/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: abentley
  • Date: 2005-10-16 05:15:58 UTC
  • mfrom: (1457)
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1460.
  • Revision ID: abentley@lappy-20051016051558-502eb6c3601ceb90
Merged Robert's latest

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