/******************************************************************************* µBlock - a browser extension to block requests. Copyright (C) 2014 The µBlock authors This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see {http://www.gnu.org/licenses/}. Home: https://github.com/gorhill/uBlock */ /* global self, µBlock */ // For background page /******************************************************************************/ (function() { 'use strict'; /******************************************************************************/ var vAPI = self.vAPI = self.vAPI || {}; var chrome = self.chrome; var manifest = chrome.runtime.getManifest(); vAPI.chrome = true; var noopFunc = function(){}; /******************************************************************************/ vAPI.app = { name: manifest.name, version: manifest.version }; /******************************************************************************/ vAPI.app.restart = function() { chrome.runtime.reload(); }; /******************************************************************************/ /******************************************************************************/ // chrome.storage.local.get(null, function(bin){ console.debug('%o', bin); }); vAPI.storage = chrome.storage.local; /******************************************************************************/ /******************************************************************************/ // https://github.com/gorhill/uMatrix/issues/234 // https://developer.chrome.com/extensions/privacy#property-network // 2015-08-12: Wrapped Chrome API in try-catch statements. I had a fluke // event in which it appeared Chrome 46 decided to restart uBlock (for // unknown reasons) and again for unknown reasons the browser acted as if // uBlock did not declare the `privacy` permission in its manifest, putting // uBlock in a bad, non-functional state -- because call to `chrome.privacy` // API threw an exception. vAPI.browserSettings = { set: function(details) { for ( var setting in details ) { if ( details.hasOwnProperty(setting) === false ) { continue; } switch ( setting ) { case 'prefetching': try { chrome.privacy.network.networkPredictionEnabled.set({ value: !!details[setting], scope: 'regular' }); } catch(ex) { console.error(ex); } break; case 'hyperlinkAuditing': try { chrome.privacy.websites.hyperlinkAuditingEnabled.set({ value: !!details[setting], scope: 'regular' }); } catch(ex) { console.error(ex); } break; case 'webrtcIPAddress': if ( typeof chrome.privacy.network.webRTCMultipleRoutesEnabled === 'object' ) { try { chrome.privacy.network.webRTCMultipleRoutesEnabled.set({ value: !!details[setting], scope: 'regular' }); } catch(ex) { console.error(ex); } } break; default: break; } } } }; /******************************************************************************/ /******************************************************************************/ vAPI.tabs = {}; /******************************************************************************/ vAPI.isBehindTheSceneTabId = function(tabId) { return tabId.toString() === '-1'; }; vAPI.noTabId = '-1'; /******************************************************************************/ var toChromiumTabId = function(tabId) { if ( typeof tabId === 'string' ) { tabId = parseInt(tabId, 10); } if ( typeof tabId !== 'number' || isNaN(tabId) || tabId === -1 ) { return 0; } return tabId; }; /******************************************************************************/ vAPI.tabs.registerListeners = function() { var onNavigationClient = this.onNavigation || noopFunc; var onPopupClient = this.onPopup || noopFunc; var onUpdatedClient = this.onUpdated || noopFunc; // https://developer.chrome.com/extensions/webNavigation // [onCreatedNavigationTarget ->] // onBeforeNavigate -> // onCommitted -> // onDOMContentLoaded -> // onCompleted var popupCandidates = Object.create(null); var PopupCandidate = function(details) { this.targetTabId = details.tabId.toString(); this.openerTabId = details.sourceTabId.toString(); this.targetURL = details.url; this.selfDestructionTimer = null; }; PopupCandidate.prototype.selfDestruct = function() { if ( this.selfDestructionTimer !== null ) { clearTimeout(this.selfDestructionTimer); } delete popupCandidates[this.targetTabId]; }; PopupCandidate.prototype.launchSelfDestruction = function() { if ( this.selfDestructionTimer !== null ) { clearTimeout(this.selfDestructionTimer); } this.selfDestructionTimer = setTimeout(this.selfDestruct.bind(this), 10000); }; var popupCandidateCreate = function(details) { var popup = popupCandidates[details.tabId]; // This really should not happen... if ( popup !== undefined ) { return; } return (popupCandidates[details.tabId] = new PopupCandidate(details)); }; var popupCandidateTest = function(details) { var popup = popupCandidates[details.tabId]; if ( popup === undefined ) { return; } popup.targetURL = details.url; if ( onPopupClient(popup) !== true ) { return; } popup.selfDestruct(); return true; }; var popupCandidateDestroy = function(details) { var popup = popupCandidates[details.tabId]; if ( popup instanceof PopupCandidate ) { popup.launchSelfDestruction(); } }; // The chrome.webRequest.onBeforeRequest() won't be called for everything // else than `http`/`https`. Thus, in such case, we will bind the tab as // early as possible in order to increase the likelihood of a context // properly setup if network requests are fired from within the tab. // Example: Chromium + case #6 at // http://raymondhill.net/ublock/popup.html var reGoodForWebRequestAPI = /^https?:\/\//; var onCreatedNavigationTarget = function(details) { //console.debug('onCreatedNavigationTarget: popup candidate tab id %d = "%s"', details.tabId, details.url); if ( reGoodForWebRequestAPI.test(details.url) === false ) { details.frameId = 0; onNavigationClient(details); } popupCandidateCreate(details); popupCandidateTest(details); }; var onBeforeNavigate = function(details) { if ( details.frameId !== 0 ) { return; } //console.debug('onBeforeNavigate: popup candidate tab id %d = "%s"', details.tabId, details.url); popupCandidateTest(details); }; var onUpdated = function(tabId, changeInfo, tab) { if ( changeInfo.url && popupCandidateTest({ tabId: tabId, url: changeInfo.url }) ) { return; } onUpdatedClient(tabId, changeInfo, tab); }; var onCommitted = function(details) { if ( details.frameId !== 0 ) { return; } onNavigationClient(details); //console.debug('onCommitted: popup candidate tab id %d = "%s"', details.tabId, details.url); if ( popupCandidateTest(details) === true ) { return; } popupCandidateDestroy(details); }; chrome.webNavigation.onCreatedNavigationTarget.addListener(onCreatedNavigationTarget); chrome.webNavigation.onBeforeNavigate.addListener(onBeforeNavigate); chrome.webNavigation.onCommitted.addListener(onCommitted); chrome.tabs.onUpdated.addListener(onUpdated); if ( typeof this.onClosed === 'function' ) { chrome.tabs.onRemoved.addListener(this.onClosed); } }; /******************************************************************************/ vAPI.tabs.get = function(tabId, callback) { var onTabReady = function(tab) { // https://code.google.com/p/chromium/issues/detail?id=410868#c8 if ( chrome.runtime.lastError ) { /* noop */ } // Caller must be prepared to deal with nil tab value callback(tab); }; if ( tabId !== null ) { tabId = toChromiumTabId(tabId); if ( tabId === 0 ) { onTabReady(null); } else { chrome.tabs.get(tabId, onTabReady); } return; } var onTabReceived = function(tabs) { // https://code.google.com/p/chromium/issues/detail?id=410868#c8 if ( chrome.runtime.lastError ) { /* noop */ } callback(tabs[0]); }; chrome.tabs.query({ active: true, currentWindow: true }, onTabReceived); }; /******************************************************************************/ // properties of the details object: // url: 'URL', // the address that will be opened // tabId: 1, // the tab is used if set, instead of creating a new one // index: -1, // undefined: end of the list, -1: following tab, or after index // active: false, // opens the tab in background - true and undefined: foreground // select: true, // if a tab is already opened with that url, then select it instead of opening a new one // popup: true // open in a new window vAPI.tabs.open = function(details) { var targetURL = details.url; if ( typeof targetURL !== 'string' || targetURL === '' ) { return null; } // extension pages if ( /^[\w-]{2,}:/.test(targetURL) !== true ) { targetURL = vAPI.getURL(targetURL); } // dealing with Chrome's asynchronous API var wrapper = function() { if ( details.active === undefined ) { details.active = true; } var subWrapper = function() { var _details = { url: targetURL, active: !!details.active }; // Opening a tab from incognito window won't focus the window // in which the tab was opened var focusWindow = function(tab) { if ( tab.active ) { chrome.windows.update(tab.windowId, { focused: true }); } }; if ( !details.tabId ) { if ( details.index !== undefined ) { _details.index = details.index; } chrome.tabs.create(_details, focusWindow); return; } // update doesn't accept index, must use move chrome.tabs.update(toChromiumTabId(details.tabId), _details, function(tab) { // if the tab doesn't exist if ( vAPI.lastError() ) { chrome.tabs.create(_details, focusWindow); } else if ( details.index !== undefined ) { chrome.tabs.move(tab.id, {index: details.index}); } }); }; // Open in a standalone window if ( details.popup === true ) { chrome.windows.create({ url: details.url, focused: details.active, type: 'popup' }); return; } if ( details.index !== -1 ) { subWrapper(); return; } vAPI.tabs.get(null, function(tab) { if ( tab ) { details.index = tab.index + 1; } else { delete details.index; } subWrapper(); }); }; if ( !details.select ) { wrapper(); return; } // https://developer.chrome.com/extensions/tabs#method-query // "Note that fragment identifiers are not matched." // It's a lie, fragment identifiers ARE matched. So we need to remove the // fragment. var pos = targetURL.indexOf('#'); var targetURLWithoutHash = pos === -1 ? targetURL : targetURL.slice(0, pos); chrome.tabs.query({ url: targetURLWithoutHash }, function(tabs) { var tab = tabs[0]; if ( !tab ) { wrapper(); return; } var _details = { active: true, url: undefined }; if ( targetURL !== tab.url ) { _details.url = targetURL; } chrome.tabs.update(tab.id, _details, function(tab) { chrome.windows.update(tab.windowId, { focused: true }); }); }); }; /******************************************************************************/ // Replace the URL of a tab. Noop if the tab does not exist. vAPI.tabs.replace = function(tabId, url) { tabId = toChromiumTabId(tabId); if ( tabId === 0 ) { return; } var targetURL = url; // extension pages if ( /^[\w-]{2,}:/.test(targetURL) !== true ) { targetURL = vAPI.getURL(targetURL); } chrome.tabs.update(tabId, { url: targetURL }, function() { // https://code.google.com/p/chromium/issues/detail?id=410868#c8 if ( chrome.runtime.lastError ) { /* noop */ } }); }; /******************************************************************************/ vAPI.tabs.remove = function(tabId) { tabId = toChromiumTabId(tabId); if ( tabId === 0 ) { return; } var onTabRemoved = function() { // https://code.google.com/p/chromium/issues/detail?id=410868#c8 if ( chrome.runtime.lastError ) { /* noop */ } }; chrome.tabs.remove(tabId, onTabRemoved); }; /******************************************************************************/ vAPI.tabs.reload = function(tabId /*, flags*/) { tabId = toChromiumTabId(tabId); if ( tabId === 0 ) { return; } var onReloaded = function() { // https://code.google.com/p/chromium/issues/detail?id=410868#c8 if ( chrome.runtime.lastError ) { /* noop */ } }; chrome.tabs.reload(tabId, onReloaded); }; /******************************************************************************/ // Select a specific tab. vAPI.tabs.select = function(tabId) { tabId = toChromiumTabId(tabId); if ( tabId === 0 ) { return; } chrome.tabs.update(tabId, { active: true }, function(tab) { if ( chrome.runtime.lastError ) { /* noop */ } if ( !tab ) { return; } chrome.windows.update(tab.windowId, { focused: true }); }); }; /******************************************************************************/ vAPI.tabs.injectScript = function(tabId, details, callback) { var onScriptExecuted = function() { // https://code.google.com/p/chromium/issues/detail?id=410868#c8 if ( chrome.runtime.lastError ) { /* noop */ } if ( typeof callback === 'function' ) { callback(); } }; if ( tabId ) { chrome.tabs.executeScript(toChromiumTabId(tabId), details, onScriptExecuted); } else { chrome.tabs.executeScript(details, onScriptExecuted); } }; /******************************************************************************/ /******************************************************************************/ // Must read: https://code.google.com/p/chromium/issues/detail?id=410868#c8 // https://github.com/chrisaljoudi/uBlock/issues/19 // https://github.com/chrisaljoudi/uBlock/issues/207 // Since we may be called asynchronously, the tab id may not exist // anymore, so this ensures it does still exist. vAPI.setIcon = function(tabId, iconStatus, badge) { tabId = toChromiumTabId(tabId); if ( tabId === 0 ) { return; } var onIconReady = function() { if ( vAPI.lastError() ) { return; } chrome.browserAction.setBadgeText({ tabId: tabId, text: badge }); if ( badge !== '' ) { chrome.browserAction.setBadgeBackgroundColor({ tabId: tabId, color: '#666' }); } }; var iconPaths = iconStatus === 'on' ? { '19': 'img/browsericons/icon19.png', '38': 'img/browsericons/icon38.png' } : { '19': 'img/browsericons/icon19-off.png', '38': 'img/browsericons/icon38-off.png' }; chrome.browserAction.setIcon({ tabId: tabId, path: iconPaths }, onIconReady); }; /******************************************************************************/ /******************************************************************************/ vAPI.messaging = { ports: {}, listeners: {}, defaultHandler: null, NOOPFUNC: noopFunc, UNHANDLED: 'vAPI.messaging.notHandled' }; /******************************************************************************/ vAPI.messaging.listen = function(listenerName, callback) { this.listeners[listenerName] = callback; }; /******************************************************************************/ vAPI.messaging.onPortMessage = (function() { var messaging = vAPI.messaging; var toAuxPending = {}; // Use a wrapper to avoid closure and to allow reuse. var CallbackWrapper = function(port, request, timeout) { this.callback = this.proxy.bind(this); // bind once this.init(port, request, timeout); }; CallbackWrapper.prototype.init = function(port, request, timeout) { this.port = port; this.request = request; this.timerId = timeout !== undefined ? vAPI.setTimeout(this.callback, timeout) : null; return this; }; CallbackWrapper.prototype.proxy = function(response) { if ( this.timerId !== null ) { clearTimeout(this.timerId); delete toAuxPending[this.timerId]; this.timerId = null; } // https://github.com/chrisaljoudi/uBlock/issues/383 if ( messaging.ports.hasOwnProperty(this.port.name) ) { this.port.postMessage({ auxProcessId: this.request.auxProcessId, channelName: this.request.channelName, msg: response !== undefined ? response : null }); } // Mark for reuse this.port = this.request = null; callbackWrapperJunkyard.push(this); }; var callbackWrapperJunkyard = []; var callbackWrapperFactory = function(port, request, timeout) { var wrapper = callbackWrapperJunkyard.pop(); if ( wrapper ) { return wrapper.init(port, request, timeout); } return new CallbackWrapper(port, request, timeout); }; var toAux = function(details, portFrom) { var port, portTo; var chromiumTabId = toChromiumTabId(details.toTabId); // TODO: This could be an issue with a lot of tabs: easy to address // with a port name to tab id map. for ( var portName in messaging.ports ) { if ( messaging.ports.hasOwnProperty(portName) === false ) { continue; } // When sending to an auxiliary process, the target is always the // port associated with the root frame. port = messaging.ports[portName]; if ( port.sender.frameId === 0 && port.sender.tab.id === chromiumTabId ) { portTo = port; break; } } var wrapper; if ( details.auxProcessId !== undefined ) { wrapper = callbackWrapperFactory(portFrom, details, 1023); } // Destination not found: if ( portTo === undefined ) { if ( wrapper !== undefined ) { wrapper.callback(); } return; } // As per HTML5, timer id is always an integer, thus suitable to be // used as a key, and which value is safe to use across process // boundaries. if ( wrapper !== undefined ) { toAuxPending[wrapper.timerId] = wrapper; } portTo.postMessage({ mainProcessId: wrapper && wrapper.timerId, channelName: details.toChannel, msg: details.msg }); }; var toAuxResponse = function(details) { var mainProcessId = details.mainProcessId; if ( mainProcessId === undefined ) { return; } if ( toAuxPending.hasOwnProperty(mainProcessId) === false ) { return; } var wrapper = toAuxPending[mainProcessId]; delete toAuxPending[mainProcessId]; wrapper.callback(details.msg); }; return function(request, port) { // Auxiliary process to auxiliary process if ( request.toTabId !== undefined ) { toAux(request, port); return; } // Auxiliary process to auxiliary process: response if ( request.mainProcessId !== undefined ) { toAuxResponse(request); return; } // Auxiliary process to main process: prepare response var callback = messaging.NOOPFUNC; if ( request.auxProcessId !== undefined ) { callback = callbackWrapperFactory(port, request).callback; } // Auxiliary process to main process: specific handler var r = messaging.UNHANDLED; var listener = messaging.listeners[request.channelName]; if ( typeof listener === 'function' ) { r = listener(request.msg, port.sender, callback); } if ( r !== messaging.UNHANDLED ) { return; } // Auxiliary process to main process: default handler r = messaging.defaultHandler(request.msg, port.sender, callback); if ( r !== messaging.UNHANDLED ) { return; } // Auxiliary process to main process: no handler console.error('uBlock> messaging > unknown request: %o', request); // Need to callback anyways in case caller expected an answer, or // else there is a memory leak on caller's side callback(); }; })(); /******************************************************************************/ vAPI.messaging.onPortDisconnect = function(port) { port.onDisconnect.removeListener(vAPI.messaging.onPortDisconnect); port.onMessage.removeListener(vAPI.messaging.onPortMessage); delete vAPI.messaging.ports[port.name]; }; /******************************************************************************/ vAPI.messaging.onPortConnect = function(port) { port.onDisconnect.addListener(vAPI.messaging.onPortDisconnect); port.onMessage.addListener(vAPI.messaging.onPortMessage); vAPI.messaging.ports[port.name] = port; }; /******************************************************************************/ vAPI.messaging.setup = function(defaultHandler) { // Already setup? if ( this.defaultHandler !== null ) { return; } if ( typeof defaultHandler !== 'function' ) { defaultHandler = function(){ return vAPI.messaging.UNHANDLED; }; } this.defaultHandler = defaultHandler; chrome.runtime.onConnect.addListener(this.onPortConnect); }; /******************************************************************************/ vAPI.messaging.broadcast = function(message) { var messageWrapper = { broadcast: true, msg: message }; for ( var portName in this.ports ) { if ( this.ports.hasOwnProperty(portName) === false ) { continue; } this.ports[portName].postMessage(messageWrapper); } }; /******************************************************************************/ /******************************************************************************/ vAPI.net = {}; /******************************************************************************/ vAPI.net.registerListeners = function() { var µb = µBlock; var µburi = µb.URI; var normalizeRequestDetails = function(details) { µburi.set(details.url); details.tabId = details.tabId.toString(); details.hostname = µburi.hostnameFromURI(details.url); // The rest of the function code is to normalize type if ( details.type !== 'other' ) { return; } var tail = µburi.path.slice(-6); var pos = tail.lastIndexOf('.'); // https://github.com/chrisaljoudi/uBlock/issues/862 // If no transposition possible, transpose to `object` as per // Chromium bug 410382 (see below) if ( pos === -1 ) { details.type = 'object'; return; } var ext = tail.slice(pos) + '.'; if ( '.eot.ttf.otf.svg.woff.woff2.'.indexOf(ext) !== -1 ) { details.type = 'font'; return; } // Still need this because often behind-the-scene requests are wrongly // categorized as 'other' if ( '.ico.png.gif.jpg.jpeg.webp.'.indexOf(ext) !== -1 ) { details.type = 'image'; return; } // https://code.google.com/p/chromium/issues/detail?id=410382 details.type = 'object'; }; var headerValue = function(headers, name) { var i = headers.length; while ( i-- ) { if ( headers[i].name.toLowerCase() === name ) { return headers[i].value.trim(); } } return ''; }; var onBeforeRequestClient = this.onBeforeRequest.callback; var onBeforeRequest = function(details) { normalizeRequestDetails(details); return onBeforeRequestClient(details); }; var onHeadersReceivedClient = this.onHeadersReceived.callback; var onHeadersReceivedClientTypes = this.onHeadersReceived.types.slice(0); var onHeadersReceivedTypes = onHeadersReceivedClientTypes.slice(0); if ( onHeadersReceivedTypes.length !== 0 && onHeadersReceivedTypes.indexOf('other') === -1 ) { onHeadersReceivedTypes.push('other'); } var onHeadersReceived = function(details) { normalizeRequestDetails(details); // Hack to work around Chromium API limitations, where requests of // type `font` are returned as `other`. For example, our normalization // fail at transposing `other` into `font` for URLs which are outside // what is expected. At least when headers are received we can check // for content type `font/*`. Blocking at onHeadersReceived time is // less worse than not blocking at all. Also, due to Chromium bug, // `other` always becomes `object` when it can't be normalized into // something else. Test case for "unfriendly" font URLs: // https://www.google.com/fonts if ( details.type === 'object' ) { if ( headerValue(details.responseHeaders, 'content-type').lastIndexOf('font/', 0) === 0 ) { details.type = 'font'; var r = onBeforeRequestClient(details); if ( typeof r === 'object' && r.cancel === true ) { return { cancel: true }; } } if ( onHeadersReceivedClientTypes.length !== 0 && onHeadersReceivedClientTypes.indexOf(details.type) === -1 ) { return; } } return onHeadersReceivedClient(details); }; var installListeners = (function() { var listener; var crapi = chrome.webRequest; listener = onBeforeRequest; //listener = function(details) { // quickProfiler.start('onBeforeRequest'); // var r = onBeforeRequest(details); // quickProfiler.stop(); // return r; //}; if ( crapi.onBeforeRequest.hasListener(listener) === false ) { crapi.onBeforeRequest.addListener( listener, { 'urls': this.onBeforeRequest.urls || [''], 'types': this.onBeforeRequest.types || undefined }, this.onBeforeRequest.extra ); } listener = onHeadersReceived; if ( crapi.onHeadersReceived.hasListener(listener) === false ) { crapi.onHeadersReceived.addListener( listener, { 'urls': this.onHeadersReceived.urls || [''], 'types': onHeadersReceivedTypes }, this.onHeadersReceived.extra ); } // https://github.com/gorhill/uBlock/issues/675 // Experimental: keep polling to be sure our listeners are still installed. //setTimeout(installListeners, 20000); }).bind(this); installListeners(); }; /******************************************************************************/ /******************************************************************************/ vAPI.contextMenu = { create: function(details, callback) { this.menuId = details.id; this.callback = callback; chrome.contextMenus.create(details); chrome.contextMenus.onClicked.addListener(this.callback); }, remove: function() { chrome.contextMenus.onClicked.removeListener(this.callback); chrome.contextMenus.remove(this.menuId); } }; /******************************************************************************/ /******************************************************************************/ vAPI.lastError = function() { return chrome.runtime.lastError; }; /******************************************************************************/ /******************************************************************************/ // This is called only once, when everything has been loaded in memory after // the extension was launched. It can be used to inject content scripts // in already opened web pages, to remove whatever nuisance could make it to // the web pages before uBlock was ready. vAPI.onLoadAllCompleted = function() { // http://code.google.com/p/chromium/issues/detail?id=410868#c11 // Need to be sure to access `vAPI.lastError()` to prevent // spurious warnings in the console. var scriptDone = function() { vAPI.lastError(); }; var scriptEnd = function(tabId) { if ( vAPI.lastError() ) { return; } vAPI.tabs.injectScript(tabId, { file: 'js/contentscript-end.js', allFrames: true, runAt: 'document_idle' }, scriptDone); }; var scriptStart = function(tabId) { vAPI.tabs.injectScript(tabId, { file: 'js/vapi-client.js', allFrames: true, runAt: 'document_idle' }, function(){ }); vAPI.tabs.injectScript(tabId, { file: 'js/contentscript-start.js', allFrames: true, runAt: 'document_idle' }, function(){ scriptEnd(tabId); }); }; var bindToTabs = function(tabs) { var µb = µBlock; var i = tabs.length, tab; while ( i-- ) { tab = tabs[i]; µb.tabContextManager.commit(tab.id, tab.url); µb.bindTabToPageStats(tab.id); // https://github.com/chrisaljoudi/uBlock/issues/129 scriptStart(tab.id); } }; chrome.tabs.query({ url: '' }, bindToTabs); }; /******************************************************************************/ /******************************************************************************/ vAPI.punycodeHostname = function(hostname) { return hostname; }; vAPI.punycodeURL = function(url) { return url; }; /******************************************************************************/ /******************************************************************************/ vAPI.cloud = (function() { var chunkCountPerFetch = 16; // Must be a power of 2 // Mind chrome.storage.sync.MAX_ITEMS (512 at time of writing) var maxChunkCountPerItem = Math.floor(512 * 0.75) & ~(chunkCountPerFetch - 1); // Mind chrome.storage.sync.QUOTA_BYTES_PER_ITEM (8192 at time of writing) var maxChunkSize = Math.floor(chrome.storage.sync.QUOTA_BYTES_PER_ITEM * 0.75); // Mind chrome.storage.sync.QUOTA_BYTES_PER_ITEM (8192 at time of writing) var maxStorageSize = chrome.storage.sync.QUOTA_BYTES; var options = { defaultDeviceName: window.navigator.platform, deviceName: window.localStorage.getItem('deviceName') || '' }; // This is used to find out a rough count of how many chunks exists: // We "poll" at specific index in order to get a rough idea of how // large is the stored string. // This allows reading a single item with only 2 sync operations -- a // good thing given chrome.storage.syncMAX_WRITE_OPERATIONS_PER_MINUTE // and chrome.storage.syncMAX_WRITE_OPERATIONS_PER_HOUR. var getCoarseChunkCount = function(dataKey, callback) { var bin = {}; for ( var i = 0; i < maxChunkCountPerItem; i += 16 ) { bin[dataKey + i.toString()] = ''; } chrome.storage.sync.get(bin, function(bin) { if ( chrome.runtime.lastError ) { callback(0, chrome.runtime.lastError.message); return; } var chunkCount = 0; for ( var i = 0; i < maxChunkCountPerItem; i += 16 ) { if ( bin[dataKey + i.toString()] === '' ) { break; } chunkCount = i + 16; } callback(chunkCount); }); }; var deleteChunks = function(dataKey, start) { var keys = []; // No point in deleting more than: // - The max number of chunks per item // - The max number of chunks per storage limit var n = Math.min( maxChunkCountPerItem, Math.ceil(maxStorageSize / maxChunkSize) ); for ( var i = start; i < n; i++ ) { keys.push(dataKey + i.toString()); } chrome.storage.sync.remove(keys); }; var start = function(/* dataKeys */) { }; var push = function(dataKey, data, callback) { var bin = { 'source': options.deviceName || options.defaultDeviceName, 'tstamp': Date.now(), 'data': data, 'size': 0 }; bin.size = JSON.stringify(bin).length; var item = JSON.stringify(bin); // Chunkify taking into account QUOTA_BYTES_PER_ITEM: // https://developer.chrome.com/extensions/storage#property-sync // "The maximum size (in bytes) of each individual item in sync // "storage, as measured by the JSON stringification of its value // "plus its key length." bin = {}; var chunkCount = Math.ceil(item.length / maxChunkSize); for ( var i = 0; i < chunkCount; i++ ) { bin[dataKey + i.toString()] = item.substr(i * maxChunkSize, maxChunkSize); } bin[dataKey + i.toString()] = ''; // Sentinel chrome.storage.sync.set(bin, function() { var errorStr; if ( chrome.runtime.lastError ) { errorStr = chrome.runtime.lastError.message; } callback(errorStr); // Remove potentially unused trailing chunks deleteChunks(dataKey, chunkCount); }); }; var pull = function(dataKey, callback) { var assembleChunks = function(bin) { if ( chrome.runtime.lastError ) { callback(null, chrome.runtime.lastError.message); return; } // Assemble chunks into a single string. var json = [], jsonSlice; var i = 0; for (;;) { jsonSlice = bin[dataKey + i.toString()]; if ( jsonSlice === '' ) { break; } json.push(jsonSlice); i += 1; } var entry = null; try { entry = JSON.parse(json.join('')); } catch(ex) { } callback(entry); }; var fetchChunks = function(coarseCount, errorStr) { if ( coarseCount === 0 || typeof errorStr === 'string' ) { callback(null, errorStr); return; } var bin = {}; for ( var i = 0; i < coarseCount; i++ ) { bin[dataKey + i.toString()] = ''; } chrome.storage.sync.get(bin, assembleChunks); }; getCoarseChunkCount(dataKey, fetchChunks); }; var getOptions = function(callback) { if ( typeof callback !== 'function' ) { return; } callback(options); }; var setOptions = function(details, callback) { if ( typeof details !== 'object' || details === null ) { return; } if ( typeof details.deviceName === 'string' ) { window.localStorage.setItem('deviceName', details.deviceName); options.deviceName = details.deviceName; } getOptions(callback); }; return { start: start, push: push, pull: pull, getOptions: getOptions, setOptions: setOptions }; })(); /******************************************************************************/ /******************************************************************************/ })(); /******************************************************************************/