admin.php

Go to the documentation of this file.

<?php
function elgg_get_admins(array $options = array()) {
    global $CONFIG;

    if (isset($options['joins'])) {
        if (!is_array($options['joins'])) {
            $options['joins'] = array($options['joins']);
        }
        $options['joins'][] = "join {$CONFIG->dbprefix}users_entity u on e.guid=u.guid";
    } else {
        $options['joins'] = array("join {$CONFIG->dbprefix}users_entity u on e.guid=u.guid");
    }

    if (isset($options['wheres'])) {
        if (!is_array($options['wheres'])) {
            $options['wheres'] = array($options['wheres']);
        }
        $options['wheres'][] = "u.admin = 'yes'";
    } else {
        $options['wheres'][] = "u.admin = 'yes'";
    }

    return elgg_get_entities($options);
}

function elgg_add_admin_notice($id, $message) {
    if ($id && $message) {
        if (elgg_admin_notice_exists($id)) {
            return false;
        }

        // need to handle when no one is logged in
        $old_ia = elgg_set_ignore_access(true);

        $admin_notice = new ElggObject();
        $admin_notice->subtype = 'admin_notice';
        // admins can see ACCESS_PRIVATE but no one else can.
        $admin_notice->access_id = ACCESS_PRIVATE;
        $admin_notice->admin_notice_id = $id;
        $admin_notice->description = $message;

        $result = $admin_notice->save();

        elgg_set_ignore_access($old_ia);

        return (bool)$result;
    }

    return false;
}

function elgg_delete_admin_notice($id) {
    if (!$id) {
        return false;
    }
    $result = true;
    $notices = elgg_get_entities_from_metadata(array(
        'metadata_name' => 'admin_notice_id',
        'metadata_value' => $id
    ));

    if ($notices) {
        // in case a bad plugin adds many, let it remove them all at once.
        foreach ($notices as $notice) {
            $result = ($result && $notice->delete());
        }
        return $result;
    }
    return false;
}

function elgg_get_admin_notices($limit = 10) {
    return elgg_get_entities_from_metadata(array(
        'type' => 'object',
        'subtype' => 'admin_notice',
        'limit' => $limit
    ));
}

function elgg_admin_notice_exists($id) {
    $old_ia = elgg_set_ignore_access(true);
    $notice = elgg_get_entities_from_metadata(array(
        'type' => 'object',
        'subtype' => 'admin_notice',
        'metadata_name_value_pair' => array('name' => 'admin_notice_id', 'value' => $id)
    ));
    elgg_set_ignore_access($old_ia);

    return ($notice) ? true : false;
}

function elgg_register_admin_menu_item($section, $menu_id, $parent_id = null, $priority = 100) {

    // make sure parent is registered
    if ($parent_id && !elgg_is_menu_item_registered('page', $parent_id)) {
        elgg_register_admin_menu_item($section, $parent_id);
    }

    // in the admin section parents never have links
    if ($parent_id) {
        $href = "admin/$parent_id/$menu_id";
    } else {
        $href = null;
    }

    $name = $menu_id;
    if ($parent_id) {
        $name = "$parent_id:$name";
    }

    return elgg_register_menu_item('page', array(
        'name' => $name,
        'href' => $href,
        'text' => elgg_echo("admin:$name"),
        'context' => 'admin',
        'parent_name' => $parent_id,
        'priority' => $priority,
        'section' => $section
    ));
}

function _elgg_create_notice_of_pending_upgrade($event, $type, $object) {
    if ($object instanceof ElggUpgrade) {
        // Link to the Upgrades section
        $link = elgg_view('output/url', array(
            '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_event_handler('pagesetup', 'system', '_elgg_admin_pagesetup', 1000);

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

        elgg_register_menu_item('topbar', array(
            'name' => 'maintenance_mode',
            'href' => 'admin/administer_utilities/maintenance',
            'text' => elgg_echo('admin:maintenance_mode:indicator_menu_item'),
            'priority' => 900,
        ));
    }

    elgg_register_action('admin/user/ban', '', 'admin');
    elgg_register_action('admin/user/unban', '', 'admin');
    elgg_register_action('admin/user/delete', '', 'admin');
    elgg_register_action('admin/user/resetpassword', '', 'admin');
    elgg_register_action('admin/user/makeadmin', '', 'admin');
    elgg_register_action('admin/user/removeadmin', '', 'admin');

    elgg_register_action('admin/site/update_basic', '', 'admin');
    elgg_register_action('admin/site/update_advanced', '', 'admin');
    elgg_register_action('admin/site/flush_cache', '', 'admin');
    elgg_register_action('admin/site/unlock_upgrade', '', 'admin');
    elgg_register_action('admin/site/set_robots', '', 'admin');
    elgg_register_action('admin/site/set_maintenance_mode', '', 'admin');

    elgg_register_action('admin/upgrades/upgrade_comments', '', 'admin');
    elgg_register_action('admin/upgrades/upgrade_datadirs', '', 'admin');
    elgg_register_action('admin/upgrades/upgrade_discussion_replies', '', 'admin');
    elgg_register_action('admin/site/regenerate_secret', '', 'admin');

    elgg_register_action('admin/menu/save', '', 'admin');

    elgg_register_action('admin/delete_admin_notice', '', 'admin');

    elgg_register_action('profile/fields/reset', '', 'admin');
    elgg_register_action('profile/fields/add', '', 'admin');
    elgg_register_action('profile/fields/edit', '', 'admin');
    elgg_register_action('profile/fields/delete', '', 'admin');
    elgg_register_action('profile/fields/reorder', '', 'admin');

    elgg_register_simplecache_view('css/admin');
    $url = elgg_get_simplecache_url('js', 'admin');
    elgg_register_js('elgg.admin', $url);
    elgg_register_js('elgg.upgrades', 'js/lib/upgrades.js');
    elgg_register_js('jquery.jeditable', 'vendors/jquery/jquery.jeditable.mini.js');

    // administer
    // dashboard
    elgg_register_menu_item('page', array(
        'name' => 'dashboard',
        'href' => 'admin/dashboard',
        'text' => elgg_echo('admin:dashboard'),
        'context' => 'admin',
        'priority' => 10,
        'section' => 'administer'
    ));
    // statistics
    elgg_register_admin_menu_item('administer', 'statistics', null, 20);
    elgg_register_admin_menu_item('administer', 'overview', 'statistics');
    elgg_register_admin_menu_item('administer', 'server', 'statistics');
    //utilities
    elgg_register_admin_menu_item('administer', 'maintenance', 'administer_utilities');

    // users
    elgg_register_admin_menu_item('administer', 'users', null, 20);
    elgg_register_admin_menu_item('administer', 'online', 'users', 10);
    elgg_register_admin_menu_item('administer', 'admins', 'users', 20);
    elgg_register_admin_menu_item('administer', 'newest', 'users', 30);
    elgg_register_admin_menu_item('administer', 'add', 'users', 40);

    // configure
    // upgrades
    elgg_register_menu_item('page', array(
        'name' => 'upgrades',
        'href' => 'admin/upgrades',
        'text' => elgg_echo('admin:upgrades'),
        'context' => 'admin',
        'priority' => 10,
        'section' => 'configure'
    ));

    // plugins
    elgg_register_menu_item('page', array(
        'name' => 'plugins',
        'href' => 'admin/plugins',
        'text' => elgg_echo('admin:plugins'),
        'context' => 'admin',
        'priority' => 75,
        'section' => 'configure'
    ));

    // settings
    elgg_register_admin_menu_item('configure', 'appearance', null, 50);
    elgg_register_admin_menu_item('configure', 'settings', null, 100);
    elgg_register_admin_menu_item('configure', 'basic', 'settings', 10);
    elgg_register_admin_menu_item('configure', 'advanced', 'settings', 20);
    // plugin settings are added in _elgg_admin_add_plugin_settings_menu() via the admin page handler
    // for performance reasons.

    // appearance
    elgg_register_admin_menu_item('configure', 'menu_items', 'appearance', 30);
    elgg_register_admin_menu_item('configure', 'profile_fields', 'appearance', 40);
    // default widgets is added via an event handler elgg_default_widgets_init() in widgets.php
    // because it requires additional setup.

    // configure utilities
    elgg_register_admin_menu_item('configure', 'robots', 'configure_utilities');

    // we want plugin settings menu items to be sorted alphabetical
    if (elgg_in_context('admin')) {
        elgg_register_plugin_hook_handler('prepare', 'menu:page', '_elgg_admin_sort_page_menu');
    }

    if (elgg_is_admin_logged_in()) {
        elgg_register_menu_item('topbar', array(
            'name' => 'administration',
            'href' => 'admin',
            'text' => elgg_view_icon('settings') . elgg_echo('admin'),
            'priority' => 100,
            'section' => 'alt',
        ));
    }

    // widgets
    $widgets = array('online_users', 'new_users', 'content_stats', 'banned_users', 'admin_welcome', 'control_panel');
    foreach ($widgets as $widget) {
        elgg_register_widget_type(
                $widget,
                elgg_echo("admin:widget:$widget"),
                elgg_echo("admin:widget:$widget:help"),
                array('admin')
        );
    }

    // automatic adding of widgets for admin
    elgg_register_event_handler('make_admin', 'user', '_elgg_add_admin_widgets');

    // Add notice about pending upgrades
    elgg_register_event_handler('create', 'object', '_elgg_create_notice_of_pending_upgrade');

    elgg_register_page_handler('admin', '_elgg_admin_page_handler');
    elgg_register_page_handler('admin_plugin_screenshot', '_elgg_admin_plugin_screenshot_page_handler');
    elgg_register_page_handler('admin_plugin_text_file', '_elgg_admin_markdown_page_handler');
    elgg_register_page_handler('robots.txt', '_elgg_robots_page_handler');
}

function _elgg_admin_pagesetup() {
    if (elgg_in_context('admin')) {
        $url = elgg_get_simplecache_url('css', 'admin');
        elgg_register_css('elgg.admin', $url);
        elgg_load_css('elgg.admin');
        elgg_unregister_css('elgg');

        // setup footer menu
        elgg_register_menu_item('admin_footer', array(
            'name' => 'faq',
            'text' => elgg_echo('admin:footer:faq'),
            'href' => 'http://learn.elgg.org/en/stable/appendix/faqs.html',
        ));

        elgg_register_menu_item('admin_footer', array(
            'name' => 'manual',
            'text' => elgg_echo('admin:footer:manual'),
            'href' => 'http://learn.elgg.org/en/stable/admin/index.html',
        ));

        elgg_register_menu_item('admin_footer', array(
            'name' => 'community_forums',
            'text' => elgg_echo('admin:footer:community_forums'),
            'href' => 'http://community.elgg.org/groups/all/',
        ));

        elgg_register_menu_item('admin_footer', array(
            'name' => 'blog',
            'text' => elgg_echo('admin:footer:blog'),
            'href' => 'http://blog.elgg.org/',
        ));
    }
}

function _elgg_admin_add_plugin_settings_menu() {

    $active_plugins = elgg_get_plugins('active');
    if (!$active_plugins) {
        // nothing added because no items
        return;
    }

    foreach ($active_plugins as $plugin) {
        $plugin_id = $plugin->getID();
        $settings_view_old = 'settings/' . $plugin_id . '/edit';
        $settings_view_new = 'plugins/' . $plugin_id . '/settings';
        if (elgg_view_exists($settings_view_new) || elgg_view_exists($settings_view_old)) {
            elgg_register_menu_item('page', array(
                'name' => $plugin_id,
                'href' => "admin/plugin_settings/$plugin_id",
                'text' => $plugin->getManifest()->getName(),
                'parent_name' => 'settings',
                'context' => 'admin',
                'section' => 'configure',
            ));
        }
    }
}

function _elgg_admin_sort_page_menu($hook, $type, $return, $params) {
    $configure_items = $return['configure'];
    if (is_array($configure_items)) {
        /* @var ElggMenuItem[] $configure_items */
        foreach ($configure_items as $menu_item) {
            if ($menu_item->getName() == 'settings') {
                $settings = $menu_item;
            }
        }

        if (!empty($settings) && $settings instanceof ElggMenuItem) {
            // keep the basic and advanced settings at the top
            /* @var ElggMenuItem $settings */
            $children = $settings->getChildren();
            $site_settings = array_splice($children, 0, 2);
            usort($children, array('ElggMenuBuilder', 'compareByText'));
            array_splice($children, 0, 0, $site_settings);
            $settings->setChildren($children);
        }
    }
}

function _elgg_admin_page_handler($page) {

    elgg_admin_gatekeeper();
    _elgg_admin_add_plugin_settings_menu();
    elgg_set_context('admin');

    elgg_unregister_css('elgg');
    elgg_load_js('elgg.admin');
    elgg_load_js('jquery.jeditable');

    // default to dashboard
    if (!isset($page[0]) || empty($page[0])) {
        $page = array('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 = array('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("settings/{$page[1]}/edit") ||
            elgg_view_exists("plugins/{$page[1]}/settings"))) {

            $view = 'admin/plugin_settings';
            $plugin = elgg_get_plugin_from_id($page[1]);
            $vars['plugin'] = $plugin;

            $title = elgg_echo("admin:{$page[0]}");
        } 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', array('content' => $content, 'title' => $title));
    echo elgg_view_page($title, $body, 'admin');
    return true;
}

function _elgg_admin_plugin_screenshot_page_handler($pages) {
    // only admins can use this for security
    elgg_admin_gatekeeper();

    $plugin_id = elgg_extract(0, $pages);
    // only thumbnail or full.
    $size = elgg_extract(1, $pages, 'thumbnail');

    // the rest of the string is the filename
    $filename_parts = array_slice($pages, 2);
    $filename = implode('/', $filename_parts);
    $filename = sanitise_filepath($filename, false);

    $plugin = elgg_get_plugin_from_id($plugin_id);
    if (!$plugin) {
        $file = elgg_get_root_path() . '_graphics/icons/default/medium.png';
    } else {
        $file = $plugin->getPath() . $filename;
        if (!file_exists($file)) {
            $file = elgg_get_root_path() . '_graphics/icons/default/medium.png';
        }
    }

    header("Content-type: image/jpeg");

    // resize to 100x100 for thumbnails
    switch ($size) {
        case 'thumbnail':
            echo get_resized_image_from_existing_file($file, 100, 100, true);
            break;

        case 'full':
        default:
            echo file_get_contents($file);
            break;
    }
    return true;
}

function _elgg_admin_markdown_page_handler($pages) {
    elgg_admin_gatekeeper();
    _elgg_admin_add_plugin_settings_menu();
    elgg_set_context('admin');

    elgg_unregister_css('elgg');
    elgg_load_js('elgg.admin');
    elgg_load_js('jquery.jeditable');
    elgg_load_library('elgg:markdown');

    $plugin_id = elgg_extract(0, $pages);
    $plugin = elgg_get_plugin_from_id($plugin_id);
    $filename = elgg_extract(1, $pages);

    $error = false;
    if (!$plugin) {
        $error = elgg_echo('admin:plugins:markdown:unknown_plugin');
        $body = elgg_view_layout('admin', array('content' => $error, 'title' => $error));
        echo elgg_view_page($error, $body, 'admin');
        return true;
    }

    $text_files = $plugin->getAvailableTextFiles();

    if (!array_key_exists($filename, $text_files)) {
        $error = elgg_echo('admin:plugins:markdown:unknown_file');
    }

    $file = $text_files[$filename];
    $file_contents = file_get_contents($file);

    if (!$file_contents) {
        $error = elgg_echo('admin:plugins:markdown:unknown_file');
    }

    if ($error) {
        $title = $error;
        $body = elgg_view_layout('admin', array('content' => $error, 'title' => $title));
        echo elgg_view_page($title, $body, 'admin');
        return true;
    }

    $title = $plugin->getManifest()->getName() . ": $filename";
    $text = Markdown($file_contents);

    $body = elgg_view_layout('admin', array(
        // setting classes here because there's no way to pass classes
        // to the layout
        'content' => '<div class="elgg-markdown">' . $text . '</div>',
        'title' => $title
    ));

    echo elgg_view_page($title, $body, 'admin');
    return true;
}

function _elgg_robots_page_handler() {
    $site = elgg_get_site_entity();
    header("Content-type: text/plain");
    $content = $site->getPrivateSetting('robots.txt');
    $plugin_content = elgg_trigger_plugin_hook('robots.txt', 'site', array('site' => $site), '');
    if ($plugin_content) {
        $content = $content . "\n\n" . $plugin_content;
    }
    echo $content;

    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 = array(
        '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');

    $site = elgg_get_site_entity();
    $message = $site->getPrivateSetting('elgg_maintenance_message');
    if (!$message) {
        $message = elgg_echo('admin:maintenance_mode:default_message');
    }

    elgg_load_css('maintenance');

    header("HTTP/1.1 503 Service Unavailable");

    $body = elgg_view_layout('maintenance', array(
        'message' => $message,
        'site' => $site,
    ));
    echo elgg_view_page($site->name, $body, '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 ($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) {
    elgg_set_ignore_access(true);

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

    // In the form column => array of handlers in order, top to bottom
    $adminWidgets = array(
        1 => array('control_panel', 'admin_welcome'),
        2 => array('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) {
                $widget = get_entity($guid);
                /* @var ElggWidget $widget */
                $widget->move($column, $position);
            }
        }
    }
    elgg_set_ignore_access(false);
}

elgg_register_event_handler('init', 'system', '_elgg_admin_init');