/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

Partially fix pull.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
import sys, os
19
 
 
20
 
import bzrlib
21
 
from bzrlib.trace import mutter, note
22
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, splitpath, \
23
 
     sha_file, appendpath, file_kind
24
 
from bzrlib.errors import BzrError
25
 
 
26
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
27
 
## TODO: Maybe include checks for common corruption of newlines, etc?
28
 
 
29
 
 
30
 
 
31
 
def find_branch(f, **args):
32
 
    if f and (f.startswith('http://') or f.startswith('https://')):
33
 
        import remotebranch 
34
 
        return remotebranch.RemoteBranch(f, **args)
35
 
    else:
36
 
        return Branch(f, **args)
37
 
 
38
 
 
39
 
def find_cached_branch(f, cache_root, **args):
40
 
    from remotebranch import RemoteBranch
41
 
    br = find_branch(f, **args)
42
 
    def cacheify(br, store_name):
43
 
        from meta_store import CachedStore
44
 
        cache_path = os.path.join(cache_root, store_name)
45
 
        os.mkdir(cache_path)
46
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
47
 
        setattr(br, store_name, new_store)
48
 
 
49
 
    if isinstance(br, RemoteBranch):
50
 
        cacheify(br, 'inventory_store')
51
 
        cacheify(br, 'text_store')
52
 
        cacheify(br, 'revision_store')
53
 
    return br
54
 
 
55
 
 
56
 
def _relpath(base, path):
57
 
    """Return path relative to base, or raise exception.
58
 
 
59
 
    The path may be either an absolute path or a path relative to the
60
 
    current working directory.
61
 
 
62
 
    Lifted out of Branch.relpath for ease of testing.
63
 
 
64
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
65
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
66
 
    avoids that problem."""
67
 
    rp = os.path.abspath(path)
68
 
 
69
 
    s = []
70
 
    head = rp
71
 
    while len(head) >= len(base):
72
 
        if head == base:
73
 
            break
74
 
        head, tail = os.path.split(head)
75
 
        if tail:
76
 
            s.insert(0, tail)
77
 
    else:
78
 
        from errors import NotBranchError
79
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
80
 
 
81
 
    return os.sep.join(s)
82
 
        
83
 
 
84
 
def find_branch_root(f=None):
85
 
    """Find the branch root enclosing f, or pwd.
86
 
 
87
 
    f may be a filename or a URL.
88
 
 
89
 
    It is not necessary that f exists.
90
 
 
91
 
    Basically we keep looking up until we find the control directory or
92
 
    run into the root."""
93
 
    if f == None:
94
 
        f = os.getcwd()
95
 
    elif hasattr(os.path, 'realpath'):
96
 
        f = os.path.realpath(f)
97
 
    else:
98
 
        f = os.path.abspath(f)
99
 
    if not os.path.exists(f):
100
 
        raise BzrError('%r does not exist' % f)
101
 
        
102
 
 
103
 
    orig_f = f
104
 
 
105
 
    while True:
106
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
107
 
            return f
108
 
        head, tail = os.path.split(f)
109
 
        if head == f:
110
 
            # reached the root, whatever that may be
111
 
            raise BzrError('%r is not in a branch' % orig_f)
112
 
        f = head
113
 
    
114
 
class DivergedBranches(Exception):
115
 
    def __init__(self, branch1, branch2):
116
 
        self.branch1 = branch1
117
 
        self.branch2 = branch2
118
 
        Exception.__init__(self, "These branches have diverged.")
119
 
 
120
 
 
121
 
class NoSuchRevision(BzrError):
122
 
    def __init__(self, branch, revision):
123
 
        self.branch = branch
124
 
        self.revision = revision
125
 
        msg = "Branch %s has no revision %d" % (branch, revision)
126
 
        BzrError.__init__(self, msg)
127
 
 
128
 
 
129
 
######################################################################
130
 
# branch objects
131
 
 
132
 
class Branch(object):
133
 
    """Branch holding a history of revisions.
134
 
 
135
 
    base
136
 
        Base directory of the branch.
137
 
 
138
 
    _lock_mode
139
 
        None, or 'r' or 'w'
140
 
 
141
 
    _lock_count
142
 
        If _lock_mode is true, a positive count of the number of times the
143
 
        lock has been taken.
144
 
 
145
 
    _lock
146
 
        Lock object from bzrlib.lock.
147
 
    """
148
 
    base = None
149
 
    _lock_mode = None
150
 
    _lock_count = None
151
 
    _lock = None
152
 
    
153
 
    def __init__(self, base, init=False, find_root=True):
154
 
        """Create new branch object at a particular location.
155
 
 
156
 
        base -- Base directory for the branch.
157
 
        
158
 
        init -- If True, create new control files in a previously
159
 
             unversioned directory.  If False, the branch must already
160
 
             be versioned.
161
 
 
162
 
        find_root -- If true and init is false, find the root of the
163
 
             existing branch containing base.
164
 
 
165
 
        In the test suite, creation of new trees is tested using the
166
 
        `ScratchBranch` class.
167
 
        """
168
 
        from bzrlib.store import ImmutableStore
169
 
        if init:
170
 
            self.base = os.path.realpath(base)
171
 
            self._make_control()
172
 
        elif find_root:
173
 
            self.base = find_branch_root(base)
174
 
        else:
175
 
            self.base = os.path.realpath(base)
176
 
            if not isdir(self.controlfilename('.')):
177
 
                from errors import NotBranchError
178
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
179
 
                                     ['use "bzr init" to initialize a new working tree',
180
 
                                      'current bzr can only operate from top-of-tree'])
181
 
        self._check_format()
182
 
 
183
 
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
184
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
185
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
186
 
 
187
 
 
188
 
    def __str__(self):
189
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
190
 
 
191
 
 
192
 
    __repr__ = __str__
193
 
 
194
 
 
195
 
    def __del__(self):
196
 
        if self._lock_mode or self._lock:
197
 
            from warnings import warn
198
 
            warn("branch %r was not explicitly unlocked" % self)
199
 
            self._lock.unlock()
200
 
 
201
 
 
202
 
 
203
 
    def lock_write(self):
204
 
        if self._lock_mode:
205
 
            if self._lock_mode != 'w':
206
 
                from errors import LockError
207
 
                raise LockError("can't upgrade to a write lock from %r" %
208
 
                                self._lock_mode)
209
 
            self._lock_count += 1
210
 
        else:
211
 
            from bzrlib.lock import WriteLock
212
 
 
213
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
214
 
            self._lock_mode = 'w'
215
 
            self._lock_count = 1
216
 
 
217
 
 
218
 
 
219
 
    def lock_read(self):
220
 
        if self._lock_mode:
221
 
            assert self._lock_mode in ('r', 'w'), \
222
 
                   "invalid lock mode %r" % self._lock_mode
223
 
            self._lock_count += 1
224
 
        else:
225
 
            from bzrlib.lock import ReadLock
226
 
 
227
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
228
 
            self._lock_mode = 'r'
229
 
            self._lock_count = 1
230
 
                        
231
 
 
232
 
            
233
 
    def unlock(self):
234
 
        if not self._lock_mode:
235
 
            from errors import LockError
236
 
            raise LockError('branch %r is not locked' % (self))
237
 
 
238
 
        if self._lock_count > 1:
239
 
            self._lock_count -= 1
240
 
        else:
241
 
            self._lock.unlock()
242
 
            self._lock = None
243
 
            self._lock_mode = self._lock_count = None
244
 
 
245
 
 
246
 
    def abspath(self, name):
247
 
        """Return absolute filename for something in the branch"""
248
 
        return os.path.join(self.base, name)
249
 
 
250
 
 
251
 
    def relpath(self, path):
252
 
        """Return path relative to this branch of something inside it.
253
 
 
254
 
        Raises an error if path is not in this branch."""
255
 
        return _relpath(self.base, path)
256
 
 
257
 
 
258
 
    def controlfilename(self, file_or_path):
259
 
        """Return location relative to branch."""
260
 
        if isinstance(file_or_path, basestring):
261
 
            file_or_path = [file_or_path]
262
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
263
 
 
264
 
 
265
 
    def controlfile(self, file_or_path, mode='r'):
266
 
        """Open a control file for this branch.
267
 
 
268
 
        There are two classes of file in the control directory: text
269
 
        and binary.  binary files are untranslated byte streams.  Text
270
 
        control files are stored with Unix newlines and in UTF-8, even
271
 
        if the platform or locale defaults are different.
272
 
 
273
 
        Controlfiles should almost never be opened in write mode but
274
 
        rather should be atomically copied and replaced using atomicfile.
275
 
        """
276
 
 
277
 
        fn = self.controlfilename(file_or_path)
278
 
 
279
 
        if mode == 'rb' or mode == 'wb':
280
 
            return file(fn, mode)
281
 
        elif mode == 'r' or mode == 'w':
282
 
            # open in binary mode anyhow so there's no newline translation;
283
 
            # codecs uses line buffering by default; don't want that.
284
 
            import codecs
285
 
            return codecs.open(fn, mode + 'b', 'utf-8',
286
 
                               buffering=60000)
287
 
        else:
288
 
            raise BzrError("invalid controlfile mode %r" % mode)
289
 
 
290
 
 
291
 
 
292
 
    def _make_control(self):
293
 
        from bzrlib.inventory import Inventory
294
 
        from bzrlib.xml import pack_xml
295
 
        
296
 
        os.mkdir(self.controlfilename([]))
297
 
        self.controlfile('README', 'w').write(
298
 
            "This is a Bazaar-NG control directory.\n"
299
 
            "Do not change any files in this directory.\n")
300
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
301
 
        for d in ('text-store', 'inventory-store', 'revision-store'):
302
 
            os.mkdir(self.controlfilename(d))
303
 
        for f in ('revision-history', 'merged-patches',
304
 
                  'pending-merged-patches', 'branch-name',
305
 
                  'branch-lock',
306
 
                  'pending-merges'):
307
 
            self.controlfile(f, 'w').write('')
308
 
        mutter('created control directory in ' + self.base)
309
 
 
310
 
        pack_xml(Inventory(), self.controlfile('inventory','w'))
311
 
 
312
 
 
313
 
    def _check_format(self):
314
 
        """Check this branch format is supported.
315
 
 
316
 
        The current tool only supports the current unstable format.
317
 
 
318
 
        In the future, we might need different in-memory Branch
319
 
        classes to support downlevel branches.  But not yet.
320
 
        """
321
 
        # This ignores newlines so that we can open branches created
322
 
        # on Windows from Linux and so on.  I think it might be better
323
 
        # to always make all internal files in unix format.
324
 
        fmt = self.controlfile('branch-format', 'r').read()
325
 
        fmt.replace('\r\n', '')
326
 
        if fmt != BZR_BRANCH_FORMAT:
327
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
328
 
                           ['use a different bzr version',
329
 
                            'or remove the .bzr directory and "bzr init" again'])
330
 
 
331
 
 
332
 
 
333
 
    def read_working_inventory(self):
334
 
        """Read the working inventory."""
335
 
        from bzrlib.inventory import Inventory
336
 
        from bzrlib.xml import unpack_xml
337
 
        from time import time
338
 
        before = time()
339
 
        self.lock_read()
340
 
        try:
341
 
            # ElementTree does its own conversion from UTF-8, so open in
342
 
            # binary.
343
 
            inv = unpack_xml(Inventory,
344
 
                                  self.controlfile('inventory', 'rb'))
345
 
            mutter("loaded inventory of %d items in %f"
346
 
                   % (len(inv), time() - before))
347
 
            return inv
348
 
        finally:
349
 
            self.unlock()
350
 
            
351
 
 
352
 
    def _write_inventory(self, inv):
353
 
        """Update the working inventory.
354
 
 
355
 
        That is to say, the inventory describing changes underway, that
356
 
        will be committed to the next revision.
357
 
        """
358
 
        from bzrlib.atomicfile import AtomicFile
359
 
        from bzrlib.xml import pack_xml
360
 
        
361
 
        self.lock_write()
362
 
        try:
363
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
364
 
            try:
365
 
                pack_xml(inv, f)
366
 
                f.commit()
367
 
            finally:
368
 
                f.close()
369
 
        finally:
370
 
            self.unlock()
371
 
        
372
 
        mutter('wrote working inventory')
373
 
            
374
 
 
375
 
    inventory = property(read_working_inventory, _write_inventory, None,
376
 
                         """Inventory for the working copy.""")
377
 
 
378
 
 
379
 
    def add(self, files, verbose=False, ids=None):
380
 
        """Make files versioned.
381
 
 
382
 
        Note that the command line normally calls smart_add instead.
383
 
 
384
 
        This puts the files in the Added state, so that they will be
385
 
        recorded by the next commit.
386
 
 
387
 
        files
388
 
            List of paths to add, relative to the base of the tree.
389
 
 
390
 
        ids
391
 
            If set, use these instead of automatically generated ids.
392
 
            Must be the same length as the list of files, but may
393
 
            contain None for ids that are to be autogenerated.
394
 
 
395
 
        TODO: Perhaps have an option to add the ids even if the files do
396
 
              not (yet) exist.
397
 
 
398
 
        TODO: Perhaps return the ids of the files?  But then again it
399
 
              is easy to retrieve them if they're needed.
400
 
 
401
 
        TODO: Adding a directory should optionally recurse down and
402
 
              add all non-ignored children.  Perhaps do that in a
403
 
              higher-level method.
404
 
        """
405
 
        from bzrlib.textui import show_status
406
 
        # TODO: Re-adding a file that is removed in the working copy
407
 
        # should probably put it back with the previous ID.
408
 
        if isinstance(files, basestring):
409
 
            assert(ids is None or isinstance(ids, basestring))
410
 
            files = [files]
411
 
            if ids is not None:
412
 
                ids = [ids]
413
 
 
414
 
        if ids is None:
415
 
            ids = [None] * len(files)
416
 
        else:
417
 
            assert(len(ids) == len(files))
418
 
 
419
 
        self.lock_write()
420
 
        try:
421
 
            inv = self.read_working_inventory()
422
 
            for f,file_id in zip(files, ids):
423
 
                if is_control_file(f):
424
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
425
 
 
426
 
                fp = splitpath(f)
427
 
 
428
 
                if len(fp) == 0:
429
 
                    raise BzrError("cannot add top-level %r" % f)
430
 
 
431
 
                fullpath = os.path.normpath(self.abspath(f))
432
 
 
433
 
                try:
434
 
                    kind = file_kind(fullpath)
435
 
                except OSError:
436
 
                    # maybe something better?
437
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
438
 
 
439
 
                if kind != 'file' and kind != 'directory':
440
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
441
 
 
442
 
                if file_id is None:
443
 
                    file_id = gen_file_id(f)
444
 
                inv.add_path(f, kind=kind, file_id=file_id)
445
 
 
446
 
                if verbose:
447
 
                    print 'added', quotefn(f)
448
 
 
449
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
450
 
 
451
 
            self._write_inventory(inv)
452
 
        finally:
453
 
            self.unlock()
454
 
            
455
 
 
456
 
    def print_file(self, file, revno):
457
 
        """Print `file` to stdout."""
458
 
        self.lock_read()
459
 
        try:
460
 
            tree = self.revision_tree(self.lookup_revision(revno))
461
 
            # use inventory as it was in that revision
462
 
            file_id = tree.inventory.path2id(file)
463
 
            if not file_id:
464
 
                raise BzrError("%r is not present in revision %d" % (file, revno))
465
 
            tree.print_file(file_id)
466
 
        finally:
467
 
            self.unlock()
468
 
 
469
 
 
470
 
    def remove(self, files, verbose=False):
471
 
        """Mark nominated files for removal from the inventory.
472
 
 
473
 
        This does not remove their text.  This does not run on 
474
 
 
475
 
        TODO: Refuse to remove modified files unless --force is given?
476
 
 
477
 
        TODO: Do something useful with directories.
478
 
 
479
 
        TODO: Should this remove the text or not?  Tough call; not
480
 
        removing may be useful and the user can just use use rm, and
481
 
        is the opposite of add.  Removing it is consistent with most
482
 
        other tools.  Maybe an option.
483
 
        """
484
 
        from bzrlib.textui import show_status
485
 
        ## TODO: Normalize names
486
 
        ## TODO: Remove nested loops; better scalability
487
 
        if isinstance(files, basestring):
488
 
            files = [files]
489
 
 
490
 
        self.lock_write()
491
 
 
492
 
        try:
493
 
            tree = self.working_tree()
494
 
            inv = tree.inventory
495
 
 
496
 
            # do this before any modifications
497
 
            for f in files:
498
 
                fid = inv.path2id(f)
499
 
                if not fid:
500
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
501
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
502
 
                if verbose:
503
 
                    # having remove it, it must be either ignored or unknown
504
 
                    if tree.is_ignored(f):
505
 
                        new_status = 'I'
506
 
                    else:
507
 
                        new_status = '?'
508
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
509
 
                del inv[fid]
510
 
 
511
 
            self._write_inventory(inv)
512
 
        finally:
513
 
            self.unlock()
514
 
 
515
 
 
516
 
    # FIXME: this doesn't need to be a branch method
517
 
    def set_inventory(self, new_inventory_list):
518
 
        from bzrlib.inventory import Inventory, InventoryEntry
519
 
        inv = Inventory()
520
 
        for path, file_id, parent, kind in new_inventory_list:
521
 
            name = os.path.basename(path)
522
 
            if name == "":
523
 
                continue
524
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
525
 
        self._write_inventory(inv)
526
 
 
527
 
 
528
 
    def unknowns(self):
529
 
        """Return all unknown files.
530
 
 
531
 
        These are files in the working directory that are not versioned or
532
 
        control files or ignored.
533
 
        
534
 
        >>> b = ScratchBranch(files=['foo', 'foo~'])
535
 
        >>> list(b.unknowns())
536
 
        ['foo']
537
 
        >>> b.add('foo')
538
 
        >>> list(b.unknowns())
539
 
        []
540
 
        >>> b.remove('foo')
541
 
        >>> list(b.unknowns())
542
 
        ['foo']
543
 
        """
544
 
        return self.working_tree().unknowns()
545
 
 
546
 
 
547
 
    def append_revision(self, revision_id):
548
 
        from bzrlib.atomicfile import AtomicFile
549
 
 
550
 
        mutter("add {%s} to revision-history" % revision_id)
551
 
        rev_history = self.revision_history() + [revision_id]
552
 
 
553
 
        f = AtomicFile(self.controlfilename('revision-history'))
554
 
        try:
555
 
            for rev_id in rev_history:
556
 
                print >>f, rev_id
557
 
            f.commit()
558
 
        finally:
559
 
            f.close()
560
 
 
561
 
 
562
 
    def get_revision(self, revision_id):
563
 
        """Return the Revision object for a named revision"""
564
 
        from bzrlib.revision import Revision
565
 
        from bzrlib.xml import unpack_xml
566
 
 
567
 
        self.lock_read()
568
 
        try:
569
 
            if not revision_id or not isinstance(revision_id, basestring):
570
 
                raise ValueError('invalid revision-id: %r' % revision_id)
571
 
            r = unpack_xml(Revision, self.revision_store[revision_id])
572
 
        finally:
573
 
            self.unlock()
574
 
            
575
 
        assert r.revision_id == revision_id
576
 
        return r
577
 
        
578
 
 
579
 
    def get_revision_sha1(self, revision_id):
580
 
        """Hash the stored value of a revision, and return it."""
581
 
        # In the future, revision entries will be signed. At that
582
 
        # point, it is probably best *not* to include the signature
583
 
        # in the revision hash. Because that lets you re-sign
584
 
        # the revision, (add signatures/remove signatures) and still
585
 
        # have all hash pointers stay consistent.
586
 
        # But for now, just hash the contents.
587
 
        return sha_file(self.revision_store[revision_id])
588
 
 
589
 
 
590
 
    def get_inventory(self, inventory_id):
591
 
        """Get Inventory object by hash.
592
 
 
593
 
        TODO: Perhaps for this and similar methods, take a revision
594
 
               parameter which can be either an integer revno or a
595
 
               string hash."""
596
 
        from bzrlib.inventory import Inventory
597
 
        from bzrlib.xml import unpack_xml
598
 
 
599
 
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
600
 
            
601
 
 
602
 
    def get_inventory_sha1(self, inventory_id):
603
 
        """Return the sha1 hash of the inventory entry
604
 
        """
605
 
        return sha_file(self.inventory_store[inventory_id])
606
 
 
607
 
 
608
 
    def get_revision_inventory(self, revision_id):
609
 
        """Return inventory of a past revision."""
610
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
611
 
        # must be the same as its revision, so this is trivial.
612
 
        if revision_id == None:
613
 
            from bzrlib.inventory import Inventory
614
 
            return Inventory()
615
 
        else:
616
 
            return self.get_inventory(revision_id)
617
 
 
618
 
 
619
 
    def revision_history(self):
620
 
        """Return sequence of revision hashes on to this branch.
621
 
 
622
 
        >>> ScratchBranch().revision_history()
623
 
        []
624
 
        """
625
 
        self.lock_read()
626
 
        try:
627
 
            return [l.rstrip('\r\n') for l in
628
 
                    self.controlfile('revision-history', 'r').readlines()]
629
 
        finally:
630
 
            self.unlock()
631
 
 
632
 
 
633
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
634
 
        """
635
 
        >>> import commit
636
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
637
 
        >>> sb.common_ancestor(sb) == (None, None)
638
 
        True
639
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
640
 
        >>> sb.common_ancestor(sb)[0]
641
 
        1
642
 
        >>> clone = sb.clone()
643
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
644
 
        >>> sb.common_ancestor(sb)[0]
645
 
        2
646
 
        >>> sb.common_ancestor(clone)[0]
647
 
        1
648
 
        >>> commit.commit(clone, "Committing divergent second revision", 
649
 
        ...               verbose=False)
650
 
        >>> sb.common_ancestor(clone)[0]
651
 
        1
652
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
653
 
        True
654
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
655
 
        True
656
 
        >>> clone2 = sb.clone()
657
 
        >>> sb.common_ancestor(clone2)[0]
658
 
        2
659
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
660
 
        1
661
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
662
 
        1
663
 
        """
664
 
        my_history = self.revision_history()
665
 
        other_history = other.revision_history()
666
 
        if self_revno is None:
667
 
            self_revno = len(my_history)
668
 
        if other_revno is None:
669
 
            other_revno = len(other_history)
670
 
        indices = range(min((self_revno, other_revno)))
671
 
        indices.reverse()
672
 
        for r in indices:
673
 
            if my_history[r] == other_history[r]:
674
 
                return r+1, my_history[r]
675
 
        return None, None
676
 
 
677
 
    def enum_history(self, direction):
678
 
        """Return (revno, revision_id) for history of branch.
679
 
 
680
 
        direction
681
 
            'forward' is from earliest to latest
682
 
            'reverse' is from latest to earliest
683
 
        """
684
 
        rh = self.revision_history()
685
 
        if direction == 'forward':
686
 
            i = 1
687
 
            for rid in rh:
688
 
                yield i, rid
689
 
                i += 1
690
 
        elif direction == 'reverse':
691
 
            i = len(rh)
692
 
            while i > 0:
693
 
                yield i, rh[i-1]
694
 
                i -= 1
695
 
        else:
696
 
            raise ValueError('invalid history direction', direction)
697
 
 
698
 
 
699
 
    def revno(self):
700
 
        """Return current revision number for this branch.
701
 
 
702
 
        That is equivalent to the number of revisions committed to
703
 
        this branch.
704
 
        """
705
 
        return len(self.revision_history())
706
 
 
707
 
 
708
 
    def last_patch(self):
709
 
        """Return last patch hash, or None if no history.
710
 
        """
711
 
        ph = self.revision_history()
712
 
        if ph:
713
 
            return ph[-1]
714
 
        else:
715
 
            return None
716
 
 
717
 
 
718
 
    def missing_revisions(self, other, stop_revision=None):
719
 
        """
720
 
        If self and other have not diverged, return a list of the revisions
721
 
        present in other, but missing from self.
722
 
 
723
 
        >>> from bzrlib.commit import commit
724
 
        >>> bzrlib.trace.silent = True
725
 
        >>> br1 = ScratchBranch()
726
 
        >>> br2 = ScratchBranch()
727
 
        >>> br1.missing_revisions(br2)
728
 
        []
729
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
730
 
        >>> br1.missing_revisions(br2)
731
 
        [u'REVISION-ID-1']
732
 
        >>> br2.missing_revisions(br1)
733
 
        []
734
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
735
 
        >>> br1.missing_revisions(br2)
736
 
        []
737
 
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
738
 
        >>> br1.missing_revisions(br2)
739
 
        [u'REVISION-ID-2A']
740
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
741
 
        >>> br1.missing_revisions(br2)
742
 
        Traceback (most recent call last):
743
 
        DivergedBranches: These branches have diverged.
744
 
        """
745
 
        self_history = self.revision_history()
746
 
        self_len = len(self_history)
747
 
        other_history = other.revision_history()
748
 
        other_len = len(other_history)
749
 
        common_index = min(self_len, other_len) -1
750
 
        if common_index >= 0 and \
751
 
            self_history[common_index] != other_history[common_index]:
752
 
            raise DivergedBranches(self, other)
753
 
 
754
 
        if stop_revision is None:
755
 
            stop_revision = other_len
756
 
        elif stop_revision > other_len:
757
 
            raise NoSuchRevision(self, stop_revision)
758
 
        
759
 
        return other_history[self_len:stop_revision]
760
 
 
761
 
 
762
 
    def update_revisions(self, other, stop_revision=None):
763
 
        """Pull in all new revisions from other branch.
764
 
        
765
 
        >>> from bzrlib.commit import commit
766
 
        >>> bzrlib.trace.silent = True
767
 
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
768
 
        >>> br1.add('foo')
769
 
        >>> br1.add('bar')
770
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
771
 
        >>> br2 = ScratchBranch()
772
 
        >>> br2.update_revisions(br1)
773
 
        Added 2 texts.
774
 
        Added 1 inventories.
775
 
        Added 1 revisions.
776
 
        >>> br2.revision_history()
777
 
        [u'REVISION-ID-1']
778
 
        >>> br2.update_revisions(br1)
779
 
        Added 0 texts.
780
 
        Added 0 inventories.
781
 
        Added 0 revisions.
782
 
        >>> br1.text_store.total_size() == br2.text_store.total_size()
783
 
        True
784
 
        """
785
 
        from bzrlib.progress import ProgressBar
786
 
        try:
787
 
            set
788
 
        except NameError:
789
 
            from sets import Set as set
790
 
 
791
 
        pb = ProgressBar()
792
 
 
793
 
        pb.update('comparing histories')
794
 
        revision_ids = self.missing_revisions(other, stop_revision)
795
 
 
796
 
        if hasattr(other.revision_store, "prefetch"):
797
 
            other.revision_store.prefetch(revision_ids)
798
 
        if hasattr(other.inventory_store, "prefetch"):
799
 
            inventory_ids = [other.get_revision(r).inventory_id
800
 
                             for r in revision_ids]
801
 
            other.inventory_store.prefetch(inventory_ids)
802
 
                
803
 
        revisions = []
804
 
        needed_texts = set()
805
 
        i = 0
806
 
        for rev_id in revision_ids:
807
 
            i += 1
808
 
            pb.update('fetching revision', i, len(revision_ids))
809
 
            rev = other.get_revision(rev_id)
810
 
            revisions.append(rev)
811
 
            inv = other.get_inventory(str(rev.inventory_id))
812
 
            for key, entry in inv.iter_entries():
813
 
                if entry.text_id is None:
814
 
                    continue
815
 
                if entry.text_id not in self.text_store:
816
 
                    needed_texts.add(entry.text_id)
817
 
 
818
 
        pb.clear()
819
 
                    
820
 
        count = self.text_store.copy_multi(other.text_store, needed_texts)
821
 
        print "Added %d texts." % count 
822
 
        inventory_ids = [ f.inventory_id for f in revisions ]
823
 
        count = self.inventory_store.copy_multi(other.inventory_store, 
824
 
                                                inventory_ids)
825
 
        print "Added %d inventories." % count 
826
 
        revision_ids = [ f.revision_id for f in revisions]
827
 
        count = self.revision_store.copy_multi(other.revision_store, 
828
 
                                               revision_ids)
829
 
        for revision_id in revision_ids:
830
 
            self.append_revision(revision_id)
831
 
        print "Added %d revisions." % count
832
 
                    
833
 
        
834
 
    def commit(self, *args, **kw):
835
 
        from bzrlib.commit import commit
836
 
        commit(self, *args, **kw)
837
 
        
838
 
 
839
 
    def lookup_revision(self, revno):
840
 
        """Return revision hash for revision number."""
841
 
        if revno == 0:
842
 
            return None
843
 
 
844
 
        try:
845
 
            # list is 0-based; revisions are 1-based
846
 
            return self.revision_history()[revno-1]
847
 
        except IndexError:
848
 
            raise BzrError("no such revision %s" % revno)
849
 
 
850
 
 
851
 
    def revision_tree(self, revision_id):
852
 
        """Return Tree for a revision on this branch.
853
 
 
854
 
        `revision_id` may be None for the null revision, in which case
855
 
        an `EmptyTree` is returned."""
856
 
        from bzrlib.tree import EmptyTree, RevisionTree
857
 
        # TODO: refactor this to use an existing revision object
858
 
        # so we don't need to read it in twice.
859
 
        if revision_id == None:
860
 
            return EmptyTree()
861
 
        else:
862
 
            inv = self.get_revision_inventory(revision_id)
863
 
            return RevisionTree(self.text_store, inv)
864
 
 
865
 
 
866
 
    def working_tree(self):
867
 
        """Return a `Tree` for the working copy."""
868
 
        from workingtree import WorkingTree
869
 
        return WorkingTree(self.base, self.read_working_inventory())
870
 
 
871
 
 
872
 
    def basis_tree(self):
873
 
        """Return `Tree` object for last revision.
874
 
 
875
 
        If there are no revisions yet, return an `EmptyTree`.
876
 
        """
877
 
        from bzrlib.tree import EmptyTree, RevisionTree
878
 
        r = self.last_patch()
879
 
        if r == None:
880
 
            return EmptyTree()
881
 
        else:
882
 
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
883
 
 
884
 
 
885
 
 
886
 
    def rename_one(self, from_rel, to_rel):
887
 
        """Rename one file.
888
 
 
889
 
        This can change the directory or the filename or both.
890
 
        """
891
 
        self.lock_write()
892
 
        try:
893
 
            tree = self.working_tree()
894
 
            inv = tree.inventory
895
 
            if not tree.has_filename(from_rel):
896
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
897
 
            if tree.has_filename(to_rel):
898
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
899
 
 
900
 
            file_id = inv.path2id(from_rel)
901
 
            if file_id == None:
902
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
903
 
 
904
 
            if inv.path2id(to_rel):
905
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
906
 
 
907
 
            to_dir, to_tail = os.path.split(to_rel)
908
 
            to_dir_id = inv.path2id(to_dir)
909
 
            if to_dir_id == None and to_dir != '':
910
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
911
 
 
912
 
            mutter("rename_one:")
913
 
            mutter("  file_id    {%s}" % file_id)
914
 
            mutter("  from_rel   %r" % from_rel)
915
 
            mutter("  to_rel     %r" % to_rel)
916
 
            mutter("  to_dir     %r" % to_dir)
917
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
918
 
 
919
 
            inv.rename(file_id, to_dir_id, to_tail)
920
 
 
921
 
            print "%s => %s" % (from_rel, to_rel)
922
 
 
923
 
            from_abs = self.abspath(from_rel)
924
 
            to_abs = self.abspath(to_rel)
925
 
            try:
926
 
                os.rename(from_abs, to_abs)
927
 
            except OSError, e:
928
 
                raise BzrError("failed to rename %r to %r: %s"
929
 
                        % (from_abs, to_abs, e[1]),
930
 
                        ["rename rolled back"])
931
 
 
932
 
            self._write_inventory(inv)
933
 
        finally:
934
 
            self.unlock()
935
 
 
936
 
 
937
 
    def move(self, from_paths, to_name):
938
 
        """Rename files.
939
 
 
940
 
        to_name must exist as a versioned directory.
941
 
 
942
 
        If to_name exists and is a directory, the files are moved into
943
 
        it, keeping their old names.  If it is a directory, 
944
 
 
945
 
        Note that to_name is only the last component of the new name;
946
 
        this doesn't change the directory.
947
 
        """
948
 
        self.lock_write()
949
 
        try:
950
 
            ## TODO: Option to move IDs only
951
 
            assert not isinstance(from_paths, basestring)
952
 
            tree = self.working_tree()
953
 
            inv = tree.inventory
954
 
            to_abs = self.abspath(to_name)
955
 
            if not isdir(to_abs):
956
 
                raise BzrError("destination %r is not a directory" % to_abs)
957
 
            if not tree.has_filename(to_name):
958
 
                raise BzrError("destination %r not in working directory" % to_abs)
959
 
            to_dir_id = inv.path2id(to_name)
960
 
            if to_dir_id == None and to_name != '':
961
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
962
 
            to_dir_ie = inv[to_dir_id]
963
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
964
 
                raise BzrError("destination %r is not a directory" % to_abs)
965
 
 
966
 
            to_idpath = inv.get_idpath(to_dir_id)
967
 
 
968
 
            for f in from_paths:
969
 
                if not tree.has_filename(f):
970
 
                    raise BzrError("%r does not exist in working tree" % f)
971
 
                f_id = inv.path2id(f)
972
 
                if f_id == None:
973
 
                    raise BzrError("%r is not versioned" % f)
974
 
                name_tail = splitpath(f)[-1]
975
 
                dest_path = appendpath(to_name, name_tail)
976
 
                if tree.has_filename(dest_path):
977
 
                    raise BzrError("destination %r already exists" % dest_path)
978
 
                if f_id in to_idpath:
979
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
980
 
 
981
 
            # OK, so there's a race here, it's possible that someone will
982
 
            # create a file in this interval and then the rename might be
983
 
            # left half-done.  But we should have caught most problems.
984
 
 
985
 
            for f in from_paths:
986
 
                name_tail = splitpath(f)[-1]
987
 
                dest_path = appendpath(to_name, name_tail)
988
 
                print "%s => %s" % (f, dest_path)
989
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
990
 
                try:
991
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
992
 
                except OSError, e:
993
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
994
 
                            ["rename rolled back"])
995
 
 
996
 
            self._write_inventory(inv)
997
 
        finally:
998
 
            self.unlock()
999
 
 
1000
 
 
1001
 
    def revert(self, filenames, old_tree=None, backups=True):
1002
 
        """Restore selected files to the versions from a previous tree.
1003
 
 
1004
 
        backups
1005
 
            If true (default) backups are made of files before
1006
 
            they're renamed.
1007
 
        """
1008
 
        from bzrlib.errors import NotVersionedError, BzrError
1009
 
        from bzrlib.atomicfile import AtomicFile
1010
 
        from bzrlib.osutils import backup_file
1011
 
        
1012
 
        inv = self.read_working_inventory()
1013
 
        if old_tree is None:
1014
 
            old_tree = self.basis_tree()
1015
 
        old_inv = old_tree.inventory
1016
 
 
1017
 
        nids = []
1018
 
        for fn in filenames:
1019
 
            file_id = inv.path2id(fn)
1020
 
            if not file_id:
1021
 
                raise NotVersionedError("not a versioned file", fn)
1022
 
            if not old_inv.has_id(file_id):
1023
 
                raise BzrError("file not present in old tree", fn, file_id)
1024
 
            nids.append((fn, file_id))
1025
 
            
1026
 
        # TODO: Rename back if it was previously at a different location
1027
 
 
1028
 
        # TODO: If given a directory, restore the entire contents from
1029
 
        # the previous version.
1030
 
 
1031
 
        # TODO: Make a backup to a temporary file.
1032
 
 
1033
 
        # TODO: If the file previously didn't exist, delete it?
1034
 
        for fn, file_id in nids:
1035
 
            backup_file(fn)
1036
 
            
1037
 
            f = AtomicFile(fn, 'wb')
1038
 
            try:
1039
 
                f.write(old_tree.get_file(file_id).read())
1040
 
                f.commit()
1041
 
            finally:
1042
 
                f.close()
1043
 
 
1044
 
 
1045
 
    def pending_merges(self):
1046
 
        """Return a list of pending merges.
1047
 
 
1048
 
        These are revisions that have been merged into the working
1049
 
        directory but not yet committed.
1050
 
        """
1051
 
        cfn = self.controlfilename('pending-merges')
1052
 
        if not os.path.exists(cfn):
1053
 
            return []
1054
 
        p = []
1055
 
        for l in self.controlfile('pending-merges', 'r').readlines():
1056
 
            p.append(l.rstrip('\n'))
1057
 
        return p
1058
 
 
1059
 
 
1060
 
    def add_pending_merge(self, revision_id):
1061
 
        from bzrlib.revision import validate_revision_id
1062
 
 
1063
 
        validate_revision_id(revision_id)
1064
 
 
1065
 
        p = self.pending_merges()
1066
 
        if revision_id in p:
1067
 
            return
1068
 
        p.append(revision_id)
1069
 
        self.set_pending_merges(p)
1070
 
 
1071
 
 
1072
 
    def set_pending_merges(self, rev_list):
1073
 
        from bzrlib.atomicfile import AtomicFile
1074
 
        self.lock_write()
1075
 
        try:
1076
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1077
 
            try:
1078
 
                for l in rev_list:
1079
 
                    print >>f, l
1080
 
                f.commit()
1081
 
            finally:
1082
 
                f.close()
1083
 
        finally:
1084
 
            self.unlock()
1085
 
 
1086
 
 
1087
 
 
1088
 
class ScratchBranch(Branch):
1089
 
    """Special test class: a branch that cleans up after itself.
1090
 
 
1091
 
    >>> b = ScratchBranch()
1092
 
    >>> isdir(b.base)
1093
 
    True
1094
 
    >>> bd = b.base
1095
 
    >>> b.destroy()
1096
 
    >>> isdir(bd)
1097
 
    False
1098
 
    """
1099
 
    def __init__(self, files=[], dirs=[], base=None):
1100
 
        """Make a test branch.
1101
 
 
1102
 
        This creates a temporary directory and runs init-tree in it.
1103
 
 
1104
 
        If any files are listed, they are created in the working copy.
1105
 
        """
1106
 
        from tempfile import mkdtemp
1107
 
        init = False
1108
 
        if base is None:
1109
 
            base = mkdtemp()
1110
 
            init = True
1111
 
        Branch.__init__(self, base, init=init)
1112
 
        for d in dirs:
1113
 
            os.mkdir(self.abspath(d))
1114
 
            
1115
 
        for f in files:
1116
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1117
 
 
1118
 
 
1119
 
    def clone(self):
1120
 
        """
1121
 
        >>> orig = ScratchBranch(files=["file1", "file2"])
1122
 
        >>> clone = orig.clone()
1123
 
        >>> os.path.samefile(orig.base, clone.base)
1124
 
        False
1125
 
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1126
 
        True
1127
 
        """
1128
 
        from shutil import copytree
1129
 
        from tempfile import mkdtemp
1130
 
        base = mkdtemp()
1131
 
        os.rmdir(base)
1132
 
        copytree(self.base, base, symlinks=True)
1133
 
        return ScratchBranch(base=base)
1134
 
        
1135
 
    def __del__(self):
1136
 
        self.destroy()
1137
 
 
1138
 
    def destroy(self):
1139
 
        """Destroy the test branch, removing the scratch directory."""
1140
 
        from shutil import rmtree
1141
 
        try:
1142
 
            if self.base:
1143
 
                mutter("delete ScratchBranch %s" % self.base)
1144
 
                rmtree(self.base)
1145
 
        except OSError, e:
1146
 
            # Work around for shutil.rmtree failing on Windows when
1147
 
            # readonly files are encountered
1148
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
1149
 
            for root, dirs, files in os.walk(self.base, topdown=False):
1150
 
                for name in files:
1151
 
                    os.chmod(os.path.join(root, name), 0700)
1152
 
            rmtree(self.base)
1153
 
        self.base = None
1154
 
 
1155
 
    
1156
 
 
1157
 
######################################################################
1158
 
# predicates
1159
 
 
1160
 
 
1161
 
def is_control_file(filename):
1162
 
    ## FIXME: better check
1163
 
    filename = os.path.normpath(filename)
1164
 
    while filename != '':
1165
 
        head, tail = os.path.split(filename)
1166
 
        ## mutter('check %r for control file' % ((head, tail), ))
1167
 
        if tail == bzrlib.BZRDIR:
1168
 
            return True
1169
 
        if filename == head:
1170
 
            break
1171
 
        filename = head
1172
 
    return False
1173
 
 
1174
 
 
1175
 
 
1176
 
def gen_file_id(name):
1177
 
    """Return new file id.
1178
 
 
1179
 
    This should probably generate proper UUIDs, but for the moment we
1180
 
    cope with just randomness because running uuidgen every time is
1181
 
    slow."""
1182
 
    import re
1183
 
    from binascii import hexlify
1184
 
    from time import time
1185
 
 
1186
 
    # get last component
1187
 
    idx = name.rfind('/')
1188
 
    if idx != -1:
1189
 
        name = name[idx+1 : ]
1190
 
    idx = name.rfind('\\')
1191
 
    if idx != -1:
1192
 
        name = name[idx+1 : ]
1193
 
 
1194
 
    # make it not a hidden file
1195
 
    name = name.lstrip('.')
1196
 
 
1197
 
    # remove any wierd characters; we don't escape them but rather
1198
 
    # just pull them out
1199
 
    name = re.sub(r'[^\w.]', '', name)
1200
 
 
1201
 
    s = hexlify(rand_bytes(8))
1202
 
    return '-'.join((name, compact_date(time()), s))