aboutsummaryrefslogtreecommitdiffstats
path: root/admin/themes/default/js/LocalStorageCache.js
blob: 4fb1d286072fb75424af6e367c972c22e4078ae3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
(function($, exports) {
  "use strict";
  
  /**
   * Base LocalStorage cache
   *
   * @param options {object}
   *    - key (required) identifier of the collection
   *    - serverId (recommended) identifier of the Piwigo instance
   *    - serverKey (required) state of collection server-side
   *    - lifetime (optional) cache lifetime in seconds
   *    - loader (required) function called to fetch data, takes a callback as first argument
   *        which must be called with the loaded date
   */
  var LocalStorageCache = function(options) {
    this._init(options);
  };

  /*
   * Constructor (deported for easy inheritance)
   */
  LocalStorageCache.prototype._init = function(options) {
    this.key = options.key + '_' + options.serverId;
    this.serverKey = options.serverKey;
    this.lifetime = options.lifetime ? options.lifetime*1000 : 3600*1000;
    this.loader = options.loader;
    
    this.storage = window.localStorage;
    this.ready = !!this.storage;
  };

  /*
   * Get the cache content
   * @param callback {function} called with the data as first parameter
   */
  LocalStorageCache.prototype.get = function(callback) {
    var now = new Date().getTime(),
        that = this;
    
    if (this.ready && this.storage[this.key] != undefined) {
      var cache = JSON.parse(this.storage[this.key]);
      
      if (now - cache.timestamp <= this.lifetime && cache.key == this.serverKey) {
        callback(cache.data);
        return;
      }
    }
    
    this.loader(function(data) {
      that.set.call(that, data);
      callback(data);
    });
  };

  /*
   * Manually set the cache content
   * @param data {mixed}
   */
  LocalStorageCache.prototype.set = function(data) {
    if (this.ready) {
      this.storage[this.key] = JSON.stringify({
        timestamp: new Date().getTime(),
        key: this.serverKey,
        data: data
      });
    }
  };

  /*
   * Manually clear the cache
   */
  LocalStorageCache.prototype.clear = function() {
    if (this.ready) {
      this.storage.removeItem(this.key);
    }
  };

  
  /**
   * Abstract class containing common initialization code for selectize
   */
  var AbstractSelectizer = function(){};
  AbstractSelectizer.prototype = new LocalStorageCache({});

  /*
   * Load Selectize with cache content
   * @param $target {jQuery} may have some data attributes (create, default, value)
   * @param options {object}
   *    - value (optional) list of preselected items (ids, or objects with "id" attribute")
   *    - default (optional) default value which will be forced if the select is emptyed
   *    - create (optional) allow item user creation
   *    - filter (optional) function called for each select before applying the data
   *      takes two parameters: cache data, options
   *      must return new data
   */
  AbstractSelectizer.prototype._selectize = function($target, globalOptions) {
    this.get(function(data) {
      $target.each(function() {
        var filtered, value, defaultValue,
            options = $.extend({}, globalOptions);
        
        // apply filter function
        if (options.filter != undefined) {
          filtered = options.filter.call(this, data, options);
        }
        else {
          filtered = data;
        }
        
        // active creation mode
        if (this.hasAttribute('data-create')) {
          options.create = true;
        }
        this.selectize.settings.create = !!options.create;

        // load options
        this.selectize.load(function(callback) {
          if ($.isEmptyObject(this.options)) {
            callback(filtered);
          }
        });

        // load items
        if ((value = $(this).data('value'))) {
          options.value = value;
        }
        if (options.value != undefined) {
          $.each(value, $.proxy(function(i, cat) {
            if ($.isNumeric(cat))
              this.selectize.addItem(cat);
            else
              this.selectize.addItem(cat.id);
          }, this));
        }
        
        // set default
        if ((defaultValue = $(this).data('default'))) {
          options.default = defaultValue;
        }
        if (options.default == 'first') {
          options.default = filtered[0] ? filtered[0].id : undefined;
        }
        
        if (options.default != undefined) {
          // add default item
          if (this.selectize.getValue() == '') {
            this.selectize.addItem(options.default);
          }

          // if multiple: prevent item deletion
          if (this.multiple) {
            this.selectize.getItem(options.default).find('.remove').hide();
            
            this.selectize.on('item_remove', function(id) {
              if (id == options.default) {
                this.addItem(id);
                this.getItem(id).find('.remove').hide();
              }
            });
          }
          // if single: restore default on blur
          else {
            this.selectize.on('dropdown_close', function() {
              if (this.getValue() == '') {
                this.addItem(options.default);
              }
            });
          }
        }
      });
    });
  };
  
  // redefine Selectize templates without escape
  AbstractSelectizer.getRender = function(field_label, lang) {
    lang = lang || { 'Add': 'Add' };

  	return {
      'option': function(data, escape) {
        return '<div class="option">' + data[field_label] + '</div>';
      },
      'item': function(data, escape) {
        return '<div class="item">' + data[field_label] + '</div>';
      },
      'option_create': function(data, escape) {
        return '<div class="create">' + lang['Add'] + ' <strong>' + data.input + '</strong>&hellip;</div>';
      }
    };
  };


  /**
   * Special LocalStorage for admin categories list
   *
   * @param options {object}
   *    - serverId (recommended) identifier of the Piwigo instance
   *    - serverKey (required) state of collection server-side
   *    - rootUrl (required) used for WS call
   */
  var CategoriesCache = function(options) {
    options.key = 'categoriesAdminList';
    
    options.loader = function(callback) {
      $.getJSON(options.rootUrl + 'ws.php?format=json&method=pwg.categories.getAdminList', function(data) {
        var cats = data.result.categories.map(function(c, i) {
          c.pos = i;
          delete c['comment'];
          delete c['uppercats'];
          return c;
        });

        callback(cats);
      });
    };
    
    this._init(options);
  };

  CategoriesCache.prototype = new AbstractSelectizer();

  /*
   * Init Selectize with cache content
   * @see AbstractSelectizer._selectize
   */
  CategoriesCache.prototype.selectize = function($target, options) {
    options = options || {};

    $target.selectize({
      valueField: 'id',
      labelField: 'fullname',
      sortField: 'pos',
      searchField: ['fullname'],
      plugins: ['remove_button'],
      render: AbstractSelectizer.getRender('fullname', options.lang)
    });
    
    this._selectize($target, options);
  };


  /**
   * Special LocalStorage for admin tags list
   *
   * @param options {object}
   *    - serverId (recommended) identifier of the Piwigo instance
   *    - serverKey (required) state of collection server-side
   *    - rootUrl (required) used for WS call
   */
  var TagsCache = function(options) {
    options.key = 'tagsAdminList';
    
    options.loader = function(callback) {
      $.getJSON(options.rootUrl + 'ws.php?format=json&method=pwg.tags.getAdminList', function(data) {
        var tags = data.result.tags.map(function(t) {
          t.id = '~~' + t.id + '~~';
          delete t['url_name'];
          delete t['lastmodified'];
          return t;
        });

        callback(tags);
      });
    };
    
    this._init(options);
  };

  TagsCache.prototype = new AbstractSelectizer();

  /*
   * Init Selectize with cache content
   * @see AbstractSelectizer._selectize
   */
  TagsCache.prototype.selectize = function($target, options) {
    options = options || {};

    $target.selectize({
      valueField: 'id',
      labelField: 'name',
      sortField: 'name',
      searchField: ['name'],
      plugins: ['remove_button'],
      render: AbstractSelectizer.getRender('name', options.lang)
    });
    
    this._selectize($target, options);
  };
  
  
  /**
   * Special LocalStorage for admin groups list
   *
   * @param options {object}
   *    - serverId (recommended) identifier of the Piwigo instance
   *    - serverKey (required) state of collection server-side
   *    - rootUrl (required) used for WS call
   */
  var GroupsCache = function(options) {
    options.key = 'groupsAdminList';
    
    options.loader = function(callback) {
      $.getJSON(options.rootUrl + 'ws.php?format=json&method=pwg.groups.getList&per_page=9999', function(data) {
        var groups = data.result.groups.map(function(g) {
          delete g['lastmodified'];
          return g;
        });

        callback(groups);
      });
    };
    
    this._init(options);
  };

  GroupsCache.prototype = new AbstractSelectizer();

  /*
   * Init Selectize with cache content
   * @see AbstractSelectizer._selectize
   */
  GroupsCache.prototype.selectize = function($target, options) {
    options = options || {};

    $target.selectize({
      valueField: 'id',
      labelField: 'name',
      sortField: 'name',
      searchField: ['name'],
      plugins: ['remove_button'],
      render: AbstractSelectizer.getRender('name', options.lang)
    });
    
    this._selectize($target, options);
  };
  
  
  /**
   * Special LocalStorage for admin users list
   *
   * @param options {object}
   *    - serverId (recommended) identifier of the Piwigo instance
   *    - serverKey (required) state of collection server-side
   *    - rootUrl (required) used for WS call
   */
  var UsersCache = function(options) {
    options.key = 'usersAdminList';
    
    options.loader = function(callback) {
      var users = [];
      
      // recursive loader
      (function load(page){
        jQuery.getJSON(options.rootUrl + 'ws.php?format=json&method=pwg.users.getList&display=username&per_page=9999&page='+ page, function(data) {
          users = users.concat(data.result.users);
          
          if (data.result.paging.count == data.result.paging.per_page) {
            load(++page);
          }
          else {
            callback(users);
          }
        });
      }(0));
    };
    
    this._init(options);
  };

  UsersCache.prototype = new AbstractSelectizer();

  /*
   * Init Selectize with cache content
   * @see AbstractSelectizer._selectize
   */
  UsersCache.prototype.selectize = function($target, options) {
    options = options || {};

    $target.selectize({
      valueField: 'id',
      labelField: 'username',
      sortField: 'username',
      searchField: ['username'],
      plugins: ['remove_button'],
      render: AbstractSelectizer.getRender('username', options.lang)
    });
    
    this._selectize($target, options);
  };
  
  
  /**
   * Expose classes in global scope
   */
  exports.LocalStorageCache = LocalStorageCache;
  exports.CategoriesCache = CategoriesCache;
  exports.TagsCache = TagsCache;
  exports.GroupsCache = GroupsCache;
  exports.UsersCache = UsersCache;
  
}(jQuery, window));