/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-07-04 12:26:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050704122602-69901910521e62c3
- check command checks that all inventory-ids are the same as in the revision.

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
        if revision_id == None:
 
611
            from bzrlib.inventory import Inventory
 
612
            return Inventory()
 
613
        else:
 
614
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
615
 
 
616
 
 
617
    def revision_history(self):
 
618
        """Return sequence of revision hashes on to this branch.
 
619
 
 
620
        >>> ScratchBranch().revision_history()
 
621
        []
 
622
        """
 
623
        self.lock_read()
 
624
        try:
 
625
            return [l.rstrip('\r\n') for l in
 
626
                    self.controlfile('revision-history', 'r').readlines()]
 
627
        finally:
 
628
            self.unlock()
 
629
 
 
630
 
 
631
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
632
        """
 
633
        >>> import commit
 
634
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
635
        >>> sb.common_ancestor(sb) == (None, None)
 
636
        True
 
637
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
638
        >>> sb.common_ancestor(sb)[0]
 
639
        1
 
640
        >>> clone = sb.clone()
 
641
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
642
        >>> sb.common_ancestor(sb)[0]
 
643
        2
 
644
        >>> sb.common_ancestor(clone)[0]
 
645
        1
 
646
        >>> commit.commit(clone, "Committing divergent second revision", 
 
647
        ...               verbose=False)
 
648
        >>> sb.common_ancestor(clone)[0]
 
649
        1
 
650
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
651
        True
 
652
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
653
        True
 
654
        >>> clone2 = sb.clone()
 
655
        >>> sb.common_ancestor(clone2)[0]
 
656
        2
 
657
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
658
        1
 
659
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
660
        1
 
661
        """
 
662
        my_history = self.revision_history()
 
663
        other_history = other.revision_history()
 
664
        if self_revno is None:
 
665
            self_revno = len(my_history)
 
666
        if other_revno is None:
 
667
            other_revno = len(other_history)
 
668
        indices = range(min((self_revno, other_revno)))
 
669
        indices.reverse()
 
670
        for r in indices:
 
671
            if my_history[r] == other_history[r]:
 
672
                return r+1, my_history[r]
 
673
        return None, None
 
674
 
 
675
    def enum_history(self, direction):
 
676
        """Return (revno, revision_id) for history of branch.
 
677
 
 
678
        direction
 
679
            'forward' is from earliest to latest
 
680
            'reverse' is from latest to earliest
 
681
        """
 
682
        rh = self.revision_history()
 
683
        if direction == 'forward':
 
684
            i = 1
 
685
            for rid in rh:
 
686
                yield i, rid
 
687
                i += 1
 
688
        elif direction == 'reverse':
 
689
            i = len(rh)
 
690
            while i > 0:
 
691
                yield i, rh[i-1]
 
692
                i -= 1
 
693
        else:
 
694
            raise ValueError('invalid history direction', direction)
 
695
 
 
696
 
 
697
    def revno(self):
 
698
        """Return current revision number for this branch.
 
699
 
 
700
        That is equivalent to the number of revisions committed to
 
701
        this branch.
 
702
        """
 
703
        return len(self.revision_history())
 
704
 
 
705
 
 
706
    def last_patch(self):
 
707
        """Return last patch hash, or None if no history.
 
708
        """
 
709
        ph = self.revision_history()
 
710
        if ph:
 
711
            return ph[-1]
 
712
        else:
 
713
            return None
 
714
 
 
715
 
 
716
    def missing_revisions(self, other, stop_revision=None):
 
717
        """
 
718
        If self and other have not diverged, return a list of the revisions
 
719
        present in other, but missing from self.
 
720
 
 
721
        >>> from bzrlib.commit import commit
 
722
        >>> bzrlib.trace.silent = True
 
723
        >>> br1 = ScratchBranch()
 
724
        >>> br2 = ScratchBranch()
 
725
        >>> br1.missing_revisions(br2)
 
726
        []
 
727
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
728
        >>> br1.missing_revisions(br2)
 
729
        [u'REVISION-ID-1']
 
730
        >>> br2.missing_revisions(br1)
 
731
        []
 
732
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
733
        >>> br1.missing_revisions(br2)
 
734
        []
 
735
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
736
        >>> br1.missing_revisions(br2)
 
737
        [u'REVISION-ID-2A']
 
738
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
739
        >>> br1.missing_revisions(br2)
 
740
        Traceback (most recent call last):
 
741
        DivergedBranches: These branches have diverged.
 
742
        """
 
743
        self_history = self.revision_history()
 
744
        self_len = len(self_history)
 
745
        other_history = other.revision_history()
 
746
        other_len = len(other_history)
 
747
        common_index = min(self_len, other_len) -1
 
748
        if common_index >= 0 and \
 
749
            self_history[common_index] != other_history[common_index]:
 
750
            raise DivergedBranches(self, other)
 
751
 
 
752
        if stop_revision is None:
 
753
            stop_revision = other_len
 
754
        elif stop_revision > other_len:
 
755
            raise NoSuchRevision(self, stop_revision)
 
756
        
 
757
        return other_history[self_len:stop_revision]
 
758
 
 
759
 
 
760
    def update_revisions(self, other, stop_revision=None):
 
761
        """Pull in all new revisions from other branch.
 
762
        
 
763
        >>> from bzrlib.commit import commit
 
764
        >>> bzrlib.trace.silent = True
 
765
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
766
        >>> br1.add('foo')
 
767
        >>> br1.add('bar')
 
768
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
769
        >>> br2 = ScratchBranch()
 
770
        >>> br2.update_revisions(br1)
 
771
        Added 2 texts.
 
772
        Added 1 inventories.
 
773
        Added 1 revisions.
 
774
        >>> br2.revision_history()
 
775
        [u'REVISION-ID-1']
 
776
        >>> br2.update_revisions(br1)
 
777
        Added 0 texts.
 
778
        Added 0 inventories.
 
779
        Added 0 revisions.
 
780
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
781
        True
 
782
        """
 
783
        from bzrlib.progress import ProgressBar
 
784
        try:
 
785
            set
 
786
        except NameError:
 
787
            from sets import Set as set
 
788
 
 
789
        pb = ProgressBar()
 
790
 
 
791
        pb.update('comparing histories')
 
792
        revision_ids = self.missing_revisions(other, stop_revision)
 
793
 
 
794
        if hasattr(other.revision_store, "prefetch"):
 
795
            other.revision_store.prefetch(revision_ids)
 
796
        if hasattr(other.inventory_store, "prefetch"):
 
797
            inventory_ids = [other.get_revision(r).inventory_id
 
798
                             for r in revision_ids]
 
799
            other.inventory_store.prefetch(inventory_ids)
 
800
                
 
801
        revisions = []
 
802
        needed_texts = set()
 
803
        i = 0
 
804
        for rev_id in revision_ids:
 
805
            i += 1
 
806
            pb.update('fetching revision', i, len(revision_ids))
 
807
            rev = other.get_revision(rev_id)
 
808
            revisions.append(rev)
 
809
            inv = other.get_inventory(str(rev.inventory_id))
 
810
            for key, entry in inv.iter_entries():
 
811
                if entry.text_id is None:
 
812
                    continue
 
813
                if entry.text_id not in self.text_store:
 
814
                    needed_texts.add(entry.text_id)
 
815
 
 
816
        pb.clear()
 
817
                    
 
818
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
819
        print "Added %d texts." % count 
 
820
        inventory_ids = [ f.inventory_id for f in revisions ]
 
821
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
822
                                                inventory_ids)
 
823
        print "Added %d inventories." % count 
 
824
        revision_ids = [ f.revision_id for f in revisions]
 
825
        count = self.revision_store.copy_multi(other.revision_store, 
 
826
                                               revision_ids)
 
827
        for revision_id in revision_ids:
 
828
            self.append_revision(revision_id)
 
829
        print "Added %d revisions." % count
 
830
                    
 
831
        
 
832
    def commit(self, *args, **kw):
 
833
        from bzrlib.commit import commit
 
834
        commit(self, *args, **kw)
 
835
        
 
836
 
 
837
    def lookup_revision(self, revno):
 
838
        """Return revision hash for revision number."""
 
839
        if revno == 0:
 
840
            return None
 
841
 
 
842
        try:
 
843
            # list is 0-based; revisions are 1-based
 
844
            return self.revision_history()[revno-1]
 
845
        except IndexError:
 
846
            raise BzrError("no such revision %s" % revno)
 
847
 
 
848
 
 
849
    def revision_tree(self, revision_id):
 
850
        """Return Tree for a revision on this branch.
 
851
 
 
852
        `revision_id` may be None for the null revision, in which case
 
853
        an `EmptyTree` is returned."""
 
854
        from bzrlib.tree import EmptyTree, RevisionTree
 
855
        # TODO: refactor this to use an existing revision object
 
856
        # so we don't need to read it in twice.
 
857
        if revision_id == None:
 
858
            return EmptyTree()
 
859
        else:
 
860
            inv = self.get_revision_inventory(revision_id)
 
861
            return RevisionTree(self.text_store, inv)
 
862
 
 
863
 
 
864
    def working_tree(self):
 
865
        """Return a `Tree` for the working copy."""
 
866
        from workingtree import WorkingTree
 
867
        return WorkingTree(self.base, self.read_working_inventory())
 
868
 
 
869
 
 
870
    def basis_tree(self):
 
871
        """Return `Tree` object for last revision.
 
872
 
 
873
        If there are no revisions yet, return an `EmptyTree`.
 
874
        """
 
875
        from bzrlib.tree import EmptyTree, RevisionTree
 
876
        r = self.last_patch()
 
877
        if r == None:
 
878
            return EmptyTree()
 
879
        else:
 
880
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
881
 
 
882
 
 
883
 
 
884
    def rename_one(self, from_rel, to_rel):
 
885
        """Rename one file.
 
886
 
 
887
        This can change the directory or the filename or both.
 
888
        """
 
889
        self.lock_write()
 
890
        try:
 
891
            tree = self.working_tree()
 
892
            inv = tree.inventory
 
893
            if not tree.has_filename(from_rel):
 
894
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
895
            if tree.has_filename(to_rel):
 
896
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
897
 
 
898
            file_id = inv.path2id(from_rel)
 
899
            if file_id == None:
 
900
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
901
 
 
902
            if inv.path2id(to_rel):
 
903
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
904
 
 
905
            to_dir, to_tail = os.path.split(to_rel)
 
906
            to_dir_id = inv.path2id(to_dir)
 
907
            if to_dir_id == None and to_dir != '':
 
908
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
909
 
 
910
            mutter("rename_one:")
 
911
            mutter("  file_id    {%s}" % file_id)
 
912
            mutter("  from_rel   %r" % from_rel)
 
913
            mutter("  to_rel     %r" % to_rel)
 
914
            mutter("  to_dir     %r" % to_dir)
 
915
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
916
 
 
917
            inv.rename(file_id, to_dir_id, to_tail)
 
918
 
 
919
            print "%s => %s" % (from_rel, to_rel)
 
920
 
 
921
            from_abs = self.abspath(from_rel)
 
922
            to_abs = self.abspath(to_rel)
 
923
            try:
 
924
                os.rename(from_abs, to_abs)
 
925
            except OSError, e:
 
926
                raise BzrError("failed to rename %r to %r: %s"
 
927
                        % (from_abs, to_abs, e[1]),
 
928
                        ["rename rolled back"])
 
929
 
 
930
            self._write_inventory(inv)
 
931
        finally:
 
932
            self.unlock()
 
933
 
 
934
 
 
935
    def move(self, from_paths, to_name):
 
936
        """Rename files.
 
937
 
 
938
        to_name must exist as a versioned directory.
 
939
 
 
940
        If to_name exists and is a directory, the files are moved into
 
941
        it, keeping their old names.  If it is a directory, 
 
942
 
 
943
        Note that to_name is only the last component of the new name;
 
944
        this doesn't change the directory.
 
945
        """
 
946
        self.lock_write()
 
947
        try:
 
948
            ## TODO: Option to move IDs only
 
949
            assert not isinstance(from_paths, basestring)
 
950
            tree = self.working_tree()
 
951
            inv = tree.inventory
 
952
            to_abs = self.abspath(to_name)
 
953
            if not isdir(to_abs):
 
954
                raise BzrError("destination %r is not a directory" % to_abs)
 
955
            if not tree.has_filename(to_name):
 
956
                raise BzrError("destination %r not in working directory" % to_abs)
 
957
            to_dir_id = inv.path2id(to_name)
 
958
            if to_dir_id == None and to_name != '':
 
959
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
960
            to_dir_ie = inv[to_dir_id]
 
961
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
962
                raise BzrError("destination %r is not a directory" % to_abs)
 
963
 
 
964
            to_idpath = inv.get_idpath(to_dir_id)
 
965
 
 
966
            for f in from_paths:
 
967
                if not tree.has_filename(f):
 
968
                    raise BzrError("%r does not exist in working tree" % f)
 
969
                f_id = inv.path2id(f)
 
970
                if f_id == None:
 
971
                    raise BzrError("%r is not versioned" % f)
 
972
                name_tail = splitpath(f)[-1]
 
973
                dest_path = appendpath(to_name, name_tail)
 
974
                if tree.has_filename(dest_path):
 
975
                    raise BzrError("destination %r already exists" % dest_path)
 
976
                if f_id in to_idpath:
 
977
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
978
 
 
979
            # OK, so there's a race here, it's possible that someone will
 
980
            # create a file in this interval and then the rename might be
 
981
            # left half-done.  But we should have caught most problems.
 
982
 
 
983
            for f in from_paths:
 
984
                name_tail = splitpath(f)[-1]
 
985
                dest_path = appendpath(to_name, name_tail)
 
986
                print "%s => %s" % (f, dest_path)
 
987
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
988
                try:
 
989
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
990
                except OSError, e:
 
991
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
992
                            ["rename rolled back"])
 
993
 
 
994
            self._write_inventory(inv)
 
995
        finally:
 
996
            self.unlock()
 
997
 
 
998
 
 
999
    def revert(self, filenames, old_tree=None, backups=True):
 
1000
        """Restore selected files to the versions from a previous tree.
 
1001
 
 
1002
        backups
 
1003
            If true (default) backups are made of files before
 
1004
            they're renamed.
 
1005
        """
 
1006
        from bzrlib.errors import NotVersionedError, BzrError
 
1007
        from bzrlib.atomicfile import AtomicFile
 
1008
        from bzrlib.osutils import backup_file
 
1009
        
 
1010
        inv = self.read_working_inventory()
 
1011
        if old_tree is None:
 
1012
            old_tree = self.basis_tree()
 
1013
        old_inv = old_tree.inventory
 
1014
 
 
1015
        nids = []
 
1016
        for fn in filenames:
 
1017
            file_id = inv.path2id(fn)
 
1018
            if not file_id:
 
1019
                raise NotVersionedError("not a versioned file", fn)
 
1020
            if not old_inv.has_id(file_id):
 
1021
                raise BzrError("file not present in old tree", fn, file_id)
 
1022
            nids.append((fn, file_id))
 
1023
            
 
1024
        # TODO: Rename back if it was previously at a different location
 
1025
 
 
1026
        # TODO: If given a directory, restore the entire contents from
 
1027
        # the previous version.
 
1028
 
 
1029
        # TODO: Make a backup to a temporary file.
 
1030
 
 
1031
        # TODO: If the file previously didn't exist, delete it?
 
1032
        for fn, file_id in nids:
 
1033
            backup_file(fn)
 
1034
            
 
1035
            f = AtomicFile(fn, 'wb')
 
1036
            try:
 
1037
                f.write(old_tree.get_file(file_id).read())
 
1038
                f.commit()
 
1039
            finally:
 
1040
                f.close()
 
1041
 
 
1042
 
 
1043
    def pending_merges(self):
 
1044
        """Return a list of pending merges.
 
1045
 
 
1046
        These are revisions that have been merged into the working
 
1047
        directory but not yet committed.
 
1048
        """
 
1049
        cfn = self.controlfilename('pending-merges')
 
1050
        if not os.path.exists(cfn):
 
1051
            return []
 
1052
        p = []
 
1053
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1054
            p.append(l.rstrip('\n'))
 
1055
        return p
 
1056
 
 
1057
 
 
1058
    def add_pending_merge(self, revision_id):
 
1059
        from bzrlib.revision import validate_revision_id
 
1060
 
 
1061
        validate_revision_id(revision_id)
 
1062
 
 
1063
        p = self.pending_merges()
 
1064
        if revision_id in p:
 
1065
            return
 
1066
        p.append(revision_id)
 
1067
        self.set_pending_merges(p)
 
1068
 
 
1069
 
 
1070
    def set_pending_merges(self, rev_list):
 
1071
        from bzrlib.atomicfile import AtomicFile
 
1072
        self.lock_write()
 
1073
        try:
 
1074
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1075
            try:
 
1076
                for l in rev_list:
 
1077
                    print >>f, l
 
1078
                f.commit()
 
1079
            finally:
 
1080
                f.close()
 
1081
        finally:
 
1082
            self.unlock()
 
1083
 
 
1084
 
 
1085
 
 
1086
class ScratchBranch(Branch):
 
1087
    """Special test class: a branch that cleans up after itself.
 
1088
 
 
1089
    >>> b = ScratchBranch()
 
1090
    >>> isdir(b.base)
 
1091
    True
 
1092
    >>> bd = b.base
 
1093
    >>> b.destroy()
 
1094
    >>> isdir(bd)
 
1095
    False
 
1096
    """
 
1097
    def __init__(self, files=[], dirs=[], base=None):
 
1098
        """Make a test branch.
 
1099
 
 
1100
        This creates a temporary directory and runs init-tree in it.
 
1101
 
 
1102
        If any files are listed, they are created in the working copy.
 
1103
        """
 
1104
        from tempfile import mkdtemp
 
1105
        init = False
 
1106
        if base is None:
 
1107
            base = mkdtemp()
 
1108
            init = True
 
1109
        Branch.__init__(self, base, init=init)
 
1110
        for d in dirs:
 
1111
            os.mkdir(self.abspath(d))
 
1112
            
 
1113
        for f in files:
 
1114
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1115
 
 
1116
 
 
1117
    def clone(self):
 
1118
        """
 
1119
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1120
        >>> clone = orig.clone()
 
1121
        >>> os.path.samefile(orig.base, clone.base)
 
1122
        False
 
1123
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1124
        True
 
1125
        """
 
1126
        from shutil import copytree
 
1127
        from tempfile import mkdtemp
 
1128
        base = mkdtemp()
 
1129
        os.rmdir(base)
 
1130
        copytree(self.base, base, symlinks=True)
 
1131
        return ScratchBranch(base=base)
 
1132
        
 
1133
    def __del__(self):
 
1134
        self.destroy()
 
1135
 
 
1136
    def destroy(self):
 
1137
        """Destroy the test branch, removing the scratch directory."""
 
1138
        from shutil import rmtree
 
1139
        try:
 
1140
            if self.base:
 
1141
                mutter("delete ScratchBranch %s" % self.base)
 
1142
                rmtree(self.base)
 
1143
        except OSError, e:
 
1144
            # Work around for shutil.rmtree failing on Windows when
 
1145
            # readonly files are encountered
 
1146
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1147
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1148
                for name in files:
 
1149
                    os.chmod(os.path.join(root, name), 0700)
 
1150
            rmtree(self.base)
 
1151
        self.base = None
 
1152
 
 
1153
    
 
1154
 
 
1155
######################################################################
 
1156
# predicates
 
1157
 
 
1158
 
 
1159
def is_control_file(filename):
 
1160
    ## FIXME: better check
 
1161
    filename = os.path.normpath(filename)
 
1162
    while filename != '':
 
1163
        head, tail = os.path.split(filename)
 
1164
        ## mutter('check %r for control file' % ((head, tail), ))
 
1165
        if tail == bzrlib.BZRDIR:
 
1166
            return True
 
1167
        if filename == head:
 
1168
            break
 
1169
        filename = head
 
1170
    return False
 
1171
 
 
1172
 
 
1173
 
 
1174
def gen_file_id(name):
 
1175
    """Return new file id.
 
1176
 
 
1177
    This should probably generate proper UUIDs, but for the moment we
 
1178
    cope with just randomness because running uuidgen every time is
 
1179
    slow."""
 
1180
    import re
 
1181
    from binascii import hexlify
 
1182
    from time import time
 
1183
 
 
1184
    # get last component
 
1185
    idx = name.rfind('/')
 
1186
    if idx != -1:
 
1187
        name = name[idx+1 : ]
 
1188
    idx = name.rfind('\\')
 
1189
    if idx != -1:
 
1190
        name = name[idx+1 : ]
 
1191
 
 
1192
    # make it not a hidden file
 
1193
    name = name.lstrip('.')
 
1194
 
 
1195
    # remove any wierd characters; we don't escape them but rather
 
1196
    # just pull them out
 
1197
    name = re.sub(r'[^\w.]', '', name)
 
1198
 
 
1199
    s = hexlify(rand_bytes(8))
 
1200
    return '-'.join((name, compact_date(time()), s))