1
/* ***** BEGIN LICENSE BLOCK *****
2
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
4
* The contents of this file are subject to the Mozilla Public License Version
5
* 1.1 (the "License"); you may not use this file except in compliance with
6
* the License. You may obtain a copy of the License at
7
* http://www.mozilla.org/MPL/
9
* Software distributed under the License is distributed on an "AS IS" basis,
10
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11
* for the specific language governing rights and limitations under the
14
* The Original Code is Bookmarks Sync.
16
* The Initial Developer of the Original Code is Mozilla.
17
* Portions created by the Initial Developer are Copyright (C) 2008
18
* the Initial Developer. All Rights Reserved.
21
* Anant Narayanan <anant@kix.in>
23
* Alternatively, the contents of this file may be used under the terms of
24
* either the GNU General Public License Version 2 or later (the "GPL"), or
25
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26
* in which case the provisions of the GPL or the LGPL are applicable instead
27
* of those above. If you wish to allow use of your version of this file only
28
* under the terms of either the GPL or the LGPL, and not to allow others to
29
* use your version of this file under the terms of the MPL, indicate your
30
* decision by deleting the provisions above and replace them with the notice
31
* and other provisions required by the GPL or the LGPL. If you do not delete
32
* the provisions above, a recipient may use your version of this file under
33
* the terms of any one of the MPL, the GPL or the LGPL.
35
* ***** END LICENSE BLOCK ***** */
37
const EXPORTED_SYMBOLS = ['Tracker'];
39
const Cc = Components.classes;
40
const Ci = Components.interfaces;
41
const Cr = Components.results;
42
const Cu = Components.utils;
44
Cu.import("resource://weave/log4moz.js");
45
Cu.import("resource://weave/constants.js");
46
Cu.import("resource://weave/util.js");
47
Cu.import("resource://weave/ext/Observers.js");
50
* Trackers are associated with a single engine and deal with
51
* listening for changes to their particular data type.
53
* There are two things they keep track of:
54
* 1) A score, indicating how urgently the engine wants to sync
55
* 2) A list of IDs for all the changed items that need to be synced
56
* and updating their 'score', indicating how urgently they
60
function Tracker(name) {
61
name = name || "Unnamed";
62
this.name = this.file = name.toLowerCase();
64
this._log = Log4Moz.repository.getLogger("Tracker." + name);
65
let level = Svc.Prefs.get("log.logger.engine." + this.name, "Debug");
66
this._log.level = Log4Moz.Level[level];
70
this.ignoreAll = false;
72
this.loadChangedIDs();
76
* Score can be called as often as desired to decide which engines to sync
78
* Valid values for score:
79
* -1: Do not sync unless the user specifically requests it (almost disabled)
80
* 0: Nothing has changed
81
* 100: Please sync me ASAP!
83
* Setting it to other values should (but doesn't currently) throw an exception
91
Observers.notify("weave:engine:score:updated", this.name);
94
// Should be called by service everytime a sync has been done for an engine
95
resetScore: function T_resetScore() {
99
saveChangedIDs: function T_saveChangedIDs() {
100
Utils.delay(function() {
101
Utils.jsonSave("changes/" + this.file, this, this.changedIDs);
102
}, 1000, this, "_lazySave");
105
loadChangedIDs: function T_loadChangedIDs() {
106
Utils.jsonLoad("changes/" + this.file, this, function(json) {
107
this.changedIDs = json;
111
// ignore/unignore specific IDs. Useful for ignoring items that are
112
// being processed, or that shouldn't be synced.
113
// But note: not persisted to disk
115
ignoreID: function T_ignoreID(id) {
117
this._ignored.push(id);
120
unignoreID: function T_unignoreID(id) {
121
let index = this._ignored.indexOf(id);
123
this._ignored.splice(index, 1);
126
addChangedID: function addChangedID(id, when) {
128
this._log.warn("Attempted to add undefined ID to tracker");
131
if (this.ignoreAll || (id in this._ignored))
134
// Default to the current time in seconds if no time is provided
136
when = Math.floor(Date.now() / 1000);
138
// Add/update the entry if we have a newer time
139
if ((this.changedIDs[id] || -Infinity) < when) {
140
this._log.trace("Adding changed ID: " + [id, when]);
141
this.changedIDs[id] = when;
142
this.saveChangedIDs();
147
removeChangedID: function T_removeChangedID(id) {
149
this._log.warn("Attempted to remove undefined ID to tracker");
152
if (this.ignoreAll || (id in this._ignored))
154
if (this.changedIDs[id] != null) {
155
this._log.trace("Removing changed ID " + id);
156
delete this.changedIDs[id];
157
this.saveChangedIDs();
162
clearChangedIDs: function T_clearChangedIDs() {
163
this._log.trace("Clearing changed ID list");
164
this.changedIDs = {};
165
this.saveChangedIDs();
added
removed
source/modules/trackers.js
