1
# Copyright (C) 2005 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
 
21
import traceback, socket, fnmatch, difflib, time
 
 
22
from binascii import hexlify
 
 
25
from inventory import Inventory
 
 
26
from trace import mutter, note
 
 
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
 
 
28
from inventory import InventoryEntry, Inventory
 
 
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
 
 
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
 
 
31
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
 
32
from store import ImmutableStore
 
 
33
from revision import Revision
 
 
34
from errors import bailout, BzrError
 
 
35
from textui import show_status
 
 
36
from diff import diff_trees
 
 
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
 
39
## TODO: Maybe include checks for common corruption of newlines, etc?
 
 
43
def find_branch_root(f=None):
 
 
44
    """Find the branch root enclosing f, or pwd.
 
 
46
    It is not necessary that f exists.
 
 
48
    Basically we keep looking up until we find the control directory or
 
 
52
    elif hasattr(os.path, 'realpath'):
 
 
53
        f = os.path.realpath(f)
 
 
55
        f = os.path.abspath(f)
 
 
60
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
 
62
        head, tail = os.path.split(f)
 
 
64
            # reached the root, whatever that may be
 
 
65
            raise BzrError('%r is not in a branch' % orig_f)
 
 
70
######################################################################
 
 
74
    """Branch holding a history of revisions.
 
 
77
        Base directory of the branch.
 
 
81
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
 
82
        """Create new branch object at a particular location.
 
 
84
        base -- Base directory for the branch.
 
 
86
        init -- If True, create new control files in a previously
 
 
87
             unversioned directory.  If False, the branch must already
 
 
90
        find_root -- If true and init is false, find the root of the
 
 
91
             existing branch containing base.
 
 
93
        In the test suite, creation of new trees is tested using the
 
 
94
        `ScratchBranch` class.
 
 
97
            self.base = os.path.realpath(base)
 
 
100
            self.base = find_branch_root(base)
 
 
102
            self.base = os.path.realpath(base)
 
 
103
            if not isdir(self.controlfilename('.')):
 
 
104
                bailout("not a bzr branch: %s" % quotefn(base),
 
 
105
                        ['use "bzr init" to initialize a new working tree',
 
 
106
                         'current bzr can only operate from top-of-tree'])
 
 
110
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
 
111
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
 
112
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
 
116
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
 
123
    def lock(self, mode='w'):
 
 
124
        """Lock the on-disk branch, excluding other processes."""
 
 
130
                om = os.O_WRONLY | os.O_CREAT
 
 
135
                raise BzrError("invalid locking mode %r" % mode)
 
 
137
            # XXX: Old branches might not have the lock file, and
 
 
138
            # won't get one until someone does a write-mode command on
 
 
139
            # them or creates it by hand.
 
 
141
            lockfile = os.open(self.controlfilename('branch-lock'), om)
 
 
142
            fcntl.lockf(lockfile, lm)
 
 
144
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
 
 
146
                self._lockmode = None
 
 
148
            self._lockmode = mode
 
 
150
            warning("please write a locking method for platform %r" % sys.platform)
 
 
152
                self._lockmode = None
 
 
154
            self._lockmode = mode
 
 
157
    def _need_readlock(self):
 
 
158
        if self._lockmode not in ['r', 'w']:
 
 
159
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
 
 
161
    def _need_writelock(self):
 
 
162
        if self._lockmode not in ['w']:
 
 
163
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
 
166
    def abspath(self, name):
 
 
167
        """Return absolute filename for something in the branch"""
 
 
168
        return os.path.join(self.base, name)
 
 
171
    def relpath(self, path):
 
 
172
        """Return path relative to this branch of something inside it.
 
 
174
        Raises an error if path is not in this branch."""
 
 
175
        rp = os.path.realpath(path)
 
 
177
        if not rp.startswith(self.base):
 
 
178
            bailout("path %r is not within branch %r" % (rp, self.base))
 
 
179
        rp = rp[len(self.base):]
 
 
180
        rp = rp.lstrip(os.sep)
 
 
184
    def controlfilename(self, file_or_path):
 
 
185
        """Return location relative to branch."""
 
 
186
        if isinstance(file_or_path, types.StringTypes):
 
 
187
            file_or_path = [file_or_path]
 
 
188
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
 
191
    def controlfile(self, file_or_path, mode='r'):
 
 
192
        """Open a control file for this branch.
 
 
194
        There are two classes of file in the control directory: text
 
 
195
        and binary.  binary files are untranslated byte streams.  Text
 
 
196
        control files are stored with Unix newlines and in UTF-8, even
 
 
197
        if the platform or locale defaults are different.
 
 
200
        fn = self.controlfilename(file_or_path)
 
 
202
        if mode == 'rb' or mode == 'wb':
 
 
203
            return file(fn, mode)
 
 
204
        elif mode == 'r' or mode == 'w':
 
 
205
            # open in binary mode anyhow so there's no newline translation;
 
 
206
            # codecs uses line buffering by default; don't want that.
 
 
208
            return codecs.open(fn, mode + 'b', 'utf-8',
 
 
211
            raise BzrError("invalid controlfile mode %r" % mode)
 
 
215
    def _make_control(self):
 
 
216
        os.mkdir(self.controlfilename([]))
 
 
217
        self.controlfile('README', 'w').write(
 
 
218
            "This is a Bazaar-NG control directory.\n"
 
 
219
            "Do not change any files in this directory.")
 
 
220
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
 
221
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
 
222
            os.mkdir(self.controlfilename(d))
 
 
223
        for f in ('revision-history', 'merged-patches',
 
 
224
                  'pending-merged-patches', 'branch-name',
 
 
226
            self.controlfile(f, 'w').write('')
 
 
227
        mutter('created control directory in ' + self.base)
 
 
228
        Inventory().write_xml(self.controlfile('inventory','w'))
 
 
231
    def _check_format(self):
 
 
232
        """Check this branch format is supported.
 
 
234
        The current tool only supports the current unstable format.
 
 
236
        In the future, we might need different in-memory Branch
 
 
237
        classes to support downlevel branches.  But not yet.
 
 
239
        # This ignores newlines so that we can open branches created
 
 
240
        # on Windows from Linux and so on.  I think it might be better
 
 
241
        # to always make all internal files in unix format.
 
 
242
        fmt = self.controlfile('branch-format', 'r').read()
 
 
243
        fmt.replace('\r\n', '')
 
 
244
        if fmt != BZR_BRANCH_FORMAT:
 
 
245
            bailout('sorry, branch format %r not supported' % fmt,
 
 
246
                    ['use a different bzr version',
 
 
247
                     'or remove the .bzr directory and "bzr init" again'])
 
 
250
    def read_working_inventory(self):
 
 
251
        """Read the working inventory."""
 
 
252
        self._need_readlock()
 
 
254
        # ElementTree does its own conversion from UTF-8, so open in
 
 
256
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
 
257
        mutter("loaded inventory of %d items in %f"
 
 
258
               % (len(inv), time.time() - before))
 
 
262
    def _write_inventory(self, inv):
 
 
263
        """Update the working inventory.
 
 
265
        That is to say, the inventory describing changes underway, that
 
 
266
        will be committed to the next revision.
 
 
268
        self._need_writelock()
 
 
269
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
 
270
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
 
271
        tmpfname = self.controlfilename('inventory.tmp')
 
 
272
        tmpf = file(tmpfname, 'wb')
 
 
275
        inv_fname = self.controlfilename('inventory')
 
 
276
        if sys.platform == 'win32':
 
 
278
        os.rename(tmpfname, inv_fname)
 
 
279
        mutter('wrote working inventory')
 
 
282
    inventory = property(read_working_inventory, _write_inventory, None,
 
 
283
                         """Inventory for the working copy.""")
 
 
286
    def add(self, files, verbose=False):
 
 
287
        """Make files versioned.
 
 
289
        Note that the command line normally calls smart_add instead.
 
 
291
        This puts the files in the Added state, so that they will be
 
 
292
        recorded by the next commit.
 
 
294
        TODO: Perhaps have an option to add the ids even if the files do
 
 
297
        TODO: Perhaps return the ids of the files?  But then again it
 
 
298
               is easy to retrieve them if they're needed.
 
 
300
        TODO: Option to specify file id.
 
 
302
        TODO: Adding a directory should optionally recurse down and
 
 
303
               add all non-ignored children.  Perhaps do that in a
 
 
306
        >>> b = ScratchBranch(files=['foo'])
 
 
307
        >>> 'foo' in b.unknowns()
 
 
312
        >>> 'foo' in b.unknowns()
 
 
314
        >>> bool(b.inventory.path2id('foo'))
 
 
320
        Traceback (most recent call last):
 
 
322
        BzrError: ('foo is already versioned', [])
 
 
324
        >>> b.add(['nothere'])
 
 
325
        Traceback (most recent call last):
 
 
326
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
 
328
        self._need_writelock()
 
 
330
        # TODO: Re-adding a file that is removed in the working copy
 
 
331
        # should probably put it back with the previous ID.
 
 
332
        if isinstance(files, types.StringTypes):
 
 
335
        inv = self.read_working_inventory()
 
 
337
            if is_control_file(f):
 
 
338
                bailout("cannot add control file %s" % quotefn(f))
 
 
343
                bailout("cannot add top-level %r" % f)
 
 
345
            fullpath = os.path.normpath(self.abspath(f))
 
 
348
                kind = file_kind(fullpath)
 
 
350
                # maybe something better?
 
 
351
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
 
353
            if kind != 'file' and kind != 'directory':
 
 
354
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
 
356
            file_id = gen_file_id(f)
 
 
357
            inv.add_path(f, kind=kind, file_id=file_id)
 
 
360
                show_status('A', kind, quotefn(f))
 
 
362
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
 
364
        self._write_inventory(inv)
 
 
367
    def print_file(self, file, revno):
 
 
368
        """Print `file` to stdout."""
 
 
369
        self._need_readlock()
 
 
370
        tree = self.revision_tree(self.lookup_revision(revno))
 
 
371
        # use inventory as it was in that revision
 
 
372
        file_id = tree.inventory.path2id(file)
 
 
374
            bailout("%r is not present in revision %d" % (file, revno))
 
 
375
        tree.print_file(file_id)
 
 
378
    def remove(self, files, verbose=False):
 
 
379
        """Mark nominated files for removal from the inventory.
 
 
381
        This does not remove their text.  This does not run on 
 
 
383
        TODO: Refuse to remove modified files unless --force is given?
 
 
385
        >>> b = ScratchBranch(files=['foo'])
 
 
387
        >>> b.inventory.has_filename('foo')
 
 
390
        >>> b.working_tree().has_filename('foo')
 
 
392
        >>> b.inventory.has_filename('foo')
 
 
395
        >>> b = ScratchBranch(files=['foo'])
 
 
400
        >>> b.inventory.has_filename('foo') 
 
 
402
        >>> b.basis_tree().has_filename('foo') 
 
 
404
        >>> b.working_tree().has_filename('foo') 
 
 
407
        TODO: Do something useful with directories.
 
 
409
        TODO: Should this remove the text or not?  Tough call; not
 
 
410
        removing may be useful and the user can just use use rm, and
 
 
411
        is the opposite of add.  Removing it is consistent with most
 
 
412
        other tools.  Maybe an option.
 
 
414
        ## TODO: Normalize names
 
 
415
        ## TODO: Remove nested loops; better scalability
 
 
416
        self._need_writelock()
 
 
418
        if isinstance(files, types.StringTypes):
 
 
421
        tree = self.working_tree()
 
 
424
        # do this before any modifications
 
 
428
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
 
429
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
 
431
                # having remove it, it must be either ignored or unknown
 
 
432
                if tree.is_ignored(f):
 
 
436
                show_status(new_status, inv[fid].kind, quotefn(f))
 
 
439
        self._write_inventory(inv)
 
 
443
        """Return all unknown files.
 
 
445
        These are files in the working directory that are not versioned or
 
 
446
        control files or ignored.
 
 
448
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
 
449
        >>> list(b.unknowns())
 
 
452
        >>> list(b.unknowns())
 
 
455
        >>> list(b.unknowns())
 
 
458
        return self.working_tree().unknowns()
 
 
461
    def commit(self, message, timestamp=None, timezone=None,
 
 
464
        """Commit working copy as a new revision.
 
 
466
        The basic approach is to add all the file texts into the
 
 
467
        store, then the inventory, then make a new revision pointing
 
 
468
        to that inventory and store that.
 
 
470
        This is not quite safe if the working copy changes during the
 
 
471
        commit; for the moment that is simply not allowed.  A better
 
 
472
        approach is to make a temporary copy of the files before
 
 
473
        computing their hashes, and then add those hashes in turn to
 
 
474
        the inventory.  This should mean at least that there are no
 
 
475
        broken hash pointers.  There is no way we can get a snapshot
 
 
476
        of the whole directory at an instant.  This would also have to
 
 
477
        be robust against files disappearing, moving, etc.  So the
 
 
478
        whole thing is a bit hard.
 
 
480
        timestamp -- if not None, seconds-since-epoch for a
 
 
481
             postdated/predated commit.
 
 
483
        self._need_writelock()
 
 
485
        ## TODO: Show branch names
 
 
487
        # TODO: Don't commit if there are no changes, unless forced?
 
 
489
        # First walk over the working inventory; and both update that
 
 
490
        # and also build a new revision inventory.  The revision
 
 
491
        # inventory needs to hold the text-id, sha1 and size of the
 
 
492
        # actual file versions committed in the revision.  (These are
 
 
493
        # not present in the working inventory.)  We also need to
 
 
494
        # detect missing/deleted files, and remove them from the
 
 
497
        work_inv = self.read_working_inventory()
 
 
499
        basis = self.basis_tree()
 
 
500
        basis_inv = basis.inventory
 
 
502
        for path, entry in work_inv.iter_entries():
 
 
503
            ## TODO: Cope with files that have gone missing.
 
 
505
            ## TODO: Check that the file kind has not changed from the previous
 
 
506
            ## revision of this file (if any).
 
 
510
            p = self.abspath(path)
 
 
511
            file_id = entry.file_id
 
 
512
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
 
514
            if not os.path.exists(p):
 
 
515
                mutter("    file is missing, removing from inventory")
 
 
517
                    show_status('D', entry.kind, quotefn(path))
 
 
518
                missing_ids.append(file_id)
 
 
521
            # TODO: Handle files that have been deleted
 
 
523
            # TODO: Maybe a special case for empty files?  Seems a
 
 
524
            # waste to store them many times.
 
 
528
            if basis_inv.has_id(file_id):
 
 
529
                old_kind = basis_inv[file_id].kind
 
 
530
                if old_kind != entry.kind:
 
 
531
                    bailout("entry %r changed kind from %r to %r"
 
 
532
                            % (file_id, old_kind, entry.kind))
 
 
534
            if entry.kind == 'directory':
 
 
536
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
 
537
            elif entry.kind == 'file':
 
 
539
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
 
541
                content = file(p, 'rb').read()
 
 
543
                entry.text_sha1 = sha_string(content)
 
 
544
                entry.text_size = len(content)
 
 
546
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
 
548
                    and (old_ie.text_size == entry.text_size)
 
 
549
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
 
550
                    ## assert content == basis.get_file(file_id).read()
 
 
551
                    entry.text_id = basis_inv[file_id].text_id
 
 
552
                    mutter('    unchanged from previous text_id {%s}' %
 
 
556
                    entry.text_id = gen_file_id(entry.name)
 
 
557
                    self.text_store.add(content, entry.text_id)
 
 
558
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
 
562
                        elif (old_ie.name == entry.name
 
 
563
                              and old_ie.parent_id == entry.parent_id):
 
 
568
                        show_status(state, entry.kind, quotefn(path))
 
 
570
        for file_id in missing_ids:
 
 
571
            # have to do this later so we don't mess up the iterator.
 
 
572
            # since parents may be removed before their children we
 
 
575
            # FIXME: There's probably a better way to do this; perhaps
 
 
576
            # the workingtree should know how to filter itself.
 
 
577
            if work_inv.has_id(file_id):
 
 
578
                del work_inv[file_id]
 
 
581
        inv_id = rev_id = _gen_revision_id(time.time())
 
 
583
        inv_tmp = tempfile.TemporaryFile()
 
 
584
        inv.write_xml(inv_tmp)
 
 
586
        self.inventory_store.add(inv_tmp, inv_id)
 
 
587
        mutter('new inventory_id is {%s}' % inv_id)
 
 
589
        self._write_inventory(work_inv)
 
 
591
        if timestamp == None:
 
 
592
            timestamp = time.time()
 
 
594
        if committer == None:
 
 
595
            committer = username()
 
 
598
            timezone = local_time_offset()
 
 
600
        mutter("building commit log message")
 
 
601
        rev = Revision(timestamp=timestamp,
 
 
604
                       precursor = self.last_patch(),
 
 
609
        rev_tmp = tempfile.TemporaryFile()
 
 
610
        rev.write_xml(rev_tmp)
 
 
612
        self.revision_store.add(rev_tmp, rev_id)
 
 
613
        mutter("new revision_id is {%s}" % rev_id)
 
 
615
        ## XXX: Everything up to here can simply be orphaned if we abort
 
 
616
        ## the commit; it will leave junk files behind but that doesn't
 
 
619
        ## TODO: Read back the just-generated changeset, and make sure it
 
 
620
        ## applies and recreates the right state.
 
 
622
        ## TODO: Also calculate and store the inventory SHA1
 
 
623
        mutter("committing patch r%d" % (self.revno() + 1))
 
 
626
        self.append_revision(rev_id)
 
 
629
            note("commited r%d" % self.revno())
 
 
632
    def append_revision(self, revision_id):
 
 
633
        mutter("add {%s} to revision-history" % revision_id)
 
 
634
        rev_history = self.revision_history()
 
 
636
        tmprhname = self.controlfilename('revision-history.tmp')
 
 
637
        rhname = self.controlfilename('revision-history')
 
 
639
        f = file(tmprhname, 'wt')
 
 
640
        rev_history.append(revision_id)
 
 
641
        f.write('\n'.join(rev_history))
 
 
645
        if sys.platform == 'win32':
 
 
647
        os.rename(tmprhname, rhname)
 
 
651
    def get_revision(self, revision_id):
 
 
652
        """Return the Revision object for a named revision"""
 
 
653
        self._need_readlock()
 
 
654
        r = Revision.read_xml(self.revision_store[revision_id])
 
 
655
        assert r.revision_id == revision_id
 
 
659
    def get_inventory(self, inventory_id):
 
 
660
        """Get Inventory object by hash.
 
 
662
        TODO: Perhaps for this and similar methods, take a revision
 
 
663
               parameter which can be either an integer revno or a
 
 
665
        self._need_readlock()
 
 
666
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
 
670
    def get_revision_inventory(self, revision_id):
 
 
671
        """Return inventory of a past revision."""
 
 
672
        self._need_readlock()
 
 
673
        if revision_id == None:
 
 
676
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
 
679
    def revision_history(self):
 
 
680
        """Return sequence of revision hashes on to this branch.
 
 
682
        >>> ScratchBranch().revision_history()
 
 
685
        self._need_readlock()
 
 
686
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
 
 
690
        """Return current revision number for this branch.
 
 
692
        That is equivalent to the number of revisions committed to
 
 
695
        >>> b = ScratchBranch()
 
 
698
        >>> b.commit('no foo')
 
 
702
        return len(self.revision_history())
 
 
705
    def last_patch(self):
 
 
706
        """Return last patch hash, or None if no history.
 
 
708
        >>> ScratchBranch().last_patch() == None
 
 
711
        ph = self.revision_history()
 
 
718
    def lookup_revision(self, revno):
 
 
719
        """Return revision hash for revision number."""
 
 
724
            # list is 0-based; revisions are 1-based
 
 
725
            return self.revision_history()[revno-1]
 
 
727
            raise BzrError("no such revision %s" % revno)
 
 
730
    def revision_tree(self, revision_id):
 
 
731
        """Return Tree for a revision on this branch.
 
 
733
        `revision_id` may be None for the null revision, in which case
 
 
734
        an `EmptyTree` is returned."""
 
 
735
        self._need_readlock()
 
 
736
        if revision_id == None:
 
 
739
            inv = self.get_revision_inventory(revision_id)
 
 
740
            return RevisionTree(self.text_store, inv)
 
 
743
    def working_tree(self):
 
 
744
        """Return a `Tree` for the working copy."""
 
 
745
        return WorkingTree(self.base, self.read_working_inventory())
 
 
748
    def basis_tree(self):
 
 
749
        """Return `Tree` object for last revision.
 
 
751
        If there are no revisions yet, return an `EmptyTree`.
 
 
753
        >>> b = ScratchBranch(files=['foo'])
 
 
754
        >>> b.basis_tree().has_filename('foo')
 
 
756
        >>> b.working_tree().has_filename('foo')
 
 
759
        >>> b.commit('add foo')
 
 
760
        >>> b.basis_tree().has_filename('foo')
 
 
763
        r = self.last_patch()
 
 
767
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
 
771
    def write_log(self, show_timezone='original', verbose=False):
 
 
772
        """Write out human-readable log of commits to this branch
 
 
774
        utc -- If true, show dates in universal time, not local time."""
 
 
775
        self._need_readlock()
 
 
776
        ## TODO: Option to choose either original, utc or local timezone
 
 
779
        for p in self.revision_history():
 
 
781
            print 'revno:', revno
 
 
782
            ## TODO: Show hash if --id is given.
 
 
783
            ##print 'revision-hash:', p
 
 
784
            rev = self.get_revision(p)
 
 
785
            print 'committer:', rev.committer
 
 
786
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
 
789
            ## opportunistic consistency check, same as check_patch_chaining
 
 
790
            if rev.precursor != precursor:
 
 
791
                bailout("mismatched precursor!")
 
 
795
                print '  (no message)'
 
 
797
                for l in rev.message.split('\n'):
 
 
800
            if verbose == True and precursor != None:
 
 
801
                print 'changed files:'
 
 
802
                tree = self.revision_tree(p)
 
 
803
                prevtree = self.revision_tree(precursor)
 
 
805
                for file_state, fid, old_name, new_name, kind in \
 
 
806
                                        diff_trees(prevtree, tree, ):
 
 
807
                    if file_state == 'A' or file_state == 'M':
 
 
808
                        show_status(file_state, kind, new_name)
 
 
809
                    elif file_state == 'D':
 
 
810
                        show_status(file_state, kind, old_name)
 
 
811
                    elif file_state == 'R':
 
 
812
                        show_status(file_state, kind,
 
 
813
                            old_name + ' => ' + new_name)
 
 
819
    def rename_one(self, from_rel, to_rel):
 
 
822
        This can change the directory or the filename or both.
 
 
824
        self._need_writelock()
 
 
825
        tree = self.working_tree()
 
 
827
        if not tree.has_filename(from_rel):
 
 
828
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
 
829
        if tree.has_filename(to_rel):
 
 
830
            bailout("can't rename: new working file %r already exists" % to_rel)
 
 
832
        file_id = inv.path2id(from_rel)
 
 
834
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
 
836
        if inv.path2id(to_rel):
 
 
837
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
 
839
        to_dir, to_tail = os.path.split(to_rel)
 
 
840
        to_dir_id = inv.path2id(to_dir)
 
 
841
        if to_dir_id == None and to_dir != '':
 
 
842
            bailout("can't determine destination directory id for %r" % to_dir)
 
 
844
        mutter("rename_one:")
 
 
845
        mutter("  file_id    {%s}" % file_id)
 
 
846
        mutter("  from_rel   %r" % from_rel)
 
 
847
        mutter("  to_rel     %r" % to_rel)
 
 
848
        mutter("  to_dir     %r" % to_dir)
 
 
849
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
 
851
        inv.rename(file_id, to_dir_id, to_tail)
 
 
853
        print "%s => %s" % (from_rel, to_rel)
 
 
855
        from_abs = self.abspath(from_rel)
 
 
856
        to_abs = self.abspath(to_rel)
 
 
858
            os.rename(from_abs, to_abs)
 
 
860
            bailout("failed to rename %r to %r: %s"
 
 
861
                    % (from_abs, to_abs, e[1]),
 
 
862
                    ["rename rolled back"])
 
 
864
        self._write_inventory(inv)
 
 
868
    def move(self, from_paths, to_name):
 
 
871
        to_name must exist as a versioned directory.
 
 
873
        If to_name exists and is a directory, the files are moved into
 
 
874
        it, keeping their old names.  If it is a directory, 
 
 
876
        Note that to_name is only the last component of the new name;
 
 
877
        this doesn't change the directory.
 
 
879
        self._need_writelock()
 
 
880
        ## TODO: Option to move IDs only
 
 
881
        assert not isinstance(from_paths, basestring)
 
 
882
        tree = self.working_tree()
 
 
884
        to_abs = self.abspath(to_name)
 
 
885
        if not isdir(to_abs):
 
 
886
            bailout("destination %r is not a directory" % to_abs)
 
 
887
        if not tree.has_filename(to_name):
 
 
888
            bailout("destination %r not in working directory" % to_abs)
 
 
889
        to_dir_id = inv.path2id(to_name)
 
 
890
        if to_dir_id == None and to_name != '':
 
 
891
            bailout("destination %r is not a versioned directory" % to_name)
 
 
892
        to_dir_ie = inv[to_dir_id]
 
 
893
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
 
894
            bailout("destination %r is not a directory" % to_abs)
 
 
896
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
 
899
            if not tree.has_filename(f):
 
 
900
                bailout("%r does not exist in working tree" % f)
 
 
901
            f_id = inv.path2id(f)
 
 
903
                bailout("%r is not versioned" % f)
 
 
904
            name_tail = splitpath(f)[-1]
 
 
905
            dest_path = appendpath(to_name, name_tail)
 
 
906
            if tree.has_filename(dest_path):
 
 
907
                bailout("destination %r already exists" % dest_path)
 
 
908
            if f_id in to_idpath:
 
 
909
                bailout("can't move %r to a subdirectory of itself" % f)
 
 
911
        # OK, so there's a race here, it's possible that someone will
 
 
912
        # create a file in this interval and then the rename might be
 
 
913
        # left half-done.  But we should have caught most problems.
 
 
916
            name_tail = splitpath(f)[-1]
 
 
917
            dest_path = appendpath(to_name, name_tail)
 
 
918
            print "%s => %s" % (f, dest_path)
 
 
919
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
 
921
                os.rename(self.abspath(f), self.abspath(dest_path))
 
 
923
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
 
924
                        ["rename rolled back"])
 
 
926
        self._write_inventory(inv)
 
 
930
    def show_status(self, show_all=False):
 
 
931
        """Display single-line status for non-ignored working files.
 
 
933
        The list is show sorted in order by file name.
 
 
935
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
 
941
        >>> b.commit("add foo")
 
 
943
        >>> os.unlink(b.abspath('foo'))
 
 
947
        TODO: Get state for single files.
 
 
949
        self._need_readlock()
 
 
951
        # We have to build everything into a list first so that it can
 
 
952
        # sorted by name, incorporating all the different sources.
 
 
954
        # FIXME: Rather than getting things in random order and then sorting,
 
 
955
        # just step through in order.
 
 
957
        # Interesting case: the old ID for a file has been removed,
 
 
958
        # but a new file has been created under that name.
 
 
960
        old = self.basis_tree()
 
 
961
        new = self.working_tree()
 
 
963
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
 
965
                show_status(fs, kind,
 
 
966
                            oldname + ' => ' + newname)
 
 
967
            elif fs == 'A' or fs == 'M':
 
 
968
                show_status(fs, kind, newname)
 
 
970
                show_status(fs, kind, oldname)
 
 
973
                    show_status(fs, kind, newname)
 
 
976
                    show_status(fs, kind, newname)
 
 
978
                show_status(fs, kind, newname)
 
 
980
                bailout("weird file state %r" % ((fs, fid),))
 
 
984
class ScratchBranch(Branch):
 
 
985
    """Special test class: a branch that cleans up after itself.
 
 
987
    >>> b = ScratchBranch()
 
 
995
    def __init__(self, files=[], dirs=[]):
 
 
996
        """Make a test branch.
 
 
998
        This creates a temporary directory and runs init-tree in it.
 
 
1000
        If any files are listed, they are created in the working copy.
 
 
1002
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
 
1004
            os.mkdir(self.abspath(d))
 
 
1007
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
 
1011
        """Destroy the test branch, removing the scratch directory."""
 
 
1013
            shutil.rmtree(self.base)
 
 
1015
            # Work around for shutil.rmtree failing on Windows when
 
 
1016
            # readonly files are encountered
 
 
1017
            for root, dirs, files in os.walk(self.base, topdown=False):
 
 
1019
                    os.chmod(os.path.join(root, name), 0700)
 
 
1020
            shutil.rmtree(self.base)
 
 
1024
######################################################################
 
 
1028
def is_control_file(filename):
 
 
1029
    ## FIXME: better check
 
 
1030
    filename = os.path.normpath(filename)
 
 
1031
    while filename != '':
 
 
1032
        head, tail = os.path.split(filename)
 
 
1033
        ## mutter('check %r for control file' % ((head, tail), ))
 
 
1034
        if tail == bzrlib.BZRDIR:
 
 
1036
        if filename == head:
 
 
1043
def _gen_revision_id(when):
 
 
1044
    """Return new revision-id."""
 
 
1045
    s = '%s-%s-' % (user_email(), compact_date(when))
 
 
1046
    s += hexlify(rand_bytes(8))
 
 
1050
def gen_file_id(name):
 
 
1051
    """Return new file id.
 
 
1053
    This should probably generate proper UUIDs, but for the moment we
 
 
1054
    cope with just randomness because running uuidgen every time is
 
 
1056
    idx = name.rfind('/')
 
 
1058
        name = name[idx+1 : ]
 
 
1059
    idx = name.rfind('\\')
 
 
1061
        name = name[idx+1 : ]
 
 
1063
    name = name.lstrip('.')
 
 
1065
    s = hexlify(rand_bytes(8))
 
 
1066
    return '-'.join((name, compact_date(time.time()), s))