~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2005 Canonical Ltd

# 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

from sets import Set

import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile

import traceback, socket, fnmatch, difflib, time

from binascii import hexlify

import bzrlib

from inventory import Inventory

from trace import mutter, note

from tree import Tree, EmptyTree, RevisionTree, WorkingTree

from inventory import InventoryEntry, Inventory

from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \

     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \

     joinpath, sha_string, file_kind, local_time_offset, appendpath

from store import ImmutableStore

from revision import Revision

from errors import bailout, BzrError

from textui import show_status

from diff import diff_trees

BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"

## TODO: Maybe include checks for common corruption of newlines, etc?

def find_branch_root(f=None):

    """Find the branch root enclosing f, or pwd.

    It is not necessary that f exists.

    Basically we keep looking up until we find the control directory or

    run into the root."""

    if f == None:

        f = os.getcwd()

    elif hasattr(os.path, 'realpath'):

        f = os.path.realpath(f)

    else:

        f = os.path.abspath(f)

    orig_f = f

    while True:

        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):

            return f

        head, tail = os.path.split(f)

        if head == f:

            # reached the root, whatever that may be

            raise BzrError('%r is not in a branch' % orig_f)

        f = head

######################################################################

# branch objects

class Branch:

    """Branch holding a history of revisions.

    :todo: Perhaps use different stores for different classes of object,

           so that we can keep track of how much space each one uses,

           or garbage-collect them.

    :todo: Add a RemoteBranch subclass.  For the basic case of read-only

           HTTP access this should be very easy by, 

           just redirecting controlfile access into HTTP requests.

           We would need a RemoteStore working similarly.

    :todo: Keep the on-disk branch locked while the object exists.

    :todo: mkdir() method.

    """

    def __init__(self, base, init=False, find_root=True):

        """Create new branch object at a particular location.

        :param base: Base directory for the branch.

        :param init: If True, create new control files in a previously

             unversioned directory.  If False, the branch must already

             be versioned.

        :param find_root: If true and init is false, find the root of the

             existing branch containing base.

        In the test suite, creation of new trees is tested using the

        `ScratchBranch` class.

        """

        if init:

            self.base = os.path.realpath(base)

            self._make_control()

        elif find_root:

            self.base = find_branch_root(base)

        else:

            self.base = os.path.realpath(base)

            if not isdir(self.controlfilename('.')):

                bailout("not a bzr branch: %s" % quotefn(base),

                        ['use "bzr init" to initialize a new working tree',

                         'current bzr can only operate from top-of-tree'])

        self._check_format()

        self.text_store = ImmutableStore(self.controlfilename('text-store'))

        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))

        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))

    def __str__(self):

        return '%s(%r)' % (self.__class__.__name__, self.base)

    __repr__ = __str__

    def abspath(self, name):

        """Return absolute filename for something in the branch"""

        return os.path.join(self.base, name)

    def relpath(self, path):

        """Return path relative to this branch of something inside it.

        Raises an error if path is not in this branch."""

        rp = os.path.realpath(path)

        # FIXME: windows

        if not rp.startswith(self.base):

            bailout("path %r is not within branch %r" % (rp, self.base))

        rp = rp[len(self.base):]

        rp = rp.lstrip(os.sep)

        return rp

    def controlfilename(self, file_or_path):

        """Return location relative to branch."""

        if isinstance(file_or_path, types.StringTypes):

            file_or_path = [file_or_path]

        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)

    def controlfile(self, file_or_path, mode='r'):

        """Open a control file for this branch.

        There are two classes of file in the control directory: text

        and binary.  binary files are untranslated byte streams.  Text

        control files are stored with Unix newlines and in UTF-8, even

        if the platform or locale defaults are different.

        """

        fn = self.controlfilename(file_or_path)

        if mode == 'rb' or mode == 'wb':

            return file(fn, mode)

        elif mode == 'r' or mode == 'w':

            # open in binary mode anyhow so there's no newline translation

            import codecs

            return codecs.open(fn, mode + 'b', 'utf-8')

        else:

            raise BzrError("invalid controlfile mode %r" % mode)

    def _make_control(self):

        os.mkdir(self.controlfilename([]))

        self.controlfile('README', 'w').write(

            "This is a Bazaar-NG control directory.\n"

            "Do not change any files in this directory.")

        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)

        for d in ('text-store', 'inventory-store', 'revision-store'):

            os.mkdir(self.controlfilename(d))

        for f in ('revision-history', 'merged-patches',

                  'pending-merged-patches', 'branch-name'):

            self.controlfile(f, 'w').write('')

        mutter('created control directory in ' + self.base)

        Inventory().write_xml(self.controlfile('inventory','w'))

    def _check_format(self):

        """Check this branch format is supported.

        The current tool only supports the current unstable format.

        In the future, we might need different in-memory Branch

        classes to support downlevel branches.  But not yet.

        """

        # This ignores newlines so that we can open branches created

        # on Windows from Linux and so on.  I think it might be better

        # to always make all internal files in unix format.

        fmt = self.controlfile('branch-format', 'r').read()

        fmt.replace('\r\n', '')

        if fmt != BZR_BRANCH_FORMAT:

            bailout('sorry, branch format %r not supported' % fmt,

                    ['use a different bzr version',

                     'or remove the .bzr directory and "bzr init" again'])

    def read_working_inventory(self):

        """Read the working inventory."""

        before = time.time()

        # ElementTree does its own conversion from UTF-8, so open in

        # binary.

        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))

        mutter("loaded inventory of %d items in %f"

               % (len(inv), time.time() - before))

        return inv

    def _write_inventory(self, inv):

        """Update the working inventory.

        That is to say, the inventory describing changes underway, that

        will be committed to the next revision.

        """

        ## TODO: factor out to atomicfile?  is rename safe on windows?

        ## TODO: Maybe some kind of clean/dirty marker on inventory?

        tmpfname = self.controlfilename('inventory.tmp')

        tmpf = file(tmpfname, 'wb')

        inv.write_xml(tmpf)

        tmpf.close()

        inv_fname = self.controlfilename('inventory')

        if sys.platform == 'win32':

            os.remove(inv_fname)

        os.rename(tmpfname, inv_fname)

        mutter('wrote working inventory')

    inventory = property(read_working_inventory, _write_inventory, None,

                         """Inventory for the working copy.""")

    def add(self, files, verbose=False):

        """Make files versioned.

        Note that the command line normally calls smart_add instead.

        This puts the files in the Added state, so that they will be

        recorded by the next commit.

        :todo: Perhaps have an option to add the ids even if the files do

               not (yet) exist.

        :todo: Perhaps return the ids of the files?  But then again it

               is easy to retrieve them if they're needed.

        :todo: Option to specify file id.

        :todo: Adding a directory should optionally recurse down and

               add all non-ignored children.  Perhaps do that in a

               higher-level method.

        >>> b = ScratchBranch(files=['foo'])

        >>> 'foo' in b.unknowns()

        True

        >>> b.show_status()

        ?       foo

        >>> b.add('foo')

        >>> 'foo' in b.unknowns()

        False

        >>> bool(b.inventory.path2id('foo'))

        True

        >>> b.show_status()

        A       foo

        >>> b.add('foo')

        Traceback (most recent call last):

        ...

        BzrError: ('foo is already versioned', [])

        >>> b.add(['nothere'])

        Traceback (most recent call last):

        BzrError: ('cannot add: not a regular file or directory: nothere', [])

        """

        # TODO: Re-adding a file that is removed in the working copy

        # should probably put it back with the previous ID.

        if isinstance(files, types.StringTypes):

            files = [files]

        inv = self.read_working_inventory()

        for f in files:

            if is_control_file(f):

                bailout("cannot add control file %s" % quotefn(f))

            fp = splitpath(f)

            if len(fp) == 0:

                bailout("cannot add top-level %r" % f)

            fullpath = os.path.normpath(self.abspath(f))

            try:

                kind = file_kind(fullpath)

            except OSError:

                # maybe something better?

                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))

            if kind != 'file' and kind != 'directory':

                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))

            file_id = gen_file_id(f)

            inv.add_path(f, kind=kind, file_id=file_id)

            if verbose:

                show_status('A', kind, quotefn(f))

            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))

        self._write_inventory(inv)

    def print_file(self, file, revno):

        """Print `file` to stdout."""

        tree = self.revision_tree(self.lookup_revision(revno))

        # use inventory as it was in that revision

        file_id = tree.inventory.path2id(file)

        if not file_id:

            bailout("%r is not present in revision %d" % (file, revno))

        tree.print_file(file_id)

    def remove(self, files, verbose=False):

        """Mark nominated files for removal from the inventory.

        This does not remove their text.  This does not run on 

        :todo: Refuse to remove modified files unless --force is given?

        >>> b = ScratchBranch(files=['foo'])

        >>> b.add('foo')

        >>> b.inventory.has_filename('foo')

        True

        >>> b.remove('foo')

        >>> b.working_tree().has_filename('foo')

        True

        >>> b.inventory.has_filename('foo')

        False

        >>> b = ScratchBranch(files=['foo'])

        >>> b.add('foo')

        >>> b.commit('one')

        >>> b.remove('foo')

        >>> b.commit('two')

        >>> b.inventory.has_filename('foo') 

        False

        >>> b.basis_tree().has_filename('foo') 

        False

        >>> b.working_tree().has_filename('foo') 

        True

        :todo: Do something useful with directories.

        :todo: Should this remove the text or not?  Tough call; not

        removing may be useful and the user can just use use rm, and

        is the opposite of add.  Removing it is consistent with most

        other tools.  Maybe an option.

        """

        ## TODO: Normalize names

        ## TODO: Remove nested loops; better scalability

        if isinstance(files, types.StringTypes):

            files = [files]

        tree = self.working_tree()

        inv = tree.inventory

        # do this before any modifications

        for f in files:

            fid = inv.path2id(f)

            if not fid:

                bailout("cannot remove unversioned file %s" % quotefn(f))

            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))

            if verbose:

                # having remove it, it must be either ignored or unknown

                if tree.is_ignored(f):

                    new_status = 'I'

                else:

                    new_status = '?'

                show_status(new_status, inv[fid].kind, quotefn(f))

            del inv[fid]

        self._write_inventory(inv)

    def unknowns(self):

        """Return all unknown files.

        These are files in the working directory that are not versioned or

        control files or ignored.

        >>> b = ScratchBranch(files=['foo', 'foo~'])

        >>> list(b.unknowns())

        ['foo']

        >>> b.add('foo')

        >>> list(b.unknowns())

        []

        >>> b.remove('foo')

        >>> list(b.unknowns())

        ['foo']

        """

        return self.working_tree().unknowns()

    def commit(self, message, timestamp=None, timezone=None,

               committer=None,

               verbose=False):

        """Commit working copy as a new revision.

        The basic approach is to add all the file texts into the

        store, then the inventory, then make a new revision pointing

        to that inventory and store that.

        This is not quite safe if the working copy changes during the

        commit; for the moment that is simply not allowed.  A better

        approach is to make a temporary copy of the files before

        computing their hashes, and then add those hashes in turn to

        the inventory.  This should mean at least that there are no

        broken hash pointers.  There is no way we can get a snapshot

        of the whole directory at an instant.  This would also have to

        be robust against files disappearing, moving, etc.  So the

        whole thing is a bit hard.

        :param timestamp: if not None, seconds-since-epoch for a

             postdated/predated commit.

        """

        ## TODO: Show branch names

        # TODO: Don't commit if there are no changes, unless forced?

        # First walk over the working inventory; and both update that

        # and also build a new revision inventory.  The revision

        # inventory needs to hold the text-id, sha1 and size of the

        # actual file versions committed in the revision.  (These are

        # not present in the working inventory.)  We also need to

        # detect missing/deleted files, and remove them from the

        # working inventory.

        work_inv = self.read_working_inventory()

        inv = Inventory()

        basis = self.basis_tree()

        basis_inv = basis.inventory

        missing_ids = []

        for path, entry in work_inv.iter_entries():

            ## TODO: Cope with files that have gone missing.

            ## TODO: Check that the file kind has not changed from the previous

            ## revision of this file (if any).

            entry = entry.copy()

            p = self.abspath(path)

            file_id = entry.file_id

            mutter('commit prep file %s, id %r ' % (p, file_id))

            if not os.path.exists(p):

                mutter("    file is missing, removing from inventory")

                if verbose:

                    show_status('D', entry.kind, quotefn(path))

                missing_ids.append(file_id)

                continue

            # TODO: Handle files that have been deleted

            # TODO: Maybe a special case for empty files?  Seems a

            # waste to store them many times.

            inv.add(entry)

            if basis_inv.has_id(file_id):

                old_kind = basis_inv[file_id].kind

                if old_kind != entry.kind:

                    bailout("entry %r changed kind from %r to %r"

                            % (file_id, old_kind, entry.kind))

            if entry.kind == 'directory':

                if not isdir(p):

                    bailout("%s is entered as directory but not a directory" % quotefn(p))

            elif entry.kind == 'file':

                if not isfile(p):

                    bailout("%s is entered as file but is not a file" % quotefn(p))

                content = file(p, 'rb').read()

                entry.text_sha1 = sha_string(content)

                entry.text_size = len(content)

                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]

                if (old_ie

                    and (old_ie.text_size == entry.text_size)

                    and (old_ie.text_sha1 == entry.text_sha1)):

                    ## assert content == basis.get_file(file_id).read()

                    entry.text_id = basis_inv[file_id].text_id

                    mutter('    unchanged from previous text_id {%s}' %

                           entry.text_id)

                else:

                    entry.text_id = gen_file_id(entry.name)

                    self.text_store.add(content, entry.text_id)

                    mutter('    stored with text_id {%s}' % entry.text_id)

                    if verbose:

                        if not old_ie:

                            state = 'A'

                        elif (old_ie.name == entry.name

                              and old_ie.parent_id == entry.parent_id):

                            state = 'M'

                        else:

                            state = 'R'

                        show_status(state, entry.kind, quotefn(path))

        for file_id in missing_ids:

            # have to do this later so we don't mess up the iterator.

            # since parents may be removed before their children we

            # have to test.

            # FIXME: There's probably a better way to do this; perhaps

            # the workingtree should know how to filter itself.

            if work_inv.has_id(file_id):

                del work_inv[file_id]

        inv_id = rev_id = _gen_revision_id(time.time())

        inv_tmp = tempfile.TemporaryFile()

        inv.write_xml(inv_tmp)

        inv_tmp.seek(0)

        self.inventory_store.add(inv_tmp, inv_id)

        mutter('new inventory_id is {%s}' % inv_id)

        self._write_inventory(work_inv)

        if timestamp == None:

            timestamp = time.time()

        if committer == None:

            committer = username()

        if timezone == None:

            timezone = local_time_offset()

        mutter("building commit log message")

        rev = Revision(timestamp=timestamp,

                       timezone=timezone,

                       committer=committer,

                       precursor = self.last_patch(),

                       message = message,

                       inventory_id=inv_id,

                       revision_id=rev_id)

        rev_tmp = tempfile.TemporaryFile()

        rev.write_xml(rev_tmp)

        rev_tmp.seek(0)

        self.revision_store.add(rev_tmp, rev_id)

        mutter("new revision_id is {%s}" % rev_id)

        ## XXX: Everything up to here can simply be orphaned if we abort

        ## the commit; it will leave junk files behind but that doesn't

        ## matter.

        ## TODO: Read back the just-generated changeset, and make sure it

        ## applies and recreates the right state.

        ## TODO: Also calculate and store the inventory SHA1

        mutter("committing patch r%d" % (self.revno() + 1))

        self.append_revision(rev_id)

        if verbose:

            note("commited r%d" % self.revno())

    def append_revision(self, revision_id):

        mutter("add {%s} to revision-history" % revision_id)

        rev_history = self.revision_history()

        tmprhname = self.controlfilename('revision-history.tmp')

        rhname = self.controlfilename('revision-history')

        f = file(tmprhname, 'wt')

        rev_history.append(revision_id)

        f.write('\n'.join(rev_history))

        f.write('\n')

        f.close()

        if sys.platform == 'win32':

            os.remove(rhname)

        os.rename(tmprhname, rhname)

    def get_revision(self, revision_id):

        """Return the Revision object for a named revision"""

        r = Revision.read_xml(self.revision_store[revision_id])

        assert r.revision_id == revision_id

        return r

    def get_inventory(self, inventory_id):

        """Get Inventory object by hash.

        :todo: Perhaps for this and similar methods, take a revision

               parameter which can be either an integer revno or a

               string hash."""

        i = Inventory.read_xml(self.inventory_store[inventory_id])

        return i

    def get_revision_inventory(self, revision_id):

        """Return inventory of a past revision."""

        if revision_id == None:

            return Inventory()

        else:

            return self.get_inventory(self.get_revision(revision_id).inventory_id)

    def revision_history(self):

        """Return sequence of revision hashes on to this branch.

        >>> ScratchBranch().revision_history()

        []

        """

        return [chomp(l) for l in self.controlfile('revision-history', 'r').readlines()]

    def revno(self):

        """Return current revision number for this branch.

        That is equivalent to the number of revisions committed to

        this branch.

        >>> b = ScratchBranch()

        >>> b.revno()

        0

        >>> b.commit('no foo')

        >>> b.revno()

        1

        """

        return len(self.revision_history())

    def last_patch(self):

        """Return last patch hash, or None if no history.

        >>> ScratchBranch().last_patch() == None

        True

        """

        ph = self.revision_history()

        if ph:

            return ph[-1]

        else:

            return None

    def lookup_revision(self, revno):

        """Return revision hash for revision number."""

        if revno == 0:

            return None

        try:

            # list is 0-based; revisions are 1-based

            return self.revision_history()[revno-1]

        except IndexError:

            raise BzrError("no such revision %s" % revno)

    def revision_tree(self, revision_id):

        """Return Tree for a revision on this branch.

        `revision_id` may be None for the null revision, in which case

        an `EmptyTree` is returned."""

        if revision_id == None:

            return EmptyTree()

        else:

            inv = self.get_revision_inventory(revision_id)

            return RevisionTree(self.text_store, inv)

    def working_tree(self):

        """Return a `Tree` for the working copy."""

        return WorkingTree(self.base, self.read_working_inventory())

    def basis_tree(self):

        """Return `Tree` object for last revision.

        If there are no revisions yet, return an `EmptyTree`.

        >>> b = ScratchBranch(files=['foo'])

        >>> b.basis_tree().has_filename('foo')

        False

        >>> b.working_tree().has_filename('foo')

        True

        >>> b.add('foo')

        >>> b.commit('add foo')

        >>> b.basis_tree().has_filename('foo')

        True

        """

        r = self.last_patch()

        if r == None:

            return EmptyTree()

        else:

            return RevisionTree(self.text_store, self.get_revision_inventory(r))

    def write_log(self, show_timezone='original', verbose=False):

        """Write out human-readable log of commits to this branch

        :param utc: If true, show dates in universal time, not local time."""

        ## TODO: Option to choose either original, utc or local timezone

        revno = 1

        precursor = None

        for p in self.revision_history():

            print '-' * 40

            print 'revno:', revno

            ## TODO: Show hash if --id is given.

            ##print 'revision-hash:', p

            rev = self.get_revision(p)

            print 'committer:', rev.committer

            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,

                                                 show_timezone))

            ## opportunistic consistency check, same as check_patch_chaining

            if rev.precursor != precursor:

                bailout("mismatched precursor!")

            print 'message:'

            if not rev.message:

                print '  (no message)'

            else:

                for l in rev.message.split('\n'):

                    print '  ' + l

            if verbose == True and precursor != None:

                print 'changed files:'

                tree = self.revision_tree(p)

                prevtree = self.revision_tree(precursor)

                for file_state, fid, old_name, new_name, kind in \

                                        diff_trees(prevtree, tree, ):

                    if file_state == 'A' or file_state == 'M':

                        show_status(file_state, kind, new_name)

                    elif file_state == 'D':

                        show_status(file_state, kind, old_name)

                    elif file_state == 'R':

                        show_status(file_state, kind,

                            old_name + ' => ' + new_name)

            revno += 1

            precursor = p

    def rename_one(self, from_rel, to_rel):

        tree = self.working_tree()

        inv = tree.inventory

        if not tree.has_filename(from_rel):

            bailout("can't rename: old working file %r does not exist" % from_rel)

        if tree.has_filename(to_rel):

            bailout("can't rename: new working file %r already exists" % to_rel)

        file_id = inv.path2id(from_rel)

        if file_id == None:

            bailout("can't rename: old name %r is not versioned" % from_rel)

        if inv.path2id(to_rel):

            bailout("can't rename: new name %r is already versioned" % to_rel)

        to_dir, to_tail = os.path.split(to_rel)

        to_dir_id = inv.path2id(to_dir)

        if to_dir_id == None and to_dir != '':

            bailout("can't determine destination directory id for %r" % to_dir)