/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

Update news and readme

- better explanation of dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
17
17
 
18
18
import sys
19
19
import os
 
20
import errno
 
21
from warnings import warn
 
22
from cStringIO import StringIO
 
23
 
20
24
 
21
25
import bzrlib
 
26
from bzrlib.inventory import InventoryEntry
 
27
import bzrlib.inventory as inventory
22
28
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId
27
 
import bzrlib.errors
 
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)
28
37
from bzrlib.textui import show_status
29
 
from bzrlib.revision import Revision
30
 
from bzrlib.xml import unpack_xml
 
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
 
39
 
31
40
from bzrlib.delta import compare_trees
32
41
from bzrlib.tree import EmptyTree, RevisionTree
33
 
        
34
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
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"
35
57
## TODO: Maybe include checks for common corruption of newlines, etc?
36
58
 
37
59
 
38
60
# TODO: Some operations like log might retrieve the same revisions
39
61
# repeatedly to calculate deltas.  We could perhaps have a weakref
40
 
# cache in memory to make this faster.
41
 
 
42
 
 
43
 
def find_branch(f, **args):
44
 
    if f and (f.startswith('http://') or f.startswith('https://')):
45
 
        import remotebranch 
46
 
        return remotebranch.RemoteBranch(f, **args)
47
 
    else:
48
 
        return Branch(f, **args)
49
 
 
50
 
 
51
 
def find_cached_branch(f, cache_root, **args):
52
 
    from remotebranch import RemoteBranch
53
 
    br = find_branch(f, **args)
54
 
    def cacheify(br, store_name):
55
 
        from meta_store import CachedStore
56
 
        cache_path = os.path.join(cache_root, store_name)
57
 
        os.mkdir(cache_path)
58
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
59
 
        setattr(br, store_name, new_store)
60
 
 
61
 
    if isinstance(br, RemoteBranch):
62
 
        cacheify(br, 'inventory_store')
63
 
        cacheify(br, 'text_store')
64
 
        cacheify(br, 'revision_store')
65
 
    return br
66
 
 
67
 
 
68
 
def _relpath(base, path):
69
 
    """Return path relative to base, or raise exception.
70
 
 
71
 
    The path may be either an absolute path or a path relative to the
72
 
    current working directory.
73
 
 
74
 
    Lifted out of Branch.relpath for ease of testing.
75
 
 
76
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
77
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
78
 
    avoids that problem."""
79
 
    rp = os.path.abspath(path)
80
 
 
81
 
    s = []
82
 
    head = rp
83
 
    while len(head) >= len(base):
84
 
        if head == base:
85
 
            break
86
 
        head, tail = os.path.split(head)
87
 
        if tail:
88
 
            s.insert(0, tail)
89
 
    else:
90
 
        from errors import NotBranchError
91
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
92
 
 
93
 
    return os.sep.join(s)
94
 
        
95
 
 
96
 
def find_branch_root(f=None):
97
 
    """Find the branch root enclosing f, or pwd.
98
 
 
99
 
    f may be a filename or a URL.
100
 
 
101
 
    It is not necessary that f exists.
102
 
 
103
 
    Basically we keep looking up until we find the control directory or
104
 
    run into the root."""
105
 
    if f == None:
106
 
        f = os.getcwd()
107
 
    elif hasattr(os.path, 'realpath'):
108
 
        f = os.path.realpath(f)
109
 
    else:
110
 
        f = os.path.abspath(f)
111
 
    if not os.path.exists(f):
112
 
        raise BzrError('%r does not exist' % f)
113
 
        
114
 
 
115
 
    orig_f = f
116
 
 
117
 
    while True:
118
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
119
 
            return f
120
 
        head, tail = os.path.split(f)
121
 
        if head == f:
122
 
            # reached the root, whatever that may be
123
 
            raise BzrError('%r is not in a branch' % orig_f)
124
 
        f = head
125
 
    
126
 
class DivergedBranches(Exception):
127
 
    def __init__(self, branch1, branch2):
128
 
        self.branch1 = branch1
129
 
        self.branch2 = branch2
130
 
        Exception.__init__(self, "These branches have diverged.")
131
 
 
 
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
132
91
 
133
92
######################################################################
134
93
# branch objects
137
96
    """Branch holding a history of revisions.
138
97
 
139
98
    base
140
 
        Base directory of the branch.
 
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.
141
161
 
142
162
    _lock_mode
143
163
        None, or 'r' or 'w'
149
169
    _lock
150
170
        Lock object from bzrlib.lock.
151
171
    """
152
 
    base = None
 
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.
153
176
    _lock_mode = None
154
177
    _lock_count = None
155
178
    _lock = None
 
179
    _inventory_weave = None
156
180
    
157
181
    # Map some sort of prefix into a namespace
158
182
    # stuff like "revno:10", "revid:", etc.
159
183
    # This should match a prefix with a function which accepts
160
184
    REVISION_NAMESPACES = {}
161
185
 
162
 
    def __init__(self, base, init=False, find_root=True):
 
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):
163
208
        """Create new branch object at a particular location.
164
209
 
165
 
        base -- Base directory for the branch.
 
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)
166
213
        
167
214
        init -- If True, create new control files in a previously
168
215
             unversioned directory.  If False, the branch must already
169
216
             be versioned.
170
217
 
171
 
        find_root -- If true and init is false, find the root of the
172
 
             existing branch containing base.
 
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.
173
222
 
174
223
        In the test suite, creation of new trees is tested using the
175
224
        `ScratchBranch` class.
176
225
        """
177
 
        from bzrlib.store import ImmutableStore
 
226
        assert isinstance(transport, Transport), \
 
227
            "%r is not a Transport" % transport
 
228
        self._transport = transport
178
229
        if init:
179
 
            self.base = os.path.realpath(base)
180
230
            self._make_control()
181
 
        elif find_root:
182
 
            self.base = find_branch_root(base)
183
 
        else:
184
 
            self.base = os.path.realpath(base)
185
 
            if not isdir(self.controlfilename('.')):
186
 
                from errors import NotBranchError
187
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
 
                                     ['use "bzr init" to initialize a new working tree',
189
 
                                      'current bzr can only operate from top-of-tree'])
190
 
        self._check_format()
191
 
 
192
 
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
195
 
 
 
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
196
272
 
197
273
    def __str__(self):
198
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
274
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
199
275
 
200
276
 
201
277
    __repr__ = __str__
203
279
 
204
280
    def __del__(self):
205
281
        if self._lock_mode or self._lock:
206
 
            from warnings import warn
 
282
            # XXX: This should show something every time, and be suitable for
 
283
            # headless operation and embedding
207
284
            warn("branch %r was not explicitly unlocked" % self)
208
285
            self._lock.unlock()
209
286
 
210
 
 
 
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
211
334
 
212
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
213
339
        if self._lock_mode:
214
340
            if self._lock_mode != 'w':
215
 
                from errors import LockError
216
341
                raise LockError("can't upgrade to a write lock from %r" %
217
342
                                self._lock_mode)
218
343
            self._lock_count += 1
219
344
        else:
220
 
            from bzrlib.lock import WriteLock
221
 
 
222
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
345
            self._lock = self._transport.lock_write(
 
346
                    self._rel_controlfilename('branch-lock'))
223
347
            self._lock_mode = 'w'
224
348
            self._lock_count = 1
225
 
 
226
 
 
 
349
            self._set_transaction(transactions.PassThroughTransaction())
227
350
 
228
351
    def lock_read(self):
 
352
        mutter("lock read: %s (%s)", self, self._lock_count)
229
353
        if self._lock_mode:
230
354
            assert self._lock_mode in ('r', 'w'), \
231
355
                   "invalid lock mode %r" % self._lock_mode
232
356
            self._lock_count += 1
233
357
        else:
234
 
            from bzrlib.lock import ReadLock
235
 
 
236
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
358
            self._lock = self._transport.lock_read(
 
359
                    self._rel_controlfilename('branch-lock'))
237
360
            self._lock_mode = 'r'
238
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)
239
365
                        
240
 
 
241
 
            
242
366
    def unlock(self):
 
367
        mutter("unlock: %s (%s)", self, self._lock_count)
243
368
        if not self._lock_mode:
244
 
            from errors import LockError
245
369
            raise LockError('branch %r is not locked' % (self))
246
370
 
247
371
        if self._lock_count > 1:
248
372
            self._lock_count -= 1
249
373
        else:
 
374
            self._finish_transaction()
250
375
            self._lock.unlock()
251
376
            self._lock = None
252
377
            self._lock_mode = self._lock_count = None
253
378
 
254
 
 
255
379
    def abspath(self, name):
256
 
        """Return absolute filename for something in the branch"""
257
 
        return os.path.join(self.base, name)
258
 
 
259
 
 
260
 
    def relpath(self, path):
261
 
        """Return path relative to this branch of something inside it.
262
 
 
263
 
        Raises an error if path is not in this branch."""
264
 
        return _relpath(self.base, path)
265
 
 
 
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
266
391
 
267
392
    def controlfilename(self, file_or_path):
268
393
        """Return location relative to branch."""
269
 
        if isinstance(file_or_path, basestring):
270
 
            file_or_path = [file_or_path]
271
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
394
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
272
395
 
273
396
 
274
397
    def controlfile(self, file_or_path, mode='r'):
282
405
        Controlfiles should almost never be opened in write mode but
283
406
        rather should be atomically copied and replaced using atomicfile.
284
407
        """
285
 
 
286
 
        fn = self.controlfilename(file_or_path)
287
 
 
288
 
        if mode == 'rb' or mode == 'wb':
289
 
            return file(fn, mode)
290
 
        elif mode == 'r' or mode == 'w':
291
 
            # open in binary mode anyhow so there's no newline translation;
292
 
            # codecs uses line buffering by default; don't want that.
293
 
            import codecs
294
 
            return codecs.open(fn, mode + 'b', 'utf-8',
295
 
                               buffering=60000)
 
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")
296
421
        else:
297
422
            raise BzrError("invalid controlfile mode %r" % mode)
298
423
 
299
 
 
 
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)
300
452
 
301
453
    def _make_control(self):
302
454
        from bzrlib.inventory import Inventory
303
 
        from bzrlib.xml import pack_xml
 
455
        from bzrlib.weavefile import write_weave_v5
 
456
        from bzrlib.weave import Weave
304
457
        
305
 
        os.mkdir(self.controlfilename([]))
306
 
        self.controlfile('README', 'w').write(
 
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', 
307
471
            "This is a Bazaar-NG control directory.\n"
308
 
            "Do not change any files in this directory.\n")
309
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
 
        for d in ('text-store', 'inventory-store', 'revision-store'):
311
 
            os.mkdir(self.controlfilename(d))
312
 
        for f in ('revision-history', 'merged-patches',
313
 
                  'pending-merged-patches', 'branch-name',
314
 
                  'branch-lock',
315
 
                  'pending-merges'):
316
 
            self.controlfile(f, 'w').write('')
317
 
        mutter('created control directory in ' + self.base)
318
 
 
319
 
        pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
320
 
 
321
 
 
322
 
    def _check_format(self):
 
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):
323
488
        """Check this branch format is supported.
324
489
 
325
 
        The current tool only supports the current unstable format.
 
490
        The format level is stored, as an integer, in
 
491
        self._branch_format for code that needs to check it later.
326
492
 
327
493
        In the future, we might need different in-memory Branch
328
494
        classes to support downlevel branches.  But not yet.
329
495
        """
330
 
        # This ignores newlines so that we can open branches created
331
 
        # on Windows from Linux and so on.  I think it might be better
332
 
        # to always make all internal files in unix format.
333
 
        fmt = self.controlfile('branch-format', 'r').read()
334
 
        fmt.replace('\r\n', '')
335
 
        if fmt != BZR_BRANCH_FORMAT:
336
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
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,
337
512
                           ['use a different bzr version',
338
 
                            'or remove the .bzr directory and "bzr init" again'])
 
513
                            'or remove the .bzr directory'
 
514
                            ' and "bzr init" again'])
339
515
 
340
516
    def get_root_id(self):
341
517
        """Return the id of this branches root"""
354
530
                entry.parent_id = inv.root.file_id
355
531
        self._write_inventory(inv)
356
532
 
 
533
    @needs_read_lock
357
534
    def read_working_inventory(self):
358
535
        """Read the working inventory."""
359
 
        from bzrlib.inventory import Inventory
360
 
        from bzrlib.xml import unpack_xml
361
 
        from time import time
362
 
        before = time()
363
 
        self.lock_read()
364
 
        try:
365
 
            # ElementTree does its own conversion from UTF-8, so open in
366
 
            # binary.
367
 
            inv = unpack_xml(Inventory,
368
 
                             self.controlfile('inventory', 'rb'))
369
 
            mutter("loaded inventory of %d items in %f"
370
 
                   % (len(inv), time() - before))
371
 
            return inv
372
 
        finally:
373
 
            self.unlock()
374
 
            
 
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)
375
540
 
 
541
    @needs_write_lock
376
542
    def _write_inventory(self, inv):
377
543
        """Update the working inventory.
378
544
 
379
545
        That is to say, the inventory describing changes underway, that
380
546
        will be committed to the next revision.
381
547
        """
382
 
        from bzrlib.atomicfile import AtomicFile
383
 
        from bzrlib.xml import pack_xml
384
 
        
385
 
        self.lock_write()
386
 
        try:
387
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
 
            try:
389
 
                pack_xml(inv, f)
390
 
                f.commit()
391
 
            finally:
392
 
                f.close()
393
 
        finally:
394
 
            self.unlock()
 
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)
395
554
        
396
555
        mutter('wrote working inventory')
397
556
            
398
 
 
399
557
    inventory = property(read_working_inventory, _write_inventory, None,
400
558
                         """Inventory for the working copy.""")
401
559
 
402
 
 
403
 
    def add(self, files, verbose=False, ids=None):
 
560
    @needs_write_lock
 
561
    def add(self, files, ids=None):
404
562
        """Make files versioned.
405
563
 
406
 
        Note that the command line normally calls smart_add instead.
 
564
        Note that the command line normally calls smart_add instead,
 
565
        which can automatically recurse.
407
566
 
408
567
        This puts the files in the Added state, so that they will be
409
568
        recorded by the next commit.
419
578
        TODO: Perhaps have an option to add the ids even if the files do
420
579
              not (yet) exist.
421
580
 
422
 
        TODO: Perhaps return the ids of the files?  But then again it
423
 
              is easy to retrieve them if they're needed.
424
 
 
425
 
        TODO: Adding a directory should optionally recurse down and
426
 
              add all non-ignored children.  Perhaps do that in a
427
 
              higher-level method.
 
581
        TODO: Perhaps yield the ids and paths as they're added.
428
582
        """
429
583
        # TODO: Re-adding a file that is removed in the working copy
430
584
        # should probably put it back with the previous ID.
439
593
        else:
440
594
            assert(len(ids) == len(files))
441
595
 
442
 
        self.lock_write()
443
 
        try:
444
 
            inv = self.read_working_inventory()
445
 
            for f,file_id in zip(files, ids):
446
 
                if is_control_file(f):
447
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
448
 
 
449
 
                fp = splitpath(f)
450
 
 
451
 
                if len(fp) == 0:
452
 
                    raise BzrError("cannot add top-level %r" % f)
453
 
 
454
 
                fullpath = os.path.normpath(self.abspath(f))
455
 
 
456
 
                try:
457
 
                    kind = file_kind(fullpath)
458
 
                except OSError:
459
 
                    # maybe something better?
460
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
461
 
 
462
 
                if kind != 'file' and kind != 'directory':
463
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
464
 
 
465
 
                if file_id is None:
466
 
                    file_id = gen_file_id(f)
467
 
                inv.add_path(f, kind=kind, file_id=file_id)
468
 
 
469
 
                if verbose:
470
 
                    print 'added', quotefn(f)
471
 
 
472
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
 
 
474
 
            self._write_inventory(inv)
475
 
        finally:
476
 
            self.unlock()
477
 
            
478
 
 
 
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
479
627
    def print_file(self, file, revno):
480
628
        """Print `file` to stdout."""
481
 
        self.lock_read()
482
 
        try:
483
 
            tree = self.revision_tree(self.lookup_revision(revno))
484
 
            # use inventory as it was in that revision
485
 
            file_id = tree.inventory.path2id(file)
486
 
            if not file_id:
487
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
488
 
            tree.print_file(file_id)
489
 
        finally:
490
 
            self.unlock()
491
 
 
492
 
 
493
 
    def remove(self, files, verbose=False):
494
 
        """Mark nominated files for removal from the inventory.
495
 
 
496
 
        This does not remove their text.  This does not run on 
497
 
 
498
 
        TODO: Refuse to remove modified files unless --force is given?
499
 
 
500
 
        TODO: Do something useful with directories.
501
 
 
502
 
        TODO: Should this remove the text or not?  Tough call; not
503
 
        removing may be useful and the user can just use use rm, and
504
 
        is the opposite of add.  Removing it is consistent with most
505
 
        other tools.  Maybe an option.
506
 
        """
507
 
        ## TODO: Normalize names
508
 
        ## TODO: Remove nested loops; better scalability
509
 
        if isinstance(files, basestring):
510
 
            files = [files]
511
 
 
512
 
        self.lock_write()
513
 
 
514
 
        try:
515
 
            tree = self.working_tree()
516
 
            inv = tree.inventory
517
 
 
518
 
            # do this before any modifications
519
 
            for f in files:
520
 
                fid = inv.path2id(f)
521
 
                if not fid:
522
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
524
 
                if verbose:
525
 
                    # having remove it, it must be either ignored or unknown
526
 
                    if tree.is_ignored(f):
527
 
                        new_status = 'I'
528
 
                    else:
529
 
                        new_status = '?'
530
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
531
 
                del inv[fid]
532
 
 
533
 
            self._write_inventory(inv)
534
 
        finally:
535
 
            self.unlock()
536
 
 
 
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)
537
635
 
538
636
    # FIXME: this doesn't need to be a branch method
539
637
    def set_inventory(self, new_inventory_list):
543
641
            name = os.path.basename(path)
544
642
            if name == "":
545
643
                continue
546
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
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)
547
653
        self._write_inventory(inv)
548
654
 
549
 
 
550
655
    def unknowns(self):
551
656
        """Return all unknown files.
552
657
 
553
658
        These are files in the working directory that are not versioned or
554
659
        control files or ignored.
555
660
        
 
661
        >>> from bzrlib.workingtree import WorkingTree
556
662
        >>> b = ScratchBranch(files=['foo', 'foo~'])
557
 
        >>> list(b.unknowns())
 
663
        >>> map(str, b.unknowns())
558
664
        ['foo']
559
665
        >>> b.add('foo')
560
666
        >>> list(b.unknowns())
561
667
        []
562
 
        >>> b.remove('foo')
 
668
        >>> WorkingTree(b.base, b).remove('foo')
563
669
        >>> list(b.unknowns())
564
670
        ['foo']
565
671
        """
566
672
        return self.working_tree().unknowns()
567
673
 
568
 
 
 
674
    @needs_write_lock
569
675
    def append_revision(self, *revision_ids):
570
 
        from bzrlib.atomicfile import AtomicFile
571
 
 
572
676
        for revision_id in revision_ids:
573
677
            mutter("add {%s} to revision-history" % revision_id)
574
 
 
575
678
        rev_history = self.revision_history()
576
679
        rev_history.extend(revision_ids)
577
 
 
578
 
        f = AtomicFile(self.controlfilename('revision-history'))
579
 
        try:
580
 
            for rev_id in rev_history:
581
 
                print >>f, rev_id
582
 
            f.commit()
583
 
        finally:
584
 
            f.close()
585
 
 
586
 
 
587
 
    def get_revision_xml(self, revision_id):
 
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):
588
692
        """Return XML file object for revision object."""
589
693
        if not revision_id or not isinstance(revision_id, basestring):
590
694
            raise InvalidRevisionId(revision_id)
591
 
 
592
 
        self.lock_read()
593
695
        try:
594
 
            try:
595
 
                return self.revision_store[revision_id]
596
 
            except IndexError:
597
 
                raise bzrlib.errors.NoSuchRevision(revision_id)
598
 
        finally:
599
 
            self.unlock()
 
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()
600
705
 
601
706
 
602
707
    def get_revision(self, revision_id):
603
708
        """Return the Revision object for a named revision"""
604
 
        xml_file = self.get_revision_xml(revision_id)
 
709
        xml_file = self.get_revision_xml_file(revision_id)
605
710
 
606
711
        try:
607
 
            r = unpack_xml(Revision, xml_file)
 
712
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
608
713
        except SyntaxError, e:
609
714
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
715
                                         [revision_id,
613
718
        assert r.revision_id == revision_id
614
719
        return r
615
720
 
616
 
 
617
721
    def get_revision_delta(self, revno):
618
722
        """Return the delta for one revision.
619
723
 
635
739
 
636
740
        return compare_trees(old_tree, new_tree)
637
741
 
638
 
        
639
 
 
640
742
    def get_revision_sha1(self, revision_id):
641
743
        """Hash the stored value of a revision, and return it."""
642
744
        # In the future, revision entries will be signed. At that
645
747
        # the revision, (add signatures/remove signatures) and still
646
748
        # have all hash pointers stay consistent.
647
749
        # But for now, just hash the contents.
648
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
649
 
 
650
 
 
651
 
    def get_inventory(self, inventory_id):
652
 
        """Get Inventory object by hash.
653
 
 
654
 
        TODO: Perhaps for this and similar methods, take a revision
655
 
               parameter which can be either an integer revno or a
656
 
               string hash."""
657
 
        from bzrlib.inventory import Inventory
658
 
        from bzrlib.xml import unpack_xml
659
 
 
660
 
        return unpack_xml(Inventory, self.inventory_store[inventory_id])
661
 
            
662
 
 
663
 
    def get_inventory_sha1(self, inventory_id):
 
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):
664
783
        """Return the sha1 hash of the inventory entry
665
784
        """
666
 
        return sha_file(self.inventory_store[inventory_id])
667
 
 
 
785
        return self.get_revision(revision_id).inventory_sha1
668
786
 
669
787
    def get_revision_inventory(self, revision_id):
670
788
        """Return inventory of a past revision."""
671
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
789
        # TODO: Unify this with get_inventory()
 
790
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
672
791
        # must be the same as its revision, so this is trivial.
673
792
        if revision_id == None:
674
 
            from bzrlib.inventory import Inventory
675
793
            return Inventory(self.get_root_id())
676
794
        else:
677
795
            return self.get_inventory(revision_id)
678
796
 
679
 
 
 
797
    @needs_read_lock
680
798
    def revision_history(self):
681
 
        """Return sequence of revision hashes on to this branch.
682
 
 
683
 
        >>> ScratchBranch().revision_history()
684
 
        []
685
 
        """
686
 
        self.lock_read()
687
 
        try:
688
 
            return [l.rstrip('\r\n') for l in
689
 
                    self.controlfile('revision-history', 'r').readlines()]
690
 
        finally:
691
 
            self.unlock()
692
 
 
693
 
 
694
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
695
 
        """
696
 
        >>> import commit
697
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
698
 
        >>> sb.common_ancestor(sb) == (None, None)
699
 
        True
700
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
701
 
        >>> sb.common_ancestor(sb)[0]
702
 
        1
703
 
        >>> clone = sb.clone()
704
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
705
 
        >>> sb.common_ancestor(sb)[0]
706
 
        2
707
 
        >>> sb.common_ancestor(clone)[0]
708
 
        1
709
 
        >>> commit.commit(clone, "Committing divergent second revision", 
710
 
        ...               verbose=False)
711
 
        >>> sb.common_ancestor(clone)[0]
712
 
        1
713
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
714
 
        True
715
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
716
 
        True
717
 
        >>> clone2 = sb.clone()
718
 
        >>> sb.common_ancestor(clone2)[0]
719
 
        2
720
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
721
 
        1
722
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
723
 
        1
724
 
        """
725
 
        my_history = self.revision_history()
726
 
        other_history = other.revision_history()
727
 
        if self_revno is None:
728
 
            self_revno = len(my_history)
729
 
        if other_revno is None:
730
 
            other_revno = len(other_history)
731
 
        indices = range(min((self_revno, other_revno)))
732
 
        indices.reverse()
733
 
        for r in indices:
734
 
            if my_history[r] == other_history[r]:
735
 
                return r+1, my_history[r]
736
 
        return None, None
737
 
 
 
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)
738
812
 
739
813
    def revno(self):
740
814
        """Return current revision number for this branch.
744
818
        """
745
819
        return len(self.revision_history())
746
820
 
747
 
 
748
 
    def last_patch(self):
 
821
    def last_revision(self):
749
822
        """Return last patch hash, or None if no history.
750
823
        """
751
824
        ph = self.revision_history()
754
827
        else:
755
828
            return None
756
829
 
757
 
 
758
 
    def missing_revisions(self, other, stop_revision=None):
759
 
        """
 
830
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
831
        """Return a list of new revisions that would perfectly fit.
 
832
        
760
833
        If self and other have not diverged, return a list of the revisions
761
834
        present in other, but missing from self.
762
835
 
793
866
 
794
867
        if stop_revision is None:
795
868
            stop_revision = other_len
796
 
        elif stop_revision > other_len:
797
 
            raise NoSuchRevision(self, stop_revision)
798
 
        
 
869
        else:
 
870
            assert isinstance(stop_revision, int)
 
871
            if stop_revision > other_len:
 
872
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
873
        return other_history[self_len:stop_revision]
800
874
 
801
 
 
802
875
    def update_revisions(self, other, stop_revision=None):
803
 
        """Pull in all new revisions from other branch.
804
 
        
805
 
        >>> from bzrlib.commit import commit
806
 
        >>> bzrlib.trace.silent = True
807
 
        >>> br1 = ScratchBranch(files=['foo', 'bar'])
808
 
        >>> br1.add('foo')
809
 
        >>> br1.add('bar')
810
 
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1", verbose=False)
811
 
        >>> br2 = ScratchBranch()
812
 
        >>> br2.update_revisions(br1)
813
 
        Added 2 texts.
814
 
        Added 1 inventories.
815
 
        Added 1 revisions.
816
 
        >>> br2.revision_history()
817
 
        [u'REVISION-ID-1']
818
 
        >>> br2.update_revisions(br1)
819
 
        Added 0 texts.
820
 
        Added 0 inventories.
821
 
        Added 0 revisions.
822
 
        >>> br1.text_store.total_size() == br2.text_store.total_size()
823
 
        True
824
 
        """
825
 
        from bzrlib.progress import ProgressBar
826
 
 
827
 
        pb = ProgressBar()
828
 
 
829
 
        pb.update('comparing histories')
830
 
        revision_ids = self.missing_revisions(other, stop_revision)
831
 
 
832
 
        if hasattr(other.revision_store, "prefetch"):
833
 
            other.revision_store.prefetch(revision_ids)
834
 
        if hasattr(other.inventory_store, "prefetch"):
835
 
            inventory_ids = [other.get_revision(r).inventory_id
836
 
                             for r in revision_ids]
837
 
            other.inventory_store.prefetch(inventory_ids)
838
 
                
839
 
        revisions = []
840
 
        needed_texts = set()
841
 
        i = 0
842
 
        for rev_id in revision_ids:
843
 
            i += 1
844
 
            pb.update('fetching revision', i, len(revision_ids))
845
 
            rev = other.get_revision(rev_id)
846
 
            revisions.append(rev)
847
 
            inv = other.get_inventory(str(rev.inventory_id))
848
 
            for key, entry in inv.iter_entries():
849
 
                if entry.text_id is None:
850
 
                    continue
851
 
                if entry.text_id not in self.text_store:
852
 
                    needed_texts.add(entry.text_id)
853
 
 
854
 
        pb.clear()
855
 
                    
856
 
        count = self.text_store.copy_multi(other.text_store, needed_texts)
857
 
        print "Added %d texts." % count 
858
 
        inventory_ids = [ f.inventory_id for f in revisions ]
859
 
        count = self.inventory_store.copy_multi(other.inventory_store, 
860
 
                                                inventory_ids)
861
 
        print "Added %d inventories." % count 
862
 
        revision_ids = [ f.revision_id for f in revisions]
863
 
        count = self.revision_store.copy_multi(other.revision_store, 
864
 
                                               revision_ids)
865
 
        for revision_id in revision_ids:
866
 
            self.append_revision(revision_id)
867
 
        print "Added %d revisions." % count
868
 
                    
 
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
869
908
        
870
909
    def commit(self, *args, **kw):
871
 
        from bzrlib.commit import commit
872
 
        commit(self, *args, **kw)
873
 
        
874
 
 
875
 
    def lookup_revision(self, revision):
876
 
        """Return the revision identifier for a given revision information."""
877
 
        revno, info = self.get_revision_info(revision)
878
 
        return info
879
 
 
880
 
    def get_revision_info(self, revision):
881
 
        """Return (revno, revision id) for revision identifier.
882
 
 
883
 
        revision can be an integer, in which case it is assumed to be revno (though
884
 
            this will translate negative values into positive ones)
885
 
        revision can also be a string, in which case it is parsed for something like
886
 
            'date:' or 'revid:' etc.
887
 
        """
888
 
        if revision is None:
889
 
            return 0, None
890
 
        revno = None
891
 
        try:# Convert to int if possible
892
 
            revision = int(revision)
893
 
        except ValueError:
894
 
            pass
895
 
        revs = self.revision_history()
896
 
        if isinstance(revision, int):
897
 
            if revision == 0:
898
 
                return 0, None
899
 
            # Mabye we should do this first, but we don't need it if revision == 0
900
 
            if revision < 0:
901
 
                revno = len(revs) + revision + 1
902
 
            else:
903
 
                revno = revision
904
 
        elif isinstance(revision, basestring):
905
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
906
 
                if revision.startswith(prefix):
907
 
                    revno = func(self, revs, revision)
908
 
                    break
909
 
            else:
910
 
                raise BzrError('No namespace registered for string: %r' % revision)
911
 
 
912
 
        if revno is None or revno <= 0 or revno > len(revs):
913
 
            raise BzrError("no such revision %s" % revision)
914
 
        return revno, revs[revno-1]
915
 
 
916
 
    def _namespace_revno(self, revs, revision):
917
 
        """Lookup a revision by revision number"""
918
 
        assert revision.startswith('revno:')
919
 
        try:
920
 
            return int(revision[6:])
921
 
        except ValueError:
922
 
            return None
923
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
924
 
 
925
 
    def _namespace_revid(self, revs, revision):
926
 
        assert revision.startswith('revid:')
927
 
        try:
928
 
            return revs.index(revision[6:]) + 1
929
 
        except ValueError:
930
 
            return None
931
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
932
 
 
933
 
    def _namespace_last(self, revs, revision):
934
 
        assert revision.startswith('last:')
935
 
        try:
936
 
            offset = int(revision[5:])
937
 
        except ValueError:
938
 
            return None
939
 
        else:
940
 
            if offset <= 0:
941
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
942
 
            return len(revs) - offset + 1
943
 
    REVISION_NAMESPACES['last:'] = _namespace_last
944
 
 
945
 
    def _namespace_tag(self, revs, revision):
946
 
        assert revision.startswith('tag:')
947
 
        raise BzrError('tag: namespace registered, but not implemented.')
948
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
949
 
 
950
 
    def _namespace_date(self, revs, revision):
951
 
        assert revision.startswith('date:')
952
 
        import datetime
953
 
        # Spec for date revisions:
954
 
        #   date:value
955
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
956
 
        #   it can also start with a '+/-/='. '+' says match the first
957
 
        #   entry after the given date. '-' is match the first entry before the date
958
 
        #   '=' is match the first entry after, but still on the given date.
959
 
        #
960
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
961
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
962
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
963
 
        #       May 13th, 2005 at 0:00
964
 
        #
965
 
        #   So the proper way of saying 'give me all entries for today' is:
966
 
        #       -r {date:+today}:{date:-tomorrow}
967
 
        #   The default is '=' when not supplied
968
 
        val = revision[5:]
969
 
        match_style = '='
970
 
        if val[:1] in ('+', '-', '='):
971
 
            match_style = val[:1]
972
 
            val = val[1:]
973
 
 
974
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
975
 
        if val.lower() == 'yesterday':
976
 
            dt = today - datetime.timedelta(days=1)
977
 
        elif val.lower() == 'today':
978
 
            dt = today
979
 
        elif val.lower() == 'tomorrow':
980
 
            dt = today + datetime.timedelta(days=1)
981
 
        else:
982
 
            import re
983
 
            # This should be done outside the function to avoid recompiling it.
984
 
            _date_re = re.compile(
985
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
986
 
                    r'(,|T)?\s*'
987
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
988
 
                )
989
 
            m = _date_re.match(val)
990
 
            if not m or (not m.group('date') and not m.group('time')):
991
 
                raise BzrError('Invalid revision date %r' % revision)
992
 
 
993
 
            if m.group('date'):
994
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
995
 
            else:
996
 
                year, month, day = today.year, today.month, today.day
997
 
            if m.group('time'):
998
 
                hour = int(m.group('hour'))
999
 
                minute = int(m.group('minute'))
1000
 
                if m.group('second'):
1001
 
                    second = int(m.group('second'))
1002
 
                else:
1003
 
                    second = 0
1004
 
            else:
1005
 
                hour, minute, second = 0,0,0
1006
 
 
1007
 
            dt = datetime.datetime(year=year, month=month, day=day,
1008
 
                    hour=hour, minute=minute, second=second)
1009
 
        first = dt
1010
 
        last = None
1011
 
        reversed = False
1012
 
        if match_style == '-':
1013
 
            reversed = True
1014
 
        elif match_style == '=':
1015
 
            last = dt + datetime.timedelta(days=1)
1016
 
 
1017
 
        if reversed:
1018
 
            for i in range(len(revs)-1, -1, -1):
1019
 
                r = self.get_revision(revs[i])
1020
 
                # TODO: Handle timezone.
1021
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1022
 
                if first >= dt and (last is None or dt >= last):
1023
 
                    return i+1
1024
 
        else:
1025
 
            for i in range(len(revs)):
1026
 
                r = self.get_revision(revs[i])
1027
 
                # TODO: Handle timezone.
1028
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1029
 
                if first <= dt and (last is None or dt <= last):
1030
 
                    return i+1
1031
 
    REVISION_NAMESPACES['date:'] = _namespace_date
 
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]
1032
932
 
1033
933
    def revision_tree(self, revision_id):
1034
934
        """Return Tree for a revision on this branch.
1041
941
            return EmptyTree()
1042
942
        else:
1043
943
            inv = self.get_revision_inventory(revision_id)
1044
 
            return RevisionTree(self.text_store, inv)
1045
 
 
 
944
            return RevisionTree(self.weave_store, inv, revision_id)
1046
945
 
1047
946
    def working_tree(self):
1048
947
        """Return a `Tree` for the working copy."""
1049
 
        from workingtree import WorkingTree
1050
 
        return WorkingTree(self.base, self.read_working_inventory())
 
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)
1051
955
 
1052
956
 
1053
957
    def basis_tree(self):
1055
959
 
1056
960
        If there are no revisions yet, return an `EmptyTree`.
1057
961
        """
1058
 
        r = self.last_patch()
1059
 
        if r == None:
1060
 
            return EmptyTree()
1061
 
        else:
1062
 
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
1063
 
 
1064
 
 
1065
 
 
 
962
        return self.revision_tree(self.last_revision())
 
963
 
 
964
    @needs_write_lock
1066
965
    def rename_one(self, from_rel, to_rel):
1067
966
        """Rename one file.
1068
967
 
1069
968
        This can change the directory or the filename or both.
1070
969
        """
1071
 
        self.lock_write()
 
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)
1072
1000
        try:
1073
 
            tree = self.working_tree()
1074
 
            inv = tree.inventory
1075
 
            if not tree.has_filename(from_rel):
1076
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1077
 
            if tree.has_filename(to_rel):
1078
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
1079
 
 
1080
 
            file_id = inv.path2id(from_rel)
1081
 
            if file_id == None:
1082
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1083
 
 
1084
 
            if inv.path2id(to_rel):
1085
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1086
 
 
1087
 
            to_dir, to_tail = os.path.split(to_rel)
1088
 
            to_dir_id = inv.path2id(to_dir)
1089
 
            if to_dir_id == None and to_dir != '':
1090
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
1091
 
 
1092
 
            mutter("rename_one:")
1093
 
            mutter("  file_id    {%s}" % file_id)
1094
 
            mutter("  from_rel   %r" % from_rel)
1095
 
            mutter("  to_rel     %r" % to_rel)
1096
 
            mutter("  to_dir     %r" % to_dir)
1097
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
1098
 
 
1099
 
            inv.rename(file_id, to_dir_id, to_tail)
1100
 
 
1101
 
            print "%s => %s" % (from_rel, to_rel)
1102
 
 
1103
 
            from_abs = self.abspath(from_rel)
1104
 
            to_abs = self.abspath(to_rel)
1105
 
            try:
1106
 
                os.rename(from_abs, to_abs)
1107
 
            except OSError, e:
1108
 
                raise BzrError("failed to rename %r to %r: %s"
1109
 
                        % (from_abs, to_abs, e[1]),
1110
 
                        ["rename rolled back"])
1111
 
 
1112
 
            self._write_inventory(inv)
1113
 
        finally:
1114
 
            self.unlock()
1115
 
 
1116
 
 
 
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
1117
1010
    def move(self, from_paths, to_name):
1118
1011
        """Rename files.
1119
1012
 
1124
1017
 
1125
1018
        Note that to_name is only the last component of the new name;
1126
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.
1127
1023
        """
1128
 
        self.lock_write()
1129
 
        try:
1130
 
            ## TODO: Option to move IDs only
1131
 
            assert not isinstance(from_paths, basestring)
1132
 
            tree = self.working_tree()
1133
 
            inv = tree.inventory
1134
 
            to_abs = self.abspath(to_name)
1135
 
            if not isdir(to_abs):
1136
 
                raise BzrError("destination %r is not a directory" % to_abs)
1137
 
            if not tree.has_filename(to_name):
1138
 
                raise BzrError("destination %r not in working directory" % to_abs)
1139
 
            to_dir_id = inv.path2id(to_name)
1140
 
            if to_dir_id == None and to_name != '':
1141
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1142
 
            to_dir_ie = inv[to_dir_id]
1143
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
 
                raise BzrError("destination %r is not a directory" % to_abs)
1145
 
 
1146
 
            to_idpath = inv.get_idpath(to_dir_id)
1147
 
 
1148
 
            for f in from_paths:
1149
 
                if not tree.has_filename(f):
1150
 
                    raise BzrError("%r does not exist in working tree" % f)
1151
 
                f_id = inv.path2id(f)
1152
 
                if f_id == None:
1153
 
                    raise BzrError("%r is not versioned" % f)
1154
 
                name_tail = splitpath(f)[-1]
1155
 
                dest_path = appendpath(to_name, name_tail)
1156
 
                if tree.has_filename(dest_path):
1157
 
                    raise BzrError("destination %r already exists" % dest_path)
1158
 
                if f_id in to_idpath:
1159
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1160
 
 
1161
 
            # OK, so there's a race here, it's possible that someone will
1162
 
            # create a file in this interval and then the rename might be
1163
 
            # left half-done.  But we should have caught most problems.
1164
 
 
1165
 
            for f in from_paths:
1166
 
                name_tail = splitpath(f)[-1]
1167
 
                dest_path = appendpath(to_name, name_tail)
1168
 
                print "%s => %s" % (f, dest_path)
1169
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1170
 
                try:
1171
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1172
 
                except OSError, e:
1173
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
 
                            ["rename rolled back"])
1175
 
 
1176
 
            self._write_inventory(inv)
1177
 
        finally:
1178
 
            self.unlock()
 
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
1179
1073
 
1180
1074
 
1181
1075
    def revert(self, filenames, old_tree=None, backups=True):
1185
1079
            If true (default) backups are made of files before
1186
1080
            they're renamed.
1187
1081
        """
1188
 
        from bzrlib.errors import NotVersionedError, BzrError
1189
1082
        from bzrlib.atomicfile import AtomicFile
1190
1083
        from bzrlib.osutils import backup_file
1191
1084
        
1198
1091
        for fn in filenames:
1199
1092
            file_id = inv.path2id(fn)
1200
1093
            if not file_id:
1201
 
                raise NotVersionedError("not a versioned file", fn)
 
1094
                raise NotVersionedError(path=fn)
1202
1095
            if not old_inv.has_id(file_id):
1203
1096
                raise BzrError("file not present in old tree", fn, file_id)
1204
1097
            nids.append((fn, file_id))
1228
1121
        These are revisions that have been merged into the working
1229
1122
        directory but not yet committed.
1230
1123
        """
1231
 
        cfn = self.controlfilename('pending-merges')
1232
 
        if not os.path.exists(cfn):
 
1124
        cfn = self._rel_controlfilename('pending-merges')
 
1125
        if not self._transport.has(cfn):
1233
1126
            return []
1234
1127
        p = []
1235
1128
        for l in self.controlfile('pending-merges', 'r').readlines():
1237
1130
        return p
1238
1131
 
1239
1132
 
1240
 
    def add_pending_merge(self, revision_id):
1241
 
        from bzrlib.revision import validate_revision_id
1242
 
 
1243
 
        validate_revision_id(revision_id)
1244
 
 
 
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?
1245
1136
        p = self.pending_merges()
1246
 
        if revision_id in p:
1247
 
            return
1248
 
        p.append(revision_id)
1249
 
        self.set_pending_merges(p)
1250
 
 
1251
 
 
 
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
1252
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?
1253
1170
        from bzrlib.atomicfile import AtomicFile
1254
 
        self.lock_write()
 
1171
        f = AtomicFile(self.controlfilename('parent'))
1255
1172
        try:
1256
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1257
 
            try:
1258
 
                for l in rev_list:
1259
 
                    print >>f, l
1260
 
                f.commit()
1261
 
            finally:
1262
 
                f.close()
 
1173
            f.write(url + '\n')
 
1174
            f.commit()
1263
1175
        finally:
1264
 
            self.unlock()
1265
 
 
1266
 
 
1267
 
 
1268
 
class ScratchBranch(Branch):
 
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):
1269
1205
    """Special test class: a branch that cleans up after itself.
1270
1206
 
1271
1207
    >>> b = ScratchBranch()
1272
1208
    >>> isdir(b.base)
1273
1209
    True
1274
1210
    >>> bd = b.base
1275
 
    >>> b.destroy()
 
1211
    >>> b._transport.__del__()
1276
1212
    >>> isdir(bd)
1277
1213
    False
1278
1214
    """
1279
 
    def __init__(self, files=[], dirs=[], base=None):
 
1215
 
 
1216
    def __init__(self, files=[], dirs=[], transport=None):
1280
1217
        """Make a test branch.
1281
1218
 
1282
1219
        This creates a temporary directory and runs init-tree in it.
1283
1220
 
1284
1221
        If any files are listed, they are created in the working copy.
1285
1222
        """
1286
 
        from tempfile import mkdtemp
1287
 
        init = False
1288
 
        if base is None:
1289
 
            base = mkdtemp()
1290
 
            init = True
1291
 
        Branch.__init__(self, base, init=init)
 
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
 
1292
1229
        for d in dirs:
1293
 
            os.mkdir(self.abspath(d))
 
1230
            self._transport.mkdir(d)
1294
1231
            
1295
1232
        for f in files:
1296
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1233
            self._transport.put(f, 'content of %s' % f)
1297
1234
 
1298
1235
 
1299
1236
    def clone(self):
1300
1237
        """
1301
1238
        >>> orig = ScratchBranch(files=["file1", "file2"])
1302
1239
        >>> clone = orig.clone()
1303
 
        >>> os.path.samefile(orig.base, clone.base)
 
1240
        >>> if os.name != 'nt':
 
1241
        ...   os.path.samefile(orig.base, clone.base)
 
1242
        ... else:
 
1243
        ...   orig.base == clone.base
 
1244
        ...
1304
1245
        False
1305
1246
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
1247
        True
1310
1251
        base = mkdtemp()
1311
1252
        os.rmdir(base)
1312
1253
        copytree(self.base, base, symlinks=True)
1313
 
        return ScratchBranch(base=base)
1314
 
        
1315
 
    def __del__(self):
1316
 
        self.destroy()
1317
 
 
1318
 
    def destroy(self):
1319
 
        """Destroy the test branch, removing the scratch directory."""
1320
 
        from shutil import rmtree
1321
 
        try:
1322
 
            if self.base:
1323
 
                mutter("delete ScratchBranch %s" % self.base)
1324
 
                rmtree(self.base)
1325
 
        except OSError, e:
1326
 
            # Work around for shutil.rmtree failing on Windows when
1327
 
            # readonly files are encountered
1328
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
 
            for root, dirs, files in os.walk(self.base, topdown=False):
1330
 
                for name in files:
1331
 
                    os.chmod(os.path.join(root, name), 0700)
1332
 
            rmtree(self.base)
1333
 
        self.base = None
1334
 
 
 
1254
        return ScratchBranch(
 
1255
            transport=bzrlib.transport.local.ScratchTransport(base))
1335
1256
    
1336
1257
 
1337
1258
######################################################################
1386
1307
    """Return a new tree-root file id."""
1387
1308
    return gen_file_id('TREE_ROOT')
1388
1309
 
 
1310