/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-10 04:32:39 UTC
  • Revision ID: mbp@sourcefrog.net-20050510043239-d866ce1a4f472b7f
- Skip symlinks during recursive add (path from aaron)

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