/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-06 02:20:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050406022039-dfbff590495c81193a32fd8b
- better output from test.sh- test.sh exercises cat command (currently broken)

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
    def print_file(self, file, revno):
 
305
        """Print `file` to stdout."""
 
306
        tree = self.revision_tree(self.lookup_revision(revno))
 
307
        tree.print_file(self.inventory.path2id(file))
 
308
        
 
309
 
 
310
    def remove(self, files, verbose=False):
 
311
        """Mark nominated files for removal from the inventory.
 
312
 
 
313
        This does not remove their text.  This does not run on 
 
314
 
 
315
        :todo: Refuse to remove modified files unless --force is given?
 
316
 
 
317
        >>> b = ScratchBranch(files=['foo'])
 
318
        >>> b.add('foo')
 
319
        >>> b.inventory.has_filename('foo')
 
320
        True
 
321
        >>> b.remove('foo')
 
322
        >>> b.working_tree().has_filename('foo')
 
323
        True
 
324
        >>> b.inventory.has_filename('foo')
 
325
        False
 
326
        
 
327
        >>> b = ScratchBranch(files=['foo'])
 
328
        >>> b.add('foo')
 
329
        >>> b.commit('one')
 
330
        >>> b.remove('foo')
 
331
        >>> b.commit('two')
 
332
        >>> b.inventory.has_filename('foo') 
 
333
        False
 
334
        >>> b.basis_tree().has_filename('foo') 
 
335
        False
 
336
        >>> b.working_tree().has_filename('foo') 
 
337
        True
 
338
 
 
339
        :todo: Do something useful with directories.
 
340
 
 
341
        :todo: Should this remove the text or not?  Tough call; not
 
342
        removing may be useful and the user can just use use rm, and
 
343
        is the opposite of add.  Removing it is consistent with most
 
344
        other tools.  Maybe an option.
 
345
        """
 
346
        ## TODO: Normalize names
 
347
        ## TODO: Remove nested loops; better scalability
 
348
 
 
349
        if isinstance(files, types.StringTypes):
 
350
            files = [files]
 
351
        
 
352
        tree = self.working_tree()
 
353
        inv = tree.inventory
 
354
 
 
355
        # do this before any modifications
 
356
        for f in files:
 
357
            fid = inv.path2id(f)
 
358
            if not fid:
 
359
                bailout("cannot remove unversioned file %s" % quotefn(f))
 
360
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
361
            if verbose:
 
362
                # having remove it, it must be either ignored or unknown
 
363
                if tree.is_ignored(f):
 
364
                    new_status = 'I'
 
365
                else:
 
366
                    new_status = '?'
 
367
                show_status(new_status, inv[fid].kind, quotefn(f))
 
368
            del inv[fid]
 
369
 
 
370
        self._write_inventory(inv)
 
371
 
 
372
 
 
373
    def unknowns(self):
 
374
        """Return all unknown files.
 
375
 
 
376
        These are files in the working directory that are not versioned or
 
377
        control files or ignored.
 
378
        
 
379
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
380
        >>> list(b.unknowns())
 
381
        ['foo']
 
382
        >>> b.add('foo')
 
383
        >>> list(b.unknowns())
 
384
        []
 
385
        >>> b.remove('foo')
 
386
        >>> list(b.unknowns())
 
387
        ['foo']
 
388
        """
 
389
        return self.working_tree().unknowns()
 
390
 
 
391
 
 
392
    def commit(self, message, timestamp=None, timezone=None,
 
393
               committer=None,
 
394
               verbose=False):
 
395
        """Commit working copy as a new revision.
 
396
        
 
397
        The basic approach is to add all the file texts into the
 
398
        store, then the inventory, then make a new revision pointing
 
399
        to that inventory and store that.
 
400
        
 
401
        This is not quite safe if the working copy changes during the
 
402
        commit; for the moment that is simply not allowed.  A better
 
403
        approach is to make a temporary copy of the files before
 
404
        computing their hashes, and then add those hashes in turn to
 
405
        the inventory.  This should mean at least that there are no
 
406
        broken hash pointers.  There is no way we can get a snapshot
 
407
        of the whole directory at an instant.  This would also have to
 
408
        be robust against files disappearing, moving, etc.  So the
 
409
        whole thing is a bit hard.
 
410
 
 
411
        :param timestamp: if not None, seconds-since-epoch for a
 
412
             postdated/predated commit.
 
413
        """
 
414
 
 
415
        ## TODO: Show branch names
 
416
 
 
417
        # TODO: Don't commit if there are no changes, unless forced?
 
418
 
 
419
        # First walk over the working inventory; and both update that
 
420
        # and also build a new revision inventory.  The revision
 
421
        # inventory needs to hold the text-id, sha1 and size of the
 
422
        # actual file versions committed in the revision.  (These are
 
423
        # not present in the working inventory.)  We also need to
 
424
        # detect missing/deleted files, and remove them from the
 
425
        # working inventory.
 
426
 
 
427
        work_inv = self.read_working_inventory()
 
428
        inv = Inventory()
 
429
        basis = self.basis_tree()
 
430
        basis_inv = basis.inventory
 
431
        missing_ids = []
 
432
        for path, entry in work_inv.iter_entries():
 
433
            ## TODO: Cope with files that have gone missing.
 
434
 
 
435
            ## TODO: Check that the file kind has not changed from the previous
 
436
            ## revision of this file (if any).
 
437
 
 
438
            entry = entry.copy()
 
439
 
 
440
            p = self.abspath(path)
 
441
            file_id = entry.file_id
 
442
            mutter('commit prep file %s, id %r ' % (p, file_id))
 
443
 
 
444
            if not os.path.exists(p):
 
445
                mutter("    file is missing, removing from inventory")
 
446
                if verbose:
 
447
                    show_status('D', entry.kind, quotefn(path))
 
448
                missing_ids.append(file_id)
 
449
                continue
 
450
 
 
451
            # TODO: Handle files that have been deleted
 
452
 
 
453
            # TODO: Maybe a special case for empty files?  Seems a
 
454
            # waste to store them many times.
 
455
 
 
456
            inv.add(entry)
 
457
 
 
458
            if basis_inv.has_id(file_id):
 
459
                old_kind = basis_inv[file_id].kind
 
460
                if old_kind != entry.kind:
 
461
                    bailout("entry %r changed kind from %r to %r"
 
462
                            % (file_id, old_kind, entry.kind))
 
463
 
 
464
            if entry.kind == 'directory':
 
465
                if not isdir(p):
 
466
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
 
467
            elif entry.kind == 'file':
 
468
                if not isfile(p):
 
469
                    bailout("%s is entered as file but is not a file" % quotefn(p))
 
470
 
 
471
                content = file(p, 'rb').read()
 
472
 
 
473
                entry.text_sha1 = sha_string(content)
 
474
                entry.text_size = len(content)
 
475
 
 
476
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
477
                if (old_ie
 
478
                    and (old_ie.text_size == entry.text_size)
 
479
                    and (old_ie.text_sha1 == entry.text_sha1)):
 
480
                    ## assert content == basis.get_file(file_id).read()
 
481
                    entry.text_id = basis_inv[file_id].text_id
 
482
                    mutter('    unchanged from previous text_id {%s}' %
 
483
                           entry.text_id)
 
484
                    
 
485
                else:
 
486
                    entry.text_id = gen_file_id(entry.name)
 
487
                    self.text_store.add(content, entry.text_id)
 
488
                    mutter('    stored with text_id {%s}' % entry.text_id)
 
489
                    if verbose:
 
490
                        if not old_ie:
 
491
                            state = 'A'
 
492
                        elif (old_ie.name == entry.name
 
493
                              and old_ie.parent_id == entry.parent_id):
 
494
                            state = 'M'
 
495
                        else:
 
496
                            state = 'R'
 
497
 
 
498
                        show_status(state, entry.kind, quotefn(path))
 
499
 
 
500
        for file_id in missing_ids:
 
501
            # have to do this later so we don't mess up the iterator.
 
502
            # since parents may be removed before their children we
 
503
            # have to test.
 
504
 
 
505
            # FIXME: There's probably a better way to do this; perhaps
 
506
            # the workingtree should know how to filter itself.
 
507
            if work_inv.has_id(file_id):
 
508
                del work_inv[file_id]
 
509
 
 
510
 
 
511
        inv_id = rev_id = _gen_revision_id(time.time())
 
512
        
 
513
        inv_tmp = tempfile.TemporaryFile()
 
514
        inv.write_xml(inv_tmp)
 
515
        inv_tmp.seek(0)
 
516
        self.inventory_store.add(inv_tmp, inv_id)
 
517
        mutter('new inventory_id is {%s}' % inv_id)
 
518
 
 
519
        self._write_inventory(work_inv)
 
520
 
 
521
        if timestamp == None:
 
522
            timestamp = time.time()
 
523
 
 
524
        if committer == None:
 
525
            committer = username()
 
526
 
 
527
        if timezone == None:
 
528
            timezone = local_time_offset()
 
529
 
 
530
        mutter("building commit log message")
 
531
        rev = Revision(timestamp=timestamp,
 
532
                       timezone=timezone,
 
533
                       committer=committer,
 
534
                       precursor = self.last_patch(),
 
535
                       message = message,
 
536
                       inventory_id=inv_id,
 
537
                       revision_id=rev_id)
 
538
 
 
539
        rev_tmp = tempfile.TemporaryFile()
 
540
        rev.write_xml(rev_tmp)
 
541
        rev_tmp.seek(0)
 
542
        self.revision_store.add(rev_tmp, rev_id)
 
543
        mutter("new revision_id is {%s}" % rev_id)
 
544
        
 
545
        ## XXX: Everything up to here can simply be orphaned if we abort
 
546
        ## the commit; it will leave junk files behind but that doesn't
 
547
        ## matter.
 
548
 
 
549
        ## TODO: Read back the just-generated changeset, and make sure it
 
550
        ## applies and recreates the right state.
 
551
 
 
552
        ## TODO: Also calculate and store the inventory SHA1
 
553
        mutter("committing patch r%d" % (self.revno() + 1))
 
554
 
 
555
        mutter("append to revision-history")
 
556
        f = self.controlfile('revision-history', 'at')
 
557
        f.write(rev_id + '\n')
 
558
        f.close()
 
559
 
 
560
        if verbose:
 
561
            note("commited r%d" % self.revno())
 
562
 
 
563
 
 
564
    def get_revision(self, revision_id):
 
565
        """Return the Revision object for a named revision"""
 
566
        r = Revision.read_xml(self.revision_store[revision_id])
 
567
        assert r.revision_id == revision_id
 
568
        return r
 
569
 
 
570
 
 
571
    def get_inventory(self, inventory_id):
 
572
        """Get Inventory object by hash.
 
573
 
 
574
        :todo: Perhaps for this and similar methods, take a revision
 
575
               parameter which can be either an integer revno or a
 
576
               string hash."""
 
577
        i = Inventory.read_xml(self.inventory_store[inventory_id])
 
578
        return i
 
579
 
 
580
 
 
581
    def get_revision_inventory(self, revision_id):
 
582
        """Return inventory of a past revision."""
 
583
        if revision_id == None:
 
584
            return Inventory()
 
585
        else:
 
586
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
 
587
 
 
588
 
 
589
    def revision_history(self):
 
590
        """Return sequence of revision hashes on to this branch.
 
591
 
 
592
        >>> ScratchBranch().revision_history()
 
593
        []
 
594
        """
 
595
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
 
596
 
 
597
 
 
598
    def revno(self):
 
599
        """Return current revision number for this branch.
 
600
 
 
601
        That is equivalent to the number of revisions committed to
 
602
        this branch.
 
603
 
 
604
        >>> b = ScratchBranch()
 
605
        >>> b.revno()
 
606
        0
 
607
        >>> b.commit('no foo')
 
608
        >>> b.revno()
 
609
        1
 
610
        """
 
611
        return len(self.revision_history())
 
612
 
 
613
 
 
614
    def last_patch(self):
 
615
        """Return last patch hash, or None if no history.
 
616
 
 
617
        >>> ScratchBranch().last_patch() == None
 
618
        True
 
619
        """
 
620
        ph = self.revision_history()
 
621
        if ph:
 
622
            return ph[-1]
 
623
 
 
624
 
 
625
    def lookup_revision(self, revno):
 
626
        """Return revision hash for revision number."""
 
627
        if revno == 0:
 
628
            return None
 
629
 
 
630
        try:
 
631
            # list is 0-based; revisions are 1-based
 
632
            return self.revision_history()[revno-1]
 
633
        except IndexError:
 
634
            bailout("no such revision %s" % revno)
 
635
 
 
636
 
 
637
    def revision_tree(self, revision_id):
 
638
        """Return Tree for a revision on this branch.
 
639
 
 
640
        `revision_id` may be None for the null revision, in which case
 
641
        an `EmptyTree` is returned."""
 
642
 
 
643
        if revision_id == None:
 
644
            return EmptyTree()
 
645
        else:
 
646
            inv = self.get_revision_inventory(revision_id)
 
647
            return RevisionTree(self.text_store, inv)
 
648
 
 
649
 
 
650
    def working_tree(self):
 
651
        """Return a `Tree` for the working copy."""
 
652
        return WorkingTree(self.base, self.read_working_inventory())
 
653
 
 
654
 
 
655
    def basis_tree(self):
 
656
        """Return `Tree` object for last revision.
 
657
 
 
658
        If there are no revisions yet, return an `EmptyTree`.
 
659
 
 
660
        >>> b = ScratchBranch(files=['foo'])
 
661
        >>> b.basis_tree().has_filename('foo')
 
662
        False
 
663
        >>> b.working_tree().has_filename('foo')
 
664
        True
 
665
        >>> b.add('foo')
 
666
        >>> b.commit('add foo')
 
667
        >>> b.basis_tree().has_filename('foo')
 
668
        True
 
669
        """
 
670
        r = self.last_patch()
 
671
        if r == None:
 
672
            return EmptyTree()
 
673
        else:
 
674
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
 
675
 
 
676
 
 
677
 
 
678
    def write_log(self, show_timezone='original'):
 
679
        """Write out human-readable log of commits to this branch
 
680
 
 
681
        :param utc: If true, show dates in universal time, not local time."""
 
682
        ## TODO: Option to choose either original, utc or local timezone
 
683
        revno = 1
 
684
        precursor = None
 
685
        for p in self.revision_history():
 
686
            print '-' * 40
 
687
            print 'revno:', revno
 
688
            ## TODO: Show hash if --id is given.
 
689
            ##print 'revision-hash:', p
 
690
            rev = self.get_revision(p)
 
691
            print 'committer:', rev.committer
 
692
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
 
693
                                                 show_timezone))
 
694
 
 
695
            ## opportunistic consistency check, same as check_patch_chaining
 
696
            if rev.precursor != precursor:
 
697
                bailout("mismatched precursor!")
 
698
 
 
699
            print 'message:'
 
700
            if not rev.message:
 
701
                print '  (no message)'
 
702
            else:
 
703
                for l in rev.message.split('\n'):
 
704
                    print '  ' + l
 
705
 
 
706
            revno += 1
 
707
            precursor = p
 
708
 
 
709
 
 
710
    def rename_one(self, from_rel, to_rel):
 
711
        tree = self.working_tree()
 
712
        inv = tree.inventory
 
713
        if not tree.has_filename(from_rel):
 
714
            bailout("can't rename: old working file %r does not exist" % from_rel)
 
715
        if tree.has_filename(to_rel):
 
716
            bailout("can't rename: new working file %r already exists" % to_rel)
 
717
            
 
718
        file_id = inv.path2id(from_rel)
 
719
        if file_id == None:
 
720
            bailout("can't rename: old name %r is not versioned" % from_rel)
 
721
 
 
722
        if inv.path2id(to_rel):
 
723
            bailout("can't rename: new name %r is already versioned" % to_rel)
 
724
 
 
725
        to_dir, to_tail = os.path.split(to_rel)
 
726
        to_dir_id = inv.path2id(to_dir)
 
727
        if to_dir_id == None and to_dir != '':
 
728
            bailout("can't determine destination directory id for %r" % to_dir)
 
729
 
 
730
        mutter("rename_one:")
 
731
        mutter("  file_id    {%s}" % file_id)
 
732
        mutter("  from_rel   %r" % from_rel)
 
733
        mutter("  to_rel     %r" % to_rel)
 
734
        mutter("  to_dir     %r" % to_dir)
 
735
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
736
            
 
737
        inv.rename(file_id, to_dir_id, to_tail)
 
738
 
 
739
        print "%s => %s" % (from_rel, to_rel)
 
740
        
 
741
        from_abs = self.abspath(from_rel)
 
742
        to_abs = self.abspath(to_rel)
 
743
        try:
 
744
            os.rename(from_abs, to_abs)
 
745
        except OSError, e:
 
746
            bailout("failed to rename %r to %r: %s"
 
747
                    % (from_abs, to_abs, e[1]),
 
748
                    ["rename rolled back"])
 
749
 
 
750
        self._write_inventory(inv)
 
751
            
 
752
 
 
753
 
 
754
    def move(self, from_paths, to_name):
 
755
        """Rename files.
 
756
 
 
757
        to_name must exist as a versioned directory.
 
758
 
 
759
        If to_name exists and is a directory, the files are moved into
 
760
        it, keeping their old names.  If it is a directory, 
 
761
 
 
762
        Note that to_name is only the last component of the new name;
 
763
        this doesn't change the directory.
 
764
        """
 
765
        ## TODO: Option to move IDs only
 
766
        assert not isinstance(from_paths, basestring)
 
767
        tree = self.working_tree()
 
768
        inv = tree.inventory
 
769
        to_abs = self.abspath(to_name)
 
770
        if not isdir(to_abs):
 
771
            bailout("destination %r is not a directory" % to_abs)
 
772
        if not tree.has_filename(to_name):
 
773
            bailout("destination %r not in working directory" % to_abs)
 
774
        to_dir_id = inv.path2id(to_name)
 
775
        if to_dir_id == None and to_name != '':
 
776
            bailout("destination %r is not a versioned directory" % to_name)
 
777
        to_dir_ie = inv[to_dir_id]
 
778
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
779
            bailout("destination %r is not a directory" % to_abs)
 
780
 
 
781
        to_idpath = Set(inv.get_idpath(to_dir_id))
 
782
 
 
783
        for f in from_paths:
 
784
            if not tree.has_filename(f):
 
785
                bailout("%r does not exist in working tree" % f)
 
786
            f_id = inv.path2id(f)
 
787
            if f_id == None:
 
788
                bailout("%r is not versioned" % f)
 
789
            name_tail = splitpath(f)[-1]
 
790
            dest_path = appendpath(to_name, name_tail)
 
791
            if tree.has_filename(dest_path):
 
792
                bailout("destination %r already exists" % dest_path)
 
793
            if f_id in to_idpath:
 
794
                bailout("can't move %r to a subdirectory of itself" % f)
 
795
 
 
796
        # OK, so there's a race here, it's possible that someone will
 
797
        # create a file in this interval and then the rename might be
 
798
        # left half-done.  But we should have caught most problems.
 
799
 
 
800
        for f in from_paths:
 
801
            name_tail = splitpath(f)[-1]
 
802
            dest_path = appendpath(to_name, name_tail)
 
803
            print "%s => %s" % (f, dest_path)
 
804
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
805
            try:
 
806
                os.rename(self.abspath(f), self.abspath(dest_path))
 
807
            except OSError, e:
 
808
                bailout("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
809
                        ["rename rolled back"])
 
810
 
 
811
        self._write_inventory(inv)
 
812
 
 
813
 
 
814
 
 
815
    def show_status(branch, show_all=False):
 
816
        """Display single-line status for non-ignored working files.
 
817
 
 
818
        The list is show sorted in order by file name.
 
819
 
 
820
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
821
        >>> b.show_status()
 
822
        ?       foo
 
823
        >>> b.add('foo')
 
824
        >>> b.show_status()
 
825
        A       foo
 
826
        >>> b.commit("add foo")
 
827
        >>> b.show_status()
 
828
        >>> os.unlink(b.abspath('foo'))
 
829
        >>> b.show_status()
 
830
        D       foo
 
831
        
 
832
 
 
833
        :todo: Get state for single files.
 
834
 
 
835
        :todo: Perhaps show a slash at the end of directory names.        
 
836
 
 
837
        """
 
838
 
 
839
        # We have to build everything into a list first so that it can
 
840
        # sorted by name, incorporating all the different sources.
 
841
 
 
842
        # FIXME: Rather than getting things in random order and then sorting,
 
843
        # just step through in order.
 
844
 
 
845
        # Interesting case: the old ID for a file has been removed,
 
846
        # but a new file has been created under that name.
 
847
 
 
848
        old = branch.basis_tree()
 
849
        old_inv = old.inventory
 
850
        new = branch.working_tree()
 
851
        new_inv = new.inventory
 
852
 
 
853
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
 
854
            if fs == 'R':
 
855
                show_status(fs, kind,
 
856
                            oldname + ' => ' + newname)
 
857
            elif fs == 'A' or fs == 'M':
 
858
                show_status(fs, kind, newname)
 
859
            elif fs == 'D':
 
860
                show_status(fs, kind, oldname)
 
861
            elif fs == '.':
 
862
                if show_all:
 
863
                    show_status(fs, kind, newname)
 
864
            elif fs == 'I':
 
865
                if show_all:
 
866
                    show_status(fs, kind, newname)
 
867
            elif fs == '?':
 
868
                show_status(fs, kind, newname)
 
869
            else:
 
870
                bailout("wierd file state %r" % ((fs, fid),))
 
871
                
 
872
 
 
873
 
 
874
class ScratchBranch(Branch):
 
875
    """Special test class: a branch that cleans up after itself.
 
876
 
 
877
    >>> b = ScratchBranch()
 
878
    >>> isdir(b.base)
 
879
    True
 
880
    >>> bd = b.base
 
881
    >>> del b
 
882
    >>> isdir(bd)
 
883
    False
 
884
    """
 
885
    def __init__(self, files=[], dirs=[]):
 
886
        """Make a test branch.
 
887
 
 
888
        This creates a temporary directory and runs init-tree in it.
 
889
 
 
890
        If any files are listed, they are created in the working copy.
 
891
        """
 
892
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
893
        for d in dirs:
 
894
            os.mkdir(self.abspath(d))
 
895
            
 
896
        for f in files:
 
897
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
898
 
 
899
 
 
900
    def __del__(self):
 
901
        """Destroy the test branch, removing the scratch directory."""
 
902
        try:
 
903
            shutil.rmtree(self.base)
 
904
        except OSError:
 
905
            # Work around for shutil.rmtree failing on Windows when
 
906
            # readonly files are encountered
 
907
            for root, dirs, files in os.walk(self.base, topdown=False):
 
908
                for name in files:
 
909
                    os.chmod(os.path.join(root, name), 0700)
 
910
            shutil.rmtree(self.base)
 
911
 
 
912
    
 
913
 
 
914
######################################################################
 
915
# predicates
 
916
 
 
917
 
 
918
def is_control_file(filename):
 
919
    ## FIXME: better check
 
920
    filename = os.path.normpath(filename)
 
921
    while filename != '':
 
922
        head, tail = os.path.split(filename)
 
923
        ## mutter('check %r for control file' % ((head, tail), ))
 
924
        if tail == bzrlib.BZRDIR:
 
925
            return True
 
926
        if filename == head:
 
927
            break
 
928
        filename = head
 
929
    return False
 
930
 
 
931
 
 
932
 
 
933
def _gen_revision_id(when):
 
934
    """Return new revision-id."""
 
935
    s = '%s-%s-' % (user_email(), compact_date(when))
 
936
    s += hexlify(rand_bytes(12))
 
937
    return s
 
938
 
 
939
 
 
940
def gen_file_id(name):
 
941
    """Return new file id.
 
942
 
 
943
    This should probably generate proper UUIDs, but for the moment we
 
944
    cope with just randomness because running uuidgen every time is
 
945
    slow."""
 
946
    idx = name.rfind('/')
 
947
    if idx != -1:
 
948
        name = name[idx+1 : ]
 
949
 
 
950
    name = name.lstrip('.')
 
951
 
 
952
    s = hexlify(rand_bytes(12))
 
953
    return '-'.join((name, compact_date(time.time()), s))
 
954
 
 
955