Added darcs support.

I don't know much darcs, so I make no claims about the beauty of my
implementation.  It seems to get the job done though, until a darcs
guru comes along.

I also tweaked the libbe.git.Git._rcs_get_user_id to handle the case
where user.name or user.email are not set.

I also added the option to pass a stdin string into the
libbe.rcs.RCS._u_invoke* functions.

5 files changed, 208 insertions, 26 deletions

diff --git a/libbe/bugdir.py b/libbe/bugdir.py
index 3c2c247..3ad5824 100644
--- a/libbe/bugdir.py
+++ b/libbe/bugdir.py
@@ -181,7 +181,7 @@ that the Arch RCS backend *enforces* ids with this format.""",
 settings easy.  Don't set this attribute.  Set .rcs instead, and
 .rcs_name will be automatically adjusted.""",
                          default="None",
-                         allowed=["None", "Arch", "bzr", "git", "hg"])
+                         allowed=["None", "Arch", "bzr", "darcs", "git", "hg"])
     def rcs_name(): return {}
 
     def _get_rcs(self, rcs_name=None):
diff --git a/libbe/darcs.py b/libbe/darcs.py
new file mode 100644
index 0000000..a3b52b6
--- /dev/null
+++ b/libbe/darcs.py
@@ -0,0 +1,164 @@
+# Copyright (C) 2007 Chris Ball <chris@printf.net>,
+#               2009 W. Trevor King <wking@drexel.edu>
+#
+#    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 2 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, write to the Free Software
+#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+import codecs
+import os
+import re
+import sys
+import unittest
+import doctest
+
+import rcs
+from rcs import RCS
+
+def new():
+    return Darcs()
+
+class Darcs(RCS):
+    name="darcs"
+    client="darcs"
+    versioned=True
+    def _rcs_help(self):
+        status,output,error = self._u_invoke_client("--help")
+        return output
+    def _rcs_detect(self, path):
+        if self._u_search_parent_directories(path, "_darcs") != None :
+            return True
+        return False 
+    def _rcs_root(self, path):
+        """Find the root of the deepest repository containing path."""
+        # Assume that nothing funny is going on; in particular, that we aren't
+        # dealing with a bare repo.
+        if os.path.isdir(path) != True:
+            path = os.path.dirname(path)
+        darcs_dir = self._u_search_parent_directories(path, "_darcs")
+        if darcs_dir == None:
+            return None
+        return os.path.dirname(darcs_dir)
+    def _rcs_init(self, path):
+        self._u_invoke_client("init", directory=path)
+    def _rcs_get_user_id(self):
+        # following http://darcs.net/manual/node4.html#SECTION00410030000000000000
+        # as of June 29th, 2009
+        if self.rootdir == None:
+            return None
+        darcs_dir = os.path.join(self.rootdir, "_darcs")
+        if darcs_dir != None:
+            for pref_file in ["author", "email"]:
+                pref_path = os.path.join(darcs_dir, "prefs", pref_file)
+                if os.path.exists(pref_path):
+                    return self.get_file_contents(pref_path)
+        for env_variable in ["DARCS_EMAIL", "EMAIL"]:
+            if env_variable in os.environ:
+                return os.environ[env_variable]
+        return None
+    def _rcs_set_user_id(self, value):
+        if self.rootdir == None:
+            self.root(".")
+            if self.rootdir == None:
+                raise rcs.SettingIDnotSupported
+        author_path = os.path.join(self.rootdir, "_darcs", "prefs", "author")
+        f = codecs.open(author_path, "w", self.encoding)
+        f.write(value)
+        f.close()
+    def _rcs_add(self, path):
+        if os.path.isdir(path):
+            return
+        self._u_invoke_client("add", path)
+    def _rcs_remove(self, path):
+        if not os.path.isdir(self._u_abspath(path)):
+            os.remove(os.path.join(self.rootdir, path)) # darcs notices removal
+    def _rcs_update(self, path):
+        pass # darcs notices changes
+    def _rcs_get_file_contents(self, path, revision=None, binary=False):
+        if revision == None:
+            return RCS._rcs_get_file_contents(self, path, revision,
+                                              binary=binary)
+        else:
+            try:
+                return self._u_invoke_client("show", "contents", "--patch", revision, path)
+            except rcs.CommandError:
+                # Darcs versions < 2.0.0pre2 lack the "show contents" command
+
+                status,output,error = self._u_invoke_client("diff", "--unified",
+                                                            "--from-patch",
+                                                            revision, path)
+                major_patch = output
+                status,output,error = self._u_invoke_client("diff", "--unified",
+                                                            "--patch",
+                                                            revision, path)
+                target_patch = output
+                
+                # "--output -" to be supported in GNU patch > 2.5.9
+                # but that hasn't been released as of June 30th, 2009.
+
+                # Rewrite path to status before the patch we want
+                args=["patch", "--reverse", path]
+                status,output,error = self._u_invoke(args, stdin=major_patch)
+                # Now apply the patch we want
+                args=["patch", path]
+                status,output,error = self._u_invoke(args, stdin=target_patch)
+
+                if os.path.exists(os.path.join(self.rootdir, path)) == True:
+                    contents = RCS._rcs_get_file_contents(self, path,
+                                                          binary=binary)
+                else:
+                    contents = ""
+
+                # Now restore path to it's current incarnation
+                args=["patch", "--reverse", path]
+                status,output,error = self._u_invoke(args, stdin=target_patch)
+                args=["patch", path]
+                status,output,error = self._u_invoke(args, stdin=major_patch)
+                current_contents = RCS._rcs_get_file_contents(self, path,
+                                                              binary=binary)
+                return contents
+    def _rcs_duplicate_repo(self, directory, revision=None):
+        if revision==None:
+            RCS._rcs_duplicate_repo(self, directory, revision)
+        else:
+            self._u_invoke_client("put", "--no-pristine-tree",
+                                  "--to-patch", revision, directory)
+    def _rcs_commit(self, commitfile):
+        id = self.get_user_id()
+        if '@' not in id:
+            id = "%s <%s@invalid.com>" % (id, id)
+        # Darcs doesn't like commitfiles without trailing endlines.
+        f = codecs.open(commitfile, 'r', self.encoding)
+        contents = f.read()
+        f.close()
+        if contents[-1] != '\n':
+            f = codecs.open(commitfile, 'a', self.encoding)
+            f.write('\n')
+            f.close()
+        status,output,error = self._u_invoke_client('record', '--all',
+                                                    '--author', id,
+                                                    '--logfile', commitfile)
+        revision = None
+
+        revline = re.compile("Finished recording patch '(.*)'")
+        match = revline.search(output)
+        assert match != None, output+error
+        assert len(match.groups()) == 1
+        revision = match.groups()[0]
+        return revision
+
+    
+rcs.make_rcs_testcase_subclasses(Darcs, sys.modules[__name__])
+
+unitsuite = unittest.TestLoader().loadTestsFromModule(sys.modules[__name__])
+suite = unittest.TestSuite([unitsuite, doctest.DocTestSuite()])
diff --git a/libbe/git.py b/libbe/git.py
index 5da1f86..8c25416 100644
--- a/libbe/git.py
+++ b/libbe/git.py
@@ -55,7 +55,14 @@ class Git(RCS):
         name = output.rstrip('\n')
         status,output,error = self._u_invoke_client("config", "user.email")
         email = output.rstrip('\n')
-        return self._u_create_id(name, email)
+        if name != "" or email != "": # got something!
+            # guess missing info, if necessary
+            if name == "":
+                name = self._u_get_fallback_username()
+            if email == "":
+                email = self._u_get_fallback_email()
+            return self._u_create_id(name, email)
+        return None # Git has no infomation
     def _rcs_set_user_id(self, value):
         name,email = self._u_parse_id(value)
         if email != None:
diff --git a/libbe/rcs.py b/libbe/rcs.py
index 9c2defe..f19f00f 100644
--- a/libbe/rcs.py
+++ b/libbe/rcs.py
@@ -34,9 +34,10 @@ def _get_matching_rcs(matchfn):
     """Return the first module for which matchfn(RCS_instance) is true"""
     import arch
     import bzr
-    import hg
+    import darcs
     import git
-    for module in [arch, bzr, hg, git]:
+    import hg
+    for module in [arch, bzr, darcs, git, hg]:
         rcs = module.new()
         if matchfn(rcs) == True:
             return rcs
@@ -383,7 +384,7 @@ class RCS(object):
         pass
     def postcommit(self, directory):
         pass
-    def _u_invoke(self, args, expect=(0,), cwd=None):
+    def _u_invoke(self, args, stdin=None, expect=(0,), cwd=None):
         if cwd == None:
             cwd = self.rootdir
         if self.verboseInvoke == True:
@@ -398,7 +399,7 @@ class RCS(object):
         except OSError, e :
             strerror = "%s\nwhile executing %s" % (e.args[1], args)
             raise CommandError(strerror, e.args[0])
-        output, error = q.communicate()
+        output, error = q.communicate(input=stdin)
         status = q.wait()
         if self.verboseInvoke == True:
             print >> sys.stderr, "%d\n%s%s" % (status, output, error)
@@ -409,9 +410,10 @@ class RCS(object):
     def _u_invoke_client(self, *args, **kwargs):
         directory = kwargs.get('directory',None)
         expect = kwargs.get('expect', (0,))
+        stdin = kwargs.get('stdin', None)
         cl_args = [self.client]
         cl_args.extend(args)
-        return self._u_invoke(cl_args, expect, cwd=directory)
+        return self._u_invoke(cl_args, stdin=stdin,expect=expect,cwd=directory)
     def _u_search_parent_directories(self, path, filename):
         """
         Find the file (or directory) named filename in path or in any
@@ -567,10 +569,12 @@ def setup_rcs_test_fixtures(testcase):
     testcase.dir = Dir()
     testcase.dirname = testcase.dir.path
 
+    rcs_not_supporting_uninitialized_user_id = []
+    rcs_not_supporting_set_user_id = ["None", "hg"]
     testcase.rcs_supports_uninitialized_user_id = (
-        testcase.rcs.name not in ["git"])
+        testcase.rcs.name not in rcs_not_supporting_uninitialized_user_id)
     testcase.rcs_supports_set_user_id = (
-        testcase.rcs.name not in ["None", "hg"])
+        testcase.rcs.name not in rcs_not_supporting_set_user_id)
 
     if not testcase.rcs.installed():
         testcase.fail(
diff --git a/test_usage.sh b/test_usage.sh
index 42c0f2f..b7391d9 100755
--- a/test_usage.sh
+++ b/test_usage.sh
@@ -23,14 +23,14 @@ then
     echo "usage: test_usage.sh [RCS]"
     echo ""
     echo "where RCS is one of"
-    for RCS in bzr git hg arch none
+    for RCS in arch bzr darcs git hg none
     do
 	echo "  $RCS"
     done
     exit 1
 elif [ $# -eq 0 ]
 then
-    for RCS in bzr git hg arch none
+    for RCS in arch bzr darcs git hg none
     do
 	echo -e "\n\nTesting $RCS\n\n"
 	$0 "$RCS" || exit 1
@@ -43,21 +43,7 @@ RCS="$1"
 TESTDIR=`mktemp -d /tmp/BEtest.XXXXXXXXXX`
 cd $TESTDIR
 
-if [ "$RCS" == "bzr" ]
-then
-    ID=`bzr whoami`
-    bzr init
-elif [ "$RCS" == "git" ]
-then
-    NAME=`git-config user.name`
-    EMAIL=`git-config user.email`
-    ID="$NAME <$EMAIL>"
-    git init
-elif [ "$RCS" == "hg" ]
-then
-    ID=`hg showconfig ui.username`
-    hg init
-elif [ "$RCS" == "arch" ]
+if [ "$RCS" == "arch" ]
 then
     ID=`tla my-id`
     ARCH_PARAM_DIR="$HOME/.arch-params"
@@ -76,6 +62,27 @@ then
     sed -i 's/^source .*/source ^[._=a-zA-X0-9].*$/' '{arch}/=tagging-method'
     echo "tla import -A $ARCH_ARCHIVE --summary 'Began versioning'"
     tla import -A $ARCH_ARCHIVE --summary 'Began versioning'
+elif [ "$RCS" == "bzr" ]
+then
+    ID=`bzr whoami`
+    bzr init
+elif [ "$RCS" == "darcs" ]
+then
+    if [ -z "$DARCS_EMAIL" ]; then
+	export DARCS_EMAIL="J. Doe <jdoe@example.com>"
+    fi
+    ID="$DARCS_EMAIL"
+    darcs init
+elif [ "$RCS" == "git" ]
+then
+    NAME=`git-config user.name`
+    EMAIL=`git-config user.email`
+    ID="$NAME <$EMAIL>"
+    git init
+elif [ "$RCS" == "hg" ]
+then
+    ID=`hg showconfig ui.username`
+    hg init
 elif [ "$RCS" == "none" ]
 then
     ID=`id -nu`