From a5b2cf82007ac1b2461ba86b79c48e43c2640053 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Mon, 26 May 2014 22:03:57 +0000 Subject: feature 3077 : factorize code for categories cache (TODO for other collections) + fix incorrect categories list for dissociation git-svn-id: http://piwigo.org/svn/trunk@28542 68402e56-0260-453c-a942-63ccdbb3a9ee --- admin/themes/default/js/LocalStorageCache.js | 121 +++++++++++++++++++++ .../default/template/batch_manager_global.tpl | 59 ++++------ admin/themes/default/template/cat_modify.tpl | 59 +++------- .../themes/default/template/photos_add_direct.tpl | 47 ++------ admin/themes/default/template/picture_modify.tpl | 39 ++----- 5 files changed, 176 insertions(+), 149 deletions(-) (limited to 'admin/themes') diff --git a/admin/themes/default/js/LocalStorageCache.js b/admin/themes/default/js/LocalStorageCache.js index b720851be..747254349 100644 --- a/admin/themes/default/js/LocalStorageCache.js +++ b/admin/themes/default/js/LocalStorageCache.js @@ -1,4 +1,22 @@ +/** + * 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; @@ -8,6 +26,10 @@ var LocalStorageCache = function(options) { 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; @@ -27,6 +49,10 @@ LocalStorageCache.prototype.get = function(callback) { }); }; +/* + * Manually set the cache content + * @param data {mixed} + */ LocalStorageCache.prototype.set = function(data) { if (this.ready) { this.storage[this.key] = JSON.stringify({ @@ -37,8 +63,103 @@ LocalStorageCache.prototype.set = function(data) { } }; +/* + * Manually clear the cache + */ LocalStorageCache.prototype.clear = function() { if (this.ready) { this.storage.removeItem(this.key); } +}; + + +/** + * 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) { + jQuery.getJSON(options.rootUrl + 'ws.php?format=json&method=pwg.categories.getAdminList', function(data) { + callback(data.result.categories); + }); + }; + + this._init(options); +}; + +CategoriesCache.prototype = new LocalStorageCache({}); + +/* + * Init Selectize with cache content + * @param $target {jQuery} + * @param options {object} + * - default (optional) default value which will be forced if the select is emptyed + * - filter (optional) function called for each select before applying the data + * takes two parameters: cache data, options + * must return new data + */ +CategoriesCache.prototype.selectize = function($target, options) { + options = options || {}; + + $target.selectize({ + valueField: 'id', + labelField: 'fullname', + sortField: 'global_rank', + searchField: ['fullname'], + plugins: ['remove_button'] + }); + + this.get(function(categories) { + $target.each(function() { + var data; + if (options.filter != undefined) { + data = options.filter.call(this, categories, options); + } + else { + data = categories; + } + + this.selectize.load(function(callback) { + callback(data); + }); + + if (jQuery(this).data('value')) { + jQuery.each(jQuery(this).data('value'), jQuery.proxy(function(i, id) { + this.selectize.addItem(id); + }, this)); + } + + if (options.default != undefined) { + 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); + } + }); + } + } + }); + }); }; \ No newline at end of file diff --git a/admin/themes/default/template/batch_manager_global.tpl b/admin/themes/default/template/batch_manager_global.tpl index 4a45cab41..a5a48e8de 100644 --- a/admin/themes/default/template/batch_manager_global.tpl +++ b/admin/themes/default/template/batch_manager_global.tpl @@ -119,46 +119,31 @@ jQuery(document).ready(function() {ldelim} }); {* *} - var categoriesCache = new LocalStorageCache({ - key: 'categoriesAdminList', + var categoriesCache = new CategoriesCache({ serverKey: '{$CACHE_KEYS.categories}', serverId: '{$CACHE_KEYS._hash}', - - loader: function(callback) { - jQuery.getJSON('{$ROOT_URL}ws.php?format=json&method=pwg.categories.getAdminList', function(data) { - callback(data.result.categories); - }); - } + rootUrl: '{$ROOT_URL}' }); - jQuery('[data-selectize=categories]').selectize({ - valueField: 'id', - labelField: 'fullname', - sortField: 'global_rank', - searchField: ['fullname'], - plugins: ['remove_button'] - }); - - categoriesCache.get(function(categories) { - jQuery('[data-selectize=categories]').each(function() { - this.selectize.load(function(callback) { - callback(categories); - }); - - if (jQuery(this).data('value')) { - this.selectize.setValue(jQuery(this).data('value')[0]); + categoriesCache.selectize(jQuery('[data-selectize=categories]'), { + filter: function(categories, options) { + if (this.name == 'dissociate') { + var filtered = jQuery.grep(categories, function(cat) { + return !cat.dir; + }); + + if (filtered.length > 0) { + jQuery('.albumDissociate').show(); + options.default = filtered[0].id; + } + + return filtered; } - - // prevent empty value - if (this.selectize.getValue() == '') { - this.selectize.setValue(categories[0].id); + else { + options.default = categories[0].id; + return categories; } - this.selectize.on('dropdown_close', function() { - if (this.getValue() == '') { - this.setValue(categories[0].id); - } - }); - }); + } }); jQuery('[data-add-album]').pwgAddAlbum({ cache: categoriesCache }); @@ -837,9 +822,7 @@ UL.thumbnails SPAN.wrap2 {ldelim} - {if !empty($dissociate_options)} - - {/if} + {if !empty($associated_tags)} @@ -884,7 +867,7 @@ UL.thumbnails SPAN.wrap2 {ldelim} -
+ diff --git a/admin/themes/default/template/cat_modify.tpl b/admin/themes/default/template/cat_modify.tpl index 4bb06c03b..b1b9a5e06 100644 --- a/admin/themes/default/template/cat_modify.tpl +++ b/admin/themes/default/template/cat_modify.tpl @@ -5,57 +5,28 @@ {footer_script} {* *} -var categoriesCache = new LocalStorageCache({ - key: 'categoriesAdminList', +var categoriesCache = new CategoriesCache({ serverKey: '{$CACHE_KEYS.categories}', serverId: '{$CACHE_KEYS._hash}', - - loader: function(callback) { - jQuery.getJSON('{$ROOT_URL}ws.php?format=json&method=pwg.categories.getAdminList', function(data) { - callback(data.result.categories); - }); - } -}); - -jQuery('[data-selectize=categories]').selectize({ - valueField: 'id', - labelField: 'fullname', - sortField: 'global_rank', - searchField: ['fullname'], - plugins: ['remove_button'] + rootUrl: '{$ROOT_URL}' }); -categoriesCache.get(function(categories) { - categories.push({ - id: 0, - fullname: '------------', - global_rank: 0 - }); - - // remove itself and children - categories = jQuery.grep(categories, function(cat) { - return !(/\b{$CAT_ID}\b/.test(cat.uppercats)); - }); - - jQuery('[data-selectize=categories]').each(function() { - this.selectize.load(function(callback) { - callback(categories); +categoriesCache.selectize(jQuery('[data-selectize=categories]'), { + default: 0, + filter: function(categories, options) { + // remove itself and children + var filtered = jQuery.grep(categories, function(cat) { + return !(/\b{$CAT_ID}\b/.test(cat.uppercats)); }); - - if (jQuery(this).data('value')) { - this.selectize.setValue(jQuery(this).data('value')[0]); - } - // prevent empty value - if (this.selectize.getValue() == '') { - this.selectize.setValue(0); - } - this.selectize.on('dropdown_close', function() { - if (this.getValue() == '') { - this.setValue(0); - } + filtered.push({ + id: 0, + fullname: '------------', + global_rank: 0 }); - }); + + return filtered; + } }); {/footer_script} diff --git a/admin/themes/default/template/photos_add_direct.tpl b/admin/themes/default/template/photos_add_direct.tpl index fdf80c481..df87e4d87 100644 --- a/admin/themes/default/template/photos_add_direct.tpl +++ b/admin/themes/default/template/photos_add_direct.tpl @@ -16,50 +16,21 @@ {footer_script} {* *} -var categoriesCache = new LocalStorageCache({ - key: 'categoriesAdminList', +var categoriesCache = new CategoriesCache({ serverKey: '{$CACHE_KEYS.categories}', serverId: '{$CACHE_KEYS._hash}', - - loader: function(callback) { - jQuery.getJSON('{$ROOT_URL}ws.php?format=json&method=pwg.categories.getAdminList', function(data) { - callback(data.result.categories); - }); - } + rootUrl: '{$ROOT_URL}' }); -jQuery('[data-selectize=categories]').selectize({ - valueField: 'id', - labelField: 'fullname', - sortField: 'global_rank', - searchField: ['fullname'], - plugins: ['remove_button'] -}); - -categoriesCache.get(function(categories) { - if (categories.length > 0) { - jQuery("#albumSelection").show(); - } - - jQuery('[data-selectize=categories]').each(function() { - this.selectize.load(function(callback) { - callback(categories); - }); - - if (jQuery(this).data('value')) { - this.selectize.setValue(jQuery(this).data('value')[0]); +categoriesCache.selectize(jQuery('[data-selectize=categories]'), { + filter: function(categories, options) { + if (categories.length > 0) { + jQuery("#albumSelection").show(); + options.default = categories[0].id; } - // prevent empty value - if (this.selectize.getValue() == '') { - this.selectize.setValue(categories[0].id); - } - this.selectize.on('dropdown_close', function() { - if (this.getValue() == '') { - this.setValue(categories[0].id); - } - }); - }); + return categories; + } }); jQuery('[data-add-album]').pwgAddAlbum({ cache: categoriesCache }); diff --git a/admin/themes/default/template/picture_modify.tpl b/admin/themes/default/template/picture_modify.tpl index 3688d92ff..454a06428 100644 --- a/admin/themes/default/template/picture_modify.tpl +++ b/admin/themes/default/template/picture_modify.tpl @@ -10,37 +10,18 @@ {footer_script} (function(){ {* *} -var categoriesCache = new LocalStorageCache({ - key: 'categoriesAdminList', +var categoriesCache = new CategoriesCache({ serverKey: '{$CACHE_KEYS.categories}', serverId: '{$CACHE_KEYS._hash}', - - loader: function(callback) { - jQuery.getJSON('{$ROOT_URL}ws.php?format=json&method=pwg.categories.getAdminList', function(data) { - callback(data.result.categories); - }); - } -}); - -jQuery('[data-selectize=categories]').selectize({ - valueField: 'id', - labelField: 'fullname', - sortField: 'global_rank', - searchField: ['fullname'], - plugins: ['remove_button'] + rootUrl: '{$ROOT_URL}' }); -categoriesCache.get(function(categories) { - jQuery('[data-selectize=categories]').each(function() { - this.selectize.load(function(callback) { - callback(categories); - }); - - jQuery.each(jQuery(this).data('value'), jQuery.proxy(function(i, id) { - this.selectize.addItem(id); - }, this)); - }); -}); +categoriesCache.selectize(jQuery('[data-selectize=categories]'), { {if $STORAGE_ALBUM} + filter: function(categories, options) { + options.default = (this.name == 'associate[]') ? {$STORAGE_ALBUM} : undefined; + return categories; + } +{/if} }); {* *} var tagsCache = new LocalStorageCache({ @@ -157,14 +138,14 @@ jQuery(function(){ {* *}

{'Linked albums'|@translate}
-

{'Representation of albums'|@translate}
-

-- cgit v1.2.3