aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/sites.php
blob: 4aace3f4720a300a6dbceb460eec02c245d94479 (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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<?php

	/**
	 * Elgg sites
	 * Functions to manage multiple or single sites in an Elgg install
	 * 
	 * @package Elgg
	 * @subpackage Core
	 * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
	 * @author Marcus Povey <marcus@dushka.co.uk>
	 * @copyright Curverider Ltd 2008
	 * @link http://elgg.org/
	 */

	/**
	 * ElggSite
	 * Representation of a "site" in the system.
	 * @author Marcus Povey <marcus@dushka.co.uk>
	 * @package Elgg
	 * @subpackage Core
	 */
	class ElggSite extends ElggEntity
	{
		/**
		 * Initialise the attributes array. 
		 * This is vital to distinguish between metadata and base parameters.
		 * 
		 * Place your base parameters here.
		 */
		protected function initialise_attributes()
		{
			parent::initialise_attributes();
			
			$this->attributes['type'] = "site";
			$this->attributes['name'] = "";
			$this->attributes['description'] = "";
			$this->attributes['url'] = "";
			$this->attributes['tables_split'] = 2;
		}
				
		/**
		 * Construct a new site object, optionally from a given id value.
		 *
		 * @param mixed $guid If an int, load that GUID. 
		 * 	If a db row then will attempt to load the rest of the data.
		 * @throws Exception if there was a problem creating the site. 
		 */
		function __construct($guid = null) 
		{			
			$this->initialise_attributes();
			
			if (!empty($guid))
			{
				// Is $guid is a DB row - either a entity row, or a site table row.
				if ($guid instanceof stdClass) {			
					// Load the rest
					if (!$this->load($guid->guid))
						throw new IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid->guid)); 
				}
				
				// Is $guid is an ElggSite? Use a copy constructor
				else if ($guid instanceof ElggSite)
				{				
					 foreach ($guid->attributes as $key => $value)
					 	$this->attributes[$key] = $value;
				}
				
				// Is this is an ElggEntity but not an ElggSite = ERROR!
				else if ($guid instanceof ElggEntity)
					throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggSite'));
					
				// See if this is a URL
				else if (strpos($guid, "http")!==false)
				{					
					$guid = get_site_by_url($guid);
					foreach ($guid->attributes as $key => $value)
					 	$this->attributes[$key] = $value;
					 	
				}
					
				// We assume if we have got this far, $guid is an int
				else if (is_numeric($guid)) {				
					if (!$this->load($guid)) throw new IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid));
				}
				
				else
					throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnrecognisedValue'));
			}
		}
		
		/**
		 * Class member get overloading
		 *
		 * @param string $name
		 * @return mixed
		 */
		function __get($name) { return $this->get($name); }
		
		/**
		 * Class member set overloading
		 *
		 * @param string $name
		 * @param mixed $value
		 * @return mixed
		 */
		function __set($name, $value) { return $this->set($name, $value); }
		
		/**
		 * Override the load function.
		 * This function will ensure that all data is loaded (were possible), so
		 * if only part of the ElggSite is loaded, it'll load the rest.
		 * 
		 * @param int $guid 
		 */
		protected function load($guid)
		{			
			// Test to see if we have the generic stuff
			if (!parent::load($guid)) 
				return false;

			// Check the type
			if ($this->attributes['type']!='site')
				throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));
				
			// Load missing data
			$row = get_site_entity_as_row($guid);
			if (($row) && (!$this->isFullyLoaded())) $this->attributes['tables_loaded'] ++;	// If $row isn't a cached copy then increment the counter
			
			// Now put these into the attributes array as core values
			$objarray = (array) $row;
			foreach($objarray as $key => $value) 
				$this->attributes[$key] = $value;
			
			return true;
		}
		
		/**
		 * Override the save function.
		 */
		public function save()
		{
			// Save generic stuff
			if (!parent::save())
				return false;
			
			// Now save specific stuff
			return create_site_entity($this->get('guid'), $this->get('name'), $this->get('description'), $this->get('url'));
		}
		
		/**
		 * Delete this site.
		 */
		public function delete() 
		{ 
			if (!parent::delete())
				return false;
				
			return delete_site_entity($this->get('guid'));
		}
		
		/**
		 * Return a list of users using this site.
		 *
		 * @param int $limit
		 * @param int $offset
		 * @return array of ElggUsers
		 */
		public function getMembers($limit = 10, $offset = 0) { get_site_members($this->getGUID(), $limit, $offset); }
		
		/**
		 * Add a user to the site.
		 *
		 * @param int $user_guid
		 */
		public function addUser($user_guid) { return add_site_user($this->getGUID(), $user_guid); }
		
		/**
		 * Remove a site user.
		 *
		 * @param int $user_guid
		 */
		public function removeUser($user_guid) { return remove_site_user($this->getGUID(), $user_guid); }
		
		/**
		 * Get an array of member ElggObjects.
		 *
		 * @param string $subtype
		 * @param int $limit
		 * @param int $offset
		 */
		public function getObjects($subtype="", $limit = 10, $offset = 0) { get_site_objects($this->getGUID(), $subtype, $limit, $offset); }
		
		/**
		 * Add an object to the site.
		 *
		 * @param int $user_id
		 */
		public function addObject($object_guid) { return add_site_object($this->getGUID(), $object_guid); }
		
		/**
		 * Remove a site user.
		 *
		 * @param int $user_id
		 */
		public function removeObject($object_guid) { return remove_site_object($this->getGUID(), $object_guid); }

		/**
		 * Get the collections associated with a site.
		 *
		 * @param string $type
		 * @param int $limit
		 * @param int $offset
		 * @return unknown
		 */
		public function getCollections($subtype="", $limit = 10, $offset = 0) { get_site_collections($this->getGUID(), $subtype, $limit, $offset); }
		
	}

	/**
	 * Return the site specific details of a site by a row.
	 * 
	 * @param int $guid
	 */
	function get_site_entity_as_row($guid)
	{
		global $CONFIG;
		
		$guid = (int)$guid;
		
		$row = retrieve_cached_entity_row($guid);
		if ($row->isFullyLoaded())
		{
			// We have already cached this object, so retrieve its value from the cache
			if ($CONFIG->debug)
				error_log("** Retrieving sub part of GUID:$guid from cache");
				
			return $row;
		}
		else
		{
			// Object not cached, load it.
			if ($CONFIG->debug)
				error_log("** Sub part of GUID:$guid loaded from DB");
		
			return get_data_row("SELECT * from {$CONFIG->dbprefix}sites_entity where guid=$guid");
		}
	}
	
	/**
	 * Create or update the extras table for a given site.
	 * Call create_entity first.
	 * 
	 * @param int $guid
	 * @param string $name
	 * @param string $description
	 * @param string $url
	 */
	function create_site_entity($guid, $name, $description, $url)
	{
		global $CONFIG;
		
		$guid = (int)$guid;
		$name = sanitise_string($name);
		$description = sanitise_string($description);
		$url = sanitise_string($url);
		
		$row = get_entity_as_row($guid);
		
		if ($row)
		{
			// Exists and you have access to it
			$result = update_data("UPDATE {$CONFIG->dbprefix}sites_entity set name='$name', description='$description', url='$url' where guid=$guid");
			if ($result!=false)
			{
				// Update succeeded, continue
				$entity = get_entity($guid);
				if (trigger_event('update',$entity->type,$entity)) {
					return true;
				} else {
					delete_entity($guid);
				}
			}
			else
			{
				// Update failed, attempt an insert.
				$result = insert_data("INSERT into {$CONFIG->dbprefix}sites_entity (guid, name, description, url) values ($guid, '$name','$description','$url')");
				if ($result!==false) {
					$entity = get_entity($guid);
					if (trigger_event('create',$entity->type,$entity)) {
						return true;
					} else {
						delete_entity($guid);
					}
				}
			}
		}
		
		return false;
	}
	
	/**
	 * Delete a site's extra data.
	 * 
	 * @param int $guid
	 */
	function delete_site_entity($guid)
	{
		global $CONFIG;
		
		$guid = (int)$guid;
		
		$row = get_entity_as_row($guid);
		
		// Check to see if we have access and it exists
		if ($row) 
		{
			// Delete any existing stuff
			return delete_data("DELETE from {$CONFIG->dbprefix}sites_entity where guid=$guid");
		}
		
		return false;
	}
		
	/**
	 * Add a user to a site.
	 * 
	 * @param int $site_guid 
	 * @param int $user_guid
	 */
	function add_site_user($site_guid, $user_guid)
	{
		global $CONFIG;
		
		$site_guid = (int)$site_guid;
		$user_guid = (int)$user_guid;
		
		return add_entity_relationship($user_guid, "member_of_site", $site_guid);
	}
	
	/**
	 * Remove a user from a site.
	 * 
	 * @param int $site_guid 
	 * @param int $user_guid
	 */
	function remove_site_user($site_guid, $user_guid)
	{
		$site_guid = (int)$site_guid;
		$user_guid = (int)$user_guid;
		
		return remove_entity_relationship($user_guid, "member_of_site", $site_guid);
	}
	
	/**
	 * Get the members of a site.
	 * 
	 * @param int $site_guid
	 * @param int $limit 
	 * @param int $offset
	 */
	function get_site_members($site_guid, $limit = 10, $offset = 0)
	{
		$site_guid = (int)$site_guid;
		$limit = (int)$limit;
		$offset = (int)$offset;
		
		return get_entities_from_relationship("member_of_site", $site_guid, true, "user", "", 0, "time_created desc", $limit, $offset);
	}
	
	/**
	 * Add an object to a site.
	 * 
	 * @param int $site_guid 
	 * @param int $object_guid
	 */
	function add_site_object($site_guid, $object_guid)
	{
		global $CONFIG;
		
		$site_guid = (int)$site_guid;
		$object_guid = (int)$object_guid;
		
		return add_entity_relationship($object_guid, "member_of_site", $site_guid);
	}
	
	/**
	 * Remove an object from a site.
	 * 
	 * @param int $site_guid 
	 * @param int $object_guid
	 */
	function remove_site_object($site_guid, $object_guid)
	{
		$site_guid = (int)$site_guid;
		$object_guid = (int)$object_guid;
		
		return remove_entity_relationship($object_guid, "member_of_site", $site_guid);
	}
	
	/**
	 * Get the objects belonging to a site.
	 * 
	 * @param int $site_guid
	 * @param string $subtype
	 * @param int $limit 
	 * @param int $offset
	 */
	function get_site_objects($site_guid, $subtype = "", $limit = 10, $offset = 0)
	{
		$site_guid = (int)$site_guid;
		$subtype = sanitise_string($subtype);
		$limit = (int)$limit;
		$offset = (int)$offset;
		
		return get_entities_from_relationship("member_of_site", $site_guid, true, "object", $subtype, 0, "time_created desc", $limit, $offset);
	}
	
	/**
	 * Add a collection to a site.
	 * 
	 * @param int $site_guid 
	 * @param int $collection_guid
	 */
	function add_site_collection($site_guid, $collection_guid)
	{
		global $CONFIG;
		
		$site_guid = (int)$site_guid;
		$collection_guid = (int)$collection_guid;
		
		return add_entity_relationship($collection_guid, "member_of_site", $site_guid);
	}
	
	/**
	 * Remove a collection from a site.
	 * 
	 * @param int $site_guid 
	 * @param int $collection_guid
	 */
	function remove_site_collection($site_guid, $collection_guid)
	{
		$site_guid = (int)$site_guid;
		$collection_guid = (int)$collection_guid;
		
		return remove_entity_relationship($collection_guid, "member_of_site", $site_guid);
	}
	
	/**
	 * Get the collections belonging to a site.
	 * 
	 * @param int $site_guid
	 * @param string $subtype
	 * @param int $limit 
	 * @param int $offset
	 */
	function get_site_collections($site_guid, $subtype = "", $limit = 10, $offset = 0)
	{
		$site_guid = (int)$site_guid;
		$subtype = sanitise_string($subtype);
		$limit = (int)$limit;
		$offset = (int)$offset;
		
		return get_entities_from_relationship("member_of_site", $site_guid, true, "collection", $subtype, 0, "time_created desc", $limit, $offset);
	}
	
	/**
	 * Return the site via a url.
	 */
	function get_site_by_url($url)
	{
		global $CONFIG;
		
		$url = sanitise_string($url);
		
		$row = get_data_row("SELECT * from {$CONFIG->dbprefix}sites_entity where url='$url'");
	
		if ($row)
			return new ElggSite($row); 
		
		return false;
	}
	
	
	
	
	/**
	 * Initialise site handling
	 *
	 * Called at the beginning of system running, to set the ID of the current site.
	 * This is 0 by default, but plugins may alter this behaviour by attaching functions
	 * to the sites init event and changing $CONFIG->site_id.
	 * 
	 * @uses $CONFIG
	 * @param string $event Event API required parameter
	 * @param string $object_type Event API required parameter
	 * @param null $object Event API required parameter
	 * @return true
	 */
		function sites_init($event, $object_type, $object) {
			
			global $CONFIG;
			
			if (!is_installed() || !is_db_installed()) return false;
			
			$site = trigger_plugin_hook("siteid","system");
			if ($site === null || $site === false) {
				$CONFIG->site_id = (int) datalist_get('default_site');
			} else {
				$CONFIG->site_id = $site;
			}
			$CONFIG->site_guid = $CONFIG->site_id;
			$CONFIG->site = get_entity($CONFIG->site_guid);
			
			return true;
			
		}
		
	// Register event handlers

		register_event_handler('boot','system','sites_init',2);

?>