/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-29 04:11:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050629041140-6b17e65a23ffdf47
Merge John's log patch:

implements bzr log --forward --verbose
optimizes so that only logs to be printed are read (rather than reading
all and filtering out unwanted).

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
 
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
            self.controlfile(f, 'w').write('')
 
307
        mutter('created control directory in ' + self.base)
 
308
 
 
309
        pack_xml(Inventory(), self.controlfile('inventory','w'))
 
310
 
 
311
 
 
312
    def _check_format(self):
 
313
        """Check this branch format is supported.
 
314
 
 
315
        The current tool only supports the current unstable format.
 
316
 
 
317
        In the future, we might need different in-memory Branch
 
318
        classes to support downlevel branches.  But not yet.
 
319
        """
 
320
        # This ignores newlines so that we can open branches created
 
321
        # on Windows from Linux and so on.  I think it might be better
 
322
        # to always make all internal files in unix format.
 
323
        fmt = self.controlfile('branch-format', 'r').read()
 
324
        fmt.replace('\r\n', '')
 
325
        if fmt != BZR_BRANCH_FORMAT:
 
326
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
327
                           ['use a different bzr version',
 
328
                            'or remove the .bzr directory and "bzr init" again'])
 
329
 
 
330
 
 
331
 
 
332
    def read_working_inventory(self):
 
333
        """Read the working inventory."""
 
334
        from bzrlib.inventory import Inventory
 
335
        from bzrlib.xml import unpack_xml
 
336
        from time import time
 
337
        before = time()
 
338
        self.lock_read()
 
339
        try:
 
340
            # ElementTree does its own conversion from UTF-8, so open in
 
341
            # binary.
 
342
            inv = unpack_xml(Inventory,
 
343
                                  self.controlfile('inventory', 'rb'))
 
344
            mutter("loaded inventory of %d items in %f"
 
345
                   % (len(inv), time() - before))
 
346
            return inv
 
347
        finally:
 
348
            self.unlock()
 
349
            
 
350
 
 
351
    def _write_inventory(self, inv):
 
352
        """Update the working inventory.
 
353
 
 
354
        That is to say, the inventory describing changes underway, that
 
355
        will be committed to the next revision.
 
356
        """
 
357
        from bzrlib.atomicfile import AtomicFile
 
358
        from bzrlib.xml import pack_xml
 
359
        
 
360
        self.lock_write()
 
361
        try:
 
362
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
363
            try:
 
364
                pack_xml(inv, f)
 
365
                f.commit()
 
366
            finally:
 
367
                f.close()
 
368
        finally:
 
369
            self.unlock()
 
370
        
 
371
        mutter('wrote working inventory')
 
372
            
 
373
 
 
374
    inventory = property(read_working_inventory, _write_inventory, None,
 
375
                         """Inventory for the working copy.""")
 
376
 
 
377
 
 
378
    def add(self, files, verbose=False, ids=None):
 
379
        """Make files versioned.
 
380
 
 
381
        Note that the command line normally calls smart_add instead.
 
382
 
 
383
        This puts the files in the Added state, so that they will be
 
384
        recorded by the next commit.
 
385
 
 
386
        files
 
387
            List of paths to add, relative to the base of the tree.
 
388
 
 
389
        ids
 
390
            If set, use these instead of automatically generated ids.
 
391
            Must be the same length as the list of files, but may
 
392
            contain None for ids that are to be autogenerated.
 
393
 
 
394
        TODO: Perhaps have an option to add the ids even if the files do
 
395
              not (yet) exist.
 
396
 
 
397
        TODO: Perhaps return the ids of the files?  But then again it
 
398
              is easy to retrieve them if they're needed.
 
399
 
 
400
        TODO: Adding a directory should optionally recurse down and
 
401
              add all non-ignored children.  Perhaps do that in a
 
402
              higher-level method.
 
403
        """
 
404
        from bzrlib.textui import show_status
 
405
        # TODO: Re-adding a file that is removed in the working copy
 
406
        # should probably put it back with the previous ID.
 
407
        if isinstance(files, basestring):
 
408
            assert(ids is None or isinstance(ids, basestring))
 
409
            files = [files]
 
410
            if ids is not None:
 
411
                ids = [ids]
 
412
 
 
413
        if ids is None:
 
414
            ids = [None] * len(files)
 
415
        else:
 
416
            assert(len(ids) == len(files))
 
417
 
 
418
        self.lock_write()
 
419
        try:
 
420
            inv = self.read_working_inventory()
 
421
            for f,file_id in zip(files, ids):
 
422
                if is_control_file(f):
 
423
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
424
 
 
425
                fp = splitpath(f)
 
426
 
 
427
                if len(fp) == 0:
 
428
                    raise BzrError("cannot add top-level %r" % f)
 
429
 
 
430
                fullpath = os.path.normpath(self.abspath(f))
 
431
 
 
432
                try:
 
433
                    kind = file_kind(fullpath)
 
434
                except OSError:
 
435
                    # maybe something better?
 
436
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
437
 
 
438
                if kind != 'file' and kind != 'directory':
 
439
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
440
 
 
441
                if file_id is None:
 
442
                    file_id = gen_file_id(f)
 
443
                inv.add_path(f, kind=kind, file_id=file_id)
 
444
 
 
445
                if verbose:
 
446
                    print 'added', quotefn(f)
 
447
 
 
448
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
449
 
 
450
            self._write_inventory(inv)
 
451
        finally:
 
452
            self.unlock()
 
453
            
 
454
 
 
455
    def print_file(self, file, revno):
 
456
        """Print `file` to stdout."""
 
457
        self.lock_read()
 
458
        try:
 
459
            tree = self.revision_tree(self.lookup_revision(revno))
 
460
            # use inventory as it was in that revision
 
461
            file_id = tree.inventory.path2id(file)
 
462
            if not file_id:
 
463
                raise BzrError("%r is not present in revision %d" % (file, revno))
 
464
            tree.print_file(file_id)
 
465
        finally:
 
466
            self.unlock()
 
467
 
 
468
 
 
469
    def remove(self, files, verbose=False):
 
470
        """Mark nominated files for removal from the inventory.
 
471
 
 
472
        This does not remove their text.  This does not run on 
 
473
 
 
474
        TODO: Refuse to remove modified files unless --force is given?
 
475
 
 
476
        TODO: Do something useful with directories.
 
477
 
 
478
        TODO: Should this remove the text or not?  Tough call; not
 
479
        removing may be useful and the user can just use use rm, and
 
480
        is the opposite of add.  Removing it is consistent with most
 
481
        other tools.  Maybe an option.
 
482
        """
 
483
        from bzrlib.textui import show_status
 
484
        ## TODO: Normalize names
 
485
        ## TODO: Remove nested loops; better scalability
 
486
        if isinstance(files, basestring):
 
487
            files = [files]
 
488
 
 
489
        self.lock_write()
 
490
 
 
491
        try:
 
492
            tree = self.working_tree()
 
493
            inv = tree.inventory
 
494
 
 
495
            # do this before any modifications
 
496
            for f in files:
 
497
                fid = inv.path2id(f)
 
498
                if not fid:
 
499
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
500
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
501
                if verbose:
 
502
                    # having remove it, it must be either ignored or unknown
 
503
                    if tree.is_ignored(f):
 
504
                        new_status = 'I'
 
505
                    else:
 
506
                        new_status = '?'
 
507
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
508
                del inv[fid]
 
509
 
 
510
            self._write_inventory(inv)
 
511
        finally:
 
512
            self.unlock()
 
513
 
 
514
 
 
515
    # FIXME: this doesn't need to be a branch method
 
516
    def set_inventory(self, new_inventory_list):
 
517
        from bzrlib.inventory import Inventory, InventoryEntry
 
518
        inv = Inventory()
 
519
        for path, file_id, parent, kind in new_inventory_list:
 
520
            name = os.path.basename(path)
 
521
            if name == "":
 
522
                continue
 
523
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
524
        self._write_inventory(inv)
 
525
 
 
526
 
 
527
    def unknowns(self):
 
528
        """Return all unknown files.
 
529
 
 
530
        These are files in the working directory that are not versioned or
 
531
        control files or ignored.
 
532
        
 
533
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
534
        >>> list(b.unknowns())
 
535
        ['foo']
 
536
        >>> b.add('foo')
 
537
        >>> list(b.unknowns())
 
538
        []
 
539
        >>> b.remove('foo')
 
540
        >>> list(b.unknowns())
 
541
        ['foo']
 
542
        """
 
543
        return self.working_tree().unknowns()
 
544
 
 
545
 
 
546
    def append_revision(self, revision_id):
 
547
        from bzrlib.atomicfile import AtomicFile
 
548
 
 
549
        mutter("add {%s} to revision-history" % revision_id)
 
550
        rev_history = self.revision_history() + [revision_id]
 
551
 
 
552
        f = AtomicFile(self.controlfilename('revision-history'))
 
553
        try:
 
554
            for rev_id in rev_history:
 
555
                print >>f, rev_id
 
556
            f.commit()
 
557
        finally:
 
558
            f.close()
 
559
 
 
560
 
 
561
    def get_revision(self, revision_id):
 
562
        """Return the Revision object for a named revision"""
 
563
        from bzrlib.revision import Revision
 
564
        from bzrlib.xml import unpack_xml
 
565
 
 
566
        self.lock_read()
 
567
        try:
 
568
            if not revision_id or not isinstance(revision_id, basestring):
 
569
                raise ValueError('invalid revision-id: %r' % revision_id)
 
570
            r = unpack_xml(Revision, self.revision_store[revision_id])
 
571
        finally:
 
572
            self.unlock()
 
573
            
 
574
        assert r.revision_id == revision_id
 
575
        return r
 
576
        
 
577
 
 
578
    def get_revision_sha1(self, revision_id):
 
579
        """Hash the stored value of a revision, and return it."""
 
580
        # In the future, revision entries will be signed. At that
 
581
        # point, it is probably best *not* to include the signature
 
582
        # in the revision hash. Because that lets you re-sign
 
583
        # the revision, (add signatures/remove signatures) and still
 
584
        # have all hash pointers stay consistent.
 
585
        # But for now, just hash the contents.
 
586
        return sha_file(self.revision_store[revision_id])
 
587
 
 
588
 
 
589
    def get_inventory(self, inventory_id):
 
590
        """Get Inventory object by hash.
 
591
 
 
592
        TODO: Perhaps for this and similar methods, take a revision
 
593
               parameter which can be either an integer revno or a
 
594
               string hash."""
 
595
        from bzrlib.inventory import Inventory
 
596
        from bzrlib.xml import unpack_xml
 
597
 
 
598
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
 
599
            
 
600
 
 
601
    def get_inventory_sha1(self, inventory_id):
 
602
        """Return the sha1 hash of the inventory entry
 
603
        """
 
604
        return sha_file(self.inventory_store[inventory_id])
 
605
 
 
606
 
 
607
    def get_revision_inventory(self, revision_id):
 
608
        """Return inventory of a past revision."""
 
609
        if revision_id == None:
 
610
            from bzrlib.inventory import Inventory
 
611
            return Inventory()
 
612
        else:
 
613
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
614
 
 
615
 
 
616
    def revision_history(self):
 
617
        """Return sequence of revision hashes on to this branch.
 
618
 
 
619
        >>> ScratchBranch().revision_history()
 
620
        []
 
621
        """
 
622
        self.lock_read()
 
623
        try:
 
624
            return [l.rstrip('\r\n') for l in
 
625
                    self.controlfile('revision-history', 'r').readlines()]
 
626
        finally:
 
627
            self.unlock()
 
628
 
 
629
 
 
630
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
631
        """
 
632
        >>> import commit
 
633
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
634
        >>> sb.common_ancestor(sb) == (None, None)
 
635
        True
 
636
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
637
        >>> sb.common_ancestor(sb)[0]
 
638
        1
 
639
        >>> clone = sb.clone()
 
640
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
641
        >>> sb.common_ancestor(sb)[0]
 
642
        2
 
643
        >>> sb.common_ancestor(clone)[0]
 
644
        1
 
645
        >>> commit.commit(clone, "Committing divergent second revision", 
 
646
        ...               verbose=False)
 
647
        >>> sb.common_ancestor(clone)[0]
 
648
        1
 
649
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
650
        True
 
651
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
652
        True
 
653
        >>> clone2 = sb.clone()
 
654
        >>> sb.common_ancestor(clone2)[0]
 
655
        2
 
656
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
657
        1
 
658
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
659
        1
 
660
        """
 
661
        my_history = self.revision_history()
 
662
        other_history = other.revision_history()
 
663
        if self_revno is None:
 
664
            self_revno = len(my_history)
 
665
        if other_revno is None:
 
666
            other_revno = len(other_history)
 
667
        indices = range(min((self_revno, other_revno)))
 
668
        indices.reverse()
 
669
        for r in indices:
 
670
            if my_history[r] == other_history[r]:
 
671
                return r+1, my_history[r]
 
672
        return None, None
 
673
 
 
674
    def enum_history(self, direction):
 
675
        """Return (revno, revision_id) for history of branch.
 
676
 
 
677
        direction
 
678
            'forward' is from earliest to latest
 
679
            'reverse' is from latest to earliest
 
680
        """
 
681
        rh = self.revision_history()
 
682
        if direction == 'forward':
 
683
            i = 1
 
684
            for rid in rh:
 
685
                yield i, rid
 
686
                i += 1
 
687
        elif direction == 'reverse':
 
688
            i = len(rh)
 
689
            while i > 0:
 
690
                yield i, rh[i-1]
 
691
                i -= 1
 
692
        else:
 
693
            raise ValueError('invalid history direction', direction)
 
694
 
 
695
 
 
696
    def revno(self):
 
697
        """Return current revision number for this branch.
 
698
 
 
699
        That is equivalent to the number of revisions committed to
 
700
        this branch.
 
701
        """
 
702
        return len(self.revision_history())
 
703
 
 
704
 
 
705
    def last_patch(self):
 
706
        """Return last patch hash, or None if no history.
 
707
        """
 
708
        ph = self.revision_history()
 
709
        if ph:
 
710
            return ph[-1]
 
711
        else:
 
712
            return None
 
713
 
 
714
 
 
715
    def missing_revisions(self, other, stop_revision=None):
 
716
        """
 
717
        If self and other have not diverged, return a list of the revisions
 
718
        present in other, but missing from self.
 
719
 
 
720
        >>> from bzrlib.commit import commit
 
721
        >>> bzrlib.trace.silent = True
 
722
        >>> br1 = ScratchBranch()
 
723
        >>> br2 = ScratchBranch()
 
724
        >>> br1.missing_revisions(br2)
 
725
        []
 
726
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
727
        >>> br1.missing_revisions(br2)
 
728
        [u'REVISION-ID-1']
 
729
        >>> br2.missing_revisions(br1)
 
730
        []
 
731
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
732
        >>> br1.missing_revisions(br2)
 
733
        []
 
734
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
735
        >>> br1.missing_revisions(br2)
 
736
        [u'REVISION-ID-2A']
 
737
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
738
        >>> br1.missing_revisions(br2)
 
739
        Traceback (most recent call last):
 
740
        DivergedBranches: These branches have diverged.
 
741
        """
 
742
        self_history = self.revision_history()
 
743
        self_len = len(self_history)
 
744
        other_history = other.revision_history()
 
745
        other_len = len(other_history)
 
746
        common_index = min(self_len, other_len) -1
 
747
        if common_index >= 0 and \
 
748
            self_history[common_index] != other_history[common_index]:
 
749
            raise DivergedBranches(self, other)
 
750
 
 
751
        if stop_revision is None:
 
752
            stop_revision = other_len
 
753
        elif stop_revision > other_len:
 
754
            raise NoSuchRevision(self, stop_revision)
 
755
        
 
756
        return other_history[self_len:stop_revision]
 
757
 
 
758
 
 
759
    def update_revisions(self, other, stop_revision=None):
 
760
        """Pull in all new revisions from other branch.
 
761
        
 
762
        >>> from bzrlib.commit import commit
 
763
        >>> bzrlib.trace.silent = True
 
764
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
765
        >>> br1.add('foo')
 
766
        >>> br1.add('bar')
 
767
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
768
        >>> br2 = ScratchBranch()
 
769
        >>> br2.update_revisions(br1)
 
770
        Added 2 texts.
 
771
        Added 1 inventories.
 
772
        Added 1 revisions.
 
773
        >>> br2.revision_history()
 
774
        [u'REVISION-ID-1']
 
775
        >>> br2.update_revisions(br1)
 
776
        Added 0 texts.
 
777
        Added 0 inventories.
 
778
        Added 0 revisions.
 
779
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
780
        True
 
781
        """
 
782
        from bzrlib.progress import ProgressBar
 
783
        try:
 
784
            set
 
785
        except NameError:
 
786
            from sets import Set as set
 
787
 
 
788
        pb = ProgressBar()
 
789
 
 
790
        pb.update('comparing histories')
 
791
        revision_ids = self.missing_revisions(other, stop_revision)
 
792
 
 
793
        if hasattr(other.revision_store, "prefetch"):
 
794
            other.revision_store.prefetch(revision_ids)
 
795
        if hasattr(other.inventory_store, "prefetch"):
 
796
            inventory_ids = [other.get_revision(r).inventory_id
 
797
                             for r in revision_ids]
 
798
            other.inventory_store.prefetch(inventory_ids)
 
799
                
 
800
        revisions = []
 
801
        needed_texts = set()
 
802
        i = 0
 
803
        for rev_id in revision_ids:
 
804
            i += 1
 
805
            pb.update('fetching revision', i, len(revision_ids))
 
806
            rev = other.get_revision(rev_id)
 
807
            revisions.append(rev)
 
808
            inv = other.get_inventory(str(rev.inventory_id))
 
809
            for key, entry in inv.iter_entries():
 
810
                if entry.text_id is None:
 
811
                    continue
 
812
                if entry.text_id not in self.text_store:
 
813
                    needed_texts.add(entry.text_id)
 
814
 
 
815
        pb.clear()
 
816
                    
 
817
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
818
        print "Added %d texts." % count 
 
819
        inventory_ids = [ f.inventory_id for f in revisions ]
 
820
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
821
                                                inventory_ids)
 
822
        print "Added %d inventories." % count 
 
823
        revision_ids = [ f.revision_id for f in revisions]
 
824
        count = self.revision_store.copy_multi(other.revision_store, 
 
825
                                               revision_ids)
 
826
        for revision_id in revision_ids:
 
827
            self.append_revision(revision_id)
 
828
        print "Added %d revisions." % count
 
829
                    
 
830
        
 
831
    def commit(self, *args, **kw):
 
832
        from bzrlib.commit import commit
 
833
        commit(self, *args, **kw)
 
834
        
 
835
 
 
836
    def lookup_revision(self, revno):
 
837
        """Return revision hash for revision number."""
 
838
        if revno == 0:
 
839
            return None
 
840
 
 
841
        try:
 
842
            # list is 0-based; revisions are 1-based
 
843
            return self.revision_history()[revno-1]
 
844
        except IndexError:
 
845
            raise BzrError("no such revision %s" % revno)
 
846
 
 
847
 
 
848
    def revision_tree(self, revision_id):
 
849
        """Return Tree for a revision on this branch.
 
850
 
 
851
        `revision_id` may be None for the null revision, in which case
 
852
        an `EmptyTree` is returned."""
 
853
        from bzrlib.tree import EmptyTree, RevisionTree
 
854
        # TODO: refactor this to use an existing revision object
 
855
        # so we don't need to read it in twice.
 
856
        if revision_id == None:
 
857
            return EmptyTree()
 
858
        else:
 
859
            inv = self.get_revision_inventory(revision_id)
 
860
            return RevisionTree(self.text_store, inv)
 
861
 
 
862
 
 
863
    def working_tree(self):
 
864
        """Return a `Tree` for the working copy."""
 
865
        from workingtree import WorkingTree
 
866
        return WorkingTree(self.base, self.read_working_inventory())
 
867
 
 
868
 
 
869
    def basis_tree(self):
 
870
        """Return `Tree` object for last revision.
 
871
 
 
872
        If there are no revisions yet, return an `EmptyTree`.
 
873
        """
 
874
        from bzrlib.tree import EmptyTree, RevisionTree
 
875
        r = self.last_patch()
 
876
        if r == None:
 
877
            return EmptyTree()
 
878
        else:
 
879
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
880
 
 
881
 
 
882
 
 
883
    def rename_one(self, from_rel, to_rel):
 
884
        """Rename one file.
 
885
 
 
886
        This can change the directory or the filename or both.
 
887
        """
 
888
        self.lock_write()
 
889
        try:
 
890
            tree = self.working_tree()
 
891
            inv = tree.inventory
 
892
            if not tree.has_filename(from_rel):
 
893
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
894
            if tree.has_filename(to_rel):
 
895
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
896
 
 
897
            file_id = inv.path2id(from_rel)
 
898
            if file_id == None:
 
899
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
900
 
 
901
            if inv.path2id(to_rel):
 
902
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
903
 
 
904
            to_dir, to_tail = os.path.split(to_rel)
 
905
            to_dir_id = inv.path2id(to_dir)
 
906
            if to_dir_id == None and to_dir != '':
 
907
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
908
 
 
909
            mutter("rename_one:")
 
910
            mutter("  file_id    {%s}" % file_id)
 
911
            mutter("  from_rel   %r" % from_rel)
 
912
            mutter("  to_rel     %r" % to_rel)
 
913
            mutter("  to_dir     %r" % to_dir)
 
914
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
915
 
 
916
            inv.rename(file_id, to_dir_id, to_tail)
 
917
 
 
918
            print "%s => %s" % (from_rel, to_rel)
 
919
 
 
920
            from_abs = self.abspath(from_rel)
 
921
            to_abs = self.abspath(to_rel)
 
922
            try:
 
923
                os.rename(from_abs, to_abs)
 
924
            except OSError, e:
 
925
                raise BzrError("failed to rename %r to %r: %s"
 
926
                        % (from_abs, to_abs, e[1]),
 
927
                        ["rename rolled back"])
 
928
 
 
929
            self._write_inventory(inv)
 
930
        finally:
 
931
            self.unlock()
 
932
 
 
933
 
 
934
    def move(self, from_paths, to_name):
 
935
        """Rename files.
 
936
 
 
937
        to_name must exist as a versioned directory.
 
938
 
 
939
        If to_name exists and is a directory, the files are moved into
 
940
        it, keeping their old names.  If it is a directory, 
 
941
 
 
942
        Note that to_name is only the last component of the new name;
 
943
        this doesn't change the directory.
 
944
        """
 
945
        self.lock_write()
 
946
        try:
 
947
            ## TODO: Option to move IDs only
 
948
            assert not isinstance(from_paths, basestring)
 
949
            tree = self.working_tree()
 
950
            inv = tree.inventory
 
951
            to_abs = self.abspath(to_name)
 
952
            if not isdir(to_abs):
 
953
                raise BzrError("destination %r is not a directory" % to_abs)
 
954
            if not tree.has_filename(to_name):
 
955
                raise BzrError("destination %r not in working directory" % to_abs)
 
956
            to_dir_id = inv.path2id(to_name)
 
957
            if to_dir_id == None and to_name != '':
 
958
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
959
            to_dir_ie = inv[to_dir_id]
 
960
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
961
                raise BzrError("destination %r is not a directory" % to_abs)
 
962
 
 
963
            to_idpath = inv.get_idpath(to_dir_id)
 
964
 
 
965
            for f in from_paths:
 
966
                if not tree.has_filename(f):
 
967
                    raise BzrError("%r does not exist in working tree" % f)
 
968
                f_id = inv.path2id(f)
 
969
                if f_id == None:
 
970
                    raise BzrError("%r is not versioned" % f)
 
971
                name_tail = splitpath(f)[-1]
 
972
                dest_path = appendpath(to_name, name_tail)
 
973
                if tree.has_filename(dest_path):
 
974
                    raise BzrError("destination %r already exists" % dest_path)
 
975
                if f_id in to_idpath:
 
976
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
977
 
 
978
            # OK, so there's a race here, it's possible that someone will
 
979
            # create a file in this interval and then the rename might be
 
980
            # left half-done.  But we should have caught most problems.
 
981
 
 
982
            for f in from_paths:
 
983
                name_tail = splitpath(f)[-1]
 
984
                dest_path = appendpath(to_name, name_tail)
 
985
                print "%s => %s" % (f, dest_path)
 
986
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
987
                try:
 
988
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
989
                except OSError, e:
 
990
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
991
                            ["rename rolled back"])
 
992
 
 
993
            self._write_inventory(inv)
 
994
        finally:
 
995
            self.unlock()
 
996
 
 
997
 
 
998
    def revert(self, filenames, old_tree=None, backups=True):
 
999
        """Restore selected files to the versions from a previous tree.
 
1000
 
 
1001
        backups
 
1002
            If true (default) backups are made of files before
 
1003
            they're renamed.
 
1004
        """
 
1005
        from bzrlib.errors import NotVersionedError, BzrError
 
1006
        from bzrlib.atomicfile import AtomicFile
 
1007
        from bzrlib.osutils import backup_file
 
1008
        
 
1009
        inv = self.read_working_inventory()
 
1010
        if old_tree is None:
 
1011
            old_tree = self.basis_tree()
 
1012
        old_inv = old_tree.inventory
 
1013
 
 
1014
        nids = []
 
1015
        for fn in filenames:
 
1016
            file_id = inv.path2id(fn)
 
1017
            if not file_id:
 
1018
                raise NotVersionedError("not a versioned file", fn)
 
1019
            if not old_inv.has_id(file_id):
 
1020
                raise BzrError("file not present in old tree", fn, file_id)
 
1021
            nids.append((fn, file_id))
 
1022
            
 
1023
        # TODO: Rename back if it was previously at a different location
 
1024
 
 
1025
        # TODO: If given a directory, restore the entire contents from
 
1026
        # the previous version.
 
1027
 
 
1028
        # TODO: Make a backup to a temporary file.
 
1029
 
 
1030
        # TODO: If the file previously didn't exist, delete it?
 
1031
        for fn, file_id in nids:
 
1032
            backup_file(fn)
 
1033
            
 
1034
            f = AtomicFile(fn, 'wb')
 
1035
            try:
 
1036
                f.write(old_tree.get_file(file_id).read())
 
1037
                f.commit()
 
1038
            finally:
 
1039
                f.close()
 
1040
 
 
1041
 
 
1042
 
 
1043
class ScratchBranch(Branch):
 
1044
    """Special test class: a branch that cleans up after itself.
 
1045
 
 
1046
    >>> b = ScratchBranch()
 
1047
    >>> isdir(b.base)
 
1048
    True
 
1049
    >>> bd = b.base
 
1050
    >>> b.destroy()
 
1051
    >>> isdir(bd)
 
1052
    False
 
1053
    """
 
1054
    def __init__(self, files=[], dirs=[], base=None):
 
1055
        """Make a test branch.
 
1056
 
 
1057
        This creates a temporary directory and runs init-tree in it.
 
1058
 
 
1059
        If any files are listed, they are created in the working copy.
 
1060
        """
 
1061
        from tempfile import mkdtemp
 
1062
        init = False
 
1063
        if base is None:
 
1064
            base = mkdtemp()
 
1065
            init = True
 
1066
        Branch.__init__(self, base, init=init)
 
1067
        for d in dirs:
 
1068
            os.mkdir(self.abspath(d))
 
1069
            
 
1070
        for f in files:
 
1071
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1072
 
 
1073
 
 
1074
    def clone(self):
 
1075
        """
 
1076
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1077
        >>> clone = orig.clone()
 
1078
        >>> os.path.samefile(orig.base, clone.base)
 
1079
        False
 
1080
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1081
        True
 
1082
        """
 
1083
        from shutil import copytree
 
1084
        from tempfile import mkdtemp
 
1085
        base = mkdtemp()
 
1086
        os.rmdir(base)
 
1087
        copytree(self.base, base, symlinks=True)
 
1088
        return ScratchBranch(base=base)
 
1089
        
 
1090
    def __del__(self):
 
1091
        self.destroy()
 
1092
 
 
1093
    def destroy(self):
 
1094
        """Destroy the test branch, removing the scratch directory."""
 
1095
        from shutil import rmtree
 
1096
        try:
 
1097
            if self.base:
 
1098
                mutter("delete ScratchBranch %s" % self.base)
 
1099
                rmtree(self.base)
 
1100
        except OSError, e:
 
1101
            # Work around for shutil.rmtree failing on Windows when
 
1102
            # readonly files are encountered
 
1103
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1104
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1105
                for name in files:
 
1106
                    os.chmod(os.path.join(root, name), 0700)
 
1107
            rmtree(self.base)
 
1108
        self.base = None
 
1109
 
 
1110
    
 
1111
 
 
1112
######################################################################
 
1113
# predicates
 
1114
 
 
1115
 
 
1116
def is_control_file(filename):
 
1117
    ## FIXME: better check
 
1118
    filename = os.path.normpath(filename)
 
1119
    while filename != '':
 
1120
        head, tail = os.path.split(filename)
 
1121
        ## mutter('check %r for control file' % ((head, tail), ))
 
1122
        if tail == bzrlib.BZRDIR:
 
1123
            return True
 
1124
        if filename == head:
 
1125
            break
 
1126
        filename = head
 
1127
    return False
 
1128
 
 
1129
 
 
1130
 
 
1131
def gen_file_id(name):
 
1132
    """Return new file id.
 
1133
 
 
1134
    This should probably generate proper UUIDs, but for the moment we
 
1135
    cope with just randomness because running uuidgen every time is
 
1136
    slow."""
 
1137
    import re
 
1138
    from binascii import hexlify
 
1139
    from time import time
 
1140
 
 
1141
    # get last component
 
1142
    idx = name.rfind('/')
 
1143
    if idx != -1:
 
1144
        name = name[idx+1 : ]
 
1145
    idx = name.rfind('\\')
 
1146
    if idx != -1:
 
1147
        name = name[idx+1 : ]
 
1148
 
 
1149
    # make it not a hidden file
 
1150
    name = name.lstrip('.')
 
1151
 
 
1152
    # remove any wierd characters; we don't escape them but rather
 
1153
    # just pull them out
 
1154
    name = re.sub(r'[^\w.]', '', name)
 
1155
 
 
1156
    s = hexlify(rand_bytes(8))
 
1157
    return '-'.join((name, compact_date(time()), s))