/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: Martin Pool
  • Date: 2005-05-06 03:20:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050506032014-decf4918803147d2
- split out notes on storing annotations in revfiles

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