Add 'ddocs.py' generation on setup.py.

4 files changed, 40 insertions, 146 deletions

diff --git a/common/src/leap/soledad/common/.gitignore b/common/src/leap/soledad/common/.gitignore
new file mode 100644
index 00000000..3378c78a
--- /dev/null
+++ b/common/src/leap/soledad/common/.gitignore
@@ -0,0 +1 @@
+ddocs.py
diff --git a/common/src/leap/soledad/common/couch.py b/common/src/leap/soledad/common/couch.py
index b9e699f3..d2414477 100644
--- a/common/src/leap/soledad/common/couch.py
+++ b/common/src/leap/soledad/common/couch.py
@@ -34,9 +34,8 @@ from u1db.remote import http_app
 from u1db.remote.server_state import ServerState
 
 
-from leap.soledad.common import USER_DB_PREFIX
+from leap.soledad.common import USER_DB_PREFIX, ddocs
 from leap.soledad.common.document import SoledadDocument
-from leap.soledad.common.ddocs import ensure_ddocs_on_db
 
 
 logger = logging.getLogger(__name__)
@@ -187,7 +186,7 @@ class CouchDatabase(CommonBackend):
         return cls(url, dbname)
 
     def __init__(self, url, dbname, replica_uid=None, full_commit=True,
-                 session=None, ensure_ddocs=False):
+                 session=None, ensure_ddocs=True):
         """
         Create a new Couch data container.
 
@@ -220,9 +219,27 @@ class CouchDatabase(CommonBackend):
         except ResourceNotFound:
             self._server.create(self._dbname)
             self._database = self._server[self._dbname]
-        self._set_replica_uid(replica_uid or uuid.uuid4().hex)
+        if replica_uid is not None:
+            self._set_replica_uid(replica_uid)
         if ensure_ddocs:
-            ensure_ddocs_on_db(self._database)
+            self.ensure_ddocs_on_db()
+
+    def ensure_ddocs_on_db(self):
+        """
+        Ensure that the design documents used by the backend exist on the
+        couch database.
+        """
+        # we check for existence of one of the files, and put all of them if
+        # that one does not exist
+        try:
+            self._database['_design/docs']
+            return
+        except ResourceNotFound:
+            for ddoc_name in ['docs', 'syncs', 'transactions']:
+                ddoc = json.loads(
+                    binascii.a2b_base64(
+                        getattr(ddocs, ddoc_name)))
+                self._database.save(ddoc)
 
     def get_sync_target(self):
         """
@@ -261,9 +278,11 @@ class CouchDatabase(CommonBackend):
         :type replica_uid: str
         """
         try:
+            # set on existent config document
             doc = self._database['u1db_config']
             doc['replica_uid'] = replica_uid
         except ResourceNotFound:
+            # or create the config document
             doc = {
                 '_id': 'u1db_config',
                 'replica_uid': replica_uid,
@@ -280,9 +299,16 @@ class CouchDatabase(CommonBackend):
         """
         if self._real_replica_uid is not None:
             return self._real_replica_uid
-        doc = self._database['u1db_config']
-        self._real_replica_uid = doc['replica_uid']
-        return self._real_replica_uid
+        try:
+            # grab replica_uid from server
+            doc = self._database['u1db_config']
+            self._real_replica_uid = doc['replica_uid']
+            return self._real_replica_uid
+        except ResourceNotFound:
+            # create a unique replica_uid
+            self._real_replica_uid = uuid.uuid4().hex
+            self._set_replica_uid(self._real_replica_uid)
+            return self._real_replica_uid
 
     _replica_uid = property(_get_replica_uid, _set_replica_uid)
 
diff --git a/common/src/leap/soledad/common/ddocs/README.txt b/common/src/leap/soledad/common/ddocs/README.txt
index 37d89fbf..5569d929 100644
--- a/common/src/leap/soledad/common/ddocs/README.txt
+++ b/common/src/leap/soledad/common/ddocs/README.txt
@@ -1,3 +1,8 @@
+This directory holds a folder structure containing javascript files that
+represent the design documents needed by the CouchDB U1DB backend. These files
+are compiled into the `../ddocs.py` file by setuptools when creating the
+source distribution.
+
 The following table depicts the U1DB CouchDB backend method and the URI that
 is queried to obtain/update data from/to the server.
 
diff --git a/common/src/leap/soledad/common/ddocs/__init__.py b/common/src/leap/soledad/common/ddocs/__init__.py
deleted file mode 100644
index 389bdff9..00000000
--- a/common/src/leap/soledad/common/ddocs/__init__.py
+++ /dev/null
@@ -1,138 +0,0 @@
-# -*- coding: utf-8 -*-
-# __init__.py
-# Copyright (C) 2013 LEAP
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-
-"""
-CouchDB U1DB backend design documents helper.
-"""
-
-
-from os import listdir
-from os.path import realpath, dirname, isdir, join, isfile, basename
-import json
-import logging
-
-
-from couchdb import Document as CouchDocument
-
-
-logger = logging.getLogger(__name__)
-
-
-# where to search for design docs definitions
-prefix = dirname(realpath(__file__))
-
-
-def ensure_ddocs_on_db(db, prefix=prefix):
-    """
-    Ensure that the design documents in C{db} contain.
-
-    :param db: The database in which to create/update the design docs.
-    :type db: couchdb.client.Server
-    :param prefix: Where to look for design documents definitions.
-    :type prefix: str
-    """
-    ddocs = build_ddocs(prefix)
-    for ddoc_name, ddoc_content in ddocs.iteritems():
-        ddoc_id = "_design/%s" % ddoc_name
-        ddoc = CouchDocument({'_id': ddoc_id})
-        ddoc.update(ddoc_content)
-        # ensure revision if ddoc is already in db
-        doc = db.get(ddoc_id)
-        if doc is not None:
-            ddoc['_rev'] = doc.rev
-        db.save(ddoc)
-
-
-def create_local_ddocs(prefix=prefix):
-    """
-    Create local design docs based on content from subdirectories in
-    C{prefix}.
-
-    :param create_local: Whether to create local .json files.
-    :type create_local: bool
-    """
-    ddocs = build_ddocs(prefix)
-    for ddoc_name, ddoc_content in ddocs.iteritems():
-        with open(join(prefix, '%s.json' % ddoc_name), 'w') as f:
-            f.write(json.dumps(ddoc_content, indent=4))
-
-
-def build_ddocs(prefix=prefix):
-    """
-    Build design documents based on content from subdirectories in
-    C{prefix}.
-
-    :param prefix: Where to look for design documents definitions.
-    :type prefix: str
-
-    :return: A dictionary containing the design docs definitions.
-    :rtype: dict
-    """
-    ddocs = {}
-    # design docs are represented by subdirectories in current directory
-    for ddoc in [f for f in listdir(prefix) if isdir(join(prefix, f))]:
-        logger.debug("Building %s.json ..." % ddoc)
-
-        ddocs[ddoc] = {}
-
-        for t in ['views', 'lists', 'updates']:
-            tdir = join(prefix, ddoc, t)
-            if not isdir(tdir):
-                logger.debug("  - no %s" % t)
-            else:
-
-                ddocs[ddoc][t] = {}
-
-                if t == 'views':  # handle views (with map/reduce functions)
-                    for view in [f for f in listdir(tdir) \
-                            if isdir(join(tdir, f))]:
-                        logger.debug("  - view: %s" % view)
-                        # look for map.js and reduce.js
-                        mapfile = join(tdir, view, 'map.js')
-                        reducefile = join(tdir, view, 'reduce.js')
-                        mapfun = None
-                        reducefun = None
-                        try:
-                            with open(mapfile) as f:
-                                mapfun = f.read()
-                        except IOError:
-                            pass
-                        try:
-                            with open(reducefile) as f:
-                                reducefun = f.read()
-                        except IOError:
-                            pass
-                        ddocs[ddoc]['views'][view] = {}
-
-                        if mapfun is not None:
-                            ddocs[ddoc]['views'][view]['map'] = mapfun
-                        if reducefun is not None:
-                            ddocs[ddoc]['views'][view]['reduce'] = reducefun
-
-                else:  # handle lists, updates, etc
-                    for fun in [f for f in listdir(tdir) \
-                            if isfile(join(tdir, f))]:
-                        logger.debug("  - %s: %s" % (t, fun))
-                        funfile = join(tdir, fun)
-                        funname = basename(funfile).replace('.js', '')
-                        try:
-                            with open(funfile) as f:
-                                ddocs[ddoc][t][funname] = f.read()
-                        except IOError:
-                            pass
-    return ddocs