attributes['type'] = "user"; $this->attributes['name'] = ""; $this->attributes['username'] = ""; $this->attributes['password'] = ""; $this->attributes['email'] = ""; $this->attributes['language'] = ""; $this->attributes['code'] = ""; $this->attributes['tables_split'] = 2; } /** * Construct a new user entity, 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 user. */ function __construct($guid = null) { $this->initialise_attributes(); if (!empty($guid)) { // Is $guid is a DB row - either a entity row, or a user 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)); } // See if this is a username else if (is_string($guid)) { $guid = get_user_by_username($guid); foreach ($guid->attributes as $key => $value) $this->attributes[$key] = $value; } // Is $guid is an ElggUser? Use a copy constructor else if ($guid instanceof ElggUser) { foreach ($guid->attributes as $key => $value) $this->attributes[$key] = $value; } // Is this is an ElggEntity but not an ElggUser = ERROR! else if ($guid instanceof ElggEntity) throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggUser')); // We assume if we have got this far, $guid is an int else if (is_numeric($guid)) { if (!$this->load($guid)) 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 ElggUser is loaded, it'll load the rest. * * @param int $guid * @return true|false */ 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']!='user') throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class())); // Load missing data $row = get_user_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; } /** * Saves this user to the database. * @return true|false */ public function save() { // Save generic stuff if (!parent::save()) return false; // Now save specific stuff return create_user_entity($this->get('guid'), $this->get('name'), $this->get('username'), $this->get('password'), $this->get('email'), $this->get('language'), $this->get('code')); } /** * Delete this user. * @return true|false */ public function delete() { if (!parent::delete()) return false; return delete_user_entity($this->get('guid')); } /** * Get sites that this user is a member of * * @param string $subtype Optionally, the subtype of result we want to limit to * @param int $limit The number of results to return * @param int $offset Any indexing offset */ function getSites($subtype="", $limit = 10, $offset = 0) { return get_site_users($this->getGUID(), $subtype, $limit, $offset); } /** * Add this user to a particular site * * @param int $site_guid The guid of the site to add it to * @return true|false */ function addToSite($site_guid) { return add_site_user($this->getGUID(), $site_guid); } /** * Remove this user from a particular site * * @param int $site_guid The guid of the site to remove it from * @return true|false */ function removeFromSite($site_guid) { return remove_site_user($this->getGUID(), $site_guid); } /** * Adds a user to this user's friends list * * @param int $friend_guid The GUID of the user to add * @return true|false Depending on success */ function addFriend($friend_guid) { return user_add_friend($this->getGUID(), $friend_guid); } /** * Removes a user from this user's friends list * * @param int $friend_guid The GUID of the user to remove * @return true|false Depending on success */ function removeFriend($friend_guid) { return user_remove_friend($this->getGUID(), $friend_guid); } /** * Determines whether or not this user is a friend of the currently logged in user * * @return true|false */ function isFriend() { return user_is_friend($_SESSION['guid'], $this->getGUID()); } /** * Determines whether this user is friends with another user * * @param int $user_guid The GUID of the user to check is on this user's friends list * @return true|false */ function isFriendsWith($user_guid) { return user_is_friend($this->getGUID(), $user_guid); } /** * Determines whether or not this user is on another user's friends list * * @param int $user_guid The GUID of the user to check against * @return true|false */ function isFriendOf($user_guid) { return user_is_friend($user_guid, $this->getGUID()); } /** * Retrieves a list of this user's friends * * @param string $subtype Optionally, the subtype of user to filter to (leave blank for all) * @param int $limit The number of users to retrieve * @param int $offset Indexing offset, if any * @return array|false Array of ElggUsers, or false, depending on success */ function getFriends($subtype = "", $limit = 10, $offset = 0) { return get_user_friends($this->getGUID(), $subtype, $limit, $offset); } /** * Retrieves a list of people who have made this user a friend * * @param string $subtype Optionally, the subtype of user to filter to (leave blank for all) * @param int $limit The number of users to retrieve * @param int $offset Indexing offset, if any * @return array|false Array of ElggUsers, or false, depending on success */ function getFriendsOf($subtype = "", $limit = 10, $offset = 0) { return get_user_friends_of($this->getGUID(), $subtype, $limit, $offset); } /** * Get an array of ElggObjects owned by this user. * * @param string $subtype The subtype of the objects, if any * @param int $limit Number of results to return * @param int $offset Any indexing offset */ public function getObjects($subtype="", $limit = 10, $offset = 0) { return get_user_objects($this->getGUID(), $subtype, $limit, $offset); } /** * Get an array of ElggObjects owned by this user's friends. * * @param string $subtype The subtype of the objects, if any * @param int $limit Number of results to return * @param int $offset Any indexing offset */ public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0) { return get_user_friends_objects($this->getGUID(), $subtype, $limit, $offset); } /** * Counts the number of ElggObjects owned by this user * * @param string $subtype The subtypes of the objects, if any * @return int The number of ElggObjects */ public function countObjects($subtype = "") { return count_user_objects($this->getGUID(), $subtype); } /** * Get the collections associated with a user. * * @param string $subtype Optionally, the subtype of result we want to limit to * @param int $limit The number of results to return * @param int $offset Any indexing offset * @return unknown */ public function getCollections($subtype="", $limit = 10, $offset = 0) { return get_user_collections($this->getGUID(), $subtype, $limit, $offset); } /** * If a user's owner is blank, return its own GUID as the owner * * @return int User GUID */ function getOwner() { if ($this->owner_guid == 0) return $this->getGUID(); return $this->owner_guid; } } /** * Return the user specific details of a user by a row. * * @param int $guid */ function get_user_entity_as_row($guid) { global $CONFIG; $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 == true) 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"); $guid = (int)$guid; return get_data_row("SELECT * from {$CONFIG->dbprefix}users_entity where guid=$guid"); } } /** * Create or update the extras table for a given user. * Call create_entity first. * * @param int $guid * @param string $name * @param string $description * @param string $url */ function create_user_entity($guid, $name, $username, $password, $email, $language, $code) { global $CONFIG; $guid = (int)$guid; $name = sanitise_string($name); $username = sanitise_string($username); $password = sanitise_string($password); $email = sanitise_string($email); $language = sanitise_string($language); $code = sanitise_string($code); $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}users_entity where guid = {$guid}")) { $result = update_data("UPDATE {$CONFIG->dbprefix}users_entity set name='$name', username='$username', password='$password', email='$email', language='$language', code='$code', last_action = ". time() ." where guid = {$guid}"); if ($result != false) { // Update succeeded, continue $entity = get_entity($guid); if (trigger_elgg_event('update',$entity->type,$entity)) { return true; } else { $entity->delete(); } } } else { // Update failed, attempt an insert. $result = insert_data("INSERT into {$CONFIG->dbprefix}users_entity (guid, name, username, password, email, language, code) values ($guid, '$name', '$username', '$password', '$email', '$language', '$code')"); if ($result!==false) { $entity = get_entity($guid); if (trigger_elgg_event('create',$entity->type,$entity)) { return true; } else { delete_entity($guid); } } } } return false; } /** * Delete a user's extra data. * * @param int $guid */ function delete_user_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}users_entity where guid=$guid"); } return false; } /** * Get the sites this user is part of * * @param int $user_guid The user's GUID * @param int $limit Number of results to return * @param int $offset Any indexing offset * @return false|array On success, an array of ElggSites */ function get_user_sites($user_guid, $limit = 10, $offset = 0) { $user_guid = (int)$user_guid; $limit = (int)$limit; $offset = (int)$offset; return get_entities_from_relationship("member_of_site", $user_guid, false, "site", "", 0, "time_created desc", $limit, $offset); } /** * Adds a user to another user's friends list. * * @param int $user_guid The GUID of the friending user * @param int $friend_guid The GUID of the user to friend * @return true|false Depending on success */ function user_add_friend($user_guid, $friend_guid) { $user_guid = (int) $user_guid; $friend_guid = (int) $friend_guid; if (!$friend = get_entity($friend_guid)) return false; if (!$user = get_entity($user_guid)) return false; if (get_class($user) != "ElggUser" || get_class($friend) != "ElggUser") return false; return add_entity_relationship($user_guid, "friend", $friend_guid); } /** * Removes a user from another user's friends list. * * @param int $user_guid The GUID of the friending user * @param int $friend_guid The GUID of the user on the friends list * @return true|false Depending on success */ function user_remove_friend($user_guid, $friend_guid) { $user_guid = (int) $user_guid; $friend_guid = (int) $friend_guid; return remove_entity_relationship($user_guid, "friend", $friend_guid); } /** * Determines whether or not a user is another user's friend. * * @param int $user_guid The GUID of the user * @param int $friend_guid The GUID of the friend * @return true|false */ function user_is_friend($user_guid, $friend_guid) { return check_entity_relationship($user_guid, "friend", $friend_guid); } /** * Obtains a given user's friends * * @param int $user_guid The user's GUID * @param string $subtype The subtype of users, if any * @param int $limit Number of results to return (default 10) * @param int $offset Indexing offset, if any * @return false|array Either an array of ElggUsers or false, depending on success */ function get_user_friends($user_guid, $subtype = "", $limit = 10, $offset = 0) { return get_entities_from_relationship("friend",$user_guid,false,"user",$subtype,0,"time_created desc",$limit,$offset); } /** * Obtains the people who have made a given user a friend * * @param int $user_guid The user's GUID * @param string $subtype The subtype of users, if any * @param int $limit Number of results to return (default 10) * @param int $offset Indexing offset, if any * @return false|array Either an array of ElggUsers or false, depending on success */ function get_user_friends_of($user_guid, $subtype = "", $limit = 10, $offset = 0) { return get_entities_from_relationship("friend",$user_guid,true,"user",$subtype,0,"time_created desc",$limit,$offset); } /** * Obtains a list of objects owned by a user * * @param int $user_guid The GUID of the owning user * @param string $subtype Optionally, the subtype of objects * @param int $limit The number of results to return (default 10) * @param int $offset Indexing offset, if any * @return false|array An array of ElggObjects or false, depending on success */ function get_user_objects($user_guid, $subtype = "", $limit = 10, $offset = 0) { $ntt = get_entities('object',$subtype, $user_guid, "time_created desc", $limit, $offset); return $ntt; } /** * Counts the objects (optionally of a particular subtype) owned by a user * * @param int $user_guid The GUID of the owning user * @param string $subtype Optionally, the subtype of objects * @return int The number of objects the user owns (of this subtype) */ function count_user_objects($user_guid, $subtype = "") { $total = get_entities('object', $subtype, $user_guid, "time_created desc", null, null, true); return $total; } /** * Displays a list of user objects of a particular subtype, with navigation. * * @see elgg_view_entity_list * * @param int $user_guid The GUID of the user * @param string $subtype The object subtype * @param int $limit The number of entities to display on a page * @return string The list in a form suitable to display */ function list_user_objects($user_guid, $subtype = "", $limit = 10) { $offset = (int) get_input('offset'); $limit = (int) $limit; $count = (int) count_user_objects($user_guid, $subtype); $entities = get_user_objects($user_guid, $subtype, $limit, $offset); return elgg_view_entity_list($entities, $count, $offset, $limit); } /** * Obtains a list of objects owned by a user's friends * * @param int $user_guid The GUID of the user to get the friends of * @param string $subtype Optionally, the subtype of objects * @param int $limit The number of results to return (default 10) * @param int $offset Indexing offset, if any * @return false|array An array of ElggObjects or false, depending on success */ function get_user_friends_objects($user_guid, $subtype = "", $limit = 10, $offset = 0) { if ($friends = get_user_friends($user_guid, $subtype, 999999, 0)) { $friendguids = array(); foreach($friends as $friend) { $friendguids[] = $friend->getGUID(); } return get_entities('object',$subtype,$friendguids, "time_created desc", $limit, $offset); } return false; } /** * Counts the number of objects owned by a user's friends * * @param int $user_guid The GUID of the user to get the friends of * @param string $subtype Optionally, the subtype of objects * @return int The number of objects */ function count_user_friends_objects($user_guid, $subtype = "") { if ($friends = get_user_friends($user_guid, $subtype, 999999, 0)) { $friendguids = array(); foreach($friends as $friend) { $friendguids[] = $friend->getGUID(); } return get_entities('object',$subtype,$friendguids, "time_created desc", $limit, $offset, true); } return 0; } /** * Displays a list of a user's friends' objects of a particular subtype, with navigation. * * @see elgg_view_entity_list * * @param int $user_guid The GUID of the user * @param string $subtype The object subtype * @param int $limit The number of entities to display on a page * @return string The list in a form suitable to display */ function list_user_friends_objects($user_guid, $subtype = "", $limit = 10) { $offset = (int) get_input('offset'); $limit = (int) $limit; $count = (int) count_user_friends_objects($user_guid, $subtype); $entities = get_user_friends_objects($user_guid, $subtype, $limit, $offset); return elgg_view_entity_list($entities, $count, $offset, $limit); } /** * Get user objects by an array of metadata * * @param int $user_guid The GUID of the owning user * @param string $subtype Optionally, the subtype of objects * @paran array $metadata An array of metadata * @param int $limit The number of results to return (default 10) * @param int $offset Indexing offset, if any * @return false|array An array of ElggObjects or false, depending on success * @return unknown */ function get_user_objects_by_metadata($user_guid, $subtype = "", $metadata = array(), $limit = 0, $offset = 0) { return get_entities_from_metadata_multi($metadata,"object",$subtype,$user_guid,$limit,$offset); } /** * Get a user object from a GUID. * * This function returns an ElggUser from a given GUID. * @param int $guid The GUID * @return ElggUser|false * @throws InvalidParameterException if $GUID exists but is not an ElggUser. */ function get_user($guid) { if (!empty($guid)) // Fixes "Exception thrown without stack frame" when db_select fails $result = get_entity($guid); if ((!empty($result)) && (!($result instanceof ElggUser))) throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class())); if (!empty($result)) return $result; return false; } /** * Get user by username * * @param string $username The user's username * @return ElggUser|false Depending on success */ function get_user_by_username($username) { global $CONFIG; $username = sanitise_string($username); $row = get_data_row("SELECT * from {$CONFIG->dbprefix}users_entity where username='$username'"); if ($row) return new ElggUser($row); return false; } /** * Get user by session code * * @param string $code The session code * @return ElggUser|false Depending on success */ function get_user_by_code($code) { global $CONFIG; $code = sanitise_string($code); $row = get_data_row("SELECT * from {$CONFIG->dbprefix}users_entity where code='$code'"); if ($row) return new ElggUser($row); return false; } /** * Searches for a user based on a complete or partial name or username using full text searching. * * IMPORTANT NOTE: With MySQL's default setup: * 1) $criteria must be 4 or more characters long * 2) If $criteria matches greater than 50% of results NO RESULTS ARE RETURNED! * * @param string $criteria The partial or full name or username. * @param int $limit Limit of the search. * @param int $offset Offset. * @param string $order_by The order. * @param boolean $count Whether to return the count of results or just the results. */ function search_for_user($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}users_entity u on e.guid=u.guid where match(u.name,u.username) 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; } /** * A function that returns a maximum of $limit users who have done something within the last * $seconds seconds. * * @param int $seconds Number of seconds (default 600 = 10min) * @param int $limit Limit, default 10. * @param int $offset Offset, defualt 0. */ function find_active_users($seconds = 600, $limit = 10, $offset = 0) { global $CONFIG; $seconds = (int)$seconds; $limit = (int)$limit; $offset = (int)$offset; $time = time() - $seconds; //$query = "SELECT * from {$CONFIG->dbprefix}entities where type='user' and time_updated>=$time order by time_updated desc limit $offset, $limit"; $query = "SELECT distinct e.* from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}system_log s on e.guid=s.performed_by_guid where e.type='user' and s.time_created>=$time order by s.time_created desc limit $offset,$limit"; return get_data($query, "entity_row_to_elggstar"); } /** * Generate a validation code for a given user's email address. * * @param int $user_guid The user id * @param string $email_address The email address */ function generate_email_validation_code($user_guid, $email_address) { global $CONFIG; return md5($user_guid . $email_address . $CONFIG->site->url); // Note I bind to site URL, this is important on multisite! } /** * Send out a validation request for a given user. * This function assumes that a user has already been created and that the email address has been * saved in the email field in the database. * * @param int $user_guid The user. * @return bool */ function request_email_validation($user_guid) { global $CONFIG; $user_guid = (int)$user_guid; $user = get_entity($user_guid); if (($user) && ($user instanceof ElggUser)) { // Clear existing status $user->validated_email = false; // Work out validate link $link = $CONFIG->site->url . "action/email/confirm?u=$user_guid&c=" . generate_email_validation_code($user_guid, $user->email); // Send validation email return notify_user($user->guid, $CONFIG->site->guid, elgg_echo('email:validate:subject'), sprintf(elgg_echo('email:validate:body'), $user->username, $link), NULL, 'email'); } return false; } /** * Validate a user email address against the code provided, and if valid set the appropriate flag * * @param int $user_guid User GUID * @param string $code The code provided on validation. */ function validate_email($user_guid, $code) { $user = get_entity($user_guid); $valid = ($code == generate_email_validation_code($user_guid, $user->email)); if ($valid) $user->validated_email = true; return $valid; } /** * Generate a password for a user, currently uses MD5. * * Later may introduce salting etc. * * @param ElggUser $user The user this is being generated for. * @param string $password Password in clear text */ function generate_user_password(ElggUser $user, $password) { return md5($password); } /** * Registers a user, returning false if the username already exists * * @param string $username The username of the new user * @param string $password The password * @param string $name The user's display name * @param string $email Their email address * @return int|false The new user's GUID; false on failure */ function register_user($username, $password, $name, $email) { // Load the configuration global $CONFIG; // A little sanity checking if (empty($username) || empty($password) || empty($name) || empty($email)) { return false; } // Check to see if $username exists already if ($user = get_user_by_username($username)) { return false; } // Check to see if we've registered the first admin yet. // If not, this is the first admin user! $admin = datalist_get('admin_registered'); // Otherwise ... $user = new ElggUser(); $user->username = $username; $user->email = $email; $user->name = $name; $user->access_id = 2; $user->password = generate_user_password($user, $password); $user->save(); if (!$admin) { $user->admin = true; datalist_set('admin_registered',1); } // Send email validation request request_email_validation($user->getGUID()); return $user->getGUID(); } /** * Page handler for friends * */ function friends_page_handler($page_elements) { if (isset($page_elements[0]) && $user = get_user_by_username($page_elements[0])) { set_page_owner($user->getGUID()); } require_once(dirname(dirname(dirname(__FILE__))) . "/friends/index.php"); } /** * Page handler for friends of * */ function friends_of_page_handler($page_elements) { if (isset($page_elements[0]) && $user = get_user_by_username($page_elements[0])) { set_page_owner($user->getGUID()); } require_once(dirname(dirname(dirname(__FILE__))) . "/friends/of.php"); } /** * Users initialisation function, which establishes the page handler * */ function users_init() { register_page_handler('friends','friends_page_handler'); register_page_handler('friendsof','friends_of_page_handler'); register_action("register",true); register_action("friends/add"); register_action("friends/remove"); register_action("email/confirm"); register_action("usersettings/save"); // User name change extend_elgg_settings_page('user/settings/name', 'usersettings/user', 1); //register_action("user/name"); // User password change extend_elgg_settings_page('user/settings/password', 'usersettings/user', 1); //register_action("user/password"); // Add email settings extend_elgg_settings_page('user/settings/email', 'usersettings/user', 1); //register_action("email/save"); // Add language settings extend_elgg_settings_page('user/settings/language', 'usersettings/user', 1); //register_action("user/language"); register_plugin_hook('usersettings:save','user','users_settings_save'); } function users_settings_save() { global $CONFIG; @include($CONFIG->path . "actions/user/name.php"); @include($CONFIG->path . "actions/user/password.php"); @include($CONFIG->path . "actions/email/save.php"); @include($CONFIG->path . "actions/user/language.php"); } //register actions ************************************************************* register_elgg_event_handler('init','system','users_init',0); ?>