engine/lib/sites.php

Go to the documentation of this file.

<?php

    class ElggSite extends ElggEntity
    {
        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;
        }
                
        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'));
            }
        }
        
        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;
        }
        
        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'));
        }
        
        public function delete() 
        { 
            global $CONFIG;
            if ($CONFIG->site->getGUID() == $this->guid)
                throw new SecurityException('SecurityException:deletedisablecurrentsite');  
            
            return parent::delete;
        }
        
        public function disable($reason = "")
        {
            global $CONFIG;
            if ($CONFIG->site->getGUID() == $this->guid)
                throw new SecurityException('SecurityException:deletedisablecurrentsite');  
                
            return parent::disable($reason);
        }
        
        public function getMembers($limit = 10, $offset = 0) { get_site_members($this->getGUID(), $limit, $offset); }
        
        public function addUser($user_guid) { return add_site_user($this->getGUID(), $user_guid); }
        
        public function removeUser($user_guid) { return remove_site_user($this->getGUID(), $user_guid); }
        
        public function getObjects($subtype="", $limit = 10, $offset = 0) { get_site_objects($this->getGUID(), $subtype, $limit, $offset); }
        
        public function addObject($object_guid) { return add_site_object($this->getGUID(), $object_guid); }
        
        public function removeObject($object_guid) { return remove_site_object($this->getGUID(), $object_guid); }

        public function getCollections($subtype="", $limit = 10, $offset = 0) { get_site_collections($this->getGUID(), $subtype, $limit, $offset); }
        
        // EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////
        
        public function getExportableValues()
        {
            return array_merge(parent::getExportableValues(), array(
                'name',
                'description',
                'url',
            ));
        }
        
    }

    function get_site_entity_as_row($guid)
    {
        global $CONFIG;
        
        $guid = (int)$guid;
        
        /*$row = retrieve_cached_entity_row($guid);
        if ($row)
        {
            // We have already cached this object, so retrieve its value from the cache
            if (isset($CONFIG->debug) && $CONFIG->debug)
                error_log("** Retrieving sub part of GUID:$guid from cache");
                
            return $row;
        }
        else
        {*/
            // Object not cached, load it.
            if (isset($CONFIG->debug) && $CONFIG->debug == true)
                error_log("** Sub part of GUID:$guid loaded from DB");
        
            return get_data_row("SELECT * from {$CONFIG->dbprefix}sites_entity where guid=$guid");
        //}
    }
    
    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
            if ($exists = get_data_row("SELECT guid from {$CONFIG->dbprefix}sites_entity where guid = {$guid}")) {
                $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_elgg_event('update',$entity->type,$entity)) {
                        return $guid;
                    } else {
                        $entity->delete();
                        //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_elgg_event('create',$entity->type,$entity)) {
                        return $guid;
                    } else {
                        $entity->delete();
                        //delete_entity($guid);
                    }
                }
            }
        }
        
        return false;
    }
    
    function delete_site_entity($guid)
    {
        system_message(sprintf(elgg_echo('deprecatedfunction'), 'delete_user_entity'));
        
        return 1; // Always return that we have deleted one row in order to not break existing code.
    }
        
    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);
    }
    
    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);
    }
    
    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);
    }
    
    function list_site_members($site_guid, $limit = 10, $fullview = true) {
        
        $offset = (int) get_input('offset');
        $limit = (int) $limit;
        $count = (int) get_entities_from_relationship("member_of_site", $site_guid, true, "user", "", 0, "time_created desc", $limit, $offset, true);
        $entities = get_site_members($site_guid, $limit, $offset);
        
        return elgg_view_entity_list($entities, $count, $offset, $limit, $fullview);
        
    }
    
    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);
    }
    
    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);
    }
    
    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);
    }
    
    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);
    }
    
    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);
    }
    
    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);
    }
    
    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;
    }
    
    function search_for_site($criteria, $limit = 10, $offset = 0, $order_by = "", $count = false)
    {
        global $CONFIG;
        
        $criteria = sanitise_string($criteria);
        $limit = (int)$limit;
        $offset = (int)$offset;
        $order_by = sanitise_string($order_by);
        
        $access = get_access_sql_suffix("e");
        
        if ($order_by == "") $order_by = "e.time_created desc";
        
        if ($count) {
            $query = "SELECT count(e.guid) as total ";
        } else {
            $query = "SELECT e.* "; 
        }
        $query .= "from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}sites_entity s on e.guid=s.guid where match(s.name,s.description,s.url) against ('$criteria') and $access";
        
        if (!$count) {
            $query .= " order by $order_by limit $offset, $limit"; // Add order and limit
            return get_data($query, "entity_row_to_elggstar");
        } else {
            if ($count = get_data_row($query)) {
                return $count->total;
            }
        }
        return false;
    }
    
    function get_site_domain($guid)
    {
        $guid = (int)$guid;
        
        $site = get_entity($guid);
        if ($site instanceof ElggSite) {
            $breakdown = parse_url($site->url);
            return $breakdown['host'];
        }
        
        return false;
    }
    
        function sites_init($event, $object_type, $object) {
            
            global $CONFIG;
            
            if (is_installed() && is_db_installed()) {
                
                $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;
            }
            
            return true;
        }
        
    // Register event handlers

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

?>

---