ajax.js

Go to the documentation of this file.

/*globals elgg, $*/
elgg.provide('elgg.ajax');

elgg.ajax = function(url, options) {
    options = elgg.ajax.handleOptions(url, options);

    options.url = elgg.normalize_url(options.url);
    return $.ajax(options);
};
elgg.ajax.SUCCESS = 0;

elgg.ajax.ERROR = -1;

elgg.ajax.handleOptions = function(url, options) {
    var data_only = true,
        data,
        member;

    //elgg.ajax('example/file.php', {...});
    if (elgg.isString(url)) {
        options = options || {};

    //elgg.ajax({...});
    } else {
        options = url || {};
        url = options.url;
    }

    //elgg.ajax('example/file.php', function() {...});
    if (elgg.isFunction(options)) {
        data_only = false;
        options = {success: options};
    }

    //elgg.ajax('example/file.php', {data:{...}});
    if (options.data) {
        data_only = false;
    } else {
        for (member in options) {
            //elgg.ajax('example/file.php', {callback:function(){...}});
            if (elgg.isFunction(options[member])) {
                data_only = false;
            }
        }
    }

    //elgg.ajax('example/file.php', {notdata:notfunc});
    if (data_only) {
        data = options;
        options = {data: data};
    }

    if (!elgg.isFunction(options.error)) {
        // add a generic error handler
        options.error = function(xhr, status, error) { 
            elgg.ajax.handleAjaxError(xhr, status, error);
        };
    }
    
    if (url) {
        options.url = url;
    }

    return options;
};

elgg.ajax.handleAjaxError = function(xhr, status, error) {
    if (!xhr.getAllResponseHeaders()) {
        // user aborts (like refresh or navigate) do not have headers
        return;
    }
    
    elgg.register_error(elgg.echo('ajax:error'));
};

elgg.get = function(url, options) {
    options = elgg.ajax.handleOptions(url, options);

    options.type = 'get';
    return elgg.ajax(options);
};

elgg.getJSON = function(url, options) {
    options = elgg.ajax.handleOptions(url, options);

    options.dataType = 'json';
    return elgg.get(options);
};

elgg.post = function(url, options) {
    options = elgg.ajax.handleOptions(url, options);

    options.type = 'post';
    return elgg.ajax(options);
};

elgg.action = function(action, options) {
    elgg.assertTypeOf('string', action);

    // support shortcut and full URLs
    // this will mangle URLs that aren't elgg actions.
    // Use post, get, or ajax for those.
    if (action.indexOf('action/') < 0) {
        action = 'action/' + action;
    }

    options = elgg.ajax.handleOptions(action, options);

    // This is a misuse of elgg.security.addToken() because it is not always a
    // full query string with a ?. As such we need a special check for the tokens.
    if (!elgg.isString(options.data) || options.data.indexOf('__elgg_ts') == -1) {
        options.data = elgg.security.addToken(options.data);
    }
    options.dataType = 'json';

    //Always display system messages after actions
    var custom_success = options.success || elgg.nullFunction;
    options.success = function(json, two, three, four) {
        if (json && json.system_messages) {
            elgg.register_error(json.system_messages.error);
            elgg.system_message(json.system_messages.success);
        }

        custom_success(json, two, three, four);
    };

    return elgg.post(options);
};

elgg.api = function (method, options) {
    elgg.assertTypeOf('string', method);

    var defaults = {
        dataType: 'json',
        data: {}
    };

    options = elgg.ajax.handleOptions(method, options);
    options = $.extend(defaults, options);

    options.url = 'services/api/rest/' + options.dataType + '/';
    options.data.method = method;

    return elgg.ajax(options);
};