/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-05 13:46:36 UTC
  • Revision ID: mbp@sourcefrog.net-20050405134635-488e04a5092ce0faec0ff181
- New 'move' command; now separated out from rename

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
from sets import Set
 
19
 
 
20
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
 
21
import traceback, socket, fnmatch, difflib, time
 
22
from binascii import hexlify
 
23
 
 
24
import bzrlib
 
25
from inventory import Inventory
 
26
from trace import mutter, note
 
27
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
 
28
from inventory import InventoryEntry, Inventory
 
29
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
 
30
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
 
31
     joinpath, sha_string, file_kind, local_time_offset, appendpath
 
32
from store import ImmutableStore
 
33
from revision import Revision
 
34
from errors import bailout
 
35
from textui import show_status
 
36
from diff import diff_trees
 
37
 
 
38
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
39
## TODO: Maybe include checks for common corruption of newlines, etc?
 
40
 
 
41
 
 
42
 
 
43
def find_branch_root(f=None):
 
44
    """Find the branch root enclosing f, or pwd.
 
45
 
 
46
    It is not necessary that f exists.
 
47
 
 
48
    Basically we keep looking up until we find the control directory or
 
49
    run into the root."""
 
50
    if f is None:
 
51
        f = os.getcwd()
 
52
    elif hasattr(os.path, 'realpath'):
 
53
        f = os.path.realpath(f)
 
54
    else:
 
55
        f = os.path.abspath(f)
 
56
 
 
57
    orig_f = f
 
58
 
 
59
    last_f = f
 
60
    while True:
 
61
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
 
62
            return f
 
63
        head, tail = os.path.split(f)
 
64
        if head == f:
 
65
            # reached the root, whatever that may be
 
66
            bailout('%r is not in a branch' % orig_f)
 
67
        f = head
 
68
    
 
69
 
 
70
 
 
71
######################################################################
 
72
# branch objects
 
73
 
 
74
class Branch:
 
75
    """Branch holding a history of revisions.
 
76
 
 
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.
 
89
    """
 
90
    def __init__(self, base, init=False, find_root=True):
 
91
        """Create new branch object at a particular location.
 
92
 
 
93
        :param base: Base directory for the branch.
 
94
        
 
95
        :param init: If True, create new control files in a previously
 
96
             unversioned directory.  If False, the branch must already
 
97
             be versioned.
 
98
 
 
99
        :param find_root: If true and init is false, find the root of the
 
100
             existing branch containing base.
 
101
 
 
102
        In the test suite, creation of new trees is tested using the
 
103
        `ScratchBranch` class.
 
104
        """
 
105
        if init:
 
106
            self.base = os.path.realpath(base)
 
107
            self._make_control()
 
108
        elif find_root:
 
109
            self.base = find_branch_root(base)
 
110
        else:
 
111
            self.base = os.path.realpath(base)
 
112
            if not isdir(self.controlfilename('.')):
 
113
                bailout("not a bzr branch: %s" % quotefn(base),
 
114
                        ['use "bzr init" to initialize a new working tree',
 
115
                         'current bzr can only operate from top-of-tree'])
 
116
        self._check_format()
 
117
 
 
118
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
 
119
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
 
120
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
 
121
 
 
122
 
 
123
    def __str__(self):
 
124
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
125
 
 
126
 
 
127
    __repr__ = __str__
 
128
 
 
129
 
 
130
    def abspath(self, name):
 
131
        """Return absolute filename for something in the branch"""
 
132
        return os.path.join(self.base, name)
 
133
 
 
134
 
 
135
    def relpath(self, path):
 
136
        """Return path relative to this branch of something inside it.
 
137
 
 
138
        Raises an error if path is not in this branch."""
 
139
        rp = os.path.realpath(path)
 
140
        # FIXME: windows
 
141
        if not rp.startswith(self.base):
 
142
            bailout("path %r is not within branch %r" % (rp, self.base))
 
143
        rp = rp[len(self.base):]
 
144
        rp = rp.lstrip(os.sep)
 
145
        return rp
 
146
 
 
147
 
 
148
    def controlfilename(self, file_or_path):
 
149
        """Return location relative to branch."""
 
150
        if isinstance(file_or_path, types.StringTypes):
 
151
            file_or_path = [file_or_path]
 
152
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
153
 
 
154
 
 
155
    def controlfile(self, file_or_path, mode='r'):
 
156
        """Open a control file for this branch"""
 
157
        return file(self.controlfilename(file_or_path), mode)
 
158
 
 
159
 
 
160
    def _make_control(self):
 
161
        os.mkdir(self.controlfilename([]))
 
162
        self.controlfile('README', 'w').write(
 
163
            "This is a Bazaar-NG control directory.\n"
 
164
            "Do not change any files in this directory.")
 
165
        self.controlfile('branch-format', 'wb').write(BZR_BRANCH_FORMAT)
 
166
        for d in ('text-store', 'inventory-store', 'revision-store'):
 
167
            os.mkdir(self.controlfilename(d))
 
168
        for f in ('revision-history', 'merged-patches',
 
169
                  'pending-merged-patches', 'branch-name'):
 
170
            self.controlfile(f, 'w').write('')
 
171
        mutter('created control directory in ' + self.base)
 
172
        Inventory().write_xml(self.controlfile('inventory','w'))
 
173
 
 
174
 
 
175
    def _check_format(self):
 
176
        """Check this branch format is supported.
 
177
 
 
178
        The current tool only supports the current unstable format.
 
179
 
 
180
        In the future, we might need different in-memory Branch
 
181
        classes to support downlevel branches.  But not yet.
 
182
        """
 
183
        # This ignores newlines so that we can open branches created
 
184
        # on Windows from Linux and so on.  I think it might be better
 
185
        # to always make all internal files in unix format.
 
186
        fmt = self.controlfile('branch-format', 'rb').read()
 
187
        fmt.replace('\r\n', '')
 
188
        if fmt != BZR_BRANCH_FORMAT:
 
189
            bailout('sorry, branch format %r not supported' % fmt,
 
190
                    ['use a different bzr version',
 
191
                     'or remove the .bzr directory and "bzr init" again'])
 
192
 
 
193
 
 
194
    def read_working_inventory(self):
 
195
        """Read the working inventory."""
 
196
        before = time.time()
 
197
        inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
 
198
        mutter("loaded inventory of %d items in %f"
 
199
               % (len(inv), time.time() - before))
 
200
        return inv
 
201
 
 
202
 
 
203
    def _write_inventory(self, inv):
 
204
        """Update the working inventory.
 
205
 
 
206
        That is to say, the inventory describing changes underway, that
 
207
        will be committed to the next revision.
 
208
        """
 
209
        ## TODO: factor out to atomicfile?  is rename safe on windows?
 
210
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
 
211
        tmpfname = self.controlfilename('inventory.tmp')
 
212
        tmpf = file(tmpfname, 'w')
 
213
        inv.write_xml(tmpf)
 
214
        tmpf.close()
 
215
        inv_fname = self.controlfilename('inventory')
 
216
        if sys.platform == 'win32':
 
217
            os.remove(inv_fname)
 
218
        os.rename(tmpfname, inv_fname)
 
219
        mutter('wrote working inventory')
 
220
 
 
221
 
 
222
    inventory = property(read_working_inventory, _write_inventory, None,
 
223
                         """Inventory for the working copy.""")
 
224
 
 
225
 
 
226
    def add(self, files, verbose=False):
 
227
        """Make files versioned.
 
228
 
 
229
        This puts the files in the Added state, so that they will be
 
230
        recorded by the next commit.
 
231
 
 
232
        :todo: Perhaps have an option to add the ids even if the files do
 
233
               not (yet) exist.
 
234
 
 
235
        :todo: Perhaps return the ids of the files?  But then again it
 
236
               is easy to retrieve them if they're needed.
 
237
 
 
238
        :todo: Option to specify file id.
 
239
 
 
240
        :todo: Adding a directory should optionally recurse down and
 
241
               add all non-ignored children.  Perhaps do that in a
 
242
               higher-level method.
 
243
 
 
244
        >>> b = ScratchBranch(files=['foo'])
 
245
        >>> 'foo' in b.unknowns()
 
246
        True
 
247
        >>> b.show_status()
 
248
        ?       foo
 
249
        >>> b.add('foo')
 
250
        >>> 'foo' in b.unknowns()
 
251
        False
 
252
        >>> bool(b.inventory.path2id('foo'))
 
253
        True
 
254
        >>> b.show_status()
 
255
        A       foo
 
256
 
 
257
        >>> b.add('foo')
 
258
        Traceback (most recent call last):
 
259
        ...
 
260
        BzrError: ('foo is already versioned', [])
 
261
 
 
262
        >>> b.add(['nothere'])
 
263
        Traceback (most recent call last):
 
264
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
265
        """
 
266
 
 
267
        # TODO: Re-adding a file that is removed in the working copy
 
268
        # should probably put it back with the previous ID.
 
269
        if isinstance(files, types.StringTypes):
 
270
            files = [files]
 
271
        
 
272
        inv = self.read_working_inventory()
 
273
        for f in files:
 
274
            if is_control_file(f):
 
275
                bailout("cannot add control file %s" % quotefn(f))
 
276
 
 
277
            fp = splitpath(f)
 
278
 
 
279
            if len(fp) == 0:
 
280
                bailout("cannot add top-level %r" % f)
 
281
                
 
282
            fullpath = os.path.normpath(self.abspath(f))
 
283
 
 
284
            try:
 
285
                kind = file_kind(fullpath)
 
286
            except OSError:
 
287
                # maybe something better?
 
288
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
289
            
 
290
            if kind != 'file' and kind != 'directory':
 
291
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
 
292
 
 
293
            file_id = gen_file_id(f)
 
294
            inv.add_path(f, kind=kind, file_id=file_id)
 
295
 
 
296
            if verbose:
 
297
                show_status('A', kind, quotefn(f))
 
298
                
 
299
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
300
            
 
301
        self._write_inventory(inv)
 
302
 
 
303
 
 
304
 
 
305
    def remove(self, files, verbose=False):
 
306
        """Mark nominated files for removal from the inventory.
 
307
 
 
308
        This does not remove their text.  This does not run on 
 
309
 
 
310
        :todo: Refuse to remove modified files unless --force is given?
 
311
 
 
312
        >>> b = ScratchBranch(files=['foo'])
 
313
        >>> b.add('foo')
 
314
        >>> b.inventory.has_filename('foo')
 
315
        True
 
316
        >>> b.remove('foo')
 
317
        >>> b.working_tree().has_filename('foo')
 
318
        True
 
319
        >>> b.inventory.has_filename('foo')
 
320
        False
 
321
        
 
322
        >>> b = ScratchBranch(files=['foo'])
 
323
        >>> b.add('foo')
 
324
        >>> b.commit('one')
 
325
        >>> b.remove('foo')
 
326
        >>> b.commit('two')
 
327
        >>> b.inventory.has_filename('foo') 
 
328
        False
 
329
        >>> b.basis_tree().has_filename('foo') 
 
330
        False
 
331
        >>> b.working_tree().has_filename('foo') 
 
332
        True
 
333
 
 
334
        :todo: Do something useful with directories.
 
335
 
 
336
        :todo: Should this remove the text or not?  Tough call; not
 
337
        removing may be useful and the user can just use use rm, and
 
338
        is the opposite of add.  Removing it is consistent with most
 
339
        other tools.  Maybe an option.
 
340
        """
 
341
        ## TODO: Normalize names
 
342
        ## TODO: Remove nested loops; better scalability
 
343
 
 
344
        if isinstance(files, types.StringTypes):
 
345
            files = [files]
 
346
        
 
347
        tree = self.working_tree()
 
348
        inv = tree.inventory
 
349
 
 
350
        # do this before any modifications
 
351
        for f in files:
 
352
            fid = inv.path2id(f)
 
353
            if not fid:
 
354
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
355
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
356
            if verbose:
 
357
                # having remove it, it must be either ignored or unknown
 
358
                if tree.is_ignored(f):
 
359
                    new_status = 'I'
 
360
                else:
 
361
                    new_status = '?'
 
362
                show_status(new_status, inv[fid].kind, quotefn(f))
 
363
            del inv[fid]
 
364
 
 
365
        self._write_inventory(inv)
 
366
 
 
367
 
 
368
    def unknowns(self):
 
369
        """Return all unknown files.
 
370
 
 
371
        These are files in the working directory that are not versioned or
 
372
        control files or ignored.
 
373
        
 
374
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
375
        >>> list(b.unknowns())
 
376
        ['foo']
 
377
        >>> b.add('foo')
 
378
        >>> list(b.unknowns())
 
379
        []
 
380
        >>> b.remove('foo')
 
381
        >>> list(b.unknowns())
 
382
        ['foo']
 
383
        """
 
384
        return self.working_tree().unknowns()
 
385
 
 
386
 
 
387
    def commit(self, message, timestamp=None, timezone=None,
 
388
               committer=None,
 
389
               verbose=False):
 
390
        """Commit working copy as a new revision.
 
391
        
 
392
        The basic approach is to add all the file texts into the
 
393
        store, then the inventory, then make a new revision pointing
 
394
        to that inventory and store that.
 
395
        
 
396
        This is not quite safe if the working copy changes during the
 
397
        commit; for the moment that is simply not allowed.  A better
 
398
        approach is to make a temporary copy of the files before
 
399
        computing their hashes, and then add those hashes in turn to
 
400
        the inventory.  This should mean at least that there are no
 
401
        broken hash pointers.  There is no way we can get a snapshot
 
402
        of the whole directory at an instant.  This would also have to
 
403
        be robust against files disappearing, moving, etc.  So the
 
404
        whole thing is a bit hard.
 
405
 
 
406
        :param timestamp: if not None, seconds-since-epoch for a
 
407
             postdated/predated commit.
 
408
        """
 
409
 
 
410
        ## TODO: Show branch names
 
411
 
 
412
        # TODO: Don't commit if there are no changes, unless forced?
 
413
 
 
414
        # First walk over the working inventory; and both update that
 
415
        # and also build a new revision inventory.  The revision
 
416
        # inventory needs to hold the text-id, sha1 and size of the
 
417
        # actual file versions committed in the revision.  (These are
 
418
        # not present in the working inventory.)  We also need to
 
419
        # detect missing/deleted files, and remove them from the
 
420
        # working inventory.
 
421
 
 
422
        work_inv = self.read_working_inventory()
 
423
        inv = Inventory()
 
424
        basis = self.basis_tree()
 
425
        basis_inv = basis.inventory
 
426
        missing_ids = []
 
427
        for path, entry in work_inv.iter_entries():
 
428
            ## TODO: Cope with files that have gone missing.
 
429
 
 
430
            ## TODO: Check that the file kind has not changed from the previous
 
431
            ## revision of this file (if any).
 
432
 
 
433
            entry = entry.copy()
 
434
 
 
435
            p = self.abspath(path)
 
436
            file_id = entry.file_id
 
437
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
438
 
 
439
            if not os.path.exists(p):
 
440
                mutter("    file is missing, removing from inventory")
 
441
                if verbose:
 
442
                    show_status('D', entry.kind, quotefn(path))
 
443
                missing_ids.append(file_id)
 
444
                continue
 
445
 
 
446
            # TODO: Handle files that have been deleted
 
447
 
 
448
            # TODO: Maybe a special case for empty files?  Seems a
 
449
            # waste to store them many times.
 
450
 
 
451
            inv.add(entry)
 
452
 
 
453
            if basis_inv.has_id(file_id):
 
454
                old_kind = basis_inv[file_id].kind
 
455
                if old_kind != entry.kind:
 
456
                    bailout("entry %r changed kind from %r to %r"
 
457
                            % (file_id, old_kind, entry.kind))
 
458
 
 
459
            if entry.kind == 'directory':
 
460
                if not isdir(p):
 
461
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
462
            elif entry.kind == 'file':
 
463
                if not isfile(p):
 
464
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
465
 
 
466
                content = file(p, 'rb').read()
 
467
 
 
468
                entry.text_sha1 = sha_string(content)
 
469
                entry.text_size = len(content)
 
470
 
 
471
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
472
                if (old_ie
 
473
                    and (old_ie.text_size == entry.text_size)
 
474
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
475
                    ## assert content == basis.get_file(file_id).read()
 
476
                    entry.text_id = basis_inv[file_id].text_id
 
477
                    mutter('    unchanged from previous text_id {%s}' %
 
478
                           entry.text_id)
 
479
                    
 
480
                else:
 
481
                    entry.text_id = gen_file_id(entry.name)
 
482
                    self.text_store.add(content, entry.text_id)
 
483
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
484
                    if verbose:
 
485
                        if not old_ie:
 
486
                            state = 'A'
 
487
                        elif (old_ie.name == entry.name
 
488
                              and old_ie.parent_id == entry.parent_id):
 
489
                            state = 'M'
 
490
                        else:
 
491
                            state = 'R'
 
492
 
 
493
                        show_status(state, entry.kind, quotefn(path))
 
494
 
 
495
        for file_id in missing_ids:
 
496
            # have to do this later so we don't mess up the iterator.
 
497
            # since parents may be removed before their children we
 
498
            # have to test.
 
499
 
 
500
            # FIXME: There's probably a better way to do this; perhaps
 
501
            # the workingtree should know how to filter itself.
 
502
            if work_inv.has_id(file_id):
 
503
                del work_inv[file_id]
 
504
 
 
505
 
 
506
        inv_id = rev_id = _gen_revision_id(time.time())
 
507
        
 
508
        inv_tmp = tempfile.TemporaryFile()
 
509
        inv.write_xml(inv_tmp)
 
510
        inv_tmp.seek(0)
 
511
        self.inventory_store.add(inv_tmp, inv_id)
 
512
        mutter('new inventory_id is {%s}' % inv_id)
 
513
 
 
514
        self._write_inventory(work_inv)
 
515
 
 
516
        if timestamp == None:
 
517
            timestamp = time.time()
 
518
 
 
519
        if committer == None:
 
520
            committer = username()
 
521
 
 
522
        if timezone == None:
 
523
            timezone = local_time_offset()
 
524
 
 
525
        mutter("building commit log message")
 
526
        rev = Revision(timestamp=timestamp,
 
527
                       timezone=timezone,
 
528
                       committer=committer,
 
529
                       precursor = self.last_patch(),
 
530
                       message = message,
 
531
                       inventory_id=inv_id,
 
532
                       revision_id=rev_id)
 
533
 
 
534
        rev_tmp = tempfile.TemporaryFile()
 
535
        rev.write_xml(rev_tmp)
 
536
        rev_tmp.seek(0)
 
537
        self.revision_store.add(rev_tmp, rev_id)
 
538
        mutter("new revision_id is {%s}" % rev_id)
 
539
        
 
540
        ## XXX: Everything up to here can simply be orphaned if we abort
 
541
        ## the commit; it will leave junk files behind but that doesn't
 
542
        ## matter.
 
543
 
 
544
        ## TODO: Read back the just-generated changeset, and make sure it
 
545
        ## applies and recreates the right state.
 
546
 
 
547
        ## TODO: Also calculate and store the inventory SHA1
 
548
        mutter("committing patch r%d" % (self.revno() + 1))
 
549
 
 
550
        mutter("append to revision-history")
 
551
        f = self.controlfile('revision-history', 'at')
 
552
        f.write(rev_id + '\n')
 
553
        f.close()
 
554
 
 
555
        if verbose:
 
556
            note("commited r%d" % self.revno())
 
557
 
 
558
 
 
559
    def get_revision(self, revision_id):
 
560
        """Return the Revision object for a named revision"""
 
561
        r = Revision.read_xml(self.revision_store[revision_id])
 
562
        assert r.revision_id == revision_id
 
563
        return r
 
564
 
 
565
 
 
566
    def get_inventory(self, inventory_id):
 
567
        """Get Inventory object by hash.
 
568
 
 
569
        :todo: Perhaps for this and similar methods, take a revision
 
570
               parameter which can be either an integer revno or a
 
571
               string hash."""
 
572
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
573
        return i
 
574
 
 
575
 
 
576
    def get_revision_inventory(self, revision_id):
 
577
        """Return inventory of a past revision."""
 
578
        if revision_id == None:
 
579
            return Inventory()
 
580
        else:
 
581
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
582
 
 
583
 
 
584
    def revision_history(self):
 
585
        """Return sequence of revision hashes on to this branch.
 
586
 
 
587
        >>> ScratchBranch().revision_history()
 
588
        []
 
589
        """
 
590
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
 
591
 
 
592
 
 
593
    def revno(self):
 
594
        """Return current revision number for this branch.
 
595
 
 
596
        That is equivalent to the number of revisions committed to
 
597
        this branch.
 
598
 
 
599
        >>> b = ScratchBranch()
 
600
        >>> b.revno()
 
601
        0
 
602
        >>> b.commit('no foo')
 
603
        >>> b.revno()
 
604
        1
 
605
        """
 
606
        return len(self.revision_history())
 
607
 
 
608
 
 
609
    def last_patch(self):
 
610
        """Return last patch hash, or None if no history.
 
611
 
 
612
        >>> ScratchBranch().last_patch() == None
 
613
        True
 
614
        """
 
615
        ph = self.revision_history()
 
616
        if ph:
 
617
            return ph[-1]
 
618
 
 
619
 
 
620
    def lookup_revision(self, revno):
 
621
        """Return revision hash for revision number."""
 
622
        if revno == 0:
 
623
            return None
 
624
 
 
625
        try:
 
626
            # list is 0-based; revisions are 1-based
 
627
            return self.revision_history()[revno-1]
 
628
        except IndexError:
 
629
            bailout("no such revision %s" % revno)
 
630
 
 
631
 
 
632
    def revision_tree(self, revision_id):
 
633
        """Return Tree for a revision on this branch.
 
634
 
 
635
        `revision_id` may be None for the null revision, in which case
 
636
        an `EmptyTree` is returned."""
 
637
 
 
638
        if revision_id == None:
 
639
            return EmptyTree()
 
640
        else:
 
641
            inv = self.get_revision_inventory(revision_id)
 
642
            return RevisionTree(self.text_store, inv)
 
643
 
 
644
 
 
645
    def working_tree(self):
 
646
        """Return a `Tree` for the working copy."""
 
647
        return WorkingTree(self.base, self.read_working_inventory())
 
648
 
 
649
 
 
650
    def basis_tree(self):
 
651
        """Return `Tree` object for last revision.
 
652
 
 
653
        If there are no revisions yet, return an `EmptyTree`.
 
654
 
 
655
        >>> b = ScratchBranch(files=['foo'])
 
656
        >>> b.basis_tree().has_filename('foo')
 
657
        False
 
658
        >>> b.working_tree().has_filename('foo')
 
659
        True
 
660
        >>> b.add('foo')
 
661
        >>> b.commit('add foo')
 
662
        >>> b.basis_tree().has_filename('foo')
 
663
        True
 
664
        """
 
665
        r = self.last_patch()
 
666
        if r == None:
 
667
            return EmptyTree()
 
668
        else:
 
669
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
670
 
 
671
 
 
672
 
 
673
    def write_log(self, show_timezone='original'):
 
674
        """Write out human-readable log of commits to this branch
 
675
 
 
676
        :param utc: If true, show dates in universal time, not local time."""
 
677
        ## TODO: Option to choose either original, utc or local timezone
 
678
        revno = 1
 
679
        precursor = None
 
680
        for p in self.revision_history():
 
681
            print '-' * 40
 
682
            print 'revno:', revno
 
683
            ## TODO: Show hash if --id is given.
 
684
            ##print 'revision-hash:', p
 
685
            rev = self.get_revision(p)
 
686
            print 'committer:', rev.committer
 
687
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
688
                                                 show_timezone))
 
689
 
 
690
            ## opportunistic consistency check, same as check_patch_chaining
 
691
            if rev.precursor != precursor:
 
692
                bailout("mismatched precursor!")
 
693
 
 
694
            print 'message:'
 
695
            if not rev.message:
 
696
                print '  (no message)'
 
697
            else:
 
698
                for l in rev.message.split('\n'):
 
699
                    print '  ' + l
 
700
 
 
701
            revno += 1
 
702
            precursor = p
 
703
 
 
704
 
 
705
    def rename_one(self, from_rel, to_rel):
 
706
        tree = self.working_tree()
 
707
        inv = tree.inventory
 
708
        if not tree.has_filename(from_rel):
 
709
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
710
        if tree.has_filename(to_rel):
 
711
            bailout("can't rename: new working file %r already exists" % to_rel)
 
712
            
 
713
        file_id = inv.path2id(from_rel)
 
714
        if file_id == None:
 
715
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
716
 
 
717
        if inv.path2id(to_rel):
 
718
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
719
 
 
720
        to_dir, to_tail = os.path.split(to_rel)
 
721
        to_dir_id = inv.path2id(to_dir)
 
722
        if to_dir_id == None and to_dir != '':
 
723
            bailout("can't determine destination directory id for %r" % to_dir)
 
724
 
 
725
        mutter("rename_one:")
 
726
        mutter("  file_id    {%s}" % file_id)
 
727
        mutter("  from_rel   %r" % from_rel)
 
728
        mutter("  to_rel     %r" % to_rel)
 
729
        mutter("  to_dir     %r" % to_dir)
 
730
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
731
            
 
732
        inv.rename(file_id, to_dir_id, to_tail)
 
733
 
 
734
        print "%s => %s" % (from_rel, to_rel)
 
735
        
 
736
        from_abs = self.abspath(from_rel)
 
737
        to_abs = self.abspath(to_rel)
 
738
        try:
 
739
            os.rename(from_abs, to_abs)
 
740
        except OSError, e:
 
741
            bailout("failed to rename %r to %r: %s"
 
742
                    % (from_abs, to_abs, e[1]),
 
743
                    ["rename rolled back"])
 
744
 
 
745
        self._write_inventory(inv)
 
746
            
 
747
 
 
748
 
 
749
    def move(self, from_paths, to_name):
 
750
        """Rename files.
 
751
 
 
752
        to_name must exist as a versioned directory.
 
753
 
 
754
        If to_name exists and is a directory, the files are moved into
 
755
        it, keeping their old names.  If it is a directory, 
 
756
 
 
757
        Note that to_name is only the last component of the new name;
 
758
        this doesn't change the directory.
 
759
        """
 
760
        ## TODO: Option to move IDs only
 
761
        assert not isinstance(from_paths, basestring)
 
762
        tree = self.working_tree()
 
763
        inv = tree.inventory
 
764
        to_abs = self.abspath(to_name)
 
765
        if not isdir(to_abs):
 
766
            bailout("destination %r is not a directory" % to_abs)
 
767
        if not tree.has_filename(to_name):
 
768
            bailout("destination %r is not a versioned directory" % to_abs)
 
769
        to_dir_id = inv.path2id(to_name)
 
770
        if to_dir_id == None and to_name != '':
 
771
            bailout("destination %r is not a versioned directory" % to_name)
 
772
        to_dir_ie = inv[to_dir_id]
 
773
        if to_dir_ie.kind != 'directory':
 
774
            bailout("destination %r is not a versioned directory" % to_abs)
 
775
 
 
776
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
777
 
 
778
        for f in from_paths:
 
779
            if not tree.has_filename(f):
 
780
                bailout("%r does not exist in working tree" % f)
 
781
            f_id = inv.path2id(f)
 
782
            if f_id == None:
 
783
                bailout("%r is not versioned" % f)
 
784
            name_tail = splitpath(f)[-1]
 
785
            dest_path = appendpath(to_name, name_tail)
 
786
            if tree.has_filename(dest_path):
 
787
                bailout("destination %r already exists" % dest_path)
 
788
            if f_id in to_idpath:
 
789
                bailout("can't move %r to a subdirectory of itself" % f)
 
790
 
 
791
        # OK, so there's a race here, it's possible that someone will
 
792
        # create a file in this interval and then the rename might be
 
793
        # left half-done.  But we should have caught most problems.
 
794
 
 
795
        for f in from_paths:
 
796
            name_tail = splitpath(f)[-1]
 
797
            dest_path = appendpath(to_name, name_tail)
 
798
            print "%s => %s" % (f, dest_path)
 
799
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
800
            try:
 
801
                os.rename(self.abspath(f), self.abspath(dest_path))
 
802
            except OSError, e:
 
803
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
804
                        ["rename rolled back"])
 
805
 
 
806
        self._write_inventory(inv)
 
807
 
 
808
 
 
809
 
 
810
    def show_status(branch, show_all=False):
 
811
        """Display single-line status for non-ignored working files.
 
812
 
 
813
        The list is show sorted in order by file name.
 
814
 
 
815
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
816
        >>> b.show_status()
 
817
        ?       foo
 
818
        >>> b.add('foo')
 
819
        >>> b.show_status()
 
820
        A       foo
 
821
        >>> b.commit("add foo")
 
822
        >>> b.show_status()
 
823
        >>> os.unlink(b.abspath('foo'))
 
824
        >>> b.show_status()
 
825
        D       foo
 
826
        
 
827
 
 
828
        :todo: Get state for single files.
 
829
 
 
830
        :todo: Perhaps show a slash at the end of directory names.        
 
831
 
 
832
        """
 
833
 
 
834
        # We have to build everything into a list first so that it can
 
835
        # sorted by name, incorporating all the different sources.
 
836
 
 
837
        # FIXME: Rather than getting things in random order and then sorting,
 
838
        # just step through in order.
 
839
 
 
840
        # Interesting case: the old ID for a file has been removed,
 
841
        # but a new file has been created under that name.
 
842
 
 
843
        old = branch.basis_tree()
 
844
        old_inv = old.inventory
 
845
        new = branch.working_tree()
 
846
        new_inv = new.inventory
 
847
 
 
848
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
849
            if fs == 'R':
 
850
                show_status(fs, kind,
 
851
                            oldname + ' => ' + newname)
 
852
            elif fs == 'A' or fs == 'M':
 
853
                show_status(fs, kind, newname)
 
854
            elif fs == 'D':
 
855
                show_status(fs, kind, oldname)
 
856
            elif fs == '.':
 
857
                if show_all:
 
858
                    show_status(fs, kind, newname)
 
859
            elif fs == 'I':
 
860
                if show_all:
 
861
                    show_status(fs, kind, newname)
 
862
            elif fs == '?':
 
863
                show_status(fs, kind, newname)
 
864
            else:
 
865
                bailout("wierd file state %r" % ((fs, fid),))
 
866
                
 
867
 
 
868
 
 
869
class ScratchBranch(Branch):
 
870
    """Special test class: a branch that cleans up after itself.
 
871
 
 
872
    >>> b = ScratchBranch()
 
873
    >>> isdir(b.base)
 
874
    True
 
875
    >>> bd = b.base
 
876
    >>> del b
 
877
    >>> isdir(bd)
 
878
    False
 
879
    """
 
880
    def __init__(self, files=[], dirs=[]):
 
881
        """Make a test branch.
 
882
 
 
883
        This creates a temporary directory and runs init-tree in it.
 
884
 
 
885
        If any files are listed, they are created in the working copy.
 
886
        """
 
887
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
888
        for d in dirs:
 
889
            os.mkdir(self.abspath(d))
 
890
            
 
891
        for f in files:
 
892
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
893
 
 
894
 
 
895
    def __del__(self):
 
896
        """Destroy the test branch, removing the scratch directory."""
 
897
        try:
 
898
            shutil.rmtree(self.base)
 
899
        except OSError:
 
900
            # Work around for shutil.rmtree failing on Windows when
 
901
            # readonly files are encountered
 
902
            for root, dirs, files in os.walk(self.base, topdown=False):
 
903
                for name in files:
 
904
                    os.chmod(os.path.join(root, name), 0700)
 
905
            shutil.rmtree(self.base)
 
906
 
 
907
    
 
908
 
 
909
######################################################################
 
910
# predicates
 
911
 
 
912
 
 
913
def is_control_file(filename):
 
914
    ## FIXME: better check
 
915
    filename = os.path.normpath(filename)
 
916
    while filename != '':
 
917
        head, tail = os.path.split(filename)
 
918
        ## mutter('check %r for control file' % ((head, tail), ))
 
919
        if tail == bzrlib.BZRDIR:
 
920
            return True
 
921
        if filename == head:
 
922
            break
 
923
        filename = head
 
924
    return False
 
925
 
 
926
 
 
927
 
 
928
def _gen_revision_id(when):
 
929
    """Return new revision-id."""
 
930
    s = '%s-%s-' % (user_email(), compact_date(when))
 
931
    s += hexlify(rand_bytes(12))
 
932
    return s
 
933
 
 
934
 
 
935
def gen_file_id(name):
 
936
    """Return new file id.
 
937
 
 
938
    This should probably generate proper UUIDs, but for the moment we
 
939
    cope with just randomness because running uuidgen every time is
 
940
    slow."""
 
941
    idx = name.rfind('/')
 
942
    if idx != -1:
 
943
        name = name[idx+1 : ]
 
944
 
 
945
    name = name.lstrip('.')
 
946
 
 
947
    s = hexlify(rand_bytes(12))
 
948
    return '-'.join((name, compact_date(time.time()), s))
 
949
 
 
950