aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/export.php
blob: 024f25a63c32a60c8471e4ab97f47e26b43996fb (plain)
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<?php
	/**
	 * Elgg Data import export functionality.
	 * 
	 * @package Elgg
	 * @subpackage Core
	 * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
	 * @author Marcus Povey
	 * @copyright Curverider Ltd 2008
	 * @link http://elgg.org/
	 */

	/**
	 * Define an interface for all exportable objects.
	 * @author Marcus Povey
	 */
	interface Exportable
	{
		/**
		 * This must take the contents of the object and return it as a stdClass.
		 */
	    public function export();
	}

	/**
	 * Define an interface for all importable objects.
	 * @author Marcus Povey
	 */
	interface Importable
	{
		/**
		 * Accepts an array of data to import, this data is parsed from the XML produced by export.
		 * The function should return the constructed object data, or NULL.
		 *
		 * @param array $data
		 * @param int $version Support different internal serialisation formats, should be "1"
		 * @return mixed The newly imported object.
		 * @throws ImportException if there was a critical error importing data.
		 */
		public function import(array $data, $version = 1);
	}
	
	/**
	 * 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.
	 * 
	 * @see ElggEntity for an example of its usage.
	 * @param int $guid The GUID.
	 * @return xml 
	 */
	function export($guid)
	{
		global $CONFIG;
		
		$guid = (int)$guid;  
		
		// Initialise the array
		$to_be_serialised = array();
		
		// Trigger a hook to 
		$to_be_serialised = trigger_plugin_hook("export", "all", array("guid" => $guid), $to_be_serialised);
		
		// Sanity check
		if ((!is_array($to_be_serialised)) || (count($to_be_serialised)==0)) throw new ExportException("No such entity GUID:$guid");
		
		// Now serialise the result to XML
		$wrapper = new stdClass;
	
		// Construct header
		$wrapper->header = new stdClass;
		$wrapper->header->date = date("r");
		$wrapper->header->timestamp = time();
		$wrapper->header->domain = $CONFIG->wwwroot;
		$wrapper->header->exported_by = guid_to_uuid($_SESSION['id']);
		
		// Construct data
		$wrapper->data = $to_be_serialised;
	
		return serialise_object_to_xml($wrapper, "elggexport");
	}
	

	/**
	 * XML 2 Array function.
	 * Taken from http://www.bytemycode.com/snippets/snippet/445/
	 * @license UNKNOWN - Please contact if you are the original author of this code.
	 * @author UNKNOWN
	 */
	function __xml2array($xml) 
	{
        $xmlary = array();
               
        $reels = '/<(\w+)\s*([^\/>]*)\s*(?:\/>|>(.*)<\/\s*\\1\s*>)/s';
        $reattrs = '/(\w+)=(?:"|\')([^"\']*)(:?"|\')/';

        preg_match_all($reels, $xml, $elements);

        foreach ($elements[1] as $ie => $xx) {
	        $xmlary[$ie]["name"] = $elements[1][$ie];
	       
	        if ($attributes = trim($elements[2][$ie])) {
	                preg_match_all($reattrs, $attributes, $att);
	                foreach ($att[1] as $ia => $xx)
	                        $xmlary[$ie]["attributes"][$att[1][$ia]] = $att[2][$ia];
	        }
	
	        $cdend = strpos($elements[3][$ie], "<");
	        if ($cdend > 0) {
	                $xmlary[$ie]["text"] = substr($elements[3][$ie], 0, $cdend - 1);
	        }
	
	        if (preg_match($reels, $elements[3][$ie]))
	                $xmlary[$ie]["elements"] = __xml2array($elements[3][$ie]);
	        else if ($elements[3][$ie]) {
	                $xmlary[$ie]["text"] = $elements[3][$ie];
	        }
        }

        return $xmlary;
	}

	$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.
	 */
	function __process_element(array $dom)
	{
		global $IMPORTED_DATA, $IMPORTED_OBJECT_COUNTER;
		
		foreach ($dom as $element)
		{
			// See if anyone handles this element, return true if it is.
			$handled = trigger_plugin_hook("import", "all", array("name" => $element['name'], "element" => $element), $to_be_serialised);
		
			// If not, then see if any of its sub elements are handled
			if (!$handled) 
			{
				if (isset($element['elements'])) 
					__process_element($element['elements']);
			}
			else
			{
				$IMPORTED_OBJECT_COUNTER ++; // Increment validation counter
				$IMPORTED_DATA[] = $handled; // Return the constructed object
			}
		}
	}
	
	/**
	 * Import an XML serialisation of an object.
	 * This will make a best attempt at importing a given xml doc.
	 *
	 * @param string $xml
	 * @return array An array of imported objects (these have already been saved).
	 * @throws Exception if there was a problem importing the data.
	 */
	function import($xml)
	{
		global $IMPORTED_DATA, $IMPORTED_OBJECT_COUNTER;
		
		$IMPORTED_DATA = array();
		$IMPORTED_OBJECT_COUNTER = 0;
		$IMPORTED_GUID_MAP = array();
		
		$dom = __xml2array($xml);
		
		__process_element($dom);
		
		if ($IMPORTED_OBJECT_COUNTER!= count($IMPORTED_DATA))
			throw new ImportException("Not all elements were imported.");
		
		return $IMPORTED_DATA;
	}

	/**
	 * Generate a UUID from a given GUID.
	 * 
	 * @param int $guid The GUID of an object.
	 */
	function guid_to_uuid($guid)
	{
		global $CONFIG;
		
		return "UUID:".md5($CONFIG->wwwroot)  . ":$guid";
	}
	
	/**
	 * Test to see if a given uuid is for this domain, returning true if so.
	 * @param $uuid
	 * @return bool
	 */
	function is_uuid_this_domain($uuid)
	{
		global $CONFIG;
		
		$domain = md5($CONFIG->wwwroot);
		$tmp = explode(":",$uuid);
		
		if (strcmp($tmp[1], $domain) == 0)
			return true;
			
		return false;
	}

	/**
	 * This function attempts to retrieve a previously imported entity via its UUID.
	 * 
	 * @param $uuid 
	 */
	function get_entity_from_uuid($uuid)
	{
		$uuid = sanitise_string($uuid);
		
		$entities = get_entities_from_metadata("import_uuid", $uuid);
		if ((!$entities) || (count($entities)!=1))
			throw new InvalidParameterException("Unexpected number of entities tagged with $uuid, previous import failed?");
			
		return $entities[0];
	}
	
	/**
	 * Tag a previously created guid with the uuid it was imported on.
	 *
	 * @param int $guid
	 * @param string $uuid
	 */
	function add_uuid_to_guid($guid, $uuid)
	{
		$guid = (int)$guid;
		$uuid = sanitise_string($uuid);
		
		return create_metadata($guid, "import_uuid", $uuid);
	}
	
	/**
	 * This function serialises an object recursively into an XML representation.
	 * The function attempts to call $data->export() which expects a stdClass in return, otherwise it will attempt to
	 * get the object variables using get_object_vars (which will only return public variables!)
	 * @param $data object The object to serialise.
	 * @param $n int Level, only used for recursion.
	 * @return string The serialised XML output.
	 */
	function serialise_object_to_xml($data, $name = "", $n = 0)
	{
		$classname = ($name=="" ? get_class($data) : $name);
		
		$vars = method_exists($data, "export") ? get_object_vars($data->export()) : get_object_vars($data); 
		
		$output = "";
		
		if (($n==0) || ( is_object($data) && !($data instanceof stdClass))) $output = "<$classname>";

		foreach ($vars as $key => $value)
		{
			$output .= "<$key type=\"".gettype($value)."\">";
			
			if (is_object($value))
				$output .= serialise_object_to_xml($value, $key, $n+1);
			else if (is_array($value))
				$output .= serialise_array_to_xml($value, $n+1);
			else
				$output .= htmlentities($value);
			
			$output .= "</$key>\n";
		}
		
		if (($n==0) || ( is_object($data) && !($data instanceof stdClass))) $output .= "</$classname>\n";
		
		return $output;
	}

	/**
	 * Serialise an array.
	 *
	 * @param array $data
	 * @param int $n Used for recursion
	 * @return string
	 */
	function serialise_array_to_xml(array $data, $n = 0)
	{
		$output = "";
		
		if ($n==0) $output = "<array>\n";
		
		foreach ($data as $key => $value)
		{
			$item = "array_item";
			
			if (is_numeric($key))
				$output .= "<$item name=\"$key\" type=\"".gettype($value)."\">";
			else
			{
				$item = $key;
				$output .= "<$item type=\"".gettype($value)."\">";
			}
			
			if (is_object($value))
				$output .= serialise_object_to_xml($value, "", $n+1);
			else if (is_array($value))
				$output .= serialise_array_to_xml($value, $n+1);
			else
				$output .= htmlentities($value);
			
			$output .= "</$item>\n";
		}
		
		if ($n==0) $output = "</array>\n";
		
		return $output;
	}
	
	class ExportException extends Exception {}
	class ImportException extends Exception {}
	
?>