Use the GIT-specific environment as default
[stgit] / stgit / stack.py
index 7109186..9aa5099 100644 (file)
@@ -64,13 +64,13 @@ def __clean_comments(f):
     f.seek(0); f.truncate()
     f.writelines(lines)
 
-def edit_file(series, string, comment, show_patch = True):
+def edit_file(series, line, comment, show_patch = True):
     fname = '.stgit.msg'
-    tmpl = os.path.join(git.base_dir, 'patchdescr.tmpl')
+    tmpl = os.path.join(git.get_base_dir(), 'patchdescr.tmpl')
 
     f = file(fname, 'w+')
-    if string:
-        print >> f, string
+    if line:
+        print >> f, line
     elif os.path.isfile(tmpl):
         print >> f, file(tmpl).read().rstrip()
     else:
@@ -88,7 +88,7 @@ def edit_file(series, string, comment, show_patch = True):
        git.diff([], series.get_patch(series.get_current()).get_bottom(), None, f)
 
     #Vim modeline must be near the end.
-    print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff:'
+    print >> f, __comment_prefix, 'vi: set textwidth=75 filetype=diff nobackup:'
     f.close()
 
     # the editor
@@ -108,12 +108,12 @@ def edit_file(series, string, comment, show_patch = True):
 
     __clean_comments(f)
     f.seek(0)
-    string = f.read()
+    result = f.read()
 
     f.close()
     os.remove(fname)
 
-    return string
+    return result
 
 #
 # Classes
@@ -122,10 +122,10 @@ def edit_file(series, string, comment, show_patch = True):
 class Patch:
     """Basic patch implementation
     """
-    def __init__(self, name, patch_dir):
-        self.__patch_dir = patch_dir
+    def __init__(self, name, series_dir):
+        self.__series_dir = series_dir
         self.__name = name
-        self.__dir = os.path.join(self.__patch_dir, self.__name)
+        self.__dir = os.path.join(self.__series_dir, self.__name)
 
     def create(self):
         os.mkdir(self.__dir)
@@ -143,51 +143,57 @@ class Patch:
     def rename(self, newname):
         olddir = self.__dir
         self.__name = newname
-        self.__dir = os.path.join(self.__patch_dir, self.__name)
+        self.__dir = os.path.join(self.__series_dir, self.__name)
 
         os.rename(olddir, self.__dir)
 
     def __get_field(self, name, multiline = False):
         id_file = os.path.join(self.__dir, name)
         if os.path.isfile(id_file):
-            string = read_string(id_file, multiline)
-            if string == '':
+            line = read_string(id_file, multiline)
+            if line == '':
                 return None
             else:
-                return string
+                return line
         else:
             return None
 
-    def __set_field(self, name, string, multiline = False):
+    def __set_field(self, name, value, multiline = False):
         fname = os.path.join(self.__dir, name)
-        if string and string != '':
-            write_string(fname, string, multiline)
+        if value and value != '':
+            write_string(fname, value, multiline)
         elif os.path.isfile(fname):
             os.remove(fname)
 
+    def get_old_bottom(self):
+        return self.__get_field('bottom.old')
+
     def get_bottom(self):
         return self.__get_field('bottom')
 
-    def set_bottom(self, string, backup = False):
+    def set_bottom(self, value, backup = False):
         if backup:
             curr = self.__get_field('bottom')
-            if curr != string:
+            if curr != value:
                 self.__set_field('bottom.old', curr)
             else:
                 self.__set_field('bottom.old', None)
-        self.__set_field('bottom', string)
+        self.__set_field('bottom', value)
+
+    def get_old_top(self):
+        return self.__get_field('top.old')
 
     def get_top(self):
         return self.__get_field('top')
 
-    def set_top(self, string, backup = False):
+    def set_top(self, value, backup = False):
         if backup:
             curr = self.__get_field('top')
-            if curr != string:
+            if curr != value:
                 self.__set_field('top.old', curr)
             else:
                 self.__set_field('top.old', None)
-        self.__set_field('top', string)
+        self.__set_field('top', value)
 
     def restore_old_boundaries(self):
         bottom = self.__get_field('bottom.old')
@@ -203,68 +209,91 @@ class Patch:
     def get_description(self):
         return self.__get_field('description', True)
 
-    def set_description(self, string):
-        self.__set_field('description', string, True)
+    def set_description(self, line):
+        self.__set_field('description', line, True)
 
     def get_authname(self):
         return self.__get_field('authname')
 
-    def set_authname(self, string):
-        if not string and config.has_option('stgit', 'authname'):
-            string = config.get('stgit', 'authname')
-        self.__set_field('authname', string)
+    def set_authname(self, name):
+        if not name:
+            if config.has_option('stgit', 'authname'):
+                name = config.get('stgit', 'authname')
+            elif 'GIT_AUTHOR_NAME' in os.environ:
+                name = os.environ['GIT_AUTHOR_NAME']
+        self.__set_field('authname', name)
 
     def get_authemail(self):
         return self.__get_field('authemail')
 
-    def set_authemail(self, string):
-        if not string and config.has_option('stgit', 'authemail'):
-            string = config.get('stgit', 'authemail')
-        self.__set_field('authemail', string)
+    def set_authemail(self, address):
+        if not address:
+            if config.has_option('stgit', 'authemail'):
+                address = config.get('stgit', 'authemail')
+            elif 'GIT_AUTHOR_EMAIL' in os.environ:
+                address = os.environ['GIT_AUTHOR_EMAIL']
+        self.__set_field('authemail', address)
 
     def get_authdate(self):
         return self.__get_field('authdate')
 
-    def set_authdate(self, string):
-        self.__set_field('authdate', string)
+    def set_authdate(self, date):
+        if not date and 'GIT_AUTHOR_DATE' in os.environ:
+            date = os.environ['GIT_AUTHOR_DATE']
+        self.__set_field('authdate', date)
 
     def get_commname(self):
         return self.__get_field('commname')
 
-    def set_commname(self, string):
-        if not string and config.has_option('stgit', 'commname'):
-            string = config.get('stgit', 'commname')
-        self.__set_field('commname', string)
+    def set_commname(self, name):
+        if not name:
+            if config.has_option('stgit', 'commname'):
+                name = config.get('stgit', 'commname')
+            elif 'GIT_COMMITTER_NAME' in os.environ:
+                name = os.environ['GIT_COMMITTER_NAME']
+        self.__set_field('commname', name)
 
     def get_commemail(self):
         return self.__get_field('commemail')
 
-    def set_commemail(self, string):
-        if not string and config.has_option('stgit', 'commemail'):
-            string = config.get('stgit', 'commemail')
-        self.__set_field('commemail', string)
+    def set_commemail(self, address):
+        if not address:
+            if config.has_option('stgit', 'commemail'):
+                address = config.get('stgit', 'commemail')
+            elif 'GIT_COMMITTER_EMAIL' in os.environ:
+                address = os.environ['GIT_COMMITTER_EMAIL']
+        self.__set_field('commemail', address)
 
 
 class Series:
     """Class including the operations on series
     """
     def __init__(self, name = None):
-        """Takes a series name as the parameter. A valid .git/patches/name
-        directory should exist
+        """Takes a series name as the parameter.
         """
-        if name:
-            self.__name = name
-        else:
-            self.__name = git.get_head_file()
-
-        if self.__name:
-            self.__patch_dir = os.path.join(git.base_dir, 'patches',
-                                            self.__name)
-            self.__base_file = os.path.join(git.base_dir, 'refs', 'bases',
-                                            self.__name)
-            self.__applied_file = os.path.join(self.__patch_dir, 'applied')
-            self.__unapplied_file = os.path.join(self.__patch_dir, 'unapplied')
-            self.__current_file = os.path.join(self.__patch_dir, 'current')
+        try:
+            if name:
+                self.__name = name
+            else:
+                self.__name = git.get_head_file()
+            base_dir = git.get_base_dir()
+        except git.GitException, ex:
+            raise StackException, 'GIT tree not initialised: %s' % ex
+
+        self.__series_dir = os.path.join(base_dir, 'patches',
+                                         self.__name)
+        self.__base_file = os.path.join(base_dir, 'refs', 'bases',
+                                        self.__name)
+
+        self.__applied_file = os.path.join(self.__series_dir, 'applied')
+        self.__unapplied_file = os.path.join(self.__series_dir, 'unapplied')
+        self.__current_file = os.path.join(self.__series_dir, 'current')
+        self.__descr_file = os.path.join(self.__series_dir, 'description')
+
+        # where this series keeps its patches
+        self.__patch_dir = os.path.join(self.__series_dir, 'patches')
+        if not os.path.isdir(self.__patch_dir):
+            self.__patch_dir = self.__series_dir
 
     def get_branch(self):
         """Return the branch name for the Series object
@@ -297,12 +326,16 @@ class Series:
             return name
 
     def get_applied(self):
+        if not os.path.isfile(self.__applied_file):
+            raise StackException, 'Branch "%s" not initialised' % self.__name
         f = file(self.__applied_file)
         names = [line.strip() for line in f.readlines()]
         f.close()
         return names
 
     def get_unapplied(self):
+        if not os.path.isfile(self.__unapplied_file):
+            raise StackException, 'Branch "%s" not initialised' % self.__name
         f = file(self.__unapplied_file)
         names = [line.strip() for line in f.readlines()]
         f.close()
@@ -311,6 +344,25 @@ class Series:
     def get_base_file(self):
         return self.__base_file
 
+    def get_protected(self):
+        return os.path.isfile(os.path.join(self.__series_dir, 'protected'))
+
+    def protect(self):
+        protect_file = os.path.join(self.__series_dir, 'protected')
+        if not os.path.isfile(protect_file):
+            create_empty_file(protect_file)
+
+    def unprotect(self):
+        protect_file = os.path.join(self.__series_dir, 'protected')
+        if os.path.isfile(protect_file):
+            os.remove(protect_file)
+
+    def get_description(self):
+        if os.path.isfile(self.__descr_file):
+            return read_string(self.__descr_file)
+        else:
+            return ''
+
     def __patch_is_current(self, patch):
         return patch.get_name() == read_string(self.__current_file)
 
@@ -349,12 +401,17 @@ class Series:
             return True
         return git.get_head() == Patch(crt, self.__patch_dir).get_top()
 
+    def is_initialised(self):
+        """Checks if series is already initialised
+        """
+        return os.path.isdir(self.__patch_dir)
+
     def init(self):
         """Initialises the stgit series
         """
-        bases_dir = os.path.join(git.base_dir, 'refs', 'bases')
+        bases_dir = os.path.join(git.get_base_dir(), 'refs', 'bases')
 
-        if os.path.isdir(self.__patch_dir):
+        if self.is_initialised():
             raise StackException, self.__patch_dir + ' already exists'
         os.makedirs(self.__patch_dir)
 
@@ -363,14 +420,129 @@ class Series:
 
         create_empty_file(self.__applied_file)
         create_empty_file(self.__unapplied_file)
+        create_empty_file(self.__descr_file)
+        os.makedirs(os.path.join(self.__series_dir, 'patches'))
         self.__begin_stack_check()
 
-    def refresh_patch(self, message = None, edit = False, show_patch = False,
+    def convert(self):
+        """Either convert to use a separate patch directory, or
+        unconvert to place the patches in the same directory with
+        series control files
+        """
+        if self.__patch_dir == self.__series_dir:
+            print 'Converting old-style to new-style...',
+            sys.stdout.flush()
+
+            self.__patch_dir = os.path.join(self.__series_dir, 'patches')
+            os.makedirs(self.__patch_dir)
+
+            for p in self.get_applied() + self.get_unapplied():
+                src = os.path.join(self.__series_dir, p)
+                dest = os.path.join(self.__patch_dir, p)
+                os.rename(src, dest)
+
+            print 'done'
+
+        else:
+            print 'Converting new-style to old-style...',
+            sys.stdout.flush()
+
+            for p in self.get_applied() + self.get_unapplied():
+                src = os.path.join(self.__patch_dir, p)
+                dest = os.path.join(self.__series_dir, p)
+                os.rename(src, dest)
+
+            if not os.listdir(self.__patch_dir):
+                os.rmdir(self.__patch_dir)
+                print 'done'
+            else:
+                print 'Patch directory %s is not empty.' % self.__name
+
+            self.__patch_dir = self.__series_dir
+
+    def rename(self, to_name):
+        """Renames a series
+        """
+        to_stack = Series(to_name)
+
+        if to_stack.is_initialised():
+            raise StackException, '"%s" already exists' % to_stack.get_branch()
+        if os.path.exists(to_stack.__base_file):
+            os.remove(to_stack.__base_file)
+
+        git.rename_branch(self.__name, to_name)
+
+        if os.path.isdir(self.__series_dir):
+            os.rename(self.__series_dir, to_stack.__series_dir)
+        if os.path.exists(self.__base_file):
+            os.rename(self.__base_file, to_stack.__base_file)
+
+        self.__init__(to_name)
+
+    def clone(self, target_series):
+        """Clones a series
+        """
+        base = read_string(self.get_base_file())
+        git.create_branch(target_series, tree_id = base)
+        Series(target_series).init()
+        new_series = Series(target_series)
+
+        # generate an artificial description file
+        write_string(new_series.__descr_file, 'clone of "%s"' % self.__name)
+
+        # clone self's entire series as unapplied patches
+        patches = self.get_applied() + self.get_unapplied()
+        patches.reverse()
+        for p in patches:
+            patch = self.get_patch(p)
+            new_series.new_patch(p, message = patch.get_description(),
+                                 can_edit = False, unapplied = True,
+                                 bottom = patch.get_bottom(),
+                                 top = patch.get_top(),
+                                 author_name = patch.get_authname(),
+                                 author_email = patch.get_authemail(),
+                                 author_date = patch.get_authdate())
+
+        # fast forward the cloned series to self's top
+        new_series.forward_patches(self.get_applied())
+
+    def delete(self, force = False):
+        """Deletes an stgit series
+        """
+        if self.is_initialised():
+            patches = self.get_unapplied() + self.get_applied()
+            if not force and patches:
+                raise StackException, \
+                      'Cannot delete: the series still contains patches'
+            for p in patches:
+                Patch(p, self.__patch_dir).delete()
+
+            if os.path.exists(self.__applied_file):
+                os.remove(self.__applied_file)
+            if os.path.exists(self.__unapplied_file):
+                os.remove(self.__unapplied_file)
+            if os.path.exists(self.__current_file):
+                os.remove(self.__current_file)
+            if os.path.exists(self.__descr_file):
+                os.remove(self.__descr_file)
+            if not os.listdir(self.__patch_dir):
+                os.rmdir(self.__patch_dir)
+            else:
+                print 'Patch directory %s is not empty.' % self.__name
+            if not os.listdir(self.__series_dir):
+                os.rmdir(self.__series_dir)
+            else:
+                print 'Series directory %s is not empty.' % self.__name
+
+        if os.path.exists(self.__base_file):
+            os.remove(self.__base_file)
+
+    def refresh_patch(self, files = None, message = None, edit = False,
+                      show_patch = False,
                       cache_update = True,
                       author_name = None, author_email = None,
                       author_date = None,
-                      committer_name = None, committer_email = None,
-                      commit_only = False):
+                      committer_name = None, committer_email = None):
         """Generates a new commit for the given patch
         """
         name = self.get_current()
@@ -402,7 +574,8 @@ class Series:
         if not committer_email:
             committer_email = patch.get_commemail()
 
-        commit_id = git.commit(message = descr, parents = [patch.get_bottom()],
+        commit_id = git.commit(files = files,
+                               message = descr, parents = [patch.get_bottom()],
                                cache_update = cache_update,
                                allowempty = True,
                                author_name = author_name,
@@ -411,14 +584,13 @@ class Series:
                                committer_name = committer_name,
                                committer_email = committer_email)
 
-        if not commit_only:
-            patch.set_top(commit_id)
-            patch.set_description(descr)
-            patch.set_authname(author_name)
-            patch.set_authemail(author_email)
-            patch.set_authdate(author_date)
-            patch.set_commname(committer_name)
-            patch.set_commemail(committer_email)
+        patch.set_top(commit_id)
+        patch.set_description(descr)
+        patch.set_authname(author_name)
+        patch.set_authemail(author_email)
+        patch.set_authdate(author_date)
+        patch.set_commname(committer_name)
+        patch.set_commemail(committer_email)
 
         return commit_id
 
@@ -555,6 +727,9 @@ class Series:
             forwarded+=1
             unapplied.remove(name)
 
+        if forwarded == 0:
+            return 0
+
         git.switch(top)
 
         append_strings(self.__applied_file, names[0:forwarded])
@@ -582,6 +757,7 @@ class Series:
         top = patch.get_top()
 
         ex = None
+        modified = False
 
         # top != bottom always since we have a commit for each patch
         if head == bottom:
@@ -595,14 +771,21 @@ class Series:
             # The current patch is empty after merge.
             patch.set_bottom(head, backup = True)
             patch.set_top(head, backup = True)
-            # merge/refresh can fail but the patch needs to be pushed
-            try:
-                git.merge(bottom, head, top)
-            except git.GitException, ex:
-                print >> sys.stderr, \
-                      'The merge failed during "push". ' \
-                      'Use "refresh" after fixing the conflicts'
-                pass
+
+            # Try the fast applying first. If this fails, fall back to the
+            # three-way merge
+            if not git.apply_diff(bottom, top):
+                # if git.apply_diff() fails, the patch requires a diff3
+                # merge and can be reported as modified
+                modified = True
+
+                # merge can fail but the patch needs to be pushed
+                try:
+                    git.merge(bottom, head, top)
+                except git.GitException, ex:
+                    print >> sys.stderr, \
+                          'The merge failed during "push". ' \
+                          'Use "refresh" after fixing the conflicts'
 
         append_string(self.__applied_file, name)
 
@@ -622,6 +805,8 @@ class Series:
             else:
                 raise StackException, str(ex)
 
+        return modified
+
     def undo_push(self):
         name = self.get_current()
         assert(name)
@@ -686,6 +871,9 @@ class Series:
         applied = self.get_applied()
         unapplied = self.get_unapplied()
 
+        if oldname == newname:
+            raise StackException, '"To" name and "from" name are the same'
+
         if newname in applied or newname in unapplied:
             raise StackException, 'Patch "%s" already exists' % newname