UsersTable.php

Go to the documentation of this file.

<?php
namespace Elgg\Database;


global $USERNAME_TO_GUID_MAP_CACHE;
$USERNAME_TO_GUID_MAP_CACHE = array();

class UsersTable {
    private $CONFIG;

    public function __construct() {
        global $CONFIG;
        $this->CONFIG = $CONFIG;
    }

    function getRow($guid) {
        $guid = (int)$guid;
        return _elgg_services()->db->getDataRow("SELECT * from {$this->CONFIG->dbprefix}users_entity where guid=$guid");
    }
    
    function disableEntities($owner_guid) {
        $owner_guid = (int) $owner_guid;
        if ($entity = get_entity($owner_guid)) {
            if (_elgg_services()->events->trigger('disable', $entity->type, $entity)) {
                if ($entity->canEdit()) {
                    $query = "UPDATE {$this->CONFIG->dbprefix}entities
                        set enabled='no' where owner_guid={$owner_guid}
                        or container_guid = {$owner_guid}";
    
                    $res = _elgg_services()->db->updateData($query);
                    return $res;
                }
            }
        }
    
        return false;
    }
    
    function ban($user_guid, $reason = "") {
        $user_guid = (int)$user_guid;
    
        $user = get_entity($user_guid);
    
        if (($user instanceof \ElggUser) && $user->canEdit()) {
            if (_elgg_services()->events->trigger('ban', 'user', $user)) {
                // Add reason
                if ($reason) {
                    create_metadata($user_guid, 'ban_reason', $reason, '', 0, ACCESS_PUBLIC);
                }
    
                // invalidate memcache for this user
                static $newentity_cache;
                if ((!$newentity_cache) && (is_memcache_available())) {
                    $newentity_cache = new \ElggMemcache('new_entity_cache');
                }
    
                if ($newentity_cache) {
                    $newentity_cache->delete($user_guid);
                }
    
                return $this->markBanned($user_guid, true);
            }
    
            return false;
        }
    
        return false;
    }

    public function markBanned($guid, $banned) {
        $banned = $banned ? 'yes' : 'no';
        $query = "
            UPDATE {$this->CONFIG->dbprefix}users_entity
            SET banned = '$banned'
            WHERE guid = $guid
        ";

        return _elgg_services()->db->updateData($query);
    }
    
    function unban($user_guid) {
        $user_guid = (int)$user_guid;
    
        $user = get_entity($user_guid);
    
        if (($user) && ($user->canEdit()) && ($user instanceof \ElggUser)) {
            if (_elgg_services()->events->trigger('unban', 'user', $user)) {
                create_metadata($user_guid, 'ban_reason', '', '', 0, ACCESS_PUBLIC);
    
                // invalidate memcache for this user
                static $newentity_cache;
                if ((!$newentity_cache) && (is_memcache_available())) {
                    $newentity_cache = new \ElggMemcache('new_entity_cache');
                }
    
                if ($newentity_cache) {
                    $newentity_cache->delete($user_guid);
                }
    
                return $this->markBanned($user_guid, false);
            }
    
            return false;
        }
    
        return false;
    }
    
    function makeAdmin($user_guid) {
        $user = get_entity((int)$user_guid);
    
        if (($user) && ($user instanceof \ElggUser) && ($user->canEdit())) {
            if (_elgg_services()->events->trigger('make_admin', 'user', $user)) {
    
                // invalidate memcache for this user
                static $newentity_cache;
                if ((!$newentity_cache) && (is_memcache_available())) {
                    $newentity_cache = new \ElggMemcache('new_entity_cache');
                }
    
                if ($newentity_cache) {
                    $newentity_cache->delete($user_guid);
                }
    
                $r = _elgg_services()->db->updateData("UPDATE {$this->CONFIG->dbprefix}users_entity set admin='yes' where guid=$user_guid");
                _elgg_services()->entityCache->remove($user_guid);
                return $r;
            }
    
            return false;
        }
    
        return false;
    }
    
    function removeAdmin($user_guid) {
        
    
        $user = get_entity((int)$user_guid);
    
        if (($user) && ($user instanceof \ElggUser) && ($user->canEdit())) {
            if (_elgg_services()->events->trigger('remove_admin', 'user', $user)) {
    
                // invalidate memcache for this user
                static $newentity_cache;
                if ((!$newentity_cache) && (is_memcache_available())) {
                    $newentity_cache = new \ElggMemcache('new_entity_cache');
                }
    
                if ($newentity_cache) {
                    $newentity_cache->delete($user_guid);
                }
    
                $r = _elgg_services()->db->updateData("UPDATE {$this->CONFIG->dbprefix}users_entity set admin='no' where guid=$user_guid");
                _elgg_services()->entityCache->remove($user_guid);
                return $r;
            }
    
            return false;
        }
    
        return false;
    }
    
    function getByUsername($username) {
        global $USERNAME_TO_GUID_MAP_CACHE;
    
        // Fixes #6052. Username is frequently sniffed from the path info, which,
        // unlike $_GET, is not URL decoded. If the username was not URL encoded,
        // this is harmless.
        $username = rawurldecode($username);
    
        $username = sanitise_string($username);
        $access = _elgg_get_access_where_sql();
    
        // Caching
        if ((isset($USERNAME_TO_GUID_MAP_CACHE[$username]))
                && (_elgg_services()->entityCache->get($USERNAME_TO_GUID_MAP_CACHE[$username]))) {
            return _elgg_services()->entityCache->get($USERNAME_TO_GUID_MAP_CACHE[$username]);
        }
    
        $query = "SELECT e.* FROM {$this->CONFIG->dbprefix}users_entity u
            JOIN {$this->CONFIG->dbprefix}entities e ON e.guid = u.guid
            WHERE u.username = '$username' AND $access";
    
        $entity = _elgg_services()->db->getDataRow($query, 'entity_row_to_elggstar');
        if ($entity) {
            $USERNAME_TO_GUID_MAP_CACHE[$username] = $entity->guid;
        } else {
            $entity = false;
        }
    
        return $entity;
    }
    
    function getByEmail($email) {
        
    
        $email = sanitise_string($email);
    
        $access = _elgg_get_access_where_sql();
    
        $query = "SELECT e.* FROM {$this->CONFIG->dbprefix}entities e
            JOIN {$this->CONFIG->dbprefix}users_entity u ON e.guid = u.guid
            WHERE email = '$email' AND $access";
    
        return _elgg_services()->db->getData($query, 'entity_row_to_elggstar');
    }
    
    function findActive($options = array(), $limit = 10, $offset = 0, $count = false) {
    
        $seconds = 600; //default value
    
        if (!is_array($options)) {
            elgg_deprecated_notice("find_active_users() now accepts an \$options array", 1.9);
            if (!$options) {
                $options = $seconds; //assign default value
            }
            $options = array('seconds' => $options);
        }

        if ($limit === null) {
            $limit = _elgg_services()->config->get('default_limit');
        }

        $options = array_merge(array(
            'seconds' => $seconds,
            'limit' => $limit,
            'offset' => $offset,
            'count' => $count,
        ), $options);
    
        // cast options we're sending to hook
        foreach (array('seconds', 'limit', 'offset') as $key) {
            $options[$key] = (int)$options[$key];
        }
        $options['count'] = (bool)$options['count'];
    
        // allow plugins to override
        $params = array(
            'seconds' => $options['seconds'],
            'limit' => $options['limit'],
            'offset' => $options['offset'],
            'count' => $options['count'],
            'options' => $options,
        );
        $data = _elgg_services()->hooks->trigger('find_active_users', 'system', $params, null);
        // check null because the handler could legitimately return falsey values.
        if ($data !== null) {
            return $data;
        }
    
        $dbprefix = _elgg_services()->config->get('dbprefix');
        $time = time() - $options['seconds'];
        return elgg_get_entities(array(
            'type' => 'user',
            'limit' => $options['limit'],
            'offset' => $options['offset'],
            'count' => $options['count'],
            'joins' => array("join {$dbprefix}users_entity u on e.guid = u.guid"),
            'wheres' => array("u.last_action >= {$time}"),
            'order_by' => "u.last_action desc",
        ));
    }

    function register($username, $password, $name, $email, $allow_multiple_emails = false) {
    
        // no need to trim password.
        $username = trim($username);
        $name = trim(strip_tags($name));
        $email = trim($email);
    
        // A little sanity checking
        if (empty($username)
                || empty($password)
                || empty($name)
                || empty($email)) {
            return false;
        }

        // Make sure a user with conflicting details hasn't registered and been disabled
        $access_status = access_get_show_hidden_status();
        access_show_hidden_entities(true);
    
        if (!validate_email_address($email)) {
            throw new \RegistrationException(_elgg_services()->translator->translate('registration:emailnotvalid'));
        }
    
        if (!validate_password($password)) {
            throw new \RegistrationException(_elgg_services()->translator->translate('registration:passwordnotvalid'));
        }
    
        if (!validate_username($username)) {
            throw new \RegistrationException(_elgg_services()->translator->translate('registration:usernamenotvalid'));
        }
    
        if ($user = get_user_by_username($username)) {
            throw new \RegistrationException(_elgg_services()->translator->translate('registration:userexists'));
        }
    
        if ((!$allow_multiple_emails) && (get_user_by_email($email))) {
            throw new \RegistrationException(_elgg_services()->translator->translate('registration:dupeemail'));
        }
    
        access_show_hidden_entities($access_status);
    
        // Create user
        $user = new \ElggUser();
        $user->username = $username;
        $user->email = $email;
        $user->name = $name;
        $user->access_id = ACCESS_PUBLIC;
        $user->setPassword($password);
        $user->owner_guid = 0; // Users aren't owned by anyone, even if they are admin created.
        $user->container_guid = 0; // Users aren't contained by anyone, even if they are admin created.
        $user->language = _elgg_services()->translator->getCurrentLanguage();
        if ($user->save() === false) {
            return false;
        }
    
        // Turn on email notifications by default
        set_user_notification_setting($user->getGUID(), 'email', true);
    
        return $user->getGUID();
    }
    
    function generateInviteCode($username) {
        $time = time();
        return "$time." . _elgg_services()->crypto->getHmac([(int)$time, $username])->getToken();
    }

    function validateInviteCode($username, $code) {
        // validate the format of the token created by ->generateInviteCode()
        if (!preg_match('~^(\d+)\.([a-zA-Z0-9\-_]+)$~', $code, $m)) {
            return false;
        }
        $time = $m[1];
        $mac = $m[2];

        return _elgg_services()->crypto->getHmac([(int)$time, $username])->matchesToken($mac);
    }
    
    function setValidationStatus($user_guid, $status, $method = '') {
        $result1 = create_metadata($user_guid, 'validated', $status, '', 0, ACCESS_PUBLIC, false);
        $result2 = create_metadata($user_guid, 'validated_method', $method, '', 0, ACCESS_PUBLIC, false);
        if ($result1 && $result2) {
            return true;
        } else {
            return false;
        }
    }
    
    function getValidationStatus($user_guid) {
        $md = elgg_get_metadata(array(
            'guid' => $user_guid,
            'metadata_name' => 'validated'
        ));
        if ($md == false) {
            return null;
        }
    
        if ($md[0]->value) {
            return true;
        }
    
        return false;
    }
    
    function setLastAction($user_guid) {
        $user_guid = (int) $user_guid;
        
        $time = time();
    
        $query = "UPDATE {$this->CONFIG->dbprefix}users_entity
            set prev_last_action = last_action,
            last_action = {$time} where guid = {$user_guid}";
    
        execute_delayed_write_query($query);
    }
    
    function setLastLogin($user_guid) {
        $user_guid = (int) $user_guid;
        
        $time = time();
    
        $query = "UPDATE {$this->CONFIG->dbprefix}users_entity
            set prev_last_login = last_login, last_login = {$time} where guid = {$user_guid}";
    
        execute_delayed_write_query($query);
    }
        
}