/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

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
import sys
 
19
import os
 
20
import errno
 
21
from warnings import warn
 
22
from cStringIO import StringIO
 
23
 
 
24
 
 
25
import bzrlib
 
26
from bzrlib.inventory import InventoryEntry
 
27
import bzrlib.inventory as inventory
 
28
from bzrlib.trace import mutter, note
 
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes, 
 
30
                            rename, splitpath, sha_file, appendpath, 
 
31
                            file_kind)
 
32
import bzrlib.errors as errors
 
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError, UnlistableStore,
 
36
                           UnlistableBranch, NoSuchFile)
 
37
from bzrlib.textui import show_status
 
38
from bzrlib.revision import Revision
 
39
from bzrlib.delta import compare_trees
 
40
from bzrlib.tree import EmptyTree, RevisionTree
 
41
from bzrlib.inventory import Inventory
 
42
from bzrlib.store import copy_all
 
43
from bzrlib.store.compressed_text import CompressedTextStore
 
44
from bzrlib.store.text import TextStore
 
45
from bzrlib.store.weave import WeaveStore
 
46
import bzrlib.transactions as transactions
 
47
from bzrlib.transport import Transport, get_transport
 
48
import bzrlib.xml5
 
49
import bzrlib.ui
 
50
 
 
51
 
 
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
54
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
 
55
## TODO: Maybe include checks for common corruption of newlines, etc?
 
56
 
 
57
 
 
58
# TODO: Some operations like log might retrieve the same revisions
 
59
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
60
# cache in memory to make this faster.  In general anything can be
 
61
# cached in memory between lock and unlock operations.
 
62
 
 
63
def find_branch(*ignored, **ignored_too):
 
64
    # XXX: leave this here for about one release, then remove it
 
65
    raise NotImplementedError('find_branch() is not supported anymore, '
 
66
                              'please use one of the new branch constructors')
 
67
def _relpath(base, path):
 
68
    """Return path relative to base, or raise exception.
 
69
 
 
70
    The path may be either an absolute path or a path relative to the
 
71
    current working directory.
 
72
 
 
73
    Lifted out of Branch.relpath for ease of testing.
 
74
 
 
75
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
76
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
77
    avoids that problem."""
 
78
    rp = os.path.abspath(path)
 
79
 
 
80
    s = []
 
81
    head = rp
 
82
    while len(head) >= len(base):
 
83
        if head == base:
 
84
            break
 
85
        head, tail = os.path.split(head)
 
86
        if tail:
 
87
            s.insert(0, tail)
 
88
    else:
 
89
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
 
90
 
 
91
    return os.sep.join(s)
 
92
        
 
93
 
 
94
def find_branch_root(t):
 
95
    """Find the branch root enclosing the transport's base.
 
96
 
 
97
    t is a Transport object.
 
98
 
 
99
    It is not necessary that the base of t exists.
 
100
 
 
101
    Basically we keep looking up until we find the control directory or
 
102
    run into the root.  If there isn't one, raises NotBranchError.
 
103
    """
 
104
    orig_base = t.base
 
105
    while True:
 
106
        if t.has(bzrlib.BZRDIR):
 
107
            return t
 
108
        new_t = t.clone('..')
 
109
        if new_t.base == t.base:
 
110
            # reached the root, whatever that may be
 
111
            raise NotBranchError('%s is not in a branch' % orig_base)
 
112
        t = new_t
 
113
 
 
114
 
 
115
######################################################################
 
116
# branch objects
 
117
 
 
118
class Branch(object):
 
119
    """Branch holding a history of revisions.
 
120
 
 
121
    base
 
122
        Base directory/url of the branch.
 
123
    """
 
124
    base = None
 
125
 
 
126
    def __init__(self, *ignored, **ignored_too):
 
127
        raise NotImplementedError('The Branch class is abstract')
 
128
 
 
129
    @staticmethod
 
130
    def open_downlevel(base):
 
131
        """Open a branch which may be of an old format.
 
132
        
 
133
        Only local branches are supported."""
 
134
        return _Branch(get_transport(base), relax_version_check=True)
 
135
        
 
136
    @staticmethod
 
137
    def open(base):
 
138
        """Open an existing branch, rooted at 'base' (url)"""
 
139
        t = get_transport(base)
 
140
        mutter("trying to open %r with transport %r", base, t)
 
141
        return _Branch(t)
 
142
 
 
143
    @staticmethod
 
144
    def open_containing(url):
 
145
        """Open an existing branch which contains url.
 
146
        
 
147
        This probes for a branch at url, and searches upwards from there.
 
148
        """
 
149
        t = get_transport(url)
 
150
        t = find_branch_root(t)
 
151
        return _Branch(t)
 
152
 
 
153
    @staticmethod
 
154
    def initialize(base):
 
155
        """Create a new branch, rooted at 'base' (url)"""
 
156
        t = get_transport(base)
 
157
        return _Branch(t, init=True)
 
158
 
 
159
    def setup_caching(self, cache_root):
 
160
        """Subclasses that care about caching should override this, and set
 
161
        up cached stores located under cache_root.
 
162
        """
 
163
        self.cache_root = cache_root
 
164
 
 
165
 
 
166
class _Branch(Branch):
 
167
    """A branch stored in the actual filesystem.
 
168
 
 
169
    Note that it's "local" in the context of the filesystem; it doesn't
 
170
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
171
    it's writable, and can be accessed via the normal filesystem API.
 
172
 
 
173
    _lock_mode
 
174
        None, or 'r' or 'w'
 
175
 
 
176
    _lock_count
 
177
        If _lock_mode is true, a positive count of the number of times the
 
178
        lock has been taken.
 
179
 
 
180
    _lock
 
181
        Lock object from bzrlib.lock.
 
182
    """
 
183
    # We actually expect this class to be somewhat short-lived; part of its
 
184
    # purpose is to try to isolate what bits of the branch logic are tied to
 
185
    # filesystem access, so that in a later step, we can extricate them to
 
186
    # a separarte ("storage") class.
 
187
    _lock_mode = None
 
188
    _lock_count = None
 
189
    _lock = None
 
190
    _inventory_weave = None
 
191
    
 
192
    # Map some sort of prefix into a namespace
 
193
    # stuff like "revno:10", "revid:", etc.
 
194
    # This should match a prefix with a function which accepts
 
195
    REVISION_NAMESPACES = {}
 
196
 
 
197
    def push_stores(self, branch_to):
 
198
        """Copy the content of this branches store to branch_to."""
 
199
        if (self._branch_format != branch_to._branch_format
 
200
            or self._branch_format != 4):
 
201
            from bzrlib.fetch import greedy_fetch
 
202
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
 
203
                   self, self._branch_format, branch_to, branch_to._branch_format)
 
204
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
205
                         revision=self.last_revision())
 
206
            return
 
207
 
 
208
        store_pairs = ((self.text_store,      branch_to.text_store),
 
209
                       (self.inventory_store, branch_to.inventory_store),
 
210
                       (self.revision_store,  branch_to.revision_store))
 
211
        try:
 
212
            for from_store, to_store in store_pairs: 
 
213
                copy_all(from_store, to_store)
 
214
        except UnlistableStore:
 
215
            raise UnlistableBranch(from_store)
 
216
 
 
217
    def __init__(self, transport, init=False,
 
218
                 relax_version_check=False):
 
219
        """Create new branch object at a particular location.
 
220
 
 
221
        transport -- A Transport object, defining how to access files.
 
222
                (If a string, transport.transport() will be used to
 
223
                create a Transport object)
 
224
        
 
225
        init -- If True, create new control files in a previously
 
226
             unversioned directory.  If False, the branch must already
 
227
             be versioned.
 
228
 
 
229
        relax_version_check -- If true, the usual check for the branch
 
230
            version is not applied.  This is intended only for
 
231
            upgrade/recovery type use; it's not guaranteed that
 
232
            all operations will work on old format branches.
 
233
 
 
234
        In the test suite, creation of new trees is tested using the
 
235
        `ScratchBranch` class.
 
236
        """
 
237
        assert isinstance(transport, Transport), \
 
238
            "%r is not a Transport" % transport
 
239
        self._transport = transport
 
240
        if init:
 
241
            self._make_control()
 
242
        self._check_format(relax_version_check)
 
243
 
 
244
        def get_store(name, compressed=True, prefixed=False):
 
245
            # FIXME: This approach of assuming stores are all entirely compressed
 
246
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
247
            # some existing branches where there's a mixture; we probably 
 
248
            # still want the option to look for both.
 
249
            relpath = self._rel_controlfilename(name)
 
250
            if compressed:
 
251
                store = CompressedTextStore(self._transport.clone(relpath),
 
252
                                            prefixed=prefixed)
 
253
            else:
 
254
                store = TextStore(self._transport.clone(relpath),
 
255
                                  prefixed=prefixed)
 
256
            #if self._transport.should_cache():
 
257
            #    cache_path = os.path.join(self.cache_root, name)
 
258
            #    os.mkdir(cache_path)
 
259
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
260
            return store
 
261
        def get_weave(name, prefixed=False):
 
262
            relpath = self._rel_controlfilename(name)
 
263
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
 
264
            if self._transport.should_cache():
 
265
                ws.enable_cache = True
 
266
            return ws
 
267
 
 
268
        if self._branch_format == 4:
 
269
            self.inventory_store = get_store('inventory-store')
 
270
            self.text_store = get_store('text-store')
 
271
            self.revision_store = get_store('revision-store')
 
272
        elif self._branch_format == 5:
 
273
            self.control_weaves = get_weave([])
 
274
            self.weave_store = get_weave('weaves')
 
275
            self.revision_store = get_store('revision-store', compressed=False)
 
276
        elif self._branch_format == 6:
 
277
            self.control_weaves = get_weave([])
 
278
            self.weave_store = get_weave('weaves', prefixed=True)
 
279
            self.revision_store = get_store('revision-store', compressed=False,
 
280
                                            prefixed=True)
 
281
        self._transaction = None
 
282
 
 
283
    def __str__(self):
 
284
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
 
285
 
 
286
 
 
287
    __repr__ = __str__
 
288
 
 
289
 
 
290
    def __del__(self):
 
291
        if self._lock_mode or self._lock:
 
292
            # XXX: This should show something every time, and be suitable for
 
293
            # headless operation and embedding
 
294
            warn("branch %r was not explicitly unlocked" % self)
 
295
            self._lock.unlock()
 
296
 
 
297
        # TODO: It might be best to do this somewhere else,
 
298
        # but it is nice for a Branch object to automatically
 
299
        # cache it's information.
 
300
        # Alternatively, we could have the Transport objects cache requests
 
301
        # See the earlier discussion about how major objects (like Branch)
 
302
        # should never expect their __del__ function to run.
 
303
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
304
            try:
 
305
                import shutil
 
306
                shutil.rmtree(self.cache_root)
 
307
            except:
 
308
                pass
 
309
            self.cache_root = None
 
310
 
 
311
    def _get_base(self):
 
312
        if self._transport:
 
313
            return self._transport.base
 
314
        return None
 
315
 
 
316
    base = property(_get_base)
 
317
 
 
318
    def _finish_transaction(self):
 
319
        """Exit the current transaction."""
 
320
        if self._transaction is None:
 
321
            raise errors.LockError('Branch %s is not in a transaction' %
 
322
                                   self)
 
323
        transaction = self._transaction
 
324
        self._transaction = None
 
325
        transaction.finish()
 
326
 
 
327
    def get_transaction(self):
 
328
        """Return the current active transaction.
 
329
 
 
330
        If no transaction is active, this returns a passthrough object
 
331
        for which all data is immedaitely flushed and no caching happens.
 
332
        """
 
333
        if self._transaction is None:
 
334
            return transactions.PassThroughTransaction()
 
335
        else:
 
336
            return self._transaction
 
337
 
 
338
    def _set_transaction(self, new_transaction):
 
339
        """Set a new active transaction."""
 
340
        if self._transaction is not None:
 
341
            raise errors.LockError('Branch %s is in a transaction already.' %
 
342
                                   self)
 
343
        self._transaction = new_transaction
 
344
 
 
345
    def lock_write(self):
 
346
        mutter("lock write: %s (%s)", self, self._lock_count)
 
347
        # TODO: Upgrade locking to support using a Transport,
 
348
        # and potentially a remote locking protocol
 
349
        if self._lock_mode:
 
350
            if self._lock_mode != 'w':
 
351
                raise LockError("can't upgrade to a write lock from %r" %
 
352
                                self._lock_mode)
 
353
            self._lock_count += 1
 
354
        else:
 
355
            self._lock = self._transport.lock_write(
 
356
                    self._rel_controlfilename('branch-lock'))
 
357
            self._lock_mode = 'w'
 
358
            self._lock_count = 1
 
359
            self._set_transaction(transactions.PassThroughTransaction())
 
360
 
 
361
 
 
362
    def lock_read(self):
 
363
        mutter("lock read: %s (%s)", self, self._lock_count)
 
364
        if self._lock_mode:
 
365
            assert self._lock_mode in ('r', 'w'), \
 
366
                   "invalid lock mode %r" % self._lock_mode
 
367
            self._lock_count += 1
 
368
        else:
 
369
            self._lock = self._transport.lock_read(
 
370
                    self._rel_controlfilename('branch-lock'))
 
371
            self._lock_mode = 'r'
 
372
            self._lock_count = 1
 
373
            self._set_transaction(transactions.ReadOnlyTransaction())
 
374
                        
 
375
    def unlock(self):
 
376
        mutter("unlock: %s (%s)", self, self._lock_count)
 
377
        if not self._lock_mode:
 
378
            raise LockError('branch %r is not locked' % (self))
 
379
 
 
380
        if self._lock_count > 1:
 
381
            self._lock_count -= 1
 
382
        else:
 
383
            self._finish_transaction()
 
384
            self._lock.unlock()
 
385
            self._lock = None
 
386
            self._lock_mode = self._lock_count = None
 
387
 
 
388
    def abspath(self, name):
 
389
        """Return absolute filename for something in the branch"""
 
390
        return self._transport.abspath(name)
 
391
 
 
392
    def relpath(self, path):
 
393
        """Return path relative to this branch of something inside it.
 
394
 
 
395
        Raises an error if path is not in this branch."""
 
396
        return self._transport.relpath(path)
 
397
 
 
398
 
 
399
    def _rel_controlfilename(self, file_or_path):
 
400
        if isinstance(file_or_path, basestring):
 
401
            file_or_path = [file_or_path]
 
402
        return [bzrlib.BZRDIR] + file_or_path
 
403
 
 
404
    def controlfilename(self, file_or_path):
 
405
        """Return location relative to branch."""
 
406
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
 
407
 
 
408
 
 
409
    def controlfile(self, file_or_path, mode='r'):
 
410
        """Open a control file for this branch.
 
411
 
 
412
        There are two classes of file in the control directory: text
 
413
        and binary.  binary files are untranslated byte streams.  Text
 
414
        control files are stored with Unix newlines and in UTF-8, even
 
415
        if the platform or locale defaults are different.
 
416
 
 
417
        Controlfiles should almost never be opened in write mode but
 
418
        rather should be atomically copied and replaced using atomicfile.
 
419
        """
 
420
        import codecs
 
421
 
 
422
        relpath = self._rel_controlfilename(file_or_path)
 
423
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
424
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
425
        if mode == 'rb': 
 
426
            return self._transport.get(relpath)
 
427
        elif mode == 'wb':
 
428
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
429
        elif mode == 'r':
 
430
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
431
        elif mode == 'w':
 
432
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
 
433
        else:
 
434
            raise BzrError("invalid controlfile mode %r" % mode)
 
435
 
 
436
    def put_controlfile(self, path, f, encode=True):
 
437
        """Write an entry as a controlfile.
 
438
 
 
439
        :param path: The path to put the file, relative to the .bzr control
 
440
                     directory
 
441
        :param f: A file-like or string object whose contents should be copied.
 
442
        :param encode:  If true, encode the contents as utf-8
 
443
        """
 
444
        self.put_controlfiles([(path, f)], encode=encode)
 
445
 
 
446
    def put_controlfiles(self, files, encode=True):
 
447
        """Write several entries as controlfiles.
 
448
 
 
449
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
450
                      underneath the bzr control directory
 
451
        :param encode:  If true, encode the contents as utf-8
 
452
        """
 
453
        import codecs
 
454
        ctrl_files = []
 
455
        for path, f in files:
 
456
            if encode:
 
457
                if isinstance(f, basestring):
 
458
                    f = f.encode('utf-8', 'replace')
 
459
                else:
 
460
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
461
            path = self._rel_controlfilename(path)
 
462
            ctrl_files.append((path, f))
 
463
        self._transport.put_multi(ctrl_files)
 
464
 
 
465
    def _make_control(self):
 
466
        from bzrlib.inventory import Inventory
 
467
        from bzrlib.weavefile import write_weave_v5
 
468
        from bzrlib.weave import Weave
 
469
        
 
470
        # Create an empty inventory
 
471
        sio = StringIO()
 
472
        # if we want per-tree root ids then this is the place to set
 
473
        # them; they're not needed for now and so ommitted for
 
474
        # simplicity.
 
475
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
 
476
        empty_inv = sio.getvalue()
 
477
        sio = StringIO()
 
478
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
479
        empty_weave = sio.getvalue()
 
480
 
 
481
        dirs = [[], 'revision-store', 'weaves']
 
482
        files = [('README', 
 
483
            "This is a Bazaar-NG control directory.\n"
 
484
            "Do not change any files in this directory.\n"),
 
485
            ('branch-format', BZR_BRANCH_FORMAT_6),
 
486
            ('revision-history', ''),
 
487
            ('branch-name', ''),
 
488
            ('branch-lock', ''),
 
489
            ('pending-merges', ''),
 
490
            ('inventory', empty_inv),
 
491
            ('inventory.weave', empty_weave),
 
492
            ('ancestry.weave', empty_weave)
 
493
        ]
 
494
        cfn = self._rel_controlfilename
 
495
        self._transport.mkdir_multi([cfn(d) for d in dirs])
 
496
        self.put_controlfiles(files)
 
497
        mutter('created control directory in ' + self._transport.base)
 
498
 
 
499
    def _check_format(self, relax_version_check):
 
500
        """Check this branch format is supported.
 
501
 
 
502
        The format level is stored, as an integer, in
 
503
        self._branch_format for code that needs to check it later.
 
504
 
 
505
        In the future, we might need different in-memory Branch
 
506
        classes to support downlevel branches.  But not yet.
 
507
        """
 
508
        try:
 
509
            fmt = self.controlfile('branch-format', 'r').read()
 
510
        except NoSuchFile:
 
511
            raise NotBranchError(self.base)
 
512
        mutter("got branch format %r", fmt)
 
513
        if fmt == BZR_BRANCH_FORMAT_6:
 
514
            self._branch_format = 6
 
515
        elif fmt == BZR_BRANCH_FORMAT_5:
 
516
            self._branch_format = 5
 
517
        elif fmt == BZR_BRANCH_FORMAT_4:
 
518
            self._branch_format = 4
 
519
 
 
520
        if (not relax_version_check
 
521
            and self._branch_format not in (5, 6)):
 
522
            raise errors.UnsupportedFormatError(
 
523
                           'sorry, branch format %r not supported' % fmt,
 
524
                           ['use a different bzr version',
 
525
                            'or remove the .bzr directory'
 
526
                            ' and "bzr init" again'])
 
527
 
 
528
    def get_root_id(self):
 
529
        """Return the id of this branches root"""
 
530
        inv = self.read_working_inventory()
 
531
        return inv.root.file_id
 
532
 
 
533
    def set_root_id(self, file_id):
 
534
        inv = self.read_working_inventory()
 
535
        orig_root_id = inv.root.file_id
 
536
        del inv._byid[inv.root.file_id]
 
537
        inv.root.file_id = file_id
 
538
        inv._byid[inv.root.file_id] = inv.root
 
539
        for fid in inv:
 
540
            entry = inv[fid]
 
541
            if entry.parent_id in (None, orig_root_id):
 
542
                entry.parent_id = inv.root.file_id
 
543
        self._write_inventory(inv)
 
544
 
 
545
    def read_working_inventory(self):
 
546
        """Read the working inventory."""
 
547
        self.lock_read()
 
548
        try:
 
549
            # ElementTree does its own conversion from UTF-8, so open in
 
550
            # binary.
 
551
            f = self.controlfile('inventory', 'rb')
 
552
            return bzrlib.xml5.serializer_v5.read_inventory(f)
 
553
        finally:
 
554
            self.unlock()
 
555
            
 
556
 
 
557
    def _write_inventory(self, inv):
 
558
        """Update the working inventory.
 
559
 
 
560
        That is to say, the inventory describing changes underway, that
 
561
        will be committed to the next revision.
 
562
        """
 
563
        from cStringIO import StringIO
 
564
        self.lock_write()
 
565
        try:
 
566
            sio = StringIO()
 
567
            bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
568
            sio.seek(0)
 
569
            # Transport handles atomicity
 
570
            self.put_controlfile('inventory', sio)
 
571
        finally:
 
572
            self.unlock()
 
573
        
 
574
        mutter('wrote working inventory')
 
575
            
 
576
    inventory = property(read_working_inventory, _write_inventory, None,
 
577
                         """Inventory for the working copy.""")
 
578
 
 
579
    def add(self, files, ids=None):
 
580
        """Make files versioned.
 
581
 
 
582
        Note that the command line normally calls smart_add instead,
 
583
        which can automatically recurse.
 
584
 
 
585
        This puts the files in the Added state, so that they will be
 
586
        recorded by the next commit.
 
587
 
 
588
        files
 
589
            List of paths to add, relative to the base of the tree.
 
590
 
 
591
        ids
 
592
            If set, use these instead of automatically generated ids.
 
593
            Must be the same length as the list of files, but may
 
594
            contain None for ids that are to be autogenerated.
 
595
 
 
596
        TODO: Perhaps have an option to add the ids even if the files do
 
597
              not (yet) exist.
 
598
 
 
599
        TODO: Perhaps yield the ids and paths as they're added.
 
600
        """
 
601
        # TODO: Re-adding a file that is removed in the working copy
 
602
        # should probably put it back with the previous ID.
 
603
        if isinstance(files, basestring):
 
604
            assert(ids is None or isinstance(ids, basestring))
 
605
            files = [files]
 
606
            if ids is not None:
 
607
                ids = [ids]
 
608
 
 
609
        if ids is None:
 
610
            ids = [None] * len(files)
 
611
        else:
 
612
            assert(len(ids) == len(files))
 
613
 
 
614
        self.lock_write()
 
615
        try:
 
616
            inv = self.read_working_inventory()
 
617
            for f,file_id in zip(files, ids):
 
618
                if is_control_file(f):
 
619
                    raise BzrError("cannot add control file %s" % quotefn(f))
 
620
 
 
621
                fp = splitpath(f)
 
622
 
 
623
                if len(fp) == 0:
 
624
                    raise BzrError("cannot add top-level %r" % f)
 
625
 
 
626
                fullpath = os.path.normpath(self.abspath(f))
 
627
 
 
628
                try:
 
629
                    kind = file_kind(fullpath)
 
630
                except OSError:
 
631
                    # maybe something better?
 
632
                    raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
633
 
 
634
                if not InventoryEntry.versionable_kind(kind):
 
635
                    raise BzrError('cannot add: not a versionable file ('
 
636
                                   'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
637
 
 
638
                if file_id is None:
 
639
                    file_id = gen_file_id(f)
 
640
                inv.add_path(f, kind=kind, file_id=file_id)
 
641
 
 
642
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
643
 
 
644
            self._write_inventory(inv)
 
645
        finally:
 
646
            self.unlock()
 
647
            
 
648
 
 
649
    def print_file(self, file, revno):
 
650
        """Print `file` to stdout."""
 
651
        self.lock_read()
 
652
        try:
 
653
            tree = self.revision_tree(self.get_rev_id(revno))
 
654
            # use inventory as it was in that revision
 
655
            file_id = tree.inventory.path2id(file)
 
656
            if not file_id:
 
657
                raise BzrError("%r is not present in revision %s" % (file, revno))
 
658
            tree.print_file(file_id)
 
659
        finally:
 
660
            self.unlock()
 
661
 
 
662
 
 
663
    def remove(self, files, verbose=False):
 
664
        """Mark nominated files for removal from the inventory.
 
665
 
 
666
        This does not remove their text.  This does not run on 
 
667
 
 
668
        TODO: Refuse to remove modified files unless --force is given?
 
669
 
 
670
        TODO: Do something useful with directories.
 
671
 
 
672
        TODO: Should this remove the text or not?  Tough call; not
 
673
        removing may be useful and the user can just use use rm, and
 
674
        is the opposite of add.  Removing it is consistent with most
 
675
        other tools.  Maybe an option.
 
676
        """
 
677
        ## TODO: Normalize names
 
678
        ## TODO: Remove nested loops; better scalability
 
679
        if isinstance(files, basestring):
 
680
            files = [files]
 
681
 
 
682
        self.lock_write()
 
683
 
 
684
        try:
 
685
            tree = self.working_tree()
 
686
            inv = tree.inventory
 
687
 
 
688
            # do this before any modifications
 
689
            for f in files:
 
690
                fid = inv.path2id(f)
 
691
                if not fid:
 
692
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
 
693
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
 
694
                if verbose:
 
695
                    # having remove it, it must be either ignored or unknown
 
696
                    if tree.is_ignored(f):
 
697
                        new_status = 'I'
 
698
                    else:
 
699
                        new_status = '?'
 
700
                    show_status(new_status, inv[fid].kind, quotefn(f))
 
701
                del inv[fid]
 
702
 
 
703
            self._write_inventory(inv)
 
704
        finally:
 
705
            self.unlock()
 
706
 
 
707
    # FIXME: this doesn't need to be a branch method
 
708
    def set_inventory(self, new_inventory_list):
 
709
        from bzrlib.inventory import Inventory, InventoryEntry
 
710
        inv = Inventory(self.get_root_id())
 
711
        for path, file_id, parent, kind in new_inventory_list:
 
712
            name = os.path.basename(path)
 
713
            if name == "":
 
714
                continue
 
715
            # fixme, there should be a factory function inv,add_?? 
 
716
            if kind == 'directory':
 
717
                inv.add(inventory.InventoryDirectory(file_id, name, parent))
 
718
            elif kind == 'file':
 
719
                inv.add(inventory.InventoryFile(file_id, name, parent))
 
720
            elif kind == 'symlink':
 
721
                inv.add(inventory.InventoryLink(file_id, name, parent))
 
722
            else:
 
723
                raise BzrError("unknown kind %r" % kind)
 
724
        self._write_inventory(inv)
 
725
 
 
726
    def unknowns(self):
 
727
        """Return all unknown files.
 
728
 
 
729
        These are files in the working directory that are not versioned or
 
730
        control files or ignored.
 
731
        
 
732
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
733
        >>> list(b.unknowns())
 
734
        ['foo']
 
735
        >>> b.add('foo')
 
736
        >>> list(b.unknowns())
 
737
        []
 
738
        >>> b.remove('foo')
 
739
        >>> list(b.unknowns())
 
740
        ['foo']
 
741
        """
 
742
        return self.working_tree().unknowns()
 
743
 
 
744
 
 
745
    def append_revision(self, *revision_ids):
 
746
        for revision_id in revision_ids:
 
747
            mutter("add {%s} to revision-history" % revision_id)
 
748
        self.lock_write()
 
749
        try:
 
750
            rev_history = self.revision_history()
 
751
            rev_history.extend(revision_ids)
 
752
            self.put_controlfile('revision-history', '\n'.join(rev_history))
 
753
        finally:
 
754
            self.unlock()
 
755
 
 
756
    def has_revision(self, revision_id):
 
757
        """True if this branch has a copy of the revision.
 
758
 
 
759
        This does not necessarily imply the revision is merge
 
760
        or on the mainline."""
 
761
        return (revision_id is None
 
762
                or revision_id in self.revision_store)
 
763
 
 
764
    def get_revision_xml_file(self, revision_id):
 
765
        """Return XML file object for revision object."""
 
766
        if not revision_id or not isinstance(revision_id, basestring):
 
767
            raise InvalidRevisionId(revision_id)
 
768
 
 
769
        self.lock_read()
 
770
        try:
 
771
            try:
 
772
                return self.revision_store[revision_id]
 
773
            except (IndexError, KeyError):
 
774
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
775
        finally:
 
776
            self.unlock()
 
777
 
 
778
    #deprecated
 
779
    get_revision_xml = get_revision_xml_file
 
780
 
 
781
    def get_revision_xml(self, revision_id):
 
782
        return self.get_revision_xml_file(revision_id).read()
 
783
 
 
784
 
 
785
    def get_revision(self, revision_id):
 
786
        """Return the Revision object for a named revision"""
 
787
        xml_file = self.get_revision_xml_file(revision_id)
 
788
 
 
789
        try:
 
790
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
 
791
        except SyntaxError, e:
 
792
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
793
                                         [revision_id,
 
794
                                          str(e)])
 
795
            
 
796
        assert r.revision_id == revision_id
 
797
        return r
 
798
 
 
799
    def get_revision_delta(self, revno):
 
800
        """Return the delta for one revision.
 
801
 
 
802
        The delta is relative to its mainline predecessor, or the
 
803
        empty tree for revision 1.
 
804
        """
 
805
        assert isinstance(revno, int)
 
806
        rh = self.revision_history()
 
807
        if not (1 <= revno <= len(rh)):
 
808
            raise InvalidRevisionNumber(revno)
 
809
 
 
810
        # revno is 1-based; list is 0-based
 
811
 
 
812
        new_tree = self.revision_tree(rh[revno-1])
 
813
        if revno == 1:
 
814
            old_tree = EmptyTree()
 
815
        else:
 
816
            old_tree = self.revision_tree(rh[revno-2])
 
817
 
 
818
        return compare_trees(old_tree, new_tree)
 
819
 
 
820
    def get_revision_sha1(self, revision_id):
 
821
        """Hash the stored value of a revision, and return it."""
 
822
        # In the future, revision entries will be signed. At that
 
823
        # point, it is probably best *not* to include the signature
 
824
        # in the revision hash. Because that lets you re-sign
 
825
        # the revision, (add signatures/remove signatures) and still
 
826
        # have all hash pointers stay consistent.
 
827
        # But for now, just hash the contents.
 
828
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
829
 
 
830
    def get_ancestry(self, revision_id):
 
831
        """Return a list of revision-ids integrated by a revision.
 
832
        
 
833
        This currently returns a list, but the ordering is not guaranteed:
 
834
        treat it as a set.
 
835
        """
 
836
        if revision_id is None:
 
837
            return [None]
 
838
        w = self.get_inventory_weave()
 
839
        return [None] + map(w.idx_to_name,
 
840
                            w.inclusions([w.lookup(revision_id)]))
 
841
 
 
842
    def get_inventory_weave(self):
 
843
        return self.control_weaves.get_weave('inventory',
 
844
                                             self.get_transaction())
 
845
 
 
846
    def get_inventory(self, revision_id):
 
847
        """Get Inventory object by hash."""
 
848
        xml = self.get_inventory_xml(revision_id)
 
849
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
850
 
 
851
    def get_inventory_xml(self, revision_id):
 
852
        """Get inventory XML as a file object."""
 
853
        try:
 
854
            assert isinstance(revision_id, basestring), type(revision_id)
 
855
            iw = self.get_inventory_weave()
 
856
            return iw.get_text(iw.lookup(revision_id))
 
857
        except IndexError:
 
858
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
859
 
 
860
    def get_inventory_sha1(self, revision_id):
 
861
        """Return the sha1 hash of the inventory entry
 
862
        """
 
863
        return self.get_revision(revision_id).inventory_sha1
 
864
 
 
865
    def get_revision_inventory(self, revision_id):
 
866
        """Return inventory of a past revision."""
 
867
        # TODO: Unify this with get_inventory()
 
868
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
869
        # must be the same as its revision, so this is trivial.
 
870
        if revision_id == None:
 
871
            return Inventory(self.get_root_id())
 
872
        else:
 
873
            return self.get_inventory(revision_id)
 
874
 
 
875
    def revision_history(self):
 
876
        """Return sequence of revision hashes on to this branch."""
 
877
        self.lock_read()
 
878
        try:
 
879
            return [l.rstrip('\r\n') for l in
 
880
                    self.controlfile('revision-history', 'r').readlines()]
 
881
        finally:
 
882
            self.unlock()
 
883
 
 
884
    def common_ancestor(self, other, self_revno=None, other_revno=None):
 
885
        """
 
886
        >>> from bzrlib.commit import commit
 
887
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
 
888
        >>> sb.common_ancestor(sb) == (None, None)
 
889
        True
 
890
        >>> commit(sb, "Committing first revision", verbose=False)
 
891
        >>> sb.common_ancestor(sb)[0]
 
892
        1
 
893
        >>> clone = sb.clone()
 
894
        >>> commit(sb, "Committing second revision", verbose=False)
 
895
        >>> sb.common_ancestor(sb)[0]
 
896
        2
 
897
        >>> sb.common_ancestor(clone)[0]
 
898
        1
 
899
        >>> commit(clone, "Committing divergent second revision", 
 
900
        ...               verbose=False)
 
901
        >>> sb.common_ancestor(clone)[0]
 
902
        1
 
903
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
 
904
        True
 
905
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
 
906
        True
 
907
        >>> clone2 = sb.clone()
 
908
        >>> sb.common_ancestor(clone2)[0]
 
909
        2
 
910
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
 
911
        1
 
912
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
 
913
        1
 
914
        """
 
915
        my_history = self.revision_history()
 
916
        other_history = other.revision_history()
 
917
        if self_revno is None:
 
918
            self_revno = len(my_history)
 
919
        if other_revno is None:
 
920
            other_revno = len(other_history)
 
921
        indices = range(min((self_revno, other_revno)))
 
922
        indices.reverse()
 
923
        for r in indices:
 
924
            if my_history[r] == other_history[r]:
 
925
                return r+1, my_history[r]
 
926
        return None, None
 
927
 
 
928
 
 
929
    def revno(self):
 
930
        """Return current revision number for this branch.
 
931
 
 
932
        That is equivalent to the number of revisions committed to
 
933
        this branch.
 
934
        """
 
935
        return len(self.revision_history())
 
936
 
 
937
 
 
938
    def last_revision(self):
 
939
        """Return last patch hash, or None if no history.
 
940
        """
 
941
        ph = self.revision_history()
 
942
        if ph:
 
943
            return ph[-1]
 
944
        else:
 
945
            return None
 
946
 
 
947
 
 
948
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
949
        """Return a list of new revisions that would perfectly fit.
 
950
        
 
951
        If self and other have not diverged, return a list of the revisions
 
952
        present in other, but missing from self.
 
953
 
 
954
        >>> from bzrlib.commit import commit
 
955
        >>> bzrlib.trace.silent = True
 
956
        >>> br1 = ScratchBranch()
 
957
        >>> br2 = ScratchBranch()
 
958
        >>> br1.missing_revisions(br2)
 
959
        []
 
960
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
961
        >>> br1.missing_revisions(br2)
 
962
        [u'REVISION-ID-1']
 
963
        >>> br2.missing_revisions(br1)
 
964
        []
 
965
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
966
        >>> br1.missing_revisions(br2)
 
967
        []
 
968
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
969
        >>> br1.missing_revisions(br2)
 
970
        [u'REVISION-ID-2A']
 
971
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
972
        >>> br1.missing_revisions(br2)
 
973
        Traceback (most recent call last):
 
974
        DivergedBranches: These branches have diverged.
 
975
        """
 
976
        # FIXME: If the branches have diverged, but the latest
 
977
        # revision in this branch is completely merged into the other,
 
978
        # then we should still be able to pull.
 
979
        self_history = self.revision_history()
 
980
        self_len = len(self_history)
 
981
        other_history = other.revision_history()
 
982
        other_len = len(other_history)
 
983
        common_index = min(self_len, other_len) -1
 
984
        if common_index >= 0 and \
 
985
            self_history[common_index] != other_history[common_index]:
 
986
            raise DivergedBranches(self, other)
 
987
 
 
988
        if stop_revision is None:
 
989
            stop_revision = other_len
 
990
        else:
 
991
            assert isinstance(stop_revision, int)
 
992
            if stop_revision > other_len:
 
993
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
994
        return other_history[self_len:stop_revision]
 
995
 
 
996
    def update_revisions(self, other, stop_revision=None):
 
997
        """Pull in new perfect-fit revisions."""
 
998
        from bzrlib.fetch import greedy_fetch
 
999
        from bzrlib.revision import get_intervening_revisions
 
1000
        if stop_revision is None:
 
1001
            stop_revision = other.last_revision()
 
1002
        greedy_fetch(to_branch=self, from_branch=other,
 
1003
                     revision=stop_revision)
 
1004
        pullable_revs = self.missing_revisions(
 
1005
            other, other.revision_id_to_revno(stop_revision))
 
1006
        if pullable_revs:
 
1007
            greedy_fetch(to_branch=self,
 
1008
                         from_branch=other,
 
1009
                         revision=pullable_revs[-1])
 
1010
            self.append_revision(*pullable_revs)
 
1011
    
 
1012
 
 
1013
    def commit(self, *args, **kw):
 
1014
        from bzrlib.commit import Commit
 
1015
        Commit().commit(self, *args, **kw)
 
1016
    
 
1017
    def revision_id_to_revno(self, revision_id):
 
1018
        """Given a revision id, return its revno"""
 
1019
        if revision_id is None:
 
1020
            return 0
 
1021
        history = self.revision_history()
 
1022
        try:
 
1023
            return history.index(revision_id) + 1
 
1024
        except ValueError:
 
1025
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
1026
 
 
1027
    def get_rev_id(self, revno, history=None):
 
1028
        """Find the revision id of the specified revno."""
 
1029
        if revno == 0:
 
1030
            return None
 
1031
        if history is None:
 
1032
            history = self.revision_history()
 
1033
        elif revno <= 0 or revno > len(history):
 
1034
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
1035
        return history[revno - 1]
 
1036
 
 
1037
    def revision_tree(self, revision_id):
 
1038
        """Return Tree for a revision on this branch.
 
1039
 
 
1040
        `revision_id` may be None for the null revision, in which case
 
1041
        an `EmptyTree` is returned."""
 
1042
        # TODO: refactor this to use an existing revision object
 
1043
        # so we don't need to read it in twice.
 
1044
        if revision_id == None:
 
1045
            return EmptyTree()
 
1046
        else:
 
1047
            inv = self.get_revision_inventory(revision_id)
 
1048
            return RevisionTree(self.weave_store, inv, revision_id)
 
1049
 
 
1050
 
 
1051
    def working_tree(self):
 
1052
        """Return a `Tree` for the working copy."""
 
1053
        from bzrlib.workingtree import WorkingTree
 
1054
        # TODO: In the future, WorkingTree should utilize Transport
 
1055
        # RobertCollins 20051003 - I don't think it should - working trees are
 
1056
        # much more complex to keep consistent than our careful .bzr subset.
 
1057
        # instead, we should say that working trees are local only, and optimise
 
1058
        # for that.
 
1059
        return WorkingTree(self._transport.base, self.read_working_inventory())
 
1060
 
 
1061
 
 
1062
    def basis_tree(self):
 
1063
        """Return `Tree` object for last revision.
 
1064
 
 
1065
        If there are no revisions yet, return an `EmptyTree`.
 
1066
        """
 
1067
        return self.revision_tree(self.last_revision())
 
1068
 
 
1069
 
 
1070
    def rename_one(self, from_rel, to_rel):
 
1071
        """Rename one file.
 
1072
 
 
1073
        This can change the directory or the filename or both.
 
1074
        """
 
1075
        self.lock_write()
 
1076
        try:
 
1077
            tree = self.working_tree()
 
1078
            inv = tree.inventory
 
1079
            if not tree.has_filename(from_rel):
 
1080
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
1081
            if tree.has_filename(to_rel):
 
1082
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
1083
 
 
1084
            file_id = inv.path2id(from_rel)
 
1085
            if file_id == None:
 
1086
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
1087
 
 
1088
            if inv.path2id(to_rel):
 
1089
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
1090
 
 
1091
            to_dir, to_tail = os.path.split(to_rel)
 
1092
            to_dir_id = inv.path2id(to_dir)
 
1093
            if to_dir_id == None and to_dir != '':
 
1094
                raise BzrError("can't determine destination directory id for %r" % to_dir)
 
1095
 
 
1096
            mutter("rename_one:")
 
1097
            mutter("  file_id    {%s}" % file_id)
 
1098
            mutter("  from_rel   %r" % from_rel)
 
1099
            mutter("  to_rel     %r" % to_rel)
 
1100
            mutter("  to_dir     %r" % to_dir)
 
1101
            mutter("  to_dir_id  {%s}" % to_dir_id)
 
1102
 
 
1103
            inv.rename(file_id, to_dir_id, to_tail)
 
1104
 
 
1105
            from_abs = self.abspath(from_rel)
 
1106
            to_abs = self.abspath(to_rel)
 
1107
            try:
 
1108
                rename(from_abs, to_abs)
 
1109
            except OSError, e:
 
1110
                raise BzrError("failed to rename %r to %r: %s"
 
1111
                        % (from_abs, to_abs, e[1]),
 
1112
                        ["rename rolled back"])
 
1113
 
 
1114
            self._write_inventory(inv)
 
1115
        finally:
 
1116
            self.unlock()
 
1117
 
 
1118
 
 
1119
    def move(self, from_paths, to_name):
 
1120
        """Rename files.
 
1121
 
 
1122
        to_name must exist as a versioned directory.
 
1123
 
 
1124
        If to_name exists and is a directory, the files are moved into
 
1125
        it, keeping their old names.  If it is a directory, 
 
1126
 
 
1127
        Note that to_name is only the last component of the new name;
 
1128
        this doesn't change the directory.
 
1129
 
 
1130
        This returns a list of (from_path, to_path) pairs for each
 
1131
        entry that is moved.
 
1132
        """
 
1133
        result = []
 
1134
        self.lock_write()
 
1135
        try:
 
1136
            ## TODO: Option to move IDs only
 
1137
            assert not isinstance(from_paths, basestring)
 
1138
            tree = self.working_tree()
 
1139
            inv = tree.inventory
 
1140
            to_abs = self.abspath(to_name)
 
1141
            if not isdir(to_abs):
 
1142
                raise BzrError("destination %r is not a directory" % to_abs)
 
1143
            if not tree.has_filename(to_name):
 
1144
                raise BzrError("destination %r not in working directory" % to_abs)
 
1145
            to_dir_id = inv.path2id(to_name)
 
1146
            if to_dir_id == None and to_name != '':
 
1147
                raise BzrError("destination %r is not a versioned directory" % to_name)
 
1148
            to_dir_ie = inv[to_dir_id]
 
1149
            if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1150
                raise BzrError("destination %r is not a directory" % to_abs)
 
1151
 
 
1152
            to_idpath = inv.get_idpath(to_dir_id)
 
1153
 
 
1154
            for f in from_paths:
 
1155
                if not tree.has_filename(f):
 
1156
                    raise BzrError("%r does not exist in working tree" % f)
 
1157
                f_id = inv.path2id(f)
 
1158
                if f_id == None:
 
1159
                    raise BzrError("%r is not versioned" % f)
 
1160
                name_tail = splitpath(f)[-1]
 
1161
                dest_path = appendpath(to_name, name_tail)
 
1162
                if tree.has_filename(dest_path):
 
1163
                    raise BzrError("destination %r already exists" % dest_path)
 
1164
                if f_id in to_idpath:
 
1165
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1166
 
 
1167
            # OK, so there's a race here, it's possible that someone will
 
1168
            # create a file in this interval and then the rename might be
 
1169
            # left half-done.  But we should have caught most problems.
 
1170
 
 
1171
            for f in from_paths:
 
1172
                name_tail = splitpath(f)[-1]
 
1173
                dest_path = appendpath(to_name, name_tail)
 
1174
                result.append((f, dest_path))
 
1175
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1176
                try:
 
1177
                    rename(self.abspath(f), self.abspath(dest_path))
 
1178
                except OSError, e:
 
1179
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1180
                            ["rename rolled back"])
 
1181
 
 
1182
            self._write_inventory(inv)
 
1183
        finally:
 
1184
            self.unlock()
 
1185
 
 
1186
        return result
 
1187
 
 
1188
 
 
1189
    def revert(self, filenames, old_tree=None, backups=True):
 
1190
        """Restore selected files to the versions from a previous tree.
 
1191
 
 
1192
        backups
 
1193
            If true (default) backups are made of files before
 
1194
            they're renamed.
 
1195
        """
 
1196
        from bzrlib.errors import NotVersionedError, BzrError
 
1197
        from bzrlib.atomicfile import AtomicFile
 
1198
        from bzrlib.osutils import backup_file
 
1199
        
 
1200
        inv = self.read_working_inventory()
 
1201
        if old_tree is None:
 
1202
            old_tree = self.basis_tree()
 
1203
        old_inv = old_tree.inventory
 
1204
 
 
1205
        nids = []
 
1206
        for fn in filenames:
 
1207
            file_id = inv.path2id(fn)
 
1208
            if not file_id:
 
1209
                raise NotVersionedError("not a versioned file", fn)
 
1210
            if not old_inv.has_id(file_id):
 
1211
                raise BzrError("file not present in old tree", fn, file_id)
 
1212
            nids.append((fn, file_id))
 
1213
            
 
1214
        # TODO: Rename back if it was previously at a different location
 
1215
 
 
1216
        # TODO: If given a directory, restore the entire contents from
 
1217
        # the previous version.
 
1218
 
 
1219
        # TODO: Make a backup to a temporary file.
 
1220
 
 
1221
        # TODO: If the file previously didn't exist, delete it?
 
1222
        for fn, file_id in nids:
 
1223
            backup_file(fn)
 
1224
            
 
1225
            f = AtomicFile(fn, 'wb')
 
1226
            try:
 
1227
                f.write(old_tree.get_file(file_id).read())
 
1228
                f.commit()
 
1229
            finally:
 
1230
                f.close()
 
1231
 
 
1232
 
 
1233
    def pending_merges(self):
 
1234
        """Return a list of pending merges.
 
1235
 
 
1236
        These are revisions that have been merged into the working
 
1237
        directory but not yet committed.
 
1238
        """
 
1239
        cfn = self._rel_controlfilename('pending-merges')
 
1240
        if not self._transport.has(cfn):
 
1241
            return []
 
1242
        p = []
 
1243
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1244
            p.append(l.rstrip('\n'))
 
1245
        return p
 
1246
 
 
1247
 
 
1248
    def add_pending_merge(self, *revision_ids):
 
1249
        # TODO: Perhaps should check at this point that the
 
1250
        # history of the revision is actually present?
 
1251
        p = self.pending_merges()
 
1252
        updated = False
 
1253
        for rev_id in revision_ids:
 
1254
            if rev_id in p:
 
1255
                continue
 
1256
            p.append(rev_id)
 
1257
            updated = True
 
1258
        if updated:
 
1259
            self.set_pending_merges(p)
 
1260
 
 
1261
    def set_pending_merges(self, rev_list):
 
1262
        self.lock_write()
 
1263
        try:
 
1264
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
 
1265
        finally:
 
1266
            self.unlock()
 
1267
 
 
1268
 
 
1269
    def get_parent(self):
 
1270
        """Return the parent location of the branch.
 
1271
 
 
1272
        This is the default location for push/pull/missing.  The usual
 
1273
        pattern is that the user can override it by specifying a
 
1274
        location.
 
1275
        """
 
1276
        import errno
 
1277
        _locs = ['parent', 'pull', 'x-pull']
 
1278
        for l in _locs:
 
1279
            try:
 
1280
                return self.controlfile(l, 'r').read().strip('\n')
 
1281
            except IOError, e:
 
1282
                if e.errno != errno.ENOENT:
 
1283
                    raise
 
1284
        return None
 
1285
 
 
1286
 
 
1287
    def set_parent(self, url):
 
1288
        # TODO: Maybe delete old location files?
 
1289
        from bzrlib.atomicfile import AtomicFile
 
1290
        self.lock_write()
 
1291
        try:
 
1292
            f = AtomicFile(self.controlfilename('parent'))
 
1293
            try:
 
1294
                f.write(url + '\n')
 
1295
                f.commit()
 
1296
            finally:
 
1297
                f.close()
 
1298
        finally:
 
1299
            self.unlock()
 
1300
 
 
1301
    def check_revno(self, revno):
 
1302
        """\
 
1303
        Check whether a revno corresponds to any revision.
 
1304
        Zero (the NULL revision) is considered valid.
 
1305
        """
 
1306
        if revno != 0:
 
1307
            self.check_real_revno(revno)
 
1308
            
 
1309
    def check_real_revno(self, revno):
 
1310
        """\
 
1311
        Check whether a revno corresponds to a real revision.
 
1312
        Zero (the NULL revision) is considered invalid
 
1313
        """
 
1314
        if revno < 1 or revno > self.revno():
 
1315
            raise InvalidRevisionNumber(revno)
 
1316
        
 
1317
        
 
1318
        
 
1319
 
 
1320
 
 
1321
class ScratchBranch(_Branch):
 
1322
    """Special test class: a branch that cleans up after itself.
 
1323
 
 
1324
    >>> b = ScratchBranch()
 
1325
    >>> isdir(b.base)
 
1326
    True
 
1327
    >>> bd = b.base
 
1328
    >>> b.destroy()
 
1329
    >>> isdir(bd)
 
1330
    False
 
1331
    """
 
1332
    def __init__(self, files=[], dirs=[], base=None):
 
1333
        """Make a test branch.
 
1334
 
 
1335
        This creates a temporary directory and runs init-tree in it.
 
1336
 
 
1337
        If any files are listed, they are created in the working copy.
 
1338
        """
 
1339
        from tempfile import mkdtemp
 
1340
        init = False
 
1341
        if base is None:
 
1342
            base = mkdtemp()
 
1343
            init = True
 
1344
        if isinstance(base, basestring):
 
1345
            base = get_transport(base)
 
1346
        _Branch.__init__(self, base, init=init)
 
1347
        for d in dirs:
 
1348
            self._transport.mkdir(d)
 
1349
            
 
1350
        for f in files:
 
1351
            self._transport.put(f, 'content of %s' % f)
 
1352
 
 
1353
 
 
1354
    def clone(self):
 
1355
        """
 
1356
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1357
        >>> clone = orig.clone()
 
1358
        >>> if os.name != 'nt':
 
1359
        ...   os.path.samefile(orig.base, clone.base)
 
1360
        ... else:
 
1361
        ...   orig.base == clone.base
 
1362
        ...
 
1363
        False
 
1364
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1365
        True
 
1366
        """
 
1367
        from shutil import copytree
 
1368
        from tempfile import mkdtemp
 
1369
        base = mkdtemp()
 
1370
        os.rmdir(base)
 
1371
        copytree(self.base, base, symlinks=True)
 
1372
        return ScratchBranch(base=base)
 
1373
 
 
1374
    def __del__(self):
 
1375
        self.destroy()
 
1376
 
 
1377
    def destroy(self):
 
1378
        """Destroy the test branch, removing the scratch directory."""
 
1379
        from shutil import rmtree
 
1380
        try:
 
1381
            if self.base:
 
1382
                mutter("delete ScratchBranch %s" % self.base)
 
1383
                rmtree(self.base)
 
1384
        except OSError, e:
 
1385
            # Work around for shutil.rmtree failing on Windows when
 
1386
            # readonly files are encountered
 
1387
            mutter("hit exception in destroying ScratchBranch: %s" % e)
 
1388
            for root, dirs, files in os.walk(self.base, topdown=False):
 
1389
                for name in files:
 
1390
                    os.chmod(os.path.join(root, name), 0700)
 
1391
            rmtree(self.base)
 
1392
        self._transport = None
 
1393
 
 
1394
    
 
1395
 
 
1396
######################################################################
 
1397
# predicates
 
1398
 
 
1399
 
 
1400
def is_control_file(filename):
 
1401
    ## FIXME: better check
 
1402
    filename = os.path.normpath(filename)
 
1403
    while filename != '':
 
1404
        head, tail = os.path.split(filename)
 
1405
        ## mutter('check %r for control file' % ((head, tail), ))
 
1406
        if tail == bzrlib.BZRDIR:
 
1407
            return True
 
1408
        if filename == head:
 
1409
            break
 
1410
        filename = head
 
1411
    return False
 
1412
 
 
1413
 
 
1414
 
 
1415
def gen_file_id(name):
 
1416
    """Return new file id.
 
1417
 
 
1418
    This should probably generate proper UUIDs, but for the moment we
 
1419
    cope with just randomness because running uuidgen every time is
 
1420
    slow."""
 
1421
    import re
 
1422
    from binascii import hexlify
 
1423
    from time import time
 
1424
 
 
1425
    # get last component
 
1426
    idx = name.rfind('/')
 
1427
    if idx != -1:
 
1428
        name = name[idx+1 : ]
 
1429
    idx = name.rfind('\\')
 
1430
    if idx != -1:
 
1431
        name = name[idx+1 : ]
 
1432
 
 
1433
    # make it not a hidden file
 
1434
    name = name.lstrip('.')
 
1435
 
 
1436
    # remove any wierd characters; we don't escape them but rather
 
1437
    # just pull them out
 
1438
    name = re.sub(r'[^\w.]', '', name)
 
1439
 
 
1440
    s = hexlify(rand_bytes(8))
 
1441
    return '-'.join((name, compact_date(time()), s))
 
1442
 
 
1443
 
 
1444
def gen_root_id():
 
1445
    """Return a new tree-root file id."""
 
1446
    return gen_file_id('TREE_ROOT')
 
1447
 
 
1448