~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-10 06:29:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050610062935-cd2fc37ca7ae1e09
- split out proposed progress module

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
import sys
19
 
import os
20
 
from cStringIO import StringIO
 
18
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
19
import traceback, socket, fnmatch, difflib, time
 
20
from binascii import hexlify
21
21
 
22
22
import bzrlib
23
 
from bzrlib.trace import mutter, note
24
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
 
     splitpath, \
26
 
     sha_file, appendpath, file_kind
27
 
 
28
 
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
 
                           NoSuchRevision)
30
 
from bzrlib.textui import show_status
31
 
from bzrlib.revision import Revision
32
 
from bzrlib.delta import compare_trees
33
 
from bzrlib.tree import EmptyTree, RevisionTree
34
 
from bzrlib.inventory import Inventory
35
 
from bzrlib.weavestore import WeaveStore
36
 
from bzrlib.store import ImmutableStore
37
 
import bzrlib.xml5
38
 
import bzrlib.ui
39
 
 
40
 
 
41
 
INVENTORY_FILEID = '__inventory'
42
 
ANCESTRY_FILEID = '__ancestry'
43
 
 
44
 
 
45
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
46
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
23
from inventory import Inventory
 
24
from trace import mutter, note
 
25
from tree import Tree, EmptyTree, RevisionTree
 
26
from inventory import InventoryEntry, Inventory
 
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
 
28
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
 
29
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
30
from store import ImmutableStore
 
31
from revision import Revision
 
32
from errors import BzrError
 
33
from textui import show_status
 
34
 
 
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
47
36
## TODO: Maybe include checks for common corruption of newlines, etc?
48
37
 
49
38
 
50
 
# TODO: Some operations like log might retrieve the same revisions
51
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
52
 
# cache in memory to make this faster.  In general anything can be
53
 
# cached in memory between lock and unlock operations.
54
 
 
55
 
# TODO: please move the revision-string syntax stuff out of the branch
56
 
# object; it's clutter
57
 
 
58
39
 
59
40
def find_branch(f, **args):
60
41
    if f and (f.startswith('http://') or f.startswith('https://')):
64
45
        return Branch(f, **args)
65
46
 
66
47
 
67
 
def find_cached_branch(f, cache_root, **args):
68
 
    from remotebranch import RemoteBranch
69
 
    br = find_branch(f, **args)
70
 
    def cacheify(br, store_name):
71
 
        from meta_store import CachedStore
72
 
        cache_path = os.path.join(cache_root, store_name)
73
 
        os.mkdir(cache_path)
74
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
75
 
        setattr(br, store_name, new_store)
76
 
 
77
 
    if isinstance(br, RemoteBranch):
78
 
        cacheify(br, 'inventory_store')
79
 
        cacheify(br, 'text_store')
80
 
        cacheify(br, 'revision_store')
81
 
    return br
82
 
 
83
48
 
84
49
def _relpath(base, path):
85
50
    """Return path relative to base, or raise exception.
117
82
    It is not necessary that f exists.
118
83
 
119
84
    Basically we keep looking up until we find the control directory or
120
 
    run into the root.  If there isn't one, raises NotBranchError.
121
 
    """
 
85
    run into the root."""
122
86
    if f == None:
123
87
        f = os.getcwd()
124
88
    elif hasattr(os.path, 'realpath'):
137
101
        head, tail = os.path.split(f)
138
102
        if head == f:
139
103
            # reached the root, whatever that may be
140
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
 
104
            raise BzrError('%r is not in a branch' % orig_f)
141
105
        f = head
142
 
 
143
 
 
144
 
 
145
 
# XXX: move into bzrlib.errors; subclass BzrError    
 
106
    
146
107
class DivergedBranches(Exception):
147
108
    def __init__(self, branch1, branch2):
148
109
        self.branch1 = branch1
149
110
        self.branch2 = branch2
150
111
        Exception.__init__(self, "These branches have diverged.")
151
112
 
152
 
 
153
113
######################################################################
154
114
# branch objects
155
115
 
173
133
    _lock_mode = None
174
134
    _lock_count = None
175
135
    _lock = None
176
 
    _inventory_weave = None
177
136
    
178
 
    # Map some sort of prefix into a namespace
179
 
    # stuff like "revno:10", "revid:", etc.
180
 
    # This should match a prefix with a function which accepts
181
 
    REVISION_NAMESPACES = {}
182
 
 
183
137
    def __init__(self, base, init=False, find_root=True):
184
138
        """Create new branch object at a particular location.
185
139
 
209
163
                                      'current bzr can only operate from top-of-tree'])
210
164
        self._check_format()
211
165
 
212
 
        self.weave_store = WeaveStore(self.controlfilename('weaves'))
 
166
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
213
167
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
168
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
214
169
 
215
170
 
216
171
    def __str__(self):
227
182
            self._lock.unlock()
228
183
 
229
184
 
 
185
 
230
186
    def lock_write(self):
231
187
        if self._lock_mode:
232
188
            if self._lock_mode != 'w':
242
198
            self._lock_count = 1
243
199
 
244
200
 
 
201
 
245
202
    def lock_read(self):
246
203
        if self._lock_mode:
247
204
            assert self._lock_mode in ('r', 'w'), \
254
211
            self._lock_mode = 'r'
255
212
            self._lock_count = 1
256
213
                        
 
214
 
 
215
            
257
216
    def unlock(self):
258
217
        if not self._lock_mode:
259
218
            from errors import LockError
266
225
            self._lock = None
267
226
            self._lock_mode = self._lock_count = None
268
227
 
 
228
 
269
229
    def abspath(self, name):
270
230
        """Return absolute filename for something in the branch"""
271
231
        return os.path.join(self.base, name)
272
232
 
 
233
 
273
234
    def relpath(self, path):
274
235
        """Return path relative to this branch of something inside it.
275
236
 
276
237
        Raises an error if path is not in this branch."""
277
238
        return _relpath(self.base, path)
278
239
 
 
240
 
279
241
    def controlfilename(self, file_or_path):
280
242
        """Return location relative to branch."""
281
 
        if isinstance(file_or_path, basestring):
 
243
        if isinstance(file_or_path, types.StringTypes):
282
244
            file_or_path = [file_or_path]
283
245
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
284
246
 
308
270
        else:
309
271
            raise BzrError("invalid controlfile mode %r" % mode)
310
272
 
 
273
 
 
274
 
311
275
    def _make_control(self):
312
276
        os.mkdir(self.controlfilename([]))
313
277
        self.controlfile('README', 'w').write(
314
278
            "This is a Bazaar-NG control directory.\n"
315
 
            "Do not change any files in this directory.\n")
316
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
 
        for d in ('text-store', 'revision-store',
318
 
                  'weaves'):
 
279
            "Do not change any files in this directory.")
 
280
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
281
        for d in ('text-store', 'inventory-store', 'revision-store'):
319
282
            os.mkdir(self.controlfilename(d))
320
283
        for f in ('revision-history', 'merged-patches',
321
284
                  'pending-merged-patches', 'branch-name',
322
 
                  'branch-lock',
323
 
                  'pending-merges'):
 
285
                  'branch-lock'):
324
286
            self.controlfile(f, 'w').write('')
325
287
        mutter('created control directory in ' + self.base)
326
 
 
327
 
        # if we want per-tree root ids then this is the place to set
328
 
        # them; they're not needed for now and so ommitted for
329
 
        # simplicity.
330
 
        f = self.controlfile('inventory','w')
331
 
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
332
 
        
 
288
        Inventory().write_xml(self.controlfile('inventory','w'))
333
289
 
334
290
 
335
291
    def _check_format(self):
336
292
        """Check this branch format is supported.
337
293
 
338
 
        The format level is stored, as an integer, in
339
 
        self._branch_format for code that needs to check it later.
 
294
        The current tool only supports the current unstable format.
340
295
 
341
296
        In the future, we might need different in-memory Branch
342
297
        classes to support downlevel branches.  But not yet.
343
298
        """
 
299
        # This ignores newlines so that we can open branches created
 
300
        # on Windows from Linux and so on.  I think it might be better
 
301
        # to always make all internal files in unix format.
344
302
        fmt = self.controlfile('branch-format', 'r').read()
345
 
        if fmt == BZR_BRANCH_FORMAT_5:
346
 
            self._branch_format = 5
347
 
        else:
348
 
            raise BzrError('sorry, branch format "%s" not supported; ' 
349
 
                           'use a different bzr version, '
350
 
                           'or run "bzr upgrade", '
351
 
                           'or remove the .bzr directory and "bzr init" again'
352
 
                           % fmt.rstrip('\n\r'))
353
 
 
354
 
    def get_root_id(self):
355
 
        """Return the id of this branches root"""
356
 
        inv = self.read_working_inventory()
357
 
        return inv.root.file_id
358
 
 
359
 
    def set_root_id(self, file_id):
360
 
        inv = self.read_working_inventory()
361
 
        orig_root_id = inv.root.file_id
362
 
        del inv._byid[inv.root.file_id]
363
 
        inv.root.file_id = file_id
364
 
        inv._byid[inv.root.file_id] = inv.root
365
 
        for fid in inv:
366
 
            entry = inv[fid]
367
 
            if entry.parent_id in (None, orig_root_id):
368
 
                entry.parent_id = inv.root.file_id
369
 
        self._write_inventory(inv)
 
303
        fmt.replace('\r\n', '')
 
304
        if fmt != BZR_BRANCH_FORMAT:
 
305
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
306
                           ['use a different bzr version',
 
307
                            'or remove the .bzr directory and "bzr init" again'])
 
308
 
 
309
 
370
310
 
371
311
    def read_working_inventory(self):
372
312
        """Read the working inventory."""
 
313
        before = time.time()
 
314
        # ElementTree does its own conversion from UTF-8, so open in
 
315
        # binary.
373
316
        self.lock_read()
374
317
        try:
375
 
            # ElementTree does its own conversion from UTF-8, so open in
376
 
            # binary.
377
 
            f = self.controlfile('inventory', 'rb')
378
 
            return bzrlib.xml5.serializer_v5.read_inventory(f)
 
318
            inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
319
            mutter("loaded inventory of %d items in %f"
 
320
                   % (len(inv), time.time() - before))
 
321
            return inv
379
322
        finally:
380
323
            self.unlock()
381
324
            
386
329
        That is to say, the inventory describing changes underway, that
387
330
        will be committed to the next revision.
388
331
        """
389
 
        from bzrlib.atomicfile import AtomicFile
390
 
        
391
 
        self.lock_write()
392
 
        try:
393
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
394
 
            try:
395
 
                bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
 
                f.commit()
397
 
            finally:
398
 
                f.close()
399
 
        finally:
400
 
            self.unlock()
401
 
        
 
332
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
333
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
334
        tmpfname = self.controlfilename('inventory.tmp')
 
335
        tmpf = file(tmpfname, 'wb')
 
336
        inv.write_xml(tmpf)
 
337
        tmpf.close()
 
338
        inv_fname = self.controlfilename('inventory')
 
339
        if sys.platform == 'win32':
 
340
            os.remove(inv_fname)
 
341
        os.rename(tmpfname, inv_fname)
402
342
        mutter('wrote working inventory')
403
343
            
404
344
 
406
346
                         """Inventory for the working copy.""")
407
347
 
408
348
 
409
 
    def add(self, files, ids=None):
 
349
    def add(self, files, verbose=False, ids=None):
410
350
        """Make files versioned.
411
351
 
412
 
        Note that the command line normally calls smart_add instead,
413
 
        which can automatically recurse.
 
352
        Note that the command line normally calls smart_add instead.
414
353
 
415
354
        This puts the files in the Added state, so that they will be
416
355
        recorded by the next commit.
426
365
        TODO: Perhaps have an option to add the ids even if the files do
427
366
              not (yet) exist.
428
367
 
429
 
        TODO: Perhaps yield the ids and paths as they're added.
 
368
        TODO: Perhaps return the ids of the files?  But then again it
 
369
              is easy to retrieve them if they're needed.
 
370
 
 
371
        TODO: Adding a directory should optionally recurse down and
 
372
              add all non-ignored children.  Perhaps do that in a
 
373
              higher-level method.
430
374
        """
431
375
        # TODO: Re-adding a file that is removed in the working copy
432
376
        # should probably put it back with the previous ID.
433
 
        if isinstance(files, basestring):
434
 
            assert(ids is None or isinstance(ids, basestring))
 
377
        if isinstance(files, types.StringTypes):
 
378
            assert(ids is None or isinstance(ids, types.StringTypes))
435
379
            files = [files]
436
380
            if ids is not None:
437
381
                ids = [ids]
468
412
                    file_id = gen_file_id(f)
469
413
                inv.add_path(f, kind=kind, file_id=file_id)
470
414
 
 
415
                if verbose:
 
416
                    show_status('A', kind, quotefn(f))
 
417
 
471
418
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
472
419
 
473
420
            self._write_inventory(inv)
483
430
            # use inventory as it was in that revision
484
431
            file_id = tree.inventory.path2id(file)
485
432
            if not file_id:
486
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
433
                raise BzrError("%r is not present in revision %d" % (file, revno))
487
434
            tree.print_file(file_id)
488
435
        finally:
489
436
            self.unlock()
505
452
        """
506
453
        ## TODO: Normalize names
507
454
        ## TODO: Remove nested loops; better scalability
508
 
        if isinstance(files, basestring):
 
455
        if isinstance(files, types.StringTypes):
509
456
            files = [files]
510
457
 
511
458
        self.lock_write()
536
483
 
537
484
    # FIXME: this doesn't need to be a branch method
538
485
    def set_inventory(self, new_inventory_list):
539
 
        from bzrlib.inventory import Inventory, InventoryEntry
540
 
        inv = Inventory(self.get_root_id())
 
486
        inv = Inventory()
541
487
        for path, file_id, parent, kind in new_inventory_list:
542
488
            name = os.path.basename(path)
543
489
            if name == "":
565
511
        return self.working_tree().unknowns()
566
512
 
567
513
 
568
 
    def append_revision(self, *revision_ids):
569
 
        from bzrlib.atomicfile import AtomicFile
570
 
 
571
 
        for revision_id in revision_ids:
572
 
            mutter("add {%s} to revision-history" % revision_id)
573
 
 
 
514
    def append_revision(self, revision_id):
 
515
        mutter("add {%s} to revision-history" % revision_id)
574
516
        rev_history = self.revision_history()
575
 
        rev_history.extend(revision_ids)
576
 
 
577
 
        f = AtomicFile(self.controlfilename('revision-history'))
578
 
        try:
579
 
            for rev_id in rev_history:
580
 
                print >>f, rev_id
581
 
            f.commit()
582
 
        finally:
583
 
            f.close()
584
 
 
585
 
 
586
 
    def get_revision_xml_file(self, revision_id):
587
 
        """Return XML file object for revision object."""
588
 
        if not revision_id or not isinstance(revision_id, basestring):
589
 
            raise InvalidRevisionId(revision_id)
590
 
 
591
 
        self.lock_read()
592
 
        try:
593
 
            try:
594
 
                return self.revision_store[revision_id]
595
 
            except IndexError:
596
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
597
 
        finally:
598
 
            self.unlock()
599
 
 
600
 
 
601
 
    #deprecated
602
 
    get_revision_xml = get_revision_xml_file
 
517
 
 
518
        tmprhname = self.controlfilename('revision-history.tmp')
 
519
        rhname = self.controlfilename('revision-history')
 
520
        
 
521
        f = file(tmprhname, 'wt')
 
522
        rev_history.append(revision_id)
 
523
        f.write('\n'.join(rev_history))
 
524
        f.write('\n')
 
525
        f.close()
 
526
 
 
527
        if sys.platform == 'win32':
 
528
            os.remove(rhname)
 
529
        os.rename(tmprhname, rhname)
 
530
        
603
531
 
604
532
 
605
533
    def get_revision(self, revision_id):
606
534
        """Return the Revision object for a named revision"""
607
 
        xml_file = self.get_revision_xml_file(revision_id)
608
 
 
609
 
        try:
610
 
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
611
 
        except SyntaxError, e:
612
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
 
                                         [revision_id,
614
 
                                          str(e)])
615
 
            
 
535
        r = Revision.read_xml(self.revision_store[revision_id])
616
536
        assert r.revision_id == revision_id
617
537
        return r
618
538
 
619
539
 
620
 
    def get_revision_delta(self, revno):
621
 
        """Return the delta for one revision.
622
 
 
623
 
        The delta is relative to its mainline predecessor, or the
624
 
        empty tree for revision 1.
625
 
        """
626
 
        assert isinstance(revno, int)
627
 
        rh = self.revision_history()
628
 
        if not (1 <= revno <= len(rh)):
629
 
            raise InvalidRevisionNumber(revno)
630
 
 
631
 
        # revno is 1-based; list is 0-based
632
 
 
633
 
        new_tree = self.revision_tree(rh[revno-1])
634
 
        if revno == 1:
635
 
            old_tree = EmptyTree()
636
 
        else:
637
 
            old_tree = self.revision_tree(rh[revno-2])
638
 
 
639
 
        return compare_trees(old_tree, new_tree)
640
 
 
641
 
        
642
 
 
643
 
    def get_revision_sha1(self, revision_id):
644
 
        """Hash the stored value of a revision, and return it."""
645
 
        # In the future, revision entries will be signed. At that
646
 
        # point, it is probably best *not* to include the signature
647
 
        # in the revision hash. Because that lets you re-sign
648
 
        # the revision, (add signatures/remove signatures) and still
649
 
        # have all hash pointers stay consistent.
650
 
        # But for now, just hash the contents.
651
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
652
 
 
653
 
 
654
 
    def get_ancestry(self, revision_id):
655
 
        """Return a list of revision-ids integrated by a revision.
656
 
        """
657
 
        w = self.weave_store.get_weave(ANCESTRY_FILEID)
658
 
        # strip newlines
659
 
        return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
660
 
 
661
 
 
662
 
    def get_inventory_weave(self):
663
 
        return self.weave_store.get_weave(INVENTORY_FILEID)
664
 
 
665
 
 
666
 
    def get_inventory(self, revision_id):
667
 
        """Get Inventory object by hash."""
668
 
        # FIXME: The text gets passed around a lot coming from the weave.
669
 
        f = StringIO(self.get_inventory_xml(revision_id))
670
 
        return bzrlib.xml5.serializer_v5.read_inventory(f)
671
 
 
672
 
 
673
 
    def get_inventory_xml(self, revision_id):
674
 
        """Get inventory XML as a file object."""
675
 
        try:
676
 
            assert isinstance(revision_id, basestring), type(revision_id)
677
 
            iw = self.get_inventory_weave()
678
 
            return iw.get_text(iw.lookup(revision_id))
679
 
        except IndexError:
680
 
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
681
 
 
682
 
 
683
 
    def get_inventory_sha1(self, revision_id):
684
 
        """Return the sha1 hash of the inventory entry
685
 
        """
686
 
        return self.get_revision(revision_id).inventory_sha1
 
540
    def get_inventory(self, inventory_id):
 
541
        """Get Inventory object by hash.
 
542
 
 
543
        TODO: Perhaps for this and similar methods, take a revision
 
544
               parameter which can be either an integer revno or a
 
545
               string hash."""
 
546
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
547
        return i
687
548
 
688
549
 
689
550
    def get_revision_inventory(self, revision_id):
690
551
        """Return inventory of a past revision."""
691
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
692
 
        # must be the same as its revision, so this is trivial.
693
552
        if revision_id == None:
694
 
            return Inventory(self.get_root_id())
 
553
            return Inventory()
695
554
        else:
696
 
            return self.get_inventory(revision_id)
 
555
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
697
556
 
698
557
 
699
558
    def revision_history(self):
716
575
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
717
576
        >>> sb.common_ancestor(sb) == (None, None)
718
577
        True
719
 
        >>> commit.commit(sb, "Committing first revision")
 
578
        >>> commit.commit(sb, "Committing first revision", verbose=False)
720
579
        >>> sb.common_ancestor(sb)[0]
721
580
        1
722
581
        >>> clone = sb.clone()
723
 
        >>> commit.commit(sb, "Committing second revision")
 
582
        >>> commit.commit(sb, "Committing second revision", verbose=False)
724
583
        >>> sb.common_ancestor(sb)[0]
725
584
        2
726
585
        >>> sb.common_ancestor(clone)[0]
727
586
        1
728
 
        >>> commit.commit(clone, "Committing divergent second revision")
 
587
        >>> commit.commit(clone, "Committing divergent second revision", 
 
588
        ...               verbose=False)
729
589
        >>> sb.common_ancestor(clone)[0]
730
590
        1
731
591
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
753
613
                return r+1, my_history[r]
754
614
        return None, None
755
615
 
 
616
    def enum_history(self, direction):
 
617
        """Return (revno, revision_id) for history of branch.
 
618
 
 
619
        direction
 
620
            'forward' is from earliest to latest
 
621
            'reverse' is from latest to earliest
 
622
        """
 
623
        rh = self.revision_history()
 
624
        if direction == 'forward':
 
625
            i = 1
 
626
            for rid in rh:
 
627
                yield i, rid
 
628
                i += 1
 
629
        elif direction == 'reverse':
 
630
            i = len(rh)
 
631
            while i > 0:
 
632
                yield i, rh[i-1]
 
633
                i -= 1
 
634
        else:
 
635
            raise ValueError('invalid history direction', direction)
 
636
 
756
637
 
757
638
    def revno(self):
758
639
        """Return current revision number for this branch.
773
654
            return None
774
655
 
775
656
 
776
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
657
    def missing_revisions(self, other):
777
658
        """
778
659
        If self and other have not diverged, return a list of the revisions
779
660
        present in other, but missing from self.
808
689
        if common_index >= 0 and \
809
690
            self_history[common_index] != other_history[common_index]:
810
691
            raise DivergedBranches(self, other)
811
 
 
812
 
        if stop_revision is None:
813
 
            stop_revision = other_len
814
 
        elif stop_revision > other_len:
815
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
692
        if self_len < other_len:
 
693
            return other_history[self_len:]
 
694
        return []
 
695
 
 
696
 
 
697
    def update_revisions(self, other):
 
698
        """If self and other have not diverged, ensure self has all the
 
699
        revisions in other
 
700
 
 
701
        >>> from bzrlib.commit import commit
 
702
        >>> bzrlib.trace.silent = True
 
703
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
704
        >>> br1.add('foo')
 
705
        >>> br1.add('bar')
 
706
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
707
        >>> br2 = ScratchBranch()
 
708
        >>> br2.update_revisions(br1)
 
709
        Added 2 texts.
 
710
        Added 1 inventories.
 
711
        Added 1 revisions.
 
712
        >>> br2.revision_history()
 
713
        [u'REVISION-ID-1']
 
714
        >>> br2.update_revisions(br1)
 
715
        Added 0 texts.
 
716
        Added 0 inventories.
 
717
        Added 0 revisions.
 
718
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
719
        True
 
720
        """
 
721
        revision_ids = self.missing_revisions(other)
 
722
        revisions = [other.get_revision(f) for f in revision_ids]
 
723
        needed_texts = sets.Set()
 
724
        for rev in revisions:
 
725
            inv = other.get_inventory(str(rev.inventory_id))
 
726
            for key, entry in inv.iter_entries():
 
727
                if entry.text_id is None:
 
728
                    continue
 
729
                if entry.text_id not in self.text_store:
 
730
                    needed_texts.add(entry.text_id)
 
731
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
732
        print "Added %d texts." % count 
 
733
        inventory_ids = [ f.inventory_id for f in revisions ]
 
734
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
735
                                                inventory_ids)
 
736
        print "Added %d inventories." % count 
 
737
        revision_ids = [ f.revision_id for f in revisions]
 
738
        count = self.revision_store.copy_multi(other.revision_store, 
 
739
                                               revision_ids)
 
740
        for revision_id in revision_ids:
 
741
            self.append_revision(revision_id)
 
742
        print "Added %d revisions." % count
 
743
                    
816
744
        
817
 
        return other_history[self_len:stop_revision]
818
 
 
819
 
 
820
 
    def update_revisions(self, other, stop_revision=None):
821
 
        """Pull in all new revisions from other branch.
822
 
        """
823
 
        from bzrlib.fetch import greedy_fetch
824
 
 
825
 
        pb = bzrlib.ui.ui_factory.progress_bar()
826
 
        pb.update('comparing histories')
827
 
 
828
 
        revision_ids = self.missing_revisions(other, stop_revision)
829
 
 
830
 
        if len(revision_ids) > 0:
831
 
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
832
 
        else:
833
 
            count = 0
834
 
        self.append_revision(*revision_ids)
835
 
        ## note("Added %d revisions." % count)
836
 
        pb.clear()
837
 
 
838
 
 
839
745
    def commit(self, *args, **kw):
840
 
        from bzrlib.commit import Commit
841
 
        Commit().commit(self, *args, **kw)
 
746
        """Deprecated"""
 
747
        from bzrlib.commit import commit
 
748
        commit(self, *args, **kw)
842
749
        
843
750
 
844
 
    def lookup_revision(self, revision):
845
 
        """Return the revision identifier for a given revision information."""
846
 
        revno, info = self._get_revision_info(revision)
847
 
        return info
848
 
 
849
 
 
850
 
    def revision_id_to_revno(self, revision_id):
851
 
        """Given a revision id, return its revno"""
852
 
        history = self.revision_history()
853
 
        try:
854
 
            return history.index(revision_id) + 1
855
 
        except ValueError:
856
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
857
 
 
858
 
 
859
 
    def get_revision_info(self, revision):
860
 
        """Return (revno, revision id) for revision identifier.
861
 
 
862
 
        revision can be an integer, in which case it is assumed to be revno (though
863
 
            this will translate negative values into positive ones)
864
 
        revision can also be a string, in which case it is parsed for something like
865
 
            'date:' or 'revid:' etc.
866
 
        """
867
 
        revno, rev_id = self._get_revision_info(revision)
868
 
        if revno is None:
869
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
870
 
        return revno, rev_id
871
 
 
872
 
    def get_rev_id(self, revno, history=None):
873
 
        """Find the revision id of the specified revno."""
 
751
    def lookup_revision(self, revno):
 
752
        """Return revision hash for revision number."""
874
753
        if revno == 0:
875
754
            return None
876
 
        if history is None:
877
 
            history = self.revision_history()
878
 
        elif revno <= 0 or revno > len(history):
879
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
880
 
        return history[revno - 1]
881
 
 
882
 
    def _get_revision_info(self, revision):
883
 
        """Return (revno, revision id) for revision specifier.
884
 
 
885
 
        revision can be an integer, in which case it is assumed to be revno
886
 
        (though this will translate negative values into positive ones)
887
 
        revision can also be a string, in which case it is parsed for something
888
 
        like 'date:' or 'revid:' etc.
889
 
 
890
 
        A revid is always returned.  If it is None, the specifier referred to
891
 
        the null revision.  If the revid does not occur in the revision
892
 
        history, revno will be None.
893
 
        """
894
 
        
895
 
        if revision is None:
896
 
            return 0, None
897
 
        revno = None
898
 
        try:# Convert to int if possible
899
 
            revision = int(revision)
900
 
        except ValueError:
901
 
            pass
902
 
        revs = self.revision_history()
903
 
        if isinstance(revision, int):
904
 
            if revision < 0:
905
 
                revno = len(revs) + revision + 1
906
 
            else:
907
 
                revno = revision
908
 
            rev_id = self.get_rev_id(revno, revs)
909
 
        elif isinstance(revision, basestring):
910
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
 
                if revision.startswith(prefix):
912
 
                    result = func(self, revs, revision)
913
 
                    if len(result) > 1:
914
 
                        revno, rev_id = result
915
 
                    else:
916
 
                        revno = result[0]
917
 
                        rev_id = self.get_rev_id(revno, revs)
918
 
                    break
919
 
            else:
920
 
                raise BzrError('No namespace registered for string: %r' %
921
 
                               revision)
922
 
        else:
923
 
            raise TypeError('Unhandled revision type %s' % revision)
924
 
 
925
 
        if revno is None:
926
 
            if rev_id is None:
927
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
928
 
        return revno, rev_id
929
 
 
930
 
    def _namespace_revno(self, revs, revision):
931
 
        """Lookup a revision by revision number"""
932
 
        assert revision.startswith('revno:')
933
 
        try:
934
 
            return (int(revision[6:]),)
935
 
        except ValueError:
936
 
            return None
937
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
938
 
 
939
 
    def _namespace_revid(self, revs, revision):
940
 
        assert revision.startswith('revid:')
941
 
        rev_id = revision[len('revid:'):]
942
 
        try:
943
 
            return revs.index(rev_id) + 1, rev_id
944
 
        except ValueError:
945
 
            return None, rev_id
946
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
947
 
 
948
 
    def _namespace_last(self, revs, revision):
949
 
        assert revision.startswith('last:')
950
 
        try:
951
 
            offset = int(revision[5:])
952
 
        except ValueError:
953
 
            return (None,)
954
 
        else:
955
 
            if offset <= 0:
956
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
957
 
            return (len(revs) - offset + 1,)
958
 
    REVISION_NAMESPACES['last:'] = _namespace_last
959
 
 
960
 
    def _namespace_tag(self, revs, revision):
961
 
        assert revision.startswith('tag:')
962
 
        raise BzrError('tag: namespace registered, but not implemented.')
963
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
964
 
 
965
 
    def _namespace_date(self, revs, revision):
966
 
        assert revision.startswith('date:')
967
 
        import datetime
968
 
        # Spec for date revisions:
969
 
        #   date:value
970
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
 
        #   it can also start with a '+/-/='. '+' says match the first
972
 
        #   entry after the given date. '-' is match the first entry before the date
973
 
        #   '=' is match the first entry after, but still on the given date.
974
 
        #
975
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
 
        #       May 13th, 2005 at 0:00
979
 
        #
980
 
        #   So the proper way of saying 'give me all entries for today' is:
981
 
        #       -r {date:+today}:{date:-tomorrow}
982
 
        #   The default is '=' when not supplied
983
 
        val = revision[5:]
984
 
        match_style = '='
985
 
        if val[:1] in ('+', '-', '='):
986
 
            match_style = val[:1]
987
 
            val = val[1:]
988
 
 
989
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
 
        if val.lower() == 'yesterday':
991
 
            dt = today - datetime.timedelta(days=1)
992
 
        elif val.lower() == 'today':
993
 
            dt = today
994
 
        elif val.lower() == 'tomorrow':
995
 
            dt = today + datetime.timedelta(days=1)
996
 
        else:
997
 
            import re
998
 
            # This should be done outside the function to avoid recompiling it.
999
 
            _date_re = re.compile(
1000
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1001
 
                    r'(,|T)?\s*'
1002
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1003
 
                )
1004
 
            m = _date_re.match(val)
1005
 
            if not m or (not m.group('date') and not m.group('time')):
1006
 
                raise BzrError('Invalid revision date %r' % revision)
1007
 
 
1008
 
            if m.group('date'):
1009
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1010
 
            else:
1011
 
                year, month, day = today.year, today.month, today.day
1012
 
            if m.group('time'):
1013
 
                hour = int(m.group('hour'))
1014
 
                minute = int(m.group('minute'))
1015
 
                if m.group('second'):
1016
 
                    second = int(m.group('second'))
1017
 
                else:
1018
 
                    second = 0
1019
 
            else:
1020
 
                hour, minute, second = 0,0,0
1021
 
 
1022
 
            dt = datetime.datetime(year=year, month=month, day=day,
1023
 
                    hour=hour, minute=minute, second=second)
1024
 
        first = dt
1025
 
        last = None
1026
 
        reversed = False
1027
 
        if match_style == '-':
1028
 
            reversed = True
1029
 
        elif match_style == '=':
1030
 
            last = dt + datetime.timedelta(days=1)
1031
 
 
1032
 
        if reversed:
1033
 
            for i in range(len(revs)-1, -1, -1):
1034
 
                r = self.get_revision(revs[i])
1035
 
                # TODO: Handle timezone.
1036
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
 
                if first >= dt and (last is None or dt >= last):
1038
 
                    return (i+1,)
1039
 
        else:
1040
 
            for i in range(len(revs)):
1041
 
                r = self.get_revision(revs[i])
1042
 
                # TODO: Handle timezone.
1043
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
 
                if first <= dt and (last is None or dt <= last):
1045
 
                    return (i+1,)
1046
 
    REVISION_NAMESPACES['date:'] = _namespace_date
 
755
 
 
756
        try:
 
757
            # list is 0-based; revisions are 1-based
 
758
            return self.revision_history()[revno-1]
 
759
        except IndexError:
 
760
            raise BzrError("no such revision %s" % revno)
 
761
 
1047
762
 
1048
763
    def revision_tree(self, revision_id):
1049
764
        """Return Tree for a revision on this branch.
1056
771
            return EmptyTree()
1057
772
        else:
1058
773
            inv = self.get_revision_inventory(revision_id)
1059
 
            return RevisionTree(self.weave_store, inv, revision_id)
 
774
            return RevisionTree(self.text_store, inv)
1060
775
 
1061
776
 
1062
777
    def working_tree(self):
1070
785
 
1071
786
        If there are no revisions yet, return an `EmptyTree`.
1072
787
        """
1073
 
        return self.revision_tree(self.last_patch())
 
788
        r = self.last_patch()
 
789
        if r == None:
 
790
            return EmptyTree()
 
791
        else:
 
792
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
793
 
1074
794
 
1075
795
 
1076
796
    def rename_one(self, from_rel, to_rel):
1108
828
 
1109
829
            inv.rename(file_id, to_dir_id, to_tail)
1110
830
 
 
831
            print "%s => %s" % (from_rel, to_rel)
 
832
 
1111
833
            from_abs = self.abspath(from_rel)
1112
834
            to_abs = self.abspath(to_rel)
1113
835
            try:
1132
854
 
1133
855
        Note that to_name is only the last component of the new name;
1134
856
        this doesn't change the directory.
1135
 
 
1136
 
        This returns a list of (from_path, to_path) pairs for each
1137
 
        entry that is moved.
1138
857
        """
1139
 
        result = []
1140
858
        self.lock_write()
1141
859
        try:
1142
860
            ## TODO: Option to move IDs only
1177
895
            for f in from_paths:
1178
896
                name_tail = splitpath(f)[-1]
1179
897
                dest_path = appendpath(to_name, name_tail)
1180
 
                result.append((f, dest_path))
 
898
                print "%s => %s" % (f, dest_path)
1181
899
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1182
900
                try:
1183
901
                    os.rename(self.abspath(f), self.abspath(dest_path))
1189
907
        finally:
1190
908
            self.unlock()
1191
909
 
1192
 
        return result
1193
 
 
1194
 
 
1195
 
    def revert(self, filenames, old_tree=None, backups=True):
1196
 
        """Restore selected files to the versions from a previous tree.
1197
 
 
1198
 
        backups
1199
 
            If true (default) backups are made of files before
1200
 
            they're renamed.
1201
 
        """
1202
 
        from bzrlib.errors import NotVersionedError, BzrError
1203
 
        from bzrlib.atomicfile import AtomicFile
1204
 
        from bzrlib.osutils import backup_file
1205
 
        
1206
 
        inv = self.read_working_inventory()
1207
 
        if old_tree is None:
1208
 
            old_tree = self.basis_tree()
1209
 
        old_inv = old_tree.inventory
1210
 
 
1211
 
        nids = []
1212
 
        for fn in filenames:
1213
 
            file_id = inv.path2id(fn)
1214
 
            if not file_id:
1215
 
                raise NotVersionedError("not a versioned file", fn)
1216
 
            if not old_inv.has_id(file_id):
1217
 
                raise BzrError("file not present in old tree", fn, file_id)
1218
 
            nids.append((fn, file_id))
1219
 
            
1220
 
        # TODO: Rename back if it was previously at a different location
1221
 
 
1222
 
        # TODO: If given a directory, restore the entire contents from
1223
 
        # the previous version.
1224
 
 
1225
 
        # TODO: Make a backup to a temporary file.
1226
 
 
1227
 
        # TODO: If the file previously didn't exist, delete it?
1228
 
        for fn, file_id in nids:
1229
 
            backup_file(fn)
1230
 
            
1231
 
            f = AtomicFile(fn, 'wb')
1232
 
            try:
1233
 
                f.write(old_tree.get_file(file_id).read())
1234
 
                f.commit()
1235
 
            finally:
1236
 
                f.close()
1237
 
 
1238
 
 
1239
 
    def pending_merges(self):
1240
 
        """Return a list of pending merges.
1241
 
 
1242
 
        These are revisions that have been merged into the working
1243
 
        directory but not yet committed.
1244
 
        """
1245
 
        cfn = self.controlfilename('pending-merges')
1246
 
        if not os.path.exists(cfn):
1247
 
            return []
1248
 
        p = []
1249
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1250
 
            p.append(l.rstrip('\n'))
1251
 
        return p
1252
 
 
1253
 
 
1254
 
    def add_pending_merge(self, revision_id):
1255
 
        from bzrlib.revision import validate_revision_id
1256
 
 
1257
 
        validate_revision_id(revision_id)
1258
 
 
1259
 
        p = self.pending_merges()
1260
 
        if revision_id in p:
1261
 
            return
1262
 
        p.append(revision_id)
1263
 
        self.set_pending_merges(p)
1264
 
 
1265
 
 
1266
 
    def set_pending_merges(self, rev_list):
1267
 
        from bzrlib.atomicfile import AtomicFile
1268
 
        self.lock_write()
1269
 
        try:
1270
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1271
 
            try:
1272
 
                for l in rev_list:
1273
 
                    print >>f, l
1274
 
                f.commit()
1275
 
            finally:
1276
 
                f.close()
1277
 
        finally:
1278
 
            self.unlock()
1279
 
 
1280
 
 
1281
 
    def get_parent(self):
1282
 
        """Return the parent location of the branch.
1283
 
 
1284
 
        This is the default location for push/pull/missing.  The usual
1285
 
        pattern is that the user can override it by specifying a
1286
 
        location.
1287
 
        """
1288
 
        import errno
1289
 
        _locs = ['parent', 'pull', 'x-pull']
1290
 
        for l in _locs:
1291
 
            try:
1292
 
                return self.controlfile(l, 'r').read().strip('\n')
1293
 
            except IOError, e:
1294
 
                if e.errno != errno.ENOENT:
1295
 
                    raise
1296
 
        return None
1297
 
 
1298
 
 
1299
 
    def set_parent(self, url):
1300
 
        # TODO: Maybe delete old location files?
1301
 
        from bzrlib.atomicfile import AtomicFile
1302
 
        self.lock_write()
1303
 
        try:
1304
 
            f = AtomicFile(self.controlfilename('parent'))
1305
 
            try:
1306
 
                f.write(url + '\n')
1307
 
                f.commit()
1308
 
            finally:
1309
 
                f.close()
1310
 
        finally:
1311
 
            self.unlock()
1312
 
 
1313
 
    def check_revno(self, revno):
1314
 
        """\
1315
 
        Check whether a revno corresponds to any revision.
1316
 
        Zero (the NULL revision) is considered valid.
1317
 
        """
1318
 
        if revno != 0:
1319
 
            self.check_real_revno(revno)
1320
 
            
1321
 
    def check_real_revno(self, revno):
1322
 
        """\
1323
 
        Check whether a revno corresponds to a real revision.
1324
 
        Zero (the NULL revision) is considered invalid
1325
 
        """
1326
 
        if revno < 1 or revno > self.revno():
1327
 
            raise InvalidRevisionNumber(revno)
1328
 
        
1329
 
        
1330
910
 
1331
911
 
1332
912
class ScratchBranch(Branch):
1347
927
 
1348
928
        If any files are listed, they are created in the working copy.
1349
929
        """
1350
 
        from tempfile import mkdtemp
1351
930
        init = False
1352
931
        if base is None:
1353
 
            base = mkdtemp()
 
932
            base = tempfile.mkdtemp()
1354
933
            init = True
1355
934
        Branch.__init__(self, base, init=init)
1356
935
        for d in dirs:
1369
948
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1370
949
        True
1371
950
        """
1372
 
        from shutil import copytree
1373
 
        from tempfile import mkdtemp
1374
 
        base = mkdtemp()
 
951
        base = tempfile.mkdtemp()
1375
952
        os.rmdir(base)
1376
 
        copytree(self.base, base, symlinks=True)
 
953
        shutil.copytree(self.base, base, symlinks=True)
1377
954
        return ScratchBranch(base=base)
1378
 
 
1379
 
 
1380
955
        
1381
956
    def __del__(self):
1382
957
        self.destroy()
1383
958
 
1384
959
    def destroy(self):
1385
960
        """Destroy the test branch, removing the scratch directory."""
1386
 
        from shutil import rmtree
1387
961
        try:
1388
962
            if self.base:
1389
963
                mutter("delete ScratchBranch %s" % self.base)
1390
 
                rmtree(self.base)
 
964
                shutil.rmtree(self.base)
1391
965
        except OSError, e:
1392
966
            # Work around for shutil.rmtree failing on Windows when
1393
967
            # readonly files are encountered
1395
969
            for root, dirs, files in os.walk(self.base, topdown=False):
1396
970
                for name in files:
1397
971
                    os.chmod(os.path.join(root, name), 0700)
1398
 
            rmtree(self.base)
 
972
            shutil.rmtree(self.base)
1399
973
        self.base = None
1400
974
 
1401
975
    
1426
1000
    cope with just randomness because running uuidgen every time is
1427
1001
    slow."""
1428
1002
    import re
1429
 
    from binascii import hexlify
1430
 
    from time import time
1431
1003
 
1432
1004
    # get last component
1433
1005
    idx = name.rfind('/')
1445
1017
    name = re.sub(r'[^\w.]', '', name)
1446
1018
 
1447
1019
    s = hexlify(rand_bytes(8))
1448
 
    return '-'.join((name, compact_date(time()), s))
1449
 
 
1450
 
 
1451
 
def gen_root_id():
1452
 
    """Return a new tree-root file id."""
1453
 
    return gen_file_id('TREE_ROOT')
1454
 
 
1455
 
 
1456
 
def pull_loc(branch):
1457
 
    # TODO: Should perhaps just make attribute be 'base' in
1458
 
    # RemoteBranch and Branch?
1459
 
    if hasattr(branch, "baseurl"):
1460
 
        return branch.baseurl
1461
 
    else:
1462
 
        return branch.base
1463
 
 
1464
 
 
1465
 
def copy_branch(branch_from, to_location, revision=None):
1466
 
    """Copy branch_from into the existing directory to_location.
1467
 
 
1468
 
    revision
1469
 
        If not None, only revisions up to this point will be copied.
1470
 
        The head of the new branch will be that revision.
1471
 
 
1472
 
    to_location
1473
 
        The name of a local directory that exists but is empty.
1474
 
    """
1475
 
    from bzrlib.merge import merge
1476
 
    from bzrlib.branch import Branch
1477
 
 
1478
 
    assert isinstance(branch_from, Branch)
1479
 
    assert isinstance(to_location, basestring)
1480
 
    
1481
 
    br_to = Branch(to_location, init=True)
1482
 
    br_to.set_root_id(branch_from.get_root_id())
1483
 
    if revision is None:
1484
 
        revno = branch_from.revno()
1485
 
    else:
1486
 
        revno, rev_id = branch_from.get_revision_info(revision)
1487
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1488
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
 
          check_clean=False, ignore_zero=True)
1490
 
    
1491
 
    from_location = pull_loc(branch_from)
1492
 
    br_to.set_parent(pull_loc(branch_from))
1493
 
 
 
1020
    return '-'.join((name, compact_date(time.time()), s))