admin.php

Go to the documentation of this file.

<?php
use Elgg\Menu\MenuItems;
use Elgg\Database\QueryBuilder;

function elgg_get_admins(array $options = []) {
    $options['type'] = 'user';
    $options['metadata_name_value_pairs'] = elgg_extract('metadata_name_value_pairs', $options, []);
    
    $options['metadata_name_value_pairs']['admin'] = 'yes';

    return elgg_get_entities($options);
}

function elgg_add_admin_notice($id, $message) {
    return _elgg_services()->adminNotices->add($id, $message);
}

function elgg_delete_admin_notice($id) {
    return _elgg_services()->adminNotices->delete($id);
}

function elgg_get_admin_notices(array $options = []) {
    return _elgg_services()->adminNotices->find($options);
}

function elgg_admin_notice_exists($id) {
    return _elgg_services()->adminNotices->exists($id);
}

function _elgg_create_notice_of_pending_upgrade($event, $type, $object) {
    if (!$object instanceof \ElggUpgrade) {
        return;
    }
    
    // Link to the Upgrades section
    $link = elgg_view('output/url', [
        'href' => 'admin/upgrades',
        'text' => elgg_echo('admin:view_upgrades'),
    ]);

    $message = elgg_echo('admin:pending_upgrades');

    elgg_add_admin_notice('pending_upgrades', "$message $link");
}

function _elgg_admin_init() {

    elgg_register_css('elgg.admin', elgg_get_simplecache_url('admin.css'));
    elgg_register_css('admin/users/unvalidated', elgg_get_simplecache_url('admin/users/unvalidated.css'));

    elgg_define_js('admin/users/unvalidated', [
        'src' => elgg_get_simplecache_url('admin/users/unvalidated.js'),
    ]);
    
    elgg_extend_view('admin.css', 'lightbox/elgg-colorbox-theme/colorbox.css');
        
    elgg_register_plugin_hook_handler('register', 'menu:admin_header', '_elgg_admin_header_menu');
    elgg_register_plugin_hook_handler('register', 'menu:admin_footer', '_elgg_admin_footer_menu');
    elgg_register_plugin_hook_handler('register', 'menu:filter:admin/upgrades', '_elgg_admin_upgrades_menu');
    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_admin_page_menu');
    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_admin_page_menu_plugin_settings');
    elgg_register_plugin_hook_handler('register', 'menu:user:unvalidated:bulk', '_elgg_admin_user_unvalidated_bulk_menu');

    // maintenance mode
    if (elgg_get_config('elgg_maintenance_mode', null)) {
        elgg_register_plugin_hook_handler('route', 'all', '_elgg_admin_maintenance_handler', 600);
        elgg_register_plugin_hook_handler('action', 'all', '_elgg_admin_maintenance_action_check', 600);
        elgg_register_css('maintenance', elgg_get_simplecache_url('maintenance.css'));

        elgg_register_menu_item('topbar', [
            'name' => 'maintenance_mode',
            'href' => 'admin/configure_utilities/maintenance',
            'text' => elgg_echo('admin:maintenance_mode:indicator_menu_item'),
            'icon' => 'wrench',
            'priority' => 900,
        ]);
    }

    elgg_register_simplecache_view('admin.css');
    
    // widgets
    $widgets = ['online_users', 'new_users', 'content_stats', 'banned_users', 'admin_welcome', 'control_panel', 'cron_status'];
    foreach ($widgets as $widget) {
        elgg_register_widget_type(
                $widget,
                elgg_echo("admin:widget:$widget"),
                elgg_echo("admin:widget:$widget:help"),
                ['admin']
        );
    }

    // automatic adding of widgets for admin
    elgg_register_event_handler('make_admin', 'user', '_elgg_add_admin_widgets');
    
    elgg_register_notification_event('user', 'user', ['make_admin', 'remove_admin']);
    elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_admin_get_admin_subscribers_admin_action');
    elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_admin_get_user_subscriber_admin_action');
    elgg_register_plugin_hook_handler('prepare', 'notification:make_admin:user:user', '_elgg_admin_prepare_admin_notification_make_admin');
    elgg_register_plugin_hook_handler('prepare', 'notification:make_admin:user:user', '_elgg_admin_prepare_user_notification_make_admin');
    elgg_register_plugin_hook_handler('prepare', 'notification:remove_admin:user:user', '_elgg_admin_prepare_admin_notification_remove_admin');
    elgg_register_plugin_hook_handler('prepare', 'notification:remove_admin:user:user', '_elgg_admin_prepare_user_notification_remove_admin');
    
    // Add notice about pending upgrades
    elgg_register_event_handler('create', 'object', '_elgg_create_notice_of_pending_upgrade');
}

function _elgg_ajax_plugins_update() {
    elgg_admin_gatekeeper();
    elgg_set_context('admin');

    return elgg_ok_response([
        'list' => elgg_view('admin/plugins', ['list_only' => true]),
        'sidebar' => elgg_view('admin/sidebar'),
    ]);
}

function _elgg_admin_header_menu($hook, $type, $return, $params) {
    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
        return;
    }

    $admin = elgg_get_logged_in_user_entity();

    $return[] = \ElggMenuItem::factory([
        'name' => 'account',
        'text' => $admin->getDisplayName(),
        'href' => $admin->getURL(),
        'icon' => elgg_view('output/img', [
            'src' => $admin->getIconURL('small'),
            'alt' => $admin->getDisplayName(),
        ]),
        'link_class' => 'elgg-avatar-small',
        'priority' => 1000,
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'admin_logout',
        'href' => 'action/logout',
        'text' => elgg_echo('logout'),
        'priority' => 900,
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'view_site',
        'href' => elgg_get_site_url(),
        'text' => elgg_echo('admin:view_site'),
        'priority' => 800,
    ]);

    if (elgg_get_config('elgg_maintenance_mode')) {
        $return[] = \ElggMenuItem::factory([
            'name' => 'maintenance',
            'href' => 'admin/configure_utilities/maintenance',
            'text' => elgg_echo('admin:configure_utilities:maintenance'),
            'link_class' => 'elgg-maintenance-mode-warning',
            'priority' => 700,
        ]);
    }
    
    return $return;
}

function _elgg_admin_footer_menu($hook, $type, $return, $params) {
    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
        return;
    }

    $return[] = \ElggMenuItem::factory([
        'name' => 'faq',
        'text' => elgg_echo('admin:footer:faq'),
        'href' => 'http://learn.elgg.org/en/stable/appendix/faqs.html',
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'manual',
        'text' => elgg_echo('admin:footer:manual'),
        'href' => 'http://learn.elgg.org/en/stable/admin/index.html',
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'community_forums',
        'text' => elgg_echo('admin:footer:community_forums'),
        'href' => 'http://elgg.org/groups/all/',
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'blog',
        'text' => elgg_echo('admin:footer:blog'),
        'href' => 'https://elgg.org/blog/all',
    ]);
    
    return $return;
}

function _elgg_admin_page_menu(\Elgg\Hook $hook) {
    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
        return;
    }
    
    $return = $hook->getValue();

    // administer
    $return[] = \ElggMenuItem::factory([
        'name' => 'dashboard',
        'href' => 'admin',
        'text' => elgg_echo('admin:dashboard'),
        'priority' => 10,
        'section' => 'administer',
    ]);
    
    $return[] = \ElggMenuItem::factory([
        'name' => 'plugins',
        'href' => 'admin/plugins',
        'text' => elgg_echo('admin:plugins'),
        'priority' => 30,
        'section' => 'administer',
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'users',
        'text' => elgg_echo('admin:users'),
        'priority' => 40,
        'section' => 'administer',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'users:online',
        'text' => elgg_echo('admin:users:online'),
        'href' => 'admin/users/online',
        'priority' => 10,
        'section' => 'administer',
        'parent_name' => 'users',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'users:admins',
        'text' => elgg_echo('admin:users:admins'),
        'href' => 'admin/users/admins',
        'priority' => 20,
        'section' => 'administer',
        'parent_name' => 'users',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'users:newest',
        'text' => elgg_echo('admin:users:newest'),
        'href' => 'admin/users/newest',
        'priority' => 30,
        'section' => 'administer',
        'parent_name' => 'users',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'users:add',
        'text' => elgg_echo('admin:users:add'),
        'href' => 'admin/users/add',
        'priority' => 40,
        'section' => 'administer',
        'parent_name' => 'users',
    ]);
    
    $return[] = \ElggMenuItem::factory([
        'name' => 'users:unvalidated',
        'text' => elgg_echo('admin:users:unvalidated'),
        'href' => 'admin/users/unvalidated',
        'priority' => 50,
        'section' => 'administer',
        'parent_name' => 'users',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'upgrades',
        'href' => 'admin/upgrades',
        'text' => elgg_echo('admin:upgrades'),
        'priority' => 600,
        'section' => 'administer',
    ]);
    
    $return[] = \ElggMenuItem::factory([
        'name' => 'administer_utilities',
        'text' => elgg_echo('admin:administer_utilities'),
        'priority' => 50,
        'section' => 'administer',
    ]);
    
    // configure
    $return[] = \ElggMenuItem::factory([
        'name' => 'settings:basic',
        'href' => 'admin/settings/basic',
        'text' => elgg_echo('admin:settings:basic'),
        'priority' => 10,
        'section' => 'configure',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'settings:advanced',
        'href' => 'admin/settings/advanced',
        'text' => elgg_echo('admin:settings:advanced'),
        'priority' => 20,
        'section' => 'configure',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'security',
        'href' => 'admin/security',
        'text' => elgg_echo('admin:security'),
        'priority' => 30,
        'section' => 'configure',
    ]);

    $return[] = \ElggMenuItem::factory([
        'name' => 'configure_utilities',
        'text' => elgg_echo('admin:configure_utilities'),
        'priority' => 600,
        'section' => 'configure',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'configure_utilities:maintenance',
        'text' => elgg_echo('admin:configure_utilities:maintenance'),
        'href' => 'admin/configure_utilities/maintenance',
        'section' => 'configure',
        'parent_name' => 'configure_utilities',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'configure_utilities:menu_items',
        'text' => elgg_echo('admin:configure_utilities:menu_items'),
        'href' => 'admin/configure_utilities/menu_items',
        'section' => 'configure',
        'parent_name' => 'configure_utilities',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'configure_utilities:robots',
        'text' => elgg_echo('admin:configure_utilities:robots'),
        'href' => 'admin/configure_utilities/robots',
        'section' => 'configure',
        'parent_name' => 'configure_utilities',
    ]);
    
    // information
    $return[] = \ElggMenuItem::factory([
        'name' => 'statistics',
        'href' => 'admin/statistics',
        'text' => elgg_echo('admin:statistics'),
        'section' => 'information',
    ]);
    $return[] = \ElggMenuItem::factory([
        'name' => 'server',
        'href' => 'admin/server',
        'text' => elgg_echo('admin:server'),
        'section' => 'information',
    ]);
        
    return $return;
}

function _elgg_admin_page_menu_plugin_settings(\Elgg\Hook $hook) {
    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
        return;
    }
    
    // plugin settings
    $active_plugins = elgg_get_plugins('active');
    if (empty($active_plugins)) {
        // nothing added because no items
        return;
    }
    
    $plugins_with_settings = [];
    
    foreach ($active_plugins as $plugin) {
        $plugin_id = $plugin->getID();
        
        if (!elgg_view_exists("plugins/{$plugin_id}/settings") ) {
            continue;
        }
        $plugin_name = $plugin->getDisplayName();
        $plugins_with_settings[$plugin_name] = [
            'name' => $plugin_id,
            'href' => "admin/plugin_settings/$plugin_id",
            'text' => $plugin_name,
            'parent_name' => 'plugin_settings',
            'section' => 'configure',
        ];
    }
    
    if (empty($plugins_with_settings)) {
        return;
    }

    $return = $hook->getValue();
    
    $return[] = \ElggMenuItem::factory([
        'name' => 'plugin_settings',
        'text' => elgg_echo('admin:plugin_settings'),
        'section' => 'configure',
    ]);
    
    ksort($plugins_with_settings);
    $priority = 0;
    foreach ($plugins_with_settings as $plugin_item) {
        $priority += 10;
        $plugin_item['priority'] = $priority;
        $return[] = \ElggMenuItem::factory($plugin_item);
    }
    
    return $return;
}

function _elgg_admin_user_unvalidated_bulk_menu(\Elgg\Hook $hook) {
    
    if (!elgg_is_admin_logged_in()) {
        return;
    }
    
    $return = $hook->getValue();
    
    $return[] = ElggMenuItem::factory([
        'name' => 'select_all',
        'text' => elgg_view('input/checkbox', [
            'name' => 'select_all',
            'label' => elgg_echo('all'),
            'id' => 'admin-users-unvalidated-bulk-select',
        ]),
        'href' => false,
        'priority' => 100,
        'deps' => 'admin/users/unvalidated',
    ]);
    
    $return[] = ElggMenuItem::factory([
        'id' => 'admin-users-unvalidated-bulk-validate',
        'name' => 'bulk_validate',
        'text' => elgg_echo('validate'),
        'href' => 'action/admin/user/bulk/validate',
        'confirm' => true,
        'priority' => 400,
        'section' => 'right',
        'deps' => 'admin/users/unvalidated',
    ]);
    
    $return[] = ElggMenuItem::factory([
        'id' => 'admin-users-unvalidated-bulk-delete',
        'name' => 'bulk_delete',
        'text' => elgg_echo('delete'),
        'href' => 'action/admin/user/bulk/delete',
        'confirm' => elgg_echo('deleteconfirm:plural'),
        'priority' => 500,
        'section' => 'right',
        'deps' => 'admin/users/unvalidated',
    ]);
    
    return $return;
}

function _elgg_admin_page_handler($page) {
    elgg_admin_gatekeeper();
    elgg_set_context('admin');

    elgg_unregister_css('elgg');
    elgg_require_js('elgg/admin');

    // default to dashboard
    if (!isset($page[0]) || empty($page[0])) {
        $page = ['dashboard'];
    }

    // was going to fix this in the page_handler() function but
    // it's commented to explicitly return a string if there's a trailing /
    if (empty($page[count($page) - 1])) {
        array_pop($page);
    }

    $vars = ['page' => $page];

    // special page for plugin settings since we create the form for them
    if ($page[0] == 'plugin_settings') {
        if (isset($page[1]) && (elgg_view_exists("plugins/{$page[1]}/settings"))) {
            $view = 'admin/plugin_settings';
            $plugin = elgg_get_plugin_from_id($page[1]);
            $vars['plugin'] = $plugin; // required for plugin settings backward compatibility
            $vars['entity'] = $plugin;

            $title = elgg_echo("admin:{$page[0]}") . ': ' . $plugin->getDisplayName();
        } else {
            forward('', '404');
        }
    } else {
        $view = 'admin/' . implode('/', $page);
        $title = elgg_echo("admin:{$page[0]}");
        if (count($page) > 1) {
            $title .= ' : ' . elgg_echo('admin:' .  implode(':', $page));
        }
    }

    // gets content and prevents direct access to 'components' views
    if ($page[0] == 'components' || !($content = elgg_view($view, $vars))) {
        $title = elgg_echo('admin:unknown_section');
        $content = elgg_echo('admin:unknown_section');
    }

    $body = elgg_view_layout('admin', ['content' => $content, 'title' => $title]);
    echo elgg_view_page($title, $body, 'admin');
    return true;
}

function _elgg_admin_maintenance_allow_url($current_url) {
    $site_path = preg_replace('~^https?~', '', elgg_get_site_url());
    $current_path = preg_replace('~^https?~', '', $current_url);
    if (0 === strpos($current_path, $site_path)) {
        $current_path = ($current_path === $site_path) ? '' : substr($current_path, strlen($site_path));
    } else {
        $current_path = false;
    }

    // allow plugins to control access for specific URLs/paths
    $params = [
        'current_path' => $current_path,
        'current_url' => $current_url,
    ];
    return (bool) elgg_trigger_plugin_hook('maintenance:allow', 'url', $params, false);
}

function _elgg_admin_maintenance_handler($hook, $type, $info) {
    if (elgg_is_admin_logged_in()) {
        return;
    }

    if ($info['identifier'] == 'action' && $info['segments'][0] == 'login') {
        return;
    }

    if (_elgg_admin_maintenance_allow_url(current_page_url())) {
        return;
    }

    elgg_unregister_plugin_hook_handler('register', 'menu:login', '_elgg_login_menu_setup');

    echo elgg_view_resource('maintenance');

    return false;
}

function _elgg_admin_maintenance_action_check($hook, $type) {
    if (elgg_is_admin_logged_in()) {
        return true;
    }

    if ($type == 'login') {
        $username = get_input('username');

        $user = get_user_by_username($username);

        if (!$user) {
            $users = get_user_by_email($username);
            if (!empty($users)) {
                $user = $users[0];
            }
        }

        if ($user && $user->isAdmin()) {
            return true;
        }
    }

    if (_elgg_admin_maintenance_allow_url(current_page_url())) {
        return true;
    }

    register_error(elgg_echo('actionunauthorized'));

    return false;
}

function _elgg_add_admin_widgets($event, $type, $user) {
    $ia = elgg_set_ignore_access(true);

    // check if the user already has widgets
    if (elgg_get_widgets($user->getGUID(), 'admin')) {
        elgg_set_ignore_access($ia);
        return;
    }

    // In the form column => array of handlers in order, top to bottom
    $adminWidgets = [
        1 => ['control_panel', 'admin_welcome'],
        2 => ['online_users', 'new_users', 'content_stats'],
    ];

    foreach ($adminWidgets as $column => $handlers) {
        foreach ($handlers as $position => $handler) {
            $guid = elgg_create_widget($user->getGUID(), $handler, 'admin');
            if ($guid !== false) {
                $widget = get_entity($guid);
                /* @var \ElggWidget $widget */
                $widget->move($column, $position);
            }
        }
    }
    
    elgg_set_ignore_access($ia);
}

function _elgg_admin_get_admin_subscribers_admin_action($hook, $type, $return_value, $params) {
    
    if (!_elgg_config()->security_notify_admins) {
        return;
    }
    
    $event = elgg_extract('event', $params);
    if (!$event instanceof \Elgg\Notifications\SubscriptionNotificationEvent) {
        return;
    }
    
    if (!in_array($event->getAction(), ['make_admin', 'remove_admin'])) {
        return;
    }
    
    $user = $event->getObject();
    if (!$user instanceof \ElggUser) {
        return;
    }
    
    /* @var $admin_batch \Elgg\BatchResult */
    $admin_batch = elgg_get_admins([
        'limit' => false,
        'wheres' => [
            function (QueryBuilder $qb, $main_alias) use ($user) {
                return $qb->compare("{$main_alias}.guid", '!=', $user->guid, ELGG_VALUE_GUID);
            },
        ],
        'batch' => true,
    ]);
    
    /* @var $admin \ElggUser */
    foreach ($admin_batch as $admin) {
        $return_value[$admin->guid] = ['email'];
    }
    
    return $return_value;
}

function _elgg_admin_prepare_admin_notification_make_admin($hook, $type, $return_value, $params) {
    
    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
        return;
    }
    
    $recipient = elgg_extract('recipient', $params);
    $object = elgg_extract('object', $params);
    $actor = elgg_extract('sender', $params);
    $language = elgg_extract('language', $params);
    
    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
        return;
    }
    
    if ($recipient->getGUID() === $object->getGUID()) {
        // recipient is the user being acted on, this is handled elsewhere
        return;
    }
    
    $site = elgg_get_site_entity();
    
    $return_value->subject = elgg_echo('admin:notification:make_admin:admin:subject', [$site->getDisplayName()], $language);
    $return_value->body = elgg_echo('admin:notification:make_admin:admin:body', [
        $recipient->getDisplayName(),
        $actor->getDisplayName(),
        $object->getDisplayName(),
        $site->getDisplayName(),
        $object->getURL(),
        $site->getURL(),
    ], $language);

    $return_value->url = elgg_normalize_url('admin/users/admins');
    
    return $return_value;
}

function _elgg_admin_prepare_admin_notification_remove_admin($hook, $type, $return_value, $params) {
    
    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
        return;
    }
    
    $recipient = elgg_extract('recipient', $params);
    $object = elgg_extract('object', $params);
    $actor = elgg_extract('sender', $params);
    $language = elgg_extract('language', $params);
    
    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
        return;
    }
    
    if ($recipient->getGUID() === $object->getGUID()) {
        // recipient is the user being acted on, this is handled elsewhere
        return;
    }
    
    $site = elgg_get_site_entity();
    
    $return_value->subject = elgg_echo('admin:notification:remove_admin:admin:subject', [$site->getDisplayName()], $language);
    $return_value->body = elgg_echo('admin:notification:remove_admin:admin:body', [
        $recipient->getDisplayName(),
        $actor->getDisplayName(),
        $object->getDisplayName(),
        $site->getDisplayName(),
        $object->getURL(),
        $site->getURL(),
    ], $language);

    $return_value->url = elgg_normalize_url('admin/users/admins');
    
    return $return_value;
}

function _elgg_admin_get_user_subscriber_admin_action($hook, $type, $return_value, $params) {
    
    if (!_elgg_config()->security_notify_user_admin) {
        return;
    }
    
    $event = elgg_extract('event', $params);
    if (!$event instanceof \Elgg\Notifications\SubscriptionNotificationEvent) {
        return;
    }
    
    if (!in_array($event->getAction(), ['make_admin', 'remove_admin'])) {
        return;
    }
    
    $user = $event->getObject();
    if (!$user instanceof \ElggUser) {
        return;
    }
    
    $return_value[$user->guid] = ['email'];
    
    return $return_value;
}

function _elgg_admin_prepare_user_notification_make_admin($hook, $type, $return_value, $params) {
    
    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
        return;
    }
    
    $recipient = elgg_extract('recipient', $params);
    $object = elgg_extract('object', $params);
    $actor = elgg_extract('sender', $params);
    $language = elgg_extract('language', $params);
    
    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
        return;
    }
    
    if ($recipient->getGUID() !== $object->getGUID()) {
        // recipient is some other user, this is handled elsewhere
        return;
    }
    
    $site = elgg_get_site_entity();
    
    $return_value->subject = elgg_echo('admin:notification:make_admin:user:subject', [$site->getDisplayName()], $language);
    $return_value->body = elgg_echo('admin:notification:make_admin:user:body', [
        $recipient->getDisplayName(),
        $actor->getDisplayName(),
        $site->getDisplayName(),
        $site->getURL(),
    ], $language);

    $return_value->url = elgg_normalize_url('admin');
    
    return $return_value;
}

function _elgg_admin_prepare_user_notification_remove_admin($hook, $type, $return_value, $params) {
    
    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
        return;
    }
    
    $recipient = elgg_extract('recipient', $params);
    $object = elgg_extract('object', $params);
    $actor = elgg_extract('sender', $params);
    $language = elgg_extract('language', $params);
    
    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
        return;
    }
    
    if ($recipient->getGUID() !== $object->getGUID()) {
        // recipient is some other user, this is handled elsewhere
        return;
    }
    
    $site = elgg_get_site_entity();
    
    $return_value->subject = elgg_echo('admin:notification:remove_admin:user:subject', [$site->getDisplayName()], $language);
    $return_value->body = elgg_echo('admin:notification:remove_admin:user:body', [
        $recipient->getDisplayName(),
        $actor->getDisplayName(),
        $site->getDisplayName(),
        $site->getURL(),
    ], $language);

    $return_value->url = '';
    
    return $return_value;
}

function _elgg_admin_upgrades_menu(\Elgg\Hook $hook) {
    
    $result = $hook->getValue();
    
    $selected = $hook->getParam('filter_value');
    
    $result[] = ElggMenuItem::factory([
        'name' => 'pending',
        'text' => elgg_echo('admin:upgrades:menu:pending'),
        'href' => 'admin/upgrades',
        'priority' => 100,
        'selected' => $selected === 'pending',
    ]);
    
    $result[] = ElggMenuItem::factory([
        'name' => 'completed',
        'text' => elgg_echo('admin:upgrades:menu:completed'),
        'href' => 'admin/upgrades/finished',
        'priority' => 200,
        'selected' => $selected === 'completed',
    ]);
    
    $result[] = ElggMenuItem::factory([
        'name' => 'db',
        'text' => elgg_echo('admin:upgrades:menu:db'),
        'href' => 'admin/upgrades/db',
        'priority' => 300,
        'selected' => $selected === 'db',
    ]);
    
    return $result;
}

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