users.php

Go to the documentation of this file.

<?php
function disable_user_entities($owner_guid) {
    try {
        $entity = get_entity($owner_guid);
        if (!$entity) {
            return false;
        }
        return _elgg_services()->entityTable->disableEntities($entity);
    } catch (DatabaseException $ex) {
        elgg_log($ex, 'ERROR');

        return false;
    }
}

function get_user($guid) {
    try {
        return _elgg_services()->entityTable->get($guid, 'user');
    } catch (InvalidParameterException $ex) {
        elgg_log($ex, 'ERROR');

        return false;
    } catch (ClassException $ex) {
        elgg_log($ex, 'ERROR');

        return false;
    }
}

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(array $options = []) {
    return _elgg_services()->usersTable->findActive($options);
}

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) {
    elgg()->accounts->assertValidUsername($username);
    return true;
}

function validate_password($password) {
    elgg()->accounts->assertValidPassword($password);
    return true;
}

function validate_email_address($address) {
    elgg()->accounts->assertValidEmail($address);
    return true;
}

function register_user($username, $password, $name, $email, $allow_multiple_emails = false, $subtype = null) {
    return elgg()->accounts->register($username, $password, $name, $email, $allow_multiple_emails, $subtype);
}

function elgg_validate_registration_data($username, $password, $name, $email, $allow_multiple_emails = false) {
    return elgg()->accounts->validateAccountData($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_get_registration_url(array $query = [], $fragment = '') {
    $url = elgg_normalize_url(elgg_generate_url('account: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(elgg_generate_url('account:login'));
    $url = elgg_http_add_url_query_elements($url, $query) . $fragment;
    return elgg_trigger_plugin_hook('login_url', 'site', $query, $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 ($user->canEdit()) {
        $return[] = ElggMenuItem::factory([
            'name' => 'avatar:edit',
            'text' => elgg_echo('avatar:edit'),
            'icon' => 'image',
            'href' => elgg_generate_entity_url($user, 'edit', 'avatar'),
            'section' => (elgg_get_logged_in_user_guid() == $user->guid)? 'action' : 'admin',
        ]);
    }

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

    if (!elgg_is_admin_logged_in()) {
        return $return;
    }

    // following items are admin only
    if (!$user->isBanned()) {
        $return[] = ElggMenuItem::factory([
            'name' => 'ban',
            'text' => elgg_echo('ban'),
            'icon' => 'ban',
            'href' => "action/admin/user/ban?guid={$user->guid}",
            'confirm' => true,
            'section' => 'admin',
        ]);
    } else {
        $return[] = ElggMenuItem::factory([
            'name' => 'unban',
            'text' => elgg_echo('unban'),
            'icon' => 'ban',
            'href' => "action/admin/user/unban?guid={$user->guid}",
            'confirm' => true,
            'section' => 'admin',
        ]);
    }

    $return[] = ElggMenuItem::factory([
        'name' => 'delete',
        'text' => elgg_echo('delete'),
        'icon' => 'delete',
        'href' => "action/admin/user/delete?guid={$user->guid}",
        'confirm' => true,
        'section' => 'admin',
    ]);

    $return[] = ElggMenuItem::factory([
        'name' => 'resetpassword',
        'text' => elgg_echo('resetpassword'),
        'icon' => 'refresh',
        'href' => "action/admin/user/resetpassword?guid={$user->guid}",
        'confirm' => true,
        'section' => 'admin',
    ]);

    if (!$user->isAdmin()) {
        $return[] = ElggMenuItem::factory([
            'name' => 'makeadmin',
            'text' => elgg_echo('makeadmin'),
            'icon' => 'level-up',
            'href' => "action/admin/user/makeadmin?guid={$user->guid}",
            'confirm' => true,
            'section' => 'admin',
        ]);
    } else {
        $return[] = ElggMenuItem::factory([
            'name' => 'removeadmin',
            'text' => elgg_echo('removeadmin'),
            'icon' => 'level-down',
            'href' => "action/admin/user/removeadmin?guid={$user->guid}",
            'confirm' => true,
            'section' => 'admin',
        ]);
    }

    $return[] = ElggMenuItem::factory([
        'name' => 'settings:edit',
        'text' => elgg_echo('settings:edit'),
        'icon' => 'cogs',
        'href' => "settings/user/$user->username",
        'section' => 'admin',
    ]);

    return $return;
}

function _elgg_user_title_menu(\Elgg\Hook $hook) {
    $user = $hook->getEntityParam();
    /* @var \ElggUser $user */

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

    if (!elgg_is_logged_in()) {
        return;
    }

    if (!$user->canEdit()) {
        return;
    }
    
    $return = $hook->getValue();
    $return[] = ElggMenuItem::factory([
        'name' => 'avatar:edit',
        'text' => elgg_echo('avatar:edit'),
        'icon' => 'image',
        'class' => ['elgg-button', 'elgg-button-action'],
        'href' => elgg_generate_entity_url($user, 'edit', 'avatar'),
    ]);
    
    return $return;
}

function _elgg_user_page_menu($hook, $type, $return, $params) {

    $owner = elgg_extract('entity', $params, elgg_get_page_owner_entity());

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

    if (!elgg_is_logged_in()) {
        return;
    }

    if (!$owner->canEdit()) {
        return;
    }

    $return[] = \ElggMenuItem::factory([
        'name' => 'edit_avatar',
        'href' => elgg_generate_entity_url($owner, 'edit', 'avatar'),
        'text' => elgg_echo('avatar:edit'),
        'section' => '1_profile',
        'contexts' => ['settings'],
    ]);

    return $return;
}

function _elgg_user_topbar_menu($hook, $type, $return, $params) {

    $viewer = elgg_get_logged_in_user_entity();
    if (!$viewer) {
        return;
    }

    $return[] = \ElggMenuItem::factory([
        'name' => 'account',
        'text' => elgg_echo('account'),
        'href' => $viewer->getURL(),
        'link_class' => 'elgg-avatar-small',
        'icon' => elgg_view('output/img', [
            'src' => $viewer->getIconURL('small'),
            'alt' => $viewer->getDisplayName(),
        ]),
        'icon_alt' => 'angle-down',
        'priority' => 800,
        'section' => 'alt',
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'usersettings',
        'parent_name' => 'account',
        'href' => "settings/user/{$viewer->username}",
        'text' => elgg_echo('settings'),
        'icon' => 'sliders',
        'priority' => 300,
        'section' => 'alt',
    ]);

    if ($viewer->isAdmin()) {
        $return[] = \ElggMenuItem::factory([
            'name' => 'administration',
            'parent_name' => 'account',
            'href' => 'admin',
            'text' => elgg_echo('admin'),
            'icon' => 'cogs',
            'priority' => 800,
            'section' => 'alt',
        ]);
    }

    $return[] = \ElggMenuItem::factory([
        'name' => 'logout',
        'parent_name' => 'account',
        'href' => 'action/logout',
        'text' => elgg_echo('logout'),
        'icon' => 'sign-out',
        'is_action' => true,
        'priority' => 900,
        'section' => 'alt',
    ]);

    return $return;
}

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 _elgg_user_get_subscriber_unban_action($hook, $type, $return_value, $params) {

    if (!_elgg_config()->security_notify_user_ban) {
        return;
    }

    $event = elgg_extract('event', $params);
    if (!$event instanceof \Elgg\Notifications\SubscriptionNotificationEvent) {
        return;
    }

    if ($event->getAction() !== 'unban') {
        return;
    }

    $user = $event->getObject();
    if (!$user instanceof \ElggUser) {
        return;
    }

    $return_value[$user->guid] = ['email'];

    return $return_value;
}

function _elgg_user_ban_notification($event, $type, $user) {

    if (!_elgg_config()->security_notify_user_ban) {
        return;
    }

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

    $site = elgg_get_site_entity();
    $language = $user->getLanguage();

    $subject = elgg_echo('user:notification:ban:subject', [$site->getDisplayName()], $language);
    $body = elgg_echo('user:notification:ban:body', [
        $user->getDisplayName(),
        $site->getDisplayName(),
        $site->getURL(),
    ], $language);

    $params = [
        'action' => 'ban',
        'object' => $user,
    ];

    notify_user($user->getGUID(), $site->getGUID(), $subject, $body, $params, ['email']);
}

function _elgg_user_prepare_unban_notification($hook, $type, $return_value, $params) {

    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
        return;
    }

    $recipient = elgg_extract('recipient', $params);
    $object = elgg_extract('object', $params);
    $language = elgg_extract('language', $params);

    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser)) {
        return;
    }

    if ($recipient->getGUID() !== $object->getGUID()) {
        return;
    }

    $site = elgg_get_site_entity();

    $return_value->subject = elgg_echo('user:notification:unban:subject', [$site->getDisplayName()], $language);
    $return_value->body = elgg_echo('user:notification:unban:body', [
        $recipient->getDisplayName(),
        $site->getDisplayName(),
        $site->getURL(),
    ], $language);

    $return_value->url = $recipient->getURL();

    return $return_value;
}

function _elgg_user_unvalidated_menu(\Elgg\Hook $hook) {
    
    if (!elgg_is_admin_logged_in()) {
        return;
    }
    
    $entity = $hook->getEntityParam();
    if (!$entity instanceof ElggUser || $entity->isValidated()) {
        return;
    }
    
    $return = $hook->getValue();
    
    $return[] = ElggMenuItem::factory([
        'name' => 'validate',
        'text' => elgg_echo('validate'),
        'href' => elgg_http_add_url_query_elements('action/admin/user/validate', [
            'user_guid' => $entity->guid,
        ]),
        'confirm' => true,
        'priority' => 400,
    ]);
    
    $return[] = ElggMenuItem::factory([
        'name' => 'delete',
        'text' => elgg_echo('delete'),
        'href' => elgg_http_add_url_query_elements('action/admin/user/delete', [
            'guid' => $entity->guid,
        ]),
        'confirm' => elgg_echo('deleteconfirm'),
        'priority' => 500,
    ]);
    
    return $return;
}

function users_init() {

    elgg_register_plugin_hook_handler('register', 'menu:user_hover', 'elgg_user_hover_menu');
    elgg_register_plugin_hook_handler('register', 'menu:title', '_elgg_user_title_menu');
    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_user_page_menu');
    elgg_register_plugin_hook_handler('register', 'menu:topbar', '_elgg_user_topbar_menu');
    elgg_register_plugin_hook_handler('register', 'menu:user:unvalidated', '_elgg_user_unvalidated_menu');

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

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

    elgg_register_notification_event('user', 'user', ['unban']);
    elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_user_get_subscriber_unban_action');
    elgg_register_event_handler('ban', 'user', '_elgg_user_ban_notification');
    elgg_register_plugin_hook_handler('prepare', 'notification:unban:user:user', '_elgg_user_prepare_unban_notification');

}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', 'users_init', 0);
};