Current File : /home/jvzmxxx/wiki1/extensions/MobileFrontend/resources/mobile.startup/settings.js

/**
 * Helper library for managing user and device specific settings
 * that makes use of localStorage and cookies as a fallback.
 * @class mw.mobileFrontend.settings
 * @singleton
 */
( function ( M, $ ) {

	var settings = ( function () {
		/**
		 * Checks whether cookies are enabled
		 * @method
		 * @return {boolean} Whether cookies are enabled
		 */
		function cookiesEnabled() {
			// If session cookie already set, return true
			if ( $.cookie( 'mf_testcookie' ) === 'test_value' ) {
				return true;
			// Otherwise try to set mf_testcookie and return true if it was set
			} else {
				$.cookie( 'mf_testcookie', 'test_value', {
					path: '/'
				} );
				return $.cookie( 'mf_testcookie' ) === 'test_value';
			}
		}

		/**
		 * Saves a user setting for a later browser settings via localStorage
		 * @method
		 * @param {string} name The key to refer to this value
		 * @param {string} value The value to store alongside the key
		 * @param {boolean} [useCookieFallback] When set this will use
		 * cookies when local storage not available.
		 * @return {boolean} Whether the save was successful or not
		 */
		function save( name, value, useCookieFallback ) {
			var success = mw.storage.set( name, value ),
				cookieOptions = {
					expires: 1
				};

			return !success && useCookieFallback ? Boolean( $.cookie( name, value, cookieOptions ) ) : success;
		}

		/**
		 * Retrieves a user setting from a previous browser setting
		 * @method
		 * @param {string} name The key to refer to this value
		 * @param {boolean} [useCookieFallback] When set this will use cookies
		 * when local storage not available.
		 * @return {string|boolean} Returns the associated value or False if nothing
		 * is found
		 */
		function get( name, useCookieFallback ) {
			var val = mw.storage.get( name );
			if ( val === false && useCookieFallback ) {
				return $.cookie( name );
			}
			return val;
		}

		/**
		 * Deletes a user setting from a previous browser setting
		 * @method
		 * @param {string} name The key to refer to this value
		 * @param {boolean} [useCookieFallback] When set this will use cookies
		 * when local storage not available.
		 * @return {boolean} Whether the delete was successful or not
		 */
		function remove( name, useCookieFallback ) {
			var success = mw.storage.remove( name );
			if ( !success && useCookieFallback ) {
				return $.removeCookie( name );
			} else {
				return success;
			}
		}

		return {
			get: get,
			save: save,
			remove: remove,
			cookiesEnabled: cookiesEnabled
		};
	}() );

	M.define( 'mobile.startup/settings', settings )
		.deprecate( 'mobile.settings/settings' );

}( mw.mobileFrontend, jQuery ) );