Add the 'sync' command

[stgit] / stgit / stack.py

"""Basic quilt-like functionality
"""

__copyright__ = """
Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.

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 sys, os

from stgit.utils import *
from stgit import git, basedir, templates
from stgit.config import config


# stack exception class
class StackException(Exception):
    pass

class FilterUntil:
    def __init__(self):
        self.should_print = True
    def __call__(self, x, until_test, prefix):
        if until_test(x):
            self.should_print = False
        if self.should_print:
            return x[0:len(prefix)] != prefix
        return False

#
# Functions
#
__comment_prefix = 'STG:'
__patch_prefix = 'STG_PATCH:'

def __clean_comments(f):
    """Removes lines marked for status in a commit file
    """
    f.seek(0)

    # remove status-prefixed lines
    lines = f.readlines()

    patch_filter = FilterUntil()
    until_test = lambda t: t == (__patch_prefix + '\n')
    lines = [l for l in lines if patch_filter(l, until_test, __comment_prefix)]

    # remove empty lines at the end
    while len(lines) != 0 and lines[-1] == '\n':
        del lines[-1]

    f.seek(0); f.truncate()
    f.writelines(lines)

def edit_file(series, line, comment, show_patch = True):
    fname = '.stgitmsg.txt'
    tmpl = templates.get_template('patchdescr.tmpl')

    f = file(fname, 'w+')
    if line:
        print >> f, line
    elif tmpl:
        print >> f, tmpl,
    else:
        print >> f
    print >> f, __comment_prefix, comment
    print >> f, __comment_prefix, \
          'Lines prefixed with "%s" will be automatically removed.' \
          % __comment_prefix
    print >> f, __comment_prefix, \
          'Trailing empty lines will be automatically removed.'

    if show_patch:
       print >> f, __patch_prefix
       # series.get_patch(series.get_current()).get_top()
       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 nobackup:'
    f.close()

    # the editor
    if config.has_option('stgit', 'editor'):
        editor = config.get('stgit', 'editor')
    elif 'EDITOR' in os.environ:
        editor = os.environ['EDITOR']
    else:
        editor = 'vi'
    editor += ' %s' % fname

    print 'Invoking the editor: "%s"...' % editor,
    sys.stdout.flush()
    print 'done (exit code: %d)' % os.system(editor)

    f = file(fname, 'r+')

    __clean_comments(f)
    f.seek(0)
    result = f.read()

    f.close()
    os.remove(fname)

    return result

#
# Classes
#

class StgitObject:
    """An object with stgit-like properties stored as files in a directory
    """
    def _set_dir(self, dir):
        self.__dir = dir
    def _dir(self):
        return self.__dir

    def create_empty_field(self, name):
        create_empty_file(os.path.join(self.__dir, name))

    def _get_field(self, name, multiline = False):
        id_file = os.path.join(self.__dir, name)
        if os.path.isfile(id_file):
            line = read_string(id_file, multiline)
            if line == '':
                return None
            else:
                return line
        else:
            return None

    def _set_field(self, name, value, multiline = False):
        fname = os.path.join(self.__dir, name)
        if value and value != '':
            write_string(fname, value, multiline)
        elif os.path.isfile(fname):
            os.remove(fname)

    
class Patch(StgitObject):
    """Basic patch implementation
    """
    def __init__(self, name, series_dir, refs_dir):
        self.__series_dir = series_dir
        self.__name = name
        self._set_dir(os.path.join(self.__series_dir, self.__name))
        self.__refs_dir = refs_dir
        self.__top_ref_file = os.path.join(self.__refs_dir, self.__name)
        self.__log_ref_file = os.path.join(self.__refs_dir,
                                           self.__name + '.log')

    def create(self):
        os.mkdir(self._dir())
        self.create_empty_field('bottom')
        self.create_empty_field('top')

    def delete(self):
        for f in os.listdir(self._dir()):
            os.remove(os.path.join(self._dir(), f))
        os.rmdir(self._dir())
        os.remove(self.__top_ref_file)
        if os.path.exists(self.__log_ref_file):
            os.remove(self.__log_ref_file)

    def get_name(self):
        return self.__name

    def rename(self, newname):
        olddir = self._dir()
        old_top_ref_file = self.__top_ref_file
        old_log_ref_file = self.__log_ref_file
        self.__name = newname
        self._set_dir(os.path.join(self.__series_dir, self.__name))
        self.__top_ref_file = os.path.join(self.__refs_dir, self.__name)
        self.__log_ref_file = os.path.join(self.__refs_dir,
                                           self.__name + '.log')

        os.rename(olddir, self._dir())
        os.rename(old_top_ref_file, self.__top_ref_file)
        if os.path.exists(old_log_ref_file):
            os.rename(old_log_ref_file, self.__log_ref_file)

    def __update_top_ref(self, ref):
        write_string(self.__top_ref_file, ref)

    def __update_log_ref(self, ref):
        write_string(self.__log_ref_file, ref)

    def update_top_ref(self):
        top = self.get_top()
        if top:
            self.__update_top_ref(top)

    def get_old_bottom(self):
        return self._get_field('bottom.old')

    def get_bottom(self):
        return self._get_field('bottom')

    def set_bottom(self, value, backup = False):
        if backup:
            curr = self._get_field('bottom')
            self._set_field('bottom.old', curr)
        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, value, backup = False):
        if backup:
            curr = self._get_field('top')
            self._set_field('top.old', curr)
        self._set_field('top', value)
        self.__update_top_ref(value)

    def restore_old_boundaries(self):
        bottom = self._get_field('bottom.old')
        top = self._get_field('top.old')

        if top and bottom:
            self._set_field('bottom', bottom)
            self._set_field('top', top)
            self.__update_top_ref(top)
            return True
        else:
            return False

    def get_description(self):
        return self._get_field('description', 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, name):
        self._set_field('authname', name or git.author().name)

    def get_authemail(self):
        return self._get_field('authemail')

    def set_authemail(self, email):
        self._set_field('authemail', email or git.author().email)

    def get_authdate(self):
        return self._get_field('authdate')

    def set_authdate(self, date):
        self._set_field('authdate', date or git.author().date)

    def get_commname(self):
        return self._get_field('commname')

    def set_commname(self, name):
        self._set_field('commname', name or git.committer().name)

    def get_commemail(self):
        return self._get_field('commemail')

    def set_commemail(self, email):
        self._set_field('commemail', email or git.committer().email)

    def get_log(self):
        return self._get_field('log')

    def set_log(self, value, backup = False):
        self._set_field('log', value)
        self.__update_log_ref(value)


class Series(StgitObject):
    """Class including the operations on series
    """
    def __init__(self, name = None):
        """Takes a series name as the parameter.
        """
        try:
            if name:
                self.__name = name
            else:
                self.__name = git.get_head_file()
            self.__base_dir = basedir.get()
        except git.GitException, ex:
            raise StackException, 'GIT tree not initialised: %s' % ex

        self._set_dir(os.path.join(self.__base_dir, 'patches', self.__name))
        self.__refs_dir = os.path.join(self.__base_dir, 'refs', 'patches',
                                       self.__name)
        self.__base_file = os.path.join(self.__base_dir, 'refs', 'bases',
                                        self.__name)

        self.__applied_file = os.path.join(self._dir(), 'applied')
        self.__unapplied_file = os.path.join(self._dir(), 'unapplied')
        self.__current_file = os.path.join(self._dir(), 'current')
        self.__descr_file = os.path.join(self._dir(), 'description')

        # where this series keeps its patches
        self.__patch_dir = os.path.join(self._dir(), 'patches')
        if not os.path.isdir(self.__patch_dir):
            self.__patch_dir = self._dir()

        # if no __refs_dir, create and populate it (upgrade old repositories)
        if self.is_initialised() and not os.path.isdir(self.__refs_dir):
            os.makedirs(self.__refs_dir)
            for patch in self.get_applied() + self.get_unapplied():
                self.get_patch(patch).update_top_ref()

        # trash directory
        self.__trash_dir = os.path.join(self._dir(), 'trash')
        if self.is_initialised() and not os.path.isdir(self.__trash_dir):
            os.makedirs(self.__trash_dir)

    def get_branch(self):
        """Return the branch name for the Series object
        """
        return self.__name

    def __set_current(self, name):
        """Sets the topmost patch
        """
        self._set_field('current', name)

    def get_patch(self, name):
        """Return a Patch object for the given name
        """
        return Patch(name, self.__patch_dir, self.__refs_dir)

    def get_current_patch(self):
        """Return a Patch object representing the topmost patch, or
        None if there is no such patch."""
        crt = self.get_current()
        if not crt:
            return None
        return Patch(crt, self.__patch_dir, self.__refs_dir)

    def get_current(self):
        """Return the name of the topmost patch, or None if there is
        no such patch."""
        name = self._get_field('current')
        if name == '':
            return None
        else:
            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()
        return names

    def get_base_file(self):