users.php

Go to the documentation of this file.

<?php
function get_user_entity_as_row($guid) {
    return _elgg_services()->usersTable->getRow($guid);
}

function disable_user_entities($owner_guid) {
    return _elgg_services()->usersTable->disableEntities($owner_guid);
}

function ban_user($user_guid, $reason = "") {
    return _elgg_services()->usersTable->ban($user_guid, $reason);
}

function unban_user($user_guid) {
    return _elgg_services()->usersTable->unban($user_guid);
}

function make_user_admin($user_guid) {
    return _elgg_services()->usersTable->makeAdmin($user_guid);
}

function remove_user_admin($user_guid) {
    return _elgg_services()->usersTable->removeAdmin($user_guid);
}

function get_user($guid) {
    return _elgg_services()->entityTable->get($guid, 'user');
}

function get_user_by_username($username) {
    return _elgg_services()->usersTable->getByUsername($username);
}

function get_user_by_code($hash) {
    return _elgg_services()->persistentLogin->getUserFromHash($hash);
}

function get_user_by_email($email) {
    return _elgg_services()->usersTable->getByEmail($email);
}

function find_active_users($options = array(), $limit = 10, $offset = 0, $count = false) {
    return _elgg_services()->usersTable->findActive($options, $limit, $offset, $count);
}

function send_new_password_request($user_guid) {
    return _elgg_services()->passwords->sendNewPasswordRequest($user_guid);
}

function force_user_password_reset($user_guid, $password) {
    return _elgg_services()->passwords->forcePasswordReset($user_guid, $password);
}

function execute_new_password_request($user_guid, $conf_code, $password = null) {
    return _elgg_services()->passwords->executeNewPasswordReset($user_guid, $conf_code, $password);
}

function generate_random_cleartext_password() {
    return _elgg_services()->crypto->getRandomString(12, \ElggCrypto::CHARS_PASSWORD);
}



function validate_username($username) {
    global $CONFIG;

    // Basic, check length
    if (!isset($CONFIG->minusername)) {
        $CONFIG->minusername = 4;
    }

    if (strlen($username) < $CONFIG->minusername) {
        $msg = elgg_echo('registration:usernametooshort', array($CONFIG->minusername));
        throw new \RegistrationException($msg);
    }

    // username in the database has a limit of 128 characters
    if (strlen($username) > 128) {
        $msg = elgg_echo('registration:usernametoolong', array(128));
        throw new \RegistrationException($msg);
    }

    // Blacklist for bad characters (partially nicked from mediawiki)
    $blacklist = '/[' .
        '\x{0080}-\x{009f}' . // iso-8859-1 control chars
        '\x{00a0}' .          // non-breaking space
        '\x{2000}-\x{200f}' . // various whitespace
        '\x{2028}-\x{202f}' . // breaks and control chars
        '\x{3000}' .          // ideographic space
        '\x{e000}-\x{f8ff}' . // private use
        ']/u';

    if (preg_match($blacklist, $username)) {
        // @todo error message needs work
        throw new \RegistrationException(elgg_echo('registration:invalidchars'));
    }

    // Belts and braces
    // @todo Tidy into main unicode
    $blacklist2 = '\'/\\"*& ?#%^(){}[]~?<>;|¬`@+=';

    $blacklist2 = elgg_trigger_plugin_hook('username:character_blacklist', 'user',
        array('blacklist' => $blacklist2), $blacklist2);

    for ($n = 0; $n < strlen($blacklist2); $n++) {
        if (strpos($username, $blacklist2[$n]) !== false) {
            $msg = elgg_echo('registration:invalidchars', array($blacklist2[$n], $blacklist2));
            $msg = htmlspecialchars($msg, ENT_QUOTES, 'UTF-8');
            throw new \RegistrationException($msg);
        }
    }

    $result = true;
    return elgg_trigger_plugin_hook('registeruser:validate:username', 'all',
        array('username' => $username), $result);
}

function validate_password($password) {
    global $CONFIG;

    if (!isset($CONFIG->min_password_length)) {
        $CONFIG->min_password_length = 6;
    }

    if (strlen($password) < $CONFIG->min_password_length) {
        $msg = elgg_echo('registration:passwordtooshort', array($CONFIG->min_password_length));
        throw new \RegistrationException($msg);
    }

    $result = true;
    return elgg_trigger_plugin_hook('registeruser:validate:password', 'all',
        array('password' => $password), $result);
}

function validate_email_address($address) {
    if (!is_email_address($address)) {
        throw new \RegistrationException(elgg_echo('registration:notemail'));
    }

    // Got here, so lets try a hook (defaulting to ok)
    $result = true;
    return elgg_trigger_plugin_hook('registeruser:validate:email', 'all',
        array('email' => $address), $result);
}

function register_user($username, $password, $name, $email, $allow_multiple_emails = false) {
    return _elgg_services()->usersTable->register($username, $password, $name, $email, $allow_multiple_emails);
}

function generate_invite_code($username) {
    return _elgg_services()->usersTable->generateInviteCode($username);
}

function elgg_validate_invite_code($username, $code) {
    return _elgg_services()->usersTable->validateInviteCode($username, $code);
}

function elgg_set_user_validation_status($user_guid, $status, $method = '') {
    return _elgg_services()->usersTable->setValidationStatus($user_guid, $status, $method);
}

function elgg_get_user_validation_status($user_guid) {
    return _elgg_services()->usersTable->getValidationStatus($user_guid);
}

function elgg_user_account_page_handler($page_elements, $handler) {

    switch ($handler) {
        case 'login':
            echo elgg_view_resource("account/login");
            break;
        case 'forgotpassword':
            echo elgg_view_resource("account/forgotten_password");
            break;
        case 'changepassword':
            echo elgg_view_resource("account/change_password");
            break;
        case 'register':
            echo elgg_view_resource("account/register");
            break;
        default:
            return false;
    }

    return true;
}

function elgg_get_registration_url(array $query = [], $fragment = '') {
    $url = elgg_normalize_url('register');
    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
    return elgg_trigger_plugin_hook('registration_url', 'site', $query, $url);
}

function elgg_get_login_url(array $query = [], $fragment = '') {
    $url = elgg_normalize_url('login');
    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
    return elgg_trigger_plugin_hook('login_url', 'site', $query, $url);
}

function set_last_action($user_guid) {
    $user = get_user($user_guid);
    if (!$user) {
        return;
    }
    _elgg_services()->usersTable->setLastAction($user);
}

function set_last_login($user_guid) {
    $user = get_user($user_guid);
    if (!$user) {
        return;
    }
    _elgg_services()->usersTable->setLastLogin($user);
}

function user_create_hook_add_site_relationship($event, $object_type, $object) {
    add_entity_relationship($object->getGUID(), 'member_of_site', elgg_get_site_entity()->guid);
}

function user_avatar_hook($hook, $entity_type, $returnvalue, $params) {
    $user = elgg_extract('entity', $params);
    $size = elgg_extract('size', $params, 'medium');

    if (!$user instanceof ElggUser) {
        return;
    }

    $default_url = elgg_get_simplecache_url("icons/user/default{$size}.gif");
    if (!isset($user->icontime)) {
        return $default_url;
    }

    if (_elgg_view_may_be_altered('resources/avatar/view', 'resources/avatar/view.php')) {
        // For BC with 2.0 if a plugin is suspected of using this view/page handler we need to use it.
        // /avatar page handler will issue a deprecation notice.
        return "avatar/view/$user->username/$size/$user->icontime";
    }

    $filehandler = new ElggFile();
    $filehandler->owner_guid = $user->guid;
    $filehandler->setFilename("profile/{$user->guid}{$size}.jpg");
    $use_cookie = elgg_get_config('walled_garden'); // don't serve avatars with public URLs in a walled garden mode
    $avatar_url = elgg_get_inline_url($filehandler, $use_cookie);

    return $avatar_url ? : $default_url;
}

function elgg_user_hover_menu($hook, $type, $return, $params) {
    $user = elgg_extract('entity', $params);
    /* @var \ElggUser $user */

    if (!$user instanceof \ElggUser) {
        return;
    }

    if (!elgg_is_logged_in()) {
        return;
    }
    
    if (elgg_get_logged_in_user_guid() == $user->guid) {
        $url = "profile/$user->username/edit";
        $item = new \ElggMenuItem('profile:edit', elgg_echo('profile:edit'), $url);
        $item->setSection('action');
        $return[] = $item;

        $url = "avatar/edit/$user->username";
        $item = new \ElggMenuItem('avatar:edit', elgg_echo('avatar:edit'), $url);
        $item->setSection('action');
        $return[] = $item;
    }

    // prevent admins from banning or deleting themselves
    if (elgg_get_logged_in_user_guid() == $user->guid) {
        return $return;
    }

    if (elgg_is_admin_logged_in()) {
        $actions = array();
        if (!$user->isBanned()) {
            $actions[] = 'ban';
        } else {
            $actions[] = 'unban';
        }
        $actions[] = 'delete';
        $actions[] = 'resetpassword';
        if (!$user->isAdmin()) {
            $actions[] = 'makeadmin';
        } else {
            $actions[] = 'removeadmin';
        }

        foreach ($actions as $action) {
            $url = "action/admin/user/$action?guid={$user->guid}";
            $url = elgg_add_action_tokens_to_url($url);
            $item = new \ElggMenuItem($action, elgg_echo($action), $url);
            $item->setSection('admin');
            $item->setConfirmText(true);

            $return[] = $item;
        }

        $url = "profile/$user->username/edit";
        $item = new \ElggMenuItem('profile:edit', elgg_echo('profile:edit'), $url);
        $item->setSection('admin');
        $return[] = $item;
        
        $url = "avatar/edit/$user->username";
        $item = new \ElggMenuItem('avatar:edit', elgg_echo('avatar:edit'), $url);
        $item->setSection('admin');
        $return[] = $item;
        
        $url = "settings/user/$user->username";
        $item = new \ElggMenuItem('settings:edit', elgg_echo('settings:edit'), $url);
        $item->setSection('admin');
        $return[] = $item;

        $url = "activity/owner/$user->username";
        $item = new \ElggMenuItem('activity:owner', elgg_echo('activity:owner'), $url);
        $item->setSection('action');
        $return[] = $item;
    }

    return $return;
}

function elgg_users_setup_entity_menu($hook, $type, $return, $params) {
    if (elgg_in_context('widgets')) {
        return $return;
    }

    $entity = $params['entity'];
    if (!elgg_instanceof($entity, 'user')) {
        return $return;
    }
    /* @var \ElggUser $entity */

    if ($entity->isBanned()) {
        $banned = elgg_echo('banned');
        $options = array(
            'name' => 'banned',
            'text' => "<span>$banned</span>",
            'href' => false,
            'priority' => 0,
        );
        $return = array(\ElggMenuItem::factory($options));
    } else {
        $return = array();
        $location = $entity->location;
        if (is_string($location) && $location !== '') {
            $location = htmlspecialchars($location, ENT_QUOTES, 'UTF-8', false);
            $options = array(
                'name' => 'location',
                'text' => "<span>$location</span>",
                'href' => false,
                'priority' => 150,
            );
            $return[] = \ElggMenuItem::factory($options);
        }
    }

    return $return;
}

function elgg_profile_fields_setup() {
    global $CONFIG;

    $profile_defaults = array (
        'description' => 'longtext',
        'briefdescription' => 'text',
        'location' => 'location',
        'interests' => 'tags',
        'skills' => 'tags',
        'contactemail' => 'email',
        'phone' => 'text',
        'mobile' => 'text',
        'website' => 'url',
        'twitter' => 'text',
    );

    $loaded_defaults = array();
    $fieldlist = elgg_get_config('profile_custom_fields');
    if ($fieldlist || $fieldlist === '0') {
        $fieldlistarray = explode(',', $fieldlist);
        foreach ($fieldlistarray as $listitem) {
            if ($translation = elgg_get_config("admin_defined_profile_{$listitem}")) {
                $type = elgg_get_config("admin_defined_profile_type_{$listitem}");
                $loaded_defaults["admin_defined_profile_{$listitem}"] = $type;
                add_translation(get_current_language(), array("profile:admin_defined_profile_{$listitem}" => $translation));
            }
        }
    }

    if (count($loaded_defaults)) {
        $CONFIG->profile_using_custom = true;
        $profile_defaults = $loaded_defaults;
    }

    $CONFIG->profile_fields = elgg_trigger_plugin_hook('profile:fields', 'profile', null, $profile_defaults);

    // register any tag metadata names
    foreach ($CONFIG->profile_fields as $name => $type) {
        if ($type == 'tags' || $type == 'location' || $type == 'tag') {
            elgg_register_tag_metadata_name($name);
            // register a tag name translation
            add_translation(get_current_language(), array("tag_names:$name" => elgg_echo("profile:$name")));
        }
    }
}

function elgg_avatar_page_handler($page) {
    $user = get_user_by_username(elgg_extract(1, $page));
    if ($user) {
        elgg_set_page_owner_guid($user->getGUID());
    }

    if ($page[0] == 'edit') {
        echo elgg_view_resource("avatar/edit");
    } else {
        elgg_deprecated_notice("/avatar/view page handler has been deprecated and will be removed. Use elgg_get_inline_url() instead.", '2.2');
        echo elgg_view_resource("avatar/view", [
            'size' => elgg_extract(2, $page),
        ]);
    }

    return true;
}

function elgg_profile_page_handler($page) {
    $user = get_user_by_username($page[0]);
    elgg_set_page_owner_guid($user->guid);

    if ($page[1] == 'edit') {
        echo elgg_view_resource("profile/edit");
        return true;
    }
    return false;
}

function users_pagesetup() {

    $owner = elgg_get_page_owner_entity();
    $viewer = elgg_get_logged_in_user_entity();

    if ($owner) {
        elgg_register_menu_item('page', array(
            'name' => 'edit_avatar',
            'href' => "avatar/edit/{$owner->username}",
            'text' => elgg_echo('avatar:edit'),
            'section' => '1_profile',
            'contexts' => array('settings'),
        ));

        elgg_register_menu_item('page', array(
            'name' => 'edit_profile',
            'href' => "profile/{$owner->username}/edit",
            'text' => elgg_echo('profile:edit'),
            'section' => '1_profile',
            'contexts' => array('settings'),
        ));
    }

    // topbar
    if ($viewer) {
        elgg_register_menu_item('topbar', array(
            'name' => 'usersettings',
            'href' => "settings/user/{$viewer->username}",
            'text' => elgg_view_icon('settings') . elgg_echo('settings'),
            'priority' => 500,
            'section' => 'alt',
        ));

        elgg_register_menu_item('topbar', array(
            'name' => 'logout',
            'href' => "action/logout",
            'text' => elgg_echo('logout'),
            'is_action' => true,
            'priority' => 1000,
            'section' => 'alt',
        ));
    }
}

function _elgg_user_set_icon_file($hook, $type, $icon, $params) {

    $entity = elgg_extract('entity', $params);
    $size = elgg_extract('size', $params, 'medium');

    $icon->owner_guid = $entity->guid;
    $icon->setFilename("profile/{$entity->guid}{$size}.jpg");
    
    return $icon;
}

function users_init() {

    elgg_register_page_handler('register', 'elgg_user_account_page_handler');
    elgg_register_page_handler('forgotpassword', 'elgg_user_account_page_handler');
    elgg_register_page_handler('changepassword', 'elgg_user_account_page_handler');
    elgg_register_page_handler('login', 'elgg_user_account_page_handler');
    elgg_register_page_handler('avatar', 'elgg_avatar_page_handler');
    elgg_register_page_handler('profile', 'elgg_profile_page_handler');

    elgg_register_plugin_hook_handler('register', 'menu:user_hover', 'elgg_user_hover_menu');

    elgg_register_action('register', '', 'public');
    elgg_register_action('useradd', '', 'admin');
    elgg_register_action('avatar/upload');
    elgg_register_action('avatar/crop');
    elgg_register_action('avatar/remove');
    elgg_register_action('profile/edit');

    elgg_register_plugin_hook_handler('entity:icon:url', 'user', 'user_avatar_hook');

    elgg_register_action('user/changepassword', '', 'public');
    elgg_register_action('user/requestnewpassword', '', 'public');

    // Register the user type
    elgg_register_entity_type('user', '');

    elgg_register_plugin_hook_handler('register', 'menu:entity', 'elgg_users_setup_entity_menu', 501);

    elgg_register_event_handler('create', 'user', 'user_create_hook_add_site_relationship');

    elgg_register_plugin_hook_handler('entity:icon:file', 'user', '_elgg_user_set_icon_file');
}

function users_test($hook, $type, $value, $params) {
    global $CONFIG;
    $value[] = "{$CONFIG->path}engine/tests/ElggUserTest.php";
    return $value;
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', 'users_init', 0);
    $events->registerHandler('init', 'system', 'elgg_profile_fields_setup', 10000); // Ensure this runs after other plugins
    $events->registerHandler('pagesetup', 'system', 'users_pagesetup', 0);
    $hooks->registerHandler('unit_test', 'system', 'users_test');
};