~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-08 05:39:46 UTC
  • Revision ID: mbp@sourcefrog.net-20050408053946-1cb3415e1f8f58493034a5cf
- import lovely urlgrabber library

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
31
     joinpath, sha_string, file_kind, local_time_offset, appendpath
32
32
from store import ImmutableStore
33
33
from revision import Revision
34
34
from errors import bailout, BzrError
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
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
 
85
73
class Branch:
86
74
    """Branch holding a history of revisions.
87
75
 
88
 
    base
89
 
        Base directory of the branch.
 
76
    :todo: Perhaps use different stores for different classes of object,
 
77
           so that we can keep track of how much space each one uses,
 
78
           or garbage-collect them.
 
79
 
 
80
    :todo: Add a RemoteBranch subclass.  For the basic case of read-only
 
81
           HTTP access this should be very easy by, 
 
82
           just redirecting controlfile access into HTTP requests.
 
83
           We would need a RemoteStore working similarly.
 
84
 
 
85
    :todo: Keep the on-disk branch locked while the object exists.
 
86
 
 
87
    :todo: mkdir() method.
90
88
    """
91
 
    _lockmode = None
92
 
    
93
 
    def __init__(self, base, init=False, find_root=True, lock_mode='w'):
 
89
    def __init__(self, base, init=False, find_root=True):
94
90
        """Create new branch object at a particular location.
95
91
 
96
 
        base -- Base directory for the branch.
 
92
        :param base: Base directory for the branch.
97
93
        
98
 
        init -- If True, create new control files in a previously
 
94
        :param init: If True, create new control files in a previously
99
95
             unversioned directory.  If False, the branch must already
100
96
             be versioned.
101
97
 
102
 
        find_root -- If true and init is false, find the root of the
 
98
        :param find_root: If true and init is false, find the root of the
103
99
             existing branch containing base.
104
100
 
105
101
        In the test suite, creation of new trees is tested using the
117
113
                        ['use "bzr init" to initialize a new working tree',
118
114
                         'current bzr can only operate from top-of-tree'])
119
115
        self._check_format()
120
 
        self.lock(lock_mode)
121
116
 
122
117
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
123
118
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
131
126
    __repr__ = __str__
132
127
 
133
128
 
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
129
    def abspath(self, name):
184
130
        """Return absolute filename for something in the branch"""
185
131
        return os.path.join(self.base, name)
206
152
 
207
153
 
208
154
    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
 
 
 
155
        """Open a control file for this branch"""
 
156
        return file(self.controlfilename(file_or_path), mode)
233
157
 
234
158
 
235
159
    def _make_control(self):
237
161
        self.controlfile('README', 'w').write(
238
162
            "This is a Bazaar-NG control directory.\n"
239
163
            "Do not change any files in this directory.")
240
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
 
164
        self.controlfile('branch-format', 'wb').write(BZR_BRANCH_FORMAT)
241
165
        for d in ('text-store', 'inventory-store', 'revision-store'):
242
166
            os.mkdir(self.controlfilename(d))
243
167
        for f in ('revision-history', 'merged-patches',
244
 
                  'pending-merged-patches', 'branch-name',
245
 
                  'branch-lock'):
 
168
                  'pending-merged-patches', 'branch-name'):
246
169
            self.controlfile(f, 'w').write('')
247
170
        mutter('created control directory in ' + self.base)
248
171
        Inventory().write_xml(self.controlfile('inventory','w'))
259
182
        # This ignores newlines so that we can open branches created
260
183
        # on Windows from Linux and so on.  I think it might be better
261
184
        # to always make all internal files in unix format.
262
 
        fmt = self.controlfile('branch-format', 'r').read()
 
185
        fmt = self.controlfile('branch-format', 'rb').read()
263
186
        fmt.replace('\r\n', '')
264
187
        if fmt != BZR_BRANCH_FORMAT:
265
188
            bailout('sorry, branch format %r not supported' % fmt,
269
192
 
270
193
    def read_working_inventory(self):
271
194
        """Read the working inventory."""
272
 
        self._need_readlock()
273
195
        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'))
 
196
        inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
277
197
        mutter("loaded inventory of %d items in %f"
278
198
               % (len(inv), time.time() - before))
279
199
        return inv
285
205
        That is to say, the inventory describing changes underway, that
286
206
        will be committed to the next revision.
287
207
        """
288
 
        self._need_writelock()
289
208
        ## TODO: factor out to atomicfile?  is rename safe on windows?
290
209
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
291
210
        tmpfname = self.controlfilename('inventory.tmp')
292
 
        tmpf = file(tmpfname, 'wb')
 
211
        tmpf = file(tmpfname, 'w')
293
212
        inv.write_xml(tmpf)
294
213
        tmpf.close()
295
214
        inv_fname = self.controlfilename('inventory')
303
222
                         """Inventory for the working copy.""")
304
223
 
305
224
 
306
 
    def add(self, files, verbose=False, ids=None):
 
225
    def add(self, files, verbose=False):
307
226
        """Make files versioned.
308
227
 
309
 
        Note that the command line normally calls smart_add instead.
310
 
 
311
228
        This puts the files in the Added state, so that they will be
312
229
        recorded by the next commit.
313
230
 
314
 
        TODO: Perhaps have an option to add the ids even if the files do
 
231
        :todo: Perhaps have an option to add the ids even if the files do
315
232
               not (yet) exist.
316
233
 
317
 
        TODO: Perhaps return the ids of the files?  But then again it
 
234
        :todo: Perhaps return the ids of the files?  But then again it
318
235
               is easy to retrieve them if they're needed.
319
236
 
320
 
        TODO: Option to specify file id.
 
237
        :todo: Option to specify file id.
321
238
 
322
 
        TODO: Adding a directory should optionally recurse down and
 
239
        :todo: Adding a directory should optionally recurse down and
323
240
               add all non-ignored children.  Perhaps do that in a
324
241
               higher-level method.
 
242
 
 
243
        >>> b = ScratchBranch(files=['foo'])
 
244
        >>> 'foo' in b.unknowns()
 
245
        True
 
246
        >>> b.show_status()
 
247
        ?       foo
 
248
        >>> b.add('foo')
 
249
        >>> 'foo' in b.unknowns()
 
250
        False
 
251
        >>> bool(b.inventory.path2id('foo'))
 
252
        True
 
253
        >>> b.show_status()
 
254
        A       foo
 
255
 
 
256
        >>> b.add('foo')
 
257
        Traceback (most recent call last):
 
258
        ...
 
259
        BzrError: ('foo is already versioned', [])
 
260
 
 
261
        >>> b.add(['nothere'])
 
262
        Traceback (most recent call last):
 
263
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
325
264
        """
326
 
        self._need_writelock()
327
265
 
328
266
        # TODO: Re-adding a file that is removed in the working copy
329
267
        # should probably put it back with the previous ID.
330
268
        if isinstance(files, types.StringTypes):
331
 
            assert(ids is None or isinstance(ids, types.StringTypes))
332
269
            files = [files]
333
 
            if ids is not None:
334
 
                ids = [ids]
335
 
 
336
 
        if ids is None:
337
 
            ids = [None] * len(files)
338
 
        else:
339
 
            assert(len(ids) == len(files))
340
270
        
341
271
        inv = self.read_working_inventory()
342
 
        for f,file_id in zip(files, ids):
 
272
        for f in files:
343
273
            if is_control_file(f):
344
274
                bailout("cannot add control file %s" % quotefn(f))
345
275
 
359
289
            if kind != 'file' and kind != 'directory':
360
290
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
361
291
 
362
 
            if file_id is None:
363
 
                file_id = gen_file_id(f)
 
292
            file_id = gen_file_id(f)
364
293
            inv.add_path(f, kind=kind, file_id=file_id)
365
294
 
366
295
            if verbose:
373
302
 
374
303
    def print_file(self, file, revno):
375
304
        """Print `file` to stdout."""
376
 
        self._need_readlock()
377
305
        tree = self.revision_tree(self.lookup_revision(revno))
378
306
        # use inventory as it was in that revision
379
307
        file_id = tree.inventory.path2id(file)
387
315
 
388
316
        This does not remove their text.  This does not run on 
389
317
 
390
 
        TODO: Refuse to remove modified files unless --force is given?
391
 
 
392
 
        TODO: Do something useful with directories.
393
 
 
394
 
        TODO: Should this remove the text or not?  Tough call; not
 
318
        :todo: Refuse to remove modified files unless --force is given?
 
319
 
 
320
        >>> b = ScratchBranch(files=['foo'])
 
321
        >>> b.add('foo')
 
322
        >>> b.inventory.has_filename('foo')
 
323
        True
 
324
        >>> b.remove('foo')
 
325
        >>> b.working_tree().has_filename('foo')
 
326
        True
 
327
        >>> b.inventory.has_filename('foo')
 
328
        False
 
329
        
 
330
        >>> b = ScratchBranch(files=['foo'])
 
331
        >>> b.add('foo')
 
332
        >>> b.commit('one')
 
333
        >>> b.remove('foo')
 
334
        >>> b.commit('two')
 
335
        >>> b.inventory.has_filename('foo') 
 
336
        False
 
337
        >>> b.basis_tree().has_filename('foo') 
 
338
        False
 
339
        >>> b.working_tree().has_filename('foo') 
 
340
        True
 
341
 
 
342
        :todo: Do something useful with directories.
 
343
 
 
344
        :todo: Should this remove the text or not?  Tough call; not
395
345
        removing may be useful and the user can just use use rm, and
396
346
        is the opposite of add.  Removing it is consistent with most
397
347
        other tools.  Maybe an option.
398
348
        """
399
349
        ## TODO: Normalize names
400
350
        ## TODO: Remove nested loops; better scalability
401
 
        self._need_writelock()
402
351
 
403
352
        if isinstance(files, types.StringTypes):
404
353
            files = [files]
423
372
 
424
373
        self._write_inventory(inv)
425
374
 
426
 
    def set_inventory(self, new_inventory_list):
427
 
        inv = Inventory()
428
 
        for path, file_id, parent, kind in new_inventory_list:
429
 
            name = os.path.basename(path)
430
 
            if name == "":
431
 
                continue
432
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
433
 
        self._write_inventory(inv)
434
 
 
435
375
 
436
376
    def unknowns(self):
437
377
        """Return all unknown files.
452
392
        return self.working_tree().unknowns()
453
393
 
454
394
 
455
 
    def append_revision(self, revision_id):
456
 
        mutter("add {%s} to revision-history" % revision_id)
457
 
        rev_history = self.revision_history()
458
 
 
459
 
        tmprhname = self.controlfilename('revision-history.tmp')
460
 
        rhname = self.controlfilename('revision-history')
461
 
        
462
 
        f = file(tmprhname, 'wt')
463
 
        rev_history.append(revision_id)
464
 
        f.write('\n'.join(rev_history))
465
 
        f.write('\n')
 
395
    def commit(self, message, timestamp=None, timezone=None,
 
396
               committer=None,
 
397
               verbose=False):
 
398
        """Commit working copy as a new revision.
 
399
        
 
400
        The basic approach is to add all the file texts into the
 
401
        store, then the inventory, then make a new revision pointing
 
402
        to that inventory and store that.
 
403
        
 
404
        This is not quite safe if the working copy changes during the
 
405
        commit; for the moment that is simply not allowed.  A better
 
406
        approach is to make a temporary copy of the files before
 
407
        computing their hashes, and then add those hashes in turn to
 
408
        the inventory.  This should mean at least that there are no
 
409
        broken hash pointers.  There is no way we can get a snapshot
 
410
        of the whole directory at an instant.  This would also have to
 
411
        be robust against files disappearing, moving, etc.  So the
 
412
        whole thing is a bit hard.
 
413
 
 
414
        :param timestamp: if not None, seconds-since-epoch for a
 
415
             postdated/predated commit.
 
416
        """
 
417
 
 
418
        ## TODO: Show branch names
 
419
 
 
420
        # TODO: Don't commit if there are no changes, unless forced?
 
421
 
 
422
        # First walk over the working inventory; and both update that
 
423
        # and also build a new revision inventory.  The revision
 
424
        # inventory needs to hold the text-id, sha1 and size of the
 
425
        # actual file versions committed in the revision.  (These are
 
426
        # not present in the working inventory.)  We also need to
 
427
        # detect missing/deleted files, and remove them from the
 
428
        # working inventory.
 
429
 
 
430
        work_inv = self.read_working_inventory()
 
431
        inv = Inventory()
 
432
        basis = self.basis_tree()
 
433
        basis_inv = basis.inventory
 
434
        missing_ids = []
 
435
        for path, entry in work_inv.iter_entries():
 
436
            ## TODO: Cope with files that have gone missing.
 
437
 
 
438
            ## TODO: Check that the file kind has not changed from the previous
 
439
            ## revision of this file (if any).
 
440
 
 
441
            entry = entry.copy()
 
442
 
 
443
            p = self.abspath(path)
 
444
            file_id = entry.file_id
 
445
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
446
 
 
447
            if not os.path.exists(p):
 
448
                mutter("    file is missing, removing from inventory")
 
449
                if verbose:
 
450
                    show_status('D', entry.kind, quotefn(path))
 
451
                missing_ids.append(file_id)
 
452
                continue
 
453
 
 
454
            # TODO: Handle files that have been deleted
 
455
 
 
456
            # TODO: Maybe a special case for empty files?  Seems a
 
457
            # waste to store them many times.
 
458
 
 
459
            inv.add(entry)
 
460
 
 
461
            if basis_inv.has_id(file_id):
 
462
                old_kind = basis_inv[file_id].kind
 
463
                if old_kind != entry.kind:
 
464
                    bailout("entry %r changed kind from %r to %r"
 
465
                            % (file_id, old_kind, entry.kind))
 
466
 
 
467
            if entry.kind == 'directory':
 
468
                if not isdir(p):
 
469
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
470
            elif entry.kind == 'file':
 
471
                if not isfile(p):
 
472
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
473
 
 
474
                content = file(p, 'rb').read()
 
475
 
 
476
                entry.text_sha1 = sha_string(content)
 
477
                entry.text_size = len(content)
 
478
 
 
479
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
480
                if (old_ie
 
481
                    and (old_ie.text_size == entry.text_size)
 
482
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
483
                    ## assert content == basis.get_file(file_id).read()
 
484
                    entry.text_id = basis_inv[file_id].text_id
 
485
                    mutter('    unchanged from previous text_id {%s}' %
 
486
                           entry.text_id)
 
487
                    
 
488
                else:
 
489
                    entry.text_id = gen_file_id(entry.name)
 
490
                    self.text_store.add(content, entry.text_id)
 
491
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
492
                    if verbose:
 
493
                        if not old_ie:
 
494
                            state = 'A'
 
495
                        elif (old_ie.name == entry.name
 
496
                              and old_ie.parent_id == entry.parent_id):
 
497
                            state = 'M'
 
498
                        else:
 
499
                            state = 'R'
 
500
 
 
501
                        show_status(state, entry.kind, quotefn(path))
 
502
 
 
503
        for file_id in missing_ids:
 
504
            # have to do this later so we don't mess up the iterator.
 
505
            # since parents may be removed before their children we
 
506
            # have to test.
 
507
 
 
508
            # FIXME: There's probably a better way to do this; perhaps
 
509
            # the workingtree should know how to filter itself.
 
510
            if work_inv.has_id(file_id):
 
511
                del work_inv[file_id]
 
512
 
 
513
 
 
514
        inv_id = rev_id = _gen_revision_id(time.time())
 
515
        
 
516
        inv_tmp = tempfile.TemporaryFile()
 
517
        inv.write_xml(inv_tmp)
 
518
        inv_tmp.seek(0)
 
519
        self.inventory_store.add(inv_tmp, inv_id)
 
520
        mutter('new inventory_id is {%s}' % inv_id)
 
521
 
 
522
        self._write_inventory(work_inv)
 
523
 
 
524
        if timestamp == None:
 
525
            timestamp = time.time()
 
526
 
 
527
        if committer == None:
 
528
            committer = username()
 
529
 
 
530
        if timezone == None:
 
531
            timezone = local_time_offset()
 
532
 
 
533
        mutter("building commit log message")
 
534
        rev = Revision(timestamp=timestamp,
 
535
                       timezone=timezone,
 
536
                       committer=committer,
 
537
                       precursor = self.last_patch(),
 
538
                       message = message,
 
539
                       inventory_id=inv_id,
 
540
                       revision_id=rev_id)
 
541
 
 
542
        rev_tmp = tempfile.TemporaryFile()
 
543
        rev.write_xml(rev_tmp)
 
544
        rev_tmp.seek(0)
 
545
        self.revision_store.add(rev_tmp, rev_id)
 
546
        mutter("new revision_id is {%s}" % rev_id)
 
547
        
 
548
        ## XXX: Everything up to here can simply be orphaned if we abort
 
549
        ## the commit; it will leave junk files behind but that doesn't
 
550
        ## matter.
 
551
 
 
552
        ## TODO: Read back the just-generated changeset, and make sure it
 
553
        ## applies and recreates the right state.
 
554
 
 
555
        ## TODO: Also calculate and store the inventory SHA1
 
556
        mutter("committing patch r%d" % (self.revno() + 1))
 
557
 
 
558
        mutter("append to revision-history")
 
559
        f = self.controlfile('revision-history', 'at')
 
560
        f.write(rev_id + '\n')
466
561
        f.close()
467
562
 
468
 
        if sys.platform == 'win32':
469
 
            os.remove(rhname)
470
 
        os.rename(tmprhname, rhname)
471
 
        
 
563
        if verbose:
 
564
            note("commited r%d" % self.revno())
472
565
 
473
566
 
474
567
    def get_revision(self, revision_id):
475
568
        """Return the Revision object for a named revision"""
476
 
        self._need_readlock()
477
569
        r = Revision.read_xml(self.revision_store[revision_id])
478
570
        assert r.revision_id == revision_id
479
571
        return r
482
574
    def get_inventory(self, inventory_id):
483
575
        """Get Inventory object by hash.
484
576
 
485
 
        TODO: Perhaps for this and similar methods, take a revision
 
577
        :todo: Perhaps for this and similar methods, take a revision
486
578
               parameter which can be either an integer revno or a
487
579
               string hash."""
488
 
        self._need_readlock()
489
580
        i = Inventory.read_xml(self.inventory_store[inventory_id])
490
581
        return i
491
582
 
492
583
 
493
584
    def get_revision_inventory(self, revision_id):
494
585
        """Return inventory of a past revision."""
495
 
        self._need_readlock()
496
586
        if revision_id == None:
497
587
            return Inventory()
498
588
        else:
505
595
        >>> ScratchBranch().revision_history()
506
596
        []
507
597
        """
508
 
        self._need_readlock()
509
 
        return [l.rstrip('\r\n') for l in self.controlfile('revision-history', 'r').readlines()]
510
 
 
511
 
 
512
 
    def enum_history(self, direction):
513
 
        """Return (revno, revision_id) for history of branch.
514
 
 
515
 
        direction
516
 
            'forward' is from earliest to latest
517
 
            'reverse' is from latest to earliest
518
 
        """
519
 
        rh = self.revision_history()
520
 
        if direction == 'forward':
521
 
            i = 1
522
 
            for rid in rh:
523
 
                yield i, rid
524
 
                i += 1
525
 
        elif direction == 'reverse':
526
 
            i = len(rh)
527
 
            while i > 0:
528
 
                yield i, rh[i-1]
529
 
                i -= 1
530
 
        else:
531
 
            raise BzrError('invalid history direction %r' % direction)
 
598
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
532
599
 
533
600
 
534
601
    def revno(self):
536
603
 
537
604
        That is equivalent to the number of revisions committed to
538
605
        this branch.
 
606
 
 
607
        >>> b = ScratchBranch()
 
608
        >>> b.revno()
 
609
        0
 
610
        >>> b.commit('no foo')
 
611
        >>> b.revno()
 
612
        1
539
613
        """
540
614
        return len(self.revision_history())
541
615
 
542
616
 
543
617
    def last_patch(self):
544
618
        """Return last patch hash, or None if no history.
 
619
 
 
620
        >>> ScratchBranch().last_patch() == None
 
621
        True
545
622
        """
546
623
        ph = self.revision_history()
547
624
        if ph:
548
625
            return ph[-1]
549
626
        else:
550
627
            return None
551
 
 
552
 
 
553
 
    def commit(self, *args, **kw):
554
 
        """Deprecated"""
555
 
        from bzrlib.commit import commit
556
 
        commit(self, *args, **kw)
557
628
        
558
629
 
559
630
    def lookup_revision(self, revno):
573
644
 
574
645
        `revision_id` may be None for the null revision, in which case
575
646
        an `EmptyTree` is returned."""
576
 
        self._need_readlock()
 
647
 
577
648
        if revision_id == None:
578
649
            return EmptyTree()
579
650
        else:
583
654
 
584
655
    def working_tree(self):
585
656
        """Return a `Tree` for the working copy."""
586
 
        from workingtree import WorkingTree
587
657
        return WorkingTree(self.base, self.read_working_inventory())
588
658
 
589
659
 
591
661
        """Return `Tree` object for last revision.
592
662
 
593
663
        If there are no revisions yet, return an `EmptyTree`.
 
664
 
 
665
        >>> b = ScratchBranch(files=['foo'])
 
666
        >>> b.basis_tree().has_filename('foo')
 
667
        False
 
668
        >>> b.working_tree().has_filename('foo')
 
669
        True
 
670
        >>> b.add('foo')
 
671
        >>> b.commit('add foo')
 
672
        >>> b.basis_tree().has_filename('foo')
 
673
        True
594
674
        """
595
675
        r = self.last_patch()
596
676
        if r == None:
600
680
 
601
681
 
602
682
 
 
683
    def write_log(self, show_timezone='original'):
 
684
        """Write out human-readable log of commits to this branch
 
685
 
 
686
        :param utc: If true, show dates in universal time, not local time."""
 
687
        ## TODO: Option to choose either original, utc or local timezone
 
688
        revno = 1
 
689
        precursor = None
 
690
        for p in self.revision_history():
 
691
            print '-' * 40
 
692
            print 'revno:', revno
 
693
            ## TODO: Show hash if --id is given.
 
694
            ##print 'revision-hash:', p
 
695
            rev = self.get_revision(p)
 
696
            print 'committer:', rev.committer
 
697
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
698
                                                 show_timezone))
 
699
 
 
700
            ## opportunistic consistency check, same as check_patch_chaining
 
701
            if rev.precursor != precursor:
 
702
                bailout("mismatched precursor!")
 
703
 
 
704
            print 'message:'
 
705
            if not rev.message:
 
706
                print '  (no message)'
 
707
            else:
 
708
                for l in rev.message.split('\n'):
 
709
                    print '  ' + l
 
710
 
 
711
            revno += 1
 
712
            precursor = p
 
713
 
 
714
 
603
715
    def rename_one(self, from_rel, to_rel):
604
 
        """Rename one file.
605
 
 
606
 
        This can change the directory or the filename or both.
607
 
        """
608
 
        self._need_writelock()
609
716
        tree = self.working_tree()
610
717
        inv = tree.inventory
611
718
        if not tree.has_filename(from_rel):
660
767
        Note that to_name is only the last component of the new name;
661
768
        this doesn't change the directory.
662
769
        """
663
 
        self._need_writelock()
664
770
        ## TODO: Option to move IDs only
665
771
        assert not isinstance(from_paths, basestring)
666
772
        tree = self.working_tree()
711
817
 
712
818
 
713
819
 
 
820
    def show_status(self, show_all=False):
 
821
        """Display single-line status for non-ignored working files.
 
822
 
 
823
        The list is show sorted in order by file name.
 
824
 
 
825
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
826
        >>> b.show_status()
 
827
        ?       foo
 
828
        >>> b.add('foo')
 
829
        >>> b.show_status()
 
830
        A       foo
 
831
        >>> b.commit("add foo")
 
832
        >>> b.show_status()
 
833
        >>> os.unlink(b.abspath('foo'))
 
834
        >>> b.show_status()
 
835
        D       foo
 
836
        
 
837
 
 
838
        :todo: Get state for single files.
 
839
 
 
840
        :todo: Perhaps show a slash at the end of directory names.        
 
841
 
 
842
        """
 
843
 
 
844
        # We have to build everything into a list first so that it can
 
845
        # sorted by name, incorporating all the different sources.
 
846
 
 
847
        # FIXME: Rather than getting things in random order and then sorting,
 
848
        # just step through in order.
 
849
 
 
850
        # Interesting case: the old ID for a file has been removed,
 
851
        # but a new file has been created under that name.
 
852
 
 
853
        old = self.basis_tree()
 
854
        new = self.working_tree()
 
855
 
 
856
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
857
            if fs == 'R':
 
858
                show_status(fs, kind,
 
859
                            oldname + ' => ' + newname)
 
860
            elif fs == 'A' or fs == 'M':
 
861
                show_status(fs, kind, newname)
 
862
            elif fs == 'D':
 
863
                show_status(fs, kind, oldname)
 
864
            elif fs == '.':
 
865
                if show_all:
 
866
                    show_status(fs, kind, newname)
 
867
            elif fs == 'I':
 
868
                if show_all:
 
869
                    show_status(fs, kind, newname)
 
870
            elif fs == '?':
 
871
                show_status(fs, kind, newname)
 
872
            else:
 
873
                bailout("wierd file state %r" % ((fs, fid),))
 
874
                
 
875
 
714
876
 
715
877
class ScratchBranch(Branch):
716
878
    """Special test class: a branch that cleans up after itself.
719
881
    >>> isdir(b.base)
720
882
    True
721
883
    >>> bd = b.base
722
 
    >>> b.destroy()
 
884
    >>> del b
723
885
    >>> isdir(bd)
724
886
    False
725
887
    """
739
901
 
740
902
 
741
903
    def __del__(self):
742
 
        self.destroy()
743
 
 
744
 
    def destroy(self):
745
904
        """Destroy the test branch, removing the scratch directory."""
746
905
        try:
747
 
            mutter("delete ScratchBranch %s" % self.base)
748
906
            shutil.rmtree(self.base)
749
 
        except OSError, e:
 
907
        except OSError:
750
908
            # Work around for shutil.rmtree failing on Windows when
751
909
            # readonly files are encountered
752
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
753
910
            for root, dirs, files in os.walk(self.base, topdown=False):
754
911
                for name in files:
755
912
                    os.chmod(os.path.join(root, name), 0700)
756
913
            shutil.rmtree(self.base)
757
 
        self.base = None
758
914
 
759
915
    
760
916
 
777
933
 
778
934
 
779
935
 
 
936
def _gen_revision_id(when):
 
937
    """Return new revision-id."""
 
938
    s = '%s-%s-' % (user_email(), compact_date(when))
 
939
    s += hexlify(rand_bytes(8))
 
940
    return s
 
941
 
 
942
 
780
943
def gen_file_id(name):
781
944
    """Return new file id.
782
945
 
786
949
    idx = name.rfind('/')
787
950
    if idx != -1:
788
951
        name = name[idx+1 : ]
789
 
    idx = name.rfind('\\')
790
 
    if idx != -1:
791
 
        name = name[idx+1 : ]
792
952
 
793
953
    name = name.lstrip('.')
794
954
 
795
955
    s = hexlify(rand_bytes(8))
796
956
    return '-'.join((name, compact_date(time.time()), s))
 
957
 
 
958