~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-01 04:09:38 UTC
  • Revision ID: mbp@sourcefrog.net-20050601040938-d905145b57ae017f
- unify two defintions of LockError

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
 
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
20
21
 
21
22
import bzrlib
22
 
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
 
 
27
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
 
     DivergedBranches, NotBranchError
29
 
from bzrlib.textui import show_status
30
 
from bzrlib.revision import Revision
31
 
from bzrlib.delta import compare_trees
32
 
from bzrlib.tree import EmptyTree, RevisionTree
33
 
import bzrlib.xml
34
 
import bzrlib.ui
35
 
 
36
 
 
 
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
37
34
 
38
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
39
36
## TODO: Maybe include checks for common corruption of newlines, etc?
40
37
 
41
38
 
42
 
# TODO: Some operations like log might retrieve the same revisions
43
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
44
 
# cache in memory to make this faster.
45
 
 
46
 
# TODO: please move the revision-string syntax stuff out of the branch
47
 
# object; it's clutter
48
 
 
49
39
 
50
40
def find_branch(f, **args):
51
41
    if f and (f.startswith('http://') or f.startswith('https://')):
52
 
        from bzrlib.remotebranch import RemoteBranch
53
 
        return RemoteBranch(f, **args)
 
42
        import remotebranch 
 
43
        return remotebranch.RemoteBranch(f, **args)
54
44
    else:
55
45
        return Branch(f, **args)
56
46
 
57
47
 
58
 
def find_cached_branch(f, cache_root, **args):
59
 
    from bzrlib.remotebranch import RemoteBranch
60
 
    br = find_branch(f, **args)
61
 
    def cacheify(br, store_name):
62
 
        from bzrlib.meta_store import CachedStore
63
 
        cache_path = os.path.join(cache_root, store_name)
64
 
        os.mkdir(cache_path)
65
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
66
 
        setattr(br, store_name, new_store)
67
 
 
68
 
    if isinstance(br, RemoteBranch):
69
 
        cacheify(br, 'inventory_store')
70
 
        cacheify(br, 'text_store')
71
 
        cacheify(br, 'revision_store')
72
 
    return br
73
 
 
74
48
 
75
49
def _relpath(base, path):
76
50
    """Return path relative to base, or raise exception.
94
68
        if tail:
95
69
            s.insert(0, tail)
96
70
    else:
 
71
        from errors import NotBranchError
97
72
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
98
73
 
99
74
    return os.sep.join(s)
107
82
    It is not necessary that f exists.
108
83
 
109
84
    Basically we keep looking up until we find the control directory or
110
 
    run into the root.  If there isn't one, raises NotBranchError.
111
 
    """
 
85
    run into the root."""
112
86
    if f == None:
113
87
        f = os.getcwd()
114
88
    elif hasattr(os.path, 'realpath'):
127
101
        head, tail = os.path.split(f)
128
102
        if head == f:
129
103
            # reached the root, whatever that may be
130
 
            raise NotBranchError('%s is not in a branch' % orig_f)
 
104
            raise BzrError('%r is not in a branch' % orig_f)
131
105
        f = head
132
 
 
133
 
 
 
106
    
134
107
 
135
108
 
136
109
######################################################################
155
128
    base = None
156
129
    _lock_mode = None
157
130
    _lock_count = None
158
 
    _lock = None
159
131
    
160
 
    # Map some sort of prefix into a namespace
161
 
    # stuff like "revno:10", "revid:", etc.
162
 
    # This should match a prefix with a function which accepts
163
 
    REVISION_NAMESPACES = {}
164
 
 
165
132
    def __init__(self, base, init=False, find_root=True):
166
133
        """Create new branch object at a particular location.
167
134
 
168
 
        base -- Base directory for the branch. May be a file:// url.
 
135
        base -- Base directory for the branch.
169
136
        
170
137
        init -- If True, create new control files in a previously
171
138
             unversioned directory.  If False, the branch must already
177
144
        In the test suite, creation of new trees is tested using the
178
145
        `ScratchBranch` class.
179
146
        """
180
 
        from bzrlib.store import ImmutableStore
181
147
        if init:
182
148
            self.base = os.path.realpath(base)
183
149
            self._make_control()
184
150
        elif find_root:
185
151
            self.base = find_branch_root(base)
186
152
        else:
187
 
            if base.startswith("file://"):
188
 
                base = base[7:]
189
153
            self.base = os.path.realpath(base)
190
154
            if not isdir(self.controlfilename('.')):
 
155
                from errors import NotBranchError
191
156
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
192
157
                                     ['use "bzr init" to initialize a new working tree',
193
158
                                      'current bzr can only operate from top-of-tree'])
194
159
        self._check_format()
 
160
        self._lockfile = self.controlfile('branch-lock', 'wb')
195
161
 
196
162
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
197
163
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
206
172
 
207
173
 
208
174
    def __del__(self):
209
 
        if self._lock_mode or self._lock:
210
 
            from bzrlib.warnings import warn
 
175
        if self._lock_mode:
 
176
            from warnings import warn
211
177
            warn("branch %r was not explicitly unlocked" % self)
212
 
            self._lock.unlock()
 
178
            self.unlock()
 
179
 
 
180
 
213
181
 
214
182
    def lock_write(self):
215
183
        if self._lock_mode:
216
184
            if self._lock_mode != 'w':
217
 
                from bzrlib.errors import LockError
 
185
                from errors import LockError
218
186
                raise LockError("can't upgrade to a write lock from %r" %
219
187
                                self._lock_mode)
220
188
            self._lock_count += 1
221
189
        else:
222
 
            from bzrlib.lock import WriteLock
 
190
            from bzrlib.lock import lock, LOCK_EX
223
191
 
224
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
192
            lock(self._lockfile, LOCK_EX)
225
193
            self._lock_mode = 'w'
226
194
            self._lock_count = 1
227
195
 
228
196
 
 
197
 
229
198
    def lock_read(self):
230
199
        if self._lock_mode:
231
200
            assert self._lock_mode in ('r', 'w'), \
232
201
                   "invalid lock mode %r" % self._lock_mode
233
202
            self._lock_count += 1
234
203
        else:
235
 
            from bzrlib.lock import ReadLock
 
204
            from bzrlib.lock import lock, LOCK_SH
236
205
 
237
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
206
            lock(self._lockfile, LOCK_SH)
238
207
            self._lock_mode = 'r'
239
208
            self._lock_count = 1
240
209
                        
 
210
 
 
211
            
241
212
    def unlock(self):
242
213
        if not self._lock_mode:
243
 
            from bzrlib.errors import LockError
 
214
            from errors import LockError
244
215
            raise LockError('branch %r is not locked' % (self))
245
216
 
246
217
        if self._lock_count > 1:
247
218
            self._lock_count -= 1
248
219
        else:
249
 
            self._lock.unlock()
250
 
            self._lock = None
 
220
            assert self._lock_count == 1
 
221
            from bzrlib.lock import unlock
 
222
            unlock(self._lockfile)
251
223
            self._lock_mode = self._lock_count = None
252
224
 
 
225
 
253
226
    def abspath(self, name):
254
227
        """Return absolute filename for something in the branch"""
255
228
        return os.path.join(self.base, name)
256
229
 
 
230
 
257
231
    def relpath(self, path):
258
232
        """Return path relative to this branch of something inside it.
259
233
 
260
234
        Raises an error if path is not in this branch."""
261
235
        return _relpath(self.base, path)
262
236
 
 
237
 
263
238
    def controlfilename(self, file_or_path):
264
239
        """Return location relative to branch."""
265
 
        if isinstance(file_or_path, basestring):
 
240
        if isinstance(file_or_path, types.StringTypes):
266
241
            file_or_path = [file_or_path]
267
242
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
268
243
 
292
267
        else:
293
268
            raise BzrError("invalid controlfile mode %r" % mode)
294
269
 
 
270
 
 
271
 
295
272
    def _make_control(self):
296
 
        from bzrlib.inventory import Inventory
297
 
        
298
273
        os.mkdir(self.controlfilename([]))
299
274
        self.controlfile('README', 'w').write(
300
275
            "This is a Bazaar-NG control directory.\n"
301
 
            "Do not change any files in this directory.\n")
 
276
            "Do not change any files in this directory.")
302
277
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
303
278
        for d in ('text-store', 'inventory-store', 'revision-store'):
304
279
            os.mkdir(self.controlfilename(d))
305
280
        for f in ('revision-history', 'merged-patches',
306
281
                  'pending-merged-patches', 'branch-name',
307
 
                  'branch-lock',
308
 
                  'pending-merges'):
 
282
                  'branch-lock'):
309
283
            self.controlfile(f, 'w').write('')
310
284
        mutter('created control directory in ' + self.base)
311
 
 
312
 
        # if we want per-tree root ids then this is the place to set
313
 
        # them; they're not needed for now and so ommitted for
314
 
        # simplicity.
315
 
        f = self.controlfile('inventory','w')
316
 
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
 
285
        Inventory().write_xml(self.controlfile('inventory','w'))
317
286
 
318
287
 
319
288
    def _check_format(self):
328
297
        # on Windows from Linux and so on.  I think it might be better
329
298
        # to always make all internal files in unix format.
330
299
        fmt = self.controlfile('branch-format', 'r').read()
331
 
        fmt = fmt.replace('\r\n', '\n')
 
300
        fmt.replace('\r\n', '')
332
301
        if fmt != BZR_BRANCH_FORMAT:
333
302
            raise BzrError('sorry, branch format %r not supported' % fmt,
334
303
                           ['use a different bzr version',
335
304
                            'or remove the .bzr directory and "bzr init" again'])
336
305
 
337
 
    def get_root_id(self):
338
 
        """Return the id of this branches root"""
339
 
        inv = self.read_working_inventory()
340
 
        return inv.root.file_id
341
306
 
342
 
    def set_root_id(self, file_id):
343
 
        inv = self.read_working_inventory()
344
 
        orig_root_id = inv.root.file_id
345
 
        del inv._byid[inv.root.file_id]
346
 
        inv.root.file_id = file_id
347
 
        inv._byid[inv.root.file_id] = inv.root
348
 
        for fid in inv:
349
 
            entry = inv[fid]
350
 
            if entry.parent_id in (None, orig_root_id):
351
 
                entry.parent_id = inv.root.file_id
352
 
        self._write_inventory(inv)
353
307
 
354
308
    def read_working_inventory(self):
355
309
        """Read the working inventory."""
356
 
        from bzrlib.inventory import Inventory
 
310
        before = time.time()
 
311
        # ElementTree does its own conversion from UTF-8, so open in
 
312
        # binary.
357
313
        self.lock_read()
358
314
        try:
359
 
            # ElementTree does its own conversion from UTF-8, so open in
360
 
            # binary.
361
 
            f = self.controlfile('inventory', 'rb')
362
 
            return bzrlib.xml.serializer_v4.read_inventory(f)
 
315
            inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
316
            mutter("loaded inventory of %d items in %f"
 
317
                   % (len(inv), time.time() - before))
 
318
            return inv
363
319
        finally:
364
320
            self.unlock()
365
321
            
370
326
        That is to say, the inventory describing changes underway, that
371
327
        will be committed to the next revision.
372
328
        """
373
 
        from bzrlib.atomicfile import AtomicFile
374
 
        
375
 
        self.lock_write()
376
 
        try:
377
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
378
 
            try:
379
 
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
380
 
                f.commit()
381
 
            finally:
382
 
                f.close()
383
 
        finally:
384
 
            self.unlock()
385
 
        
 
329
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
330
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
331
        tmpfname = self.controlfilename('inventory.tmp')
 
332
        tmpf = file(tmpfname, 'wb')
 
333
        inv.write_xml(tmpf)
 
334
        tmpf.close()
 
335
        inv_fname = self.controlfilename('inventory')
 
336
        if sys.platform == 'win32':
 
337
            os.remove(inv_fname)
 
338
        os.rename(tmpfname, inv_fname)
386
339
        mutter('wrote working inventory')
387
340
            
388
341
 
390
343
                         """Inventory for the working copy.""")
391
344
 
392
345
 
393
 
    def add(self, files, ids=None):
 
346
    def add(self, files, verbose=False, ids=None):
394
347
        """Make files versioned.
395
348
 
396
 
        Note that the command line normally calls smart_add instead,
397
 
        which can automatically recurse.
 
349
        Note that the command line normally calls smart_add instead.
398
350
 
399
351
        This puts the files in the Added state, so that they will be
400
352
        recorded by the next commit.
410
362
        TODO: Perhaps have an option to add the ids even if the files do
411
363
              not (yet) exist.
412
364
 
413
 
        TODO: Perhaps yield the ids and paths as they're added.
 
365
        TODO: Perhaps return the ids of the files?  But then again it
 
366
              is easy to retrieve them if they're needed.
 
367
 
 
368
        TODO: Adding a directory should optionally recurse down and
 
369
              add all non-ignored children.  Perhaps do that in a
 
370
              higher-level method.
414
371
        """
415
372
        # TODO: Re-adding a file that is removed in the working copy
416
373
        # should probably put it back with the previous ID.
417
 
        if isinstance(files, basestring):
418
 
            assert(ids is None or isinstance(ids, basestring))
 
374
        if isinstance(files, types.StringTypes):
 
375
            assert(ids is None or isinstance(ids, types.StringTypes))
419
376
            files = [files]
420
377
            if ids is not None:
421
378
                ids = [ids]
452
409
                    file_id = gen_file_id(f)
453
410
                inv.add_path(f, kind=kind, file_id=file_id)
454
411
 
 
412
                if verbose:
 
413
                    show_status('A', kind, quotefn(f))
 
414
 
455
415
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
456
416
 
457
417
            self._write_inventory(inv)
467
427
            # use inventory as it was in that revision
468
428
            file_id = tree.inventory.path2id(file)
469
429
            if not file_id:
470
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
430
                raise BzrError("%r is not present in revision %d" % (file, revno))
471
431
            tree.print_file(file_id)
472
432
        finally:
473
433
            self.unlock()
489
449
        """
490
450
        ## TODO: Normalize names
491
451
        ## TODO: Remove nested loops; better scalability
492
 
        if isinstance(files, basestring):
 
452
        if isinstance(files, types.StringTypes):
493
453
            files = [files]
494
454
 
495
455
        self.lock_write()
520
480
 
521
481
    # FIXME: this doesn't need to be a branch method
522
482
    def set_inventory(self, new_inventory_list):
523
 
        from bzrlib.inventory import Inventory, InventoryEntry
524
 
        inv = Inventory(self.get_root_id())
 
483
        inv = Inventory()
525
484
        for path, file_id, parent, kind in new_inventory_list:
526
485
            name = os.path.basename(path)
527
486
            if name == "":
549
508
        return self.working_tree().unknowns()
550
509
 
551
510
 
552
 
    def append_revision(self, *revision_ids):
553
 
        from bzrlib.atomicfile import AtomicFile
554
 
 
555
 
        for revision_id in revision_ids:
556
 
            mutter("add {%s} to revision-history" % revision_id)
557
 
 
 
511
    def append_revision(self, revision_id):
 
512
        mutter("add {%s} to revision-history" % revision_id)
558
513
        rev_history = self.revision_history()
559
 
        rev_history.extend(revision_ids)
560
 
 
561
 
        f = AtomicFile(self.controlfilename('revision-history'))
562
 
        try:
563
 
            for rev_id in rev_history:
564
 
                print >>f, rev_id
565
 
            f.commit()
566
 
        finally:
567
 
            f.close()
568
 
 
569
 
 
570
 
    def get_revision_xml_file(self, revision_id):
571
 
        """Return XML file object for revision object."""
572
 
        if not revision_id or not isinstance(revision_id, basestring):
573
 
            raise InvalidRevisionId(revision_id)
574
 
 
575
 
        self.lock_read()
576
 
        try:
577
 
            try:
578
 
                return self.revision_store[revision_id]
579
 
            except (IndexError, KeyError):
580
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
581
 
        finally:
582
 
            self.unlock()
583
 
 
584
 
 
585
 
    #deprecated
586
 
    get_revision_xml = get_revision_xml_file
 
514
 
 
515
        tmprhname = self.controlfilename('revision-history.tmp')
 
516
        rhname = self.controlfilename('revision-history')
 
517
        
 
518
        f = file(tmprhname, 'wt')
 
519
        rev_history.append(revision_id)
 
520
        f.write('\n'.join(rev_history))
 
521
        f.write('\n')
 
522
        f.close()
 
523
 
 
524
        if sys.platform == 'win32':
 
525
            os.remove(rhname)
 
526
        os.rename(tmprhname, rhname)
 
527
        
587
528
 
588
529
 
589
530
    def get_revision(self, revision_id):
590
531
        """Return the Revision object for a named revision"""
591
 
        xml_file = self.get_revision_xml_file(revision_id)
592
 
 
593
 
        try:
594
 
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
595
 
        except SyntaxError, e:
596
 
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
597
 
                                         [revision_id,
598
 
                                          str(e)])
599
 
            
 
532
        r = Revision.read_xml(self.revision_store[revision_id])
600
533
        assert r.revision_id == revision_id
601
534
        return r
602
535
 
603
536
 
604
 
    def get_revision_delta(self, revno):
605
 
        """Return the delta for one revision.
606
 
 
607
 
        The delta is relative to its mainline predecessor, or the
608
 
        empty tree for revision 1.
609
 
        """
610
 
        assert isinstance(revno, int)
611
 
        rh = self.revision_history()
612
 
        if not (1 <= revno <= len(rh)):
613
 
            raise InvalidRevisionNumber(revno)
614
 
 
615
 
        # revno is 1-based; list is 0-based
616
 
 
617
 
        new_tree = self.revision_tree(rh[revno-1])
618
 
        if revno == 1:
619
 
            old_tree = EmptyTree()
620
 
        else:
621
 
            old_tree = self.revision_tree(rh[revno-2])
622
 
 
623
 
        return compare_trees(old_tree, new_tree)
624
 
 
625
 
        
626
 
 
627
 
    def get_revision_sha1(self, revision_id):
628
 
        """Hash the stored value of a revision, and return it."""
629
 
        # In the future, revision entries will be signed. At that
630
 
        # point, it is probably best *not* to include the signature
631
 
        # in the revision hash. Because that lets you re-sign
632
 
        # the revision, (add signatures/remove signatures) and still
633
 
        # have all hash pointers stay consistent.
634
 
        # But for now, just hash the contents.
635
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
636
 
 
637
 
 
638
537
    def get_inventory(self, inventory_id):
639
538
        """Get Inventory object by hash.
640
539
 
641
540
        TODO: Perhaps for this and similar methods, take a revision
642
541
               parameter which can be either an integer revno or a
643
542
               string hash."""
644
 
        from bzrlib.inventory import Inventory
645
 
 
646
 
        f = self.get_inventory_xml_file(inventory_id)
647
 
        return bzrlib.xml.serializer_v4.read_inventory(f)
648
 
 
649
 
 
650
 
    def get_inventory_xml(self, inventory_id):
651
 
        """Get inventory XML as a file object."""
652
 
        return self.inventory_store[inventory_id]
653
 
 
654
 
    get_inventory_xml_file = get_inventory_xml
655
 
            
656
 
 
657
 
    def get_inventory_sha1(self, inventory_id):
658
 
        """Return the sha1 hash of the inventory entry
659
 
        """
660
 
        return sha_file(self.get_inventory_xml(inventory_id))
 
543
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
544
        return i
661
545
 
662
546
 
663
547
    def get_revision_inventory(self, revision_id):
664
548
        """Return inventory of a past revision."""
665
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
666
 
        # must be the same as its revision, so this is trivial.
667
549
        if revision_id == None:
668
 
            from bzrlib.inventory import Inventory
669
 
            return Inventory(self.get_root_id())
 
550
            return Inventory()
670
551
        else:
671
 
            return self.get_inventory(revision_id)
 
552
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
672
553
 
673
554
 
674
555
    def revision_history(self):
685
566
            self.unlock()
686
567
 
687
568
 
688
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
689
 
        """
690
 
        >>> from bzrlib.commit import commit
691
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
692
 
        >>> sb.common_ancestor(sb) == (None, None)
693
 
        True
694
 
        >>> commit(sb, "Committing first revision", verbose=False)
695
 
        >>> sb.common_ancestor(sb)[0]
696
 
        1
697
 
        >>> clone = sb.clone()
698
 
        >>> commit(sb, "Committing second revision", verbose=False)
699
 
        >>> sb.common_ancestor(sb)[0]
700
 
        2
701
 
        >>> sb.common_ancestor(clone)[0]
702
 
        1
703
 
        >>> commit(clone, "Committing divergent second revision", 
704
 
        ...               verbose=False)
705
 
        >>> sb.common_ancestor(clone)[0]
706
 
        1
707
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
708
 
        True
709
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
710
 
        True
711
 
        >>> clone2 = sb.clone()
712
 
        >>> sb.common_ancestor(clone2)[0]
713
 
        2
714
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
715
 
        1
716
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
717
 
        1
718
 
        """
719
 
        my_history = self.revision_history()
720
 
        other_history = other.revision_history()
721
 
        if self_revno is None:
722
 
            self_revno = len(my_history)
723
 
        if other_revno is None:
724
 
            other_revno = len(other_history)
725
 
        indices = range(min((self_revno, other_revno)))
726
 
        indices.reverse()
727
 
        for r in indices:
728
 
            if my_history[r] == other_history[r]:
729
 
                return r+1, my_history[r]
730
 
        return None, None
 
569
    def enum_history(self, direction):
 
570
        """Return (revno, revision_id) for history of branch.
 
571
 
 
572
        direction
 
573
            'forward' is from earliest to latest
 
574
            'reverse' is from latest to earliest
 
575
        """
 
576
        rh = self.revision_history()
 
577
        if direction == 'forward':
 
578
            i = 1
 
579
            for rid in rh:
 
580
                yield i, rid
 
581
                i += 1
 
582
        elif direction == 'reverse':
 
583
            i = len(rh)
 
584
            while i > 0:
 
585
                yield i, rh[i-1]
 
586
                i -= 1
 
587
        else:
 
588
            raise ValueError('invalid history direction', direction)
731
589
 
732
590
 
733
591
    def revno(self):
749
607
            return None
750
608
 
751
609
 
752
 
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
753
 
        """
754
 
        If self and other have not diverged, return a list of the revisions
755
 
        present in other, but missing from self.
756
 
 
757
 
        >>> from bzrlib.commit import commit
758
 
        >>> bzrlib.trace.silent = True
759
 
        >>> br1 = ScratchBranch()
760
 
        >>> br2 = ScratchBranch()
761
 
        >>> br1.missing_revisions(br2)
762
 
        []
763
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
764
 
        >>> br1.missing_revisions(br2)
765
 
        [u'REVISION-ID-1']
766
 
        >>> br2.missing_revisions(br1)
767
 
        []
768
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
769
 
        >>> br1.missing_revisions(br2)
770
 
        []
771
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
772
 
        >>> br1.missing_revisions(br2)
773
 
        [u'REVISION-ID-2A']
774
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
775
 
        >>> br1.missing_revisions(br2)
776
 
        Traceback (most recent call last):
777
 
        DivergedBranches: These branches have diverged.
778
 
        """
779
 
        self_history = self.revision_history()
780
 
        self_len = len(self_history)
781
 
        other_history = other.revision_history()
782
 
        other_len = len(other_history)
783
 
        common_index = min(self_len, other_len) -1
784
 
        if common_index >= 0 and \
785
 
            self_history[common_index] != other_history[common_index]:
786
 
            raise DivergedBranches(self, other)
787
 
 
788
 
        if stop_revision is None:
789
 
            stop_revision = other_len
790
 
        elif stop_revision > other_len:
791
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
792
 
        
793
 
        return other_history[self_len:stop_revision]
794
 
 
795
 
 
796
 
    def update_revisions(self, other, stop_revision=None):
797
 
        """Pull in all new revisions from other branch.
798
 
        """
799
 
        from bzrlib.fetch import greedy_fetch
800
 
        from bzrlib.revision import get_intervening_revisions
801
 
 
802
 
        pb = bzrlib.ui.ui_factory.progress_bar()
803
 
        pb.update('comparing histories')
804
 
        if stop_revision is None:
805
 
            other_revision = other.last_patch()
806
 
        else:
807
 
            other_revision = other.lookup_revision(stop_revision)
808
 
        count = greedy_fetch(self, other, other_revision, pb)[0]
809
 
        try:
810
 
            revision_ids = self.missing_revisions(other, stop_revision)
811
 
        except DivergedBranches, e:
812
 
            try:
813
 
                revision_ids = get_intervening_revisions(self.last_patch(), 
814
 
                                                         other_revision, self)
815
 
                assert self.last_patch() not in revision_ids
816
 
            except bzrlib.errors.NotAncestor:
817
 
                raise e
818
 
 
819
 
        self.append_revision(*revision_ids)
820
 
        pb.clear()
821
 
 
822
 
    def install_revisions(self, other, revision_ids, pb):
823
 
        if hasattr(other.revision_store, "prefetch"):
824
 
            other.revision_store.prefetch(revision_ids)
825
 
        if hasattr(other.inventory_store, "prefetch"):
826
 
            inventory_ids = []
827
 
            for rev_id in revision_ids:
828
 
                try:
829
 
                    revision = other.get_revision(rev_id).inventory_id
830
 
                    inventory_ids.append(revision)
831
 
                except bzrlib.errors.NoSuchRevision:
832
 
                    pass
833
 
            other.inventory_store.prefetch(inventory_ids)
834
 
 
835
 
        if pb is None:
836
 
            pb = bzrlib.ui.ui_factory.progress_bar()
837
 
                
838
 
        revisions = []
839
 
        needed_texts = set()
840
 
        i = 0
841
 
 
842
 
        failures = set()
843
 
        for i, rev_id in enumerate(revision_ids):
844
 
            pb.update('fetching revision', i+1, len(revision_ids))
845
 
            try:
846
 
                rev = other.get_revision(rev_id)
847
 
            except bzrlib.errors.NoSuchRevision:
848
 
                failures.add(rev_id)
849
 
                continue
850
 
 
851
 
            revisions.append(rev)
852
 
            inv = other.get_inventory(str(rev.inventory_id))
853
 
            for key, entry in inv.iter_entries():
854
 
                if entry.text_id is None:
855
 
                    continue
856
 
                if entry.text_id not in self.text_store:
857
 
                    needed_texts.add(entry.text_id)
858
 
 
859
 
        pb.clear()
860
 
                    
861
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
862
 
                                                    needed_texts)
863
 
        #print "Added %d texts." % count 
864
 
        inventory_ids = [ f.inventory_id for f in revisions ]
865
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
866
 
                                                         inventory_ids)
867
 
        #print "Added %d inventories." % count 
868
 
        revision_ids = [ f.revision_id for f in revisions]
869
 
 
870
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
871
 
                                                          revision_ids,
872
 
                                                          permit_failure=True)
873
 
        assert len(cp_fail) == 0 
874
 
        return count, failures
875
 
       
876
 
 
877
610
    def commit(self, *args, **kw):
 
611
        """Deprecated"""
878
612
        from bzrlib.commit import commit
879
613
        commit(self, *args, **kw)
880
614
        
881
615
 
882
 
    def lookup_revision(self, revision):
883
 
        """Return the revision identifier for a given revision information."""
884
 
        revno, info = self._get_revision_info(revision)
885
 
        return info
886
 
 
887
 
 
888
 
    def revision_id_to_revno(self, revision_id):
889
 
        """Given a revision id, return its revno"""
890
 
        history = self.revision_history()
891
 
        try:
892
 
            return history.index(revision_id) + 1
893
 
        except ValueError:
894
 
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
895
 
 
896
 
 
897
 
    def get_revision_info(self, revision):
898
 
        """Return (revno, revision id) for revision identifier.
899
 
 
900
 
        revision can be an integer, in which case it is assumed to be revno (though
901
 
            this will translate negative values into positive ones)
902
 
        revision can also be a string, in which case it is parsed for something like
903
 
            'date:' or 'revid:' etc.
904
 
        """
905
 
        revno, rev_id = self._get_revision_info(revision)
906
 
        if revno is None:
907
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
908
 
        return revno, rev_id
909
 
 
910
 
    def get_rev_id(self, revno, history=None):
911
 
        """Find the revision id of the specified revno."""
 
616
    def lookup_revision(self, revno):
 
617
        """Return revision hash for revision number."""
912
618
        if revno == 0:
913
619
            return None
914
 
        if history is None:
915
 
            history = self.revision_history()
916
 
        elif revno <= 0 or revno > len(history):
917
 
            raise bzrlib.errors.NoSuchRevision(self, revno)
918
 
        return history[revno - 1]
919
 
 
920
 
    def _get_revision_info(self, revision):
921
 
        """Return (revno, revision id) for revision specifier.
922
 
 
923
 
        revision can be an integer, in which case it is assumed to be revno
924
 
        (though this will translate negative values into positive ones)
925
 
        revision can also be a string, in which case it is parsed for something
926
 
        like 'date:' or 'revid:' etc.
927
 
 
928
 
        A revid is always returned.  If it is None, the specifier referred to
929
 
        the null revision.  If the revid does not occur in the revision
930
 
        history, revno will be None.
931
 
        """
932
 
        
933
 
        if revision is None:
934
 
            return 0, None
935
 
        revno = None
936
 
        try:# Convert to int if possible
937
 
            revision = int(revision)
938
 
        except ValueError:
939
 
            pass
940
 
        revs = self.revision_history()
941
 
        if isinstance(revision, int):
942
 
            if revision < 0:
943
 
                revno = len(revs) + revision + 1
944
 
            else:
945
 
                revno = revision
946
 
            rev_id = self.get_rev_id(revno, revs)
947
 
        elif isinstance(revision, basestring):
948
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
949
 
                if revision.startswith(prefix):
950
 
                    result = func(self, revs, revision)
951
 
                    if len(result) > 1:
952
 
                        revno, rev_id = result
953
 
                    else:
954
 
                        revno = result[0]
955
 
                        rev_id = self.get_rev_id(revno, revs)
956
 
                    break
957
 
            else:
958
 
                raise BzrError('No namespace registered for string: %r' %
959
 
                               revision)
960
 
        else:
961
 
            raise TypeError('Unhandled revision type %s' % revision)
962
 
 
963
 
        if revno is None:
964
 
            if rev_id is None:
965
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
966
 
        return revno, rev_id
967
 
 
968
 
    def _namespace_revno(self, revs, revision):
969
 
        """Lookup a revision by revision number"""
970
 
        assert revision.startswith('revno:')
971
 
        try:
972
 
            return (int(revision[6:]),)
973
 
        except ValueError:
974
 
            return None
975
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
976
 
 
977
 
    def _namespace_revid(self, revs, revision):
978
 
        assert revision.startswith('revid:')
979
 
        rev_id = revision[len('revid:'):]
980
 
        try:
981
 
            return revs.index(rev_id) + 1, rev_id
982
 
        except ValueError:
983
 
            return None, rev_id
984
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
985
 
 
986
 
    def _namespace_last(self, revs, revision):
987
 
        assert revision.startswith('last:')
988
 
        try:
989
 
            offset = int(revision[5:])
990
 
        except ValueError:
991
 
            return (None,)
992
 
        else:
993
 
            if offset <= 0:
994
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
995
 
            return (len(revs) - offset + 1,)
996
 
    REVISION_NAMESPACES['last:'] = _namespace_last
997
 
 
998
 
    def _namespace_tag(self, revs, revision):
999
 
        assert revision.startswith('tag:')
1000
 
        raise BzrError('tag: namespace registered, but not implemented.')
1001
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
1002
 
 
1003
 
    def _namespace_date(self, revs, revision):
1004
 
        assert revision.startswith('date:')
1005
 
        import datetime
1006
 
        # Spec for date revisions:
1007
 
        #   date:value
1008
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1009
 
        #   it can also start with a '+/-/='. '+' says match the first
1010
 
        #   entry after the given date. '-' is match the first entry before the date
1011
 
        #   '=' is match the first entry after, but still on the given date.
1012
 
        #
1013
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1014
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1015
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1016
 
        #       May 13th, 2005 at 0:00
1017
 
        #
1018
 
        #   So the proper way of saying 'give me all entries for today' is:
1019
 
        #       -r {date:+today}:{date:-tomorrow}
1020
 
        #   The default is '=' when not supplied
1021
 
        val = revision[5:]
1022
 
        match_style = '='
1023
 
        if val[:1] in ('+', '-', '='):
1024
 
            match_style = val[:1]
1025
 
            val = val[1:]
1026
 
 
1027
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1028
 
        if val.lower() == 'yesterday':
1029
 
            dt = today - datetime.timedelta(days=1)
1030
 
        elif val.lower() == 'today':
1031
 
            dt = today
1032
 
        elif val.lower() == 'tomorrow':
1033
 
            dt = today + datetime.timedelta(days=1)
1034
 
        else:
1035
 
            import re
1036
 
            # This should be done outside the function to avoid recompiling it.
1037
 
            _date_re = re.compile(
1038
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1039
 
                    r'(,|T)?\s*'
1040
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1041
 
                )
1042
 
            m = _date_re.match(val)
1043
 
            if not m or (not m.group('date') and not m.group('time')):
1044
 
                raise BzrError('Invalid revision date %r' % revision)
1045
 
 
1046
 
            if m.group('date'):
1047
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1048
 
            else:
1049
 
                year, month, day = today.year, today.month, today.day
1050
 
            if m.group('time'):
1051
 
                hour = int(m.group('hour'))
1052
 
                minute = int(m.group('minute'))
1053
 
                if m.group('second'):
1054
 
                    second = int(m.group('second'))
1055
 
                else:
1056
 
                    second = 0
1057
 
            else:
1058
 
                hour, minute, second = 0,0,0
1059
 
 
1060
 
            dt = datetime.datetime(year=year, month=month, day=day,
1061
 
                    hour=hour, minute=minute, second=second)
1062
 
        first = dt
1063
 
        last = None
1064
 
        reversed = False
1065
 
        if match_style == '-':
1066
 
            reversed = True
1067
 
        elif match_style == '=':
1068
 
            last = dt + datetime.timedelta(days=1)
1069
 
 
1070
 
        if reversed:
1071
 
            for i in range(len(revs)-1, -1, -1):
1072
 
                r = self.get_revision(revs[i])
1073
 
                # TODO: Handle timezone.
1074
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1075
 
                if first >= dt and (last is None or dt >= last):
1076
 
                    return (i+1,)
1077
 
        else:
1078
 
            for i in range(len(revs)):
1079
 
                r = self.get_revision(revs[i])
1080
 
                # TODO: Handle timezone.
1081
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1082
 
                if first <= dt and (last is None or dt <= last):
1083
 
                    return (i+1,)
1084
 
    REVISION_NAMESPACES['date:'] = _namespace_date
1085
 
 
1086
 
 
1087
 
    def _namespace_ancestor(self, revs, revision):
1088
 
        from revision import common_ancestor, MultipleRevisionSources
1089
 
        other_branch = find_branch(_trim_namespace('ancestor', revision))
1090
 
        revision_a = self.last_patch()
1091
 
        revision_b = other_branch.last_patch()
1092
 
        for r, b in ((revision_a, self), (revision_b, other_branch)):
1093
 
            if r is None:
1094
 
                raise bzrlib.errors.NoCommits(b)
1095
 
        revision_source = MultipleRevisionSources(self, other_branch)
1096
 
        result = common_ancestor(revision_a, revision_b, revision_source)
1097
 
        try:
1098
 
            revno = self.revision_id_to_revno(result)
1099
 
        except bzrlib.errors.NoSuchRevision:
1100
 
            revno = None
1101
 
        return revno,result
1102
 
        
1103
 
 
1104
 
    REVISION_NAMESPACES['ancestor:'] = _namespace_ancestor
 
620
 
 
621
        try:
 
622
            # list is 0-based; revisions are 1-based
 
623
            return self.revision_history()[revno-1]
 
624
        except IndexError:
 
625
            raise BzrError("no such revision %s" % revno)
 
626
 
1105
627
 
1106
628
    def revision_tree(self, revision_id):
1107
629
        """Return Tree for a revision on this branch.
1119
641
 
1120
642
    def working_tree(self):
1121
643
        """Return a `Tree` for the working copy."""
1122
 
        from bzrlib.workingtree import WorkingTree
 
644
        from workingtree import WorkingTree
1123
645
        return WorkingTree(self.base, self.read_working_inventory())
1124
646
 
1125
647
 
1171
693
 
1172
694
            inv.rename(file_id, to_dir_id, to_tail)
1173
695
 
 
696
            print "%s => %s" % (from_rel, to_rel)
 
697
 
1174
698
            from_abs = self.abspath(from_rel)
1175
699
            to_abs = self.abspath(to_rel)
1176
700
            try:
1195
719
 
1196
720
        Note that to_name is only the last component of the new name;
1197
721
        this doesn't change the directory.
1198
 
 
1199
 
        This returns a list of (from_path, to_path) pairs for each
1200
 
        entry that is moved.
1201
722
        """
1202
 
        result = []
1203
723
        self.lock_write()
1204
724
        try:
1205
725
            ## TODO: Option to move IDs only
1240
760
            for f in from_paths:
1241
761
                name_tail = splitpath(f)[-1]
1242
762
                dest_path = appendpath(to_name, name_tail)
1243
 
                result.append((f, dest_path))
 
763
                print "%s => %s" % (f, dest_path)
1244
764
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1245
765
                try:
1246
766
                    os.rename(self.abspath(f), self.abspath(dest_path))
1252
772
        finally:
1253
773
            self.unlock()
1254
774
 
1255
 
        return result
1256
 
 
1257
 
 
1258
 
    def revert(self, filenames, old_tree=None, backups=True):
1259
 
        """Restore selected files to the versions from a previous tree.
1260
 
 
1261
 
        backups
1262
 
            If true (default) backups are made of files before
1263
 
            they're renamed.
1264
 
        """
1265
 
        from bzrlib.errors import NotVersionedError, BzrError
1266
 
        from bzrlib.atomicfile import AtomicFile
1267
 
        from bzrlib.osutils import backup_file
1268
 
        
1269
 
        inv = self.read_working_inventory()
1270
 
        if old_tree is None:
1271
 
            old_tree = self.basis_tree()
1272
 
        old_inv = old_tree.inventory
1273
 
 
1274
 
        nids = []
1275
 
        for fn in filenames:
1276
 
            file_id = inv.path2id(fn)
1277
 
            if not file_id:
1278
 
                raise NotVersionedError("not a versioned file", fn)
1279
 
            if not old_inv.has_id(file_id):
1280
 
                raise BzrError("file not present in old tree", fn, file_id)
1281
 
            nids.append((fn, file_id))
1282
 
            
1283
 
        # TODO: Rename back if it was previously at a different location
1284
 
 
1285
 
        # TODO: If given a directory, restore the entire contents from
1286
 
        # the previous version.
1287
 
 
1288
 
        # TODO: Make a backup to a temporary file.
1289
 
 
1290
 
        # TODO: If the file previously didn't exist, delete it?
1291
 
        for fn, file_id in nids:
1292
 
            backup_file(fn)
1293
 
            
1294
 
            f = AtomicFile(fn, 'wb')
1295
 
            try:
1296
 
                f.write(old_tree.get_file(file_id).read())
1297
 
                f.commit()
1298
 
            finally:
1299
 
                f.close()
1300
 
 
1301
 
 
1302
 
    def pending_merges(self):
1303
 
        """Return a list of pending merges.
1304
 
 
1305
 
        These are revisions that have been merged into the working
1306
 
        directory but not yet committed.
1307
 
        """
1308
 
        cfn = self.controlfilename('pending-merges')
1309
 
        if not os.path.exists(cfn):
1310
 
            return []
1311
 
        p = []
1312
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1313
 
            p.append(l.rstrip('\n'))
1314
 
        return p
1315
 
 
1316
 
 
1317
 
    def add_pending_merge(self, revision_id):
1318
 
        from bzrlib.revision import validate_revision_id
1319
 
 
1320
 
        validate_revision_id(revision_id)
1321
 
 
1322
 
        p = self.pending_merges()
1323
 
        if revision_id in p:
1324
 
            return
1325
 
        p.append(revision_id)
1326
 
        self.set_pending_merges(p)
1327
 
 
1328
 
 
1329
 
    def set_pending_merges(self, rev_list):
1330
 
        from bzrlib.atomicfile import AtomicFile
1331
 
        self.lock_write()
1332
 
        try:
1333
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1334
 
            try:
1335
 
                for l in rev_list:
1336
 
                    print >>f, l
1337
 
                f.commit()
1338
 
            finally:
1339
 
                f.close()
1340
 
        finally:
1341
 
            self.unlock()
1342
 
 
1343
 
 
1344
 
    def get_parent(self):
1345
 
        """Return the parent location of the branch.
1346
 
 
1347
 
        This is the default location for push/pull/missing.  The usual
1348
 
        pattern is that the user can override it by specifying a
1349
 
        location.
1350
 
        """
1351
 
        import errno
1352
 
        _locs = ['parent', 'pull', 'x-pull']
1353
 
        for l in _locs:
1354
 
            try:
1355
 
                return self.controlfile(l, 'r').read().strip('\n')
1356
 
            except IOError, e:
1357
 
                if e.errno != errno.ENOENT:
1358
 
                    raise
1359
 
        return None
1360
 
 
1361
 
 
1362
 
    def set_parent(self, url):
1363
 
        # TODO: Maybe delete old location files?
1364
 
        from bzrlib.atomicfile import AtomicFile
1365
 
        self.lock_write()
1366
 
        try:
1367
 
            f = AtomicFile(self.controlfilename('parent'))
1368
 
            try:
1369
 
                f.write(url + '\n')
1370
 
                f.commit()
1371
 
            finally:
1372
 
                f.close()
1373
 
        finally:
1374
 
            self.unlock()
1375
 
 
1376
 
    def check_revno(self, revno):
1377
 
        """\
1378
 
        Check whether a revno corresponds to any revision.
1379
 
        Zero (the NULL revision) is considered valid.
1380
 
        """
1381
 
        if revno != 0:
1382
 
            self.check_real_revno(revno)
1383
 
            
1384
 
    def check_real_revno(self, revno):
1385
 
        """\
1386
 
        Check whether a revno corresponds to a real revision.
1387
 
        Zero (the NULL revision) is considered invalid
1388
 
        """
1389
 
        if revno < 1 or revno > self.revno():
1390
 
            raise InvalidRevisionNumber(revno)
1391
 
        
1392
 
        
1393
775
 
1394
776
 
1395
777
class ScratchBranch(Branch):
1403
785
    >>> isdir(bd)
1404
786
    False
1405
787
    """
1406
 
    def __init__(self, files=[], dirs=[], base=None):
 
788
    def __init__(self, files=[], dirs=[]):
1407
789
        """Make a test branch.
1408
790
 
1409
791
        This creates a temporary directory and runs init-tree in it.
1410
792
 
1411
793
        If any files are listed, they are created in the working copy.
1412
794
        """
1413
 
        from tempfile import mkdtemp
1414
 
        init = False
1415
 
        if base is None:
1416
 
            base = mkdtemp()
1417
 
            init = True
1418
 
        Branch.__init__(self, base, init=init)
 
795
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
1419
796
        for d in dirs:
1420
797
            os.mkdir(self.abspath(d))
1421
798
            
1423
800
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1424
801
 
1425
802
 
1426
 
    def clone(self):
1427
 
        """
1428
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1429
 
        >>> clone = orig.clone()
1430
 
        >>> os.path.samefile(orig.base, clone.base)
1431
 
        False
1432
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1433
 
        True
1434
 
        """
1435
 
        from shutil import copytree
1436
 
        from tempfile import mkdtemp
1437
 
        base = mkdtemp()
1438
 
        os.rmdir(base)
1439
 
        copytree(self.base, base, symlinks=True)
1440
 
        return ScratchBranch(base=base)
1441
 
 
1442
 
 
1443
 
        
1444
803
    def __del__(self):
1445
804
        self.destroy()
1446
805
 
1447
806
    def destroy(self):
1448
807
        """Destroy the test branch, removing the scratch directory."""
1449
 
        from shutil import rmtree
1450
808
        try:
1451
809
            if self.base:
1452
810
                mutter("delete ScratchBranch %s" % self.base)
1453
 
                rmtree(self.base)
 
811
                shutil.rmtree(self.base)
1454
812
        except OSError, e:
1455
813
            # Work around for shutil.rmtree failing on Windows when
1456
814
            # readonly files are encountered
1458
816
            for root, dirs, files in os.walk(self.base, topdown=False):
1459
817
                for name in files:
1460
818
                    os.chmod(os.path.join(root, name), 0700)
1461
 
            rmtree(self.base)
 
819
            shutil.rmtree(self.base)
1462
820
        self.base = None
1463
821
 
1464
822
    
1489
847
    cope with just randomness because running uuidgen every time is
1490
848
    slow."""
1491
849
    import re
1492
 
    from binascii import hexlify
1493
 
    from time import time
1494
850
 
1495
851
    # get last component
1496
852
    idx = name.rfind('/')
1508
864
    name = re.sub(r'[^\w.]', '', name)
1509
865
 
1510
866
    s = hexlify(rand_bytes(8))
1511
 
    return '-'.join((name, compact_date(time()), s))
1512
 
 
1513
 
 
1514
 
def gen_root_id():
1515
 
    """Return a new tree-root file id."""
1516
 
    return gen_file_id('TREE_ROOT')
1517
 
 
1518
 
 
1519
 
def copy_branch(branch_from, to_location, revision=None):
1520
 
    """Copy branch_from into the existing directory to_location.
1521
 
 
1522
 
    revision
1523
 
        If not None, only revisions up to this point will be copied.
1524
 
        The head of the new branch will be that revision.
1525
 
 
1526
 
    to_location
1527
 
        The name of a local directory that exists but is empty.
1528
 
    """
1529
 
    from bzrlib.merge import merge
1530
 
 
1531
 
    assert isinstance(branch_from, Branch)
1532
 
    assert isinstance(to_location, basestring)
1533
 
    
1534
 
    br_to = Branch(to_location, init=True)
1535
 
    br_to.set_root_id(branch_from.get_root_id())
1536
 
    if revision is None:
1537
 
        revno = branch_from.revno()
1538
 
    else:
1539
 
        revno, rev_id = branch_from.get_revision_info(revision)
1540
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1541
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1542
 
          check_clean=False, ignore_zero=True)
1543
 
    br_to.set_parent(branch_from.base)
1544
 
    return br_to
1545
 
 
1546
 
def _trim_namespace(namespace, spec):
1547
 
    full_namespace = namespace + ':'
1548
 
    assert spec.startswith(full_namespace)
1549
 
    return spec[len(full_namespace):]
 
867
    return '-'.join((name, compact_date(time.time()), s))