src/cm/media/js/lib/yui/yui_3.10.3/build/cache-offline/cache-offline-debug.js
author gibus
Tue, 16 Jul 2013 14:29:46 +0200
changeset 525 89ef5ed3c48b
permissions -rw-r--r--
Upgrades to yui 3.10.3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
/*
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
YUI 3.10.3 (build 2fb5187)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
Copyright 2013 Yahoo! Inc. All rights reserved.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
Licensed under the BSD License.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
http://yuilibrary.com/license/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
*/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
YUI.add('cache-offline', function (Y, NAME) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
 * Provides a Cache subclass which uses HTML5 `localStorage` for persistence.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
 * 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
 * @module cache
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
 * @submodule cache-offline
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
 */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
 * Extends Cache utility with offline functionality.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
 * @class CacheOffline
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
 * @extends Cache
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
 * @constructor
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
 */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
function CacheOffline() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
    CacheOffline.superclass.constructor.apply(this, arguments);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
var localStorage = null,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
    JSON = Y.JSON;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
// Bug 2529572
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
try {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
    localStorage = Y.config.win.localStorage;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
catch(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
    Y.log("Could not access localStorage.", "warn", "cache");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
// CacheOffline events
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
/**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
* @event error
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
* @description Fired when an entry could not be added, most likely due to
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
* exceeded browser quota.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
* <dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
* <dt>error (Object)</dt> <dd>The error object.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
* </dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
*/
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
// CacheOffline static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
Y.mix(CacheOffline, {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
     * Class name.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
     * @property NAME
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
     * @type String
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
     * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
     * @final
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
     * @value "cacheOffline"
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
    NAME: "cacheOffline",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
    ATTRS: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
        /////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
        //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
        // CacheOffline Attributes
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
        //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
        /////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
        * @attribute sandbox
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
        * @description A string that must be passed in via the constructor.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
        * This identifier is used to sandbox one cache instance's entries
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
        * from another. Calling the cache instance's flush and length methods
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
        * or get("entries") will apply to only these sandboxed entries.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
        * @type String
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
        * @default "default"
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
        * @initOnly
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
        */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
        sandbox: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
            value: "default",
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
            writeOnce: "initOnly"
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
        * @attribute expires
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
        * @description Absolute Date when data expires or
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
        * relative number of milliseconds. Zero disables expiration.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
        * @type Date | Number
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
        * @default 86400000 (one day)
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
        */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
        expires: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
            value: 86400000
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
        * @attribute max
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
        * @description Disabled.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
        * @readOnly
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
        * @default null
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
        */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
        max: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
            value: null,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
            readOnly: true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
        },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
        /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
        * @attribute uniqueKeys
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
        * @description Always true for CacheOffline.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
        * @readOnly
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
        * @default true
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
        */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
        uniqueKeys: {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
            value: true,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
            readOnly: true,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
            setter: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
                return true;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
     * Removes all items from all sandboxes. Useful if localStorage has
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
     * exceeded quota. Only supported on browsers that implement HTML 5
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
     * localStorage.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
     * @method flushAll
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
     * @static
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
    flushAll: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
        var store = localStorage, key;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
        if(store) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
            if(store.clear) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
                store.clear();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
            // FF2.x and FF3.0.x
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
            else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
                for (key in store) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
                    if (store.hasOwnProperty(key)) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
                        store.removeItem(key);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
                        delete store[key];
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
                    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
                }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
            Y.log("All sandboxes of OfflineCache flushed", "info", "cache");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
        else {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
            Y.log("Could not flush all OfflineCache sandboxes.", "warn", "cache");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
Y.extend(CacheOffline, Y.Cache, localStorage ? {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
// Offline is supported
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
    /////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
    // CacheOffline protected methods
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
    /////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
     * Always return null.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
     * @method _setMax
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
     * @protected
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
    _setMax: function(value) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
        return null;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
     * Gets size.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
     * @method _getSize
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
     * @protected
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
    _getSize: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
        var count = 0,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
            i=0,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
            l=localStorage.length;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
        for(; i<l; ++i) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
            // Match sandbox id
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
            if(localStorage.key(i).indexOf(this.get("sandbox")) === 0) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
                count++;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
        return count;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
     * Gets all entries.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
     * @method _getEntries
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
     * @protected
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
    _getEntries: function() {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
        var entries = [],
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
            i=0,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
            l=localStorage.length,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
            sandbox = this.get("sandbox");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
        for(; i<l; ++i) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
            // Match sandbox id
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
            if(localStorage.key(i).indexOf(sandbox) === 0) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
                entries[i] = JSON.parse(localStorage.key(i).substring(sandbox.length));
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
        return entries;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
     * Adds entry to cache.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
     * @method _defAddFn
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
     * @param e {Event.Facade} Event Facade with the following properties:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
     * <dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
     * <dt>entry (Object)</dt> <dd>The cached entry.</dd>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
     * </dl>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
     * @protected
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
    _defAddFn: function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
        var entry = e.entry,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
            request = entry.request,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
            cached = entry.cached,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
            expires = entry.expires;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
        // Convert Dates to msecs on the way into localStorage
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
        entry.cached = cached.getTime();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
        entry.expires = expires ? expires.getTime() : expires;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
        try {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
            localStorage.setItem(this.get("sandbox")+JSON.stringify({"request":request}), JSON.stringify(entry));
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
            Y.log("Cached offline entry: " + Y.dump(entry), "info", "cache");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
        catch(error) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
            this.fire("error", {error:error});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
            Y.log("Could not cache offline entry: " + Y.dump(entry) +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
            " due to error: " + Y.dump(error), "warn", "cache");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
     * Flushes cache.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
     * @method _defFlushFn
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
     * @param e {Event.Facade} Event Facade object.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   257
     * @protected
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   258
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   259
    _defFlushFn: function(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   260
        var key,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   261
            i=localStorage.length-1;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   262
        for(; i>-1; --i) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   263
            // Match sandbox id
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   264
            key = localStorage.key(i);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   265
            if(key.indexOf(this.get("sandbox")) === 0) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   266
                localStorage.removeItem(key);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   267
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   268
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   269
    },
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   270
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   271
    /////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   272
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   273
    // CacheOffline public methods
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   274
    //
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   275
    /////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   276
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   277
     * Adds a new entry to the cache of the format
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   278
     * {request:request, response:response, cached:cached, expires: expires}.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   279
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   280
     * @method add
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   281
     * @param request {Object} Request value must be a String or JSON.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   282
     * @param response {Object} Response value must be a String or JSON.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   283
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   284
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   285
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   286
     * Retrieves cached object for given request, if available.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   287
     * Returns null if there is no cache match.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   288
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   289
     * @method retrieve
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   290
     * @param request {Object} Request object.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   291
     * @return {Object} Cached object with the properties request, response,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   292
     * and expires, or null.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   293
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   294
    retrieve: function(request) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   295
        this.fire("request", {request: request});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   296
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   297
        var entry, expires, sandboxedrequest;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   298
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   299
        try {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   300
            sandboxedrequest = this.get("sandbox")+JSON.stringify({"request":request});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   301
            try {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   302
                entry = JSON.parse(localStorage.getItem(sandboxedrequest));
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   303
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   304
            catch(e) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   305
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   306
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   307
        catch(e2) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   308
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   309
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   310
        if(entry) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   311
            // Convert msecs to Dates on the way out of localStorage
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   312
            entry.cached = new Date(entry.cached);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   313
            expires = entry.expires;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   314
            expires = !expires ? null : new Date(expires);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   315
            entry.expires = expires;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   316
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   317
            if(this._isMatch(request, entry)) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   318
                this.fire("retrieve", {entry: entry});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   319
                Y.log("Retrieved offlinecached response: " + Y.dump(entry) +
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   320
                        " for request: " + Y.dump(request), "info", "cache");
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   321
                return entry;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   322
            }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   323
        }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   324
        return null;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   325
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   326
} :
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   327
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   328
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   329
// Offline is not supported
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   330
//
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   331
/////////////////////////////////////////////////////////////////////////////
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   332
{
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   333
    /**
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   334
     * Always return null.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   335
     *
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   336
     * @method _setMax
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   337
     * @protected
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   338
     */
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   339
    _setMax: function(value) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   340
        return null;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   341
    }
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   342
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   343
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   344
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   345
Y.CacheOffline = CacheOffline;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   346
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   347
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   348
}, '3.10.3', {"requires": ["cache-base", "json"]});