File "imgcache.js"
Full Path: /srv/www/www.cadoro.it/app/lib/imgcache.js/js/imgcache.js
File size: 38.97 KB
MIME-type: text/plain
Charset: utf-8
/*! imgcache.js
Copyright 2012-2017 Christophe BENOIT
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/*jslint browser:true*/
/*global console,LocalFileSystem,device,FileTransfer,define,module*/
var ImgCache = {
version: '1.1.0',
// options to override before using the library (but after loading this script!)
options: {
debug: false, /* call the log method ? */
localCacheFolder: 'imgcache', /* name of the cache folder */
useDataURI: false, /* use src="data:.."? otherwise will use src="filesystem:.." */
chromeQuota: 10 * 1024 * 1024, /* allocated cache space : here 10MB */
usePersistentCache: true, /* false = use temporary cache storage */
cacheClearSize: 0, /* size in MB that triggers cache clear on init, 0 to disable */
headers: {}, /* HTTP headers for the download requests -- e.g: headers: { 'Accept': 'application/jpg' } */
withCredentials: false, /* indicates whether or not cross-site Access-Control requests should be made using credentials */
skipURIencoding: false, /* enable if URIs are already encoded (skips call to sanitizeURI) */
cordovaFilesystemRoot: null, /* if specified, use one of the Cordova File plugin's app directories for storage */
timeout: 0 /* timeout delay in ms for xhr request */
},
overridables: {
hash: function (s) {
/* tiny-sha1 r4 (11/2011) - MIT License - http://code.google.com/p/tiny-sha1/ */
/* jshint ignore:start */
function U(a,b,c){while(0<c--)a.push(b)}function L(a,b){return(a<<b)|(a>>>(32-b))}function P(a,b,c){return a^b^c}function A(a,b){var c=(b&0xFFFF)+(a&0xFFFF),d=(b>>>16)+(a>>>16)+(c>>>16);return((d&0xFFFF)<<16)|(c&0xFFFF)}var B="0123456789abcdef";return(function(a){var c=[],d=a.length*4,e;for(var i=0;i<d;i++){e=a[i>>2]>>((3-(i%4))*8);c.push(B.charAt((e>>4)&0xF)+B.charAt(e&0xF))}return c.join('')}((function(a,b){var c,d,e,f,g,h=a.length,v=0x67452301,w=0xefcdab89,x=0x98badcfe,y=0x10325476,z=0xc3d2e1f0,M=[];U(M,0x5a827999,20);U(M,0x6ed9eba1,20);U(M,0x8f1bbcdc,20);U(M,0xca62c1d6,20);a[b>>5]|=0x80<<(24-(b%32));a[(((b+65)>>9)<<4)+15]=b;for(var i=0;i<h;i+=16){c=v;d=w;e=x;f=y;g=z;for(var j=0,O=[];j<80;j++){O[j]=j<16?a[j+i]:L(O[j-3]^O[j-8]^O[j-14]^O[j-16],1);var k=(function(a,b,c,d,e){var f=(e&0xFFFF)+(a&0xFFFF)+(b&0xFFFF)+(c&0xFFFF)+(d&0xFFFF),g=(e>>>16)+(a>>>16)+(b>>>16)+(c>>>16)+(d>>>16)+(f>>>16);return((g&0xFFFF)<<16)|(f&0xFFFF)})(j<20?(function(t,a,b){return(t&a)^(~t&b)}(d,e,f)):j<40?P(d,e,f):j<60?(function(t,a,b){return(t&a)^(t&b)^(a&b)}(d,e,f)):P(d,e,f),g,M[j],O[j],L(c,5));g=f;f=e;e=L(d,30);d=c;c=k}v=A(v,c);w=A(w,d);x=A(x,e);y=A(y,f);z=A(z,g)}return[v,w,x,y,z]}((function(t){var a=[],b=255,c=t.length*8;for(var i=0;i<c;i+=8){a[i>>5]|=(t.charCodeAt(i/8)&b)<<(24-(i%32))}return a}(s)).slice(),s.length*8))));
/* jshint ignore:end */
},
log: function (str, level) {
'use strict';
if (ImgCache.options.debug) {
if (level === LOG_LEVEL_INFO) { str = 'INFO: ' + str; }
if (level === LOG_LEVEL_WARNING) { str = 'WARN: ' + str; }
if (level === LOG_LEVEL_ERROR) { str = 'ERROR: ' + str; }
console.log(str);
}
}
},
ready: false,
attributes: {}
},
LOG_LEVEL_INFO = 1,
LOG_LEVEL_WARNING = 2,
LOG_LEVEL_ERROR = 3;
(function ($) {
'use strict';
/** Helpers *****************************************************************/
var Helpers = {};
// make sure the url does not contain funny characters like spaces that might make the download fail
Helpers.sanitizeURI = function (uri) {
if (ImgCache.options.skipURIencoding) {
return uri;
} else {
if (uri.length >= 2 && uri[0] === '"' && uri[uri.length - 1] === '"') {
uri = uri.substr(1, uri.length - 2);
}
var encodedURI = encodeURI(uri);
/*
TODO: The following bit of code will have to be checked first (#30)
if (Helpers.isCordova()) {
return encodedURI.replace(/%/g, '%25');
}
*/
return encodedURI;
}
};
// with a little help from http://code.google.com/p/js-uri/
Helpers.URI = function (str) {
if (!str) { str = ''; }
// Based on the regex in RFC2396 Appendix B.
var parser = /^(?:([^:\/?\#]+):)?(?:\/\/([^\/?\#]*))?([^?\#]*)(?:\?([^\#]*))?(?:\#(.*))?/,
result = str.match(parser);
this.scheme = result[1] || null;
this.authority = result[2] || null;
this.path = result[3] || null;
this.query = result[4] || null;
this.fragment = result[5] || null;
};
// returns lower cased filename from full URI
Helpers.URIGetFileName = function (fullpath) {
if (!fullpath) {
return;
}
//TODO: there must be a better way here.. (url encoded strings fail)
var idx = fullpath.lastIndexOf('/');
if (!idx) {
return;
}
return fullpath.substr(idx + 1).toLowerCase();
};
// returns lower cased path from full URI
Helpers.URIGetPath = function (str) {
if (!str) {
return;
}
var uri = Helpers.URI(str);
return uri.path.toLowerCase();
};
// returns extension from filename (without leading '.')
Helpers.fileGetExtension = function (filename) {
if (!filename) {
return '';
}
filename = filename.split('?')[0];
var ext = filename.split('.').pop();
// make sure it's a realistic file extension - for images no more than 4 characters long (.jpeg)
if (!ext || ext.length > 4) {
return '';
}
return ext;
};
Helpers.appendPaths = function (path1, path2) {
if (!path2) {
path2 = '';
}
if (!path1 || path1 === '') {
return (path2.length > 0 && path2[0] == '/' ? '' : '/') + path2;
}
return path1 + ( ((path1[path1.length - 1] == '/') || (path2.length > 0 && path2[0] == '/')) ? '' : '/' ) + path2;
};
Helpers.hasJqueryOrJqueryLite = function () {
return (ImgCache.jQuery || ImgCache.jQueryLite);
};
Helpers.isCordova = function () {
return (typeof cordova !== 'undefined' || typeof phonegap !== 'undefined');
};
Helpers.isCordovaAndroid = function () {
return (Helpers.isCordova() && device && device.platform && device.platform.toLowerCase().indexOf('android') >= 0);
};
Helpers.isCordovaWindowsPhone = function () {
return (Helpers.isCordova() && device && device.platform && ((device.platform.toLowerCase().indexOf('win32nt') >= 0) || (device.platform.toLowerCase().indexOf('windows') >= 0)));
};
Helpers.isCordovaIOS = function () {
return (Helpers.isCordova() && device && device.platform && device.platform.toLowerCase() === 'ios');
};
// special case for #93
Helpers.isCordovaAndroidOlderThan3_3 = function () {
return (Helpers.isCordovaAndroid() && device.version && (
device.version.indexOf('2.') === 0 ||
device.version.indexOf('3.0') === 0 ||
device.version.indexOf('3.1') === 0 ||
device.version.indexOf('3.2') === 0
));
};
// special case for #47
Helpers.isCordovaAndroidOlderThan4 = function () {
return (Helpers.isCordovaAndroid() && device.version && (device.version.indexOf('2.') === 0 || device.version.indexOf('3.') === 0));
};
// Fix for #42 (Cordova versions < 4.0)
Helpers.EntryToURL = function (entry) {
if (Helpers.isCordovaAndroidOlderThan4() && typeof entry.toNativeURL === 'function') {
return entry.toNativeURL();
} else if (typeof entry.toInternalURL === 'function') {
// Fix for #97
return entry.toInternalURL();
} else {
return entry.toURL();
}
};
// Returns a URL that can be used to locate a file
Helpers.EntryGetURL = function (entry) {
// toURL for html5, toURI for cordova 1.x
return (typeof entry.toURL === 'function' ? Helpers.EntryToURL(entry) : entry.toURI());
};
// Returns the full absolute path from the root to the FileEntry
Helpers.EntryGetPath = function (entry) {
if (Helpers.isCordova()) {
// #93
if (Helpers.isCordovaIOS()) {
if (Helpers.isCordovaAndroidOlderThan3_3()) {
return entry.fullPath;
} else {
return entry.nativeURL;
}
}
// From Cordova 3.3 onward toURL() seems to be required instead of fullPath (#38)
return (typeof entry.toURL === 'function' ? Helpers.EntryToURL(entry) : entry.fullPath);
} else {
return entry.fullPath;
}
};
Helpers.getCordovaStorageType = function (isPersistent) {
// From Cordova 3.1 onward those constants have moved to the window object (#38)
if (typeof LocalFileSystem !== 'undefined') {
if (isPersistent && LocalFileSystem.hasOwnProperty('PERSISTENT')) {
return LocalFileSystem.PERSISTENT;
}
if (!isPersistent && LocalFileSystem.hasOwnProperty('TEMPORARY')) {
return LocalFileSystem.TEMPORARY;
}
}
return (isPersistent ? window.PERSISTENT : window.TEMPORARY);
};
/****************************************************************************/
/** DomHelpers **************************************************************/
var DomHelpers = {};
DomHelpers.trigger = function (DomElement, eventName) {
if (ImgCache.jQuery) {
$(DomElement).trigger(eventName);
} else {
/* CustomEvent polyfill */
if (Helpers.isCordovaWindowsPhone() || !window.CustomEvent) {
// CustomEvent for browsers which don't natively support the Constructor method
window.CustomEvent = function CustomEvent(type, params) {
var event;
params = params || {bubbles: false, cancelable: false, detail: undefined};
try {
event = document.createEvent('CustomEvent');
event.initCustomEvent(type, params.bubbles, params.cancelable, params.detail);
} catch (error) {
// for browsers that don't support CustomEvent at all, we use a regular event instead
event = document.createEvent('Event');
event.initEvent(type, params.bubbles, params.cancelable);
event.detail = params.detail;
}
return event;
};
}
DomElement.dispatchEvent(new CustomEvent(eventName));
}
};
DomHelpers.removeAttribute = function (element, attrName) {
if (Helpers.hasJqueryOrJqueryLite()) {
element.removeAttr(attrName);
} else {
element.removeAttribute(attrName);
}
};
DomHelpers.setAttribute = function (element, attrName, value) {
if (Helpers.hasJqueryOrJqueryLite()) {
element.attr(attrName, value);
} else {
element.setAttribute(attrName, value);
}
};
DomHelpers.getAttribute = function (element, attrName) {
if (Helpers.hasJqueryOrJqueryLite()) {
return element.attr(attrName);
} else {
return element.getAttribute(attrName);
}
};
DomHelpers.getBackgroundImage = function (element) {
if (Helpers.hasJqueryOrJqueryLite()) {
return element.attr('data-old-background') ? "url(" + element.attr('data-old-background') + ")" : element.css('background-image');
} else {
var style = window.getComputedStyle(element, null);
if (!style) {
return;
}
return element.getAttribute("data-old-background") ? "url(" + element.getAttribute("data-old-background") + ")" : style.backgroundImage;
}
};
DomHelpers.setBackgroundImage = function (element, styleValue) {
if (Helpers.hasJqueryOrJqueryLite()) {
element.css('background-image', styleValue);
} else {
element.style.backgroundImage = styleValue;
}
};
/****************************************************************************/
/** Private *****************************************************************/
var Private = { attributes: {} };
Private.isImgCacheLoaded = function () {
if (!ImgCache.attributes.filesystem || !ImgCache.attributes.dirEntry) {
ImgCache.overridables.log('ImgCache not loaded yet! - Have you called ImgCache.init() first?', LOG_LEVEL_WARNING);
return false;
}
return true;
};
Private.attributes.hasLocalStorage = false;
Private.hasLocalStorage = function () {
// if already tested, avoid doing the check again
if (Private.attributes.hasLocalStorage) {
return Private.attributes.hasLocalStorage;
}
try {
var mod = ImgCache.overridables.hash('imgcache_test');
localStorage.setItem(mod, mod);
localStorage.removeItem(mod);
Private.attributes.hasLocalStorage = true;
return true;
} catch (e) {
// this is an info, not an error
ImgCache.overridables.log('Could not write to local storage: ' + e.message, LOG_LEVEL_INFO);
return false;
}
};
Private.setCurrentSize = function (curSize) {
ImgCache.overridables.log('current size: ' + curSize, LOG_LEVEL_INFO);
if (Private.hasLocalStorage()) {
localStorage.setItem('imgcache:' + ImgCache.options.localCacheFolder, curSize);
}
};
Private.getCachedFilePath = function (img_src) {
return Helpers.appendPaths(ImgCache.options.localCacheFolder, Private.getCachedFileName(img_src));
};
// used for FileTransfer.download only
Private.getCachedFileFullPath = function (img_src) {
var local_root = Helpers.EntryGetPath(ImgCache.attributes.dirEntry);
return Helpers.appendPaths(local_root, Private.getCachedFileName(img_src));
};
Private.getCachedFileName = function (img_src) {
if (!img_src) {
ImgCache.overridables.log('No source given to getCachedFileName', LOG_LEVEL_WARNING);
return;
}
var hash = ImgCache.overridables.hash(img_src);
var ext = Helpers.fileGetExtension(Helpers.URIGetFileName(img_src));
return hash + (ext ? ('.' + ext) : '');
};
Private.setNewImgPath = function ($img, new_src, old_src) {
DomHelpers.setAttribute($img, 'src', new_src);
// store previous url in case we need to reload it
DomHelpers.setAttribute($img, OLD_SRC_ATTR, old_src);
};
Private.createCacheDir = function (success_callback, error_callback) {
if (!ImgCache.attributes.filesystem) {
ImgCache.overridables.log('Filesystem instance was not initialised', LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
return;
}
var _fail = function (error) {
ImgCache.overridables.log('Failed to get/create local cache directory: ' + error.code, LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
};
var _getDirSuccess = function (dirEntry) {
ImgCache.attributes.dirEntry = dirEntry;
ImgCache.overridables.log('Local cache folder opened: ' + Helpers.EntryGetPath(dirEntry), LOG_LEVEL_INFO);
//Put .nomedia file in cache directory so Android doesn't index it.
if (Helpers.isCordovaAndroid()) {
var _androidNoMediaFileCreated = function () {
ImgCache.overridables.log('.nomedia file created.', LOG_LEVEL_INFO);
if (success_callback) { success_callback(); }
};
dirEntry.getFile('.nomedia', {create: true, exclusive: false}, _androidNoMediaFileCreated, _fail);
} else if (!Helpers.isCordovaWindowsPhone()) {
// #73 - iOS: the directory should not be backed up in iCloud
if (Helpers.isCordovaIOS() && dirEntry.setMetadata) {
dirEntry.setMetadata(function () {
/* success*/
ImgCache.overridables.log('com.apple.MobileBackup metadata set', LOG_LEVEL_INFO);
}, function () {
/* failure */
ImgCache.overridables.log('com.apple.MobileBackup metadata could not be set', LOG_LEVEL_WARNING);
}, { 'com.apple.MobileBackup': 1 }
// 1=NO backup oddly enough..
);
}
if (success_callback) { success_callback(); }
} else {
if (success_callback) { success_callback(); }
}
ImgCache.ready = true;
DomHelpers.trigger(document, IMGCACHE_READY_TRIGGERED_EVENT);
};
ImgCache.attributes.filesystem.root.getDirectory(ImgCache.options.localCacheFolder, {create: true, exclusive: false}, _getDirSuccess, _fail);
};
// This is a wrapper for phonegap's FileTransfer object in order to implement the same feature
// in Chrome (and possibly extra browsers in the future)
Private.FileTransferWrapper = function (filesystem) {
if (Helpers.isCordova()) {
// PHONEGAP
this.fileTransfer = new FileTransfer();
}
this.filesystem = filesystem; // only useful for CHROME
};
Private.FileTransferWrapper.prototype.download = function (uri, localPath, success_callback, error_callback, on_progress) {
var headers = ImgCache.options.headers || {};
var isOnProgressAvailable = (typeof on_progress === 'function');
if (this.fileTransfer) {
if (isOnProgressAvailable) {
this.fileTransfer.onprogress = on_progress;
}
return this.fileTransfer.download(uri, localPath, success_callback, error_callback, false, { 'headers': headers });
}
var filesystem = this.filesystem;
// CHROME - browsers
var _fail = function (str, level, error_callback) {
ImgCache.overridables.log(str, level);
// mock up FileTransferError, so at least caller knows there was a problem.
// Normally, the error.code in the callback is a FileWriter error, we return 0 if the error was an XHR error
if (error_callback) {
error_callback({code: 0, source: uri, target: localPath});
}
};
var xhr = new XMLHttpRequest();
xhr.open('GET', uri, true);
if (isOnProgressAvailable) {
xhr.onprogress = on_progress;
}
if (ImgCache.options.withCredentials) {
xhr.withCredentials = true;
}
xhr.timeout = ImgCache.options.timeout
xhr.responseType = 'blob';
for (var key in headers) {
xhr.setRequestHeader(key, headers[key]);
}
xhr.onload = function () {
if (xhr.response && (xhr.status === 200 || xhr.status === 0)) {
filesystem.root.getFile(localPath, { create:true }, function (fileEntry) {
fileEntry.createWriter(function (writer) {
writer.onerror = error_callback;
writer.onwriteend = function () { success_callback(fileEntry); };
writer.write(xhr.response, error_callback);
}, error_callback);
}, error_callback);
} else {
_fail('Image ' + uri + ' could not be downloaded - status: ' + xhr.status, 3, error_callback);
}
};
xhr.onerror = function () {
_fail('XHR error - Image ' + uri + ' could not be downloaded - status: ' + xhr.status, 3, error_callback);
};
xhr.send();
};
Private.getBackgroundImageURL = function ($div) {
var backgroundImageProperty = DomHelpers.getBackgroundImage($div);
if (!backgroundImageProperty) {
return;
}
var regexp = /url\s?\((.+)\)/;
var img_src = regexp.exec(backgroundImageProperty)[1];
return img_src.replace(/(['"])/g, '');
};
Private.loadCachedFile = function ($element, img_src, set_path_callback, success_callback, error_callback) {
if (!Private.isImgCacheLoaded()) {
return;
}
if (!$element) {
return;
}
var filename = Helpers.URIGetFileName(img_src);
var _gotFileEntry = function (entry) {
if (ImgCache.options.useDataURI) {
var _win = function (file) {
var reader = new FileReader();
reader.onloadend = function (e) {
// prefix with : 'data:' + mime_type + ';base64;' + .. ?
/* var mime_type = '';
if (filename && filename.length > 4) {
//TODO: of course relying on extension is wrong.. but we trust our data here
var ext = filename.substr(filename.length - 4).toLowerCase();
if (ext == '.jpg' || ext == 'jpeg') {
mime_type = 'image/jpeg';
} else if (ext == '.png') {
mime_type = 'image/png';
} else if (ext == '.gif') {
mime_type = 'image/gif';
}
} */
var base64content = e.target.result;
if (!base64content) {
ImgCache.overridables.log('File in cache ' + filename + ' is empty', LOG_LEVEL_WARNING);
if (error_callback) { error_callback($element); }
return;
}
set_path_callback($element, base64content, img_src);
ImgCache.overridables.log('File ' + filename + ' loaded from cache', LOG_LEVEL_INFO);
if (success_callback) { success_callback($element); }
};
reader.readAsDataURL(file);
};
var _fail = function (error) {
ImgCache.overridables.log('Failed to read file ' + error.code, LOG_LEVEL_ERROR);
if (error_callback) { error_callback($element); }
};
entry.file(_win, _fail);
} else {
// using src="filesystem:" kind of url
var new_url = Helpers.EntryGetURL(entry);
set_path_callback($element, new_url, img_src);
ImgCache.overridables.log('File ' + filename + ' loaded from cache', LOG_LEVEL_INFO);
if (success_callback) { success_callback($element); }
}
};
// if file does not exist in cache, cache it now!
var _fail = function () {
ImgCache.overridables.log('File ' + filename + ' not in cache', LOG_LEVEL_INFO);
if (error_callback) { error_callback($element); }
};
ImgCache.attributes.filesystem.root.getFile(Private.getCachedFilePath(img_src), {create: false}, _gotFileEntry, _fail);
};
/****************************************************************************/
var OLD_SRC_ATTR = 'data-old-src',
OLD_BACKGROUND_ATTR = 'data-old-background',
IMGCACHE_READY_TRIGGERED_EVENT = 'ImgCacheReady';
ImgCache.init = function (success_callback, error_callback) {
ImgCache.jQuery = (window.jQuery || window.Zepto) ? true : false; /* using jQuery if it's available otherwise the DOM API */
ImgCache.jQueryLite = (typeof window.angular !== 'undefined' && window.angular.element) ? true : false; /* is AngularJS jQueryLite available */
ImgCache.attributes.init_callback = success_callback;
ImgCache.overridables.log('ImgCache initialising', LOG_LEVEL_INFO);
var _checkSize = function (callback) {
if (ImgCache.options.cacheClearSize > 0) {
var curSize = ImgCache.getCurrentSize();
if (curSize > (ImgCache.options.cacheClearSize * 1024 * 1024)) {
ImgCache.clearCache(callback, callback);
} else {
if (callback) { callback(); }
}
} else {
if (callback) { callback(); }
}
};
var _gotFS = function (filesystem) {
ImgCache.overridables.log('LocalFileSystem opened', LOG_LEVEL_INFO);
// store filesystem handle
ImgCache.attributes.filesystem = filesystem;
Private.createCacheDir(function () {
_checkSize(ImgCache.attributes.init_callback);
}, error_callback);
};
var _fail = function (error) {
ImgCache.overridables.log('Failed to initialise LocalFileSystem ' + error.code, LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
};
if (Helpers.isCordova() && window.requestFileSystem) {
// PHONEGAP
if (ImgCache.options.cordovaFilesystemRoot) {
try {
window.resolveLocalFileSystemURL(
ImgCache.options.cordovaFilesystemRoot,
function (dirEntry) {
_gotFS({ root: dirEntry });
},
_fail
);
} catch (e) {
_fail({ code: e.message })
}
} else {
window.requestFileSystem(Helpers.getCordovaStorageType(ImgCache.options.usePersistentCache), 0, _gotFS, _fail);
}
} else {
//CHROME
var savedFS = window.requestFileSystem || window.webkitRequestFileSystem;
window.storageInfo = window.storageInfo || (ImgCache.options.usePersistentCache ? navigator.webkitPersistentStorage : navigator.webkitTemporaryStorage);
if (!window.storageInfo) {
ImgCache.overridables.log('Your browser does not support the html5 File API', LOG_LEVEL_WARNING);
if (error_callback) { error_callback(); }
return;
}
// request space for storage
var quota_size = ImgCache.options.chromeQuota;
window.storageInfo.requestQuota(
quota_size,
function () {
/* success*/
var persistence = (ImgCache.options.usePersistentCache ? window.storageInfo.PERSISTENT : window.storageInfo.TEMPORARY);
savedFS(persistence, quota_size, _gotFS, _fail);
},
function (error) {
/* error*/
ImgCache.overridables.log('Failed to request quota: ' + error.message, LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
}
);
}
};
ImgCache.getCurrentSize = function () {
if (Private.hasLocalStorage()) {
var curSize = localStorage.getItem('imgcache:' + ImgCache.options.localCacheFolder);
if (curSize === null) {
return 0;
}
return parseInt(curSize, 10);
} else {
return 0;
}
};
// this function will not check if the image is already cached or not => it will overwrite existing data
// on_progress callback follows this spec: http://www.w3.org/TR/2014/REC-progress-events-20140211/ -- see #54
ImgCache.cacheFile = function (img_src, success_callback, error_callback, on_progress) {
if (!Private.isImgCacheLoaded() || !img_src) {
return;
}
img_src = Helpers.sanitizeURI(img_src);
var filePath = Private.getCachedFileFullPath(img_src);
var fileTransfer = new Private.FileTransferWrapper(ImgCache.attributes.filesystem);
fileTransfer.download(
img_src,
filePath,
function (entry) {
entry.getMetadata(function (metadata) {
if (metadata && ('size' in metadata)) {
ImgCache.overridables.log('Cached file size: ' + metadata.size, LOG_LEVEL_INFO);
Private.setCurrentSize(ImgCache.getCurrentSize() + parseInt(metadata.size, 10));
} else {
ImgCache.overridables.log('No metadata size property available', LOG_LEVEL_INFO);
}
});
ImgCache.overridables.log('Download complete: ' + Helpers.EntryGetPath(entry), LOG_LEVEL_INFO);
// iOS: the file should not be backed up in iCloud
// new from cordova 1.8 only
if (entry.setMetadata) {
entry.setMetadata(
function () {
/* success*/
ImgCache.overridables.log('com.apple.MobileBackup metadata set', LOG_LEVEL_INFO);
},
function () {
/* failure */
ImgCache.overridables.log('com.apple.MobileBackup metadata could not be set', LOG_LEVEL_WARNING);
},
{ 'com.apple.MobileBackup': 1 }
// 1=NO backup oddly enough..
);
}
if (success_callback) {
success_callback(entry.toURL());
}
},
function (error) {
if (error.source) { ImgCache.overridables.log('Download error source: ' + error.source, LOG_LEVEL_ERROR); }
if (error.target) { ImgCache.overridables.log('Download error target: ' + error.target, LOG_LEVEL_ERROR); }
ImgCache.overridables.log('Download error code: ' + error.code, LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
},
on_progress
);
};
// Returns the file already available in the cached
// Reminder: this is an asynchronous method!
// Answer to the question comes in response_callback as the second argument (first being the path)
ImgCache.getCachedFile = function (img_src, response_callback) {
// sanity check
if (!Private.isImgCacheLoaded() || !response_callback) {
return;
}
var original_img_src = img_src;
img_src = Helpers.sanitizeURI(img_src);
var path = Private.getCachedFilePath(img_src);
if (Helpers.isCordovaAndroid()) {
// This hack is probably only used for older versions of Cordova
if (path.indexOf('file://') === 0) {
// issue #4 -- android cordova specific
path = path.substr(7);
}
}
// try to get the file entry: if it fails, there's no such file in the cache
// if it fails, we send the original path, not the sanitized one.
ImgCache.attributes.filesystem.root.getFile(
path,
{ create: false },
function (file_entry) { response_callback(img_src, file_entry); },
function () { response_callback(original_img_src, null); }
);
};
// Returns the local url of a file already available in the cache
ImgCache.getCachedFileURL = function (img_src, success_callback, error_callback) {
var _getURL = function (img_src, entry) {
if (!entry) {
if (error_callback) { error_callback(img_src); }
} else {
success_callback(img_src, Helpers.EntryGetURL(entry));
}
};
ImgCache.getCachedFile(img_src, _getURL);
};
// checks if a copy of the file has already been cached
// Reminder: this is an asynchronous method!
// Answer to the question comes in response_callback as the second argument (first being the path)
ImgCache.isCached = function (img_src, response_callback) {
ImgCache.getCachedFile(img_src, function (src, file_entry) {
response_callback(src, file_entry !== null);
});
};
// $img: jQuery object of an <img/> element
// Synchronous method
ImgCache.useOnlineFile = function ($img) {
if (!Private.isImgCacheLoaded() || !$img) {
return;
}
var prev_src = DomHelpers.getAttribute($img, OLD_SRC_ATTR);
if (prev_src) {
DomHelpers.setAttribute($img, 'src', prev_src);
}
DomHelpers.removeAttribute($img, OLD_SRC_ATTR);
};
// $img: jQuery object of an <img/> element
ImgCache.useCachedFile = function ($img, success_callback, error_callback) {
if (!Private.isImgCacheLoaded()) {
return;
}
Private.loadCachedFile($img, DomHelpers.getAttribute($img, 'src'), Private.setNewImgPath, success_callback, error_callback);
};
// When the source url is not the 'src' attribute of the given img element
ImgCache.useCachedFileWithSource = function ($img, image_url, success_callback, error_callback) {
if (!Private.isImgCacheLoaded()) {
return;
}
var img_url = Helpers.sanitizeURI(image_url);
Private.loadCachedFile($img, img_url, Private.setNewImgPath, success_callback, error_callback);
};
// clears the cache
ImgCache.clearCache = function (success_callback, error_callback) {
if (!Private.isImgCacheLoaded()) {
return;
}
// delete cache dir completely
ImgCache.attributes.dirEntry.removeRecursively(
function () {
ImgCache.overridables.log('Local cache cleared', LOG_LEVEL_INFO);
Private.setCurrentSize(0);
// recreate the cache dir now
Private.createCacheDir(success_callback, error_callback);
},
function (error) {
ImgCache.overridables.log('Failed to remove directory or its contents: ' + error.code, LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
}
);
};
ImgCache.removeFile = function (img_src, success_callback, error_callback) {
img_src = Helpers.sanitizeURI(img_src);
var filePath = Private.getCachedFilePath(img_src);
var _fail = function (error) {
ImgCache.overridables.log('Failed to remove file due to ' + error.code, LOG_LEVEL_ERROR);
if (error_callback) { error_callback(); }
};
ImgCache.attributes.filesystem.root.getFile(filePath, { create: false }, function (fileEntry) {
fileEntry.remove(
function () {
if (success_callback) { success_callback(); }
},
_fail
);
}, _fail);
};
ImgCache.isBackgroundCached = function ($div, response_callback) {
var img_src = Private.getBackgroundImageURL($div);
ImgCache.getCachedFile(img_src, function (src, file_entry) {
response_callback(src, file_entry !== null);
});
};
ImgCache.cacheBackground = function ($div, success_callback, error_callback, on_progress) {
if (!Private.isImgCacheLoaded()) {
return;
}
var img_src = Private.getBackgroundImageURL($div);
if (!img_src) {
ImgCache.overridables.log('No background to cache', LOG_LEVEL_WARNING);
if (error_callback) { error_callback(); }
return;
}
ImgCache.overridables.log('Background image URL: ' + img_src, LOG_LEVEL_INFO);
ImgCache.cacheFile(img_src, success_callback, error_callback, on_progress);
};
ImgCache.useCachedBackground = function ($div, success_callback, error_callback) {
if (!Private.isImgCacheLoaded()) {
return;
}
var img_src = Private.getBackgroundImageURL($div);
if (!img_src) {
ImgCache.overridables.log('No background to cache', LOG_LEVEL_WARNING);
if (error_callback) { error_callback(); }
return;
}
var _setBackgroundImagePath = function ($element, new_src, old_src) {
DomHelpers.setBackgroundImage($element, 'url("' + new_src + '")');
// store previous url in case we need to reload it
DomHelpers.setAttribute($element, OLD_BACKGROUND_ATTR, old_src);
};
Private.loadCachedFile($div, img_src, _setBackgroundImagePath, success_callback, error_callback);
};
// $div: jQuery object of an element
// Synchronous method
// Method used to revert call to useCachedBackground
ImgCache.useBackgroundOnlineFile = function ($div) {
if (!$div) {
return;
}
var prev_src = DomHelpers.getAttribute($div, OLD_BACKGROUND_ATTR);
if (prev_src) {
DomHelpers.setBackgroundImage($div, 'url("' + prev_src + '")');
}
DomHelpers.removeAttribute($div, OLD_BACKGROUND_ATTR);
};
// returns the URI of the local cache folder (filesystem:)
// this function is more useful for the examples than for anything else..
// Synchronous method
ImgCache.getCacheFolderURI = function () {
if (!Private.isImgCacheLoaded()) {
return;
}
return Helpers.EntryGetURL(ImgCache.attributes.dirEntry);
};
// private methods can now be used publicly
ImgCache.helpers = Helpers;
ImgCache.domHelpers = DomHelpers;
ImgCache.private = Private;
/****************************************************************************/
// Expose the class either via AMD, CommonJS or the global object
if (typeof define === 'function' && define.amd) {
define('imgcache', [], function () {
return ImgCache;
});
}
else if (typeof module === 'object' && module.exports){
module.exports = ImgCache;
}
else {
window.ImgCache = ImgCache;
}
})(window.jQuery || window.Zepto || function () { throw "jQuery is not available"; } );