Merge lp:~urbanape/bindwood/xpi-refinement into lp:~urbanape/bindwood/trunk

[Zachery Bir]

[Zachery Bir (urbanape)]

Added back some debug information and moved the dbus.sh script out to top-level.

One of the things lp:~sil and I talked about was setting some sort of flag to spilling the beans in debugging. Now that we're moving towards a Makefile approach, I think it might be nice to be able to specify a debug build that includes all the messages, and leave them all in the code.

[Elliot Murphy (statik)]

this looks ready to merge to trunk.

review: Approve

[Rick McBride (rmcbride)]

Very cool stuff

review: Approve

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2009-07-14 14:09:22 +0000
@@ -0,0 +1,1 @@
+bindwood.xpi

=== added file 'README'
--- README	1970-01-01 00:00:00 +0000
+++ README	2009-07-14 14:09:22 +0000
@@ -0,0 +1,7 @@
+This is a Firefox extension that syncs bookmarks with a desktop CouchDB instance.
+To build it, run ./build.sh.
+
+The project home page is https://launchpad.net/bindwood.
+To submit patches, please make a branch on launchpad and 'propose for merging'.
+You can discuss this extension on the [e-mail]
+mailing list.

=== added file 'build.sh'
--- build.sh	1970-01-01 00:00:00 +0000
+++ build.sh	2009-07-14 14:09:22 +0000
@@ -0,0 +1,128 @@
+#!/bin/bash
+# build.sh -- builds JAR and XPI files for mozilla extensions
+#   by Nickolay Ponomarev <[e-mail]>
+#   (original version based on Nathan Yergler's build script)
+# Most recent version is at <http://kb.mozillazine.org/Bash_build_script>
+
+# This script assumes the following directory structure:
+# ./
+#   chrome.manifest (optional - for newer extensions)
+#   install.rdf
+#   (other files listed in $ROOT_FILES)
+#
+#   content/    |
+#   locale/     |} these can be named arbitrary and listed in $CHROME_PROVIDERS
+#   skin/       |
+#
+#   defaults/   |
+#   components/ |} these must be listed in $ROOT_DIRS in order to be packaged
+#   ...         |
+#
+# It uses a temporary directory ./build when building; don't use that!
+# Script's output is:
+# ./$APP_NAME.xpi
+# ./$APP_NAME.jar  (only if $KEEP_JAR=1)
+# ./files -- the list of packaged files
+#
+# Note: It modifies chrome.manifest when packaging so that it points to 
+#       chrome/$APP_NAME.jar!/*
+
+#
+# default configuration file is ./config_build.sh, unless another file is 
+# specified in command-line. Available config variables:
+APP_NAME=          # short-name, jar and xpi files name. Must be lowercase with no spaces
+CHROME_PROVIDERS=  # which chrome providers we have (space-separated list)
+CLEAN_UP=          # delete the jar / "files" when done?       (1/0)
+ROOT_FILES=        # put these files in root of xpi (space separated list of leaf filenames)
+ROOT_DIRS=         # ...and these directories       (space separated list)
+BEFORE_BUILD=      # run this before building       (bash command)
+AFTER_BUILD=       # ...and this after the build    (bash command)
+
+if [ -z $1 ]; then
+  . ./config_build.sh
+else
+  . $1
+fi
+
+if [ -z $APP_NAME ]; then
+  echo "You need to create build config file first!"
+  echo "Read comments at the beginning of this script for more info."
+  exit;
+fi
+
+ROOT_DIR=`pwd`
+TMP_DIR=build
+
+#uncomment to debug
+#set -x
+
+# remove any left-over files from previous build
+rm -f $APP_NAME.jar $APP_NAME.xpi files
+rm -rf $TMP_DIR
+
+$BEFORE_BUILD
+
+mkdir --parents --verbose $TMP_DIR/chrome
+
+# generate the JAR file, excluding CVS and temporary files
+JAR_FILE=$TMP_DIR/chrome/$APP_NAME.jar
+echo "Generating $JAR_FILE..."
+for CHROME_SUBDIR in $CHROME_PROVIDERS; do
+  find $CHROME_SUBDIR -path '*CVS*' -prune -o -type f -print | grep -v \~ >> files
+done
+
+zip -0 -r $JAR_FILE `cat files`
+# The following statement should be used instead if you don't wish to use the JAR file
+#cp --verbose --parents `cat files` $TMP_DIR/chrome
+
+# prepare components and defaults
+echo "Copying various files to $TMP_DIR folder..."
+for DIR in $ROOT_DIRS; do
+  mkdir $TMP_DIR/$DIR
+  FILES="`find $DIR -path '*CVS*' -prune -o -type f -print | grep -v \~`"
+  echo $FILES >> files
+  cp --verbose --parents $FILES $TMP_DIR
+done
+
+# Copy other files to the root of future XPI.
+for ROOT_FILE in $ROOT_FILES install.rdf chrome.manifest; do
+  cp --verbose $ROOT_FILE $TMP_DIR
+  if [ -f $ROOT_FILE ]; then
+    echo $ROOT_FILE >> files
+  fi
+done
+
+cd $TMP_DIR
+
+if [ -f "chrome.manifest" ]; then
+  echo "Preprocessing chrome.manifest..."
+  # You think this is scary?
+  #s/^(content\s+\S*\s+)(\S*\/)$/\1jar:chrome\/$APP_NAME\.jar!\/\2/
+  #s/^(skin|locale)(\s+\S*\s+\S*\s+)(.*\/)$/\1\2jar:chrome\/$APP_NAME\.jar!\/\3/
+  #
+  # Then try this! (Same, but with characters escaped for bash :)
+  sed -i -r s/^\(content\\s+\\S*\\s+\)\(\\S*\\/\)$/\\1jar:chrome\\/$APP_NAME\\.jar!\\/\\2/ chrome.manifest
+  sed -i -r s/^\(skin\|locale\)\(\\s+\\S*\\s+\\S*\\s+\)\(.*\\/\)$/\\1\\2jar:chrome\\/$APP_NAME\\.jar!\\/\\3/ chrome.manifest
+
+  # (it simply adds jar:chrome/whatever.jar!/ at appropriate positions of chrome.manifest)
+fi
+
+# generate the XPI file
+echo "Generating $APP_NAME.xpi..."
+zip -r ../$APP_NAME.xpi *
+
+cd "$ROOT_DIR"
+
+echo "Cleanup..."
+if [ $CLEAN_UP = 0 ]; then
+  # save the jar file
+  mv $TMP_DIR/chrome/$APP_NAME.jar .
+else
+  rm ./files
+fi
+
+# remove the working files
+rm -rf $TMP_DIR
+echo "Done!"
+
+$AFTER_BUILD

=== removed directory 'chrome'
=== modified file 'chrome.manifest'
--- chrome.manifest	2009-07-02 13:41:07 +0000
+++ chrome.manifest	2009-07-14 14:09:22 +0000
@@ -1,3 +1,3 @@
-content bindwood chrome/content/
-locale  bindwood en     chrome/locale/en/
+content bindwood content/
+locale  bindwood en     locale/en/
 overlay chrome://browser/content/browser.xul    chrome://bindwood/content/browserOverlay.xul

=== added file 'config_build.sh'
--- config_build.sh	1970-01-01 00:00:00 +0000
+++ config_build.sh	2009-07-14 19:27:48 +0000
@@ -0,0 +1,9 @@
+#!/bin/bash
+# Build config for build.sh
+APP_NAME=bindwood
+CHROME_PROVIDERS="content locale"
+CLEAN_UP=1
+ROOT_FILES="dbus.sh"
+ROOT_DIRS="defaults"
+BEFORE_BUILD=
+AFTER_BUILD=

=== renamed directory 'chrome/content' => 'content'
=== modified file 'content/sync.js'
--- chrome/content/sync.js	2009-07-09 13:32:21 +0000
+++ content/sync.js	2009-07-14 19:27:48 +0000
@@ -20,8 +20,8 @@
         return Bindwood.uuidService.generateUUID().toString();
     },
 
-    annotateItemWithUUID: function(itemId) {
-        var uuid = Bindwood.generateUUIDString();
+    annotateItemWithUUID: function(itemId, uuid) {
+        var uuid = uuid ? uuid : Bindwood.generateUUIDString();
         Bindwood.annotationService.setItemAnnotation(itemId, Bindwood.annotationKey, uuid, 0, Bindwood.annotationService.EXPIRE_NEVER);
         // Whenever we create a new UUID, stash it and the itemId in
         // our local cache.
@@ -55,7 +55,7 @@
             uuid = Bindwood.annotationService.getItemAnnotation(itemId, Bindwood.annotationKey);
             found = true;
         } catch(e) {
-            uuid = Bindwood.annotateItemWithUUID(itemId);
+            uuid = Bindwood.annotateItemWithUUID(itemId, null);
         }
 
         return uuid;
@@ -80,6 +80,7 @@
         if(Components.classes["@mozilla.org/appshell/window-mediator;1"]
            .getService(Components.interfaces.nsIWindowMediator)
            .getEnumerator("").getNext() == window) {
+           Bindwood.writeMessage("Getting a Couch Port");
             Bindwood.getCouchPortNumber(Bindwood.startProcess);
         }
     },
@@ -105,8 +106,8 @@
         var MY_ID = "[e-mail]";
         var em = Components.classes["@mozilla.org/extensions/manager;1"].
             getService(Components.interfaces.nsIExtensionManager);
-        var dbus_script = em.getInstallLocation(MY_ID).getItemFile(MY_ID,
-            "chrome/content/dbus.sh");
+        var dbus_script = em.getInstallLocation(MY_ID).getItemFile(MY_ID, "dbus.sh");
+        Bindwood.writeMessage("Found path to dbus_script: " + dbus_script.path);
         // create an nsILocalFile for the executable
         var nsifile = Components.classes["@mozilla.org/file/local;1"]
                      .createInstance(Components.interfaces.nsILocalFile);
@@ -312,7 +313,7 @@
                 }
             });
         } catch(e) {
-            Bindwood.writeError("Problem fetching all bookmarks from Couch:", e);
+            Bindwood.writeError("Problem fetching all bookmarks from Couch: ", e);
         }
         for (var i = 0; i < rows.rows.length; i++) {
             var recordid = rows.rows[i].id;
@@ -322,8 +323,9 @@
                 bm.application_annotations.Firefox.uuid) {
                 // this bookmark has a uuid, so check its values haven't changed
                 // find the bookmark with this uuid
-                var itemId = Bindwood.itemIdForUUID(
-                    bm.application_annotations.Firefox.uuid);
+                var couch_uuid = bm.application_annotations.Firefox.uuid;
+                Bindwood.writeMessage("Row uuid: " + couch_uuid);
+                var itemId = Bindwood.itemIdForUUID(couch_uuid);
                 if (!itemId) {
                     // This bookmark has a uuid, but it's not one of ours.
                     // We need to work out whether (a) it's the same as one
@@ -331,67 +333,101 @@
                     //   make the uuids the same), or (b) it's a new one
                     //   that happens to have been created on a different
                     //   machine.
-                    // For the moment, punt on this.
+                    try {
+                        var uri = Bindwood.ioService.newURI(bm.uri, null, null);
+                    } catch(e) {
+                        Bindwood.writeError("Problem creating URI (" + bm.uri + ") for bookmark: ", e);
+                        continue;
+                    }
+                    var ids = Bindwood.bookmarksService.getBookmarkIdsForURI(uri, {});
+                    if (ids.length > 1) {
+                        // punt for now, too many problems.
+                    } else if (ids.length) {
+                        // Found one local bookmark. Replace its uuid to
+                        // be the one from Couch.
+                        var itemId = ids[0];
+                        var old_uuid = Bindwood.uuidForItemId(itemId);
+                        delete Bindwood.uuidItemIdMap[old_uuid];
+                        Bindwood.annotateItemWithUUID(itemId, couch_uuid);
+                    } else {
+                        /// No local bookmarks
+                        Bindwood.addLocalBookmark(bm, recordid, couch_uuid);
+                    }
                 } else {
-                    var title = Bindwood.bookmarksService.getItemTitle(itemId);
-                    var metadata = Bindwood.bookmarksService.getBookmarkURI(itemId);
-                    if (title != bm.title) {
-                        Bindwood.bookmarksService.setItemTitle(itemId, bm.title);
-                    }
-                    if (metadata.spec != bm.uri) {
-                        try {
-                            metadata = Bindwood.ioService.newURI(bm.uri, null, null);
-                        } catch(e) {
-                            Bindwood.writeError("Problem creating a new URI for bookmark", e);
-                        }
-                        Bindwood.bookmarksService.changeBookmarkURI(itemId, metadata);
+                    if (bm.deleted) {
+                        // This bookmark exists on Couch, but has been
+                        // flagged for deletion by another Client. We
+                        // want to respect that, and delete it
+                        // locally.
+                        Bindwood.bookmarksService.removeItem(itemId);
+                    } else {
+                        var title = Bindwood.bookmarksService.getItemTitle(itemId);
+                        var metadata = Bindwood.bookmarksService.getBookmarkURI(itemId);
+                        if (title != bm.title) {
+                            Bindwood.bookmarksService.setItemTitle(itemId, bm.title);
+                        }
+                        if (metadata.spec != bm.uri) {
+                            try {
+                                metadata = Bindwood.ioService.newURI(bm.uri, null, null);
+                                Bindwood.bookmarksService.changeBookmarkURI(itemId, metadata);
+                            } catch(e) {
+                                Bindwood.writeError("Problem creating a new URI for bookmark: ", e);
+                            }
+                        }
                     }
                 }
             } else {
-                // this bookmark has no uuid, so create it from fresh in Firefox
-                var list;
-                if (bm.application_annotations &&
-                    bm.application_annotations.Firefox &&
-                    bm.application_annotations.Firefox.list) {
-                    switch (bm.application_annotations.Firefox.list) {
-                        case "toolbarFolder":
-                            list = Bindwood.bookmarksService.toolbarFolder;
-                            break;
-                        case "bookmarksMenuFolder":
-                            list = Bindwood.bookmarksService.bookmarksMenuFolder;
-                            break;
-                        default:
-                            list = Bindwood.bookmarksService.toolbarFolder;
-                            break;
-                    }
-                } else {
-                    list = Bindwood.bookmarksService.toolbarFolder;
-                }
-                var metadata = Bindwood.ioService.newURI(bm.uri, null, null);
-
-                var itemId = Bindwood.bookmarksService.insertBookmark(list,
-                    metadata, -1, bm.title);
-                // and then write the new uuid back to the record
-                var uuid = Bindwood.uuidForItemId(itemId);
-                var doc = couch.open(recordid);
-                if (!doc.application_annotations) {
-                    doc.application_annotations = {};
-                }
-                if (!doc.application_annotations.Firefox) {
-                    doc.application_annotations.Firefox = {};
-                }
-                doc.application_annotations.Firefox.uuid = uuid;
-                try {
-                    couch.save(doc);
-                } catch(e) {
-                    Bindwood.writeError("Problem writing record for new bookmark: ",e);
-                }
+                // This bookmark has no uuid, so create it from fresh
+                // in Firefox. Passing in null to addLocalBookmar will
+                // generate a new uuid.
+                Bindwood.addLocalBookmark(bm, recordid, null);
             }
         }
         // reschedule ourself
         setTimeout(Bindwood.pullBookmarks, 30000);
     },
 
+    addLocalBookmark: function(bm, recordid, uuid) {
+        var couch = new CouchDB('bookmarks');
+        var list;
+        if (bm.application_annotations &&
+            bm.application_annotations.Firefox &&
+            bm.application_annotations.Firefox.list) {
+            switch (bm.application_annotations.Firefox.list) {
+            case "toolbarFolder":
+                list = Bindwood.bookmarksService.toolbarFolder;
+                break;
+            case "bookmarksMenuFolder":
+                list = Bindwood.bookmarksService.bookmarksMenuFolder;
+                break;
+            default:
+                list = Bindwood.bookmarksService.toolbarFolder;
+                break;
+            }
+        } else {
+            list = Bindwood.bookmarksService.toolbarFolder;
+        }
+        var metadata = Bindwood.ioService.newURI(bm.uri, null, null);
+
+        var itemId = Bindwood.bookmarksService.insertBookmark(list,
+            metadata, -1, bm.title);
+        // and then write the new uuid back to the record
+        var uuid = uuid ? uuid : Bindwood.uuidForItemId(itemId);
+        var doc = couch.open(recordid);
+        if (!doc.application_annotations) {
+            doc.application_annotations = {};
+        }
+        if (!doc.application_annotations.Firefox) {
+            doc.application_annotations.Firefox = {};
+        }
+        doc.application_annotations.Firefox.uuid = uuid;
+        try {
+            couch.save(doc);
+        } catch(e) {
+            Bindwood.writeError("Problem writing record for new bookmark: ",e);
+        }
+    },
+
     Observer: {
         // An nsINavBookmarkObserver
         onItemAdded: function(aItemId, aFolder, aIndex) {
@@ -429,7 +465,7 @@
             try {
                 var result = couch.save(doc);
             } catch(e) {
-                Bindwood.writeError("Problem saving new bookmark to Couch", e);
+                Bindwood.writeError("Problem saving new bookmark to Couch: ", e);
             }
         },
         onBeforeItemRemoved: function(aItemId) {
@@ -458,14 +494,17 @@
             }
 
             var doc = couch.open(results.rows[0].id);
+            // Update the doc in Couch to inform other clients that it
+            // should be deleted locally.
+            doc.deleted = true;
 
             try {
-                var result = couch.deleteDoc(doc);
+                var result = couch.save(doc);
                 // Also remove from our local cache and remove
                 // annotation from service.
                 delete Bindwood.uuidItemIdMap[uuid];
             } catch(e) {
-                Bindwood.writeError("Problem deleting record from Couch", e);
+                Bindwood.writeError("Problem pushing deleted record to Couch: ", e);
             }
         },
         onItemRemoved: function(aItemId, aFolder, aIndex) {
@@ -502,7 +541,7 @@
             try {
                 var result = couch.save(doc);
             } catch(e) {
-                Bindwood.writeError("Problem saving updated bookmark to Couch", e);
+                Bindwood.writeError("Problem saving updated bookmark to Couch: ", e);
             }
         },
 

=== renamed file 'chrome/content/dbus.sh' => 'dbus.sh'
=== modified file 'install.rdf'
--- install.rdf	2009-07-06 20:00:16 +0000
+++ install.rdf	2009-07-14 19:27:48 +0000
@@ -12,8 +12,8 @@
     <em:targetApplication>
       <Description>
         <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
-        <em:minVersion>3.0</em:minVersion>
-        <em:maxVersion>3.*</em:maxVersion>
+        <em:minVersion>3.5</em:minVersion>
+        <em:maxVersion>3.5.*</em:maxVersion>
       </Description>
     </em:targetApplication>
 
@@ -21,6 +21,6 @@
     <em:name>Bindwood</em:name>
     <em:description>An extension to synchronize your bookmarks to a local CouchDB.</em:description>
     <em:creator>Zachery Bir</em:creator>
-    <em:homepageURL>http://launchpad.net/bindwood</em:homepageURL>
+    <em:homepageURL>https://launchpad.net/bindwood</em:homepageURL>
   </Description>
 </RDF>

=== renamed directory 'chrome/locale' => 'locale'