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()->redirects->setLastForwardFrom();
        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()->redirects->setLastForwardFrom();
        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()->redirects->setLastForwardFrom();
            $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, $forward = true) {
    $entity = get_entity($guid);
    if (!$entity && $forward) {
        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();
        }
    } else if (!$entity) {
        return false;
    }

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

    $hook_type = "{$entity->getType()}:{$entity->getSubtype()}";
    $hook_params = [
        'entity' => $entity,
        'forward' => $forward,
    ];
    if (!elgg_trigger_plugin_hook('gatekeeper', $hook_type, $hook_params, true)) {
        if ($forward) {
            forward('', '403');
        } else {
            return false;
        }
    }

    return true;
}

function elgg_ajax_gatekeeper() {
    if (!elgg_is_xhr()) {
        register_error(_elgg_services()->translator->translate('ajax:not_is_xhr'));
        forward(null, '400');
    }
}

function elgg_front_page_handler() {
    return elgg_ok_response(elgg_view_resource('index'));
}

function elgg_error_page_handler($hook, $type, $result, $params) {
    elgg_deprecated_notice(__FUNCTION__ . ' is deprecated. Error pages are drawn by resource views without "forward" hook.', '2.3');
    
    // This draws an error page, and sometimes there's another 40* forward() call made during that
    // process (usually due to the pagesetup event). We want to allow the 2nd call to pass through,
    // but draw the appropriate page for the first call.
    
    static $vars;
    if ($vars === null) {
        // keep first vars for error page
        $vars = [
            'type' => $type,
            'params' => $params,
        ];
    }

    static $calls = 0;
    $calls++;
    if ($calls < 3) {
        echo elgg_view_resource('error', $vars);
        exit;
    }

    // uh oh, may be infinite loop
    register_error(elgg_echo('error:404:content'));
    header('Location: ' . elgg_get_site_url());
    exit;
}

function elgg_ok_response($content = '', $message = '', $forward_url = null, $status_code = ELGG_HTTP_OK) {
    if ($message) {
        system_message($message);
    }
    return new \Elgg\Http\OkResponse($content, $status_code, $forward_url);
    
}

function elgg_error_response($error = '', $forward_url = REFERRER, $status_code = ELGG_HTTP_OK) {
    if ($error) {
        register_error($error);
    }
    return new \Elgg\Http\ErrorResponse($error, $status_code, $forward_url);
}

function elgg_redirect_response($forward_url = REFERRER, $status_code = ELGG_HTTP_FOUND) {
    return new Elgg\Http\RedirectResponse($forward_url, $status_code);
}

function _elgg_page_handler_init() {
    elgg_register_page_handler('', 'elgg_front_page_handler');
}

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