~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin Pool
  • Date: 2005-06-27 01:25:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050627012523-50f6769ce9e125f9
- tweak rsync upload script

Show diffs side-by-side

added added

removed removed

Lines of Context:
26
26
from inventory import InventoryEntry, Inventory
27
27
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
28
28
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
29
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
29
     joinpath, sha_file, sha_string, file_kind, local_time_offset, appendpath
30
30
from store import ImmutableStore
31
31
from revision import Revision
32
 
from errors import bailout, BzrError
 
32
from errors import BzrError
33
33
from textui import show_status
34
34
 
35
35
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
43
43
        return remotebranch.RemoteBranch(f, **args)
44
44
    else:
45
45
        return Branch(f, **args)
 
46
 
 
47
 
 
48
 
 
49
def _relpath(base, path):
 
50
    """Return path relative to base, or raise exception.
 
51
 
 
52
    The path may be either an absolute path or a path relative to the
 
53
    current working directory.
 
54
 
 
55
    Lifted out of Branch.relpath for ease of testing.
 
56
 
 
57
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
58
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
59
    avoids that problem."""
 
60
    rp = os.path.abspath(path)
 
61
 
 
62
    s = []
 
63
    head = rp
 
64
    while len(head) >= len(base):
 
65
        if head == base:
 
66
            break
 
67
        head, tail = os.path.split(head)
 
68
        if tail:
 
69
            s.insert(0, tail)
 
70
    else:
 
71
        from errors import NotBranchError
 
72
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
73
 
 
74
    return os.sep.join(s)
46
75
        
47
76
 
48
77
def find_branch_root(f=None):
75
104
            raise BzrError('%r is not in a branch' % orig_f)
76
105
        f = head
77
106
    
 
107
class DivergedBranches(Exception):
 
108
    def __init__(self, branch1, branch2):
 
109
        self.branch1 = branch1
 
110
        self.branch2 = branch2
 
111
        Exception.__init__(self, "These branches have diverged.")
 
112
 
 
113
 
 
114
class NoSuchRevision(BzrError):
 
115
    def __init__(self, branch, revision):
 
116
        self.branch = branch
 
117
        self.revision = revision
 
118
        msg = "Branch %s has no revision %d" % (branch, revision)
 
119
        BzrError.__init__(self, msg)
78
120
 
79
121
 
80
122
######################################################################
85
127
 
86
128
    base
87
129
        Base directory of the branch.
 
130
 
 
131
    _lock_mode
 
132
        None, or 'r' or 'w'
 
133
 
 
134
    _lock_count
 
135
        If _lock_mode is true, a positive count of the number of times the
 
136
        lock has been taken.
 
137
 
 
138
    _lock
 
139
        Lock object from bzrlib.lock.
88
140
    """
89
 
    _lockmode = None
 
141
    base = None
 
142
    _lock_mode = None
 
143
    _lock_count = None
 
144
    _lock = None
90
145
    
91
 
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
146
    def __init__(self, base, init=False, find_root=True):
92
147
        """Create new branch object at a particular location.
93
148
 
94
149
        base -- Base directory for the branch.
111
166
        else:
112
167
            self.base = os.path.realpath(base)
113
168
            if not isdir(self.controlfilename('.')):
114
 
                bailout("not a bzr branch: %s" % quotefn(base),
115
 
                        ['use "bzr init" to initialize a new working tree',
116
 
                         'current bzr can only operate from top-of-tree'])
 
169
                from errors import NotBranchError
 
170
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
 
171
                                     ['use "bzr init" to initialize a new working tree',
 
172
                                      'current bzr can only operate from top-of-tree'])
117
173
        self._check_format()
118
 
        self.lock(lock_mode)
119
174
 
120
175
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
121
176
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
129
184
    __repr__ = __str__
130
185
 
131
186
 
132
 
 
133
 
    def lock(self, mode='w'):
134
 
        """Lock the on-disk branch, excluding other processes."""
135
 
        try:
136
 
            import fcntl, errno
137
 
 
138
 
            if mode == 'w':
139
 
                lm = fcntl.LOCK_EX
140
 
                om = os.O_WRONLY | os.O_CREAT
141
 
            elif mode == 'r':
142
 
                lm = fcntl.LOCK_SH
143
 
                om = os.O_RDONLY
144
 
            else:
145
 
                raise BzrError("invalid locking mode %r" % mode)
146
 
 
147
 
            try:
148
 
                lockfile = os.open(self.controlfilename('branch-lock'), om)
149
 
            except OSError, e:
150
 
                if e.errno == errno.ENOENT:
151
 
                    # might not exist on branches from <0.0.4
152
 
                    self.controlfile('branch-lock', 'w').close()
153
 
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
154
 
                else:
155
 
                    raise e
 
187
    def __del__(self):
 
188
        if self._lock_mode or self._lock:
 
189
            from warnings import warn
 
190
            warn("branch %r was not explicitly unlocked" % self)
 
191
            self._lock.unlock()
 
192
 
 
193
 
 
194
 
 
195
    def lock_write(self):
 
196
        if self._lock_mode:
 
197
            if self._lock_mode != 'w':
 
198
                from errors import LockError
 
199
                raise LockError("can't upgrade to a write lock from %r" %
 
200
                                self._lock_mode)
 
201
            self._lock_count += 1
 
202
        else:
 
203
            from bzrlib.lock import WriteLock
 
204
 
 
205
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
206
            self._lock_mode = 'w'
 
207
            self._lock_count = 1
 
208
 
 
209
 
 
210
 
 
211
    def lock_read(self):
 
212
        if self._lock_mode:
 
213
            assert self._lock_mode in ('r', 'w'), \
 
214
                   "invalid lock mode %r" % self._lock_mode
 
215
            self._lock_count += 1
 
216
        else:
 
217
            from bzrlib.lock import ReadLock
 
218
 
 
219
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
220
            self._lock_mode = 'r'
 
221
            self._lock_count = 1
 
222
                        
 
223
 
156
224
            
157
 
            fcntl.lockf(lockfile, lm)
158
 
            def unlock():
159
 
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
160
 
                os.close(lockfile)
161
 
                self._lockmode = None
162
 
            self.unlock = unlock
163
 
            self._lockmode = mode
164
 
        except ImportError:
165
 
            warning("please write a locking method for platform %r" % sys.platform)
166
 
            def unlock():
167
 
                self._lockmode = None
168
 
            self.unlock = unlock
169
 
            self._lockmode = mode
170
 
 
171
 
 
172
 
    def _need_readlock(self):
173
 
        if self._lockmode not in ['r', 'w']:
174
 
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
175
 
 
176
 
    def _need_writelock(self):
177
 
        if self._lockmode not in ['w']:
178
 
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
 
225
    def unlock(self):
 
226
        if not self._lock_mode:
 
227
            from errors import LockError
 
228
            raise LockError('branch %r is not locked' % (self))
 
229
 
 
230
        if self._lock_count > 1:
 
231
            self._lock_count -= 1
 
232
        else:
 
233
            self._lock.unlock()
 
234
            self._lock = None
 
235
            self._lock_mode = self._lock_count = None
179
236
 
180
237
 
181
238
    def abspath(self, name):
187
244
        """Return path relative to this branch of something inside it.
188
245
 
189
246
        Raises an error if path is not in this branch."""
190
 
        rp = os.path.realpath(path)
191
 
        # FIXME: windows
192
 
        if not rp.startswith(self.base):
193
 
            bailout("path %r is not within branch %r" % (rp, self.base))
194
 
        rp = rp[len(self.base):]
195
 
        rp = rp.lstrip(os.sep)
196
 
        return rp
 
247
        return _relpath(self.base, path)
197
248
 
198
249
 
199
250
    def controlfilename(self, file_or_path):
234
285
        os.mkdir(self.controlfilename([]))
235
286
        self.controlfile('README', 'w').write(
236
287
            "This is a Bazaar-NG control directory.\n"
237
 
            "Do not change any files in this directory.")
 
288
            "Do not change any files in this directory.\n")
238
289
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
239
290
        for d in ('text-store', 'inventory-store', 'revision-store'):
240
291
            os.mkdir(self.controlfilename(d))
260
311
        fmt = self.controlfile('branch-format', 'r').read()
261
312
        fmt.replace('\r\n', '')
262
313
        if fmt != BZR_BRANCH_FORMAT:
263
 
            bailout('sorry, branch format %r not supported' % fmt,
264
 
                    ['use a different bzr version',
265
 
                     'or remove the .bzr directory and "bzr init" again'])
 
314
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
315
                           ['use a different bzr version',
 
316
                            'or remove the .bzr directory and "bzr init" again'])
 
317
 
266
318
 
267
319
 
268
320
    def read_working_inventory(self):
269
321
        """Read the working inventory."""
270
 
        self._need_readlock()
271
322
        before = time.time()
272
323
        # ElementTree does its own conversion from UTF-8, so open in
273
324
        # binary.
274
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
275
 
        mutter("loaded inventory of %d items in %f"
276
 
               % (len(inv), time.time() - before))
277
 
        return inv
278
 
 
 
325
        self.lock_read()
 
326
        try:
 
327
            inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
328
            mutter("loaded inventory of %d items in %f"
 
329
                   % (len(inv), time.time() - before))
 
330
            return inv
 
331
        finally:
 
332
            self.unlock()
 
333
            
279
334
 
280
335
    def _write_inventory(self, inv):
281
336
        """Update the working inventory.
283
338
        That is to say, the inventory describing changes underway, that
284
339
        will be committed to the next revision.
285
340
        """
286
 
        self._need_writelock()
287
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
288
 
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
289
 
        tmpfname = self.controlfilename('inventory.tmp')
290
 
        tmpf = file(tmpfname, 'wb')
291
 
        inv.write_xml(tmpf)
292
 
        tmpf.close()
293
 
        inv_fname = self.controlfilename('inventory')
294
 
        if sys.platform == 'win32':
295
 
            os.remove(inv_fname)
296
 
        os.rename(tmpfname, inv_fname)
 
341
        self.lock_write()
 
342
        try:
 
343
            from bzrlib.atomicfile import AtomicFile
 
344
 
 
345
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
 
346
            try:
 
347
                inv.write_xml(f)
 
348
                f.commit()
 
349
            finally:
 
350
                f.close()
 
351
        finally:
 
352
            self.unlock()
 
353
        
297
354
        mutter('wrote working inventory')
298
 
 
 
355
            
299
356
 
300
357
    inventory = property(read_working_inventory, _write_inventory, None,
301
358
                         """Inventory for the working copy.""")
309
366
        This puts the files in the Added state, so that they will be
310
367
        recorded by the next commit.
311
368
 
 
369
        files
 
370
            List of paths to add, relative to the base of the tree.
 
371
 
 
372
        ids
 
373
            If set, use these instead of automatically generated ids.
 
374
            Must be the same length as the list of files, but may
 
375
            contain None for ids that are to be autogenerated.
 
376
 
312
377
        TODO: Perhaps have an option to add the ids even if the files do
313
 
               not (yet) exist.
 
378
              not (yet) exist.
314
379
 
315
380
        TODO: Perhaps return the ids of the files?  But then again it
316
 
               is easy to retrieve them if they're needed.
317
 
 
318
 
        TODO: Option to specify file id.
 
381
              is easy to retrieve them if they're needed.
319
382
 
320
383
        TODO: Adding a directory should optionally recurse down and
321
 
               add all non-ignored children.  Perhaps do that in a
322
 
               higher-level method.
 
384
              add all non-ignored children.  Perhaps do that in a
 
385
              higher-level method.
323
386
        """
324
 
        self._need_writelock()
325
 
 
326
387
        # TODO: Re-adding a file that is removed in the working copy
327
388
        # should probably put it back with the previous ID.
328
389
        if isinstance(files, types.StringTypes):
335
396
            ids = [None] * len(files)
336
397
        else:
337
398
            assert(len(ids) == len(files))
338
 
        
339
 
        inv = self.read_working_inventory()
340
 
        for f,file_id in zip(files, ids):
341
 
            if is_control_file(f):
342
 
                bailout("cannot add control file %s" % quotefn(f))
343
 
 
344
 
            fp = splitpath(f)
345
 
 
346
 
            if len(fp) == 0:
347
 
                bailout("cannot add top-level %r" % f)
348
 
                
349
 
            fullpath = os.path.normpath(self.abspath(f))
350
 
 
351
 
            try:
352
 
                kind = file_kind(fullpath)
353
 
            except OSError:
354
 
                # maybe something better?
355
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
356
 
            
357
 
            if kind != 'file' and kind != 'directory':
358
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
359
 
 
360
 
            if file_id is None:
361
 
                file_id = gen_file_id(f)
362
 
            inv.add_path(f, kind=kind, file_id=file_id)
363
 
 
364
 
            if verbose:
365
 
                show_status('A', kind, quotefn(f))
366
 
                
367
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
368
 
            
369
 
        self._write_inventory(inv)
370
 
 
 
399
 
 
400
        self.lock_write()
 
401
        try:
 
402
            inv = self.read_working_inventory()
 
403
            for f,file_id in zip(files, ids):
 
404
                if is_control_file(f):
 
405
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
406
 
 
407
                fp = splitpath(f)
 
408
 
 
409
                if len(fp) == 0:
 
410
                    raise BzrError("cannot add top-level %r" % f)
 
411
 
 
412
                fullpath = os.path.normpath(self.abspath(f))
 
413
 
 
414
                try:
 
415
                    kind = file_kind(fullpath)
 
416
                except OSError:
 
417
                    # maybe something better?
 
418
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
419
 
 
420
                if kind != 'file' and kind != 'directory':
 
421
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
422
 
 
423
                if file_id is None:
 
424
                    file_id = gen_file_id(f)
 
425
                inv.add_path(f, kind=kind, file_id=file_id)
 
426
 
 
427
                if verbose:
 
428
                    print 'added', quotefn(f)
 
429
 
 
430
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
431
 
 
432
            self._write_inventory(inv)
 
433
        finally:
 
434
            self.unlock()
 
435
            
371
436
 
372
437
    def print_file(self, file, revno):
373
438
        """Print `file` to stdout."""
374
 
        self._need_readlock()
375
 
        tree = self.revision_tree(self.lookup_revision(revno))
376
 
        # use inventory as it was in that revision
377
 
        file_id = tree.inventory.path2id(file)
378
 
        if not file_id:
379
 
            bailout("%r is not present in revision %d" % (file, revno))
380
 
        tree.print_file(file_id)
381
 
        
 
439
        self.lock_read()
 
440
        try:
 
441
            tree = self.revision_tree(self.lookup_revision(revno))
 
442
            # use inventory as it was in that revision
 
443
            file_id = tree.inventory.path2id(file)
 
444
            if not file_id:
 
445
                raise BzrError("%r is not present in revision %d" % (file, revno))
 
446
            tree.print_file(file_id)
 
447
        finally:
 
448
            self.unlock()
 
449
 
382
450
 
383
451
    def remove(self, files, verbose=False):
384
452
        """Mark nominated files for removal from the inventory.
396
464
        """
397
465
        ## TODO: Normalize names
398
466
        ## TODO: Remove nested loops; better scalability
399
 
        self._need_writelock()
400
 
 
401
467
        if isinstance(files, types.StringTypes):
402
468
            files = [files]
403
 
        
404
 
        tree = self.working_tree()
405
 
        inv = tree.inventory
406
 
 
407
 
        # do this before any modifications
408
 
        for f in files:
409
 
            fid = inv.path2id(f)
410
 
            if not fid:
411
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
412
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
413
 
            if verbose:
414
 
                # having remove it, it must be either ignored or unknown
415
 
                if tree.is_ignored(f):
416
 
                    new_status = 'I'
417
 
                else:
418
 
                    new_status = '?'
419
 
                show_status(new_status, inv[fid].kind, quotefn(f))
420
 
            del inv[fid]
421
 
 
422
 
        self._write_inventory(inv)
423
 
 
 
469
 
 
470
        self.lock_write()
 
471
 
 
472
        try:
 
473
            tree = self.working_tree()
 
474
            inv = tree.inventory
 
475
 
 
476
            # do this before any modifications
 
477
            for f in files:
 
478
                fid = inv.path2id(f)
 
479
                if not fid:
 
480
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
481
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
482
                if verbose:
 
483
                    # having remove it, it must be either ignored or unknown
 
484
                    if tree.is_ignored(f):
 
485
                        new_status = 'I'
 
486
                    else:
 
487
                        new_status = '?'
 
488
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
489
                del inv[fid]
 
490
 
 
491
            self._write_inventory(inv)
 
492
        finally:
 
493
            self.unlock()
 
494
 
 
495
 
 
496
    # FIXME: this doesn't need to be a branch method
424
497
    def set_inventory(self, new_inventory_list):
425
498
        inv = Inventory()
426
499
        for path, file_id, parent, kind in new_inventory_list:
451
524
 
452
525
 
453
526
    def append_revision(self, revision_id):
 
527
        from bzrlib.atomicfile import AtomicFile
 
528
 
454
529
        mutter("add {%s} to revision-history" % revision_id)
455
 
        rev_history = self.revision_history()
456
 
 
457
 
        tmprhname = self.controlfilename('revision-history.tmp')
458
 
        rhname = self.controlfilename('revision-history')
459
 
        
460
 
        f = file(tmprhname, 'wt')
461
 
        rev_history.append(revision_id)
462
 
        f.write('\n'.join(rev_history))
463
 
        f.write('\n')
464
 
        f.close()
465
 
 
466
 
        if sys.platform == 'win32':
467
 
            os.remove(rhname)
468
 
        os.rename(tmprhname, rhname)
469
 
        
 
530
        rev_history = self.revision_history() + [revision_id]
 
531
 
 
532
        f = AtomicFile(self.controlfilename('revision-history'))
 
533
        try:
 
534
            for rev_id in rev_history:
 
535
                print >>f, rev_id
 
536
            f.commit()
 
537
        finally:
 
538
            f.close()
470
539
 
471
540
 
472
541
    def get_revision(self, revision_id):
473
542
        """Return the Revision object for a named revision"""
474
 
        self._need_readlock()
 
543
        if not revision_id or not isinstance(revision_id, basestring):
 
544
            raise ValueError('invalid revision-id: %r' % revision_id)
475
545
        r = Revision.read_xml(self.revision_store[revision_id])
476
546
        assert r.revision_id == revision_id
477
547
        return r
478
548
 
 
549
    def get_revision_sha1(self, revision_id):
 
550
        """Hash the stored value of a revision, and return it."""
 
551
        # In the future, revision entries will be signed. At that
 
552
        # point, it is probably best *not* to include the signature
 
553
        # in the revision hash. Because that lets you re-sign
 
554
        # the revision, (add signatures/remove signatures) and still
 
555
        # have all hash pointers stay consistent.
 
556
        # But for now, just hash the contents.
 
557
        return sha_file(self.revision_store[revision_id])
 
558
 
479
559
 
480
560
    def get_inventory(self, inventory_id):
481
561
        """Get Inventory object by hash.
483
563
        TODO: Perhaps for this and similar methods, take a revision
484
564
               parameter which can be either an integer revno or a
485
565
               string hash."""
486
 
        self._need_readlock()
487
566
        i = Inventory.read_xml(self.inventory_store[inventory_id])
488
567
        return i
489
568
 
 
569
    def get_inventory_sha1(self, inventory_id):
 
570
        """Return the sha1 hash of the inventory entry
 
571
        """
 
572
        return sha_file(self.inventory_store[inventory_id])
 
573
 
490
574
 
491
575
    def get_revision_inventory(self, revision_id):
492
576
        """Return inventory of a past revision."""
493
 
        self._need_readlock()
494
577
        if revision_id == None:
495
578
            return Inventory()
496
579
        else:
503
586
        >>> ScratchBranch().revision_history()
504
587
        []
505
588
        """
506
 
        self._need_readlock()
507
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
508
 
 
 
589
        self.lock_read()
 
590
        try:
 
591
            return [l.rstrip('\r\n') for l in
 
592
                    self.controlfile('revision-history', 'r').readlines()]
 
593
        finally:
 
594
            self.unlock()
 
595
 
 
596
 
 
597
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
598
        """
 
599
        >>> import commit
 
600
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
601
        >>> sb.common_ancestor(sb) == (None, None)
 
602
        True
 
603
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
604
        >>> sb.common_ancestor(sb)[0]
 
605
        1
 
606
        >>> clone = sb.clone()
 
607
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
608
        >>> sb.common_ancestor(sb)[0]
 
609
        2
 
610
        >>> sb.common_ancestor(clone)[0]
 
611
        1
 
612
        >>> commit.commit(clone, "Committing divergent second revision", 
 
613
        ...               verbose=False)
 
614
        >>> sb.common_ancestor(clone)[0]
 
615
        1
 
616
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
617
        True
 
618
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
619
        True
 
620
        >>> clone2 = sb.clone()
 
621
        >>> sb.common_ancestor(clone2)[0]
 
622
        2
 
623
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
624
        1
 
625
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
626
        1
 
627
        """
 
628
        my_history = self.revision_history()
 
629
        other_history = other.revision_history()
 
630
        if self_revno is None:
 
631
            self_revno = len(my_history)
 
632
        if other_revno is None:
 
633
            other_revno = len(other_history)
 
634
        indices = range(min((self_revno, other_revno)))
 
635
        indices.reverse()
 
636
        for r in indices:
 
637
            if my_history[r] == other_history[r]:
 
638
                return r+1, my_history[r]
 
639
        return None, None
509
640
 
510
641
    def enum_history(self, direction):
511
642
        """Return (revno, revision_id) for history of branch.
548
679
            return None
549
680
 
550
681
 
 
682
    def missing_revisions(self, other, stop_revision=None):
 
683
        """
 
684
        If self and other have not diverged, return a list of the revisions
 
685
        present in other, but missing from self.
 
686
 
 
687
        >>> from bzrlib.commit import commit
 
688
        >>> bzrlib.trace.silent = True
 
689
        >>> br1 = ScratchBranch()
 
690
        >>> br2 = ScratchBranch()
 
691
        >>> br1.missing_revisions(br2)
 
692
        []
 
693
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
694
        >>> br1.missing_revisions(br2)
 
695
        [u'REVISION-ID-1']
 
696
        >>> br2.missing_revisions(br1)
 
697
        []
 
698
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
699
        >>> br1.missing_revisions(br2)
 
700
        []
 
701
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
702
        >>> br1.missing_revisions(br2)
 
703
        [u'REVISION-ID-2A']
 
704
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
705
        >>> br1.missing_revisions(br2)
 
706
        Traceback (most recent call last):
 
707
        DivergedBranches: These branches have diverged.
 
708
        """
 
709
        self_history = self.revision_history()
 
710
        self_len = len(self_history)
 
711
        other_history = other.revision_history()
 
712
        other_len = len(other_history)
 
713
        common_index = min(self_len, other_len) -1
 
714
        if common_index >= 0 and \
 
715
            self_history[common_index] != other_history[common_index]:
 
716
            raise DivergedBranches(self, other)
 
717
 
 
718
        if stop_revision is None:
 
719
            stop_revision = other_len
 
720
        elif stop_revision > other_len:
 
721
            raise NoSuchRevision(self, stop_revision)
 
722
        
 
723
        return other_history[self_len:stop_revision]
 
724
 
 
725
 
 
726
    def update_revisions(self, other, stop_revision=None):
 
727
        """Pull in all new revisions from other branch.
 
728
        
 
729
        >>> from bzrlib.commit import commit
 
730
        >>> bzrlib.trace.silent = True
 
731
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
 
732
        >>> br1.add('foo')
 
733
        >>> br1.add('bar')
 
734
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
 
735
        >>> br2 = ScratchBranch()
 
736
        >>> br2.update_revisions(br1)
 
737
        Added 2 texts.
 
738
        Added 1 inventories.
 
739
        Added 1 revisions.
 
740
        >>> br2.revision_history()
 
741
        [u'REVISION-ID-1']
 
742
        >>> br2.update_revisions(br1)
 
743
        Added 0 texts.
 
744
        Added 0 inventories.
 
745
        Added 0 revisions.
 
746
        >>> br1.text_store.total_size() == br2.text_store.total_size()
 
747
        True
 
748
        """
 
749
        from bzrlib.progress import ProgressBar
 
750
 
 
751
        pb = ProgressBar()
 
752
 
 
753
        pb.update('comparing histories')
 
754
        revision_ids = self.missing_revisions(other, stop_revision)
 
755
        revisions = []
 
756
        needed_texts = sets.Set()
 
757
        i = 0
 
758
        for rev_id in revision_ids:
 
759
            i += 1
 
760
            pb.update('fetching revision', i, len(revision_ids))
 
761
            rev = other.get_revision(rev_id)
 
762
            revisions.append(rev)
 
763
            inv = other.get_inventory(str(rev.inventory_id))
 
764
            for key, entry in inv.iter_entries():
 
765
                if entry.text_id is None:
 
766
                    continue
 
767
                if entry.text_id not in self.text_store:
 
768
                    needed_texts.add(entry.text_id)
 
769
 
 
770
        pb.clear()
 
771
                    
 
772
        count = self.text_store.copy_multi(other.text_store, needed_texts)
 
773
        print "Added %d texts." % count 
 
774
        inventory_ids = [ f.inventory_id for f in revisions ]
 
775
        count = self.inventory_store.copy_multi(other.inventory_store, 
 
776
                                                inventory_ids)
 
777
        print "Added %d inventories." % count 
 
778
        revision_ids = [ f.revision_id for f in revisions]
 
779
        count = self.revision_store.copy_multi(other.revision_store, 
 
780
                                               revision_ids)
 
781
        for revision_id in revision_ids:
 
782
            self.append_revision(revision_id)
 
783
        print "Added %d revisions." % count
 
784
                    
 
785
        
551
786
    def commit(self, *args, **kw):
552
 
        """Deprecated"""
553
787
        from bzrlib.commit import commit
554
788
        commit(self, *args, **kw)
555
789
        
573
807
        an `EmptyTree` is returned."""
574
808
        # TODO: refactor this to use an existing revision object
575
809
        # so we don't need to read it in twice.
576
 
        self._need_readlock()
577
810
        if revision_id == None:
578
811
            return EmptyTree()
579
812
        else:
605
838
 
606
839
        This can change the directory or the filename or both.
607
840
        """
608
 
        self._need_writelock()
609
 
        tree = self.working_tree()
610
 
        inv = tree.inventory
611
 
        if not tree.has_filename(from_rel):
612
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
613
 
        if tree.has_filename(to_rel):
614
 
            bailout("can't rename: new working file %r already exists" % to_rel)
615
 
            
616
 
        file_id = inv.path2id(from_rel)
617
 
        if file_id == None:
618
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
619
 
 
620
 
        if inv.path2id(to_rel):
621
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
622
 
 
623
 
        to_dir, to_tail = os.path.split(to_rel)
624
 
        to_dir_id = inv.path2id(to_dir)
625
 
        if to_dir_id == None and to_dir != '':
626
 
            bailout("can't determine destination directory id for %r" % to_dir)
627
 
 
628
 
        mutter("rename_one:")
629
 
        mutter("  file_id    {%s}" % file_id)
630
 
        mutter("  from_rel   %r" % from_rel)
631
 
        mutter("  to_rel     %r" % to_rel)
632
 
        mutter("  to_dir     %r" % to_dir)
633
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
634
 
            
635
 
        inv.rename(file_id, to_dir_id, to_tail)
636
 
 
637
 
        print "%s => %s" % (from_rel, to_rel)
638
 
        
639
 
        from_abs = self.abspath(from_rel)
640
 
        to_abs = self.abspath(to_rel)
 
841
        self.lock_write()
641
842
        try:
642
 
            os.rename(from_abs, to_abs)
643
 
        except OSError, e:
644
 
            bailout("failed to rename %r to %r: %s"
645
 
                    % (from_abs, to_abs, e[1]),
646
 
                    ["rename rolled back"])
647
 
 
648
 
        self._write_inventory(inv)
649
 
            
 
843
            tree = self.working_tree()
 
844
            inv = tree.inventory
 
845
            if not tree.has_filename(from_rel):
 
846
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
847
            if tree.has_filename(to_rel):
 
848
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
849
 
 
850
            file_id = inv.path2id(from_rel)
 
851
            if file_id == None:
 
852
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
853
 
 
854
            if inv.path2id(to_rel):
 
855
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
856
 
 
857
            to_dir, to_tail = os.path.split(to_rel)
 
858
            to_dir_id = inv.path2id(to_dir)
 
859
            if to_dir_id == None and to_dir != '':
 
860
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
861
 
 
862
            mutter("rename_one:")
 
863
            mutter("  file_id    {%s}" % file_id)
 
864
            mutter("  from_rel   %r" % from_rel)
 
865
            mutter("  to_rel     %r" % to_rel)
 
866
            mutter("  to_dir     %r" % to_dir)
 
867
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
868
 
 
869
            inv.rename(file_id, to_dir_id, to_tail)
 
870
 
 
871
            print "%s => %s" % (from_rel, to_rel)
 
872
 
 
873
            from_abs = self.abspath(from_rel)
 
874
            to_abs = self.abspath(to_rel)
 
875
            try:
 
876
                os.rename(from_abs, to_abs)
 
877
            except OSError, e:
 
878
                raise BzrError("failed to rename %r to %r: %s"
 
879
                        % (from_abs, to_abs, e[1]),
 
880
                        ["rename rolled back"])
 
881
 
 
882
            self._write_inventory(inv)
 
883
        finally:
 
884
            self.unlock()
650
885
 
651
886
 
652
887
    def move(self, from_paths, to_name):
660
895
        Note that to_name is only the last component of the new name;
661
896
        this doesn't change the directory.
662
897
        """
663
 
        self._need_writelock()
664
 
        ## TODO: Option to move IDs only
665
 
        assert not isinstance(from_paths, basestring)
666
 
        tree = self.working_tree()
667
 
        inv = tree.inventory
668
 
        to_abs = self.abspath(to_name)
669
 
        if not isdir(to_abs):
670
 
            bailout("destination %r is not a directory" % to_abs)
671
 
        if not tree.has_filename(to_name):
672
 
            bailout("destination %r not in working directory" % to_abs)
673
 
        to_dir_id = inv.path2id(to_name)
674
 
        if to_dir_id == None and to_name != '':
675
 
            bailout("destination %r is not a versioned directory" % to_name)
676
 
        to_dir_ie = inv[to_dir_id]
677
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
678
 
            bailout("destination %r is not a directory" % to_abs)
679
 
 
680
 
        to_idpath = inv.get_idpath(to_dir_id)
681
 
 
682
 
        for f in from_paths:
683
 
            if not tree.has_filename(f):
684
 
                bailout("%r does not exist in working tree" % f)
685
 
            f_id = inv.path2id(f)
686
 
            if f_id == None:
687
 
                bailout("%r is not versioned" % f)
688
 
            name_tail = splitpath(f)[-1]
689
 
            dest_path = appendpath(to_name, name_tail)
690
 
            if tree.has_filename(dest_path):
691
 
                bailout("destination %r already exists" % dest_path)
692
 
            if f_id in to_idpath:
693
 
                bailout("can't move %r to a subdirectory of itself" % f)
694
 
 
695
 
        # OK, so there's a race here, it's possible that someone will
696
 
        # create a file in this interval and then the rename might be
697
 
        # left half-done.  But we should have caught most problems.
698
 
 
699
 
        for f in from_paths:
700
 
            name_tail = splitpath(f)[-1]
701
 
            dest_path = appendpath(to_name, name_tail)
702
 
            print "%s => %s" % (f, dest_path)
703
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
898
        self.lock_write()
 
899
        try:
 
900
            ## TODO: Option to move IDs only
 
901
            assert not isinstance(from_paths, basestring)
 
902
            tree = self.working_tree()
 
903
            inv = tree.inventory
 
904
            to_abs = self.abspath(to_name)
 
905
            if not isdir(to_abs):
 
906
                raise BzrError("destination %r is not a directory" % to_abs)
 
907
            if not tree.has_filename(to_name):
 
908
                raise BzrError("destination %r not in working directory" % to_abs)
 
909
            to_dir_id = inv.path2id(to_name)
 
910
            if to_dir_id == None and to_name != '':
 
911
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
912
            to_dir_ie = inv[to_dir_id]
 
913
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
914
                raise BzrError("destination %r is not a directory" % to_abs)
 
915
 
 
916
            to_idpath = inv.get_idpath(to_dir_id)
 
917
 
 
918
            for f in from_paths:
 
919
                if not tree.has_filename(f):
 
920
                    raise BzrError("%r does not exist in working tree" % f)
 
921
                f_id = inv.path2id(f)
 
922
                if f_id == None:
 
923
                    raise BzrError("%r is not versioned" % f)
 
924
                name_tail = splitpath(f)[-1]
 
925
                dest_path = appendpath(to_name, name_tail)
 
926
                if tree.has_filename(dest_path):
 
927
                    raise BzrError("destination %r already exists" % dest_path)
 
928
                if f_id in to_idpath:
 
929
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
930
 
 
931
            # OK, so there's a race here, it's possible that someone will
 
932
            # create a file in this interval and then the rename might be
 
933
            # left half-done.  But we should have caught most problems.
 
934
 
 
935
            for f in from_paths:
 
936
                name_tail = splitpath(f)[-1]
 
937
                dest_path = appendpath(to_name, name_tail)
 
938
                print "%s => %s" % (f, dest_path)
 
939
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
940
                try:
 
941
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
942
                except OSError, e:
 
943
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
944
                            ["rename rolled back"])
 
945
 
 
946
            self._write_inventory(inv)
 
947
        finally:
 
948
            self.unlock()
 
949
 
 
950
 
 
951
    def revert(self, filenames, old_tree=None, backups=True):
 
952
        """Restore selected files to the versions from a previous tree.
 
953
 
 
954
        backups
 
955
            If true (default) backups are made of files before
 
956
            they're renamed.
 
957
        """
 
958
        from bzrlib.errors import NotVersionedError, BzrError
 
959
        from bzrlib.atomicfile import AtomicFile
 
960
        from bzrlib.osutils import backup_file
 
961
        
 
962
        inv = self.read_working_inventory()
 
963
        if old_tree is None:
 
964
            old_tree = self.basis_tree()
 
965
        old_inv = old_tree.inventory
 
966
 
 
967
        nids = []
 
968
        for fn in filenames:
 
969
            file_id = inv.path2id(fn)
 
970
            if not file_id:
 
971
                raise NotVersionedError("not a versioned file", fn)
 
972
            if not old_inv.has_id(file_id):
 
973
                raise BzrError("file not present in old tree", fn, file_id)
 
974
            nids.append((fn, file_id))
 
975
            
 
976
        # TODO: Rename back if it was previously at a different location
 
977
 
 
978
        # TODO: If given a directory, restore the entire contents from
 
979
        # the previous version.
 
980
 
 
981
        # TODO: Make a backup to a temporary file.
 
982
 
 
983
        # TODO: If the file previously didn't exist, delete it?
 
984
        for fn, file_id in nids:
 
985
            backup_file(fn)
 
986
            
 
987
            f = AtomicFile(fn, 'wb')
704
988
            try:
705
 
                os.rename(self.abspath(f), self.abspath(dest_path))
706
 
            except OSError, e:
707
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
708
 
                        ["rename rolled back"])
709
 
 
710
 
        self._write_inventory(inv)
711
 
 
 
989
                f.write(old_tree.get_file(file_id).read())
 
990
                f.commit()
 
991
            finally:
 
992
                f.close()
712
993
 
713
994
 
714
995
 
723
1004
    >>> isdir(bd)
724
1005
    False
725
1006
    """
726
 
    def __init__(self, files=[], dirs=[]):
 
1007
    def __init__(self, files=[], dirs=[], base=None):
727
1008
        """Make a test branch.
728
1009
 
729
1010
        This creates a temporary directory and runs init-tree in it.
730
1011
 
731
1012
        If any files are listed, they are created in the working copy.
732
1013
        """
733
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1014
        init = False
 
1015
        if base is None:
 
1016
            base = tempfile.mkdtemp()
 
1017
            init = True
 
1018
        Branch.__init__(self, base, init=init)
734
1019
        for d in dirs:
735
1020
            os.mkdir(self.abspath(d))
736
1021
            
738
1023
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
739
1024
 
740
1025
 
 
1026
    def clone(self):
 
1027
        """
 
1028
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1029
        >>> clone = orig.clone()
 
1030
        >>> os.path.samefile(orig.base, clone.base)
 
1031
        False
 
1032
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1033
        True
 
1034
        """
 
1035
        base = tempfile.mkdtemp()
 
1036
        os.rmdir(base)
 
1037
        shutil.copytree(self.base, base, symlinks=True)
 
1038
        return ScratchBranch(base=base)
 
1039
        
741
1040
    def __del__(self):
742
1041
        self.destroy()
743
1042
 
744
1043
    def destroy(self):
745
1044
        """Destroy the test branch, removing the scratch directory."""
746
1045
        try:
747
 
            mutter("delete ScratchBranch %s" % self.base)
748
 
            shutil.rmtree(self.base)
 
1046
            if self.base:
 
1047
                mutter("delete ScratchBranch %s" % self.base)
 
1048
                shutil.rmtree(self.base)
749
1049
        except OSError, e:
750
1050
            # Work around for shutil.rmtree failing on Windows when
751
1051
            # readonly files are encountered