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
 
 
21
from bzrlib.trace import mutter, note
 
 
22
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
 
 
23
     sha_file, appendpath, file_kind
 
 
24
from bzrlib.errors import BzrError
 
 
26
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
 
27
## TODO: Maybe include checks for common corruption of newlines, etc?
 
 
31
def find_branch(f, **args):
 
 
32
    if f and (f.startswith('http://') or f.startswith('https://')):
 
 
34
        return remotebranch.RemoteBranch(f, **args)
 
 
36
        return Branch(f, **args)
 
 
39
def find_cached_branch(f, cache_root, **args):
 
 
40
    from remotebranch import RemoteBranch
 
 
41
    br = find_branch(f, **args)
 
 
42
    def cacheify(br, store_name):
 
 
43
        from meta_store import CachedStore
 
 
44
        cache_path = os.path.join(cache_root, store_name)
 
 
46
        new_store = CachedStore(getattr(br, store_name), cache_path)
 
 
47
        setattr(br, store_name, new_store)
 
 
49
    if isinstance(br, RemoteBranch):
 
 
50
        cacheify(br, 'inventory_store')
 
 
51
        cacheify(br, 'text_store')
 
 
52
        cacheify(br, 'revision_store')
 
 
56
def _relpath(base, path):
 
 
57
    """Return path relative to base, or raise exception.
 
 
59
    The path may be either an absolute path or a path relative to the
 
 
60
    current working directory.
 
 
62
    Lifted out of Branch.relpath for ease of testing.
 
 
64
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
 
65
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
 
66
    avoids that problem."""
 
 
67
    rp = os.path.abspath(path)
 
 
71
    while len(head) >= len(base):
 
 
74
        head, tail = os.path.split(head)
 
 
78
        from errors import NotBranchError
 
 
79
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
 
84
def find_branch_root(f=None):
 
 
85
    """Find the branch root enclosing f, or pwd.
 
 
87
    f may be a filename or a URL.
 
 
89
    It is not necessary that f exists.
 
 
91
    Basically we keep looking up until we find the control directory or
 
 
95
    elif hasattr(os.path, 'realpath'):
 
 
96
        f = os.path.realpath(f)
 
 
98
        f = os.path.abspath(f)
 
 
99
    if not os.path.exists(f):
 
 
100
        raise BzrError('%r does not exist' % f)
 
 
106
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
 
108
        head, tail = os.path.split(f)
 
 
110
            # reached the root, whatever that may be
 
 
111
            raise BzrError('%r is not in a branch' % orig_f)
 
 
114
class DivergedBranches(Exception):
 
 
115
    def __init__(self, branch1, branch2):
 
 
116
        self.branch1 = branch1
 
 
117
        self.branch2 = branch2
 
 
118
        Exception.__init__(self, "These branches have diverged.")
 
 
121
class NoSuchRevision(BzrError):
 
 
122
    def __init__(self, branch, revision):
 
 
124
        self.revision = revision
 
 
125
        msg = "Branch %s has no revision %d" % (branch, revision)
 
 
126
        BzrError.__init__(self, msg)
 
 
129
######################################################################
 
 
132
class Branch(object):
 
 
133
    """Branch holding a history of revisions.
 
 
136
        Base directory of the branch.
 
 
142
        If _lock_mode is true, a positive count of the number of times the
 
 
146
        Lock object from bzrlib.lock.
 
 
153
    # Map some sort of prefix into a namespace
 
 
154
    # stuff like "revno:10", "revid:", etc.
 
 
155
    # This should match a prefix with a function which accepts
 
 
156
    REVISION_NAMESPACES = {}
 
 
158
    def __init__(self, base, init=False, find_root=True):
 
 
159
        """Create new branch object at a particular location.
 
 
161
        base -- Base directory for the branch.
 
 
163
        init -- If True, create new control files in a previously
 
 
164
             unversioned directory.  If False, the branch must already
 
 
167
        find_root -- If true and init is false, find the root of the
 
 
168
             existing branch containing base.
 
 
170
        In the test suite, creation of new trees is tested using the
 
 
171
        `ScratchBranch` class.
 
 
173
        from bzrlib.store import ImmutableStore
 
 
175
            self.base = os.path.realpath(base)
 
 
178
            self.base = find_branch_root(base)
 
 
180
            self.base = os.path.realpath(base)
 
 
181
            if not isdir(self.controlfilename('.')):
 
 
182
                from errors import NotBranchError
 
 
183
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
 
184
                                     ['use "bzr init" to initialize a new working tree',
 
 
185
                                      'current bzr can only operate from top-of-tree'])
 
 
188
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
 
189
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
 
190
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
 
194
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
 
201
        if self._lock_mode or self._lock:
 
 
202
            from warnings import warn
 
 
203
            warn("branch %r was not explicitly unlocked" % self)
 
 
208
    def lock_write(self):
 
 
210
            if self._lock_mode != 'w':
 
 
211
                from errors import LockError
 
 
212
                raise LockError("can't upgrade to a write lock from %r" %
 
 
214
            self._lock_count += 1
 
 
216
            from bzrlib.lock import WriteLock
 
 
218
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
 
219
            self._lock_mode = 'w'
 
 
226
            assert self._lock_mode in ('r', 'w'), \
 
 
227
                   "invalid lock mode %r" % self._lock_mode
 
 
228
            self._lock_count += 1
 
 
230
            from bzrlib.lock import ReadLock
 
 
232
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
 
233
            self._lock_mode = 'r'
 
 
239
        if not self._lock_mode:
 
 
240
            from errors import LockError
 
 
241
            raise LockError('branch %r is not locked' % (self))
 
 
243
        if self._lock_count > 1:
 
 
244
            self._lock_count -= 1
 
 
248
            self._lock_mode = self._lock_count = None
 
 
251
    def abspath(self, name):
 
 
252
        """Return absolute filename for something in the branch"""
 
 
253
        return os.path.join(self.base, name)
 
 
256
    def relpath(self, path):
 
 
257
        """Return path relative to this branch of something inside it.
 
 
259
        Raises an error if path is not in this branch."""
 
 
260
        return _relpath(self.base, path)
 
 
263
    def controlfilename(self, file_or_path):
 
 
264
        """Return location relative to branch."""
 
 
265
        if isinstance(file_or_path, basestring):
 
 
266
            file_or_path = [file_or_path]
 
 
267
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
 
270
    def controlfile(self, file_or_path, mode='r'):
 
 
271
        """Open a control file for this branch.
 
 
273
        There are two classes of file in the control directory: text
 
 
274
        and binary.  binary files are untranslated byte streams.  Text
 
 
275
        control files are stored with Unix newlines and in UTF-8, even
 
 
276
        if the platform or locale defaults are different.
 
 
278
        Controlfiles should almost never be opened in write mode but
 
 
279
        rather should be atomically copied and replaced using atomicfile.
 
 
282
        fn = self.controlfilename(file_or_path)
 
 
284
        if mode == 'rb' or mode == 'wb':
 
 
285
            return file(fn, mode)
 
 
286
        elif mode == 'r' or mode == 'w':
 
 
287
            # open in binary mode anyhow so there's no newline translation;
 
 
288
            # codecs uses line buffering by default; don't want that.
 
 
290
            return codecs.open(fn, mode + 'b', 'utf-8',
 
 
293
            raise BzrError("invalid controlfile mode %r" % mode)
 
 
297
    def _make_control(self):
 
 
298
        from bzrlib.inventory import Inventory
 
 
299
        from bzrlib.xml import pack_xml
 
 
301
        os.mkdir(self.controlfilename([]))
 
 
302
        self.controlfile('README', 'w').write(
 
 
303
            "This is a Bazaar-NG control directory.\n"
 
 
304
            "Do not change any files in this directory.\n")
 
 
305
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
 
306
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
 
307
            os.mkdir(self.controlfilename(d))
 
 
308
        for f in ('revision-history', 'merged-patches',
 
 
309
                  'pending-merged-patches', 'branch-name',
 
 
312
            self.controlfile(f, 'w').write('')
 
 
313
        mutter('created control directory in ' + self.base)
 
 
315
        pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
 
 
318
    def _check_format(self):
 
 
319
        """Check this branch format is supported.
 
 
321
        The current tool only supports the current unstable format.
 
 
323
        In the future, we might need different in-memory Branch
 
 
324
        classes to support downlevel branches.  But not yet.
 
 
326
        # This ignores newlines so that we can open branches created
 
 
327
        # on Windows from Linux and so on.  I think it might be better
 
 
328
        # to always make all internal files in unix format.
 
 
329
        fmt = self.controlfile('branch-format', 'r').read()
 
 
330
        fmt.replace('\r\n', '')
 
 
331
        if fmt != BZR_BRANCH_FORMAT:
 
 
332
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
 
333
                           ['use a different bzr version',
 
 
334
                            'or remove the .bzr directory and "bzr init" again'])
 
 
336
    def get_root_id(self):
 
 
337
        """Return the id of this branches root"""
 
 
338
        inv = self.read_working_inventory()
 
 
339
        return inv.root.file_id
 
 
341
    def set_root_id(self, file_id):
 
 
342
        inv = self.read_working_inventory()
 
 
343
        orig_root_id = inv.root.file_id
 
 
344
        del inv._byid[inv.root.file_id]
 
 
345
        inv.root.file_id = file_id
 
 
346
        inv._byid[inv.root.file_id] = inv.root
 
 
349
            if entry.parent_id in (None, orig_root_id):
 
 
350
                entry.parent_id = inv.root.file_id
 
 
351
        self._write_inventory(inv)
 
 
353
    def read_working_inventory(self):
 
 
354
        """Read the working inventory."""
 
 
355
        from bzrlib.inventory import Inventory
 
 
356
        from bzrlib.xml import unpack_xml
 
 
357
        from time import time
 
 
361
            # ElementTree does its own conversion from UTF-8, so open in
 
 
363
            inv = unpack_xml(Inventory,
 
 
364
                                  self.controlfile('inventory', 'rb'))
 
 
365
            mutter("loaded inventory of %d items in %f"
 
 
366
                   % (len(inv), time() - before))
 
 
372
    def _write_inventory(self, inv):
 
 
373
        """Update the working inventory.
 
 
375
        That is to say, the inventory describing changes underway, that
 
 
376
        will be committed to the next revision.
 
 
378
        from bzrlib.atomicfile import AtomicFile
 
 
379
        from bzrlib.xml import pack_xml
 
 
383
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
 
392
        mutter('wrote working inventory')
 
 
395
    inventory = property(read_working_inventory, _write_inventory, None,
 
 
396
                         """Inventory for the working copy.""")
 
 
399
    def add(self, files, verbose=False, ids=None):
 
 
400
        """Make files versioned.
 
 
402
        Note that the command line normally calls smart_add instead.
 
 
404
        This puts the files in the Added state, so that they will be
 
 
405
        recorded by the next commit.
 
 
408
            List of paths to add, relative to the base of the tree.
 
 
411
            If set, use these instead of automatically generated ids.
 
 
412
            Must be the same length as the list of files, but may
 
 
413
            contain None for ids that are to be autogenerated.
 
 
415
        TODO: Perhaps have an option to add the ids even if the files do
 
 
418
        TODO: Perhaps return the ids of the files?  But then again it
 
 
419
              is easy to retrieve them if they're needed.
 
 
421
        TODO: Adding a directory should optionally recurse down and
 
 
422
              add all non-ignored children.  Perhaps do that in a
 
 
425
        from bzrlib.textui import show_status
 
 
426
        # TODO: Re-adding a file that is removed in the working copy
 
 
427
        # should probably put it back with the previous ID.
 
 
428
        if isinstance(files, basestring):
 
 
429
            assert(ids is None or isinstance(ids, basestring))
 
 
435
            ids = [None] * len(files)
 
 
437
            assert(len(ids) == len(files))
 
 
441
            inv = self.read_working_inventory()
 
 
442
            for f,file_id in zip(files, ids):
 
 
443
                if is_control_file(f):
 
 
444
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
 
449
                    raise BzrError("cannot add top-level %r" % f)
 
 
451
                fullpath = os.path.normpath(self.abspath(f))
 
 
454
                    kind = file_kind(fullpath)
 
 
456
                    # maybe something better?
 
 
457
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
 
459
                if kind != 'file' and kind != 'directory':
 
 
460
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
 
463
                    file_id = gen_file_id(f)
 
 
464
                inv.add_path(f, kind=kind, file_id=file_id)
 
 
467
                    print 'added', quotefn(f)
 
 
469
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
 
471
            self._write_inventory(inv)
 
 
476
    def print_file(self, file, revno):
 
 
477
        """Print `file` to stdout."""
 
 
480
            tree = self.revision_tree(self.lookup_revision(revno))
 
 
481
            # use inventory as it was in that revision
 
 
482
            file_id = tree.inventory.path2id(file)
 
 
484
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
 
485
            tree.print_file(file_id)
 
 
490
    def remove(self, files, verbose=False):
 
 
491
        """Mark nominated files for removal from the inventory.
 
 
493
        This does not remove their text.  This does not run on 
 
 
495
        TODO: Refuse to remove modified files unless --force is given?
 
 
497
        TODO: Do something useful with directories.
 
 
499
        TODO: Should this remove the text or not?  Tough call; not
 
 
500
        removing may be useful and the user can just use use rm, and
 
 
501
        is the opposite of add.  Removing it is consistent with most
 
 
502
        other tools.  Maybe an option.
 
 
504
        from bzrlib.textui import show_status
 
 
505
        ## TODO: Normalize names
 
 
506
        ## TODO: Remove nested loops; better scalability
 
 
507
        if isinstance(files, basestring):
 
 
513
            tree = self.working_tree()
 
 
516
            # do this before any modifications
 
 
520
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
 
521
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
 
523
                    # having remove it, it must be either ignored or unknown
 
 
524
                    if tree.is_ignored(f):
 
 
528
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
 
531
            self._write_inventory(inv)
 
 
536
    # FIXME: this doesn't need to be a branch method
 
 
537
    def set_inventory(self, new_inventory_list):
 
 
538
        from bzrlib.inventory import Inventory, InventoryEntry
 
 
539
        inv = Inventory(self.get_root_id())
 
 
540
        for path, file_id, parent, kind in new_inventory_list:
 
 
541
            name = os.path.basename(path)
 
 
544
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
 
545
        self._write_inventory(inv)
 
 
549
        """Return all unknown files.
 
 
551
        These are files in the working directory that are not versioned or
 
 
552
        control files or ignored.
 
 
554
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
 
555
        >>> list(b.unknowns())
 
 
558
        >>> list(b.unknowns())
 
 
561
        >>> list(b.unknowns())
 
 
564
        return self.working_tree().unknowns()
 
 
567
    def append_revision(self, *revision_ids):
 
 
568
        from bzrlib.atomicfile import AtomicFile
 
 
570
        for revision_id in revision_ids:
 
 
571
            mutter("add {%s} to revision-history" % revision_id)
 
 
573
        rev_history = self.revision_history()
 
 
574
        rev_history.extend(revision_ids)
 
 
576
        f = AtomicFile(self.controlfilename('revision-history'))
 
 
578
            for rev_id in rev_history:
 
 
585
    def get_revision(self, revision_id):
 
 
586
        """Return the Revision object for a named revision"""
 
 
587
        from bzrlib.revision import Revision
 
 
588
        from bzrlib.xml import unpack_xml
 
 
592
            if not revision_id or not isinstance(revision_id, basestring):
 
 
593
                raise ValueError('invalid revision-id: %r' % revision_id)
 
 
594
            r = unpack_xml(Revision, self.revision_store[revision_id])
 
 
598
        assert r.revision_id == revision_id
 
 
602
    def get_revision_sha1(self, revision_id):
 
 
603
        """Hash the stored value of a revision, and return it."""
 
 
604
        # In the future, revision entries will be signed. At that
 
 
605
        # point, it is probably best *not* to include the signature
 
 
606
        # in the revision hash. Because that lets you re-sign
 
 
607
        # the revision, (add signatures/remove signatures) and still
 
 
608
        # have all hash pointers stay consistent.
 
 
609
        # But for now, just hash the contents.
 
 
610
        return sha_file(self.revision_store[revision_id])
 
 
613
    def get_inventory(self, inventory_id):
 
 
614
        """Get Inventory object by hash.
 
 
616
        TODO: Perhaps for this and similar methods, take a revision
 
 
617
               parameter which can be either an integer revno or a
 
 
619
        from bzrlib.inventory import Inventory
 
 
620
        from bzrlib.xml import unpack_xml
 
 
622
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
 
 
625
    def get_inventory_sha1(self, inventory_id):
 
 
626
        """Return the sha1 hash of the inventory entry
 
 
628
        return sha_file(self.inventory_store[inventory_id])
 
 
631
    def get_revision_inventory(self, revision_id):
 
 
632
        """Return inventory of a past revision."""
 
 
633
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
 
634
        # must be the same as its revision, so this is trivial.
 
 
635
        if revision_id == None:
 
 
636
            from bzrlib.inventory import Inventory
 
 
637
            return Inventory(self.get_root_id())
 
 
639
            return self.get_inventory(revision_id)
 
 
642
    def revision_history(self):
 
 
643
        """Return sequence of revision hashes on to this branch.
 
 
645
        >>> ScratchBranch().revision_history()
 
 
650
            return [l.rstrip('\r\n') for l in
 
 
651
                    self.controlfile('revision-history', 'r').readlines()]
 
 
656
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
 
659
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
 
660
        >>> sb.common_ancestor(sb) == (None, None)
 
 
662
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
 
663
        >>> sb.common_ancestor(sb)[0]
 
 
665
        >>> clone = sb.clone()
 
 
666
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
 
667
        >>> sb.common_ancestor(sb)[0]
 
 
669
        >>> sb.common_ancestor(clone)[0]
 
 
671
        >>> commit.commit(clone, "Committing divergent second revision", 
 
 
673
        >>> sb.common_ancestor(clone)[0]
 
 
675
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
 
677
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
 
679
        >>> clone2 = sb.clone()
 
 
680
        >>> sb.common_ancestor(clone2)[0]
 
 
682
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
 
684
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
 
687
        my_history = self.revision_history()
 
 
688
        other_history = other.revision_history()
 
 
689
        if self_revno is None:
 
 
690
            self_revno = len(my_history)
 
 
691
        if other_revno is None:
 
 
692
            other_revno = len(other_history)
 
 
693
        indices = range(min((self_revno, other_revno)))
 
 
696
            if my_history[r] == other_history[r]:
 
 
697
                return r+1, my_history[r]
 
 
700
    def enum_history(self, direction):
 
 
701
        """Return (revno, revision_id) for history of branch.
 
 
704
            'forward' is from earliest to latest
 
 
705
            'reverse' is from latest to earliest
 
 
707
        rh = self.revision_history()
 
 
708
        if direction == 'forward':
 
 
713
        elif direction == 'reverse':
 
 
719
            raise ValueError('invalid history direction', direction)
 
 
723
        """Return current revision number for this branch.
 
 
725
        That is equivalent to the number of revisions committed to
 
 
728
        return len(self.revision_history())
 
 
731
    def last_patch(self):
 
 
732
        """Return last patch hash, or None if no history.
 
 
734
        ph = self.revision_history()
 
 
741
    def missing_revisions(self, other, stop_revision=None):
 
 
743
        If self and other have not diverged, return a list of the revisions
 
 
744
        present in other, but missing from self.
 
 
746
        >>> from bzrlib.commit import commit
 
 
747
        >>> bzrlib.trace.silent = True
 
 
748
        >>> br1 = ScratchBranch()
 
 
749
        >>> br2 = ScratchBranch()
 
 
750
        >>> br1.missing_revisions(br2)
 
 
752
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
 
753
        >>> br1.missing_revisions(br2)
 
 
755
        >>> br2.missing_revisions(br1)
 
 
757
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
 
758
        >>> br1.missing_revisions(br2)
 
 
760
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
 
761
        >>> br1.missing_revisions(br2)
 
 
763
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
 
764
        >>> br1.missing_revisions(br2)
 
 
765
        Traceback (most recent call last):
 
 
766
        DivergedBranches: These branches have diverged.
 
 
768
        self_history = self.revision_history()
 
 
769
        self_len = len(self_history)
 
 
770
        other_history = other.revision_history()
 
 
771
        other_len = len(other_history)
 
 
772
        common_index = min(self_len, other_len) -1
 
 
773
        if common_index >= 0 and \
 
 
774
            self_history[common_index] != other_history[common_index]:
 
 
775
            raise DivergedBranches(self, other)
 
 
777
        if stop_revision is None:
 
 
778
            stop_revision = other_len
 
 
779
        elif stop_revision > other_len:
 
 
780
            raise NoSuchRevision(self, stop_revision)
 
 
782
        return other_history[self_len:stop_revision]
 
 
785
    def update_revisions(self, other, stop_revision=None):
 
 
786
        """Pull in all new revisions from other branch.
 
 
788
        >>> from bzrlib.commit import commit
 
 
789
        >>> bzrlib.trace.silent = True
 
 
790
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
 
793
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
 
794
        >>> br2 = ScratchBranch()
 
 
795
        >>> br2.update_revisions(br1)
 
 
799
        >>> br2.revision_history()
 
 
801
        >>> br2.update_revisions(br1)
 
 
805
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
 
808
        from bzrlib.progress import ProgressBar
 
 
812
            from sets import Set as set
 
 
816
        pb.update('comparing histories')
 
 
817
        revision_ids = self.missing_revisions(other, stop_revision)
 
 
819
        if hasattr(other.revision_store, "prefetch"):
 
 
820
            other.revision_store.prefetch(revision_ids)
 
 
821
        if hasattr(other.inventory_store, "prefetch"):
 
 
822
            inventory_ids = [other.get_revision(r).inventory_id
 
 
823
                             for r in revision_ids]
 
 
824
            other.inventory_store.prefetch(inventory_ids)
 
 
829
        for rev_id in revision_ids:
 
 
831
            pb.update('fetching revision', i, len(revision_ids))
 
 
832
            rev = other.get_revision(rev_id)
 
 
833
            revisions.append(rev)
 
 
834
            inv = other.get_inventory(str(rev.inventory_id))
 
 
835
            for key, entry in inv.iter_entries():
 
 
836
                if entry.text_id is None:
 
 
838
                if entry.text_id not in self.text_store:
 
 
839
                    needed_texts.add(entry.text_id)
 
 
843
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
 
844
        print "Added %d texts." % count 
 
 
845
        inventory_ids = [ f.inventory_id for f in revisions ]
 
 
846
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
 
848
        print "Added %d inventories." % count 
 
 
849
        revision_ids = [ f.revision_id for f in revisions]
 
 
850
        count = self.revision_store.copy_multi(other.revision_store, 
 
 
852
        for revision_id in revision_ids:
 
 
853
            self.append_revision(revision_id)
 
 
854
        print "Added %d revisions." % count
 
 
857
    def commit(self, *args, **kw):
 
 
858
        from bzrlib.commit import commit
 
 
859
        commit(self, *args, **kw)
 
 
862
    def lookup_revision(self, revision):
 
 
863
        """Return the revision identifier for a given revision information."""
 
 
864
        revno, info = self.get_revision_info(revision)
 
 
867
    def get_revision_info(self, revision):
 
 
868
        """Return (revno, revision id) for revision identifier.
 
 
870
        revision can be an integer, in which case it is assumed to be revno (though
 
 
871
            this will translate negative values into positive ones)
 
 
872
        revision can also be a string, in which case it is parsed for something like
 
 
873
            'date:' or 'revid:' etc.
 
 
878
        try:# Convert to int if possible
 
 
879
            revision = int(revision)
 
 
882
        revs = self.revision_history()
 
 
883
        if isinstance(revision, int):
 
 
886
            # Mabye we should do this first, but we don't need it if revision == 0
 
 
888
                revno = len(revs) + revision + 1
 
 
891
        elif isinstance(revision, basestring):
 
 
892
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
 
 
893
                if revision.startswith(prefix):
 
 
894
                    revno = func(self, revs, revision)
 
 
897
                raise BzrError('No namespace registered for string: %r' % revision)
 
 
899
        if revno is None or revno <= 0 or revno > len(revs):
 
 
900
            raise BzrError("no such revision %s" % revision)
 
 
901
        return revno, revs[revno-1]
 
 
903
    def _namespace_revno(self, revs, revision):
 
 
904
        """Lookup a revision by revision number"""
 
 
905
        assert revision.startswith('revno:')
 
 
907
            return int(revision[6:])
 
 
910
    REVISION_NAMESPACES['revno:'] = _namespace_revno
 
 
912
    def _namespace_revid(self, revs, revision):
 
 
913
        assert revision.startswith('revid:')
 
 
915
            return revs.index(revision[6:]) + 1
 
 
918
    REVISION_NAMESPACES['revid:'] = _namespace_revid
 
 
920
    def _namespace_last(self, revs, revision):
 
 
921
        assert revision.startswith('last:')
 
 
923
            offset = int(revision[5:])
 
 
928
                raise BzrError('You must supply a positive value for --revision last:XXX')
 
 
929
            return len(revs) - offset + 1
 
 
930
    REVISION_NAMESPACES['last:'] = _namespace_last
 
 
932
    def _namespace_tag(self, revs, revision):
 
 
933
        assert revision.startswith('tag:')
 
 
934
        raise BzrError('tag: namespace registered, but not implemented.')
 
 
935
    REVISION_NAMESPACES['tag:'] = _namespace_tag
 
 
937
    def _namespace_date(self, revs, revision):
 
 
938
        assert revision.startswith('date:')
 
 
940
        # Spec for date revisions:
 
 
942
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
 
 
943
        #   it can also start with a '+/-/='. '+' says match the first
 
 
944
        #   entry after the given date. '-' is match the first entry before the date
 
 
945
        #   '=' is match the first entry after, but still on the given date.
 
 
947
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
 
 
948
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
 
 
949
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
 
 
950
        #       May 13th, 2005 at 0:00
 
 
952
        #   So the proper way of saying 'give me all entries for today' is:
 
 
953
        #       -r {date:+today}:{date:-tomorrow}
 
 
954
        #   The default is '=' when not supplied
 
 
957
        if val[:1] in ('+', '-', '='):
 
 
958
            match_style = val[:1]
 
 
961
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
 
 
962
        if val.lower() == 'yesterday':
 
 
963
            dt = today - datetime.timedelta(days=1)
 
 
964
        elif val.lower() == 'today':
 
 
966
        elif val.lower() == 'tomorrow':
 
 
967
            dt = today + datetime.timedelta(days=1)
 
 
970
            # This should be done outside the function to avoid recompiling it.
 
 
971
            _date_re = re.compile(
 
 
972
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
 
 
974
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
 
 
976
            m = _date_re.match(val)
 
 
977
            if not m or (not m.group('date') and not m.group('time')):
 
 
978
                raise BzrError('Invalid revision date %r' % revision)
 
 
981
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
 
 
983
                year, month, day = today.year, today.month, today.day
 
 
985
                hour = int(m.group('hour'))
 
 
986
                minute = int(m.group('minute'))
 
 
987
                if m.group('second'):
 
 
988
                    second = int(m.group('second'))
 
 
992
                hour, minute, second = 0,0,0
 
 
994
            dt = datetime.datetime(year=year, month=month, day=day,
 
 
995
                    hour=hour, minute=minute, second=second)
 
 
999
        if match_style == '-':
 
 
1001
        elif match_style == '=':
 
 
1002
            last = dt + datetime.timedelta(days=1)
 
 
1005
            for i in range(len(revs)-1, -1, -1):
 
 
1006
                r = self.get_revision(revs[i])
 
 
1007
                # TODO: Handle timezone.
 
 
1008
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
 
1009
                if first >= dt and (last is None or dt >= last):
 
 
1012
            for i in range(len(revs)):
 
 
1013
                r = self.get_revision(revs[i])
 
 
1014
                # TODO: Handle timezone.
 
 
1015
                dt = datetime.datetime.fromtimestamp(r.timestamp)
 
 
1016
                if first <= dt and (last is None or dt <= last):
 
 
1018
    REVISION_NAMESPACES['date:'] = _namespace_date
 
 
1020
    def revision_tree(self, revision_id):
 
 
1021
        """Return Tree for a revision on this branch.
 
 
1023
        `revision_id` may be None for the null revision, in which case
 
 
1024
        an `EmptyTree` is returned."""
 
 
1025
        from bzrlib.tree import EmptyTree, RevisionTree
 
 
1026
        # TODO: refactor this to use an existing revision object
 
 
1027
        # so we don't need to read it in twice.
 
 
1028
        if revision_id == None:
 
 
1029
            return EmptyTree(self.get_root_id())
 
 
1031
            inv = self.get_revision_inventory(revision_id)
 
 
1032
            return RevisionTree(self.text_store, inv)
 
 
1035
    def working_tree(self):
 
 
1036
        """Return a `Tree` for the working copy."""
 
 
1037
        from workingtree import WorkingTree
 
 
1038
        return WorkingTree(self.base, self.read_working_inventory())
 
 
1041
    def basis_tree(self):
 
 
1042
        """Return `Tree` object for last revision.
 
 
1044
        If there are no revisions yet, return an `EmptyTree`.
 
 
1046
        from bzrlib.tree import EmptyTree, RevisionTree
 
 
1047
        r = self.last_patch()
 
 
1049
            return EmptyTree(self.get_root_id())
 
 
1051
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
 
1055
    def rename_one(self, from_rel, to_rel):
 
 
1058
        This can change the directory or the filename or both.
 
 
1062
            tree = self.working_tree()
 
 
1063
            inv = tree.inventory
 
 
1064
            if not tree.has_filename(from_rel):
 
 
1065
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
 
1066
            if tree.has_filename(to_rel):
 
 
1067
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
 
1069
            file_id = inv.path2id(from_rel)
 
 
1071
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
 
1073
            if inv.path2id(to_rel):
 
 
1074
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
 
1076
            to_dir, to_tail = os.path.split(to_rel)
 
 
1077
            to_dir_id = inv.path2id(to_dir)
 
 
1078
            if to_dir_id == None and to_dir != '':
 
 
1079
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
 
1081
            mutter("rename_one:")
 
 
1082
            mutter("  file_id    {%s}" % file_id)
 
 
1083
            mutter("  from_rel   %r" % from_rel)
 
 
1084
            mutter("  to_rel     %r" % to_rel)
 
 
1085
            mutter("  to_dir     %r" % to_dir)
 
 
1086
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
 
1088
            inv.rename(file_id, to_dir_id, to_tail)
 
 
1090
            print "%s => %s" % (from_rel, to_rel)
 
 
1092
            from_abs = self.abspath(from_rel)
 
 
1093
            to_abs = self.abspath(to_rel)
 
 
1095
                os.rename(from_abs, to_abs)
 
 
1097
                raise BzrError("failed to rename %r to %r: %s"
 
 
1098
                        % (from_abs, to_abs, e[1]),
 
 
1099
                        ["rename rolled back"])
 
 
1101
            self._write_inventory(inv)
 
 
1106
    def move(self, from_paths, to_name):
 
 
1109
        to_name must exist as a versioned directory.
 
 
1111
        If to_name exists and is a directory, the files are moved into
 
 
1112
        it, keeping their old names.  If it is a directory, 
 
 
1114
        Note that to_name is only the last component of the new name;
 
 
1115
        this doesn't change the directory.
 
 
1119
            ## TODO: Option to move IDs only
 
 
1120
            assert not isinstance(from_paths, basestring)
 
 
1121
            tree = self.working_tree()
 
 
1122
            inv = tree.inventory
 
 
1123
            to_abs = self.abspath(to_name)
 
 
1124
            if not isdir(to_abs):
 
 
1125
                raise BzrError("destination %r is not a directory" % to_abs)
 
 
1126
            if not tree.has_filename(to_name):
 
 
1127
                raise BzrError("destination %r not in working directory" % to_abs)
 
 
1128
            to_dir_id = inv.path2id(to_name)
 
 
1129
            if to_dir_id == None and to_name != '':
 
 
1130
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
 
1131
            to_dir_ie = inv[to_dir_id]
 
 
1132
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
 
1133
                raise BzrError("destination %r is not a directory" % to_abs)
 
 
1135
            to_idpath = inv.get_idpath(to_dir_id)
 
 
1137
            for f in from_paths:
 
 
1138
                if not tree.has_filename(f):
 
 
1139
                    raise BzrError("%r does not exist in working tree" % f)
 
 
1140
                f_id = inv.path2id(f)
 
 
1142
                    raise BzrError("%r is not versioned" % f)
 
 
1143
                name_tail = splitpath(f)[-1]
 
 
1144
                dest_path = appendpath(to_name, name_tail)
 
 
1145
                if tree.has_filename(dest_path):
 
 
1146
                    raise BzrError("destination %r already exists" % dest_path)
 
 
1147
                if f_id in to_idpath:
 
 
1148
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
 
1150
            # OK, so there's a race here, it's possible that someone will
 
 
1151
            # create a file in this interval and then the rename might be
 
 
1152
            # left half-done.  But we should have caught most problems.
 
 
1154
            for f in from_paths:
 
 
1155
                name_tail = splitpath(f)[-1]
 
 
1156
                dest_path = appendpath(to_name, name_tail)
 
 
1157
                print "%s => %s" % (f, dest_path)
 
 
1158
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
 
1160
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
 
1162
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
 
1163
                            ["rename rolled back"])
 
 
1165
            self._write_inventory(inv)
 
 
1170
    def revert(self, filenames, old_tree=None, backups=True):
 
 
1171
        """Restore selected files to the versions from a previous tree.
 
 
1174
            If true (default) backups are made of files before
 
 
1177
        from bzrlib.errors import NotVersionedError, BzrError
 
 
1178
        from bzrlib.atomicfile import AtomicFile
 
 
1179
        from bzrlib.osutils import backup_file
 
 
1181
        inv = self.read_working_inventory()
 
 
1182
        if old_tree is None:
 
 
1183
            old_tree = self.basis_tree()
 
 
1184
        old_inv = old_tree.inventory
 
 
1187
        for fn in filenames:
 
 
1188
            file_id = inv.path2id(fn)
 
 
1190
                raise NotVersionedError("not a versioned file", fn)
 
 
1191
            if not old_inv.has_id(file_id):
 
 
1192
                raise BzrError("file not present in old tree", fn, file_id)
 
 
1193
            nids.append((fn, file_id))
 
 
1195
        # TODO: Rename back if it was previously at a different location
 
 
1197
        # TODO: If given a directory, restore the entire contents from
 
 
1198
        # the previous version.
 
 
1200
        # TODO: Make a backup to a temporary file.
 
 
1202
        # TODO: If the file previously didn't exist, delete it?
 
 
1203
        for fn, file_id in nids:
 
 
1206
            f = AtomicFile(fn, 'wb')
 
 
1208
                f.write(old_tree.get_file(file_id).read())
 
 
1214
    def pending_merges(self):
 
 
1215
        """Return a list of pending merges.
 
 
1217
        These are revisions that have been merged into the working
 
 
1218
        directory but not yet committed.
 
 
1220
        cfn = self.controlfilename('pending-merges')
 
 
1221
        if not os.path.exists(cfn):
 
 
1224
        for l in self.controlfile('pending-merges', 'r').readlines():
 
 
1225
            p.append(l.rstrip('\n'))
 
 
1229
    def add_pending_merge(self, revision_id):
 
 
1230
        from bzrlib.revision import validate_revision_id
 
 
1232
        validate_revision_id(revision_id)
 
 
1234
        p = self.pending_merges()
 
 
1235
        if revision_id in p:
 
 
1237
        p.append(revision_id)
 
 
1238
        self.set_pending_merges(p)
 
 
1241
    def set_pending_merges(self, rev_list):
 
 
1242
        from bzrlib.atomicfile import AtomicFile
 
 
1245
            f = AtomicFile(self.controlfilename('pending-merges'))
 
 
1257
class ScratchBranch(Branch):
 
 
1258
    """Special test class: a branch that cleans up after itself.
 
 
1260
    >>> b = ScratchBranch()
 
 
1268
    def __init__(self, files=[], dirs=[], base=None):
 
 
1269
        """Make a test branch.
 
 
1271
        This creates a temporary directory and runs init-tree in it.
 
 
1273
        If any files are listed, they are created in the working copy.
 
 
1275
        from tempfile import mkdtemp
 
 
1280
        Branch.__init__(self, base, init=init)
 
 
1282
            os.mkdir(self.abspath(d))
 
 
1285
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
 
1290
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
 
1291
        >>> clone = orig.clone()
 
 
1292
        >>> os.path.samefile(orig.base, clone.base)
 
 
1294
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
 
1297
        from shutil import copytree
 
 
1298
        from tempfile import mkdtemp
 
 
1301
        copytree(self.base, base, symlinks=True)
 
 
1302
        return ScratchBranch(base=base)
 
 
1308
        """Destroy the test branch, removing the scratch directory."""
 
 
1309
        from shutil import rmtree
 
 
1312
                mutter("delete ScratchBranch %s" % self.base)
 
 
1315
            # Work around for shutil.rmtree failing on Windows when
 
 
1316
            # readonly files are encountered
 
 
1317
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
 
1318
            for root, dirs, files in os.walk(self.base, topdown=False):
 
 
1320
                    os.chmod(os.path.join(root, name), 0700)
 
 
1326
######################################################################
 
 
1330
def is_control_file(filename):
 
 
1331
    ## FIXME: better check
 
 
1332
    filename = os.path.normpath(filename)
 
 
1333
    while filename != '':
 
 
1334
        head, tail = os.path.split(filename)
 
 
1335
        ## mutter('check %r for control file' % ((head, tail), ))
 
 
1336
        if tail == bzrlib.BZRDIR:
 
 
1338
        if filename == head:
 
 
1345
def gen_file_id(name):
 
 
1346
    """Return new file id.
 
 
1348
    This should probably generate proper UUIDs, but for the moment we
 
 
1349
    cope with just randomness because running uuidgen every time is
 
 
1352
    from binascii import hexlify
 
 
1353
    from time import time
 
 
1355
    # get last component
 
 
1356
    idx = name.rfind('/')
 
 
1358
        name = name[idx+1 : ]
 
 
1359
    idx = name.rfind('\\')
 
 
1361
        name = name[idx+1 : ]
 
 
1363
    # make it not a hidden file
 
 
1364
    name = name.lstrip('.')
 
 
1366
    # remove any wierd characters; we don't escape them but rather
 
 
1367
    # just pull them out
 
 
1368
    name = re.sub(r'[^\w.]', '', name)
 
 
1370
    s = hexlify(rand_bytes(8))
 
 
1371
    return '-'.join((name, compact_date(time()), s))
 
 
1375
    """Return a new tree-root file id."""
 
 
1376
    return gen_file_id('TREE_ROOT')