elgglib.js

Go to the documentation of this file.

var elgg = elgg || {};

elgg.global = this;

elgg.ACCESS_PRIVATE = 0;

elgg.nullFunction = function() {};

elgg.abstractMethod = function() {
    throw new Error("Oops... you forgot to implement an abstract method!");
};

elgg.extend = jQuery.extend;

elgg.isArray = jQuery.isArray;

elgg.isFunction = jQuery.isFunction;

elgg.isPlainObject = jQuery.isPlainObject;

elgg.isString = function(val) {
    return typeof val === 'string';
};

elgg.isNumber = function(val) {
    return typeof val === 'number';
};

elgg.isObject = function(val) {
    return typeof val === 'object';
};

elgg.isUndefined = function(val) {
    return val === undefined;
};

elgg.isNull = function(val) {
    return val === null;
};

elgg.isNullOrUndefined = function(val) {
    return val == null;
};

elgg.assertTypeOf = function(type, val) {
    if (typeof val !== type) {
        throw new TypeError("Expecting param of " +
                            arguments.caller + "to be a(n) " + type + "." +
                            "  Was actually a(n) " + typeof val + ".");
    }
};

elgg.require = function(pkg) {
    elgg.assertTypeOf('string', pkg);

    var parts = pkg.split('.'),
        cur = elgg.global,
        part, i;

    for (i = 0; i < parts.length; i += 1) {
        part = parts[i];
        cur = cur[part];
        if (elgg.isUndefined(cur)) {
            throw new Error("Missing package: " + pkg);
        }
    }
};

elgg.provide = function(pkg, opt_context) {
    var parts,
        context = opt_context || elgg.global,
        part, i;

    if (elgg.isArray(pkg)) {
        parts = pkg;
    } else {
        elgg.assertTypeOf('string', pkg);
        parts = pkg.split('.');
    }

    for (i = 0; i < parts.length; i += 1) {
        part = parts[i];
        context[part] = context[part] || {};
        context = context[part];
    }
};

elgg.inherit = function(Child, Parent) {
    Child.prototype = new Parent();
    Child.prototype.constructor = Child;
};

elgg.normalize_url = function(url) {
    url = url || '';
    elgg.assertTypeOf('string', url);

    function validate(url) {
        url = elgg.parse_url(url);
        if (url.scheme) {
            url.scheme = url.scheme.toLowerCase();
        }
        if (url.scheme == 'http' || url.scheme == 'https') {
            if (!url.host) {
                return false;
            }
            /* hostname labels may contain only alphanumeric characters, dots and hypens. */
            if (!(new RegExp("^([a-zA-Z0-9][a-zA-Z0-9\\-\\.]*)$", "i")).test(url.host) || url.host.charAt(-1) == '.') {
                return false;
            }
        }
        /* some schemas allow the host to be empty */
        if (!url.scheme || !url.host && url.scheme != 'mailto' && url.scheme != 'news' && url.scheme != 'file') {
            return false;
        }
        return true;
    };

    // ignore anything with a recognized scheme
    if (url.indexOf('http:') === 0 || url.indexOf('https:') === 0 || url.indexOf('javascript:') === 0 || url.indexOf('mailto:') === 0 ) {
        return url;
    } else if (validate(url)) {
        // all normal URLs including mailto:
        return url;
    } else if ((new RegExp("^(\\#|\\?|//)", "i")).test(url)) {
        // '//example.com' (Shortcut for protocol.)
        // '?query=test', #target
        return url;
    } else if ((new RegExp("^[^\/]*\\.php(\\?.*)?$", "i")).test(url)) {
        // watch those double escapes in JS.
        // 'install.php', 'install.php?step=step'
        return elgg.config.wwwroot + url.ltrim('/');
    } else if ((new RegExp("^[^/]*\\.", "i")).test(url)) {
        // 'example.com', 'example.com/subpage'
        return 'http://' + url;
    } else {
        // 'page/handler', 'mod/plugin/file.php'
        // trim off any leading / because the site URL is stored
        // with a trailing /
        return elgg.config.wwwroot + url.ltrim('/');
    }
};

elgg.system_messages = function(msgs, delay, type) {
    if (elgg.isUndefined(msgs)) {
        return;
    }

    var classes = ['elgg-message'],
        messages_html = [],
        appendMessage = function(msg) {
            messages_html.push('<li><div class="' + classes.join(' ') + '"><div class="elgg-inner"><div class="elgg-body">' + msg + '</div></div></div></li>');
        },
        systemMessages = $('ul.elgg-system-messages'),
        i;

    //validate delay.  Must be a positive integer.
    delay = parseInt(delay || 6000, 10);
    if (isNaN(delay) || delay <= 0) {
        delay = 6000;
    }

    //Handle non-arrays
    if (!elgg.isArray(msgs)) {
        msgs = [msgs];
    }

    if (type === 'error') {
        classes.push('elgg-message-error');
    } else {
        classes.push('elgg-message-success');
    }

    msgs.forEach(appendMessage);

    if (type != 'error') {
        $(messages_html.join('')).appendTo(systemMessages)
            .animate({opacity: '1.0'}, delay).fadeOut('slow');
    } else {
        $(messages_html.join('')).appendTo(systemMessages);
    }
};

elgg.clear_system_messages = function() {
    $('ul.elgg-system-messages').empty();
};

elgg.system_message = function(msgs, delay) {
    elgg.system_messages(msgs, delay, "message");
};

elgg.register_error = function(errors, delay) {
    elgg.system_messages(errors, delay, "error");
};

elgg.deprecated_notice = function(msg, dep_version) {
    if (elgg.is_admin_logged_in()) {
        msg = "Deprecated in Elgg " + dep_version + ": " + msg;
        if (typeof console !== "undefined") {
            console.info(msg);
        }
    }
};

elgg.forward = function(url) {
    var dest = elgg.normalize_url(url);

    if (dest == location.href) {
        location.reload();
    }

    // in case the href set below just changes the hash, we want to reload. There's sadly
    // no way to force a reload and set a different hash at the same time.
    $(window).on('hashchange', function () {
        location.reload();
    });

    location.href = dest;
};

elgg.parse_url = function(url, component, expand) {
    // Adapted from http://blog.stevenlevithan.com/archives/parseuri
    // which was release under the MIT
    // It was modified to fix mailto: and javascript: support.
    expand = expand || false;
    component = component || false;
    
    var re_str =
        // scheme (and user@ testing)
        '^(?:(?![^:@]+:[^:@/]*@)([^:/?#.]+):)?(?://)?'
        // possibly a user[:password]@
        + '((?:(([^:@]*)(?::([^:@]*))?)?@)?'
        // host and port
        + '([^:/?#]*)(?::(\\d*))?)'
        // path
        + '(((/(?:[^?#](?![^?#/]*\\.[^?#/.]+(?:[?#]|$)))*/?)?([^?#/]*))'
        // query string
        + '(?:\\?([^#]*))?'
        // fragment
        + '(?:#(.*))?)';
    var keys = {
        1: "scheme",
        4: "user",
        5: "pass",
        6: "host",
        7: "port",
        9: "path",
        12: "query",
        13: "fragment"
    };
    var results = {};

    if (url.indexOf('mailto:') === 0) {
        results['scheme'] = 'mailto';
        results['path'] = url.replace('mailto:', '');
        return results;
    }

    if (url.indexOf('javascript:') === 0) {
        results['scheme'] = 'javascript';
        results['path'] = url.replace('javascript:', '');
        return results;
    }

    var re = new RegExp(re_str);
    var matches = re.exec(url);

    for (var i in keys) {
        if (matches[i]) {
            results[keys[i]] = matches[i];
        }
    }

    if (expand && typeof(results['query']) != 'undefined') {
        results['query'] = elgg.parse_str(results['query']);
    }

    if (component) {
        if (typeof(results[component]) != 'undefined') {
            return results[component];
        } else {
            return false;
        }
    }
    return results;
};

elgg.parse_str = function(string) {
    var params = {},
        result,
        key,
        value,
        re = /([^&=]+)=?([^&]*)/g,
        re2 = /\[\]$/;

    // assignment intentional
    while (result = re.exec(string)) {
        key = decodeURIComponent(result[1].replace(/\+/g, ' '));
        value = decodeURIComponent(result[2].replace(/\+/g, ' '));

        if (re2.test(key)) {
            key = key.replace(re2, '');
            if (!params[key]) {
                params[key] = [];
            }
            params[key].push(value);
        } else {
            params[key] = value;
        }
    }
    
    return params;
};

elgg.getSelectorFromUrlFragment = function(url) {
    var fragment = url.split('#')[1];

    if (fragment) {
        // this is a .class or a tag.class
        if (fragment.indexOf('.') > -1) {
            return fragment;
        } else {
            // this is an id
            return '#' + fragment;
        }
    }
    return '';
};

elgg.push_to_object_array = function(object, parent, value) {
    elgg.assertTypeOf('object', object);
    elgg.assertTypeOf('string', parent);

    if (!(object[parent] instanceof Array)) {
        object[parent] = [];
    }

    if ($.inArray(value, object[parent]) < 0) {
        return object[parent].push(value);
    }

    return false;
};

elgg.is_in_object_array = function(object, parent, value) {
    elgg.assertTypeOf('object', object);
    elgg.assertTypeOf('string', parent);

    return typeof(object[parent]) != 'undefined' && $.inArray(value, object[parent]) >= 0;
};