~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-10-24 13:59:18 UTC
  • mfrom: (1185.20.1)
  • Revision ID: robertc@robertcollins.net-20051024135918-024629d7ee347b5c
fix upgrading of trees with no commits

Show diffs side-by-side

added added

removed removed

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