modoboa/static/js/history.js

var History = function(options) {
    this.initialize(options);
};

History.prototype = {
    constructor: History,

    defaults: {
        checkinterval: 300,
        defloadingtext: gettext("Loading..."),
        defloadingcolor: "gray",
        deflocation: null,
        defcallback: null
    },

    initialize: function(options) {
        this.options = $.extend({}, this.defaults, options);
        this.callbacks = {};
        this.base = '';
        this.serialized = null;
        this.updatenext = true;
        this.load_params();
        this.reset_loading_infos();
        if (this.options.defcallback) {
            this.register_callback("default", this.options.defcallback);
            this.check_id =
                setInterval($.proxy(this.check, this), this.options.checkinterval);
        }
    },

    load_params: function() {
        var rawqs = window.location.hash.substr(1);

        if (rawqs.indexOf('?') == -1) {
            this.params = {};
            return;
        }
        var tmp = rawqs.split('?');

        rawqs = (tmp.length == 1) ? tmp[0] : tmp[1];
        this.params = parse_qs(rawqs.split('&'));
    },

    paramslength: function() {
        return Object.keys(this.params).length;
    },

    reset_loading_infos: function() {
        this.loading_message = this.options.defloadingtext;
        this.loading_color = this.options.defloadingcolor;
    },

    reset: function() {
        this.base = "";
        this.params = {};
        return this;
    },

    parse_string: function(value, reset) {
        var splits = (value.charAt(0) == '#')
            ? value.substring(1).split('?') : value.split('?');

        if (splits.length == 0) {
            this.base = this.options.deflocation;
            return this;
        }
        if (reset === undefined) {
            reset = false;
        }
        if (reset) {
            this.reset();
        }

        if ((this.base = splits[0]) != "") {
            var re = new RegExp("/$");
            if (!this.base.match(re)) {
                this.base += '/';
            }
        }
        if (splits.length > 1) {
            var params = splits[1].split('&');
            for (var i = 0; i < params.length; i++) {
                var tmp = params[i].split('=');
                this.setparam(tmp[0], tmp[1]);
            }
        }
        return this;
    },

    from_string: function(value, reset) {
        this.parse_string(value);
        this.serialized = value;
        return this;
    },

    serialize: function() {
        var res = this.base;
        var args = "";

        if (this.paramslength() != 0) {
            args += "?";
            $.each(this.params, function(key, value) {
                if (args != "?") {
                    args += "&";
                }
                args += key + "=" + encodeURIComponent(value);
            });
        }
        return res + args;
    },

    update: function(force, noupdate) {
        location.hash = this.serialize();

        if (noupdate === undefined) {
            noupdate = false;
        }
        if (!noupdate) {
            if (force) {
                this.force = force;
            }
        } else {
            this.updatenext = false;
        }
    },

    updateparams: function(str) {
        if (str.charAt(0) == '?') {
            str = str.substring(1);
        }
        var elems = str.split('&');
        for (var i = 0; i < elems.length; i++) {
            this.setparamfromstring(elems[i]);
        }
        return this;
    },

    setparamfromstring: function(str) {
        var def = str.split('=');
        this.params[def[0]] = def[1];
    },

    setparam: function(name, value) {
        this.params[name] = value;
        return this;
    },

    setparams: function(params) {
        this.params = $.extend({}, this.params, params);
        return this;
    },

    getparam: function(name, defvalue) {
        if (this.params[name] === undefined) {
            return (defvalue != undefined) ? defvalue : undefined;
        }
        return this.params[name];
    },

    baseurl: function(value, noreset) {
        if (noreset === undefined || noreset == 0) {
            this.reset();
        }
        this.base = value;
        var re = new RegExp("/$");
        if (!this.base.match(re)) {
            this.base += '/';
        }
        return this;
    },

    addbaseurl: function(value) {
        var newbase = this.base + value;
        return this.baseurl(newbase);
    },

    getbaseurl: function() {
        return this.base.substr(0, this.base.length - 1);
    },

    delparam: function(name) {
        if (this.params[name] == undefined) {
            return this;
        }
        delete(this.params[name]);
        return this;
    },

    register_callback: function(name, callback) {
        this.callbacks[name] = callback;
    },

    get_callback: function(name) {
        return this.callbacks[name];
    },

    set_default_callback: function(callback) {
        this.register_callback("default", callback);
        if (this.ca_id === undefined) {
            this.ca_id =
                setInterval($.proxy(this.check, this), this.options.checkinterval);
        }
    },

    check: function() {
        if (this.serialized == location.hash && this.force === undefined) {
            return;
        }
        delete(this.force);
        this.from_string(decodeURIComponent(location.hash));
        if (!this.serialized) {
            location.hash = this.options.deflocation;
            return;
        }
        if (!this.updatenext) {
            this.updatenext = true;
            return;
        }
        var query = this.serialized.substring(1);

        $.ajax({
            url: query,
            cache: false,
            complete: $.proxy(function(XMLHttpRequest, textStatus) {
                var resp;
                try {
                    resp = $.parseJSON(XMLHttpRequest.responseText);
                } catch (e) {
                    resp = { status: 'ko', respmsg: gettext('Internal Error') };
                }
                if (resp.status == "ko") {
                    $("body").notify("error", resp.respmsg);
                    return;
                }
                var callback = (resp.callback != undefined) ? resp.callback : "default";
                this.callbacks[callback](resp);
            }, this)
        });
    }
};