~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-29 08:01:30 UTC
  • Revision ID: mbp@sourcefrog.net-20050329080130-89b78af279b196b3
match ignore patterns like ./config.h

Show diffs side-by-side

added added

removed removed

Lines of Context:
24
24
import bzrlib
25
25
from inventory import Inventory
26
26
from trace import mutter, note
27
 
from tree import Tree, EmptyTree, RevisionTree
 
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
28
from inventory import InventoryEntry, Inventory
29
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, \
 
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
 
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
31
     joinpath, sha_string, file_kind, local_time_offset
32
32
from store import ImmutableStore
33
33
from revision import Revision
34
 
from errors import bailout, BzrError
 
34
from errors import bailout
35
35
from textui import show_status
 
36
from diff import diff_trees
36
37
 
37
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
38
39
## TODO: Maybe include checks for common corruption of newlines, etc?
39
40
 
40
41
 
41
42
 
42
 
def find_branch(f, **args):
43
 
    if f and (f.startswith('http://') or f.startswith('https://')):
44
 
        import remotebranch 
45
 
        return remotebranch.RemoteBranch(f, **args)
46
 
    else:
47
 
        return Branch(f, **args)
48
 
        
49
 
 
50
43
def find_branch_root(f=None):
51
44
    """Find the branch root enclosing f, or pwd.
52
45
 
53
 
    f may be a filename or a URL.
54
 
 
55
46
    It is not necessary that f exists.
56
47
 
57
48
    Basically we keep looking up until we find the control directory or
58
49
    run into the root."""
59
 
    if f == None:
 
50
    if f is None:
60
51
        f = os.getcwd()
61
52
    elif hasattr(os.path, 'realpath'):
62
53
        f = os.path.realpath(f)
63
54
    else:
64
55
        f = os.path.abspath(f)
65
 
    if not os.path.exists(f):
66
 
        raise BzrError('%r does not exist' % f)
67
 
        
68
56
 
69
57
    orig_f = f
70
58
 
 
59
    last_f = f
71
60
    while True:
72
61
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
73
62
            return f
74
63
        head, tail = os.path.split(f)
75
64
        if head == f:
76
65
            # reached the root, whatever that may be
77
 
            raise BzrError('%r is not in a branch' % orig_f)
 
66
            bailout('%r is not in a branch' % orig_f)
78
67
        f = head
79
68
    
80
69
 
85
74
class Branch:
86
75
    """Branch holding a history of revisions.
87
76
 
88
 
    base
89
 
        Base directory of the branch.
 
77
    :todo: Perhaps use different stores for different classes of object,
 
78
           so that we can keep track of how much space each one uses,
 
79
           or garbage-collect them.
 
80
 
 
81
    :todo: Add a RemoteBranch subclass.  For the basic case of read-only
 
82
           HTTP access this should be very easy by, 
 
83
           just redirecting controlfile access into HTTP requests.
 
84
           We would need a RemoteStore working similarly.
 
85
 
 
86
    :todo: Keep the on-disk branch locked while the object exists.
 
87
 
 
88
    :todo: mkdir() method.
90
89
    """
91
 
    _lockmode = None
92
 
    
93
 
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
90
    def __init__(self, base, init=False, find_root=True):
94
91
        """Create new branch object at a particular location.
95
92
 
96
 
        base -- Base directory for the branch.
 
93
        :param base: Base directory for the branch.
97
94
        
98
 
        init -- If True, create new control files in a previously
 
95
        :param init: If True, create new control files in a previously
99
96
             unversioned directory.  If False, the branch must already
100
97
             be versioned.
101
98
 
102
 
        find_root -- If true and init is false, find the root of the
 
99
        :param find_root: If true and init is false, find the root of the
103
100
             existing branch containing base.
104
101
 
105
102
        In the test suite, creation of new trees is tested using the
117
114
                        ['use "bzr init" to initialize a new working tree',
118
115
                         'current bzr can only operate from top-of-tree'])
119
116
        self._check_format()
120
 
        self.lock(lock_mode)
121
117
 
122
118
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
119
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
131
127
    __repr__ = __str__
132
128
 
133
129
 
134
 
 
135
 
    def lock(self, mode='w'):
136
 
        """Lock the on-disk branch, excluding other processes."""
137
 
        try:
138
 
            import fcntl, errno
139
 
 
140
 
            if mode == 'w':
141
 
                lm = fcntl.LOCK_EX
142
 
                om = os.O_WRONLY | os.O_CREAT
143
 
            elif mode == 'r':
144
 
                lm = fcntl.LOCK_SH
145
 
                om = os.O_RDONLY
146
 
            else:
147
 
                raise BzrError("invalid locking mode %r" % mode)
148
 
 
149
 
            try:
150
 
                lockfile = os.open(self.controlfilename('branch-lock'), om)
151
 
            except OSError, e:
152
 
                if e.errno == errno.ENOENT:
153
 
                    # might not exist on branches from <0.0.4
154
 
                    self.controlfile('branch-lock', 'w').close()
155
 
                    lockfile = os.open(self.controlfilename('branch-lock'), om)
156
 
                else:
157
 
                    raise e
158
 
            
159
 
            fcntl.lockf(lockfile, lm)
160
 
            def unlock():
161
 
                fcntl.lockf(lockfile, fcntl.LOCK_UN)
162
 
                os.close(lockfile)
163
 
                self._lockmode = None
164
 
            self.unlock = unlock
165
 
            self._lockmode = mode
166
 
        except ImportError:
167
 
            warning("please write a locking method for platform %r" % sys.platform)
168
 
            def unlock():
169
 
                self._lockmode = None
170
 
            self.unlock = unlock
171
 
            self._lockmode = mode
172
 
 
173
 
 
174
 
    def _need_readlock(self):
175
 
        if self._lockmode not in ['r', 'w']:
176
 
            raise BzrError('need read lock on branch, only have %r' % self._lockmode)
177
 
 
178
 
    def _need_writelock(self):
179
 
        if self._lockmode not in ['w']:
180
 
            raise BzrError('need write lock on branch, only have %r' % self._lockmode)
181
 
 
182
 
 
183
130
    def abspath(self, name):
184
131
        """Return absolute filename for something in the branch"""
185
132
        return os.path.join(self.base, name)
206
153
 
207
154
 
208
155
    def controlfile(self, file_or_path, mode='r'):
209
 
        """Open a control file for this branch.
210
 
 
211
 
        There are two classes of file in the control directory: text
212
 
        and binary.  binary files are untranslated byte streams.  Text
213
 
        control files are stored with Unix newlines and in UTF-8, even
214
 
        if the platform or locale defaults are different.
215
 
 
216
 
        Controlfiles should almost never be opened in write mode but
217
 
        rather should be atomically copied and replaced using atomicfile.
218
 
        """
219
 
 
220
 
        fn = self.controlfilename(file_or_path)
221
 
 
222
 
        if mode == 'rb' or mode == 'wb':
223
 
            return file(fn, mode)
224
 
        elif mode == 'r' or mode == 'w':
225
 
            # open in binary mode anyhow so there's no newline translation;
226
 
            # codecs uses line buffering by default; don't want that.
227
 
            import codecs
228
 
            return codecs.open(fn, mode + 'b', 'utf-8',
229
 
                               buffering=60000)
230
 
        else:
231
 
            raise BzrError("invalid controlfile mode %r" % mode)
232
 
 
 
156
        """Open a control file for this branch"""
 
157
        return file(self.controlfilename(file_or_path), mode)
233
158
 
234
159
 
235
160
    def _make_control(self):
241
166
        for d in ('text-store', 'inventory-store', 'revision-store'):
242
167
            os.mkdir(self.controlfilename(d))
243
168
        for f in ('revision-history', 'merged-patches',
244
 
                  'pending-merged-patches', 'branch-name',
245
 
                  'branch-lock'):
 
169
                  'pending-merged-patches', 'branch-name'):
246
170
            self.controlfile(f, 'w').write('')
247
171
        mutter('created control directory in ' + self.base)
248
172
        Inventory().write_xml(self.controlfile('inventory','w'))
255
179
 
256
180
        In the future, we might need different in-memory Branch
257
181
        classes to support downlevel branches.  But not yet.
258
 
        """
259
 
        # This ignores newlines so that we can open branches created
260
 
        # on Windows from Linux and so on.  I think it might be better
261
 
        # to always make all internal files in unix format.
262
 
        fmt = self.controlfile('branch-format', 'r').read()
263
 
        fmt.replace('\r\n', '')
 
182
        """        
 
183
        # read in binary mode to detect newline wierdness.
 
184
        fmt = self.controlfile('branch-format', 'rb').read()
264
185
        if fmt != BZR_BRANCH_FORMAT:
265
186
            bailout('sorry, branch format %r not supported' % fmt,
266
187
                    ['use a different bzr version',
269
190
 
270
191
    def read_working_inventory(self):
271
192
        """Read the working inventory."""
272
 
        self._need_readlock()
273
193
        before = time.time()
274
 
        # ElementTree does its own conversion from UTF-8, so open in
275
 
        # binary.
276
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'rb'))
 
194
        inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
277
195
        mutter("loaded inventory of %d items in %f"
278
196
               % (len(inv), time.time() - before))
279
197
        return inv
285
203
        That is to say, the inventory describing changes underway, that
286
204
        will be committed to the next revision.
287
205
        """
288
 
        self._need_writelock()
289
206
        ## TODO: factor out to atomicfile?  is rename safe on windows?
290
207
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
291
208
        tmpfname = self.controlfilename('inventory.tmp')
292
 
        tmpf = file(tmpfname, 'wb')
 
209
        tmpf = file(tmpfname, 'w')
293
210
        inv.write_xml(tmpf)
294
211
        tmpf.close()
295
 
        inv_fname = self.controlfilename('inventory')
296
 
        if sys.platform == 'win32':
297
 
            os.remove(inv_fname)
298
 
        os.rename(tmpfname, inv_fname)
 
212
        os.rename(tmpfname, self.controlfilename('inventory'))
299
213
        mutter('wrote working inventory')
300
214
 
301
215
 
306
220
    def add(self, files, verbose=False):
307
221
        """Make files versioned.
308
222
 
309
 
        Note that the command line normally calls smart_add instead.
310
 
 
311
223
        This puts the files in the Added state, so that they will be
312
224
        recorded by the next commit.
313
225
 
314
 
        TODO: Perhaps have an option to add the ids even if the files do
 
226
        :todo: Perhaps have an option to add the ids even if the files do
315
227
               not (yet) exist.
316
228
 
317
 
        TODO: Perhaps return the ids of the files?  But then again it
 
229
        :todo: Perhaps return the ids of the files?  But then again it
318
230
               is easy to retrieve them if they're needed.
319
231
 
320
 
        TODO: Option to specify file id.
 
232
        :todo: Option to specify file id.
321
233
 
322
 
        TODO: Adding a directory should optionally recurse down and
 
234
        :todo: Adding a directory should optionally recurse down and
323
235
               add all non-ignored children.  Perhaps do that in a
324
236
               higher-level method.
 
237
 
 
238
        >>> b = ScratchBranch(files=['foo'])
 
239
        >>> 'foo' in b.unknowns()
 
240
        True
 
241
        >>> b.show_status()
 
242
        ?       foo
 
243
        >>> b.add('foo')
 
244
        >>> 'foo' in b.unknowns()
 
245
        False
 
246
        >>> bool(b.inventory.path2id('foo'))
 
247
        True
 
248
        >>> b.show_status()
 
249
        A       foo
 
250
 
 
251
        >>> b.add('foo')
 
252
        Traceback (most recent call last):
 
253
        ...
 
254
        BzrError: ('foo is already versioned', [])
 
255
 
 
256
        >>> b.add(['nothere'])
 
257
        Traceback (most recent call last):
 
258
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
325
259
        """
326
 
        self._need_writelock()
327
260
 
328
261
        # TODO: Re-adding a file that is removed in the working copy
329
262
        # should probably put it back with the previous ID.
362
295
        self._write_inventory(inv)
363
296
 
364
297
 
365
 
    def print_file(self, file, revno):
366
 
        """Print `file` to stdout."""
367
 
        self._need_readlock()
368
 
        tree = self.revision_tree(self.lookup_revision(revno))
369
 
        # use inventory as it was in that revision
370
 
        file_id = tree.inventory.path2id(file)
371
 
        if not file_id:
372
 
            bailout("%r is not present in revision %d" % (file, revno))
373
 
        tree.print_file(file_id)
374
 
        
375
298
 
376
299
    def remove(self, files, verbose=False):
377
300
        """Mark nominated files for removal from the inventory.
378
301
 
379
302
        This does not remove their text.  This does not run on 
380
303
 
381
 
        TODO: Refuse to remove modified files unless --force is given?
382
 
 
383
 
        TODO: Do something useful with directories.
384
 
 
385
 
        TODO: Should this remove the text or not?  Tough call; not
 
304
        :todo: Refuse to remove modified files unless --force is given?
 
305
 
 
306
        >>> b = ScratchBranch(files=['foo'])
 
307
        >>> b.add('foo')
 
308
        >>> b.inventory.has_filename('foo')
 
309
        True
 
310
        >>> b.remove('foo')
 
311
        >>> b.working_tree().has_filename('foo')
 
312
        True
 
313
        >>> b.inventory.has_filename('foo')
 
314
        False
 
315
        
 
316
        >>> b = ScratchBranch(files=['foo'])
 
317
        >>> b.add('foo')
 
318
        >>> b.commit('one')
 
319
        >>> b.remove('foo')
 
320
        >>> b.commit('two')
 
321
        >>> b.inventory.has_filename('foo') 
 
322
        False
 
323
        >>> b.basis_tree().has_filename('foo') 
 
324
        False
 
325
        >>> b.working_tree().has_filename('foo') 
 
326
        True
 
327
 
 
328
        :todo: Do something useful with directories.
 
329
 
 
330
        :todo: Should this remove the text or not?  Tough call; not
386
331
        removing may be useful and the user can just use use rm, and
387
332
        is the opposite of add.  Removing it is consistent with most
388
333
        other tools.  Maybe an option.
389
334
        """
390
335
        ## TODO: Normalize names
391
336
        ## TODO: Remove nested loops; better scalability
392
 
        self._need_writelock()
393
337
 
394
338
        if isinstance(files, types.StringTypes):
395
339
            files = [files]
434
378
        return self.working_tree().unknowns()
435
379
 
436
380
 
437
 
    def append_revision(self, revision_id):
438
 
        mutter("add {%s} to revision-history" % revision_id)
439
 
        rev_history = self.revision_history()
440
 
 
441
 
        tmprhname = self.controlfilename('revision-history.tmp')
442
 
        rhname = self.controlfilename('revision-history')
443
 
        
444
 
        f = file(tmprhname, 'wt')
445
 
        rev_history.append(revision_id)
446
 
        f.write('\n'.join(rev_history))
447
 
        f.write('\n')
 
381
    def commit(self, message, timestamp=None, timezone=None,
 
382
               committer=None,
 
383
               verbose=False):
 
384
        """Commit working copy as a new revision.
 
385
        
 
386
        The basic approach is to add all the file texts into the
 
387
        store, then the inventory, then make a new revision pointing
 
388
        to that inventory and store that.
 
389
        
 
390
        This is not quite safe if the working copy changes during the
 
391
        commit; for the moment that is simply not allowed.  A better
 
392
        approach is to make a temporary copy of the files before
 
393
        computing their hashes, and then add those hashes in turn to
 
394
        the inventory.  This should mean at least that there are no
 
395
        broken hash pointers.  There is no way we can get a snapshot
 
396
        of the whole directory at an instant.  This would also have to
 
397
        be robust against files disappearing, moving, etc.  So the
 
398
        whole thing is a bit hard.
 
399
 
 
400
        :param timestamp: if not None, seconds-since-epoch for a
 
401
             postdated/predated commit.
 
402
        """
 
403
 
 
404
        ## TODO: Show branch names
 
405
 
 
406
        # TODO: Don't commit if there are no changes, unless forced?
 
407
 
 
408
        # First walk over the working inventory; and both update that
 
409
        # and also build a new revision inventory.  The revision
 
410
        # inventory needs to hold the text-id, sha1 and size of the
 
411
        # actual file versions committed in the revision.  (These are
 
412
        # not present in the working inventory.)  We also need to
 
413
        # detect missing/deleted files, and remove them from the
 
414
        # working inventory.
 
415
 
 
416
        work_inv = self.read_working_inventory()
 
417
        inv = Inventory()
 
418
        basis = self.basis_tree()
 
419
        basis_inv = basis.inventory
 
420
        missing_ids = []
 
421
        for path, entry in work_inv.iter_entries():
 
422
            ## TODO: Cope with files that have gone missing.
 
423
 
 
424
            ## TODO: Check that the file kind has not changed from the previous
 
425
            ## revision of this file (if any).
 
426
 
 
427
            entry = entry.copy()
 
428
 
 
429
            p = self.abspath(path)
 
430
            file_id = entry.file_id
 
431
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
432
 
 
433
            if not os.path.exists(p):
 
434
                mutter("    file is missing, removing from inventory")
 
435
                if verbose:
 
436
                    show_status('D', entry.kind, quotefn(path))
 
437
                missing_ids.append(file_id)
 
438
                continue
 
439
 
 
440
            # TODO: Handle files that have been deleted
 
441
 
 
442
            # TODO: Maybe a special case for empty files?  Seems a
 
443
            # waste to store them many times.
 
444
 
 
445
            inv.add(entry)
 
446
 
 
447
            if basis_inv.has_id(file_id):
 
448
                old_kind = basis_inv[file_id].kind
 
449
                if old_kind != entry.kind:
 
450
                    bailout("entry %r changed kind from %r to %r"
 
451
                            % (file_id, old_kind, entry.kind))
 
452
 
 
453
            if entry.kind == 'directory':
 
454
                if not isdir(p):
 
455
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
456
            elif entry.kind == 'file':
 
457
                if not isfile(p):
 
458
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
459
 
 
460
                content = file(p, 'rb').read()
 
461
 
 
462
                entry.text_sha1 = sha_string(content)
 
463
                entry.text_size = len(content)
 
464
 
 
465
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
466
                if (old_ie
 
467
                    and (old_ie.text_size == entry.text_size)
 
468
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
469
                    ## assert content == basis.get_file(file_id).read()
 
470
                    entry.text_id = basis_inv[file_id].text_id
 
471
                    mutter('    unchanged from previous text_id {%s}' %
 
472
                           entry.text_id)
 
473
                    
 
474
                else:
 
475
                    entry.text_id = gen_file_id(entry.name)
 
476
                    self.text_store.add(content, entry.text_id)
 
477
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
478
                    if verbose:
 
479
                        if not old_ie:
 
480
                            state = 'A'
 
481
                        elif (old_ie.name == entry.name
 
482
                              and old_ie.parent_id == entry.parent_id):
 
483
                            state = 'M'
 
484
                        else:
 
485
                            state = 'R'
 
486
 
 
487
                        show_status(state, entry.kind, quotefn(path))
 
488
 
 
489
        for file_id in missing_ids:
 
490
            # have to do this later so we don't mess up the iterator.
 
491
            # since parents may be removed before their children we
 
492
            # have to test.
 
493
 
 
494
            # FIXME: There's probably a better way to do this; perhaps
 
495
            # the workingtree should know how to filter itself.
 
496
            if work_inv.has_id(file_id):
 
497
                del work_inv[file_id]
 
498
 
 
499
 
 
500
        inv_id = rev_id = _gen_revision_id(time.time())
 
501
        
 
502
        inv_tmp = tempfile.TemporaryFile()
 
503
        inv.write_xml(inv_tmp)
 
504
        inv_tmp.seek(0)
 
505
        self.inventory_store.add(inv_tmp, inv_id)
 
506
        mutter('new inventory_id is {%s}' % inv_id)
 
507
 
 
508
        self._write_inventory(work_inv)
 
509
 
 
510
        if timestamp == None:
 
511
            timestamp = time.time()
 
512
 
 
513
        if committer == None:
 
514
            committer = username()
 
515
 
 
516
        if timezone == None:
 
517
            timezone = local_time_offset()
 
518
 
 
519
        mutter("building commit log message")
 
520
        rev = Revision(timestamp=timestamp,
 
521
                       timezone=timezone,
 
522
                       committer=committer,
 
523
                       precursor = self.last_patch(),
 
524
                       message = message,
 
525
                       inventory_id=inv_id,
 
526
                       revision_id=rev_id)
 
527
 
 
528
        rev_tmp = tempfile.TemporaryFile()
 
529
        rev.write_xml(rev_tmp)
 
530
        rev_tmp.seek(0)
 
531
        self.revision_store.add(rev_tmp, rev_id)
 
532
        mutter("new revision_id is {%s}" % rev_id)
 
533
        
 
534
        ## XXX: Everything up to here can simply be orphaned if we abort
 
535
        ## the commit; it will leave junk files behind but that doesn't
 
536
        ## matter.
 
537
 
 
538
        ## TODO: Read back the just-generated changeset, and make sure it
 
539
        ## applies and recreates the right state.
 
540
 
 
541
        ## TODO: Also calculate and store the inventory SHA1
 
542
        mutter("committing patch r%d" % (self.revno() + 1))
 
543
 
 
544
        mutter("append to revision-history")
 
545
        f = self.controlfile('revision-history', 'at')
 
546
        f.write(rev_id + '\n')
448
547
        f.close()
449
548
 
450
 
        if sys.platform == 'win32':
451
 
            os.remove(rhname)
452
 
        os.rename(tmprhname, rhname)
453
 
        
 
549
        if verbose:
 
550
            note("commited r%d" % self.revno())
454
551
 
455
552
 
456
553
    def get_revision(self, revision_id):
457
554
        """Return the Revision object for a named revision"""
458
 
        self._need_readlock()
459
555
        r = Revision.read_xml(self.revision_store[revision_id])
460
556
        assert r.revision_id == revision_id
461
557
        return r
464
560
    def get_inventory(self, inventory_id):
465
561
        """Get Inventory object by hash.
466
562
 
467
 
        TODO: Perhaps for this and similar methods, take a revision
 
563
        :todo: Perhaps for this and similar methods, take a revision
468
564
               parameter which can be either an integer revno or a
469
565
               string hash."""
470
 
        self._need_readlock()
471
566
        i = Inventory.read_xml(self.inventory_store[inventory_id])
472
567
        return i
473
568
 
474
569
 
475
570
    def get_revision_inventory(self, revision_id):
476
571
        """Return inventory of a past revision."""
477
 
        self._need_readlock()
478
572
        if revision_id == None:
479
573
            return Inventory()
480
574
        else:
487
581
        >>> ScratchBranch().revision_history()
488
582
        []
489
583
        """
490
 
        self._need_readlock()
491
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
492
 
 
493
 
 
494
 
    def enum_history(self, direction):
495
 
        """Return (revno, revision_id) for history of branch.
496
 
 
497
 
        direction
498
 
            'forward' is from earliest to latest
499
 
            'reverse' is from latest to earliest
500
 
        """
501
 
        rh = self.revision_history()
502
 
        if direction == 'forward':
503
 
            i = 1
504
 
            for rid in rh:
505
 
                yield i, rid
506
 
                i += 1
507
 
        elif direction == 'reverse':
508
 
            i = len(rh)
509
 
            while i > 0:
510
 
                yield i, rh[i-1]
511
 
                i -= 1
512
 
        else:
513
 
            raise BzrError('invalid history direction %r' % direction)
 
584
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
514
585
 
515
586
 
516
587
    def revno(self):
518
589
 
519
590
        That is equivalent to the number of revisions committed to
520
591
        this branch.
 
592
 
 
593
        >>> b = ScratchBranch()
 
594
        >>> b.revno()
 
595
        0
 
596
        >>> b.commit('no foo')
 
597
        >>> b.revno()
 
598
        1
521
599
        """
522
600
        return len(self.revision_history())
523
601
 
524
602
 
525
603
    def last_patch(self):
526
604
        """Return last patch hash, or None if no history.
 
605
 
 
606
        >>> ScratchBranch().last_patch() == None
 
607
        True
527
608
        """
528
609
        ph = self.revision_history()
529
610
        if ph:
530
611
            return ph[-1]
531
 
        else:
532
 
            return None
533
 
 
534
 
 
535
 
    def commit(self, *args, **kw):
536
 
        """Deprecated"""
537
 
        from bzrlib.commit import commit
538
 
        commit(self, *args, **kw)
539
 
        
 
612
 
540
613
 
541
614
    def lookup_revision(self, revno):
542
615
        """Return revision hash for revision number."""
547
620
            # list is 0-based; revisions are 1-based
548
621
            return self.revision_history()[revno-1]
549
622
        except IndexError:
550
 
            raise BzrError("no such revision %s" % revno)
 
623
            bailout("no such revision %s" % revno)
551
624
 
552
625
 
553
626
    def revision_tree(self, revision_id):
555
628
 
556
629
        `revision_id` may be None for the null revision, in which case
557
630
        an `EmptyTree` is returned."""
558
 
        self._need_readlock()
 
631
 
559
632
        if revision_id == None:
560
633
            return EmptyTree()
561
634
        else:
565
638
 
566
639
    def working_tree(self):
567
640
        """Return a `Tree` for the working copy."""
568
 
        from workingtree import WorkingTree
569
641
        return WorkingTree(self.base, self.read_working_inventory())
570
642
 
571
643
 
573
645
        """Return `Tree` object for last revision.
574
646
 
575
647
        If there are no revisions yet, return an `EmptyTree`.
 
648
 
 
649
        >>> b = ScratchBranch(files=['foo'])
 
650
        >>> b.basis_tree().has_filename('foo')
 
651
        False
 
652
        >>> b.working_tree().has_filename('foo')
 
653
        True
 
654
        >>> b.add('foo')
 
655
        >>> b.commit('add foo')
 
656
        >>> b.basis_tree().has_filename('foo')
 
657
        True
576
658
        """
577
659
        r = self.last_patch()
578
660
        if r == None:
582
664
 
583
665
 
584
666
 
585
 
    def rename_one(self, from_rel, to_rel):
586
 
        """Rename one file.
587
 
 
588
 
        This can change the directory or the filename or both.
589
 
        """
590
 
        self._need_writelock()
591
 
        tree = self.working_tree()
592
 
        inv = tree.inventory
593
 
        if not tree.has_filename(from_rel):
594
 
            bailout("can't rename: old working file %r does not exist" % from_rel)
595
 
        if tree.has_filename(to_rel):
596
 
            bailout("can't rename: new working file %r already exists" % to_rel)
597
 
            
598
 
        file_id = inv.path2id(from_rel)
599
 
        if file_id == None:
600
 
            bailout("can't rename: old name %r is not versioned" % from_rel)
601
 
 
602
 
        if inv.path2id(to_rel):
603
 
            bailout("can't rename: new name %r is already versioned" % to_rel)
604
 
 
605
 
        to_dir, to_tail = os.path.split(to_rel)
606
 
        to_dir_id = inv.path2id(to_dir)
607
 
        if to_dir_id == None and to_dir != '':
608
 
            bailout("can't determine destination directory id for %r" % to_dir)
609
 
 
610
 
        mutter("rename_one:")
611
 
        mutter("  file_id    {%s}" % file_id)
612
 
        mutter("  from_rel   %r" % from_rel)
613
 
        mutter("  to_rel     %r" % to_rel)
614
 
        mutter("  to_dir     %r" % to_dir)
615
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
616
 
            
617
 
        inv.rename(file_id, to_dir_id, to_tail)
618
 
 
619
 
        print "%s => %s" % (from_rel, to_rel)
 
667
    def write_log(self, show_timezone='original'):
 
668
        """Write out human-readable log of commits to this branch
 
669
 
 
670
        :param utc: If true, show dates in universal time, not local time."""
 
671
        ## TODO: Option to choose either original, utc or local timezone
 
672
        revno = 1
 
673
        precursor = None
 
674
        for p in self.revision_history():
 
675
            print '-' * 40
 
676
            print 'revno:', revno
 
677
            ## TODO: Show hash if --id is given.
 
678
            ##print 'revision-hash:', p
 
679
            rev = self.get_revision(p)
 
680
            print 'committer:', rev.committer
 
681
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
682
                                                 show_timezone))
 
683
 
 
684
            ## opportunistic consistency check, same as check_patch_chaining
 
685
            if rev.precursor != precursor:
 
686
                bailout("mismatched precursor!")
 
687
 
 
688
            print 'message:'
 
689
            if not rev.message:
 
690
                print '  (no message)'
 
691
            else:
 
692
                for l in rev.message.split('\n'):
 
693
                    print '  ' + l
 
694
 
 
695
            revno += 1
 
696
            precursor = p
 
697
 
 
698
 
 
699
 
 
700
    def show_status(branch, show_all=False):
 
701
        """Display single-line status for non-ignored working files.
 
702
 
 
703
        The list is show sorted in order by file name.
 
704
 
 
705
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
706
        >>> b.show_status()
 
707
        ?       foo
 
708
        >>> b.add('foo')
 
709
        >>> b.show_status()
 
710
        A       foo
 
711
        >>> b.commit("add foo")
 
712
        >>> b.show_status()
 
713
        >>> os.unlink(b.abspath('foo'))
 
714
        >>> b.show_status()
 
715
        D       foo
620
716
        
621
 
        from_abs = self.abspath(from_rel)
622
 
        to_abs = self.abspath(to_rel)
623
 
        try:
624
 
            os.rename(from_abs, to_abs)
625
 
        except OSError, e:
626
 
            bailout("failed to rename %r to %r: %s"
627
 
                    % (from_abs, to_abs, e[1]),
628
 
                    ["rename rolled back"])
629
 
 
630
 
        self._write_inventory(inv)
631
 
            
632
 
 
633
 
 
634
 
    def move(self, from_paths, to_name):
635
 
        """Rename files.
636
 
 
637
 
        to_name must exist as a versioned directory.
638
 
 
639
 
        If to_name exists and is a directory, the files are moved into
640
 
        it, keeping their old names.  If it is a directory, 
641
 
 
642
 
        Note that to_name is only the last component of the new name;
643
 
        this doesn't change the directory.
 
717
 
 
718
        :todo: Get state for single files.
 
719
 
 
720
        :todo: Perhaps show a slash at the end of directory names.        
 
721
 
644
722
        """
645
 
        self._need_writelock()
646
 
        ## TODO: Option to move IDs only
647
 
        assert not isinstance(from_paths, basestring)
648
 
        tree = self.working_tree()
649
 
        inv = tree.inventory
650
 
        to_abs = self.abspath(to_name)
651
 
        if not isdir(to_abs):
652
 
            bailout("destination %r is not a directory" % to_abs)
653
 
        if not tree.has_filename(to_name):
654
 
            bailout("destination %r not in working directory" % to_abs)
655
 
        to_dir_id = inv.path2id(to_name)
656
 
        if to_dir_id == None and to_name != '':
657
 
            bailout("destination %r is not a versioned directory" % to_name)
658
 
        to_dir_ie = inv[to_dir_id]
659
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
660
 
            bailout("destination %r is not a directory" % to_abs)
661
 
 
662
 
        to_idpath = Set(inv.get_idpath(to_dir_id))
663
 
 
664
 
        for f in from_paths:
665
 
            if not tree.has_filename(f):
666
 
                bailout("%r does not exist in working tree" % f)
667
 
            f_id = inv.path2id(f)
668
 
            if f_id == None:
669
 
                bailout("%r is not versioned" % f)
670
 
            name_tail = splitpath(f)[-1]
671
 
            dest_path = appendpath(to_name, name_tail)
672
 
            if tree.has_filename(dest_path):
673
 
                bailout("destination %r already exists" % dest_path)
674
 
            if f_id in to_idpath:
675
 
                bailout("can't move %r to a subdirectory of itself" % f)
676
 
 
677
 
        # OK, so there's a race here, it's possible that someone will
678
 
        # create a file in this interval and then the rename might be
679
 
        # left half-done.  But we should have caught most problems.
680
 
 
681
 
        for f in from_paths:
682
 
            name_tail = splitpath(f)[-1]
683
 
            dest_path = appendpath(to_name, name_tail)
684
 
            print "%s => %s" % (f, dest_path)
685
 
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
686
 
            try:
687
 
                os.rename(self.abspath(f), self.abspath(dest_path))
688
 
            except OSError, e:
689
 
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
690
 
                        ["rename rolled back"])
691
 
 
692
 
        self._write_inventory(inv)
693
 
 
694
 
 
 
723
 
 
724
        # We have to build everything into a list first so that it can
 
725
        # sorted by name, incorporating all the different sources.
 
726
 
 
727
        # FIXME: Rather than getting things in random order and then sorting,
 
728
        # just step through in order.
 
729
 
 
730
        # Interesting case: the old ID for a file has been removed,
 
731
        # but a new file has been created under that name.
 
732
 
 
733
        old = branch.basis_tree()
 
734
        old_inv = old.inventory
 
735
        new = branch.working_tree()
 
736
        new_inv = new.inventory
 
737
 
 
738
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
739
            if fs == 'R':
 
740
                show_status(fs, kind,
 
741
                            oldname + ' => ' + newname)
 
742
            elif fs == 'A' or fs == 'M':
 
743
                show_status(fs, kind, newname)
 
744
            elif fs == 'D':
 
745
                show_status(fs, kind, oldname)
 
746
            elif fs == '.':
 
747
                if show_all:
 
748
                    show_status(fs, kind, newname)
 
749
            elif fs == 'I':
 
750
                if show_all:
 
751
                    show_status(fs, kind, newname)
 
752
            elif fs == '?':
 
753
                show_status(fs, kind, newname)
 
754
            else:
 
755
                bailout("wierd file state %r" % ((fs, fid),))
 
756
                
695
757
 
696
758
 
697
759
class ScratchBranch(Branch):
701
763
    >>> isdir(b.base)
702
764
    True
703
765
    >>> bd = b.base
704
 
    >>> b.destroy()
 
766
    >>> del b
705
767
    >>> isdir(bd)
706
768
    False
707
769
    """
721
783
 
722
784
 
723
785
    def __del__(self):
724
 
        self.destroy()
725
 
 
726
 
    def destroy(self):
727
786
        """Destroy the test branch, removing the scratch directory."""
728
 
        try:
729
 
            mutter("delete ScratchBranch %s" % self.base)
730
 
            shutil.rmtree(self.base)
731
 
        except OSError, e:
732
 
            # Work around for shutil.rmtree failing on Windows when
733
 
            # readonly files are encountered
734
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
735
 
            for root, dirs, files in os.walk(self.base, topdown=False):
736
 
                for name in files:
737
 
                    os.chmod(os.path.join(root, name), 0700)
738
 
            shutil.rmtree(self.base)
739
 
        self.base = None
 
787
        shutil.rmtree(self.base)
740
788
 
741
789
    
742
790
 
759
807
 
760
808
 
761
809
 
 
810
def _gen_revision_id(when):
 
811
    """Return new revision-id."""
 
812
    s = '%s-%s-' % (user_email(), compact_date(when))
 
813
    s += hexlify(rand_bytes(8))
 
814
    return s
 
815
 
 
816
 
762
817
def gen_file_id(name):
763
818
    """Return new file id.
764
819
 
768
823
    idx = name.rfind('/')
769
824
    if idx != -1:
770
825
        name = name[idx+1 : ]
771
 
    idx = name.rfind('\\')
772
 
    if idx != -1:
773
 
        name = name[idx+1 : ]
774
826
 
775
827
    name = name.lstrip('.')
776
828
 
777
829
    s = hexlify(rand_bytes(8))
778
830
    return '-'.join((name, compact_date(time.time()), s))
 
831
 
 
832