/* ***** 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) 2007 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Dan Mills * Myk Melez * Anant Narayanan * * 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 = ['Weave']; const Cc = Components.classes; const Ci = Components.interfaces; const Cr = Components.results; const Cu = Components.utils; // The following constants determine when Weave will automatically sync data. // An interval of one minute, initial threshold of 100, and step of 5 means // that we'll try to sync each engine 21 times, once per minute, at // consecutively lower thresholds (from 100 down to 5 in steps of 5 and then // one more time with the threshold set to the minimum 1) before resetting // the engine's threshold to the initial value and repeating the cycle // until at some point the engine's score exceeds the threshold, at which point // we'll sync it, reset its threshold to the initial value, rinse, and repeat. // How long we wait between sync checks. const SCHEDULED_SYNC_INTERVAL = 60 * 1000 * 5; // five minutes // how long we should wait before actually syncing on idle const IDLE_TIME = 5; // xxxmpc: in seconds, should be preffable // INITIAL_THRESHOLD represents the value an engine's score has to exceed // in order for us to sync it the first time we start up (and the first time // we do a sync check after having synced the engine or reset the threshold). const INITIAL_THRESHOLD = 75; // THRESHOLD_DECREMENT_STEP is the amount by which we decrement an engine's // threshold each time we do a sync check and don't sync that engine. const THRESHOLD_DECREMENT_STEP = 25; // How long before refreshing the cluster const CLUSTER_BACKOFF = SCHEDULED_SYNC_INTERVAL; Cu.import("resource://gre/modules/XPCOMUtils.jsm"); Cu.import("resource://weave/ext/Sync.js"); Cu.import("resource://weave/log4moz.js"); Cu.import("resource://weave/constants.js"); Cu.import("resource://weave/util.js"); Cu.import("resource://weave/faultTolerance.js"); Cu.import("resource://weave/auth.js"); Cu.import("resource://weave/resource.js"); Cu.import("resource://weave/base_records/wbo.js"); Cu.import("resource://weave/base_records/crypto.js"); Cu.import("resource://weave/base_records/keys.js"); Cu.import("resource://weave/engines.js"); Cu.import("resource://weave/identity.js"); Cu.import("resource://weave/engines/clientData.js"); // for export let Weave = {}; Cu.import("resource://weave/constants.js", Weave); Cu.import("resource://weave/util.js", Weave); Cu.import("resource://weave/faultTolerance.js", Weave); Cu.import("resource://weave/auth.js", Weave); Cu.import("resource://weave/resource.js", Weave); Cu.import("resource://weave/base_records/keys.js", Weave); Cu.import("resource://weave/notifications.js", Weave); Cu.import("resource://weave/identity.js", Weave); Cu.import("resource://weave/stores.js", Weave); Cu.import("resource://weave/engines.js", Weave); Cu.import("resource://weave/engines/bookmarks.js", Weave); Cu.import("resource://weave/engines/clientData.js", Weave); Cu.import("resource://weave/engines/cookies.js", Weave); Cu.import("resource://weave/engines/extensions.js", Weave); Cu.import("resource://weave/engines/forms.js", Weave); Cu.import("resource://weave/engines/history.js", Weave); Cu.import("resource://weave/engines/input.js", Weave); Cu.import("resource://weave/engines/prefs.js", Weave); Cu.import("resource://weave/engines/microformats.js", Weave); Cu.import("resource://weave/engines/passwords.js", Weave); Cu.import("resource://weave/engines/plugins.js", Weave); Cu.import("resource://weave/engines/tabs.js", Weave); Cu.import("resource://weave/engines/themes.js", Weave); Utils.lazy(Weave, 'Service', WeaveSvc); /* * Service status query system. See constants defined in constants.js. */ function StatusRecord() { this._init(); } StatusRecord.prototype = { _init: function() { this.server = []; this.sync = null; this.engines = {}; }, addServerStatus: function(statusCode) { this.server.push(statusCode); }, setSyncStatus: function(statusCode) { this.sync = statusCode; }, setEngineStatus: function(engineName, statusCode) { this.engines[engineName] = statusCode; } }; /* * Service singleton * Main entry point into Weave's sync framework */ function WeaveSvc() { this._notify = Utils.notify("weave:service:"); } WeaveSvc.prototype = { _lock: Utils.lock, _catch: Utils.catch, _isQuitting: false, _loggedIn: false, _syncInProgress: false, _keyGenEnabled: true, // WEAVE_STATUS_OK, WEAVE_STATUS_FAILED, or WEAVE_STATUS_PARTIAL _weaveStatusCode: null, // More detailed status info: _detailedStatus: null, // object for caching public and private keys _keyPair: {}, // Timer object for automagically syncing _syncTimer: null, get username() { return Svc.Prefs.get("username", ""); }, set username(value) { if (value) Svc.Prefs.set("username", value); else Svc.Prefs.reset("username"); // fixme - need to loop over all Identity objects - needs some rethinking... ID.get('WeaveID').username = value; ID.get('WeaveCryptoID').username = value; // FIXME: need to also call this whenever the username pref changes this._genKeyURLs(); }, get password() { return ID.get('WeaveID').password; }, set password(value) { ID.get('WeaveID').setTempPassword(null); ID.get('WeaveID').password = value; }, get passphrase() { return ID.get('WeaveCryptoID').password; }, set passphrase(value) { ID.get('WeaveCryptoID').setTempPassword(null); ID.get('WeaveCryptoID').password = value; }, get baseURL() { return Utils.getURLPref("serverURL"); }, set baseURL(value) { Svc.Prefs.set("serverURL", value); }, get miscURL() { return Utils.getURLPref("miscURL"); }, set miscURL(value) { Svc.Prefs.set("miscURL", value); }, get clusterURL() { return Utils.getURLPref("clusterURL", null, "0.5/"); }, set clusterURL(value) { Svc.Prefs.set("clusterURL", value); this._genKeyURLs(); }, get userURL() { return this.clusterURL + this.username; }, get userPath() { return ID.get('WeaveID').username; }, get isLoggedIn() { return this._loggedIn; }, get isQuitting() { return this._isQuitting; }, set isQuitting(value) { this._isQuitting = value; }, get keyGenEnabled() { return this._keyGenEnabled; }, set keyGenEnabled(value) { this._keyGenEnabled = value; }, get enabled() { return Svc.Prefs.get("enabled"); }, set enabled(value) { Svc.Prefs.set("enabled", value); }, get statusCode() { return this._weaveStatusCode; }, get detailedStatus() { return this._detailedStatus; }, get locked() { return this._locked; }, lock: function Svc_lock() { if (this._locked) return false; this._locked = true; return true; }, unlock: function Svc_unlock() { this._locked = false; }, _setSyncFailure: function WeavSvc__setSyncFailure(code) { this._weaveStatusCode = WEAVE_STATUS_FAILED; this._detailedStatus.setSyncStatus(code); }, _genKeyURLs: function WeaveSvc__genKeyURLs() { let url = this.userURL; PubKeys.defaultKeyUri = url + "/storage/keys/pubkey"; PrivKeys.defaultKeyUri = url + "/storage/keys/privkey"; }, _checkCrypto: function WeaveSvc__checkCrypto() { let ok = false; try { let iv = Svc.Crypto.generateRandomIV(); if (iv.length == 24) ok = true; } catch (e) { this._log.debug("Crypto check failed: " + e); } return ok; }, onWindowOpened: function WeaveSvc__onWindowOpened() { }, // one-time initialization like setting up observers and the like // xxx we might need to split some of this out into something we can call // again when username/server/etc changes onStartup: function WeaveSvc_onStartup() { this._initLogs(); this._log.info("Weave " + WEAVE_VERSION + " initializing"); this._registerEngines(); this._detailedStatus = new StatusRecord(); // Reset our sync id if we're upgrading, so sync knows to reset local data if (WEAVE_VERSION != Svc.Prefs.get("lastversion")) { this._log.info("Resetting client syncID from _onStartup."); Clients.resetSyncID(); } let ua = Cc["@mozilla.org/network/protocol;1?name=http"]. getService(Ci.nsIHttpProtocolHandler).userAgent; this._log.info(ua); if (!this._checkCrypto()) { this.enabled = false; this._log.error("Could not load the Weave crypto component. Disabling " + "Weave, since it will not work correctly."); } Utils.prefs.addObserver("", this, false); Svc.Observer.addObserver(this, "network:offline-status-changed", true); Svc.Observer.addObserver(this, "private-browsing", true); Svc.Observer.addObserver(this, "quit-application", true); Svc.Observer.addObserver(this, "weave:service:sync:finish", true); Svc.Observer.addObserver(this, "weave:service:sync:error", true); FaultTolerance.Service; // initialize FT service if (!this.enabled) this._log.info("Weave Sync disabled"); // Create Weave identities (for logging in, and for encryption) ID.set('WeaveID', new Identity('Mozilla Services Password', this.username)); Auth.defaultAuthenticator = new BasicAuthenticator(ID.get('WeaveID')); ID.set('WeaveCryptoID', new Identity('Mozilla Services Encryption Passphrase', this.username)); this._genKeyURLs(); if (Svc.Prefs.get("autoconnect")) this._autoConnect(); }, _initLogs: function WeaveSvc__initLogs() { this._log = Log4Moz.repository.getLogger("Service.Main"); this._log.level = Log4Moz.Level[Svc.Prefs.get("log.logger.service.main")]; let formatter = new Log4Moz.BasicFormatter(); let root = Log4Moz.repository.rootLogger; root.level = Log4Moz.Level[Svc.Prefs.get("log.rootLogger")]; let capp = new Log4Moz.ConsoleAppender(formatter); capp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.console")]; root.addAppender(capp); let dapp = new Log4Moz.DumpAppender(formatter); dapp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.dump")]; root.addAppender(dapp); let brief = Svc.Directory.get("ProfD", Ci.nsIFile); brief.QueryInterface(Ci.nsILocalFile); brief.append("weave"); brief.append("logs"); brief.append("brief-log.txt"); if (!brief.exists()) brief.create(brief.NORMAL_FILE_TYPE, PERMS_FILE); let verbose = brief.parent.clone(); verbose.append("verbose-log.txt"); if (!verbose.exists()) verbose.create(verbose.NORMAL_FILE_TYPE, PERMS_FILE); this._briefApp = new Log4Moz.RotatingFileAppender(brief, formatter); this._briefApp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.briefLog")]; root.addAppender(this._briefApp); this._debugApp = new Log4Moz.RotatingFileAppender(verbose, formatter); this._debugApp.level = Log4Moz.Level[Svc.Prefs.get("log.appender.debugLog")]; root.addAppender(this._debugApp); }, clearLogs: function WeaveSvc_clearLogs() { this._briefApp.clear(); this._debugApp.clear(); }, /** * Register the built-in engines for certain applications */ _registerEngines: function WeaveSvc__registerEngines() { let engines = []; switch (Svc.AppInfo.ID) { case FENNEC_ID: engines = ["Bookmarks", "History", "Password", "Tab"]; break; case FIREFOX_ID: engines = ["Bookmarks", "Cookie", "Extension", "Form", "History", "Input", "MicroFormat", "Password", "Plugin", "Prefs", "Tab", "Theme"]; break; case SEAMONKEY_ID: engines = ["Form", "History", "Password"]; break; case THUNDERBIRD_ID: engines = ["Cookie", "Password"]; break; } // Grab the actual engine and register them Engines.register(engines.map(function(name) Weave[name + "Engine"])); }, QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver, Ci.nsISupportsWeakReference]), // nsIObserver observe: function WeaveSvc__observe(subject, topic, data) { switch (topic) { case "nsPref:changed": switch (data) { case "enabled": case "schedule": // Potentially we'll want to reschedule syncs this._checkSyncStatus(); break; } break; case "network:offline-status-changed": // Whether online or offline, we'll reschedule syncs this._log.debug("Network offline status change: " + data); this._checkSyncStatus(); break; case "private-browsing": // Entering or exiting private browsing? Reschedule syncs this._log.debug("Private browsing change: " + data); this._checkSyncStatus(); break; case "quit-application": this._onQuitApplication(); break; case "weave:service:sync:error": this._handleSyncError(); break; case "weave:service:sync:finish": this._scheduleNextSync(); this._serverErrors = 0; break; case "idle": this._log.trace("Idle time hit, trying to sync"); Svc.Idle.removeIdleObserver(this, IDLE_TIME); this.sync(false); break; } }, _onQuitApplication: function WeaveSvc__onQuitApplication() { }, // These are global (for all engines) // gets cluster from central LDAP server and returns it, or null on error findCluster: function WeaveSvc_findCluster(username) { this._log.debug("Finding cluster for user " + username); let res = new Resource(this.baseURL + "1/" + username + "/node/weave"); try { let node = res.get(); switch (node.status) { case 404: this._log.debug("Using serverURL as data cluster (multi-cluster support disabled)"); return this.baseURL; case 0: case 200: return node; default: this._log.debug("Unexpected response code: " + node.status); break; } } catch (e) { this._log.debug("Network error on findCluster"); this._setSyncFailure(LOGIN_FAILED_NETWORK_ERROR); throw e; } }, // gets cluster from central LDAP server and sets this.clusterURL setCluster: function WeaveSvc_setCluster(username) { let cluster = this.findCluster(username); if (cluster) { if (cluster == this.clusterURL) return false; this._log.debug("Saving cluster setting"); this.clusterURL = cluster; return true; } this._log.debug("Error setting cluster for user " + username); return false; }, // update cluster if required. returns false if the update was not required updateCluster: function WeaveSvc_updateCluster(username) { let cTime = Date.now(); let lastUp = parseFloat(Svc.Prefs.get("lastClusterUpdate")); if (!lastUp || ((cTime - lastUp) >= CLUSTER_BACKOFF)) { if (this.setCluster(username)) { Svc.Prefs.set("lastClusterUpdate", cTime.toString()); return true; } } return false; }, verifyLogin: function WeaveSvc_verifyLogin(username, password, passphrase, isLogin) this._catch(this._notify("verify-login", "", function() { this._log.debug("Verifying login for user " + username); let url = this.findCluster(username); if (isLogin) this.clusterURL = url; let res = new Resource(this.userURL + "/info/collections"); res.authenticator = { onRequest: function(headers) { headers['Authorization'] = 'Basic ' + btoa(username + ':' + password); return headers; } }; // login may fail because of cluster change try { let test = res.get(); switch (test.status) { case 200: if (passphrase && !this.verifyPassphrase(username, password, passphrase)) { this._setSyncFailure(LOGIN_FAILED_INVALID_PASSPHRASE); return false; } return true; case 401: if (this.updateCluster(username)) return this.verifyLogin(username, password, passphrase, isLogin); this._setSyncFailure(LOGIN_FAILED_LOGIN_REJECTED); this._log.debug("verifyLogin failed: login failed") return false; default: throw "unexpected HTTP response: " + test.status; } } catch (e) { // if we get here, we have either a busted channel or a network error this._log.debug("verifyLogin failed: " + e) this._setSyncFailure(LOGIN_FAILED_NETWORK_ERROR); throw e; } }))(), verifyPassphrase: function WeaveSvc_verifyPassphrase(username, password, passphrase) this._catch(this._notify("verify-passphrase", "", function() { this._log.debug("Verifying passphrase"); this.username = username; ID.get("WeaveID").setTempPassword(password); try { let pubkey = PubKeys.getDefaultKey(); let privkey = PrivKeys.get(pubkey.privateKeyUri); return Svc.Crypto.verifyPassphrase( privkey.payload.keyData, passphrase, privkey.payload.salt, privkey.payload.iv ); } catch (e) { // this means no keys are present (or there's a network error) return true; } return true; }))(), changePassphrase: function WeaveSvc_changePassphrase(newphrase) this._catch(this._notify("changepph", "", function() { let pubkey = PubKeys.getDefaultKey(); let privkey = PrivKeys.get(pubkey.privateKeyUri); /* Re-encrypt with new passphrase. * FIXME: verifyPassphrase first! */ let newkey = Svc.Crypto.rewrapPrivateKey(privkey.payload.keyData, this.passphrase, privkey.payload.salt, privkey.payload.iv, newphrase); privkey.payload.keyData = newkey; let resp = new Resource(privkey.uri).put(privkey.serialize()); if (!resp.success) throw resp; this.passphrase = newphrase; return true; }))(), changePassword: function WeaveSvc_changePassword(newpass) this._catch(this._notify("changepwd", "", function() { let url = this.baseURL + '1/' + this.username + "/password"; let res = new Weave.Resource(url); let resp = res.post(newpass); if (resp.status != 200) { this._log.info("Password change failed: " + resp); throw "Could not change password"; } this.password = newpass; return true; }))(), resetPassphrase: function WeaveSvc_resetPassphrase(newphrase) this._catch(this._notify("resetpph", "", function() { /* Make remote commands ready so we have a list of clients beforehand */ this.prepCommand("logout", []); let clientsBackup = Clients._store.clients; /* Wipe */ this.wipeServer(); /* Set remote commands before syncing */ Clients._store.clients = clientsBackup; let username = this.username; let password = this.password; this.logout(); /* Set this so UI is updated on next run */ this.passphrase = newphrase; /* Login in sync: this also generates new keys */ this.login(username, password, newphrase); this.sync(true); return true; }))(), _autoConnectAttempts: 0, _autoConnect: function WeaveSvc__attemptAutoConnect() { try { if (!this.username || !this.password || !this.passphrase) return; let failureReason; if (Svc.IO.offline) failureReason = "Application is offline"; else if (this.login()) { this.syncOnIdle(); return; } failureReason = this.detailedStatus.sync; } catch (ex) { failureReason = ex; } this._log.debug("Autoconnect failed: " + failureReason); let listener = new Utils.EventListener(Utils.bind2(this, function WeaveSvc__autoConnectCallback(timer) { this._autoConnectTimer = null; this._autoConnect(); })); this._autoConnectTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer); // back off slowly, with some random fuzz to avoid repeated collisions let interval = Math.floor(Math.random() * SCHEDULED_SYNC_INTERVAL + SCHEDULED_SYNC_INTERVAL * this._autoConnectAttempts); this._autoConnectAttempts++; this._autoConnectTimer.initWithCallback(listener, interval, Ci.nsITimer.TYPE_ONE_SHOT); this._log.debug("Scheduling next autoconnect attempt in " + interval / 1000 + " seconds."); }, login: function WeaveSvc_login(username, password, passphrase) this._catch(this._lock(this._notify("login", "", function() { this._loggedIn = false; this._detailedStatus = new StatusRecord(); if (Svc.IO.offline) throw "Application is offline, login should not be called"; if (typeof(username) != "undefined") this.username = username; if (typeof(password) != "undefined") ID.get("WeaveID").setTempPassword(password); if (typeof(passphrase) != "undefined") ID.get("WeaveCryptoID").setTempPassword(passphrase); if (!this.username) { this._setSyncFailure(LOGIN_FAILED_NO_USERNAME); throw "No username set, login failed"; } if (!this.password) { this._setSyncFailure(LOGIN_FAILED_NO_PASSWORD); throw "No password given or found in password manager"; } this._log.debug("Logging in user " + this.username); if (!(this.verifyLogin(this.username, this.password, passphrase, true))) { // verifyLogin sets the failure states here throw "Login failed: " + this.detailedStatus.sync; } // Try starting the sync timer now that we're logged in this._loggedIn = true; this._checkSyncStatus(); if (this._autoConnectTimer) { this._autoConnectTimer.cancel(); this._autoConnectTimer = null; } return true; })))(), logout: function WeaveSvc_logout() { this._log.info("Logging out"); this._loggedIn = false; this._keyPair = {}; ID.get('WeaveID').setTempPassword(null); // clear cached password ID.get('WeaveCryptoID').setTempPassword(null); // and passphrase // Cancel the sync timer now that we're logged out this._checkSyncStatus(); Svc.Observer.notifyObservers(null, "weave:service:logout:finish", ""); }, _errorStr: function WeaveSvc__errorStr(code) { switch (code.toString()) { case "1": return "illegal-method"; case "2": return "invalid-captcha"; case "3": return "invalid-username"; case "4": return "cannot-overwrite-resource"; case "5": return "userid-mismatch"; case "6": return "json-parse-failure"; case "7": return "invalid-password"; case "8": return "invalid-record"; case "9": return "weak-password"; default: return "generic-server-error"; } }, checkUsername: function WeaveSvc_checkUsername(username) { let url = this.baseURL + "1/" + username; let res = new Resource(url); res.authenticator = new NoOpAuthenticator(); let data = ""; try { data = res.get(); if (data.status == 200 && data == "0") return "available"; } catch(ex) {} // Convert to the error string, or default to generic on exception return this._errorStr(data); }, createAccount: function WeaveSvc_createAccount(username, password, email, captchaChallenge, captchaResponse) { let payload = JSON.stringify({ "password": password, "email": email, "captcha-challenge": captchaChallenge, "captcha-response": captchaResponse }); let url = this.baseURL + '1/' + username; let res = new Resource(url); res.authenticator = new Weave.NoOpAuthenticator(); let error = "generic-server-error"; try { let register = res.put(payload); if (register.success) { this._log.info("Account created: " + register); return; } // Must have failed, so figure out the reason if (register.status == 400) error = this._errorStr(register); } catch(ex) { this._log.warn("Failed to create account: " + ex); } return error; }, // stuff we need to to after login, before we can really do // anything (e.g. key setup) _remoteSetup: function WeaveSvc__remoteSetup() { let reset = false; this._log.debug("Fetching global metadata record"); let meta = Records.import(this.userURL + "/storage/meta/global"); let remoteVersion = (meta && meta.payload.storageVersion)? meta.payload.storageVersion : ""; this._log.debug(["Weave Version:", WEAVE_VERSION, "Compatible:", COMPATIBLE_VERSION, "Remote:", remoteVersion].join(" ")); if (!meta || !meta.payload.storageVersion || !meta.payload.syncID || Svc.Version.compare(COMPATIBLE_VERSION, remoteVersion) > 0) { // abort the server wipe if the GET status was anything other than 404 or 200 let status = Records.response.status; if (status != 200 && status != 404) { this._setSyncFailure(METARECORD_DOWNLOAD_FAIL); this._log.warn("Unknown error while downloading metadata record. " + "Aborting sync."); return false; } if (!meta) this._log.info("No metadata record, server wipe needed"); if (meta && !meta.payload.syncID) this._log.warn("No sync id, server wipe needed"); if (Svc.Version.compare(COMPATIBLE_VERSION, remoteVersion) > 0) this._log.info("Server data is older than what Weave supports, server wipe needed"); if (!this._keyGenEnabled) { this._log.info("...and key generation is disabled. Not wiping. " + "Aborting sync."); this._setSyncFailure(DESKTOP_VERSION_OUT_OF_DATE); return false; } reset = true; this._log.info("Wiping server data"); this._freshStart(); if (status == 404) this._log.info("Metadata record not found, server wiped to ensure " + "consistency."); else // 200 this._log.info("Server data wiped to ensure consistency after client " + "upgrade (" + remoteVersion + " -> " + WEAVE_VERSION + ")"); } else if (Svc.Version.compare(remoteVersion, WEAVE_VERSION) > 0) { this._setSyncFailure(VERSION_OUT_OF_DATE); this._log.warn("Server data is of a newer Weave version, this client " + "needs to be upgraded. Aborting sync."); return false; } else if (meta.payload.syncID != Clients.syncID) { this._log.warn("Meta.payload.syncID is " + meta.payload.syncID + ", Clients.syncID is " + Clients.syncID); this.resetClient(); this._log.info("Reset client because of syncID mismatch."); Clients.syncID = meta.payload.syncID; this._log.info("Reset the client after a server/client sync ID mismatch"); this._updateRemoteVersion(meta); } // We didn't wipe the server and we're not out of date, so update remote else this._updateRemoteVersion(meta); let needKeys = true; let pubkey = PubKeys.getDefaultKey(); if (!pubkey) this._log.debug("Could not get public key"); else if (pubkey.keyData == null) this._log.debug("Public key has no key data"); else { // make sure we have a matching privkey let privkey = PrivKeys.get(pubkey.privateKeyUri); if (!privkey) this._log.debug("Could not get private key"); else if (privkey.keyData == null) this._log.debug("Private key has no key data"); else return true; } if (needKeys) { if (PubKeys.response.status != 404 && PrivKeys.response.status != 404) { this._log.warn("Couldn't download keys from server, aborting sync"); this._log.debug("PubKey HTTP status: " + PubKeys.response.status); this._log.debug("PrivKey HTTP status: " + PrivKeys.response.status); this._setSyncFailure(KEYS_DOWNLOAD_FAIL); return false; } if (!this._keyGenEnabled) { this._log.warn("Couldn't download keys from server, and key generation" + "is disabled. Aborting sync"); this._setSyncFailure(NO_KEYS_NO_KEYGEN); return false; } if (!reset) { this._log.warn("Calling freshStart from !reset case."); this._freshStart(); this._log.info("Server data wiped to ensure consistency due to missing keys"); } let passphrase = ID.get("WeaveCryptoID"); if (passphrase.password) { let keys = PubKeys.createKeypair(passphrase, PubKeys.defaultKeyUri, PrivKeys.defaultKeyUri); try { // Upload and cache the keypair PubKeys.uploadKeypair(keys); PubKeys.set(keys.pubkey.uri, keys.pubkey); PrivKeys.set(keys.privkey.uri, keys.privkey); return true; } catch (e) { this._setSyncFailure(KEYS_UPLOAD_FAIL); this._log.error("Could not upload keys: " + Utils.exceptionStr(e)); } } else { this._setSyncFailure(SETUP_FAILED_NO_PASSPHRASE); this._log.warn("Could not get encryption passphrase"); } } return false; }, /** * Engine scores must meet or exceed this value before we sync them when * using thresholds. These are engine-specific, as different kinds of data * change at different rates, so we store them in a hash by engine name. */ _syncThresh: {}, /** * Determine if a sync should run. * * @return Reason for not syncing; not-truthy if sync should run */ _checkSync: function WeaveSvc__checkSync() { let reason = ""; if (!this.enabled) reason = kSyncWeaveDisabled; else if (!this._loggedIn) reason = kSyncNotLoggedIn; else if (Svc.IO.offline) reason = kSyncNetworkOffline; else if (Svc.Private && Svc.Private.privateBrowsingEnabled) // Svc.Private doesn't exist on Fennec -- don't assume it's there. reason = kSyncInPrivateBrowsing; else if (Svc.Prefs.get("schedule", 0) != 1) reason = kSyncNotScheduled; return reason; }, /** * Check if we should be syncing and schedule the next sync, if it's not scheduled */ _checkSyncStatus: function WeaveSvc__checkSyncStatus() { // Should we be syncing now, if not, cancel any sync timers and return if (this._checkSync()) { if (this._syncTimer) { this._syncTimer.cancel(); this._syncTimer = null; } try { Svc.Idle.removeIdleObserver(this, IDLE_TIME); } catch(e) {} // this throws if there isn't an observer, but that's fine return; } // otherwise, schedule the sync this._scheduleNextSync(); }, /** * Call sync() on an idle timer * */ syncOnIdle: function WeaveSvc_syncOnIdle() { this._log.debug("Idle timer created for sync, will sync after " + IDLE_TIME + " seconds of inactivity."); Svc.Idle.addIdleObserver(this, IDLE_TIME); }, /** * Set a timer for the next sync */ _scheduleNextSync: function WeaveSvc__scheduleNextSync(interval) { if (!interval) interval = SCHEDULED_SYNC_INTERVAL; // if there's an existing timer, cancel it and restart if (this._syncTimer) this._syncTimer.cancel(); else this._syncTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer); let listener = new Utils.EventListener(Utils.bind2(this, function WeaveSvc__scheduleNextSyncCallback(timer) { this._syncTimer = null; this.syncOnIdle(); })); this._syncTimer.initWithCallback(listener, interval, Ci.nsITimer.TYPE_ONE_SHOT); this._log.debug("Next sync call in: " + this._syncTimer.delay / 1000 + " seconds.") }, _serverErrors: 0, /** * Deal with sync errors appropriately */ _handleSyncError: function WeaveSvc__handleSyncError() { let shouldBackoff = false; let err = Weave.Service.detailedStatus.sync; // we'll assume the server is just borked a little for these switch (err) { case METARECORD_DOWNLOAD_FAIL: case KEYS_DOWNLOAD_FAIL: case KEYS_UPLOAD_FAIL: shouldBackoff = true; } // specifcally handle 500, 502, 503, 504 errors // xxxmpc: what else should be in this list? // this is sort of pseudocode, need a way to get at the if (!shouldBackoff) { try { shouldBackoff = Utils.checkStatus(Records.response.status, null, [500, [502, 504]]); } catch (e) { // if responseStatus throws, we have a network issue in play shouldBackoff = true; } } // if this is a client error, do the next sync as normal and return if (!shouldBackoff) { this._scheduleNextSync(); return; } // ok, something failed connecting to the server, rev the counter this._serverErrors++; // do nothing on the first failure, if we fail again we'll back off if (this._serverErrors < 2) { this._scheduleNextSync(); return; } // 30-60 minute backoff interval, increasing each time const MINIMUM_BACKOFF_INTERVAL = 15 * 60 * 1000; // 15 minutes * >= 2 const MAXIMUM_BACKOFF_INTERVAL = 8 * 60 * 60 * 1000; // 8 hours let backoffInterval = this._serverErrors * (Math.floor(Math.random() * MINIMUM_BACKOFF_INTERVAL) + MINIMUM_BACKOFF_INTERVAL); backoffInterval = Math.min(backoffInterval, MAXIMUM_BACKOFF_INTERVAL); this._scheduleNextSync(backoffInterval); let d = new Date(Date.now() + backoffInterval); this._log.config("Starting backoff, next sync at:" + d.toString()); }, /** * Sync up engines with the server. * * @param fullSync * True to unconditionally sync all engines */ sync: function WeaveSvc_sync(fullSync) this._catch(this._lock(this._notify("sync", "", function() { fullSync = true; // not doing thresholds yet // Use thresholds to determine what to sync only if it's not a full sync let useThresh = !fullSync; // Make sure we should sync or record why we shouldn't. We always obey the // reason if we're using thresholds (not a full sync); otherwise, allow // "not scheduled" as future syncs have already been canceled by checkSync. let reason = this._checkSync(); if (reason && (useThresh || reason != kSyncNotScheduled)) { // this is a purposeful abort rather than a failure, so don't set // WEAVE_STATUS_FAILED; instead, leave it as it was. this._detailedStatus.setSyncStatus(reason); reason = "Can't sync: " + reason; throw reason; } if (!(this._remoteSetup())) throw "aborting sync, remote setup failed"; this._log.debug("Refreshing client list"); Clients.sync(); // Process the incoming commands if we have any if (Clients.getClients()[Clients.clientID].commands) { try { if (!(this.processCommands())) { this._detailedStatus.setSyncStatus(ABORT_SYNC_COMMAND); throw "aborting sync, process commands said so"; } // Repeat remoteSetup in-case the commands forced us to reset if (!(this._remoteSetup())) throw "aborting sync, remote setup failed after processing commands"; } finally { // Always immediately push back the local client (now without commands) Clients.sync(); } } try { for each (let engine in Engines.getAll()) { let name = engine.name; // Nothing to do for disabled engines if (!engine.enabled) continue; // Conditionally reset the threshold for the current engine let resetThresh = Utils.bind2(this, function WeaveSvc__resetThresh(cond) cond ? this._syncThresh[name] = INITIAL_THRESHOLD : undefined); // Initialize the threshold if it doesn't exist yet resetThresh(!(name in this._syncThresh)); // Determine if we should sync if using thresholds if (useThresh) { let score = engine.score; let thresh = this._syncThresh[name]; if (score >= thresh) this._log.debug("Syncing " + name + "; " + "score " + score + " >= thresh " + thresh); else { this._log.debug("Not syncing " + name + "; " + "score " + score + " < thresh " + thresh); // Decrement the threshold by a standard amount with a lower bound of 1 this._syncThresh[name] = Math.max(thresh - THRESHOLD_DECREMENT_STEP, 1); // No need to sync this engine for now continue; } } // If there's any problems with syncing the engine, report the failure if (!(this._syncEngine(engine))) { this._log.info("Aborting sync"); break; } // We've successfully synced, so reset the threshold. We do this after // a successful sync so failures can try again on next sync, but this // could trigger too many syncs if the server is having problems. resetThresh(useThresh); } if (this._syncError) this._log.warn("Some engines did not sync correctly"); else { Svc.Prefs.set("lastSync", new Date().toString()); this._weaveStatusCode = WEAVE_STATUS_OK; this._log.info("Sync completed successfully"); } } finally { this._syncError = false; } })))(), // returns true if sync should proceed // false / no return value means sync should be aborted _syncEngine: function WeaveSvc__syncEngine(engine) { try { engine.sync(); return true; } catch(e) { // maybe a 401, cluster update needed? if (e.status == 401 && this.updateCluster(this.username)) return this._syncEngine(engine); this._syncError = true; this._weaveStatusCode = WEAVE_STATUS_PARTIAL; this._detailedStatus.setEngineStatus(engine.name, e); if (FaultTolerance.Service.onException(e)) return true; } }, _freshStart: function WeaveSvc__freshStart() { this.resetClient(); this._log.info("Reset client data from freshStart."); this._log.info("Client metadata wiped, deleting server data"); this.wipeServer(); // XXX Bug 504125 Wait a while after wiping so that the DELETEs replicate Sync.sleep(2000); this._log.debug("Uploading new metadata record"); meta = new WBORecord(this.userURL + "/storage/meta/global"); meta.payload.syncID = Clients.syncID; this._updateRemoteVersion(meta); }, _updateRemoteVersion: function WeaveSvc__updateRemoteVersion(meta) { // Don't update if the remote version is already newer if (Svc.Version.compare(meta.payload.storageVersion, WEAVE_VERSION) >= 0) return; this._log.debug("Setting meta payload storage version to " + WEAVE_VERSION); meta.payload.storageVersion = WEAVE_VERSION; let resp = new Resource(meta.uri).put(meta.serialize()); if (!resp.success) throw resp; }, /** * Wipe all user data from the server. * * @param engines [optional] * Array of engine names to wipe. If not given, all engines are used. */ wipeServer: function WeaveSvc_wipeServer(engines) this._catch(this._notify("wipe-server", "", function() { // Grab all the collections for the user let res = new Resource(this.userURL + "/info/collections"); res.get(); // Get the array of collections and delete each one let allCollections = JSON.parse(res.data); for (let name in allCollections) { try { // If we have a list of engines, make sure it's one we want if (engines && engines.indexOf(name) == -1) continue; new Resource(this.userURL + "/storage/" + name).delete(); } catch(ex) { this._log.debug("Exception on wipe of '" + name + "': " + Utils.exceptionStr(ex)); } } }))(), /** * Wipe all local user data. * * @param engines [optional] * Array of engine names to wipe. If not given, all engines are used. */ wipeClient: function WeaveSvc_wipeClient(engines) this._catch(this._notify("wipe-client", "", function() { // If we don't have any engines, reset the service and wipe all engines if (!engines) { // Clear out any service data this.resetService(); engines = [Clients].concat(Engines.getAll()); } // Convert the array of names into engines else engines = Engines.get(engines); // Fully wipe each engine for each (let engine in engines) engine.wipeClient(); }))(), /** * Wipe all remote user data by wiping the server then telling each remote * client to wipe itself. * * @param engines [optional] * Array of engine names to wipe. If not given, all engines are used. */ wipeRemote: function WeaveSvc_wipeRemote(engines) this._catch(this._notify("wipe-remote", "", function() { // Clear out any server data //this.wipeServer(engines); // Only wipe the engines provided if (engines) { engines.forEach(function(e) this.prepCommand("wipeEngine", [e]), this); return; } // Tell the remote machines to wipe themselves this.prepCommand("wipeAll", []); }))(), /** * Reset local service information like logs, sync times, caches. */ resetService: function WeaveSvc_resetService() this._catch(this._notify("reset-service", "", function() { // First drop old logs to track client resetting behavior this.clearLogs(); this._log.info("Logs reinitialized for service reset"); // Pretend we've never synced to the server and drop cached data Clients.resetSyncID(); Svc.Prefs.reset("lastSync"); for each (let cache in [PubKeys, PrivKeys, CryptoMetas, Records]) cache.clearCache(); }))(), /** * Reset the client by getting rid of any local server data and client data. * * @param engines [optional] * Array of engine names to reset. If not given, all engines are used. */ resetClient: function WeaveSvc_resetClient(engines) this._catch(this._notify("reset-client", "", function() { // If we don't have any engines, reset everything including the service if (!engines) { // Clear out any service data this.resetService(); engines = [Clients].concat(Engines.getAll()); } // Convert the array of names into engines else engines = Engines.get(engines); // Have each engine drop any temporary meta data for each (let engine in engines) engine.resetClient(); // XXX Bug 480448: Delete any snapshots from old code try { let cruft = Svc.Directory.get("ProfD", Ci.nsIFile); cruft.QueryInterface(Ci.nsILocalFile); cruft.append("weave"); cruft.append("snapshots"); if (cruft.exists()) cruft.remove(true); } catch (e) { this._log.debug("Could not remove old snapshots: " + Utils.exceptionStr(e)); } }))(), /** * A hash of valid commands that the client knows about. The key is a command * and the value is a hash containing information about the command such as * number of arguments and description. */ _commands: [ ["resetAll", 0, "Clear temporary local data for all engines"], ["resetEngine", 1, "Clear temporary local data for engine"], ["wipeAll", 0, "Delete all client data for all engines"], ["wipeEngine", 1, "Delete all client data for engine"], ["logout", 0, "Log out client"], ].reduce(function WeaveSvc__commands(commands, entry) { commands[entry[0]] = {}; for (let [i, attr] in Iterator(["args", "desc"])) commands[entry[0]][attr] = entry[i + 1]; return commands; }, {}), /** * Check if the local client has any remote commands and perform them. * * @return False to abort sync */ processCommands: function WeaveSvc_processCommands() this._notify("process-commands", "", function() { let info = Clients.getInfo(Clients.clientID); let commands = info.commands; // Immediately clear out the commands as we've got them locally delete info.commands; Clients.setInfo(Clients.clientID, info); // Process each command in order for each ({command: command, args: args} in commands) { this._log.debug("Processing command: " + command + "(" + args + ")"); let engines = [args[0]]; switch (command) { case "resetAll": engines = null; // Fallthrough case "resetEngine": this.resetClient(engines); break; case "wipeAll": engines = null; // Fallthrough case "wipeEngine": this.wipeClient(engines); break; case "logout": this.logout(); return false; default: this._log.debug("Received an unknown command: " + command); break; } } return true; })(), /** * Prepare to send a command to each remote client. Calling this doesn't * actually sync the command data to the server. If the client already has * the command/args pair, it won't get a duplicate action. * * @param command * Command to invoke on remote clients * @param args * Array of arguments to give to the command */ prepCommand: function WeaveSvc_prepCommand(command, args) { let commandData = this._commands[command]; // Don't send commands that we don't know about if (commandData == null) { this._log.error("Unknown command to send: " + command); return; } // Don't send a command with the wrong number of arguments else if (args == null || args.length != commandData.args) { this._log.error("Expected " + commandData.args + " args for '" + command + "', but got " + args); return; } // Package the command/args pair into an object let action = { command: command, args: args, }; let actionStr = command + "(" + args + ")"; // Convert args into a string to simplify array comparisons let jsonArgs = JSON.stringify(args); let notDupe = function(action) action.command != command || JSON.stringify(action.args) != jsonArgs; this._log.info("Sending clients: " + actionStr + "; " + commandData.desc); // Add the action to each remote client for (let guid in Clients.getClients()) { // Don't send commands to the local client if (guid == Clients.clientID) continue; let info = Clients.getInfo(guid); // Set the action to be a new commands array if none exists if (info.commands == null) info.commands = [action]; // Add the new action if there are no duplicates else if (info.commands.every(notDupe)) info.commands.push(action); // Must have been a dupe.. skip! else continue; Clients.setInfo(guid, info); this._log.trace("Client " + guid + " got a new action: " + actionStr); } }, };