/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-09-29 00:24:44 UTC
  • Revision ID: robertc@robertcollins.net-20050929002444-76fe66e99fb9bcd5
reinstate testfetch test case

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
import sys
19
19
import os
 
20
import errno
 
21
from warnings import warn
 
22
 
20
23
 
21
24
import bzrlib
22
25
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
 
import bzrlib.errors
 
26
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes, 
 
27
                            rename, splitpath, sha_file, appendpath, 
 
28
                            file_kind)
 
29
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
30
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
31
                           DivergedBranches, LockError, UnlistableStore,
 
32
                           UnlistableBranch)
28
33
from bzrlib.textui import show_status
29
 
from bzrlib.revision import Revision
30
 
from bzrlib.xml import unpack_xml
 
34
from bzrlib.revision import Revision, validate_revision_id, is_ancestor
31
35
from bzrlib.delta import compare_trees
32
36
from bzrlib.tree import EmptyTree, RevisionTree
33
 
        
34
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
37
from bzrlib.inventory import Inventory
 
38
from bzrlib.weavestore import WeaveStore
 
39
from bzrlib.store import copy_all, ImmutableStore
 
40
import bzrlib.xml5
 
41
import bzrlib.ui
 
42
 
 
43
 
 
44
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
45
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
35
46
## TODO: Maybe include checks for common corruption of newlines, etc?
36
47
 
37
48
 
38
49
# TODO: Some operations like log might retrieve the same revisions
39
50
# repeatedly to calculate deltas.  We could perhaps have a weakref
40
 
# cache in memory to make this faster.
41
 
 
42
 
 
43
 
def find_branch(f, **args):
44
 
    if f and (f.startswith('http://') or f.startswith('https://')):
45
 
        import remotebranch 
46
 
        return remotebranch.RemoteBranch(f, **args)
47
 
    else:
48
 
        return Branch(f, **args)
49
 
 
50
 
 
51
 
def find_cached_branch(f, cache_root, **args):
52
 
    from remotebranch import RemoteBranch
53
 
    br = find_branch(f, **args)
54
 
    def cacheify(br, store_name):
55
 
        from meta_store import CachedStore
56
 
        cache_path = os.path.join(cache_root, store_name)
57
 
        os.mkdir(cache_path)
58
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
59
 
        setattr(br, store_name, new_store)
60
 
 
61
 
    if isinstance(br, RemoteBranch):
62
 
        cacheify(br, 'inventory_store')
63
 
        cacheify(br, 'text_store')
64
 
        cacheify(br, 'revision_store')
65
 
    return br
66
 
 
 
51
# cache in memory to make this faster.  In general anything can be
 
52
# cached in memory between lock and unlock operations.
 
53
 
 
54
def find_branch(*ignored, **ignored_too):
 
55
    # XXX: leave this here for about one release, then remove it
 
56
    raise NotImplementedError('find_branch() is not supported anymore, '
 
57
                              'please use one of the new branch constructors')
67
58
 
68
59
def _relpath(base, path):
69
60
    """Return path relative to base, or raise exception.
87
78
        if tail:
88
79
            s.insert(0, tail)
89
80
    else:
90
 
        from errors import NotBranchError
91
81
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
82
 
93
83
    return os.sep.join(s)
101
91
    It is not necessary that f exists.
102
92
 
103
93
    Basically we keep looking up until we find the control directory or
104
 
    run into the root."""
 
94
    run into the root.  If there isn't one, raises NotBranchError.
 
95
    """
105
96
    if f == None:
106
97
        f = os.getcwd()
107
98
    elif hasattr(os.path, 'realpath'):
120
111
        head, tail = os.path.split(f)
121
112
        if head == f:
122
113
            # reached the root, whatever that may be
123
 
            raise BzrError('%r is not in a branch' % orig_f)
 
114
            raise NotBranchError('%s is not in a branch' % orig_f)
124
115
        f = head
125
 
    
126
 
class DivergedBranches(Exception):
127
 
    def __init__(self, branch1, branch2):
128
 
        self.branch1 = branch1
129
 
        self.branch2 = branch2
130
 
        Exception.__init__(self, "These branches have diverged.")
 
116
 
 
117
 
131
118
 
132
119
 
133
120
######################################################################
137
124
    """Branch holding a history of revisions.
138
125
 
139
126
    base
140
 
        Base directory of the branch.
 
127
        Base directory/url of the branch.
 
128
    """
 
129
    base = None
 
130
 
 
131
    def __init__(self, *ignored, **ignored_too):
 
132
        raise NotImplementedError('The Branch class is abstract')
 
133
 
 
134
    @staticmethod
 
135
    def open(base):
 
136
        """Open an existing branch, rooted at 'base' (url)"""
 
137
        if base and (base.startswith('http://') or base.startswith('https://')):
 
138
            from bzrlib.remotebranch import RemoteBranch
 
139
            return RemoteBranch(base, find_root=False)
 
140
        else:
 
141
            return LocalBranch(base, find_root=False)
 
142
 
 
143
    @staticmethod
 
144
    def open_containing(url):
 
145
        """Open an existing branch which contains url.
 
146
        
 
147
        This probes for a branch at url, and searches upwards from there.
 
148
        """
 
149
        if url and (url.startswith('http://') or url.startswith('https://')):
 
150
            from bzrlib.remotebranch import RemoteBranch
 
151
            return RemoteBranch(url)
 
152
        else:
 
153
            return LocalBranch(url)
 
154
 
 
155
    @staticmethod
 
156
    def initialize(base):
 
157
        """Create a new branch, rooted at 'base' (url)"""
 
158
        if base and (base.startswith('http://') or base.startswith('https://')):
 
159
            from bzrlib.remotebranch import RemoteBranch
 
160
            return RemoteBranch(base, init=True)
 
161
        else:
 
162
            return LocalBranch(base, init=True)
 
163
 
 
164
    def setup_caching(self, cache_root):
 
165
        """Subclasses that care about caching should override this, and set
 
166
        up cached stores located under cache_root.
 
167
        """
 
168
 
 
169
 
 
170
class LocalBranch(Branch):
 
171
    """A branch stored in the actual filesystem.
 
172
 
 
173
    Note that it's "local" in the context of the filesystem; it doesn't
 
174
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
175
    it's writable, and can be accessed via the normal filesystem API.
141
176
 
142
177
    _lock_mode
143
178
        None, or 'r' or 'w'
149
184
    _lock
150
185
        Lock object from bzrlib.lock.
151
186
    """
152
 
    base = None
 
187
    # We actually expect this class to be somewhat short-lived; part of its
 
188
    # purpose is to try to isolate what bits of the branch logic are tied to
 
189
    # filesystem access, so that in a later step, we can extricate them to
 
190
    # a separarte ("storage") class.
153
191
    _lock_mode = None
154
192
    _lock_count = None
155
193
    _lock = None
 
194
    _inventory_weave = None
156
195
    
157
196
    # Map some sort of prefix into a namespace
158
197
    # stuff like "revno:10", "revid:", etc.
159
198
    # This should match a prefix with a function which accepts
160
199
    REVISION_NAMESPACES = {}
161
200
 
162
 
    def __init__(self, base, init=False, find_root=True):
 
201
    def push_stores(self, branch_to):
 
202
        """Copy the content of this branches store to branch_to."""
 
203
        if (self._branch_format != branch_to._branch_format
 
204
            or self._branch_format != 4):
 
205
            from bzrlib.fetch import greedy_fetch
 
206
            mutter("falling back to fetch logic to push between %s and %s",
 
207
                   self, branch_to)
 
208
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
209
                         revision=self.last_revision())
 
210
            return
 
211
 
 
212
        store_pairs = ((self.text_store,      branch_to.text_store),
 
213
                       (self.inventory_store, branch_to.inventory_store),
 
214
                       (self.revision_store,  branch_to.revision_store))
 
215
        try:
 
216
            for from_store, to_store in store_pairs: 
 
217
                copy_all(from_store, to_store)
 
218
        except UnlistableStore:
 
219
            raise UnlistableBranch(from_store)
 
220
 
 
221
    def __init__(self, base, init=False, find_root=True,
 
222
                 relax_version_check=False):
163
223
        """Create new branch object at a particular location.
164
224
 
165
 
        base -- Base directory for the branch.
 
225
        base -- Base directory for the branch. May be a file:// url.
166
226
        
167
227
        init -- If True, create new control files in a previously
168
228
             unversioned directory.  If False, the branch must already
171
231
        find_root -- If true and init is false, find the root of the
172
232
             existing branch containing base.
173
233
 
 
234
        relax_version_check -- If true, the usual check for the branch
 
235
            version is not applied.  This is intended only for
 
236
            upgrade/recovery type use; it's not guaranteed that
 
237
            all operations will work on old format branches.
 
238
 
174
239
        In the test suite, creation of new trees is tested using the
175
240
        `ScratchBranch` class.
176
241
        """
177
 
        from bzrlib.store import ImmutableStore
178
242
        if init:
179
243
            self.base = os.path.realpath(base)
180
244
            self._make_control()
181
245
        elif find_root:
182
246
            self.base = find_branch_root(base)
183
247
        else:
 
248
            if base.startswith("file://"):
 
249
                base = base[7:]
184
250
            self.base = os.path.realpath(base)
185
251
            if not isdir(self.controlfilename('.')):
186
 
                from errors import NotBranchError
187
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
 
                                     ['use "bzr init" to initialize a new working tree',
189
 
                                      'current bzr can only operate from top-of-tree'])
190
 
        self._check_format()
191
 
 
192
 
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
252
                raise NotBranchError('not a bzr branch: %s' % quotefn(base),
 
253
                                     ['use "bzr init" to initialize a '
 
254
                                      'new working tree'])
 
255
        self._check_format(relax_version_check)
 
256
        cfn = self.controlfilename
 
257
        if self._branch_format == 4:
 
258
            self.inventory_store = ImmutableStore(cfn('inventory-store'))
 
259
            self.text_store = ImmutableStore(cfn('text-store'))
 
260
        elif self._branch_format == 5:
 
261
            self.control_weaves = WeaveStore(cfn([]))
 
262
            self.weave_store = WeaveStore(cfn('weaves'))
 
263
            if init:
 
264
                # FIXME: Unify with make_control_files
 
265
                self.control_weaves.put_empty_weave('inventory')
 
266
                self.control_weaves.put_empty_weave('ancestry')
 
267
        self.revision_store = ImmutableStore(cfn('revision-store'))
195
268
 
196
269
 
197
270
    def __str__(self):
203
276
 
204
277
    def __del__(self):
205
278
        if self._lock_mode or self._lock:
206
 
            from warnings import warn
 
279
            # XXX: This should show something every time, and be suitable for
 
280
            # headless operation and embedding
207
281
            warn("branch %r was not explicitly unlocked" % self)
208
282
            self._lock.unlock()
209
283
 
210
 
 
211
 
 
212
284
    def lock_write(self):
213
285
        if self._lock_mode:
214
286
            if self._lock_mode != 'w':
215
 
                from errors import LockError
216
287
                raise LockError("can't upgrade to a write lock from %r" %
217
288
                                self._lock_mode)
218
289
            self._lock_count += 1
224
295
            self._lock_count = 1
225
296
 
226
297
 
227
 
 
228
298
    def lock_read(self):
229
299
        if self._lock_mode:
230
300
            assert self._lock_mode in ('r', 'w'), \
237
307
            self._lock_mode = 'r'
238
308
            self._lock_count = 1
239
309
                        
240
 
 
241
 
            
242
310
    def unlock(self):
243
311
        if not self._lock_mode:
244
 
            from errors import LockError
245
312
            raise LockError('branch %r is not locked' % (self))
246
313
 
247
314
        if self._lock_count > 1:
251
318
            self._lock = None
252
319
            self._lock_mode = self._lock_count = None
253
320
 
254
 
 
255
321
    def abspath(self, name):
256
322
        """Return absolute filename for something in the branch"""
257
323
        return os.path.join(self.base, name)
258
324
 
259
 
 
260
325
    def relpath(self, path):
261
326
        """Return path relative to this branch of something inside it.
262
327
 
263
328
        Raises an error if path is not in this branch."""
264
329
        return _relpath(self.base, path)
265
330
 
266
 
 
267
331
    def controlfilename(self, file_or_path):
268
332
        """Return location relative to branch."""
269
333
        if isinstance(file_or_path, basestring):
296
360
        else:
297
361
            raise BzrError("invalid controlfile mode %r" % mode)
298
362
 
299
 
 
300
 
 
301
363
    def _make_control(self):
302
 
        from bzrlib.inventory import Inventory
303
 
        from bzrlib.xml import pack_xml
304
 
        
305
364
        os.mkdir(self.controlfilename([]))
306
365
        self.controlfile('README', 'w').write(
307
366
            "This is a Bazaar-NG control directory.\n"
308
367
            "Do not change any files in this directory.\n")
309
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
 
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
368
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
 
369
        for d in ('text-store', 'revision-store',
 
370
                  'weaves'):
311
371
            os.mkdir(self.controlfilename(d))
312
 
        for f in ('revision-history', 'merged-patches',
313
 
                  'pending-merged-patches', 'branch-name',
 
372
        for f in ('revision-history',
 
373
                  'branch-name',
314
374
                  'branch-lock',
315
375
                  'pending-merges'):
316
376
            self.controlfile(f, 'w').write('')
317
377
        mutter('created control directory in ' + self.base)
318
378
 
319
 
        pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
320
 
 
321
 
 
322
 
    def _check_format(self):
 
379
        # if we want per-tree root ids then this is the place to set
 
380
        # them; they're not needed for now and so ommitted for
 
381
        # simplicity.
 
382
        f = self.controlfile('inventory','w')
 
383
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
 
384
 
 
385
 
 
386
    def _check_format(self, relax_version_check):
323
387
        """Check this branch format is supported.
324
388
 
325
 
        The current tool only supports the current unstable format.
 
389
        The format level is stored, as an integer, in
 
390
        self._branch_format for code that needs to check it later.
326
391
 
327
392
        In the future, we might need different in-memory Branch
328
393
        classes to support downlevel branches.  But not yet.
329
394
        """
330
 
        # This ignores newlines so that we can open branches created
331
 
        # on Windows from Linux and so on.  I think it might be better
332
 
        # to always make all internal files in unix format.
333
 
        fmt = self.controlfile('branch-format', 'r').read()
334
 
        fmt.replace('\r\n', '')
335
 
        if fmt != BZR_BRANCH_FORMAT:
 
395
        try:
 
396
            fmt = self.controlfile('branch-format', 'r').read()
 
397
        except IOError, e:
 
398
            if e.errno == errno.ENOENT:
 
399
                raise NotBranchError(self.base)
 
400
            else:
 
401
                raise
 
402
 
 
403
        if fmt == BZR_BRANCH_FORMAT_5:
 
404
            self._branch_format = 5
 
405
        elif fmt == BZR_BRANCH_FORMAT_4:
 
406
            self._branch_format = 4
 
407
 
 
408
        if (not relax_version_check
 
409
            and self._branch_format != 5):
336
410
            raise BzrError('sorry, branch format %r not supported' % fmt,
337
411
                           ['use a different bzr version',
338
412
                            'or remove the .bzr directory and "bzr init" again'])
356
430
 
357
431
    def read_working_inventory(self):
358
432
        """Read the working inventory."""
359
 
        from bzrlib.inventory import Inventory
360
 
        from bzrlib.xml import unpack_xml
361
 
        from time import time
362
 
        before = time()
363
433
        self.lock_read()
364
434
        try:
365
435
            # ElementTree does its own conversion from UTF-8, so open in
366
436
            # binary.
367
 
            inv = unpack_xml(Inventory,
368
 
                             self.controlfile('inventory', 'rb'))
369
 
            mutter("loaded inventory of %d items in %f"
370
 
                   % (len(inv), time() - before))
371
 
            return inv
 
437
            f = self.controlfile('inventory', 'rb')
 
438
            return bzrlib.xml5.serializer_v5.read_inventory(f)
372
439
        finally:
373
440
            self.unlock()
374
441
            
380
447
        will be committed to the next revision.
381
448
        """
382
449
        from bzrlib.atomicfile import AtomicFile
383
 
        from bzrlib.xml import pack_xml
384
450
        
385
451
        self.lock_write()
386
452
        try:
387
453
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
454
            try:
389
 
                pack_xml(inv, f)
 
455
                bzrlib.xml5.serializer_v5.write_inventory(inv, f)
390
456
                f.commit()
391
457
            finally:
392
458
                f.close()
400
466
                         """Inventory for the working copy.""")
401
467
 
402
468
 
403
 
    def add(self, files, verbose=False, ids=None):
 
469
    def add(self, files, ids=None):
404
470
        """Make files versioned.
405
471
 
406
 
        Note that the command line normally calls smart_add instead.
 
472
        Note that the command line normally calls smart_add instead,
 
473
        which can automatically recurse.
407
474
 
408
475
        This puts the files in the Added state, so that they will be
409
476
        recorded by the next commit.
419
486
        TODO: Perhaps have an option to add the ids even if the files do
420
487
              not (yet) exist.
421
488
 
422
 
        TODO: Perhaps return the ids of the files?  But then again it
423
 
              is easy to retrieve them if they're needed.
424
 
 
425
 
        TODO: Adding a directory should optionally recurse down and
426
 
              add all non-ignored children.  Perhaps do that in a
427
 
              higher-level method.
 
489
        TODO: Perhaps yield the ids and paths as they're added.
428
490
        """
429
491
        # TODO: Re-adding a file that is removed in the working copy
430
492
        # should probably put it back with the previous ID.
466
528
                    file_id = gen_file_id(f)
467
529
                inv.add_path(f, kind=kind, file_id=file_id)
468
530
 
469
 
                if verbose:
470
 
                    print 'added', quotefn(f)
471
 
 
472
531
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
532
 
474
533
            self._write_inventory(inv)
480
539
        """Print `file` to stdout."""
481
540
        self.lock_read()
482
541
        try:
483
 
            tree = self.revision_tree(self.lookup_revision(revno))
 
542
            tree = self.revision_tree(self.get_rev_id(revno))
484
543
            # use inventory as it was in that revision
485
544
            file_id = tree.inventory.path2id(file)
486
545
            if not file_id:
584
643
            f.close()
585
644
 
586
645
 
587
 
    def get_revision_xml(self, revision_id):
 
646
    def has_revision(self, revision_id):
 
647
        """True if this branch has a copy of the revision.
 
648
 
 
649
        This does not necessarily imply the revision is merge
 
650
        or on the mainline."""
 
651
        return (revision_id is None
 
652
                or revision_id in self.revision_store)
 
653
 
 
654
 
 
655
    def get_revision_xml_file(self, revision_id):
588
656
        """Return XML file object for revision object."""
589
657
        if not revision_id or not isinstance(revision_id, basestring):
590
658
            raise InvalidRevisionId(revision_id)
593
661
        try:
594
662
            try:
595
663
                return self.revision_store[revision_id]
596
 
            except IndexError:
597
 
                raise bzrlib.errors.NoSuchRevision(revision_id)
 
664
            except (IndexError, KeyError):
 
665
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
598
666
        finally:
599
667
            self.unlock()
600
668
 
601
669
 
 
670
    def get_revision_xml(self, revision_id):
 
671
        return self.get_revision_xml_file(revision_id).read()
 
672
 
 
673
 
602
674
    def get_revision(self, revision_id):
603
675
        """Return the Revision object for a named revision"""
604
 
        xml_file = self.get_revision_xml(revision_id)
 
676
        xml_file = self.get_revision_xml_file(revision_id)
605
677
 
606
678
        try:
607
 
            r = unpack_xml(Revision, xml_file)
 
679
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
608
680
        except SyntaxError, e:
609
681
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
682
                                         [revision_id,
635
707
 
636
708
        return compare_trees(old_tree, new_tree)
637
709
 
638
 
        
639
710
 
640
711
    def get_revision_sha1(self, revision_id):
641
712
        """Hash the stored value of a revision, and return it."""
642
 
        # In the future, revision entries will be signed. At that
643
 
        # point, it is probably best *not* to include the signature
644
 
        # in the revision hash. Because that lets you re-sign
645
 
        # the revision, (add signatures/remove signatures) and still
646
 
        # have all hash pointers stay consistent.
647
 
        # But for now, just hash the contents.
648
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
649
 
 
650
 
 
651
 
    def get_inventory(self, inventory_id):
652
 
        """Get Inventory object by hash.
653
 
 
654
 
        TODO: Perhaps for this and similar methods, take a revision
655
 
               parameter which can be either an integer revno or a
656
 
               string hash."""
657
 
        from bzrlib.inventory import Inventory
658
 
        from bzrlib.xml import unpack_xml
659
 
 
660
 
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
661
 
            
662
 
 
663
 
    def get_inventory_sha1(self, inventory_id):
 
713
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
714
 
 
715
 
 
716
    def _get_ancestry_weave(self):
 
717
        return self.control_weaves.get_weave('ancestry')
 
718
        
 
719
 
 
720
    def get_ancestry(self, revision_id):
 
721
        """Return a list of revision-ids integrated by a revision.
 
722
        """
 
723
        # strip newlines
 
724
        if revision_id is None:
 
725
            return [None]
 
726
        w = self._get_ancestry_weave()
 
727
        return [None] + [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
 
728
 
 
729
 
 
730
    def get_inventory_weave(self):
 
731
        return self.control_weaves.get_weave('inventory')
 
732
 
 
733
 
 
734
    def get_inventory(self, revision_id):
 
735
        """Get Inventory object by hash."""
 
736
        xml = self.get_inventory_xml(revision_id)
 
737
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
738
 
 
739
 
 
740
    def get_inventory_xml(self, revision_id):
 
741
        """Get inventory XML as a file object."""
 
742
        try:
 
743
            assert isinstance(revision_id, basestring), type(revision_id)
 
744
            iw = self.get_inventory_weave()
 
745
            return iw.get_text(iw.lookup(revision_id))
 
746
        except IndexError:
 
747
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
748
 
 
749
 
 
750
    def get_inventory_sha1(self, revision_id):
664
751
        """Return the sha1 hash of the inventory entry
665
752
        """
666
 
        return sha_file(self.inventory_store[inventory_id])
 
753
        return self.get_revision(revision_id).inventory_sha1
667
754
 
668
755
 
669
756
    def get_revision_inventory(self, revision_id):
670
757
        """Return inventory of a past revision."""
671
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
758
        # TODO: Unify this with get_inventory()
 
759
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
672
760
        # must be the same as its revision, so this is trivial.
673
761
        if revision_id == None:
674
 
            from bzrlib.inventory import Inventory
675
762
            return Inventory(self.get_root_id())
676
763
        else:
677
764
            return self.get_inventory(revision_id)
678
765
 
679
766
 
680
767
    def revision_history(self):
681
 
        """Return sequence of revision hashes on to this branch.
682
 
 
683
 
        >>> ScratchBranch().revision_history()
684
 
        []
685
 
        """
 
768
        """Return sequence of revision hashes on to this branch."""
686
769
        self.lock_read()
687
770
        try:
688
771
            return [l.rstrip('\r\n') for l in
693
776
 
694
777
    def common_ancestor(self, other, self_revno=None, other_revno=None):
695
778
        """
696
 
        >>> import commit
 
779
        >>> from bzrlib.commit import commit
697
780
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
698
781
        >>> sb.common_ancestor(sb) == (None, None)
699
782
        True
700
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
783
        >>> commit(sb, "Committing first revision", verbose=False)
701
784
        >>> sb.common_ancestor(sb)[0]
702
785
        1
703
786
        >>> clone = sb.clone()
704
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
787
        >>> commit(sb, "Committing second revision", verbose=False)
705
788
        >>> sb.common_ancestor(sb)[0]
706
789
        2
707
790
        >>> sb.common_ancestor(clone)[0]
708
791
        1
709
 
        >>> commit.commit(clone, "Committing divergent second revision", 
 
792
        >>> commit(clone, "Committing divergent second revision", 
710
793
        ...               verbose=False)
711
794
        >>> sb.common_ancestor(clone)[0]
712
795
        1
745
828
        return len(self.revision_history())
746
829
 
747
830
 
748
 
    def last_patch(self):
 
831
    def last_revision(self):
749
832
        """Return last patch hash, or None if no history.
750
833
        """
751
834
        ph = self.revision_history()
755
838
            return None
756
839
 
757
840
 
758
 
    def missing_revisions(self, other, stop_revision=None):
759
 
        """
 
841
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
842
        """Return a list of new revisions that would perfectly fit.
 
843
        
760
844
        If self and other have not diverged, return a list of the revisions
761
845
        present in other, but missing from self.
762
846
 
782
866
        Traceback (most recent call last):
783
867
        DivergedBranches: These branches have diverged.
784
868
        """
 
869
        # FIXME: If the branches have diverged, but the latest
 
870
        # revision in this branch is completely merged into the other,
 
871
        # then we should still be able to pull.
785
872
        self_history = self.revision_history()
786
873
        self_len = len(self_history)
787
874
        other_history = other.revision_history()
793
880
 
794
881
        if stop_revision is None:
795
882
            stop_revision = other_len
796
 
        elif stop_revision > other_len:
797
 
            raise NoSuchRevision(self, stop_revision)
798
 
        
 
883
        else:
 
884
            assert isinstance(stop_revision, int)
 
885
            if stop_revision > other_len:
 
886
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
887
        return other_history[self_len:stop_revision]
800
888
 
801
 
 
802
889
    def update_revisions(self, other, stop_revision=None):
803
 
        """Pull in all new revisions from other branch.
804
 
        
805
 
        >>> from bzrlib.commit import commit
806
 
        >>> bzrlib.trace.silent = True
807
 
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
808
 
        >>> br1.add('foo')
809
 
        >>> br1.add('bar')
810
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
 
        >>> br2 = ScratchBranch()
812
 
        >>> br2.update_revisions(br1)
813
 
        Added 2 texts.
814
 
        Added 1 inventories.
815
 
        Added 1 revisions.
816
 
        >>> br2.revision_history()
817
 
        [u'REVISION-ID-1']
818
 
        >>> br2.update_revisions(br1)
819
 
        Added 0 texts.
820
 
        Added 0 inventories.
821
 
        Added 0 revisions.
822
 
        >>> br1.text_store.total_size() == br2.text_store.total_size()
823
 
        True
824
 
        """
825
 
        from bzrlib.progress import ProgressBar
826
 
 
827
 
        pb = ProgressBar()
828
 
 
829
 
        pb.update('comparing histories')
830
 
        revision_ids = self.missing_revisions(other, stop_revision)
831
 
 
832
 
        if hasattr(other.revision_store, "prefetch"):
833
 
            other.revision_store.prefetch(revision_ids)
834
 
        if hasattr(other.inventory_store, "prefetch"):
835
 
            inventory_ids = [other.get_revision(r).inventory_id
836
 
                             for r in revision_ids]
837
 
            other.inventory_store.prefetch(inventory_ids)
838
 
                
839
 
        revisions = []
840
 
        needed_texts = set()
841
 
        i = 0
842
 
        for rev_id in revision_ids:
843
 
            i += 1
844
 
            pb.update('fetching revision', i, len(revision_ids))
845
 
            rev = other.get_revision(rev_id)
846
 
            revisions.append(rev)
847
 
            inv = other.get_inventory(str(rev.inventory_id))
848
 
            for key, entry in inv.iter_entries():
849
 
                if entry.text_id is None:
850
 
                    continue
851
 
                if entry.text_id not in self.text_store:
852
 
                    needed_texts.add(entry.text_id)
853
 
 
854
 
        pb.clear()
855
 
                    
856
 
        count = self.text_store.copy_multi(other.text_store, needed_texts)
857
 
        print "Added %d texts." % count 
858
 
        inventory_ids = [ f.inventory_id for f in revisions ]
859
 
        count = self.inventory_store.copy_multi(other.inventory_store, 
860
 
                                                inventory_ids)
861
 
        print "Added %d inventories." % count 
862
 
        revision_ids = [ f.revision_id for f in revisions]
863
 
        count = self.revision_store.copy_multi(other.revision_store, 
864
 
                                               revision_ids)
865
 
        for revision_id in revision_ids:
866
 
            self.append_revision(revision_id)
867
 
        print "Added %d revisions." % count
868
 
                    
869
 
        
 
890
        """Pull in new perfect-fit revisions."""
 
891
        from bzrlib.fetch import greedy_fetch
 
892
        from bzrlib.revision import get_intervening_revisions
 
893
        if stop_revision is None:
 
894
            stop_revision = other.last_revision()
 
895
        greedy_fetch(to_branch=self, from_branch=other,
 
896
                     revision=stop_revision)
 
897
        pullable_revs = self.missing_revisions(
 
898
            other, other.revision_id_to_revno(stop_revision))
 
899
        if pullable_revs:
 
900
            greedy_fetch(to_branch=self,
 
901
                         from_branch=other,
 
902
                         revision=pullable_revs[-1])
 
903
            self.append_revision(*pullable_revs)
 
904
    
 
905
 
870
906
    def commit(self, *args, **kw):
871
 
        from bzrlib.commit import commit
872
 
        commit(self, *args, **kw)
873
 
        
874
 
 
875
 
    def lookup_revision(self, revision):
876
 
        """Return the revision identifier for a given revision information."""
877
 
        revno, info = self.get_revision_info(revision)
878
 
        return info
879
 
 
880
 
    def get_revision_info(self, revision):
881
 
        """Return (revno, revision id) for revision identifier.
882
 
 
883
 
        revision can be an integer, in which case it is assumed to be revno (though
884
 
            this will translate negative values into positive ones)
885
 
        revision can also be a string, in which case it is parsed for something like
886
 
            'date:' or 'revid:' etc.
887
 
        """
888
 
        if revision is None:
889
 
            return 0, None
890
 
        revno = None
891
 
        try:# Convert to int if possible
892
 
            revision = int(revision)
893
 
        except ValueError:
894
 
            pass
895
 
        revs = self.revision_history()
896
 
        if isinstance(revision, int):
897
 
            if revision == 0:
898
 
                return 0, None
899
 
            # Mabye we should do this first, but we don't need it if revision == 0
900
 
            if revision < 0:
901
 
                revno = len(revs) + revision + 1
902
 
            else:
903
 
                revno = revision
904
 
        elif isinstance(revision, basestring):
905
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
 
                if revision.startswith(prefix):
907
 
                    revno = func(self, revs, revision)
908
 
                    break
909
 
            else:
910
 
                raise BzrError('No namespace registered for string: %r' % revision)
911
 
 
912
 
        if revno is None or revno <= 0 or revno > len(revs):
913
 
            raise BzrError("no such revision %s" % revision)
914
 
        return revno, revs[revno-1]
915
 
 
916
 
    def _namespace_revno(self, revs, revision):
917
 
        """Lookup a revision by revision number"""
918
 
        assert revision.startswith('revno:')
919
 
        try:
920
 
            return int(revision[6:])
921
 
        except ValueError:
922
 
            return None
923
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
924
 
 
925
 
    def _namespace_revid(self, revs, revision):
926
 
        assert revision.startswith('revid:')
927
 
        try:
928
 
            return revs.index(revision[6:]) + 1
929
 
        except ValueError:
930
 
            return None
931
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
932
 
 
933
 
    def _namespace_last(self, revs, revision):
934
 
        assert revision.startswith('last:')
935
 
        try:
936
 
            offset = int(revision[5:])
937
 
        except ValueError:
938
 
            return None
939
 
        else:
940
 
            if offset <= 0:
941
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
942
 
            return len(revs) - offset + 1
943
 
    REVISION_NAMESPACES['last:'] = _namespace_last
944
 
 
945
 
    def _namespace_tag(self, revs, revision):
946
 
        assert revision.startswith('tag:')
947
 
        raise BzrError('tag: namespace registered, but not implemented.')
948
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
949
 
 
950
 
    def _namespace_date(self, revs, revision):
951
 
        assert revision.startswith('date:')
952
 
        import datetime
953
 
        # Spec for date revisions:
954
 
        #   date:value
955
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
 
        #   it can also start with a '+/-/='. '+' says match the first
957
 
        #   entry after the given date. '-' is match the first entry before the date
958
 
        #   '=' is match the first entry after, but still on the given date.
959
 
        #
960
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
 
        #       May 13th, 2005 at 0:00
964
 
        #
965
 
        #   So the proper way of saying 'give me all entries for today' is:
966
 
        #       -r {date:+today}:{date:-tomorrow}
967
 
        #   The default is '=' when not supplied
968
 
        val = revision[5:]
969
 
        match_style = '='
970
 
        if val[:1] in ('+', '-', '='):
971
 
            match_style = val[:1]
972
 
            val = val[1:]
973
 
 
974
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
 
        if val.lower() == 'yesterday':
976
 
            dt = today - datetime.timedelta(days=1)
977
 
        elif val.lower() == 'today':
978
 
            dt = today
979
 
        elif val.lower() == 'tomorrow':
980
 
            dt = today + datetime.timedelta(days=1)
981
 
        else:
982
 
            import re
983
 
            # This should be done outside the function to avoid recompiling it.
984
 
            _date_re = re.compile(
985
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
986
 
                    r'(,|T)?\s*'
987
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
988
 
                )
989
 
            m = _date_re.match(val)
990
 
            if not m or (not m.group('date') and not m.group('time')):
991
 
                raise BzrError('Invalid revision date %r' % revision)
992
 
 
993
 
            if m.group('date'):
994
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
995
 
            else:
996
 
                year, month, day = today.year, today.month, today.day
997
 
            if m.group('time'):
998
 
                hour = int(m.group('hour'))
999
 
                minute = int(m.group('minute'))
1000
 
                if m.group('second'):
1001
 
                    second = int(m.group('second'))
1002
 
                else:
1003
 
                    second = 0
1004
 
            else:
1005
 
                hour, minute, second = 0,0,0
1006
 
 
1007
 
            dt = datetime.datetime(year=year, month=month, day=day,
1008
 
                    hour=hour, minute=minute, second=second)
1009
 
        first = dt
1010
 
        last = None
1011
 
        reversed = False
1012
 
        if match_style == '-':
1013
 
            reversed = True
1014
 
        elif match_style == '=':
1015
 
            last = dt + datetime.timedelta(days=1)
1016
 
 
1017
 
        if reversed:
1018
 
            for i in range(len(revs)-1, -1, -1):
1019
 
                r = self.get_revision(revs[i])
1020
 
                # TODO: Handle timezone.
1021
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
 
                if first >= dt and (last is None or dt >= last):
1023
 
                    return i+1
1024
 
        else:
1025
 
            for i in range(len(revs)):
1026
 
                r = self.get_revision(revs[i])
1027
 
                # TODO: Handle timezone.
1028
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
 
                if first <= dt and (last is None or dt <= last):
1030
 
                    return i+1
1031
 
    REVISION_NAMESPACES['date:'] = _namespace_date
 
907
        from bzrlib.commit import Commit
 
908
        Commit().commit(self, *args, **kw)
 
909
    
 
910
    def revision_id_to_revno(self, revision_id):
 
911
        """Given a revision id, return its revno"""
 
912
        if revision_id is None:
 
913
            return 0
 
914
        history = self.revision_history()
 
915
        try:
 
916
            return history.index(revision_id) + 1
 
917
        except ValueError:
 
918
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
919
 
 
920
    def get_rev_id(self, revno, history=None):
 
921
        """Find the revision id of the specified revno."""
 
922
        if revno == 0:
 
923
            return None
 
924
        if history is None:
 
925
            history = self.revision_history()
 
926
        elif revno <= 0 or revno > len(history):
 
927
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
928
        return history[revno - 1]
1032
929
 
1033
930
    def revision_tree(self, revision_id):
1034
931
        """Return Tree for a revision on this branch.
1041
938
            return EmptyTree()
1042
939
        else:
1043
940
            inv = self.get_revision_inventory(revision_id)
1044
 
            return RevisionTree(self.text_store, inv)
 
941
            return RevisionTree(self.weave_store, inv, revision_id)
1045
942
 
1046
943
 
1047
944
    def working_tree(self):
1048
945
        """Return a `Tree` for the working copy."""
1049
 
        from workingtree import WorkingTree
 
946
        from bzrlib.workingtree import WorkingTree
1050
947
        return WorkingTree(self.base, self.read_working_inventory())
1051
948
 
1052
949
 
1055
952
 
1056
953
        If there are no revisions yet, return an `EmptyTree`.
1057
954
        """
1058
 
        r = self.last_patch()
1059
 
        if r == None:
1060
 
            return EmptyTree()
1061
 
        else:
1062
 
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
1063
 
 
 
955
        return self.revision_tree(self.last_revision())
1064
956
 
1065
957
 
1066
958
    def rename_one(self, from_rel, to_rel):
1098
990
 
1099
991
            inv.rename(file_id, to_dir_id, to_tail)
1100
992
 
1101
 
            print "%s => %s" % (from_rel, to_rel)
1102
 
 
1103
993
            from_abs = self.abspath(from_rel)
1104
994
            to_abs = self.abspath(to_rel)
1105
995
            try:
1106
 
                os.rename(from_abs, to_abs)
 
996
                rename(from_abs, to_abs)
1107
997
            except OSError, e:
1108
998
                raise BzrError("failed to rename %r to %r: %s"
1109
999
                        % (from_abs, to_abs, e[1]),
1124
1014
 
1125
1015
        Note that to_name is only the last component of the new name;
1126
1016
        this doesn't change the directory.
 
1017
 
 
1018
        This returns a list of (from_path, to_path) pairs for each
 
1019
        entry that is moved.
1127
1020
        """
 
1021
        result = []
1128
1022
        self.lock_write()
1129
1023
        try:
1130
1024
            ## TODO: Option to move IDs only
1165
1059
            for f in from_paths:
1166
1060
                name_tail = splitpath(f)[-1]
1167
1061
                dest_path = appendpath(to_name, name_tail)
1168
 
                print "%s => %s" % (f, dest_path)
 
1062
                result.append((f, dest_path))
1169
1063
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1170
1064
                try:
1171
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1065
                    rename(self.abspath(f), self.abspath(dest_path))
1172
1066
                except OSError, e:
1173
1067
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
1068
                            ["rename rolled back"])
1177
1071
        finally:
1178
1072
            self.unlock()
1179
1073
 
 
1074
        return result
 
1075
 
1180
1076
 
1181
1077
    def revert(self, filenames, old_tree=None, backups=True):
1182
1078
        """Restore selected files to the versions from a previous tree.
1238
1134
 
1239
1135
 
1240
1136
    def add_pending_merge(self, revision_id):
1241
 
        from bzrlib.revision import validate_revision_id
1242
 
 
1243
1137
        validate_revision_id(revision_id)
1244
 
 
 
1138
        # TODO: Perhaps should check at this point that the
 
1139
        # history of the revision is actually present?
1245
1140
        p = self.pending_merges()
1246
1141
        if revision_id in p:
1247
1142
            return
1264
1159
            self.unlock()
1265
1160
 
1266
1161
 
1267
 
 
1268
 
class ScratchBranch(Branch):
 
1162
    def get_parent(self):
 
1163
        """Return the parent location of the branch.
 
1164
 
 
1165
        This is the default location for push/pull/missing.  The usual
 
1166
        pattern is that the user can override it by specifying a
 
1167
        location.
 
1168
        """
 
1169
        import errno
 
1170
        _locs = ['parent', 'pull', 'x-pull']
 
1171
        for l in _locs:
 
1172
            try:
 
1173
                return self.controlfile(l, 'r').read().strip('\n')
 
1174
            except IOError, e:
 
1175
                if e.errno != errno.ENOENT:
 
1176
                    raise
 
1177
        return None
 
1178
 
 
1179
 
 
1180
    def set_parent(self, url):
 
1181
        # TODO: Maybe delete old location files?
 
1182
        from bzrlib.atomicfile import AtomicFile
 
1183
        self.lock_write()
 
1184
        try:
 
1185
            f = AtomicFile(self.controlfilename('parent'))
 
1186
            try:
 
1187
                f.write(url + '\n')
 
1188
                f.commit()
 
1189
            finally:
 
1190
                f.close()
 
1191
        finally:
 
1192
            self.unlock()
 
1193
 
 
1194
    def check_revno(self, revno):
 
1195
        """\
 
1196
        Check whether a revno corresponds to any revision.
 
1197
        Zero (the NULL revision) is considered valid.
 
1198
        """
 
1199
        if revno != 0:
 
1200
            self.check_real_revno(revno)
 
1201
            
 
1202
    def check_real_revno(self, revno):
 
1203
        """\
 
1204
        Check whether a revno corresponds to a real revision.
 
1205
        Zero (the NULL revision) is considered invalid
 
1206
        """
 
1207
        if revno < 1 or revno > self.revno():
 
1208
            raise InvalidRevisionNumber(revno)
 
1209
        
 
1210
        
 
1211
        
 
1212
 
 
1213
 
 
1214
class ScratchBranch(LocalBranch):
1269
1215
    """Special test class: a branch that cleans up after itself.
1270
1216
 
1271
1217
    >>> b = ScratchBranch()
1288
1234
        if base is None:
1289
1235
            base = mkdtemp()
1290
1236
            init = True
1291
 
        Branch.__init__(self, base, init=init)
 
1237
        LocalBranch.__init__(self, base, init=init)
1292
1238
        for d in dirs:
1293
1239
            os.mkdir(self.abspath(d))
1294
1240
            
1300
1246
        """
1301
1247
        >>> orig = ScratchBranch(files=["file1", "file2"])
1302
1248
        >>> clone = orig.clone()
1303
 
        >>> os.path.samefile(orig.base, clone.base)
 
1249
        >>> if os.name != 'nt':
 
1250
        ...   os.path.samefile(orig.base, clone.base)
 
1251
        ... else:
 
1252
        ...   orig.base == clone.base
 
1253
        ...
1304
1254
        False
1305
1255
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
1256
        True
1311
1261
        os.rmdir(base)
1312
1262
        copytree(self.base, base, symlinks=True)
1313
1263
        return ScratchBranch(base=base)
 
1264
 
 
1265
 
1314
1266
        
1315
1267
    def __del__(self):
1316
1268
        self.destroy()
1386
1338
    """Return a new tree-root file id."""
1387
1339
    return gen_file_id('TREE_ROOT')
1388
1340
 
 
1341
 
 
1342
def copy_branch(branch_from, to_location, revision=None, basis_branch=None):
 
1343
    """Copy branch_from into the existing directory to_location.
 
1344
 
 
1345
    revision
 
1346
        If not None, only revisions up to this point will be copied.
 
1347
        The head of the new branch will be that revision.  Must be a
 
1348
        revid or None.
 
1349
 
 
1350
    to_location
 
1351
        The name of a local directory that exists but is empty.
 
1352
 
 
1353
    revno
 
1354
        The revision to copy up to
 
1355
 
 
1356
    basis_branch
 
1357
        A local branch to copy revisions from, related to branch_from
 
1358
    """
 
1359
    # TODO: This could be done *much* more efficiently by just copying
 
1360
    # all the whole weaves and revisions, rather than getting one
 
1361
    # revision at a time.
 
1362
    from bzrlib.merge import merge
 
1363
 
 
1364
    assert isinstance(branch_from, Branch)
 
1365
    assert isinstance(to_location, basestring)
 
1366
    
 
1367
    br_to = Branch.initialize(to_location)
 
1368
    if basis_branch is not None:
 
1369
        basis_branch.push_stores(br_to)
 
1370
    br_to.set_root_id(branch_from.get_root_id())
 
1371
    if revision is None:
 
1372
        revision = branch_from.last_revision()
 
1373
    br_to.update_revisions(branch_from, stop_revision=revision)
 
1374
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
 
1375
          check_clean=False, ignore_zero=True)
 
1376
    br_to.set_parent(branch_from.base)
 
1377
    return br_to