pagehandler.php

Go to the documentation of this file.

<?php
function elgg_register_page_handler($identifier, $function) {
    return _elgg_services()->router->registerPageHandler($identifier, $function);
}

function elgg_unregister_page_handler($identifier) {
    _elgg_services()->router->unregisterPageHandler($identifier);
}

function elgg_gatekeeper() {
    if (!elgg_is_logged_in()) {
        _elgg_services()->session->set('last_forward_from', current_page_url());
        system_message(elgg_echo('loggedinrequired'));
        forward('/login', 'login');
    }
}

function gatekeeper() {
    elgg_gatekeeper();
}

function elgg_admin_gatekeeper() {
    elgg_gatekeeper();

    if (!elgg_is_admin_logged_in()) {
        _elgg_services()->session->set('last_forward_from', current_page_url());
        register_error(elgg_echo('adminrequired'));
        forward('', 'admin');
    }
}

function admin_gatekeeper() {
    elgg_admin_gatekeeper();
}

function elgg_group_gatekeeper($forward = true, $group_guid = null) {
    if (null === $group_guid) {
        $group_guid = elgg_get_page_owner_guid();
    }

    if (!$group_guid) {
        return true;
    }

    // this handles non-groups and invisible groups
    $visibility = \Elgg\GroupItemVisibility::factory($group_guid);

    if (!$visibility->shouldHideItems) {
        return true;
    }
    if ($forward) {
        // only forward to group if user can see it
        $group = get_entity($group_guid);
        $forward_url = $group ? $group->getURL() : '';

        if (!elgg_is_logged_in()) {
            _elgg_services()->session->set('last_forward_from', current_page_url());
            $forward_reason = 'login';
        } else {
            $forward_reason = 'member';
        }

        $msg_keys = array(
            'non_member' => 'membershiprequired',
            'logged_out' => 'loggedinrequired',
            'no_access' => 'noaccess',
        );
        register_error(elgg_echo($msg_keys[$visibility->reasonHidden]));
        forward($forward_url, $forward_reason);
    }

    return false;
}

function group_gatekeeper($forward = true, $page_owner_guid = null) {
    return elgg_group_gatekeeper($forward, $page_owner_guid);
}

function elgg_entity_gatekeeper($guid, $type = null, $subtype = null) {
    $entity = get_entity($guid);
    if (!$entity) {
        if (!elgg_entity_exists($guid)) {
            // entity doesn't exist
            forward('', '404');
        } elseif (!elgg_is_logged_in()) {
            // entity requires at least a logged in user
            elgg_gatekeeper();
        } else {
            // user is logged in but still does not have access to it
            register_error(elgg_echo('limited_access'));
            forward();
        }       
    }

    if ($type) {
        if (!elgg_instanceof($entity, $type, $subtype)) {
            // entity is of wrong type/subtype
            forward('', '404');
        }
    }
}

function elgg_front_page_handler() {

    if (elgg_is_logged_in()) {
        forward('activity');
    }

    $title = elgg_echo('content:latest');
    $content = elgg_list_river();
    if (!$content) {
        $content = elgg_echo('river:none');
    }

    $login_box = elgg_view('core/account/login_box');

    $params = array(
            'title' => $title,
            'content' => $content,
            'sidebar' => $login_box
    );
    $body = elgg_view_layout('one_sidebar', $params);
    echo elgg_view_page(null, $body);
    return true;
}

function elgg_error_page_handler($hook, $type, $result, $params) {
    if (elgg_view_exists("errors/$type")) {
        $title = elgg_echo("error:$type:title");
        if ($title == "error:$type:title") {
            // use default if there is no title for this error type
            $title = elgg_echo("error:default:title");
        }
        
        $content = elgg_view("errors/$type", $params);
    } else {
        $title = elgg_echo("error:default:title");
        $content = elgg_view("errors/default", $params);
    }
    
    $httpCodes = array(
        '400' => 'Bad Request',
        '401' => 'Unauthorized',
        '403' => 'Forbidden',
        '404' => 'Not Found',
        '407' => 'Proxy Authentication Required',
        '500' => 'Internal Server Error',
        '503' => 'Service Unavailable',
    );
    
    if (isset($httpCodes[$type])) {
        header("HTTP/1.1 $type {$httpCodes[$type]}");
    }

    $body = elgg_view_layout('error', array(
        'title' => $title,
        'content' => $content,
    ));
    echo elgg_view_page($title, $body, 'error');
    exit;
}

function _elgg_page_handler_init() {
    elgg_register_page_handler('', 'elgg_front_page_handler');
    // Registered at 600 so that plugins can register at the default 500 and get to run first
    elgg_register_plugin_hook_handler('forward', '400', 'elgg_error_page_handler', 600);
    elgg_register_plugin_hook_handler('forward', '403', 'elgg_error_page_handler', 600);
    elgg_register_plugin_hook_handler('forward', '404', 'elgg_error_page_handler', 600);
}

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