/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-05 06:21:22 UTC
  • Revision ID: mbp@sourcefrog.net-20050505062122-2043480e9e439807
- use cgitb to get more detailed traceback in the 
  trace file

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