/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-13 04:07:00 UTC
  • Revision ID: mbp@sourcefrog.net-20050413040700-cd67a1265f4e8af9
- control files always in utf-8-unix format
- command line arguments interpreted as locale encoding

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