source: tailor/vcpx/darcs.py @ 98

#! /usr/bin/python
# -*- mode: python; coding: utf-8 -*-
# :Progetto: vcpx -- Darcs details
# :Creato:   ven 18 giu 2004 14:45:28 CEST
# :Autore:   Lele Gaifax <lele@nautilus.homeip.net>
# 

"""
This module contains supporting classes for the `darcs` versioning system.
"""

__docformat__ = 'reStructuredText'

from shwrap import SystemCommand
from source import UpdatableSourceWorkingDir
from target import SyncronizableTargetWorkingDir, TargetInitializationFailure


class DarcsInitialize(SystemCommand):
    COMMAND = "darcs initialize"


class DarcsRecord(SystemCommand):
    COMMAND = "darcs record --all --pipe --look-for-adds %(entries)s"

    def __call__(self, output=None, dry_run=False, **kwargs):
        date = kwargs.get('date').strftime('%Y/%m/%d %H:%M:%S')
        author = kwargs.get('author')
        patchname = kwargs.get('patchname')
        logmessage = kwargs.get('logmessage')
        if not logmessage:
            logmessage = ''

        input = "%s\n%s\n%s\n%s\n" % (date, author, patchname, logmessage)
        
        return SystemCommand.__call__(self, output=output, input=input,
                                      dry_run=dry_run, 
                                      **kwargs)


class DarcsMv(SystemCommand):
    COMMAND = "darcs mv --standard-verbosity %(old)s %(new)s"


class DarcsRemove(SystemCommand):
    COMMAND = "darcs remove --standard-verbosity %(entry)s"


class DarcsAdd(SystemCommand):
    COMMAND = "darcs add --not-recursive --standard-verbosity %(entry)s"


class DarcsTag(SystemCommand):
    COMMAND = "darcs tag --standard-verbosity --patch-name='%(tagname)s'"


class DarcsChanges(SystemCommand):
    COMMAND = "darcs changes --from-tag=tagname --xml-output --summary"


class DarcsAnnotate(SystemCommand):
    COMMAND = "darcs annotate --standard-verbosity %(entry)s >/dev/null 2>&1"
    
class DarcsWorkingDir(UpdatableSourceWorkingDir,SyncronizableTargetWorkingDir):
    """
    A working directory under ``darcs``.
    """

    def __init__(self):
        self.__visitedDirs = {}
        
    ## UpdatableSourceWorkingDir
    
    def _getUpstreamChangesets(self, root, sincerev=None):
        """
        Do the actual work of fetching the upstream changeset.
        
        This is different from the other VC mechanisms: here we want
        register with the target the changes we submitted to this
        repository to be sent back to upstream. Since we may want to
        regroup the various patchsets into a single one, we first
        manually pull here what we wanna send, then the sync will replay 
        the changes of all new changesets.
        
        So, here we actually list the changes after the last tag, not
        those pending on the other side.
        """

        tagname = self._getLastTag(root)
        
        c = DarcsChanges(working_dir=root)
        changes = c(output=True)

        changesets = self.__parseDarcsChanges(changes)

        # sort changeset by date
        changesets.sort(lambda x, y: cmp(x.date, y.date))

        return changesets
    
    def __parseDarcsChanges(self, changes):
        from xml.sax import parseString
        from xml.sax.handler import ContentHandler
        from changes import ChangesetEntry, Changeset
        from datetime import datetime
        
        class DarcsXMLChangesHandler(ContentHandler):
            def __init__(self):
                self.changesets = []
                self.current = None
                self.current_field = []

            def startElement(self, name, attributes):
                if name == 'patch':
                    self.current = {}
                    self.current['author'] = attributes['author']
                    date = attributes['date']
                    # 20040619130027
                    y = int(date[:4])
                    m = int(date[4:6])
                    d = int(date[6:8])
                    hh = int(date[8:10])
                    mm = int(date[10:12])
                    ss = int(date[12:14])
                    timestamp = datetime(y, m, d, hh, mm, ss)
                    self.current['date'] = timestamp
                    self.current['revision'] = attributes['revision']
                    self.current['entries'] = []
                elif name in ['name', 'comment',
                              'add_file', 'add_directory',
                              'modify_file', 'remove_file']:
                    self.current_field = []
                elif name == 'path':
                    self.current_field = []
                    if attributes.has_key('copyfrom-path'):
                        self.current_path_action = (
                            attributes['action'],
                            attributes['copyfrom-path'][1:], # make it relative
                            attributes['copyfrom-rev'])
                    else:
                        self.current_path_action = attributes['action']
                elif name == 'move':
                    self.old_name = attributes['from']
                    self.new_name = attributes['to']
                    
            def endElement(self, name):
                if name == 'patch':
                    # Sort the paths to make tests easier
                    self.current['entries'].sort()
                    self.changesets.append(Changeset(self.current['name'],
                                                     self.current['date'],
                                                     self.current['author'],
                                                     self.current['comment'],
                                                     self.current['entries']))
                    self.current = None
                elif name in ['name', 'comment']:
                    self.current[name] = ''.join(self.current_field)
                elif name == 'move':
                    entry = ChangesetEntry(self.new_name)
                    entry.action_kind = entry.RENAMED
                    entry.old_name = self.old_name
                    self.current['entries'].append(entry)
                elif name in ['add_file', 'add_directory',
                              'modify_file', 'remove_file']:
                    entry = ChangesetEntry(''.join(self.current_field))
                    entry.action_kind = { 'add_file': entry.ADDED,
                                          'add_directory': entry.ADDED,
                                          'modify_file': entry.UPDATED,
                                          'remove_file': entry.DELETED,
                                          'rename_file': entry.RENAMED
                                        }[name]

                    self.current['entries'].append(entry)

            def characters(self, data):
                self.current_field.append(data)
        
        handler = DarcsXMLChangesHandler()
        parseString(changes.getvalue(), handler)
        return handler.changesets
        
    def _applyChangeset(self, root, changeset, logger=None):
        """
        Do the actual work of applying the changeset to the working copy.

        The changeset is already applied, so this is a do nothing method.
        """

        return
    
    ## SyncronizableTargetWorkingDir

    def _addEntry(self, root, entry):
        """
        Add a new entry, maybe registering the directory as well.
        """

        from os.path import split, join, exists

        basedir = split(entry)[0]

        if basedir:
            if not self.__visitedDirs.get(basedir):
                # This is ugly, but I didn't find a better way to test
                # whether a particular directory is already version
                # controlled by darcs.
        
                dannot = DarcsAnnotate(working_dir=root)
        
                dannot(entry=basedir)
                if dannot.exit_status:
                    self._addEntry(root, basedir)

                self.__visitedDirs[basedir] = True
                
        c = DarcsAdd(working_dir=root)
        c(entry=entry)

        
    def _commit(self,root, date, author, remark, changelog=None, entries=None):
        """
        Commit the changeset.
        """

        c = DarcsRecord(working_dir=root)

        if entries:
            entries = ' '.join(entries)
        else:
            entries = '.'
            
        c(output=True, date=date, patchname=remark,
          logmessage=changelog, author=author, entries=entries)
        
    def _removeEntry(self, root, entry):
        """
        Remove an entry.
        """

        c = DarcsRemove(working_dir=root)
        c(entry=entry)

    def _renameEntry(self, root, oldentry, newentry):
        """
        Rename an entry.
        """

        c = DarcsMv(working_dir=root)
        c(old=oldentry, new=newentry)

    def _createTag(self, root, tagname):
        """
        Tag the current situation and remember this as the *last tag*.
        """

        from os.path import join, exists
        
        c = DarcsTag(working_dir=root)
        c(output=True, tagname=tagname)
        
        fname = join(root, '_darcs', 'last-sync-tag')
        f = open(fname, 'w')
        f.write(tagname)
        f.close()
        
    def _getLastTag(self, root):
        """
        Return the name of the last emitted tag, if any, otherwise None.
        """
        
        from os.path import join, exists
        
        fname = join(root, '_darcs', 'last-sync-tag')
        if exists(fname):
            f = open(fname)
            tagname = f.read()
            f.close()
            
            return tagname

    def _initializeWorkingDir(self, root, module):
        """
        Execute `darcs initialize`.
        """
        
        c = DarcsInitialize(working_dir=root)
        c(output=True)

        if c.exit_status:
            raise TargetInitializationFailure(
                "'darcs initialize' returned status %s" % c.exit_status)