actions.php

Go to the documentation of this file.

<?php
function _elgg_action_handler(array $segments) {
    _elgg_services()->actions->execute(implode('/', $segments));
}

function action($action, $forwarder = "") {
    _elgg_services()->actions->execute($action, $forwarder);
}

function elgg_register_action($action, $filename = "", $access = 'logged_in') {
    return _elgg_services()->actions->register($action, $filename, $access);
}

function elgg_unregister_action($action) {
    return _elgg_services()->actions->unregister($action);
}

function elgg_build_hmac($data) {
    return _elgg_services()->crypto->getHmac($data);
}

function validate_action_token($visible_errors = true, $token = null, $ts = null) {
    return _elgg_services()->actions->validateActionToken($visible_errors, $token, $ts);
}

function action_gatekeeper($action) {
    return _elgg_services()->actions->gatekeeper($action);
}

function generate_action_token($timestamp) {
    return _elgg_services()->actions->generateActionToken($timestamp);
}

function init_site_secret() {
    return _elgg_services()->siteSecret->init();
}

function get_site_secret() {
    return _elgg_services()->siteSecret->get();
}

function _elgg_get_site_secret_strength() {
    return _elgg_services()->siteSecret->getStrength();
}

function elgg_action_exists($action) {
    return _elgg_services()->actions->exists($action);
}

function elgg_is_xhr() {
    return _elgg_services()->request->isXmlHttpRequest();
}

function ajax_forward_hook($hook, $type, $reason, $params) {
    _elgg_services()->actions->ajaxForwardHook($hook, $type, $reason, $params);
}

function ajax_action_hook() {
    _elgg_services()->actions->ajaxActionHook();
}

function _elgg_csrf_token_refresh() {
    if (!elgg_is_xhr()) {
        return false;
    }

    $actions = _elgg_services()->actions;

    // the page's session_token might have expired (not matching __elgg_session in the session), but
    // we still allow it to be given to validate the tokens in the page.
    $session_token = get_input('session_token', null, false);
    $pairs = (array)get_input('pairs', array(), false);
    $valid_tokens = (object)array();
    foreach ($pairs as $pair) {
        list($ts, $token) = explode(',', $pair, 2);
        if ($actions->validateTokenOwnership($token, $ts, $session_token)) {
            $valid_tokens->{$token} = true;
        }
    }

    $ts = time();
    $token = generate_action_token($ts);
    $data = array(
        'token' => array(
            '__elgg_ts' => $ts,
            '__elgg_token' => $token,
            'logged_in' => elgg_is_logged_in(),
        ),
        'valid_tokens' => $valid_tokens,
        'session_token' => elgg_get_session()->get('__elgg_session'),
        'user_guid' => elgg_get_logged_in_user_guid(),
    );

    header("Content-Type: application/json");
    echo json_encode($data);

    return true;
}

function actions_init() {
    elgg_register_page_handler('action', '_elgg_action_handler');
    elgg_register_page_handler('refresh_token', '_elgg_csrf_token_refresh');

    elgg_register_simplecache_view('js/languages/en');

    elgg_register_plugin_hook_handler('action', 'all', 'ajax_action_hook');
    elgg_register_plugin_hook_handler('forward', 'all', 'ajax_forward_hook');
}

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