Merge lp:~urbanape/bindwood/work-with-folders into lp:bindwood

[Zachery Bir]

[Zachery Bir (urbanape)]

Summary: Handle bookmarks per-profile, sync sub-folders, and
provide additional views in Couch.

  Branches represented in this merge proposal
  ===========================================

  deleted-view:

    Provide a deleted objects view, so when all client machines
    have synced deletions, the owner can purge them from Couch.

    Also, filter them out of the regular view.

  handle-all-profiles:

    Properly sync whichever profile is currently being used.

    We tag each bookmark as belonging to the current profile, and
    we use the current profile as a filter when pulling
    bookmarks.

    To test, you'll need this Bindwood branch installed on at
    least two profiles. If you need a second profile, you can run
    the Profile Manager from the command line:

      $ firefox --profilemanager

    Re-create the <email address hidden> extension file in
    ~/.mozilla/firefox/<new profile directory>/extensions/ with
    the following contents (note no trailing slash):

      /path/to/bindwood/checkout

    If you start up Firefox using your new profile:

      $ firefox -P newprofilename &

    And navigate to your CouchDB, you should see the combined
    bookmarks of all profiles. However, if you look at any
    individual bookmark, in its `application_annotations` object,
    you'll see it tied to a specific profile. Similarly, Bindwood
    will only pull that profile's bookmarks, so no cross-profile
    pollution should happen.

  work-with-folders:

    This branch ensures that all bookmarks are synced. Previous
    branches only dealt with immediate children of the three main
    bookmark folders: toolbarFolder, bookmarksMenuFolder, and
    unfiledBookmarksFolder. This branch recursively descends into
    any subfolders located here, syncing any bookmarks it finds.

    To test, create a profile without Bindwood installed, and
    create arbitrarily nested folders in any of these bookmark
    folders. When Bindwood is enabled, you should see all
    bookmarks throughout the hierarchy represented in
    Couch. Previous versions of Bindwood would only sync the
    immediate child bookmarks of the top folder.

Testing strategies
==================

  * If you have any deleted bookmarks, you'll be able to select
    the 'deleted' view in Couch to see them, separate from your
    live bookmarks.

  * If you use multiple profiles, you'll be able to sync each of
    them, without collisions between profiles. There are
    additional views registered for each profile that will show
    you only the bookmarks per profile.

  * If you have sub-folders of any of the three main
    folders (toolbarFolder, bookmarksMenuFolder, and
    unfiledBookmarksFolder), those will also be synced to Couch.

[Zachery Bir (urbanape)]

> * If you use multiple profiles, you'll be able to sync each of
> them, without collisions between profiles. There are
> additional views registered for each profile that will show
> you only the bookmarks per profile.

Actually, this last part is a lie. I was manually creating these views.
They'll show up automatically in a later branch.

[Zachery Bir (urbanape)]

> > * If you use multiple profiles, you'll be able to sync each of
> > them, without collisions between profiles. There are
> > additional views registered for each profile that will show
> > you only the bookmarks per profile.
>
> Actually, this last part is a lie. I was manually creating these views.
> They'll show up automatically in a later branch.

Actually this last part is a lie, and the first part is the truth. I've just pushed the requisite bits that create per-profile views, so the user has something a little more in-line with their expectations.

[lp:~urbanape/bindwood/work-with-folders]

31. By Zachery Bir on 2009-09-18

Create per-profile views with just that profile's bookmarks, and rename the default two

32. By Zachery Bir on 2009-09-22

s/itemId/aItemId/ and take an anti-stupid pill for next time

Unmerged revisions

=== modified file 'content/sync.js'
--- content/sync.js	2009-09-15 17:35:12 +0000
+++ content/sync.js	2009-09-18 16:16:41 +0000
@@ -30,8 +30,8 @@
         .getService(Ci.nsIIOService),
     envService: Cc["@mozilla.org/process/environment;1"]
         .getService(Ci.nsIEnvironment),
-    profileService: Cc["@mozilla.org/toolkit/profile-service;1"]
-        .getService(Ci.nsIToolkitProfileService),
+    directoryService: Cc["@mozilla.org/file/directory_service;1"]
+        .getService(Ci.nsIProperties),
     windowService: Cc["@mozilla.org/appshell/window-mediator;1"]
         .getService(Ci.nsIWindowMediator),
 
@@ -52,20 +52,37 @@
         Bindwood.consoleService.logStringMessage("Bindwood: " + aMessage + " message: '" + e.message + "', reason: '" + e.reason + "', description: '" + e.description + "', error: '" + e.error + "'");
     },
 
+    extractProfileName: function(path) {
+        // We want the last part of the profile path
+        // ('default' for '/home/zbir/.mozilla/firefox/ixlw0nvl.default')
+        // For profiles that have not been created via the Profile Manager,
+        // we just take the last path segment as the profile name.
+        //
+        // Actually, there's a degenerate case, where the last segment
+        // doesn't have the Firefox-provided random string:
+        //   '/home/zbir/canonical.com' => 'com'
+        // But as I said, this is maybe degenerate.
+
+        var segments = path.split('/');
+        var possible_profile = segments[segments.length - 1];
+        var first_period = possible_profile.indexOf('.');
+        if (first_period == -1) {
+            return possible_profile; // no periods in the last segment, return as is
+        } else {
+            return possible_profile.substr(first_period + 1);
+        }
+    },
+
     // Setup the environment and go
     init: function() {
         // Start the process and de-register ourself
         // 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.
 
-        Bindwood.currentProfile = Bindwood.profileService.selectedProfile.name;
+        Bindwood.currentProfile = Bindwood.extractProfileName(Bindwood.directoryService.get('ProfD', Ci.nsIFile).path);
 
-        if (Bindwood.currentProfile == 'default') { // We only currently operate on the 'default' profile
-            if(Bindwood.windowService.getEnumerator("").getNext() == window) {
-                Bindwood.getCouchEnvironment(Bindwood.startProcess);
-            }
-        } else {
-            Bindwood.writeError("Bindwood currently only supports the default profile.", undefined);
+        if(Bindwood.windowService.getEnumerator("").getNext() == window) {
+            Bindwood.getCouchEnvironment(Bindwood.startProcess);
         }
     },
 
@@ -178,48 +195,65 @@
         } catch(e) {
             Bindwood.writeError("Error when calling pushBookmarks: ", e);
         }
-        Bindwood.createView();
+        Bindwood.createViews();
         Bindwood.pullBookmarks();
     },
 
-    createView: function() {
-        var DDID = "_design/views";
-        var current_doc;
-        try {
-            current_doc = Bindwood.couch.open(DDID);
-            if (current_doc !== null) {
-                Bindwood.writeMessage("View already exists; leaving it alone");
-            } else {
-                new_doc = {
-                    _id: DDID,
-                    views: {
-                        display: {
-                         map: "function(doc) { " +
+    createViews: function() {
+        var views = [{ id: "_design/views",
+                       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) + '...';" +
-                             "}" +
+                               "uri = doc.uri.split('/')[2];" +
+                               "if (uri.length < 30) {" +
+                                   " uri += '/' + " +
+                                       "doc.uri.split('/',4)[3].substr(0,30-uri.length) + '...';" +
+                               "}" +
                            "} else {" +
-                           "uri = scheme + ' URL';" +
-                           "}" +
-                           "emit(doc.title, uri);" +
-                         "}"
-                       }
-                    }
-                };
-                try {
-                    Bindwood.couch.save(new_doc);
-                } catch(e) {
-                    Bindwood.writeError("Problem saving view: ", e);
-                }
+                               "uri = scheme + ' URL';" +
+                           "}" +
+                           "if (!doc.deleted) {" +
+                               "emit(doc.title, uri);" +
+                           "}" +
+                        "}" },
+                     { id: "_design/deleted",
+                       map: "function(doc) { if (doc.deleted) { emit (doc.title, doc.uri); } }" }];
+        for (var i = 0; i < views.length; i++) {
+            var view_info = views[i];
+            var dirty = false;
+            try {
+                var new_doc;
+                var current_doc = Bindwood.couch.open(view_info.id);
+                if (current_doc !== null) {
+                    var old_map = current_doc.views.display.map;
+                    if (old_map != view_info.map) { // Ours is definitive
+                        new_doc = current_doc;
+                        new_doc.views.display.map = view_info.map;
+                        dirty = true;
+                    }
+                } else {
+                    new_doc = {
+                        _id: view_info.id,
+                        views: {
+                            display: {
+                                map: view_info.map
+                            }
+                        }
+                    };
+                    dirty = true;
+                }
+                if (dirty) {
+                    try {
+                        Bindwood.couch.save(new_doc);
+                    } catch(e) {
+                        Bindwood.writeError("Problem saving view: ", e);
+                    }
+                }
+            } catch(e) {
+                // some kind of error fetching the existing design doc
+                Bindwood.writeError("Problem checking for view: ", e);
             }
-        } catch(e) {
-            // some kind of error fetching the existing design doc
-            Bindwood.writeError("Problem checking for view: ", e);
         }
     },
 
@@ -316,21 +350,13 @@
     couchReadyObjectForNodeInBookmarksFolder: function(node, bookmarksFolderName) {
         var itemId = node.itemId;
 
-        var title = node.title;
-        Bindwood.writeMessage("Title: " + title);
-        var uri = node.uri;
-        Bindwood.writeMessage("URI: " + uri);
+        var title = Bindwood.bookmarksService.getItemTitle(itemId);
         var uuid = Bindwood.uuidForItemId(itemId);
-        Bindwood.writeMessage("UUID: " + uuid);
         var folder = bookmarksFolderName;
-        Bindwood.writeMessage("Folder: " + folder);
         var profile = Bindwood.currentProfile;
-        Bindwood.writeMessage("Profile: " + profile);
 
         var bookmark = {
             title: title,
-            uri: uri,
-            record_type: null,
             application_annotations: {
                 Firefox: {
                     uuid: uuid,
@@ -343,6 +369,7 @@
         switch(Bindwood.bookmarksService.getItemType(itemId)) {
         case Bindwood.bookmarksService.TYPE_BOOKMARK:
             bookmark.record_type = "http://www.freedesktop.org/wiki/Specifications/desktopcouch/bookmark";
+            bookmark.uri = Bindwood.bookmarksService.getBookmarkURI(itemId).spec;
             break;
         case Bindwood.bookmarksService.TYPE_FOLDER:
             bookmark.record_type = "http://www.freedesktop.org/wiki/Specifications/desktopcouch/folder";
@@ -384,58 +411,50 @@
         }
 
         try {
-            Bindwood.pushBookmarksFromFolder("toolbarFolder");
+            Bindwood.pushBookmarksFromFolder("toolbarFolder", Bindwood.bookmarksService.toolbarFolder);
         } catch(e) {
             Bindwood.writeError("Error pushing toolbarFolder bookmarks: ", e);
         }
 
         try {
-            Bindwood.pushBookmarksFromFolder("bookmarksMenuFolder");
+            Bindwood.pushBookmarksFromFolder("bookmarksMenuFolder", Bindwood.bookmarksService.bookmarksMenuFolder);
         } catch(e) {
             Bindwood.writeError("Error pushing bookmarksMenuFolder bookmarks: ", e);
         }
 
         try {
-            Bindwood.pushBookmarksFromFolder("unfiledBookmarksFolder");
+            Bindwood.pushBookmarksFromFolder("unfiledBookmarksFolder", Bindwood.bookmarksService.unfiledBookmarksFolder);
         } catch(e) {
             Bindwood.writeError("Error pushing unfiledBookmarksFolder bookmarks: ", e);
         }
     },
 
-    getBookmarksFromFolder: function(bookmarksFolderName) {
+    getBookmarksFromFolder: function(bookmarksFolderName, bookmarksFolder, accum) {
         Bindwood.writeMessage("Fetching bookmarks from: " + bookmarksFolderName);
-        var retval = [];
-        var bookmarksFolder;
         var options = Bindwood.historyService.getNewQueryOptions();
         var query = Bindwood.historyService.getNewQuery();
-        switch (bookmarksFolderName) {
-        case "toolbarFolder":
-            bookmarksFolder = Bindwood.bookmarksService.toolbarFolder;
-            break;
-        case "bookmarksMenuFolder":
-            bookmarksFolder = Bindwood.bookmarksService.bookmarksMenuFolder;
-            break;
-        case "unfiledBookmarksFolder":
-            bookmarksFolder = Bindwood.bookmarksService.unfiledBookmarksFolder;
-            break;
-        default:
-            break;
-        }
         query.setFolders([bookmarksFolder], 1);
         var result = Bindwood.historyService.executeQuery(query, options);
         var rootNode = result.root;
         rootNode.containerOpen = true;
         for (var i=0; i<rootNode.childCount; i++) {
             var node = rootNode.getChild(i);
-            retval.push([node.itemId, Bindwood.couchReadyObjectForNodeInBookmarksFolder(node, bookmarksFolderName)]);
+            // If node is a folder, descend into it, looking for its contents
+            if (node.type == 6) { // RESULT_TYPE_FOLDER
+                Bindwood.writeMessage("Descending into folder: " + node.title);
+                accum = accum.concat(Bindwood.getBookmarksFromFolder(node.title, node.itemId, accum));
+            } else if (node.type == 0 || node.type == 7) { // RESULT_TYPE_URI or RESULT_TYPE_SEPARATOR
+                Bindwood.writeMessage("Adding current node: " + node.title);
+                accum.push([node.itemId, Bindwood.couchReadyObjectForNodeInBookmarksFolder(node, bookmarksFolderName)]);
+            }
         }
         rootNode.containerOpen = false;
-        return retval;
+        return accum;
     },
 
-    pushBookmarksFromFolder: function(bookmarksFolderName) {
+    pushBookmarksFromFolder: function(bookmarksFolderName, bookmarksFolder) {
         Bindwood.writeMessage("Pushing bookmarks from " + bookmarksFolderName);
-        var bookmarkData = Bindwood.getBookmarksFromFolder(bookmarksFolderName);
+        var bookmarkData = Bindwood.getBookmarksFromFolder(bookmarksFolderName, bookmarksFolder, new Array());
         for (var i = 0; i < bookmarkData.length; i++) {
             // find this bookmark in CouchDB
             var itemId = bookmarkData[i][0];
@@ -483,7 +502,11 @@
         // include the literal value
         try {
             var rows = Bindwood.couch.query(function (doc) {
-                if (doc.record_type == "http://www.freedesktop.org/wiki/Specifications/desktopcouch/bookmark") {
+                                                if (doc.record_type == "http://www.freedesktop.org/wiki/Specifications/desktopcouch/bookmark" &&
+                                                    doc.application_annotations &&
+                                                    doc.application_annotations.Firefox &&
+                                                    doc.application_annotations.Firefox.profile &&
+                                                    doc.application_annotations.Firefox.profile == Bindwood.currentProfile) {
                     emit(doc._id,doc);
                 }
                                    });