/services/sync/modules/engines/prefs.js
http://github.com/zpao/v8monkey · JavaScript · 285 lines · 197 code · 40 blank · 48 comment · 29 complexity · d71599c90905b3e9d2308a9635fbb11e MD5 · raw file
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (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.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Bookmarks Sync.
- *
- * The Initial Developer of the Original Code is Mozilla.
- * Portions created by the Initial Developer are Copyright (C) 2008
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- * Anant Narayanan <anant@kix.in>
- * Philipp von Weitershausen <philipp@weitershausen.de>
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 2 or later (the "GPL"), or
- * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
- const EXPORTED_SYMBOLS = ['PrefsEngine', 'PrefRec'];
- const Cc = Components.classes;
- const Ci = Components.interfaces;
- const Cu = Components.utils;
- const WEAVE_SYNC_PREFS = "services.sync.prefs.sync.";
- Cu.import("resource://services-sync/engines.js");
- Cu.import("resource://services-sync/record.js");
- Cu.import("resource://services-sync/util.js");
- Cu.import("resource://services-sync/constants.js");
- Cu.import("resource://services-sync/ext/Preferences.js");
- Cu.import("resource://gre/modules/LightweightThemeManager.jsm");
- const PREFS_GUID = Utils.encodeBase64url(Services.appinfo.ID);
- function PrefRec(collection, id) {
- CryptoWrapper.call(this, collection, id);
- }
- PrefRec.prototype = {
- __proto__: CryptoWrapper.prototype,
- _logName: "Sync.Record.Pref",
- };
- Utils.deferGetSet(PrefRec, "cleartext", ["value"]);
- function PrefsEngine() {
- SyncEngine.call(this, "Prefs");
- }
- PrefsEngine.prototype = {
- __proto__: SyncEngine.prototype,
- _storeObj: PrefStore,
- _trackerObj: PrefTracker,
- _recordObj: PrefRec,
- version: 2,
- getChangedIDs: function getChangedIDs() {
- // No need for a proper timestamp (no conflict resolution needed).
- let changedIDs = {};
- if (this._tracker.modified)
- changedIDs[PREFS_GUID] = 0;
- return changedIDs;
- },
- _wipeClient: function _wipeClient() {
- SyncEngine.prototype._wipeClient.call(this);
- this.justWiped = true;
- },
- _reconcile: function _reconcile(item) {
- // Apply the incoming item if we don't care about the local data
- if (this.justWiped) {
- this.justWiped = false;
- return true;
- }
- return SyncEngine.prototype._reconcile.call(this, item);
- }
- };
- function PrefStore(name) {
- Store.call(this, name);
- Svc.Obs.add("profile-before-change", function() {
- this.__prefs = null;
- }, this);
- }
- PrefStore.prototype = {
- __proto__: Store.prototype,
- __prefs: null,
- get _prefs() {
- if (!this.__prefs)
- this.__prefs = new Preferences();
- return this.__prefs;
- },
- _getSyncPrefs: function _getSyncPrefs() {
- let syncPrefs = Cc["@mozilla.org/preferences-service;1"]
- .getService(Ci.nsIPrefService)
- .getBranch(WEAVE_SYNC_PREFS)
- .getChildList("", {});
- // Also sync preferences that determine which prefs get synced.
- return syncPrefs.concat(
- syncPrefs.map(function (pref) { return WEAVE_SYNC_PREFS + pref; }));
- },
- _isSynced: function _isSyncedPref(pref) {
- return (pref.indexOf(WEAVE_SYNC_PREFS) == 0)
- || this._prefs.get(WEAVE_SYNC_PREFS + pref, false);
- },
- _getAllPrefs: function () {
- let values = {};
- for each (let pref in this._getSyncPrefs()) {
- if (this._isSynced(pref)) {
- // Missing prefs get the null value.
- values[pref] = this._prefs.get(pref, null);
- }
- }
- return values;
- },
- _setAllPrefs: function PrefStore__setAllPrefs(values) {
- let enabledPref = "lightweightThemes.isThemeSelected";
- let enabledBefore = this._prefs.get(enabledPref, false);
- let prevTheme = LightweightThemeManager.currentTheme;
- for (let [pref, value] in Iterator(values)) {
- if (!this._isSynced(pref))
- continue;
- // Pref has gone missing, best we can do is reset it.
- if (value == null) {
- this._prefs.reset(pref);
- continue;
- }
- try {
- this._prefs.set(pref, value);
- } catch(ex) {
- this._log.trace("Failed to set pref: " + pref + ": " + ex);
- }
- }
- // Notify the lightweight theme manager of all the new values
- let enabledNow = this._prefs.get(enabledPref, false);
- if (enabledBefore && !enabledNow) {
- LightweightThemeManager.currentTheme = null;
- } else if (enabledNow && LightweightThemeManager.usedThemes[0] != prevTheme) {
- LightweightThemeManager.currentTheme = null;
- LightweightThemeManager.currentTheme = LightweightThemeManager.usedThemes[0];
- }
- },
- getAllIDs: function PrefStore_getAllIDs() {
- /* We store all prefs in just one WBO, with just one GUID */
- let allprefs = {};
- allprefs[PREFS_GUID] = true;
- return allprefs;
- },
- changeItemID: function PrefStore_changeItemID(oldID, newID) {
- this._log.trace("PrefStore GUID is constant!");
- },
- itemExists: function FormStore_itemExists(id) {
- return (id === PREFS_GUID);
- },
- createRecord: function createRecord(id, collection) {
- let record = new PrefRec(collection, id);
- if (id == PREFS_GUID) {
- record.value = this._getAllPrefs();
- } else {
- record.deleted = true;
- }
- return record;
- },
- create: function PrefStore_create(record) {
- this._log.trace("Ignoring create request");
- },
- remove: function PrefStore_remove(record) {
- this._log.trace("Ignoring remove request");
- },
- update: function PrefStore_update(record) {
- // Silently ignore pref updates that are for other apps.
- if (record.id != PREFS_GUID)
- return;
- this._log.trace("Received pref updates, applying...");
- this._setAllPrefs(record.value);
- },
- wipe: function PrefStore_wipe() {
- this._log.trace("Ignoring wipe request");
- }
- };
- function PrefTracker(name) {
- Tracker.call(this, name);
- Svc.Obs.add("profile-before-change", this);
- Svc.Obs.add("weave:engine:start-tracking", this);
- Svc.Obs.add("weave:engine:stop-tracking", this);
- }
- PrefTracker.prototype = {
- __proto__: Tracker.prototype,
- get modified() {
- return Svc.Prefs.get("engine.prefs.modified", false);
- },
- set modified(value) {
- Svc.Prefs.set("engine.prefs.modified", value);
- },
- loadChangedIDs: function loadChangedIDs() {
- // Don't read changed IDs from disk at start up.
- },
- clearChangedIDs: function clearChangedIDs() {
- this.modified = false;
- },
- __prefs: null,
- get _prefs() {
- if (!this.__prefs)
- this.__prefs = new Preferences();
- return this.__prefs;
- },
- _enabled: false,
- observe: function(aSubject, aTopic, aData) {
- switch (aTopic) {
- case "weave:engine:start-tracking":
- if (!this._enabled) {
- Cc["@mozilla.org/preferences-service;1"]
- .getService(Ci.nsIPrefBranch).addObserver("", this, false);
- this._enabled = true;
- }
- break;
- case "weave:engine:stop-tracking":
- if (this._enabled)
- this._enabled = false;
- // Fall through to clean up.
- case "profile-before-change":
- this.__prefs = null;
- Cc["@mozilla.org/preferences-service;1"]
- .getService(Ci.nsIPrefBranch).removeObserver("", this);
- break;
- case "nsPref:changed":
- // Trigger a sync for MULTI-DEVICE for a change that determines
- // which prefs are synced or a regular pref change.
- if (aData.indexOf(WEAVE_SYNC_PREFS) == 0 ||
- this._prefs.get(WEAVE_SYNC_PREFS + aData, false)) {
- this.score += SCORE_INCREMENT_XLARGE;
- this.modified = true;
- this._log.trace("Preference " + aData + " changed");
- }
- break;
- }
- }
- };