Merge lp:~jamesh/bindwood/switch-to-new-synchroniser into lp:bindwood

[James Henstridge]

Plug the new synchronisation code into the Bindwood object.

Plug the new synchronisation code into the Bindwood object. It should be possible to do manual testing with this branch.

If you've got two machines successfully synchronising with each other, you could try running this version of Bindwood on each system. Alternatively, you can sync between two local instances of Bindwood (which means you don't have to deal with replication lag or errors). Here are the steps I used to do this:

1. run "firefox -no-remote -ProfileManager" and create a profile called "bindwood", start firefox, and then exit.

2. Run the previous command again and create a profile called "bindwood2", but manually set the profile folder so that it ends in ".bindwood" (Bindwood is using the profile directory name to guess the profile name). Start and exit this instance of Firefox.

3. From a checkout of this branch, run the following commands:
    ./dev-install bindwood
    ./dev-install bindwood2

4. Start the two Firefox instances with:
    BINDWOOD_DB=test_bookmarks firefox -no-remote -P bindwood
    BINDWOOD_DB=test_bookmarks firefox -no-remote -P bindwood2

You should then be able to make changes in one Firefox window and see them appear in the other window after a delay.

There are a few caveats:

1. The delay for change propagation will be about 30 seconds on average with a maximum of a minute. The synchronisation code runs every 30 seconds, and you'll need to wait for a sync from one instance and then one from the other.

2. I am not performing any duplicate detection at the moment, so the default set of bookmarks will end up being duplicated in the two instances once the two sides quiesce. Deleting one of the duplicates will resolve this.

3. There is no code to migrate old bookmark databases yet. That's why I suggested running against a scratch database above.

[James Henstridge (jamesh)]

One other error I've noticed with this code is moving a bookmark between folders. The reorder_children() routine will get confused and try to set the bookmark's position in the old folder leading to an error.

This error needs to be fixed but is not related to the changes in this branch, so I'd like to address it in a future branch.

[Eric Casteleijn (thisfred)]

Looks good, like the amount of red diff lines ;)

review: Approve

[Manuel de la Peña (mandel)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

No proposals found for merge of lp:~jamesh/bindwood/sync-all into lp:bindwood.

=== modified file 'modules/bindwood.jsm'
--- modules/bindwood.jsm	2011-02-21 06:41:10 +0000
+++ modules/bindwood.jsm	2011-03-01 10:47:38 +0000
@@ -21,28 +21,14 @@
 const Ci = Components.interfaces;
 const Cu = Components.utils;
 
-Cu.import("resource://gre/modules/utils.js");
 Cu.import("resource://bindwood/desktopcouch.jsm");
 Cu.import("resource://bindwood/logging.jsm");
+Cu.import("resource://bindwood/sync.jsm");
 
-var bookmarksService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"]
-    .getService(Ci.nsINavBookmarksService);
-var livemarkService = Cc["@mozilla.org/browser/livemark-service;2"]
-    .getService(Ci.nsILivemarkService);
-var uuidService = Cc["@mozilla.org/uuid-generator;1"]
-    .getService(Ci.nsIUUIDGenerator);
-var annotationService = Cc["@mozilla.org/browser/annotation-service;1"]
-    .getService(Ci.nsIAnnotationService);
-var historyService = Cc["@mozilla.org/browser/nav-history-service;1"]
-    .getService(Ci.nsINavHistoryService);
-var ioService = Cc["@mozilla.org/network/io-service;1"]
-    .getService(Ci.nsIIOService);
 var envService = Cc["@mozilla.org/process/environment;1"]
     .getService(Ci.nsIEnvironment);
 var directoryService = Cc["@mozilla.org/file/directory_service;1"]
     .getService(Ci.nsIProperties);
-var windowService = Cc["@mozilla.org/embedcomp/window-watcher;1"]
-    .getService(Ci.nsIWindowWatcher);
 // Technically, a branch, rather than the actual service, but
 // consistency wins, I think
 var prefsService = Cc["@mozilla.org/preferences-service;1"]
@@ -50,37 +36,12 @@
 
 var Bindwood = {
 
-    pull_changes_timer: Cc["@mozilla.org/timer;1"]
-        .createInstance(Ci.nsITimer),
-    status_timer: Cc["@mozilla.org/timer;1"]
-        .createInstance(Ci.nsITimer),
-
-    SCHEMA_VERSION: 1,
-
-    TYPE_BOOKMARK: "http://www.freedesktop.org/wiki/Specifications/desktopcouch/bookmark",
-    TYPE_FOLDER: "http://www.freedesktop.org/wiki/Specifications/desktopcouch/folder",
-    TYPE_FEED: "http://www.freedesktop.org/wiki/Specifications/desktopcouch/feed",
-    TYPE_SEPARATOR: "http://www.freedesktop.org/wiki/Specifications/desktopcouch/separator",
-
+    sync_timer: Cc["@mozilla.org/timer;1"]
+        .createInstance(Ci.nsITimer),
+
+    couch: null,
+    synchroniser: null,
     running: false,
-    push: 'ENABLED', // Start off enabled
-    annotationKey: "bindwood/uuid",
-    uuidItemIdMap: {},
-    records: [],
-    seen_revisions: {},
-    timestamps: {},
-
-    noteStartTime: function(key) {
-        var now = new Date();
-        Bindwood.timestamps[key] = now.getTime();
-    },
-
-    noteEndTime: function(key) {
-        var now = new Date();
-        var diff = now.getTime() - Bindwood.timestamps[key];
-        Log.debug(key + " took " + diff + " milliseconds");
-        delete Bindwood.timestamps[key];
-    },
 
     extractProfileName: function(path) {
         // We want the last part of the profile path
@@ -110,17 +71,26 @@
         // http://forums.mozillazine.org/viewtopic.php?f=19&t=657911&start=0
         // It ensures that we're only running that code on the first window.
 
-        if (!Bindwood.running) {
+        if (!this.running) {
             Log.debug("Getting started in init.");
-            Bindwood.currentProfile = Bindwood.extractProfileName(
+            this.currentProfile = Bindwood.extractProfileName(
                 directoryService.get('ProfD', Ci.nsIFile).path);
 
-            Log.debug("Got our profile: " + Bindwood.currentProfile);
-
-            Bindwood.running = true;
-            Bindwood.Observer = new BindwoodBookmarkObserver(this);
-            bookmarksService.addObserver(Bindwood.Observer, false);
-            Bindwood.connectToCouchDB();
+            Log.debug("Got our profile: " + this.currentProfile);
+
+            this.running = true;
+            this.connectToCouchDB();
+        }
+    },
+
+    uninit: function() {
+        if (this.running) {
+            this.running = false;
+            this.sync_timer.cancel();
+            if (this.synchroniser) {
+                this.synchroniser.uninit();
+                this.synchroniser = null;
+            }
         }
     },
 
@@ -144,9 +114,6 @@
                             "Something wrong with the process, exiting.", e);
                         return;
                     }
-                } else {
-                    // Could not connect: disable our observer.
-                    bookmarksService.removeObserver(Bindwood.Observer);
                 }
             }, function (message) {
                 Log.debug(message);
@@ -168,215 +135,39 @@
         return seq;
     },
 
-    getLatestModified: function() {
-        var mod;
-        try {
-            mod = Number(prefsService.getCharPref('latest_modified'));
-        } catch(e) {
-            mod = 0;
-        }
-        return mod;
-    },
-
-    setLatestModified: function(mod) {
-        prefsService.setCharPref(
-            'latest_modified', Number(mod).toString());
-        return mod;
-    },
-
     startProcess: function() {
-        Log.debug("Starting process");
-        Bindwood.last_seq = Bindwood.getLastSequence();
-        Log.debug("Got our last known sequence number: " + Bindwood.last_seq);
-        Bindwood.latest_modified = Bindwood.getLatestModified();
-        Log.debug(
-            "Got our latest known last_modified: " + Bindwood.latest_modified);
-
-        Log.debug("Ensuring the database exisits");
-        Bindwood.ensureDatabase();
-        Log.debug("Ensuring the views exist");
-        Bindwood.ensureViews();
-        Log.debug("Ensuring our scratch folder exists");
-        Bindwood.scratch_folder = Bindwood.ensureLocalScratchFolder();
-
-        var profile_exists = Bindwood.profileExists();
-        Log.debug(
-            "Determined whether profile already exists: " + profile_exists);
-
-        var HAVE_LAST_SEQ = Bindwood.last_seq ? 1 : 0; // 0 or 1
-        var HAVE_PROFILE_ROOT = profile_exists ? 2 : 0; // 0 or 2
-
-        var additional = []; // for case 0 and 3, nothing else needs to be done
-        var should_only_push_latest = true;
-
-        switch(HAVE_LAST_SEQ | HAVE_PROFILE_ROOT) {
-        case 0:
-            // Neither the profile root exists, nor do we have a last_seq.
-            // Ergo, we are a first time user. Proceed normally.
-
-            /* Disabling the pop-up window for the time being
-
-            Bindwood.statusWindow = windowService.openWindow(
-                null,
-                "chrome://bindwood/content/first-time.html",
-                "firstTime",
-                "chrome,centerscreen,outerwidth=640,outerheight=480", null);
-            Bindwood.status_timer.initWithCallback(
-                { notify: function(timer) {
-                    var div = Bindwood.statusWindow.document.getElementById('status');
-                    var dots = div.innerHTML;
-                    div.innerHTML = dots + ".";
-                } }, 1000, Ci.nsITimer.TYPE_REPEATING_SLACK);
-            */
-            break;
-        case 1:
-            // We have a last_seq, but the profile root does not exist.
-            // Ergo, we are an old user and must migrate to the new way of
-            // doing things.
-
-            /* Disabling the pop-up window for the time being
-
-            Bindwood.statusWindow = windowService.openWindow(
-                null,
-                "chrome://bindwood/content/migrate-old-bookmarks.html",
-                "migrate",
-                "chrome,centerscreen,outerwidth=640,outerheight=480", null);
-            Bindwood.status_timer.initWithCallback(
-                { notify: function(timer) {
-                    var div = Bindwood.statusWindow.document.getElementById('status');
-                    var dots = div.innerHTML;
-                    div.innerHTML = dots + ".";
-                } }, 1000, Ci.nsITimer.TYPE_REPEATING_SLACK);
-            */
-            // Migrate all existing records in Couch
-            Bindwood.migrateOlderBookmarkRecords();
-            // Ensure that all local records are pushed
-            should_only_push_latest = false;
-            break;
-        case 2:
-            // We have no last_seq, but the profile root exists. Ergo, we are
-            // starting up a subsequent client. We must make our local 
-            // bookmarks look like remote, and ensure that any unaccounted for
-            // local bookmarks are sent to CouchDB.
-
-            /* Disabling the pop-up window for the time being
-
-            Bindwood.statusWindow = windowService.openWindow(
-                null, 
-                "chrome://bindwood/content/subsequent-client-first-time-sync.html",
-                "subsequentClient", 
-                "chrome,centerscreen,outerwidth=640,outerheight=480", null);
-            Bindwood.status_timer.initWithCallback(
-                { notify: function(timer) {
-                    var div = Bindwood.statusWindow.document.getElementById('status');
-                    var dots = div.innerHTML;
-                    div.innerHTML = dots + ".";
-                } }, 1000, Ci.nsITimer.TYPE_REPEATING_SLACK);
-            */
-            // Sync all existing records in Couch and local records
-            Bindwood.handleSubsequentClientFirstTimeSync();
-            // Ensure that all local records are pushed
-            should_only_push_latest = false;
-            break;
-        case 3: // Should this just be default?
-            // We have a last_seq, and the profile root exists. Ergo, we are
-            // a normally operating client. Proceed normally.
-
-            break;
-        default:
-            break;
-        }
-
-        Bindwood.noteStartTime('Generating the manifest');
-        Bindwood.generateManifest();
-        Bindwood.noteEndTime('Generating the manifest');
-        Bindwood.noteStartTime('Pushing records');
-        Bindwood.pushLatestRecords(should_only_push_latest);
-        Bindwood.noteEndTime('Pushing records');
-
-        try {
-            Bindwood.pullChanges();
-        } catch(e) {
-            Log.exception("Problem pulling changes!", e);
-        }
-    },
-
-    ensureDatabase: function() {
-        // This function will create the database if it does not
-        // exist, but we return a boolean representing whether or not
-        // the database existed prior.
-        try {
-            Bindwood.couch.createDb();
+        // If we were shut down while initialising CouchDB, just return.
+        if (!this.running)
+            return;
+        Log.debug("Setting up synchroniser.");
+        this.synchroniser = new Synchroniser(this.couch, this.currentProfile);
+        this.synchroniser.last_seq = this.getLastSequence();
+        Log.debug("Got our last known sequence number: " +
+                  this.synchroniser.last_seq);
+        this.synchroniser.init();
+
+        var repeater = {
+            notify: function(timer) {
+                Bindwood.synchroniser.sync();
+                Bindwood.setLastSequence(Bindwood.synchroniser.last_seq);
+                Log.debug(
+                    "Successful run, rescheduling ourself");
+            }
+        };
+        try {
+            repeater.notify(); // Prime the pump, then schedule us out.
         } catch (e) {
-            if (e.error != 'file_exists') {
-                Log.exception("Error creating database: ", e);
-                throw(e);
-            }
+            Log.exception("Problem synchronising bookmarks", e);
+            return;
         }
-    },
-
-    ensureViews: function() {
-        var view = {
-            _id: "_design/bookmarks",
-            views: {
-                profile: {
-                    map: "function(doc) { var scheme = doc.uri.split(':',1)[0]; var uri; if (scheme == 'http' || scheme == 'https') {uri = doc.uri.split('/')[2];if (uri.length < 30) { uri += '/' + doc.uri.split('/',4)[3].substr(0,30-uri.length) + '...';}} else {uri = scheme + ' URL';}if ((!(doc.application_annotations && doc.application_annotations['Ubuntu One'] && doc.application_annotations['Ubuntu One'].private_application_annotations && doc.application_annotations['Ubuntu One'].private_application_annotations.deleted)) && (doc.application_annotations.Firefox.profile)) {emit(doc.application_annotations.Firefox.profile, [doc.title, uri]);}}"
-                },
-                live_bookmarks: {
-                    map: "function(doc) { var scheme = doc.uri.split(':',1)[0]; var uri; if (scheme == 'http' || scheme == 'https') {uri = doc.uri.split('/')[2];if (uri.length < 30) { uri += '/' + doc.uri.split('/',4)[3].substr(0,30-uri.length) + '...';}} else {uri = scheme + ' URL';}if (!(doc.application_annotations && doc.application_annotations['Ubuntu One'] && doc.application_annotations['Ubuntu One'].private_application_annotations && doc.application_annotations['Ubuntu One'].private_application_annotations.deleted)) {emit(doc.title, uri);}}"
-                },
-                deleted_bookmarks: {
-                    map: "function(doc) { if (doc.application_annotations && doc.application_annotations['Ubuntu One'] && doc.application_annotations['Ubuntu One'].private_application_annotations && doc.application_annotations['Ubuntu One'].private_application_annotations.deleted) { emit (doc.title, doc.uri); } }"
-                }
-            }
-        };
-
+
+        // reschedule ourself
         try {
-            var doc = Bindwood.couch.open(view._id);
-            if (!doc) {
-                doc = view;
-            }
-            try {
-                Bindwood.couch.save(doc);
-            } catch(e) {
-                Log.exception("Problem saving view: ", e);
-            }
+            this.sync_timer.initWithCallback(
+                repeater, 30000, Ci.nsITimer.TYPE_REPEATING_SLACK);
         } catch(e) {
-            // some kind of error fetching the existing design doc
-            Log.exception("Problem checking for view: ", e);
-        }
-    },
-
-    ensureLocalScratchFolder: function() {
-        // Because records come from CouchDB without a parent field, until
-        // we get an updated folder record with a record situated properly
-        // in its children field, we need a place to temporarily store
-        // records from Couch. This is that place.
-        var folder = bookmarksService.unfiledBookmarksFolder;
-        var rootNode = Bindwood.getFolderRoot(folder);
-        rootNode.containerOpen = true;
-        for (var i=0; i<rootNode.childCount; i++) {
-            var node = rootNode.getChild(i);
-            if (node.title == 'Desktop Couch Scratch') {
-                rootNode.containerOpen = false;
-                return node.itemId;
-            }
-        }
-        rootNode.containerOpen = false;
-
-        var folderId = bookmarksService.createFolder(
-            folder, 'Desktop Couch Scratch', -1);
-        return folderId;
-    },
-
-    profileExists: function() {
-        // Check to see if the current profile's manifest exists in
-        // the database.
-        var root = Bindwood.couch.open('root_' + Bindwood.currentProfile);
-        if (root) {
-            return 2;
-        }
-        return 0;
+            Log.exception("Problem setting up repeater.", e);
+        }
     },
 
     migrateOlderBookmarkRecords: function() {
@@ -489,1051 +280,4 @@
             }
         }
     },
-
-    handleSubsequentClientFirstTimeSync: function() {
-        Log.debug(
-            "We're a subsequent client. Let's merge the remote and the local.");
-
-        // get the remote root from Couch.
-        var remote_root = Bindwood.couch.open(
-            'root_' + Bindwood.currentProfile);
-        var local_roots = [bookmarksService.toolbarFolder,
-                           bookmarksService.bookmarksMenuFolder,
-                           bookmarksService.unfiledBookmarksFolder];
-
-        var records_needing_pushing = [];
-
-        for (var i = 0; i < local_roots.length; i++) {
-            Bindwood.syncRemoteAndLocal(
-                remote_root.children[i],
-                local_roots[i],
-                records_needing_pushing);
-        }
-
-        for (var i = 0; i < records_needing_pushing.length; i++) {
-            try {
-                var response = Bindwood.couch.save(records_needing_pushing[i]);
-                // We can avoid having to process this revision when we
-                // pull it later
-                Bindwood.seen_revisions[response.rev] = true;
-            } catch(e) {
-                Log.exception(
-                    "Problem saving record to CouchDB; record is " +
-                        JSON.stringify(records_needing_pushing[i]) + ": ", e);
-            }
-        }
-    },
-
-    syncRemoteAndLocal: function(remote_folder, local_folder, accum) {
-        Log.debug(
-            "Syncing remote folder: " + remote_folder +
-            " to local folder: " + local_folder);
-        var local_needs_pushing = false;
-
-        // get the local folder's root, and open it for iteration
-        var local = Bindwood.getFolderRoot(local_folder);
-        local.containerOpen = true;
-
-        // walk the remote folder's children, and ask for each one:
-        var remote = Bindwood.couch.open(remote_folder);
-        var remote_children = remote.children;
-        Log.debug("Beginning to walk remote children");
-        for (var i = 0; i < remote_children.length; i++) {
-            Log.debug(
-                "Getting remote child: " + remote_children[i]);
-            var remote_child = Bindwood.couch.open(remote_children[i]);
-            var local_child;
-            var found_local = false;
-
-            Log.debug(
-                "Looking for record type: " + remote_child.record_type +
-                " identified by " + 
-                (remote_child.record_type != Bindwood.TYPE_SEPARATOR ?
-                 remote_child.title :
-                 "being a separator"));
-
-            // does my local toolbarFolder have this child anywhere in it?
-            for (var j = 0; j < local.childCount; j++) {
-                local_child = local.getChild(j);
-
-                // Check to see whether we're testing a separator (which
-                // has no title) or whether we're testing the same type
-                // and title
-                if (Bindwood.sameType(local_child, remote_child) &&
-                    (remote_child.record_type == Bindwood.TYPE_SEPARATOR ||
-                     Bindwood.sameTitle(local_child, remote_child))) {
-                    found_local = true;
-                    Log.debug("Found the record.");
-                    Bindwood.annotateItemWithUUID(
-                        local_child.itemId, remote_child._id);
-                    // If we're dealing with a folder, we'll process it
-                    // recursively, and the only other thing we'd impose
-                    // would be the title, which already matches..
-                    if (remote_child.record_type != Bindwood.TYPE_FOLDER) {
-                        Bindwood.processCouchRecord(remote_child, null, null);
-                    }
-                    if (i != j) {
-                        // If yes, but in a different location, move the
-                        // local to the proper index within the same
-                        // folder.
-                        Log.debug(
-                            "Moving local record to same index as remote.");
-                        Bindwood.makeLocalChangeOnly(
-                            function() {
-                                bookmarksService.moveItem(
-                                    local_child.itemId, local_folder, i);
-                            }
-                        );
-                        local_needs_pushing = true;
-                    }
-                }
-            }
-
-            if (!found_local) {
-                // Add the record locally, annotate it, and place it in
-                // the correct index.
-
-                // Add current local folder as one that needs to be
-                // pushed back (changing its children)
-
-                Log.debug(
-                    "Remote record doesn't exist here, recreating it in " +
-                    local_folder + " at index " + i + ".");
-                Bindwood.processCouchRecord(remote_child, local_folder, i);
-                local_needs_pushing = true;
-            }
-
-            // is the child a folder?
-            if (remote_child.record_type == Bindwood.TYPE_FOLDER) {
-                // Recurse into the function with remote id and local
-                // folder id
-                Bindwood.syncRemoteAndLocal(
-                    remote_child._id, local_child.itemId, accum);
-            }
-        }
-
-        local.containerOpen = false;
-
-        if (local_needs_pushing) {
-            accum.push(Bindwood.couchRecordForItemId(local_folder));
-        }
-    },
-
-    sameType: function(localNode, remoteDoc) {
-        switch(remoteDoc.record_type) {
-        case Bindwood.TYPE_BOOKMARK:
-            return PlacesUtils.nodeIsBookmark(localNode);
-        case Bindwood.TYPE_FEED:
-            return PlacesUtils.nodeIsLivemarkContainer(localNode);
-        case Bindwood.TYPE_FOLDER:
-            return PlacesUtils.nodeIsFolder(localNode);
-        case Bindwood.TYPE_SEPARATOR:
-            return PlacesUtils.nodeIsSeparator(localNode);
-        default:
-            return false;
-        }
-    },
-
-    sameTitle: function(localNode, remoteDoc) {
-        return localNode.title == remoteDoc.title;
-    },
-
-    // Looking up records locally
-    annotateItemWithUUID: function(itemId, seed_uuid) {
-        var uuid = (seed_uuid ?
-                    seed_uuid :
-                    uuidService.generateUUID().toString());
-        Log.debug("UUID We came up with: " + uuid);
-        Log.debug("Annotating the item now.");
-        annotationService.setItemAnnotation(
-            itemId,
-            Bindwood.annotationKey,
-            uuid,
-            0,
-            annotationService.EXPIRE_NEVER);
-        // Whenever we create a new UUID, stash it and the itemId in
-        // our local cache.
-        Bindwood.uuidItemIdMap[uuid] = itemId;
-        return uuid;
-    },
-
-    itemIdForUUID: function(uuid) {
-        // First, try to look it up in our local cache, barring that
-        // (which shouldn't happen), look it up slowly.
-        var itemId = Bindwood.uuidItemIdMap[uuid];
-
-        if (!itemId) {
-            var items = annotationService.getItemsWithAnnotation(
-                Bindwood.annotationKey, {});
-            var num_items = items.length;
-            Log.debug(
-                "Found " + num_items + " records with the annotation key");
-            for (var i = 0; i < items.length; i++) {
-                Log.debug("Item #" + i + ": ItemId: " + items[i]);
-                var anno = annotationService.getItemAnnotation(
-                    items[i], Bindwood.annotationKey);
-                Log.debug(
-                    "Annotation on " + items[i] + ": " + anno);
-                if (anno == uuid) {
-                    var itemId = items[i];
-                    Bindwood.uuidItemIdMap[uuid] = itemId;
-                    break;
-                }
-            }
-            if (!itemId) {
-                Log.debug(
-                    "XXX: Still haven't found the right itemId!");
-            }
-        }
-        return itemId;
-    },
-
-    uuidForItemId: function(itemId) {
-        // Try to look up the uuid, and failing that, assign a new one
-        // and return it.
-        var uuid;
-        try {
-            uuid = annotationService.getItemAnnotation(
-                itemId, Bindwood.annotationKey);
-            Bindwood.uuidItemIdMap[uuid] = itemId;
-        } catch(e) {
-            Log.exception(
-                "Couldn't find a UUID for itemId: " + itemId, e);
-            uuid = Bindwood.makeLocalChangeOnly(
-                function() { return Bindwood.annotateItemWithUUID(
-                                 itemId, null); } );
-        }
-
-        return uuid;
-    },
-
-    couchRecordForItemId: function(itemId) {
-        var uuid = Bindwood.uuidForItemId(itemId);
-        var profile = Bindwood.currentProfile;
-        var last_modified = bookmarksService.getItemLastModified(itemId);
-
-        var record = {
-            "_id": uuid,
-            record_type_version: Bindwood.SCHEMA_VERSION,
-            application_annotations: {
-                Firefox: {
-                    profile: profile,
-                    last_modified: last_modified
-                }
-            }
-        };
-
-        record = Bindwood.decorateRecordByType(record, itemId);
-
-        return record;
-    },
-
-    decorateRecordByType: function(record, itemId) {
-        var bs = bookmarksService;
-
-        switch(bs.getItemType(itemId)) {
-        case bs.TYPE_BOOKMARK:
-            record.title = bs.getItemTitle(itemId);
-            record.record_type = Bindwood.TYPE_BOOKMARK;
-            record.uri = bs.getBookmarkURI(itemId).spec;
-            break;
-        case bs.TYPE_FOLDER:
-            record.title = bs.getItemTitle(itemId);
-
-            // Firefox doesn't differentiate between regular folders
-            // and livemark folders. *sigh* So, we override it here
-            if (livemarkService.isLivemark(itemId)) {
-                record.record_type = Bindwood.TYPE_FEED;
-                record.site_uri = livemarkService.getSiteURI(itemId).spec;
-                record.feed_uri = livemarkService.getFeedURI(itemId).spec;
-            } else {
-                record.record_type = Bindwood.TYPE_FOLDER;
-                record.children = [];
-            }
-            break;
-        case bs.TYPE_SEPARATOR:
-            record.record_type = Bindwood.TYPE_SEPARATOR;
-            break;
-        default:
-            break;
-        }
-
-        return record;
-    },
-
-    makeLocalChangeOnly: function(func) {
-        Bindwood.push = 'DISABLED';
-        var results = func();
-        Bindwood.push = 'ENABLED';
-        return results;
-    },
-
-    // Back and forth
-    getFolderRoot: function(folder) {
-        var options = historyService.getNewQueryOptions();
-        var query = historyService.getNewQuery();
-        query.setFolders([folder], 1);
-        var result = historyService.executeQuery(query, options);
-        return result.root;
-    },
-
-    getUUIDsFromFolder: function(folder) {
-        var folderRoot = Bindwood.getFolderRoot(folder);
-        folderRoot.containerOpen = true;
-        var uuids = [];
-
-        for (var i=0; i<folderRoot.childCount; i++) {
-            var node = folderRoot.getChild(i);
-            uuids.push(Bindwood.uuidForItemId(node.itemId));
-        }
-
-        return uuids;
-    },
-
-    getRecordsFromFolder: function(folder) {
-        // Make a record for us, populating a children field with the
-        // _ids of all our children
-        var folderRoot = Bindwood.getFolderRoot(folder);
-        folderRoot.containerOpen = true;
-
-        var folder_record = Bindwood.couchRecordForItemId(folder);
-        Log.debug(
-            "Building up a record for " + folder_record.title);
-
-        for (var i=0; i<folderRoot.childCount; i++) {
-            var node = folderRoot.getChild(i);
-
-            var record = Bindwood.couchRecordForItemId(node.itemId);
-            folder_record.children.push(record._id);
-            Log.debug(
-                "Added child record " + (record.title || record.record_type));
-
-            // If node is a folder (but not a Livemark or Dynamic container),
-            // descend into it, looking for its contents
-            if (record.record_type == Bindwood.TYPE_FOLDER) {
-                Bindwood.getRecordsFromFolder(node.itemId)
-            } else {
-                Bindwood.records.push(record);
-            }
-        }
-        Log.debug(
-            "Done collecting children. Folder's children is now: " +
-            JSON.stringify(folder_record.children));
-        folderRoot.containerOpen = false;
-        Bindwood.records.push(folder_record);
-        return folder_record;
-    },
-
-    generateManifest: function() {
-        // Fill up the Bindwood.manifest and initial push lists
-        var primaryFolders = [bookmarksService.toolbarFolder,
-                              bookmarksService.bookmarksMenuFolder,
-                              bookmarksService.unfiledBookmarksFolder];
-
-        var profile_root = {
-            "_id": "root_" + Bindwood.currentProfile,
-            children: [],
-            application_annotations: {
-                Firefox: {
-                    profile: Bindwood.currentProfile,
-                    last_modified: 1
-                }
-            }
-        };
-
-        for (var i=0; i<primaryFolders.length; i++) {
-            var folder = primaryFolders[i];
-            var folder_record = Bindwood.getRecordsFromFolder(folder);
-
-            profile_root.children.push(folder_record._id);
-        }
-
-        Bindwood.records.push(profile_root);
-    },
-
-    sortByLastModDesc: function(a, b) {
-        var a_mod = a.application_annotations.Firefox.last_modified;
-        var b_mod = b.application_annotations.Firefox.last_modified;
-        return b_mod - a_mod; // descending
-    },
-
-    pushLatestRecords: function(only_latest) {
-        Bindwood.records.sort(Bindwood.sortByLastModDesc);
-        // Now that the record are all sorted descending by last
-        // mod time, we can check each in turn to see if its mod time
-        // is greater than our persisted mod time. Afterwards, we'll
-        // set our persisted latest mod time to be the first record's
-        // mod time.
-        var newest = Bindwood.records[0];
-        var newest_ff = newest.application_annotations.Firefox;
-        var new_latest_modified = newest_ff.last_modified;
-        for (var i = 0; i < Bindwood.records.length; i++) {
-            // find this record in CouchDB
-            var record = Bindwood.records[i];
-            var ff = record.application_annotations.Firefox;
-
-            if (only_latest &&
-                (ff.last_modified <= Bindwood.latest_modified)) {
-                Log.debug(
-                    "We've reached records we've already dealt with." +
-                        " Breaking out of the loop.");
-                Log.debug(
-                    "Record we've seen: " + record._id);
-                break;
-            }
-
-            var doc = Bindwood.couch.open(record._id);
-            if (!doc) {
-                // this record is not in CouchDB, so write it
-                try {
-                    var response = Bindwood.couch.save(record);
-                    // We can avoid having to process this revision when
-                    // we pull it later
-                    Bindwood.seen_revisions[response.rev] = true;
-                } catch(e) {
-                    Log.exception(
-                        "Problem saving record to CouchDB; record is " +
-                            JSON.stringify(record) + ": ", e);
-                }
-            } else {
-                // record is already in CouchDB, so do nothing
-                Log.debug(
-                    "This record (" + record._id +
-                    ") is already in Couch, skipping");
-            }
-        }
-        Bindwood.latest_modified = Bindwood.setLatestModified(
-            new_latest_modified);
-    },
-
-    pushFolderChildren: function(folder, children) {
-        var doc = Bindwood.couch.open(Bindwood.uuidForItemId(folder));
-        var new_children = children;
-        if (!new_children) {
-            new_children = Bindwood.getUUIDsFromFolder(folder);
-        }
-        doc.children = new_children;
-        var response = Bindwood.couch.save(doc);
-        Bindwood.seen_revisions[response.rev] = true;
-    },
-
-    pullChanges: function() {
-        var repeater = {
-            notify: function(timer) {
-                Bindwood.pullRecords();
-                Log.debug(
-                    "Successful run, rescheduling ourself");
-            }
-        };
-
-        repeater.notify(); // Prime the pump, then schedule us out.
-
-        // reschedule ourself
-        try {
-            Bindwood.pull_changes_timer.initWithCallback(
-                repeater, 30000, Ci.nsITimer.TYPE_REPEATING_SLACK);
-        } catch(e) {
-            Log.exception("Problem setting up repeater.", e);
-        }
-
-        /* Disabling pop-up window for the time being.
-
-        if (Bindwood.statusWindow) {
-            Bindwood.reportDoneInWindow();
-        }
-        */
-    },
-
-    reportDoneInWindow: function() {
-        Bindwood.status_timer.cancel();
-        var div = Bindwood.statusWindow.document.getElementById('status');
-        var dots = div.innerHTML;
-        div.innerHTML = (dots +
-            "<br/><br/> Finished, you can close this window and proceed.  " +
-            "Thanks for your patience.");
-    },
-
-    pullRecords: function() {
-        // Check to see if our prefsService has a preference set (I
-        // know, bad form) for last_seq, which would designate the
-        // last Couch sequence we've seen (this might be 0 if we've
-        // never synced before, in which case, we'd get all
-        // changes). Afterwards, set the last known sequence in
-        // prefs. Then, future polls will use last_seq as the start
-        // for finding changes.
-
-        // XXX: currently, we do a single changes pull. Eventually, if
-        // we need to use threads, we can do long polling in a
-        // background thread.
-
-        Bindwood.noteStartTime('Pulling records');
-        var results = {results: [], last_seq: 0};
-        try {
-            results = Bindwood.couch.changes(
-                {since: Bindwood.last_seq},
-                null
-            );
-        } catch(e) {
-            Log.exception(
-                "Problem long polling bookmarks from Couch: ", e);
-        }
-        var revisions = results.results;
-        for (var i = 0; i < revisions.length; i++) {
-            var rev = revisions[i];
-            var revno = rev.changes[0].rev;
-            var recordid = rev.id;
-
-            // Skip (for now) if we're dealing with a root folder or a
-            // design doc
-            if (recordid.indexOf('root_') === 0 ||
-                recordid.indexOf('_design') === 0) {
-                Log.debug(
-                    "Root profile or design doc, skipping...");
-                continue;
-            }
-
-            // Skip any revisions we've already seen (because we just
-            // put them there)
-            if (Bindwood.seen_revisions[revno]) {
-                Log.debug(
-                    "We've seen this revision (" + revno +
-                    ") before, when we created it.");
-                delete Bindwood.seen_revisions[revno];
-                continue;
-            }
-
-            var record = Bindwood.couch.open(recordid);
-
-            if (!Bindwood.recordInCurrentProfile(record)) {
-                Log.debug(
-                    "Record isn't in our current profile. Skipping...");
-                continue;
-            }
-
-            // Next, check to see if the record we've pulled down
-            // is flagged as deleted.  If so, we should make sure any
-            // local copy we have of this record has also been
-            // deleted.
-            if (Bindwood.isDeleted(record)) {
-                Bindwood.makeLocalChangeOnly(
-                    function() {
-                        Log.debug(
-                            "Record in Couch marked as deleted;" +
-                                " attempting to delete local copy.");
-                        Bindwood.deleteLocalRecord(record);
-                    });
-                // Don't bother continuing to process anything further in
-                // this revision
-                continue;
-            }
-
-            Bindwood.processCouchRecord(record, null, null);
-        }
-
-        Bindwood.last_seq = Bindwood.setLastSequence(results.last_seq);
-        Bindwood.noteEndTime('Pulling records');
-    },
-
-    recordInCurrentProfile: function(record) {
-        if (record.application_annotations &&
-            record.application_annotations.Firefox &&
-            record.application_annotations.Firefox.profile &&
-            record.application_annotations.Firefox.profile == Bindwood.currentProfile) {
-            return true;
-        }
-        return false;
-    },
-
-    isDeleted: function(record) {
-        if (record.application_annotations &&
-            record.application_annotations["Ubuntu One"] &&
-            record.application_annotations["Ubuntu One"].private_application_annotations &&
-            record.application_annotations["Ubuntu One"].private_application_annotations.deleted) {
-            return true;
-        }
-        return false;
-    },
-
-    deleteLocalRecord: function(record) {
-        // If we can't resolve the itemId, even by looking up URI,
-        // assume it's already gone.
-        var itemId = Bindwood.itemIdForUUID(record._id);
-        if (itemId) {
-            return bookmarksService.removeItem(itemId);
-        }
-    },
-
-    processCouchRecord: function(record, aParent, aIndex) {
-        var aParent = aParent ? aParent : Bindwood.scratch_folder;
-        var aIndex = aIndex ? aIndex : -1;
-
-        Log.debug(
-            "Processing Couch Record: " + record + " placing it in " +
-            aParent + " at location " + aIndex);
-
-        switch(record.record_type) {
-        case Bindwood.TYPE_BOOKMARK:
-            Bindwood.makeLocalChangeOnly(
-                function() {
-                    Bindwood.processCouchBookmarkRevision(
-                        record, aParent, aIndex);
-                });
-            break;
-        case Bindwood.TYPE_FOLDER:
-            Bindwood.makeLocalChangeOnly(
-                function() {
-                    Bindwood.processCouchFolderRevision(
-                        record, aParent, aIndex);
-                });
-            break;
-        case Bindwood.TYPE_FEED:
-            Bindwood.makeLocalChangeOnly(
-                function() {
-                    Bindwood.processCouchFeedRevision(
-                        record, aParent, aIndex);
-                });
-            break;
-        case Bindwood.TYPE_SEPARATOR:
-            Bindwood.makeLocalChangeOnly(
-                function() {
-                    Bindwood.processCouchSeparatorRevision(
-                        record, aParent, aIndex);
-                });
-            break;
-        default:
-            break;
-        }
-    },
-
-    processCouchBookmarkRevision: function(record, aParent, aIndex) {
-        // Could be an add or change revision. Delete was handled earlier.
-        // If it's an addition (we can't resolve its _id to be one of our
-        // itemIds), add it to the Desktop Couch folder in unfiled.
-        Log.debug(
-            "Processing bookmark record: " + JSON.stringify(record));
-        var itemId = Bindwood.itemIdForUUID(record._id);
-        if (itemId) {
-            // It's a change. Stamp everything remote on the local bookmark
-            bookmarksService.setItemTitle(itemId, record.title);
-            bookmarksService.changeBookmarkURI(itemId,
-                ioService.newURI(record.uri, null, null));
-        } else {
-            // It's an addition. Add a new bookmark to our scratch folder,
-            // annotate it, and we're done.
-            itemId = bookmarksService.insertBookmark(
-                aParent,
-                ioService.newURI(record.uri, null, null),
-                aIndex,
-                record.title);
-            Bindwood.annotateItemWithUUID(itemId, record._id);
-        }
-    },
-
-    processCouchFolderRevision: function(record, aParent, aIndex) {
-        // Could be an add or change revision. Delete was handled
-        // earlier.  If it's an addition (we can't resolve its _id to be
-        // one of our itemIds), add it to the Desktop Couch folder in
-        // unfiled.
-        Log.debug(
-            "Processing folder record: " + JSON.stringify(record));
-        var itemId = Bindwood.itemIdForUUID(record._id);
-        if (itemId) {
-            // It's a change. Stamp remote title on the folder, and deal
-            // with any changed children.
-            Bindwood.noteStartTime('Shuffling folder children');
-            bookmarksService.setItemTitle(itemId, record.title);
-            // Iterate through our current folder children, and compare
-            // with remote.  Move all local children to the scratch
-            // folder, then move them back in the order of the remote
-            // children.
-            var local_children = Bindwood.getUUIDsFromFolder(itemId);
-            Log.debug(
-                "Moving local children " + JSON.stringify(local_children) +
-                " to scratch folder");
-            for (var i = 0; i<local_children.length; i++) {
-                var child = local_children[i];
-                // XXX: Probably needs to be made more robust
-                var child_itemId = Bindwood.itemIdForUUID(child);
-                try {
-                    bookmarksService.moveItem(
-                        child_itemId, Bindwood.scratch_folder, -1);
-                } catch(e) {
-                    Log.exception(
-                        "Problem moving item to scratch folder: " +
-                        JSON.stringify(e), e);
-                }
-            }
-            Log.debug(
-                "Moving children identified by record " +
-                JSON.stringify(record.children) + " to this folder");
-            for (var j = 0; j<record.children.length; j++) {
-                var new_child = record.children[j];
-                // XXX: Probably needs to be made more robust
-                var new_child_itemId = Bindwood.itemIdForUUID(new_child);
-                try {
-                    bookmarksService.moveItem(new_child_itemId, itemId, -1);
-                } catch(e) {
-                    Log.exception(
-                        "Problem moving item from scratch folder: " +
-                        JSON.stringify(e), e);
-                }
-            }
-            Bindwood.noteEndTime('Shuffling folder children');
-        } else {
-            // It's an addition. Add a new bookmark to our scratch folder,
-            // annotate it, and we're done.
-            itemId = bookmarksService.createFolder(
-                aParent,
-                record.title,
-                aIndex);
-            Bindwood.annotateItemWithUUID(itemId, record._id);
-        }
-    },
-
-    processCouchFeedRevision: function(record, aParent, aIndex) {
-        // Could be an add or change revision. Delete was handled
-        // earlier.  If it's an addition (we can't resolve its _id to be
-        // one of our itemIds), add it to the Desktop Couch folder in
-        // unfiled.
-        Log.debug(
-            "Processing feed record: " + JSON.stringify(record));
-        var itemId = Bindwood.itemIdForUUID(record._id);
-        if (itemId) {
-            // It's a change. Stamp everything remote on the local bookmark
-            bookmarksService.setItemTitle(itemId, record.title);
-            livemarkService.setSiteURI(itemId,
-                ioService.newURI(record.site_uri, null, null));
-            livemarkService.setFeedURI(itemId,
-                ioService.newURI(record.feed_uri, null, null));
-        } else {
-            // It's an addition. Add a new bookmark to our scratch folder,
-            // annotate it, and we're done.
-            var newItemId = livemarkService.createLivemark(
-                aParent,
-                record.title,
-                ioService.newURI(record.site_uri, null, null),
-                ioService.newURI(record.feed_uri, null, null),
-                aIndex);
-            Bindwood.annotateItemWithUUID(newItemId, record._id);
-        }
-    },
-
-    processCouchSeparatorRevision: function(record, aParent, aIndex) {
-        // Should only be an add revision. There's nothing to change, and
-        // delete was handled earlier.  If it's an addition (we can't
-        // resolve its _id to be one of our itemIds), add it to the
-        // Desktop Couch folder in unfiled.
-        Log.debug(
-            "Processing separator record: " + JSON.stringify(record));
-        var itemId = Bindwood.itemIdForUUID(record._id);
-        if (!itemId) {
-            // There's nothing to change about a separator, so...
-            // It's an addition. Add a new bookmark to our scratch folder,
-            // annotate it, and we're done.
-            var newItemId = bookmarksService.insertSeparator(
-                aParent,
-                aIndex);
-            Bindwood.annotateItemWithUUID(newItemId, record._id);
-        }
-    },
-
-    updateDocAndSave: function(uuid, attribute, value, callback) {
-        Log.debug(
-            "Updating a document (" +
-                uuid +
-                ") setting (" +
-                attribute +
-                ") to (" + value + ")");
-
-        // Some attributes that we track should remain inside the
-        // application_annotations object
-        var attrMap = {
-             title: true,
-             uri: true,
-             feed_uri: true,
-             site_uri: true,
-             children: true,
-             favicon: false,
-             profile: false };
-
-        var doc = Bindwood.couch.open(uuid);
-        if (attrMap[attribute.toString()] || false) { // belongs at top-level
-            doc[attribute.toString()] = value.toString();
-        } else {
-            if (!doc.application_annotations) {
-                doc.application_annotations = {};
-            }
-            if (!doc.application_annotations.Firefox) {
-                doc.application_annotations.Firefox = {};
-            }
-            doc.application_annotations.Firefox[attribute.toString()] = value.toString();
-        }
-        try {
-            var response = Bindwood.couch.save(doc);
-            Bindwood.seen_revisions[response.rev] = true;
-        } catch(e) {
-            Log.exception("Problem saving document to Couch", e);
-            throw e;
-        }
-
-        if (callback) {
-            callback();
-        }
-
-        return response;
-    },
-
-    itemWeCareAbout: function(itemId) {
-        // Traverse from the itemId up its parent chain. If at any
-        // level the parent is a livemark container or a dynamic
-        // container, return false, otherwise, return true.
-        var root = 0;
-        var parent;
-        while (parent != root) {
-            Log.debug("Looking for parent of " + itemId);
-            parent = bookmarksService.getFolderIdForItem(itemId);
-            if (parent != root &&
-                annotationService.itemHasAnnotation(
-                    parent, 'livemark/feedURI')) {
-                return false;
-            }
-            itemId = parent;
-        }
-        return true;
-    },
-};
-
-var BindwoodBookmarkObserver = function(bindwood) {
-    this.bw = bindwood;
-};
-BindwoodBookmarkObserver.prototype = {
-    // Query Interface
-    QueryInterface: function(iid) {
-        if (iid.equals(Ci.nsINavBookmarkObserver) ||
-            iid.equals(Ci.nsINavBookmarkObserver_MOZILLA_1_9_1_ADDITIONS) ||
-            iid.equals(Ci.nsISupports)) {
-            return this;
-        }
-        throw Cr.NS_ERROR_NO_INTERFACE;
-    },
-
-    // An nsINavBookmarkObserver
-    onItemAdded: function(aItemId, aFolder, aIndex) {
-        Log.debug("onItemAdded: called when push is " + this.bw.push);
-        // An item has been added, so we create a blank entry
-        // in Couch with our local itemId attached.
-        if (!this.bw.itemWeCareAbout(aItemId)) {
-            Log.debug("Ignoring this add event");
-            return;
-        }
-
-        Log.debug(
-            "A new item was created. Its id is: " + aItemId +
-            " at location: " + aIndex +
-            " in folder: " + aFolder );
-
-        switch (this.bw.push) {
-        case 'DISABLED':
-            Log.debug("Added, but not saving to Couch.");
-            break;
-        case 'ENABLED':
-            try {
-                var doc = this.bw.couchRecordForItemId(aItemId);
-                var response = this.bw.couch.save(doc);
-                Log.debug("Saved new, bare record to Couch.");
-                this.bw.seen_revisions[response.rev] = true;
-                this.bw.pushFolderChildren(aFolder);
-            } catch(e) {
-                Log.exception(
-                    "Problem saving new bookmark to Couch: ", e);
-            }
-            break;
-        default:
-            break;
-        }
-
-        this.bw.setLatestModified(
-            bookmarksService.getItemLastModified(aItemId));
-    },
-
-    onBeforeItemRemoved: function(aItemId) {
-        Log.debug(
-            "onBeforeItemRemoved: called when push is " + this.bw.push);
-        // A bookmark has been removed. This is called before it's
-        // been removed locally, though we're passed the itemId,
-        // which we use to delete from Couch.
-        var folderId = bookmarksService.getFolderIdForItem(aItemId);
-        if (!this.bw.itemWeCareAbout(aItemId)) {
-            Log.debug("Ignoring this before remove event");
-            return;
-        }
-
-        Log.debug(
-            "Record " + aItemId + " is about to be removed locally.");
-        var uuid = this.bw.uuidForItemId(aItemId);
-
-        switch (this.bw.push) {
-        case 'DISABLED':
-            delete this.bw.uuidItemIdMap[uuid];
-            Log.debug(
-                "Deleted from local uuid map, but not saving back to Couch.");
-            break;
-
-        case 'ENABLED':
-            var doc = this.bw.couch.open(uuid);
-            if (!doc.application_annotations) {
-                doc.application_annotations = {};
-            }
-            if (!doc.application_annotations['Ubuntu One']) {
-                doc.application_annotations['Ubuntu One'] = {};
-            }
-            if (!doc.application_annotations['Ubuntu One'].private_application_annotations) {
-                doc.application_annotations['Ubuntu One'].private_application_annotations = {};
-            }
-            doc.application_annotations['Ubuntu One'].private_application_annotations.deleted = true;
-
-            try {
-                // Also remove from our local cache and remove
-                // annotation from service.
-                var response = this.bw.couch.save(doc);
-                this.bw.seen_revisions[response.rev] = true;
-                delete this.bw.uuidItemIdMap[uuid];
-                Log.debug(
-                    "Deleted local reference in the" +
-                    " uuid-itemId mapping.");
-                Log.debug(
-                    "Saved document back to Couch with deleted flag set.");
-                var new_children = this.bw.getUUIDsFromFolder(folderId);
-                new_children.splice(new_children.indexOf(uuid), 1);
-                this.bw.pushFolderChildren(folderId, new_children);
-            } catch(e) {
-                Log.exception(
-                    "Problem pushing deleted record to Couch: ", e);
-            }
-            break;
-        default:
-            break;
-        }
-    },
-
-    onItemRemoved: function(aItemId, aFolder, aIndex) {
-        Log.debug(
-            "onItemRemoved: called when push is " + this,bw.push);
-        // This only happens locally, so there's never a need to push
-        if (!this.bw.itemWeCareAbout(aItemId)) {
-            Log.debug("Ignoring this remove event");
-            return;
-        }
-
-        this.bw.makeLocalChangeOnly(
-            function() {
-                return annotationService.removeItemAnnotation(
-                    aItemId, this.bw.annotationKey); });
-        Log.debug(
-            "Removed annotations from bookmark identified by: " + aItemId);
-    },
-
-    onItemChanged: function(aItemId, aProperty, aIsAnnotationProperty, aValue) {
-        Log.debug(
-            "onItemChanged: called when push is " + this.bw.push);
-        // A property of a bookmark has changed. On multiple
-        // property updates, this will be called multiple times,
-        // once per property (i.e., for title and URI)
-        if (!this.bw.itemWeCareAbout(aItemId)) {
-            Log.debug("Ignoring this change event");
-            return;
-        }
-
-        Log.debug(
-            "A property (" +
-            aProperty +
-            ") on item id: " + aItemId +
-            " has been set to: " + aValue);
-        var uuid = this.bw.uuidForItemId(aItemId);
-
-        switch (this.bw.push) {
-        case 'DISABLED':
-            Log.debug(
-                "Updated, but not saving back to Couch.");
-            break;
-        case 'ENABLED':
-            Log.debug(
-                "We will push this change back to Couch.");
-            try {
-                var result = Bindwood.updateDocAndSave(
-                    uuid, aProperty.toString(), aValue.toString(),
-                    function() {
-                        Log.debug(
-                            "Saved the document back to Couch");
-                    });
-            } catch(e) {
-                Log.exception(
-                    "Problem saving updated bookmark to Couch: ", e);
-            }
-            break;
-        default:
-            break;
-        }
-
-        this.bw.setLatestModified(
-            bookmarksService.getItemLastModified(aItemId));
-    },
-
-    onItemMoved: function(aItemId, aOldParent, aOldIndex, aNewParent, aNewIndex) {
-        Log.debug(
-            "onItemMoved: called when push is " + this.bw.push);
-        Log.debug(
-            "The item: " + aItemId + " was moved from (" +
-            aOldParent + ", " + aOldIndex +
-            ") to (" + aNewParent + ", " + aNewIndex + ")"
-        );
-        switch (this.bw.push) {
-        case 'DISABLED':
-            Log.debug(
-                "Moved, but not saving back to Couch.");
-            break;
-        case 'ENABLED':
-            var uuid = this.bw.uuidForItemId(aItemId);
-            var old_parent_uuid = this.bw.uuidForItemId(aOldParent);
-            var old_parent_doc = this.bw.couch.open(old_parent_uuid);
-            old_parent_doc.children = this.bw.getUUIDsFromFolder(
-                aOldParent);
-            try {
-                var response = this.bw.couch.save(old_parent_doc);
-                this.bw.seen_revisions[response.rev] = true;
-            } catch(e) {
-                Log.exception(
-                    "Problem saving updated old parent doc to Couch: ", e);
-            }
-            if (aOldParent != aNewParent) {
-                var new_parent_uuid = this.bw.uuidForItemId(aNewParent);
-                var new_parent_doc = this.bw.couch.open(new_parent_uuid);
-                new_parent_doc.children = this.bw.getUUIDsFromFolder(
-                    aNewParent);
-                try {
-                    var response = this.bw.couch.save(new_parent_doc);
-                    this.bw.seen_revisions[response.rev] = true;
-                } catch(e) {
-                    Log.exception(
-                        "Problem saving updated new parent doc to Couch: ",
-                        e);
-                }
-            }
-            break;
-        default:
-            break;
-        }
-
-        // Set the latest modified to the greatest of aItemId,
-        // aOldParent, or aNewParent's last_modified
-        this.bw.setLatestModified(
-            [bookmarksService.getItemLastModified(aItemId),
-             bookmarksService.getItemLastModified(aOldParent),
-             bookmarksService.getItemLastModified(aNewParent)].sort()[2]);
-    },
-
-    // Currently unhandled
-    onBeginUpdateBatch: function() {},
-    onEndUpdateBatch: function() {},
-    onItemVisited: function(aBookmarkId, aVisitID, time) {},
 };

=== modified file 'modules/sync.jsm'
--- modules/sync.jsm	2011-03-01 10:47:38 +0000
+++ modules/sync.jsm	2011-03-01 10:47:38 +0000
@@ -60,6 +60,7 @@
 Synchroniser.prototype = {
     init: function() {
         Log.debug("Initialising synchroniser.");
+        this.ensureDatabase();
         this.ensureCouchViews();
         this.first_push = true;
         this.observer = new BookmarksObserver(this);
@@ -74,6 +75,20 @@
         }
     },
 
+    ensureDatabase: function() {
+        // This function will create the database if it does not
+        // exist, but we return a boolean representing whether or not
+        // the database existed prior.
+        try {
+            this.couch.createDb();
+        } catch (e) {
+            if (e.error != 'file_exists') {
+                Log.exception("Error creating database: ", e);
+                throw(e);
+            }
+        }
+    },
+
     ensureCouchViews: function() {
         var design_doc_id = "_design/bindwood", doc;
 

=== removed file 'mozmill/tests/test_addbookmark.js'
--- mozmill/tests/test_addbookmark.js	2011-02-22 10:56:32 +0000
+++ mozmill/tests/test_addbookmark.js	1970-01-01 00:00:00 +0000
@@ -1,42 +0,0 @@
-var bm = require("../shared-modules/bookmarks");
-
-const TIMEOUT = 5000;
-
-const LOCAL_TEST_FOLDER = collector.addHttpResource('../test-files/');
-const LOCAL_TEST_PAGE = LOCAL_TEST_FOLDER + 'test.html';
-
-var setupModule = function(module) {
-    module.controller = mozmill.getBrowserController();
-    module.bindwood = {}
-    module.jum = {}
-    Components.utils.import("resource://bindwood/bindwood.jsm", module.bindwood);
-    Components.utils.import("resource://mozmill/modules/jum.js", module.jum);
-    module.bm.clearBookmarks();
-};
-
-var teardownModule = function(module) {
-    module.bm.clearBookmarks();
-};
-
-// XXX: Test disabled until new sync code is in place.
-var __testAddBookmark = function() {
-    var uri = bm.createURI(LOCAL_TEST_PAGE);
-    jum.assertEquals(bm.bookmarksService.isBookmarked(uri), false)
-
-    var bookmark_id = bm.bookmarksService.insertBookmark(
-        bm.bookmarksService.toolbarFolder,
-        uri,
-        bm.bookmarksService.DEFAULT_INDEX,
-        "Bookmark title");
-
-    var uuid = bindwood.Bindwood.uuidForItemId(bookmark_id);
-    var record;
-    controller.waitFor(function() {
-        record = bindwood.Bindwood.couch.open(uuid);
-        return record != null;
-    }, "Bookmark synchronised", TIMEOUT);
-    jum.assertEquals(record.uri, uri.spec);
-    jum.assertEquals(record.title, "Bookmark title");
-    jum.assertEquals(record.record_type, bindwood.Bindwood.TYPE_BOOKMARK);
-    jum.assertEquals(record.record_type_version, bindwood.Bindwood.SCHEMA_VERSION);
-};

=== added file 'mozmill/tests/test_bindwood.js'
--- mozmill/tests/test_bindwood.js	1970-01-01 00:00:00 +0000
+++ mozmill/tests/test_bindwood.js	2011-03-01 10:47:38 +0000
@@ -0,0 +1,71 @@
+var bm = require("../shared-modules/bookmarks");
+
+const TIMEOUT = 5000;
+
+const LOCAL_TEST_FOLDER = collector.addHttpResource('../test-files/');
+const LOCAL_TEST_PAGE = LOCAL_TEST_FOLDER + 'test.html';
+const LOCAL_TEST_FEED = LOCAL_TEST_FOLDER + 'feed.atom';
+
+var setupModule = function(module) {
+    module.controller = mozmill.getBrowserController();
+    module.jum = {};
+    module.desktopcouch = {};
+    module.bindwood = {};
+    Cu.import("resource://mozmill/modules/jum.js", module.jum);
+    Cu.import("resource://bindwood/desktopcouch.jsm", module.desktopcouch);
+    Cu.import("resource://bindwood/bindwood.jsm", module.bindwood);
+    bm.clearBookmarks();
+    module.couch = null;
+    module.synchroniser = null;
+};
+
+
+var setupTest = function(test) {
+    var done = false;
+    desktopcouch.connect_desktopcouch("test_bookmarks", function(db) {
+            couch = db;
+            done = true;
+        }, function (message) {});
+    controller.waitFor(
+        function() { return done; }, "Could not connect to CouchDB", TIMEOUT);
+    jum.assertNotEquals(couch, null);
+
+    try {
+        couch.createDb();
+    } catch (e) {
+        if (e.error != 'file_exists')
+            throw(e);
+    }
+};
+
+
+var teardownTest = function(test) {
+    //bindwood.Bindwood.uninit();
+    bm.clearBookmarks();
+    couch.deleteDb();
+};
+
+var test_bindwood_init = function() {
+    bindwood.Bindwood.init();
+    controller.waitFor(function() {
+            return bindwood.Bindwood.synchroniser != null;
+    }, "Bindwood did not initialise", TIMEOUT);
+
+    // XXX: this check causes mozmill to crash.  Possibly when it
+    //tries to serialise the synchroniser?
+    //jum.assertNotEquals(bindwood.Bindwood.synchroniser, null);
+
+    // The synchronisation timer has been initialised.
+    jum.assertNotNull(bindwood.Bindwood.sync_timer.callback);
+};
+
+var test_bindwood_uninit = function() {
+    bindwood.Bindwood.init();
+    controller.waitFor(function() {
+            return bindwood.Bindwood.synchroniser != null;
+    }, "Bindwood did not initialise", TIMEOUT);
+    bindwood.Bindwood.uninit();
+
+    jum.assertNull(bindwood.Bindwood.sync_timer.callback);
+    jum.assertNull(bindwood.Bindwood.synchroniser);
+}