CaffGeek/MBACNationals

View on GitHub
Web.Admin/2014/wordpress/wp-includes/js/utils.js

Summary

Maintainability
D
2 days
Test Coverage
/* global userSettings */
/* exported getUserSetting, setUserSetting, deleteUserSetting */
// utility functions

var wpCookies = {
// The following functions are from Cookie.js class in TinyMCE, Moxiecode, used under LGPL.

    each : function(obj, cb, scope) {
        var n, l;

        if ( !obj )
            return 0;

        scope = scope || obj;

        if ( typeof(obj.length) != 'undefined' ) {
            for ( n = 0, l = obj.length; n < l; n++ ) {
                if ( cb.call(scope, obj[n], n, obj) === false )
                    return 0;
            }
        } else {
            for ( n in obj ) {
                if ( obj.hasOwnProperty(n) ) {
                    if ( cb.call(scope, obj[n], n, obj) === false ) {
                        return 0;
                    }
                }
            }
        }
        return 1;
    },

    /**
     * Get a multi-values cookie.
     * Returns a JS object with the name: 'value' pairs.
     */
    getHash : function(name) {
        var all = this.get(name), ret;

        if ( all ) {
            this.each( all.split('&'), function(pair) {
                pair = pair.split('=');
                ret = ret || {};
                ret[pair[0]] = pair[1];
            });
        }
        return ret;
    },

    /**
     * Set a multi-values cookie.
     *
     * 'values_obj' is the JS object that is stored. It is encoded as URI in wpCookies.set().
     */
    setHash : function(name, values_obj, expires, path, domain, secure) {
        var str = '';

        this.each(values_obj, function(val, key) {
            str += (!str ? '' : '&') + key + '=' + val;
        });

        this.set(name, str, expires, path, domain, secure);
    },

    /**
     * Get a cookie.
     */
    get : function(name) {
        var e, b,
            cookie = document.cookie,
            p = name + '=';

        if ( !cookie )
            return;

        b = cookie.indexOf('; ' + p);

        if ( b == -1 ) {
            b = cookie.indexOf(p);

            if ( b !== 0 )
                return null;

        } else {
            b += 2;
        }

        e = cookie.indexOf( ';', b );

        if ( e == -1 )
            e = cookie.length;

        return decodeURIComponent( cookie.substring(b + p.length, e) );
    },

    /**
     * Set a cookie.
     *
     * The 'expires' arg can be either a JS Date() object set to the expiration date (back-compat)
     * or the number of seconds until expiration
     */
    set : function(name, value, expires, path, domain, secure) {
        var d = new Date();

        if ( typeof(expires) == 'object' && expires.toGMTString ) {
            expires = expires.toGMTString();
        } else if ( parseInt(expires, 10) ) {
            d.setTime( d.getTime() + ( parseInt(expires, 10) * 1000 ) ); // time must be in miliseconds
            expires = d.toGMTString();
        } else {
            expires = '';
        }

        document.cookie = name + '=' + encodeURIComponent( value ) +
            ( expires ? '; expires=' + expires : '' ) +
            ( path    ? '; path=' + path       : '' ) +
            ( domain  ? '; domain=' + domain   : '' ) +
            ( secure  ? '; secure'             : '' );
    },

    /**
     * Remove a cookie.
     *
     * This is done by setting it to an empty value and setting the expiration time in the past.
     */
    remove : function(name, path) {
        this.set(name, '', -1000, path);
    }
};

// Returns the value as string. Second arg or empty string is returned when value is not set.
function getUserSetting( name, def ) {
    var obj = getAllUserSettings();

    if ( obj.hasOwnProperty(name) )
        return obj[name];

    if ( typeof def != 'undefined' )
        return def;

    return '';
}

// Both name and value must be only ASCII letters, numbers or underscore
// and the shorter, the better (cookies can store maximum 4KB). Not suitable to store text.
function setUserSetting( name, value, _del ) {
    if ( 'object' !== typeof userSettings )
        return false;

    var cookie = 'wp-settings-' + userSettings.uid, all = wpCookies.getHash(cookie) || {}, path = userSettings.url,
    n = name.toString().replace(/[^A-Za-z0-9_]/, ''), v = value.toString().replace(/[^A-Za-z0-9_]/, '');

    if ( _del ) {
        delete all[n];
    } else {
        all[n] = v;
    }

    wpCookies.setHash(cookie, all, 31536000, path);
    wpCookies.set('wp-settings-time-'+userSettings.uid, userSettings.time, 31536000, path);

    return name;
}

function deleteUserSetting( name ) {
    return setUserSetting( name, '', 1 );
}

// Returns all settings as js object.
function getAllUserSettings() {
    if ( 'object' !== typeof userSettings )
        return {};

    return wpCookies.getHash('wp-settings-' + userSettings.uid) || {};
}