19549bb7d6
Add UI for the cursorToolOnLoad pref in the UI of the Chrome extension. Add logic to migrate the enableHandToolOnLoad pref to cursorToolOnLoad. For past values in the mutable extension storage area: 1. If enableHandToolOnLoad=true, save cursorToolOnLoad=1. 2. Remove enableHandToolOnLoad. For the managed extension storage, which is immutable since it is based on administrative policies, use the following logic: 1. If enableHandToolOnLoad=true and cursorToolOnLoad=0 (default). set cursorToolOnLoad=0 and assume enableHandToolOnLoad=false. 2. As usual, managed preferences can (and will) be overridden by the user. The first migration logic is in extensions/chromium/options/migration.js and can be removed after a few months / less than many years. The second migration logic is in web/chromecom.js, and should be kept around for a long while (many years). The need for this migration logic arises from the change by: https://github.com/mozilla/pdf.js/pull/7635
99 lines
3.2 KiB
JavaScript
99 lines
3.2 KiB
JavaScript
/*
|
|
Copyright 2016 Mozilla Foundation
|
|
|
|
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.
|
|
*/
|
|
/* eslint strict: ["error", "function"] */
|
|
|
|
(function() {
|
|
'use strict';
|
|
var storageLocal = chrome.storage.local;
|
|
var storageSync = chrome.storage.sync;
|
|
|
|
if (!storageSync) {
|
|
// No sync storage area - nothing to migrate to.
|
|
return;
|
|
}
|
|
|
|
getStorageNames(function(storageKeys) {
|
|
storageLocal.get(storageKeys, function(values) {
|
|
if (!values || !Object.keys(values).length) {
|
|
// No local storage - nothing to migrate.
|
|
// ... except possibly for a renamed preference name.
|
|
migrateRenamedStorage();
|
|
return;
|
|
}
|
|
migrateToSyncStorage(values);
|
|
});
|
|
});
|
|
|
|
function getStorageNames(callback) {
|
|
var x = new XMLHttpRequest();
|
|
var schema_location = chrome.runtime.getManifest().storage.managed_schema;
|
|
x.open('get', chrome.runtime.getURL(schema_location));
|
|
x.onload = function() {
|
|
var storageKeys = Object.keys(x.response.properties);
|
|
callback(storageKeys);
|
|
};
|
|
x.responseType = 'json';
|
|
x.send();
|
|
}
|
|
|
|
// Save |values| to storage.sync and delete the values with that key from
|
|
// storage.local.
|
|
function migrateToSyncStorage(values) {
|
|
storageSync.set(values, function() {
|
|
if (chrome.runtime.lastError) {
|
|
console.error('Failed to migrate settings due to an error: ' +
|
|
chrome.runtime.lastError.message);
|
|
return;
|
|
}
|
|
// Migration successful. Delete local settings.
|
|
storageLocal.remove(Object.keys(values), function() {
|
|
// In theory remove() could fail (e.g. if the browser's storage
|
|
// backend is corrupt), but since storageSync.set succeeded, consider
|
|
// the migration successful.
|
|
console.log(
|
|
'Successfully migrated preferences from local to sync storage.');
|
|
migrateRenamedStorage();
|
|
});
|
|
});
|
|
}
|
|
|
|
// TODO: Remove this migration code somewhere in the future, when most users
|
|
// have had their chance of migrating to the new preference format.
|
|
// Note: We cannot modify managed preferences, so the migration logic is
|
|
// duplicated in web/chromecom.js too.
|
|
function migrateRenamedStorage() {
|
|
storageSync.get([
|
|
'enableHandToolOnLoad',
|
|
'cursorToolOnLoad',
|
|
], function(items) {
|
|
// Migration code for https://github.com/mozilla/pdf.js/pull/7635.
|
|
if (typeof items.enableHandToolOnLoad === 'boolean') {
|
|
if (items.enableHandToolOnLoad) {
|
|
storageSync.set({
|
|
cursorToolOnLoad: 1,
|
|
}, function() {
|
|
if (!chrome.runtime.lastError) {
|
|
storageSync.remove('enableHandToolOnLoad');
|
|
}
|
|
});
|
|
} else {
|
|
storageSync.remove('enableHandToolOnLoad');
|
|
}
|
|
}
|
|
});
|
|
}
|
|
})();
|