94a49fa048
In a1cfa5f4d7, the textLayerMode
preference was introduced, to replace the disableTextLayer and
enhanceTextSelection preferences.
As a result, the text selection preference was no longer visible
in Chrome (because preferences are only rendered by default for
boolean preferences, not for enumerations).
This commit adds the necessary bits to
extensions/chromium/options/options.{html,js}
so that the textLayerMode preference can be changed again.
Also, migration logic has been added to move over preferences
from the old to the new names:
- In web/chromecom.js, the logic is added to translate
preferences that were set by an administrator (it is read-only,
so this layer is unavoidable).
- In extensions/chromium/options/migration.js, similar logic is
added, except in this case the preference storage is writable,
so this migration logic happens only once.
The "enhanced text selection" mode is still experimental, so it
has been marked as experimental to signal that there may be bugs.
The list of tasks that block promotion to stable is at #7584.
119 lines
4.0 KiB
JavaScript
119 lines
4.0 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',
|
|
'disableTextLayer',
|
|
'enhanceTextSelection',
|
|
'textLayerMode',
|
|
], 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');
|
|
}
|
|
}
|
|
// Migration code for https://github.com/mozilla/pdf.js/pull/9479.
|
|
if (typeof items.disableTextLayer === 'boolean') {
|
|
var textLayerMode = items.disableTextLayer ? 0 :
|
|
items.enhanceTextSelection ? 2 : 1;
|
|
if (textLayerMode !== 1) {
|
|
// Overwrite if computed textLayerMode is not the default value (1).
|
|
storageSync.set({
|
|
textLayerMode: textLayerMode,
|
|
}, function() {
|
|
if (!chrome.runtime.lastError) {
|
|
storageSync.remove(['disableTextLayer', 'enhanceTextSelection']);
|
|
}
|
|
});
|
|
} else {
|
|
storageSync.remove(['disableTextLayer', 'enhanceTextSelection']);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
})();
|