1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<?php
/**
* Elgg Entity Extender.
* This file contains ways of extending an Elgg entity in custom ways.
*
* @package Elgg.Core
* @subpackage DataModel.Extender
*/
/**
* Detect the value_type for a given value.
* Currently this is very crude.
*
* @todo Make better!
*
* @param mixed $value The value
* @param string $value_type If specified, overrides the detection.
*
* @return string
*/
function detect_extender_valuetype($value, $value_type = "") {
if ($value_type != "" && ($value_type == 'integer' || $value_type == 'text')) {
return $value_type;
}
// This is crude
if (is_int($value)) {
return 'integer';
}
// Catch floating point values which are not integer
if (is_numeric($value)) {
return 'text';
}
return 'text';
}
/**
* Utility function used by import_extender_plugin_hook() to process
* an ODDMetaData and add it to an entity. This function does not
* hit ->save() on the entity (this lets you construct in memory)
*
* @param ElggEntity $entity The entity to add the data to.
* @param ODDMetaData $element The OpenDD element
*
* @return bool
* @access private
*/
function oddmetadata_to_elggextender(ElggEntity $entity, ODDMetaData $element) {
// Get the type of extender (metadata, type, attribute etc)
$type = $element->getAttribute('type');
$attr_name = $element->getAttribute('name');
$attr_val = $element->getBody();
switch ($type) {
// Ignore volatile items
case 'volatile' :
break;
case 'annotation' :
$entity->annotate($attr_name, $attr_val);
break;
case 'metadata' :
$entity->setMetaData($attr_name, $attr_val, "", true);
break;
default : // Anything else assume attribute
$entity->set($attr_name, $attr_val);
}
// Set time if appropriate
$attr_time = $element->getAttribute('published');
if ($attr_time) {
$entity->set('time_updated', $attr_time);
}
return true;
}
/**
* Handler called by trigger_plugin_hook on the "import" event.
*
* @param string $hook volatile
* @param string $entity_type metadata
* @param string $returnvalue Return value from previous hook
* @param array $params The parameters
*
* @return null
* @elgg_plugin_hook_handler volatile metadata
* @todo investigate more.
* @access private
*/
function import_extender_plugin_hook($hook, $entity_type, $returnvalue, $params) {
$element = $params['element'];
$tmp = NULL;
if ($element instanceof ODDMetaData) {
// Recall entity
$entity_uuid = $element->getAttribute('entity_uuid');
$entity = get_entity_from_uuid($entity_uuid);
if (!$entity) {
throw new ImportException(elgg_echo('ImportException:GUIDNotFound', array($entity_uuid)));
}
oddmetadata_to_elggextender($entity, $element);
// Save
if (!$entity->save()) {
$attr_name = $element->getAttribute('name');
$msg = elgg_echo('ImportException:ProblemUpdatingMeta', array($attr_name, $entity_uuid));
throw new ImportException($msg);
}
return true;
}
}
/**
* Determines whether or not the specified user can edit the specified piece of extender
*
* @param int $extender_id The ID of the piece of extender
* @param string $type 'metadata' or 'annotation'
* @param int $user_guid The GUID of the user
*
* @return bool
*/
function can_edit_extender($extender_id, $type, $user_guid = 0) {
if (!elgg_is_logged_in()) {
return false;
}
$user_guid = (int)$user_guid;
$user = get_entity($user_guid);
if (!$user) {
$user = elgg_get_logged_in_user_entity();
}
$functionname = "elgg_get_{$type}_from_id";
if (is_callable($functionname)) {
$extender = call_user_func($functionname, $extender_id);
} else {
return false;
}
if (!($extender instanceof ElggExtender)) {
return false;
}
/* @var ElggExtender $extender */
// If the owner is the specified user, great! They can edit.
if ($extender->getOwnerGUID() == $user->getGUID()) {
return true;
}
// If the user can edit the entity this is attached to, great! They can edit.
if (can_edit_entity($extender->entity_guid, $user->getGUID())) {
return true;
}
// Trigger plugin hooks
$params = array('entity' => $extender->getEntity(), 'user' => $user);
return elgg_trigger_plugin_hook('permissions_check', $type, $params, false);
}
/**
* Sets the URL handler for a particular extender type and name.
* It is recommended that you do not call this directly, instead use
* one of the wrapper functions such as elgg_register_annotation_url_handler().
*
* @param string $extender_type Extender type ('annotation', 'metadata')
* @param string $extender_name The name of the extender
* @param string $function_name The function to register
*
* @return bool
*/
function elgg_register_extender_url_handler($extender_type, $extender_name, $function_name) {
global $CONFIG;
if (!is_callable($function_name, true)) {
return false;
}
if (!isset($CONFIG->extender_url_handler)) {
$CONFIG->extender_url_handler = array();
}
if (!isset($CONFIG->extender_url_handler[$extender_type])) {
$CONFIG->extender_url_handler[$extender_type] = array();
}
$CONFIG->extender_url_handler[$extender_type][$extender_name] = $function_name;
return true;
}
/**
* Get the URL of a given elgg extender.
* Used by get_annotation_url and get_metadata_url.
*
* @param ElggExtender $extender An extender object
*
* @return string
*/
function get_extender_url(ElggExtender $extender) {
global $CONFIG;
$view = elgg_get_viewtype();
$guid = $extender->entity_guid;
$type = $extender->type;
$url = "";
$function = "";
if (isset($CONFIG->extender_url_handler[$type][$extender->name])) {
$function = $CONFIG->extender_url_handler[$type][$extender->name];
}
if (isset($CONFIG->extender_url_handler[$type]['all'])) {
$function = $CONFIG->extender_url_handler[$type]['all'];
}
if (isset($CONFIG->extender_url_handler['all']['all'])) {
$function = $CONFIG->extender_url_handler['all']['all'];
}
if (is_callable($function)) {
$url = call_user_func($function, $extender);
}
if ($url == "") {
$nameid = $extender->id;
if ($type == 'volatile') {
$nameid = $extender->name;
}
$url = "export/$view/$guid/$type/$nameid/";
}
return elgg_normalize_url($url);
}
/** Register the hook */
elgg_register_plugin_hook_handler("import", "all", "import_extender_plugin_hook", 2);
|
