security.js

Go to the documentation of this file.

elgg.provide('elgg.security.token');

elgg.security.tokenRefreshTimer = null;

elgg.security.setToken = function(token_object, valid_tokens) {
    // update the convenience object
    elgg.security.token = token_object;

    // also update all forms
    $('[name=__elgg_ts]').val(token_object.__elgg_ts);
    $('[name=__elgg_token]').each(function () {
        if (valid_tokens[$(this).val()]) {
            $(this).val(token_object.__elgg_token);
        }
    });

    // also update all links that contain tokens and time stamps
    $('[href*="__elgg_ts"][href*="__elgg_token"]').each(function() {
        var token = this.href.match(/__elgg_token=([0-9a-z_-]+)/i)[1];
        if (valid_tokens[token]) {
            this.href = this.href
                .replace(/__elgg_ts=\d+/i, '__elgg_ts=' + token_object.__elgg_ts)
                .replace(/__elgg_token=[0-9a-z_-]+/i, '__elgg_token=' + token_object.__elgg_token);
        }
    });
};

elgg.security.refreshToken = function() {
    // round up token pairs present
    var pairs = {};

    pairs[elgg.security.token.__elgg_ts + ',' + elgg.security.token.__elgg_token] = 1;

    $('form').each(function () {
        // we need consider only the last ts/token inputs, as those will be submitted
        var ts = $('[name=__elgg_ts]:last', this).val();
        var token = $('[name=__elgg_token]:last', this).val();
        // some forms won't have tokens
        if (token) {
            pairs[ts + ',' + token] = 1;
        }
    });

    $('[href*="__elgg_ts"][href*="__elgg_token"]').each(function() {
        var ts = this.href.match(/__elgg_ts=(\d+)/i)[1];
        var token = this.href.match(/__elgg_token=([0-9a-z_-]+)/i)[1];
        pairs[ts + ',' + token] = 1;
    });

    pairs = $.map(pairs, function(val, key) {
        return key;
    });

    elgg.ajax('refresh_token', {
        data: {
            pairs: pairs,
            session_token: elgg.session.token
        },
        dataType: 'json',
        method: 'POST',
        success: function(data) {
            if (data) {
                elgg.session.token = data.session_token;
                elgg.security.setToken(data.token, data.valid_tokens);

                if (elgg.get_logged_in_user_guid() != data.user_guid) {
                    elgg.session.user = null;
                    if (data.user_guid) {
                        elgg.register_error(elgg.echo('session_changed_user'));
                    } else {
                        elgg.register_error(elgg.echo('session_expired'));
                    }
                }
            }
        },
        error: function() {}
    });
};

elgg.security.addToken = function(data) {

    // 'http://example.com?data=sofar'
    if (elgg.isString(data)) {
        // is this a full URL, relative URL, or just the query string?
        var parts = elgg.parse_url(data),
            args = {},
            base = '';
        
        if (parts['host'] === undefined) {
            if (data.indexOf('?') === 0) {
                // query string
                base = '?';
                args = elgg.parse_str(parts['query']);
            }
        } else {
            // full or relative URL

            if (parts['query'] !== undefined) {
                // with query string
                args = elgg.parse_str(parts['query']);
            }
            var split = data.split('?');
            base = split[0] + '?';
        }
        args["__elgg_ts"] = elgg.security.token.__elgg_ts;
        args["__elgg_token"] = elgg.security.token.__elgg_token;

        return base + jQuery.param(args);
    }

    // no input!  acts like a getter
    if (elgg.isUndefined(data)) {
        return elgg.security.token;
    }

    // {...}
    if (elgg.isPlainObject(data)) {
        return elgg.extend(data, elgg.security.token);
    }

    // oops, don't recognize that!
    throw new TypeError("elgg.security.addToken not implemented for " + (typeof data) + "s");
};

elgg.security.init = function() {
    // elgg.security.interval is set in the js/elgg PHP view.
    elgg.security.tokenRefreshTimer = setInterval(elgg.security.refreshToken, elgg.security.interval);
};

elgg.register_hook_handler('boot', 'system', elgg.security.init);