/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

- improved eta estimation for progress bar
  (patch from John Arbash Meinel)

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