Fix typo: comitter->committer
[stgit] / stgit / git.py
index e97288a..20c84c8 100644 (file)
@@ -18,7 +18,7 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 """
 
-import sys, os, glob
+import sys, os, glob, popen2
 
 from stgit.utils import *
 
@@ -35,7 +35,6 @@ else:
 
 head_link = os.path.join(base_dir, 'HEAD')
 
-
 #
 # Classes
 #
@@ -44,24 +43,23 @@ class Commit:
     """
     def __init__(self, id_hash):
         self.__id_hash = id_hash
-        f = os.popen('git-cat-file commit %s' % id_hash, 'r')
 
-        for line in f:
+        lines = _output_lines('git-cat-file commit %s' % id_hash)
+        self.__parents = []
+        for i in range(len(lines)):
+            line = lines[i]
             if line == '\n':
                 break
             field = line.strip().split(' ', 1)
             if field[0] == 'tree':
                 self.__tree = field[1]
             elif field[0] == 'parent':
-                self.__parent = field[1]
+                self.__parents.append(field[1])
             if field[0] == 'author':
                 self.__author = field[1]
-            if field[0] == 'comitter':
+            if field[0] == 'committer':
                 self.__committer = field[1]
-        self.__log = f.read()
-
-        if f.close():
-            raise GitException, 'Unknown commit id'
+        self.__log = ''.join(lines[i:])
 
     def get_id_hash(self):
         return self.__id_hash
@@ -70,7 +68,10 @@ class Commit:
         return self.__tree
 
     def get_parent(self):
-        return self.__parent
+        return self.__parents[0]
+
+    def get_parents(self):
+        return self.__parents
 
     def get_author(self):
         return self.__author
@@ -78,10 +79,26 @@ class Commit:
     def get_committer(self):
         return self.__committer
 
+    def get_log(self):
+        return self.__log
+
+# dictionary of Commit objects, used to avoid multiple calls to git
+__commits = dict()
 
 #
 # Functions
 #
+def get_commit(id_hash):
+    """Commit objects factory. Save/look-up them in the __commits
+    dictionary
+    """
+    if id_hash in __commits:
+        return __commits[id_hash]
+    else:
+        commit = Commit(id_hash)
+        __commits[id_hash] = commit
+        return commit
+
 def get_conflicts():
     """Return the list of file conflicts
     """
@@ -94,17 +111,59 @@ def get_conflicts():
     else:
         return None
 
-def __output(cmd):
-    f = os.popen(cmd, 'r')
-    string = f.readline().strip()
-    if f.close():
-        raise GitException, '%s failed' % cmd
+def _input(cmd, file_desc):
+    p = popen2.Popen3(cmd)
+    for line in file_desc:
+        p.tochild.write(line)
+    p.tochild.close()
+    if p.wait():
+        raise GitException, '%s failed' % str(cmd)
+
+def _output(cmd):
+    p=popen2.Popen3(cmd)
+    string = p.fromchild.read()
+    if p.wait():
+        raise GitException, '%s failed' % str(cmd)
+    return string
+
+def _output_one_line(cmd):
+    p=popen2.Popen3(cmd)
+    string = p.fromchild.readline().strip()
+    if p.wait():
+        raise GitException, '%s failed' % str(cmd)
     return string
 
+def _output_lines(cmd):
+    p=popen2.Popen3(cmd)
+    lines = p.fromchild.readlines()
+    if p.wait():
+        raise GitException, '%s failed' % str(cmd)
+    return lines
+
+def __run(cmd, args=None):
+    """__run: runs cmd using spawnvp.
+
+    Runs cmd using spawnvp.  The shell is avoided so it won't mess up
+    our arguments.  If args is very large, the command is run multiple
+    times; args is split xargs style: cmd is passed on each
+    invocation.  Unlike xargs, returns immediately if any non-zero
+    return code is received.  
+    """
+    
+    args_l=cmd.split()
+    if args is None:
+        args = []
+    for i in range(0, len(args)+1, 100):
+        r=os.spawnvp(os.P_WAIT, args_l[0], args_l + args[i:min(i+100, len(args))])
+    if r:
+        return r
+    return 0
+
 def __check_base_dir():
     return os.path.isdir(base_dir)
 
-def __tree_status(files = [], tree_id = 'HEAD', unknown = False):
+def __tree_status(files = [], tree_id = 'HEAD', unknown = False,
+                  noexclude = True):
     """Returns a list of pairs - [status, filename]
     """
     os.system('git-update-cache --refresh > /dev/null')
@@ -113,15 +172,21 @@ def __tree_status(files = [], tree_id = 'HEAD', unknown = False):
 
     # unknown files
     if unknown:
-        exclude_file = os.path.join(base_dir, 'exclude')
-        extra_exclude = ''
+        exclude_file = os.path.join(base_dir, 'info', 'exclude')
+        base_exclude = ['--exclude=%s' % s for s in
+                        ['*.[ao]', '*.pyc', '.*', '*~', '#*', 'TAGS', 'tags']]
+        base_exclude.append('--exclude-per-directory=.gitignore')
+
         if os.path.exists(exclude_file):
-            extra_exclude += ' --exclude-from=%s' % exclude_file
-        fout = os.popen('git-ls-files --others'
-                        ' --exclude="*.[ao]" --exclude=".*"'
-                        ' --exclude=TAGS --exclude=tags --exclude="*~"'
-                        ' --exclude="#*"' + extra_exclude, 'r')
-        cache_files += [('?', line.strip()) for line in fout]
+            extra_exclude = '--exclude-from=%s' % exclude_file
+        else:
+            extra_exclude = []
+        if noexclude:
+            extra_exclude = base_exclude = []
+
+        lines = _output_lines(['git-ls-files', '--others'] + base_exclude
+                        + extra_exclude)
+        cache_files += [('?', line.strip()) for line in lines]
 
     # conflicted files
     conflicts = get_conflicts()
@@ -130,14 +195,10 @@ def __tree_status(files = [], tree_id = 'HEAD', unknown = False):
     cache_files += [('C', filename) for filename in conflicts]
 
     # the rest
-    files_str = reduce(lambda x, y: x + ' ' + y, files, '')
-    fout = os.popen('git-diff-cache -r %s %s' % (tree_id, files_str), 'r')
-    for line in fout:
-        fs = tuple(line.split()[4:])
+    for line in _output_lines(['git-diff-cache', '-r', tree_id] + files):
+        fs = tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
         if fs[1] not in conflicts:
             cache_files.append(fs)
-    if fout.close():
-        raise GitException, 'git-diff-cache failed'
 
     return cache_files
 
@@ -185,10 +246,9 @@ def add(names):
         else:
             raise GitException, '%s is not a file or directory' % i
 
-    for f in files:
-        print 'Adding file %s' % f
-        if os.system('git-update-cache --add -- %s' % f) != 0:
-            raise GitException, 'Unable to add %s' % f
+    if files:
+        if __run('git-update-cache --add --', files):
+            raise GitException, 'Unable to add file'
 
 def rm(files, force = False):
     """Remove a file from the repository
@@ -198,60 +258,66 @@ def rm(files, force = False):
     else:
         git_opt = '--remove'
 
-    for f in files:
-        if force:
-            print 'Removing file %s' % f
-            if os.system('git-update-cache --force-remove -- %s' % f) != 0:
-                raise GitException, 'Unable to remove %s' % f
-        elif os.path.exists(f):
-            raise GitException, '%s exists. Remove it first' %f
-        else:
-            print 'Removing file %s' % f
-            if os.system('git-update-cache --remove -- %s' % f) != 0:
-                raise GitException, 'Unable to remove %s' % f
+    if not force:
+        for f in files:
+            if os.path.exists(f):
+                raise GitException, '%s exists. Remove it first' %f
+        if files:
+            __run('git-update-cache --remove --', files)
+    else:
+        if files:
+            __run('git-update-cache --force-remove --', files)
+
+def update_cache(files = [], force = False):
+    """Update the cache information for the given files
+    """
+    cache_files = __tree_status(files)
+
+    # everything is up-to-date
+    if len(cache_files) == 0:
+        return False
+
+    # check for unresolved conflicts
+    if not force and [x for x in cache_files
+                      if x[0] not in ['M', 'N', 'A', 'D']]:
+        raise GitException, 'Updating cache failed: unresolved conflicts'
+
+    # update the cache
+    add_files = [x[1] for x in cache_files if x[0] in ['N', 'A']]
+    rm_files =  [x[1] for x in cache_files if x[0] in ['D']]
+    m_files =   [x[1] for x in cache_files if x[0] in ['M']]
+
+    if add_files and __run('git-update-cache --add --', add_files) != 0:
+        raise GitException, 'Failed git-update-cache --add'
+    if rm_files and __run('git-update-cache --force-remove --', rm_files) != 0:
+        raise GitException, 'Failed git-update-cache --rm'
+    if m_files and __run('git-update-cache --', m_files) != 0:
+        raise GitException, 'Failed git-update-cache'
+
+    return True
 
 def commit(message, files = [], parents = [], allowempty = False,
+           cache_update = True,
            author_name = None, author_email = None, author_date = None,
            committer_name = None, committer_email = None):
     """Commit the current tree to repository
     """
-    first = (parents == [])
-
     # Get the tree status
-    if not first:
-        cache_files = __tree_status(files)
-
-    if not first and len(cache_files) == 0 and not allowempty:
-        raise GitException, 'No changes to commit'
-
-    # check for unresolved conflicts
-    if not first and len(filter(lambda x: x[0] not in ['M', 'N', 'D'],
-                                cache_files)) != 0:
-        raise GitException, 'Commit failed: unresolved conflicts'
+    if cache_update and parents != []:
+        changes = update_cache(files)
+        if not changes and not allowempty:
+            raise GitException, 'No changes to commit'
 
     # get the commit message
     f = file('.commitmsg', 'w+')
-    if message[-1] == '\n':
+    if message[-1:] == '\n':
         f.write(message)
     else:
         print >> f, message
     f.close()
 
-    # update the cache
-    if not first:
-        for f in cache_files:
-            if f[0] == 'N':
-                git_flag = '--add'
-            elif f[0] == 'D':
-                git_flag = '--force-remove'
-            else:
-                git_flag = '--'
-
-            if os.system('git-update-cache %s %s' % (git_flag, f[1])) != 0:
-                raise GitException, 'Failed git-update-cache -- %s' % f[1]
-
     # write the index to repository
-    tree_id = __output('git-write-tree')
+    tree_id = _output_one_line('git-write-tree')
 
     # the commit
     cmd = ''
@@ -273,7 +339,7 @@ def commit(message, files = [], parents = [], allowempty = False,
 
     cmd += ' < .commitmsg'
 
-    commit_id = __output(cmd)
+    commit_id = _output_one_line(cmd)
     __set_head(commit_id)
     os.remove('.commitmsg')
 
@@ -283,22 +349,18 @@ def merge(base, head1, head2):
     """Perform a 3-way merge between base, head1 and head2 into the
     local tree
     """
-    if os.system('git-read-tree -u -m %s %s %s' % (base, head1, head2)) != 0:
+    if __run('git-read-tree -u -m', [base, head1, head2]) != 0:
         raise GitException, 'git-read-tree failed (local changes maybe?)'
 
     # this can fail if there are conflicts
-    if os.system('git-merge-cache -o gitmergeonefile.py -a') != 0:
+    if os.system('git-merge-cache -o -q gitmergeonefile.py -a') != 0:
         raise GitException, 'git-merge-cache failed (possible conflicts)'
 
-    # this should not fail
-    if os.system('git-checkout-cache -f -a') != 0:
-        raise GitException, 'Failed git-checkout-cache'
-
 def status(files = [], modified = False, new = False, deleted = False,
-           conflict = False, unknown = False):
+           conflict = False, unknown = False, noexclude = False):
     """Show the tree status
     """
-    cache_files = __tree_status(files, unknown = True)
+    cache_files = __tree_status(files, unknown = True, noexclude = noexclude)
     all = not (modified or new or deleted or conflict or unknown)
 
     if not all:
@@ -306,6 +368,7 @@ def status(files = [], modified = False, new = False, deleted = False,
         if modified:
             filestat.append('M')
         if new:
+            filestat.append('A')
             filestat.append('N')
         if deleted:
             filestat.append('D')
@@ -313,7 +376,7 @@ def status(files = [], modified = False, new = False, deleted = False,
             filestat.append('C')
         if unknown:
             filestat.append('?')
-        cache_files = filter(lambda x: x[0] in filestat, cache_files)
+        cache_files = [x for x in cache_files if x[0] in filestat]
 
     for fs in cache_files:
         if all:
@@ -321,51 +384,32 @@ def status(files = [], modified = False, new = False, deleted = False,
         else:
             print '%s' % fs[1]
 
-def diff(files = [], rev1 = 'HEAD', rev2 = None, output = None,
-         append = False):
+def diff(files = [], rev1 = 'HEAD', rev2 = None, out_fd = None):
     """Show the diff between rev1 and rev2
     """
-    files_str = reduce(lambda x, y: x + ' ' + y, files, '')
-
-    extra_args = ''
-    if output:
-        if append:
-            extra_args += ' >> %s' % output
-        else:
-            extra_args += ' > %s' % output
-
     os.system('git-update-cache --refresh > /dev/null')
 
     if rev2:
-        if os.system('git-diff-tree -p %s %s %s %s'
-                     % (rev1, rev2, files_str, extra_args)) != 0:
-            raise GitException, 'git-diff-tree failed'
+        diff_str = _output(['git-diff-tree', '-p', rev1, rev2] + files)
+    else:
+        diff_str = _output(['git-diff-cache', '-p', rev1] + files)
+
+    if out_fd:
+        out_fd.write(diff_str)
     else:
-        if os.system('git-diff-cache -p %s %s %s'
-                     % (rev1, files_str, extra_args)) != 0:
-            raise GitException, 'git-diff-cache failed'
+        return diff_str
 
 def diffstat(files = [], rev1 = 'HEAD', rev2 = None):
     """Return the diffstat between rev1 and rev2
     """
-    files_str = reduce(lambda x, y: x + ' ' + y, files, '')
 
     os.system('git-update-cache --refresh > /dev/null')
-    ds_cmd = '| git-apply --stat'
-
-    if rev2:
-        f = os.popen('git-diff-tree -p %s %s %s %s'
-                     % (rev1, rev2, files_str, ds_cmd), 'r')
-        str = f.read().rstrip()
-        if f.close():
-            raise GitException, 'git-diff-tree failed'
-    else:
-        f = os.popen('git-diff-cache -p %s %s %s'
-                     % (rev1, files_str, ds_cmd), 'r')
-        str = f.read().rstrip()
-        if f.close():
-            raise GitException, 'git-diff-cache failed'
-
+    p=popen2.Popen3('git-apply --stat')
+    diff(files, rev1, rev2, p.tochild)
+    p.tochild.close()
+    str = p.fromchild.read().rstrip()
+    if p.wait():
+        raise GitException, 'git.diffstat failed'
     return str
 
 def files(rev1, rev2):
@@ -374,40 +418,79 @@ def files(rev1, rev2):
     os.system('git-update-cache --refresh > /dev/null')
 
     str = ''
-    f = os.popen('git-diff-tree -r %s %s' % (rev1, rev2),
-                 'r')
-    for line in f:
-        str += '%s %s\n' % tuple(line.split()[4:])
-    if f.close():
-        raise GitException, 'git-diff-tree failed'
+    for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
+        str += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
 
     return str.rstrip()
 
-def checkout(files = [], force = False):
+def checkout(files = [], tree_id = None, force = False):
     """Check out the given or all files
     """
-    git_flags = ''
+    if tree_id and __run('git-read-tree -m', [tree_id]) != 0:
+        raise GitException, 'Failed git-read-tree -m %s' % tree_id
+
+    checkout_cmd = 'git-checkout-cache -q -u'
     if force:
-        git_flags += ' -f'
+        checkout_cmd += ' -f'
     if len(files) == 0:
-        git_flags += ' -a'
+        checkout_cmd += ' -a'
     else:
-        git_flags += reduce(lambda x, y: x + ' ' + y, files, ' --')
+        checkout_cmd += ' --'
 
-    if os.system('git-checkout-cache -q -u%s' % git_flags) != 0:
-        raise GitException, 'Failed git-checkout-cache -q -u%s' % git_flags
+    if __run(checkout_cmd, files) != 0:
+        raise GitException, 'Failed git-checkout-cache'
 
 def switch(tree_id):
     """Switch the tree to the given id
     """
-    to_delete = filter(lambda x: x[0] == 'N', __tree_status(tree_id = tree_id))
+    if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
+        raise GitException, 'git-read-tree failed (local changes maybe?)'
+
+    __set_head(tree_id)
+
+def reset(tree_id = None):
+    """Revert the tree changes relative to the given tree_id. It removes
+    any local changes
+    """
+    if not tree_id:
+        tree_id = get_head()
 
-    if os.system('git-read-tree -m %s' % tree_id) != 0:
-        raise GitException, 'Failed git-read-tree -m %s' % tree_id
+    cache_files = __tree_status(tree_id = tree_id)
+    rm_files =  [x[1] for x in cache_files if x[0] in ['D']]
 
-    checkout(force = True)
+    checkout(tree_id = tree_id, force = True)
     __set_head(tree_id)
 
     # checkout doesn't remove files
-    for fs in to_delete:
-        os.remove(fs[1])
+    map(os.remove, rm_files)
+
+def pull(repository = 'origin', refspec = None):
+    """Pull changes from the remote repository. At the moment, just
+    use the 'git pull' command
+    """
+    args = [repository]
+    if refspec:
+        args.append(refspec)
+
+    if __run('git pull', args) != 0:
+        raise GitException, 'Failed "git pull %s"' % repository
+
+def apply_patch(filename = None):
+    """Apply a patch onto the current index. There must not be any
+    local changes in the tree, otherwise the command fails
+    """
+    os.system('git-update-cache --refresh > /dev/null')
+
+    if filename:
+        if __run('git-apply --index', [filename]) != 0:
+            raise GitException, 'Patch does not apply cleanly'
+    else:
+        _input('git-apply --index', sys.stdin)
+
+def clone(repository, local_dir):
+    """Clone a remote repository. At the moment, just use the
+    'git clone' script
+    """
+    if __run('git clone', [repository, local_dir]) != 0:
+        raise GitException, 'Failed "git clone %s %s"' \
+              % (repository, local_dir)