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
|
<?php
/**
* Elgg Data import export functionality.
*
* @package Elgg.Core
* @subpackage DataModel.Export
*/
/**
* Get a UUID from a given object.
*
* @param mixed $object The object either an ElggEntity, ElggRelationship or ElggExtender
*
* @return string|false the UUID or false
*/
function get_uuid_from_object($object) {
if ($object instanceof ElggEntity) {
return guid_to_uuid($object->guid);
} else if ($object instanceof ElggExtender) {
$type = $object->type;
if ($type == 'volatile') {
$uuid = guid_to_uuid($object->entity_guid) . $type . "/{$object->name}/";
} else {
$uuid = guid_to_uuid($object->entity_guid) . $type . "/{$object->id}/";
}
return $uuid;
} else if ($object instanceof ElggRelationship) {
return guid_to_uuid($object->guid_one) . "relationship/{$object->id}/";
}
return false;
}
/**
* Generate a UUID from a given GUID.
*
* @param int $guid The GUID of an object.
*
* @return string
*/
function guid_to_uuid($guid) {
return elgg_get_site_url() . "export/opendd/$guid/";
}
/**
* Test to see if a given uuid is for this domain, returning true if so.
*
* @param string $uuid A unique ID
*
* @return bool
*/
function is_uuid_this_domain($uuid) {
if (strpos($uuid, elgg_get_site_url()) === 0) {
return true;
}
return false;
}
/**
* This function attempts to retrieve a previously imported entity via its UUID.
*
* @param string $uuid A unique ID
*
* @return ElggEntity|false
*/
function get_entity_from_uuid($uuid) {
$uuid = sanitise_string($uuid);
$options = array('metadata_name' => 'import_uuid', 'metadata_value' => $uuid);
$entities = elgg_get_entities_from_metadata($options);
if ($entities) {
return $entities[0];
}
return false;
}
/**
* Tag a previously created guid with the uuid it was imported on.
*
* @param int $guid A GUID
* @param string $uuid A Unique ID
*
* @return bool
*/
function add_uuid_to_guid($guid, $uuid) {
$guid = (int)$guid;
$uuid = sanitise_string($uuid);
$result = create_metadata($guid, "import_uuid", $uuid);
return (bool)$result;
}
$IMPORTED_DATA = array();
$IMPORTED_OBJECT_COUNTER = 0;
/**
* This function processes an element, passing elements to the plugin stack to see if someone will
* process it.
*
* If nobody processes the top level element, the sub level elements are processed.
*
* @param ODD $odd The odd element to process
*
* @return bool
* @access private
*/
function _process_element(ODD $odd) {
global $IMPORTED_DATA, $IMPORTED_OBJECT_COUNTER;
// See if anyone handles this element, return true if it is.
$to_be_serialised = null;
if ($odd) {
$handled = elgg_trigger_plugin_hook("import", "all", array("element" => $odd), $to_be_serialised);
// If not, then see if any of its sub elements are handled
if ($handled) {
// Increment validation counter
$IMPORTED_OBJECT_COUNTER ++;
// Return the constructed object
$IMPORTED_DATA[] = $handled;
return true;
}
}
return false;
}
/**
* Exports an entity as an array
*
* @param int $guid Entity GUID
*
* @return array
* @throws ExportException
* @access private
*/
function exportAsArray($guid) {
$guid = (int)$guid;
// Trigger a hook to
$to_be_serialised = elgg_trigger_plugin_hook("export", "all", array("guid" => $guid), array());
// Sanity check
if ((!is_array($to_be_serialised)) || (count($to_be_serialised) == 0)) {
throw new ExportException(elgg_echo('ExportException:NoSuchEntity', array($guid)));
}
return $to_be_serialised;
}
/**
* Export a GUID.
*
* This function exports a GUID and all information related to it in an XML format.
*
* This function makes use of the "serialise" plugin hook, which is passed an array to which plugins
* should add data to be serialised to.
*
* @param int $guid The GUID.
*
* @return string XML
* @see ElggEntity for an example of its usage.
* @access private
*/
function export($guid) {
$odd = new ODDDocument(exportAsArray($guid));
return ODD_Export($odd);
}
/**
* Import an XML serialisation of an object.
* This will make a best attempt at importing a given xml doc.
*
* @param string $xml XML string
*
* @return bool
* @throws ImportException if there was a problem importing the data.
* @access private
*/
function import($xml) {
global $IMPORTED_DATA, $IMPORTED_OBJECT_COUNTER;
$IMPORTED_DATA = array();
$IMPORTED_OBJECT_COUNTER = 0;
$document = ODD_Import($xml);
if (!$document) {
throw new ImportException(elgg_echo('ImportException:NoODDElements'));
}
foreach ($document as $element) {
_process_element($element);
}
if ($IMPORTED_OBJECT_COUNTER != count($IMPORTED_DATA)) {
throw new ImportException(elgg_echo('ImportException:NotAllImported'));
}
return true;
}
/**
* Register the OpenDD import action
*
* @return void
* @access private
*/
function export_init() {
global $CONFIG;
elgg_register_action("import/opendd");
}
// Register a startup event
elgg_register_event_handler('init', 'system', 'export_init', 100);
|
