/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2005-10-18 18:48:27 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1474.
  • Revision ID: abentley@panoramicfeedback.com-20051018184827-2cc69376beb1cdf3
Switched to ConfigObj

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)
 
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)
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
import bzrlib.transactions as transactions
 
48
from bzrlib.transport import Transport, get_transport
 
49
import bzrlib.xml5
 
50
import bzrlib.ui
 
51
 
 
52
 
 
53
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
54
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
55
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
35
56
## TODO: Maybe include checks for common corruption of newlines, etc?
36
57
 
37
58
 
38
59
# TODO: Some operations like log might retrieve the same revisions
39
60
# 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
 
 
 
61
# cache in memory to make this faster.  In general anything can be
 
62
# cached in memory between lock and unlock operations.
 
63
 
 
64
def find_branch(*ignored, **ignored_too):
 
65
    # XXX: leave this here for about one release, then remove it
 
66
    raise NotImplementedError('find_branch() is not supported anymore, '
 
67
                              'please use one of the new branch constructors')
132
68
 
133
69
######################################################################
134
70
# branch objects
137
73
    """Branch holding a history of revisions.
138
74
 
139
75
    base
140
 
        Base directory of the branch.
 
76
        Base directory/url of the branch.
 
77
    """
 
78
    base = None
 
79
 
 
80
    def __init__(self, *ignored, **ignored_too):
 
81
        raise NotImplementedError('The Branch class is abstract')
 
82
 
 
83
    @staticmethod
 
84
    def open_downlevel(base):
 
85
        """Open a branch which may be of an old format.
 
86
        
 
87
        Only local branches are supported."""
 
88
        return _Branch(get_transport(base), relax_version_check=True)
 
89
        
 
90
    @staticmethod
 
91
    def open(base):
 
92
        """Open an existing branch, rooted at 'base' (url)"""
 
93
        t = get_transport(base)
 
94
        mutter("trying to open %r with transport %r", base, t)
 
95
        return _Branch(t)
 
96
 
 
97
    @staticmethod
 
98
    def open_containing(url):
 
99
        """Open an existing branch which contains url.
 
100
        
 
101
        This probes for a branch at url, and searches upwards from there.
 
102
 
 
103
        Basically we keep looking up until we find the control directory or
 
104
        run into the root.  If there isn't one, raises NotBranchError.
 
105
        """
 
106
        t = get_transport(url)
 
107
        while True:
 
108
            try:
 
109
                return _Branch(t)
 
110
            except NotBranchError:
 
111
                pass
 
112
            new_t = t.clone('..')
 
113
            if new_t.base == t.base:
 
114
                # reached the root, whatever that may be
 
115
                raise NotBranchError('%s is not in a branch' % url)
 
116
            t = new_t
 
117
 
 
118
    @staticmethod
 
119
    def initialize(base):
 
120
        """Create a new branch, rooted at 'base' (url)"""
 
121
        t = get_transport(base)
 
122
        return _Branch(t, init=True)
 
123
 
 
124
    def setup_caching(self, cache_root):
 
125
        """Subclasses that care about caching should override this, and set
 
126
        up cached stores located under cache_root.
 
127
        """
 
128
        self.cache_root = cache_root
 
129
 
 
130
 
 
131
class _Branch(Branch):
 
132
    """A branch stored in the actual filesystem.
 
133
 
 
134
    Note that it's "local" in the context of the filesystem; it doesn't
 
135
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
136
    it's writable, and can be accessed via the normal filesystem API.
141
137
 
142
138
    _lock_mode
143
139
        None, or 'r' or 'w'
149
145
    _lock
150
146
        Lock object from bzrlib.lock.
151
147
    """
152
 
    base = None
 
148
    # We actually expect this class to be somewhat short-lived; part of its
 
149
    # purpose is to try to isolate what bits of the branch logic are tied to
 
150
    # filesystem access, so that in a later step, we can extricate them to
 
151
    # a separarte ("storage") class.
153
152
    _lock_mode = None
154
153
    _lock_count = None
155
154
    _lock = None
 
155
    _inventory_weave = None
156
156
    
157
157
    # Map some sort of prefix into a namespace
158
158
    # stuff like "revno:10", "revid:", etc.
159
159
    # This should match a prefix with a function which accepts
160
160
    REVISION_NAMESPACES = {}
161
161
 
162
 
    def __init__(self, base, init=False, find_root=True):
 
162
    def push_stores(self, branch_to):
 
163
        """Copy the content of this branches store to branch_to."""
 
164
        if (self._branch_format != branch_to._branch_format
 
165
            or self._branch_format != 4):
 
166
            from bzrlib.fetch import greedy_fetch
 
167
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
 
168
                   self, self._branch_format, branch_to, branch_to._branch_format)
 
169
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
170
                         revision=self.last_revision())
 
171
            return
 
172
 
 
173
        store_pairs = ((self.text_store,      branch_to.text_store),
 
174
                       (self.inventory_store, branch_to.inventory_store),
 
175
                       (self.revision_store,  branch_to.revision_store))
 
176
        try:
 
177
            for from_store, to_store in store_pairs: 
 
178
                copy_all(from_store, to_store)
 
179
        except UnlistableStore:
 
180
            raise UnlistableBranch(from_store)
 
181
 
 
182
    def __init__(self, transport, init=False,
 
183
                 relax_version_check=False):
163
184
        """Create new branch object at a particular location.
164
185
 
165
 
        base -- Base directory for the branch.
 
186
        transport -- A Transport object, defining how to access files.
 
187
                (If a string, transport.transport() will be used to
 
188
                create a Transport object)
166
189
        
167
190
        init -- If True, create new control files in a previously
168
191
             unversioned directory.  If False, the branch must already
169
192
             be versioned.
170
193
 
171
 
        find_root -- If true and init is false, find the root of the
172
 
             existing branch containing base.
 
194
        relax_version_check -- If true, the usual check for the branch
 
195
            version is not applied.  This is intended only for
 
196
            upgrade/recovery type use; it's not guaranteed that
 
197
            all operations will work on old format branches.
173
198
 
174
199
        In the test suite, creation of new trees is tested using the
175
200
        `ScratchBranch` class.
176
201
        """
177
 
        from bzrlib.store import ImmutableStore
 
202
        assert isinstance(transport, Transport), \
 
203
            "%r is not a Transport" % transport
 
204
        self._transport = transport
178
205
        if init:
179
 
            self.base = os.path.realpath(base)
180
206
            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
 
 
 
207
        self._check_format(relax_version_check)
 
208
 
 
209
        def get_store(name, compressed=True, prefixed=False):
 
210
            # FIXME: This approach of assuming stores are all entirely compressed
 
211
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
212
            # some existing branches where there's a mixture; we probably 
 
213
            # still want the option to look for both.
 
214
            relpath = self._rel_controlfilename(name)
 
215
            if compressed:
 
216
                store = CompressedTextStore(self._transport.clone(relpath),
 
217
                                            prefixed=prefixed)
 
218
            else:
 
219
                store = TextStore(self._transport.clone(relpath),
 
220
                                  prefixed=prefixed)
 
221
            #if self._transport.should_cache():
 
222
            #    cache_path = os.path.join(self.cache_root, name)
 
223
            #    os.mkdir(cache_path)
 
224
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
225
            return store
 
226
        def get_weave(name, prefixed=False):
 
227
            relpath = self._rel_controlfilename(name)
 
228
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
 
229
            if self._transport.should_cache():
 
230
                ws.enable_cache = True
 
231
            return ws
 
232
 
 
233
        if self._branch_format == 4:
 
234
            self.inventory_store = get_store('inventory-store')
 
235
            self.text_store = get_store('text-store')
 
236
            self.revision_store = get_store('revision-store')
 
237
        elif self._branch_format == 5:
 
238
            self.control_weaves = get_weave([])
 
239
            self.weave_store = get_weave('weaves')
 
240
            self.revision_store = get_store('revision-store', compressed=False)
 
241
        elif self._branch_format == 6:
 
242
            self.control_weaves = get_weave([])
 
243
            self.weave_store = get_weave('weaves', prefixed=True)
 
244
            self.revision_store = get_store('revision-store', compressed=False,
 
245
                                            prefixed=True)
 
246
        self._transaction = None
196
247
 
197
248
    def __str__(self):
198
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
249
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
199
250
 
200
251
 
201
252
    __repr__ = __str__
203
254
 
204
255
    def __del__(self):
205
256
        if self._lock_mode or self._lock:
206
 
            from warnings import warn
 
257
            # XXX: This should show something every time, and be suitable for
 
258
            # headless operation and embedding
207
259
            warn("branch %r was not explicitly unlocked" % self)
208
260
            self._lock.unlock()
209
261
 
210
 
 
 
262
        # TODO: It might be best to do this somewhere else,
 
263
        # but it is nice for a Branch object to automatically
 
264
        # cache it's information.
 
265
        # Alternatively, we could have the Transport objects cache requests
 
266
        # See the earlier discussion about how major objects (like Branch)
 
267
        # should never expect their __del__ function to run.
 
268
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
269
            try:
 
270
                import shutil
 
271
                shutil.rmtree(self.cache_root)
 
272
            except:
 
273
                pass
 
274
            self.cache_root = None
 
275
 
 
276
    def _get_base(self):
 
277
        if self._transport:
 
278
            return self._transport.base
 
279
        return None
 
280
 
 
281
    base = property(_get_base, doc="The URL for the root of this branch.")
 
282
 
 
283
    def _finish_transaction(self):
 
284
        """Exit the current transaction."""
 
285
        if self._transaction is None:
 
286
            raise errors.LockError('Branch %s is not in a transaction' %
 
287
                                   self)
 
288
        transaction = self._transaction
 
289
        self._transaction = None
 
290
        transaction.finish()
 
291
 
 
292
    def get_transaction(self):
 
293
        """Return the current active transaction.
 
294
 
 
295
        If no transaction is active, this returns a passthrough object
 
296
        for which all data is immedaitely flushed and no caching happens.
 
297
        """
 
298
        if self._transaction is None:
 
299
            return transactions.PassThroughTransaction()
 
300
        else:
 
301
            return self._transaction
 
302
 
 
303
    def _set_transaction(self, new_transaction):
 
304
        """Set a new active transaction."""
 
305
        if self._transaction is not None:
 
306
            raise errors.LockError('Branch %s is in a transaction already.' %
 
307
                                   self)
 
308
        self._transaction = new_transaction
211
309
 
212
310
    def lock_write(self):
 
311
        mutter("lock write: %s (%s)", self, self._lock_count)
 
312
        # TODO: Upgrade locking to support using a Transport,
 
313
        # and potentially a remote locking protocol
213
314
        if self._lock_mode:
214
315
            if self._lock_mode != 'w':
215
 
                from errors import LockError
216
316
                raise LockError("can't upgrade to a write lock from %r" %
217
317
                                self._lock_mode)
218
318
            self._lock_count += 1
219
319
        else:
220
 
            from bzrlib.lock import WriteLock
221
 
 
222
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
320
            self._lock = self._transport.lock_write(
 
321
                    self._rel_controlfilename('branch-lock'))
223
322
            self._lock_mode = 'w'
224
323
            self._lock_count = 1
225
 
 
226
 
 
 
324
            self._set_transaction(transactions.PassThroughTransaction())
227
325
 
228
326
    def lock_read(self):
 
327
        mutter("lock read: %s (%s)", self, self._lock_count)
229
328
        if self._lock_mode:
230
329
            assert self._lock_mode in ('r', 'w'), \
231
330
                   "invalid lock mode %r" % self._lock_mode
232
331
            self._lock_count += 1
233
332
        else:
234
 
            from bzrlib.lock import ReadLock
235
 
 
236
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
333
            self._lock = self._transport.lock_read(
 
334
                    self._rel_controlfilename('branch-lock'))
237
335
            self._lock_mode = 'r'
238
336
            self._lock_count = 1
 
337
            self._set_transaction(transactions.ReadOnlyTransaction())
 
338
            # 5K may be excessive, but hey, its a knob.
 
339
            self.get_transaction().set_cache_size(5000)
239
340
                        
240
 
 
241
 
            
242
341
    def unlock(self):
 
342
        mutter("unlock: %s (%s)", self, self._lock_count)
243
343
        if not self._lock_mode:
244
 
            from errors import LockError
245
344
            raise LockError('branch %r is not locked' % (self))
246
345
 
247
346
        if self._lock_count > 1:
248
347
            self._lock_count -= 1
249
348
        else:
 
349
            self._finish_transaction()
250
350
            self._lock.unlock()
251
351
            self._lock = None
252
352
            self._lock_mode = self._lock_count = None
253
353
 
254
 
 
255
354
    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
 
 
 
355
        """Return absolute filename for something in the branch
 
356
        
 
357
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
358
        method and not a tree method.
 
359
        """
 
360
        return self._transport.abspath(name)
 
361
 
 
362
    def _rel_controlfilename(self, file_or_path):
 
363
        if isinstance(file_or_path, basestring):
 
364
            file_or_path = [file_or_path]
 
365
        return [bzrlib.BZRDIR] + file_or_path
266
366
 
267
367
    def controlfilename(self, file_or_path):
268
368
        """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)
 
369
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
272
370
 
273
371
 
274
372
    def controlfile(self, file_or_path, mode='r'):
282
380
        Controlfiles should almost never be opened in write mode but
283
381
        rather should be atomically copied and replaced using atomicfile.
284
382
        """
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)
 
383
        import codecs
 
384
 
 
385
        relpath = self._rel_controlfilename(file_or_path)
 
386
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
387
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
388
        if mode == 'rb': 
 
389
            return self._transport.get(relpath)
 
390
        elif mode == 'wb':
 
391
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
392
        elif mode == 'r':
 
393
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
394
        elif mode == 'w':
 
395
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
296
396
        else:
297
397
            raise BzrError("invalid controlfile mode %r" % mode)
298
398
 
299
 
 
 
399
    def put_controlfile(self, path, f, encode=True):
 
400
        """Write an entry as a controlfile.
 
401
 
 
402
        :param path: The path to put the file, relative to the .bzr control
 
403
                     directory
 
404
        :param f: A file-like or string object whose contents should be copied.
 
405
        :param encode:  If true, encode the contents as utf-8
 
406
        """
 
407
        self.put_controlfiles([(path, f)], encode=encode)
 
408
 
 
409
    def put_controlfiles(self, files, encode=True):
 
410
        """Write several entries as controlfiles.
 
411
 
 
412
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
413
                      underneath the bzr control directory
 
414
        :param encode:  If true, encode the contents as utf-8
 
415
        """
 
416
        import codecs
 
417
        ctrl_files = []
 
418
        for path, f in files:
 
419
            if encode:
 
420
                if isinstance(f, basestring):
 
421
                    f = f.encode('utf-8', 'replace')
 
422
                else:
 
423
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
424
            path = self._rel_controlfilename(path)
 
425
            ctrl_files.append((path, f))
 
426
        self._transport.put_multi(ctrl_files)
300
427
 
301
428
    def _make_control(self):
302
429
        from bzrlib.inventory import Inventory
303
 
        from bzrlib.xml import pack_xml
 
430
        from bzrlib.weavefile import write_weave_v5
 
431
        from bzrlib.weave import Weave
304
432
        
305
 
        os.mkdir(self.controlfilename([]))
306
 
        self.controlfile('README', 'w').write(
 
433
        # Create an empty inventory
 
434
        sio = StringIO()
 
435
        # if we want per-tree root ids then this is the place to set
 
436
        # them; they're not needed for now and so ommitted for
 
437
        # simplicity.
 
438
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
 
439
        empty_inv = sio.getvalue()
 
440
        sio = StringIO()
 
441
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
442
        empty_weave = sio.getvalue()
 
443
 
 
444
        dirs = [[], 'revision-store', 'weaves']
 
445
        files = [('README', 
307
446
            "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):
 
447
            "Do not change any files in this directory.\n"),
 
448
            ('branch-format', BZR_BRANCH_FORMAT_6),
 
449
            ('revision-history', ''),
 
450
            ('branch-name', ''),
 
451
            ('branch-lock', ''),
 
452
            ('pending-merges', ''),
 
453
            ('inventory', empty_inv),
 
454
            ('inventory.weave', empty_weave),
 
455
            ('ancestry.weave', empty_weave)
 
456
        ]
 
457
        cfn = self._rel_controlfilename
 
458
        self._transport.mkdir_multi([cfn(d) for d in dirs])
 
459
        self.put_controlfiles(files)
 
460
        mutter('created control directory in ' + self._transport.base)
 
461
 
 
462
    def _check_format(self, relax_version_check):
323
463
        """Check this branch format is supported.
324
464
 
325
 
        The current tool only supports the current unstable format.
 
465
        The format level is stored, as an integer, in
 
466
        self._branch_format for code that needs to check it later.
326
467
 
327
468
        In the future, we might need different in-memory Branch
328
469
        classes to support downlevel branches.  But not yet.
329
470
        """
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,
 
471
        try:
 
472
            fmt = self.controlfile('branch-format', 'r').read()
 
473
        except NoSuchFile:
 
474
            raise NotBranchError(self.base)
 
475
        mutter("got branch format %r", fmt)
 
476
        if fmt == BZR_BRANCH_FORMAT_6:
 
477
            self._branch_format = 6
 
478
        elif fmt == BZR_BRANCH_FORMAT_5:
 
479
            self._branch_format = 5
 
480
        elif fmt == BZR_BRANCH_FORMAT_4:
 
481
            self._branch_format = 4
 
482
 
 
483
        if (not relax_version_check
 
484
            and self._branch_format not in (5, 6)):
 
485
            raise errors.UnsupportedFormatError(
 
486
                           'sorry, branch format %r not supported' % fmt,
337
487
                           ['use a different bzr version',
338
 
                            'or remove the .bzr directory and "bzr init" again'])
 
488
                            'or remove the .bzr directory'
 
489
                            ' and "bzr init" again'])
339
490
 
340
491
    def get_root_id(self):
341
492
        """Return the id of this branches root"""
356
507
 
357
508
    def read_working_inventory(self):
358
509
        """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
510
        self.lock_read()
364
511
        try:
365
512
            # ElementTree does its own conversion from UTF-8, so open in
366
513
            # 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
 
514
            f = self.controlfile('inventory', 'rb')
 
515
            return bzrlib.xml5.serializer_v5.read_inventory(f)
372
516
        finally:
373
517
            self.unlock()
374
518
            
379
523
        That is to say, the inventory describing changes underway, that
380
524
        will be committed to the next revision.
381
525
        """
382
 
        from bzrlib.atomicfile import AtomicFile
383
 
        from bzrlib.xml import pack_xml
384
 
        
 
526
        from cStringIO import StringIO
385
527
        self.lock_write()
386
528
        try:
387
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
 
            try:
389
 
                pack_xml(inv, f)
390
 
                f.commit()
391
 
            finally:
392
 
                f.close()
 
529
            sio = StringIO()
 
530
            bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
531
            sio.seek(0)
 
532
            # Transport handles atomicity
 
533
            self.put_controlfile('inventory', sio)
393
534
        finally:
394
535
            self.unlock()
395
536
        
396
537
        mutter('wrote working inventory')
397
538
            
398
 
 
399
539
    inventory = property(read_working_inventory, _write_inventory, None,
400
540
                         """Inventory for the working copy.""")
401
541
 
402
 
 
403
 
    def add(self, files, verbose=False, ids=None):
 
542
    def add(self, files, ids=None):
404
543
        """Make files versioned.
405
544
 
406
 
        Note that the command line normally calls smart_add instead.
 
545
        Note that the command line normally calls smart_add instead,
 
546
        which can automatically recurse.
407
547
 
408
548
        This puts the files in the Added state, so that they will be
409
549
        recorded by the next commit.
419
559
        TODO: Perhaps have an option to add the ids even if the files do
420
560
              not (yet) exist.
421
561
 
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.
 
562
        TODO: Perhaps yield the ids and paths as they're added.
428
563
        """
429
564
        # TODO: Re-adding a file that is removed in the working copy
430
565
        # should probably put it back with the previous ID.
457
592
                    kind = file_kind(fullpath)
458
593
                except OSError:
459
594
                    # maybe something better?
460
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
595
                    raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
461
596
 
462
 
                if kind != 'file' and kind != 'directory':
463
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
597
                if not InventoryEntry.versionable_kind(kind):
 
598
                    raise BzrError('cannot add: not a versionable file ('
 
599
                                   'i.e. regular file, symlink or directory): %s' % quotefn(f))
464
600
 
465
601
                if file_id is None:
466
602
                    file_id = gen_file_id(f)
467
603
                inv.add_path(f, kind=kind, file_id=file_id)
468
604
 
469
 
                if verbose:
470
 
                    print 'added', quotefn(f)
471
 
 
472
605
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
473
606
 
474
607
            self._write_inventory(inv)
480
613
        """Print `file` to stdout."""
481
614
        self.lock_read()
482
615
        try:
483
 
            tree = self.revision_tree(self.lookup_revision(revno))
 
616
            tree = self.revision_tree(self.get_rev_id(revno))
484
617
            # use inventory as it was in that revision
485
618
            file_id = tree.inventory.path2id(file)
486
619
            if not file_id:
534
667
        finally:
535
668
            self.unlock()
536
669
 
537
 
 
538
670
    # FIXME: this doesn't need to be a branch method
539
671
    def set_inventory(self, new_inventory_list):
540
672
        from bzrlib.inventory import Inventory, InventoryEntry
543
675
            name = os.path.basename(path)
544
676
            if name == "":
545
677
                continue
546
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
678
            # fixme, there should be a factory function inv,add_?? 
 
679
            if kind == 'directory':
 
680
                inv.add(inventory.InventoryDirectory(file_id, name, parent))
 
681
            elif kind == 'file':
 
682
                inv.add(inventory.InventoryFile(file_id, name, parent))
 
683
            elif kind == 'symlink':
 
684
                inv.add(inventory.InventoryLink(file_id, name, parent))
 
685
            else:
 
686
                raise BzrError("unknown kind %r" % kind)
547
687
        self._write_inventory(inv)
548
688
 
549
 
 
550
689
    def unknowns(self):
551
690
        """Return all unknown files.
552
691
 
567
706
 
568
707
 
569
708
    def append_revision(self, *revision_ids):
570
 
        from bzrlib.atomicfile import AtomicFile
571
 
 
572
709
        for revision_id in revision_ids:
573
710
            mutter("add {%s} to revision-history" % revision_id)
574
 
 
575
 
        rev_history = self.revision_history()
576
 
        rev_history.extend(revision_ids)
577
 
 
578
 
        f = AtomicFile(self.controlfilename('revision-history'))
 
711
        self.lock_write()
579
712
        try:
580
 
            for rev_id in rev_history:
581
 
                print >>f, rev_id
582
 
            f.commit()
 
713
            rev_history = self.revision_history()
 
714
            rev_history.extend(revision_ids)
 
715
            self.put_controlfile('revision-history', '\n'.join(rev_history))
583
716
        finally:
584
 
            f.close()
585
 
 
586
 
 
587
 
    def get_revision_xml(self, revision_id):
 
717
            self.unlock()
 
718
 
 
719
    def has_revision(self, revision_id):
 
720
        """True if this branch has a copy of the revision.
 
721
 
 
722
        This does not necessarily imply the revision is merge
 
723
        or on the mainline."""
 
724
        return (revision_id is None
 
725
                or revision_id in self.revision_store)
 
726
 
 
727
    def get_revision_xml_file(self, revision_id):
588
728
        """Return XML file object for revision object."""
589
729
        if not revision_id or not isinstance(revision_id, basestring):
590
730
            raise InvalidRevisionId(revision_id)
593
733
        try:
594
734
            try:
595
735
                return self.revision_store[revision_id]
596
 
            except IndexError:
597
 
                raise bzrlib.errors.NoSuchRevision(revision_id)
 
736
            except (IndexError, KeyError):
 
737
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
598
738
        finally:
599
739
            self.unlock()
600
740
 
 
741
    #deprecated
 
742
    get_revision_xml = get_revision_xml_file
 
743
 
 
744
    def get_revision_xml(self, revision_id):
 
745
        return self.get_revision_xml_file(revision_id).read()
 
746
 
601
747
 
602
748
    def get_revision(self, revision_id):
603
749
        """Return the Revision object for a named revision"""
604
 
        xml_file = self.get_revision_xml(revision_id)
 
750
        xml_file = self.get_revision_xml_file(revision_id)
605
751
 
606
752
        try:
607
 
            r = unpack_xml(Revision, xml_file)
 
753
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
608
754
        except SyntaxError, e:
609
755
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
610
756
                                         [revision_id,
613
759
        assert r.revision_id == revision_id
614
760
        return r
615
761
 
616
 
 
617
762
    def get_revision_delta(self, revno):
618
763
        """Return the delta for one revision.
619
764
 
635
780
 
636
781
        return compare_trees(old_tree, new_tree)
637
782
 
638
 
        
639
 
 
640
783
    def get_revision_sha1(self, revision_id):
641
784
        """Hash the stored value of a revision, and return it."""
642
785
        # In the future, revision entries will be signed. At that
645
788
        # the revision, (add signatures/remove signatures) and still
646
789
        # have all hash pointers stay consistent.
647
790
        # 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):
 
791
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
792
 
 
793
    def get_ancestry(self, revision_id):
 
794
        """Return a list of revision-ids integrated by a revision.
 
795
        
 
796
        This currently returns a list, but the ordering is not guaranteed:
 
797
        treat it as a set.
 
798
        """
 
799
        if revision_id is None:
 
800
            return [None]
 
801
        w = self.get_inventory_weave()
 
802
        return [None] + map(w.idx_to_name,
 
803
                            w.inclusions([w.lookup(revision_id)]))
 
804
 
 
805
    def get_inventory_weave(self):
 
806
        return self.control_weaves.get_weave('inventory',
 
807
                                             self.get_transaction())
 
808
 
 
809
    def get_inventory(self, revision_id):
 
810
        """Get Inventory object by hash."""
 
811
        xml = self.get_inventory_xml(revision_id)
 
812
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
813
 
 
814
    def get_inventory_xml(self, revision_id):
 
815
        """Get inventory XML as a file object."""
 
816
        try:
 
817
            assert isinstance(revision_id, basestring), type(revision_id)
 
818
            iw = self.get_inventory_weave()
 
819
            return iw.get_text(iw.lookup(revision_id))
 
820
        except IndexError:
 
821
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
822
 
 
823
    def get_inventory_sha1(self, revision_id):
664
824
        """Return the sha1 hash of the inventory entry
665
825
        """
666
 
        return sha_file(self.inventory_store[inventory_id])
667
 
 
 
826
        return self.get_revision(revision_id).inventory_sha1
668
827
 
669
828
    def get_revision_inventory(self, revision_id):
670
829
        """Return inventory of a past revision."""
671
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
830
        # TODO: Unify this with get_inventory()
 
831
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
672
832
        # must be the same as its revision, so this is trivial.
673
833
        if revision_id == None:
674
 
            from bzrlib.inventory import Inventory
675
834
            return Inventory(self.get_root_id())
676
835
        else:
677
836
            return self.get_inventory(revision_id)
678
837
 
679
 
 
680
838
    def revision_history(self):
681
 
        """Return sequence of revision hashes on to this branch.
682
 
 
683
 
        >>> ScratchBranch().revision_history()
684
 
        []
685
 
        """
 
839
        """Return sequence of revision hashes on to this branch."""
686
840
        self.lock_read()
687
841
        try:
688
 
            return [l.rstrip('\r\n') for l in
 
842
            transaction = self.get_transaction()
 
843
            history = transaction.map.find_revision_history()
 
844
            if history is not None:
 
845
                mutter("cache hit for revision-history in %s", self)
 
846
                return list(history)
 
847
            history = [l.rstrip('\r\n') for l in
689
848
                    self.controlfile('revision-history', 'r').readlines()]
 
849
            transaction.map.add_revision_history(history)
 
850
            # this call is disabled because revision_history is 
 
851
            # not really an object yet, and the transaction is for objects.
 
852
            # transaction.register_clean(history, precious=True)
 
853
            return list(history)
690
854
        finally:
691
855
            self.unlock()
692
856
 
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
 
 
738
 
 
739
857
    def revno(self):
740
858
        """Return current revision number for this branch.
741
859
 
745
863
        return len(self.revision_history())
746
864
 
747
865
 
748
 
    def last_patch(self):
 
866
    def last_revision(self):
749
867
        """Return last patch hash, or None if no history.
750
868
        """
751
869
        ph = self.revision_history()
755
873
            return None
756
874
 
757
875
 
758
 
    def missing_revisions(self, other, stop_revision=None):
759
 
        """
 
876
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
877
        """Return a list of new revisions that would perfectly fit.
 
878
        
760
879
        If self and other have not diverged, return a list of the revisions
761
880
        present in other, but missing from self.
762
881
 
793
912
 
794
913
        if stop_revision is None:
795
914
            stop_revision = other_len
796
 
        elif stop_revision > other_len:
797
 
            raise NoSuchRevision(self, stop_revision)
798
 
        
 
915
        else:
 
916
            assert isinstance(stop_revision, int)
 
917
            if stop_revision > other_len:
 
918
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
799
919
        return other_history[self_len:stop_revision]
800
920
 
801
 
 
802
921
    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
 
                    
869
 
        
 
922
        """Pull in new perfect-fit revisions."""
 
923
        # FIXME: If the branches have diverged, but the latest
 
924
        # revision in this branch is completely merged into the other,
 
925
        # then we should still be able to pull.
 
926
        from bzrlib.fetch import greedy_fetch
 
927
        if stop_revision is None:
 
928
            stop_revision = other.last_revision()
 
929
        ### Should this be checking is_ancestor instead of revision_history?
 
930
        if (stop_revision is not None and 
 
931
            stop_revision in self.revision_history()):
 
932
            return
 
933
        greedy_fetch(to_branch=self, from_branch=other,
 
934
                     revision=stop_revision)
 
935
        pullable_revs = self.pullable_revisions(other, stop_revision)
 
936
        if len(pullable_revs) > 0:
 
937
            self.append_revision(*pullable_revs)
 
938
 
 
939
    def pullable_revisions(self, other, stop_revision):
 
940
        other_revno = other.revision_id_to_revno(stop_revision)
 
941
        try:
 
942
            return self.missing_revisions(other, other_revno)
 
943
        except DivergedBranches, e:
 
944
            try:
 
945
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
946
                                                          stop_revision, self)
 
947
                assert self.last_revision() not in pullable_revs
 
948
                return pullable_revs
 
949
            except bzrlib.errors.NotAncestor:
 
950
                if is_ancestor(self.last_revision(), stop_revision, self):
 
951
                    return []
 
952
                else:
 
953
                    raise e
 
954
        
 
955
 
870
956
    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
 
957
        from bzrlib.commit import Commit
 
958
        Commit().commit(self, *args, **kw)
 
959
    
 
960
    def revision_id_to_revno(self, revision_id):
 
961
        """Given a revision id, return its revno"""
 
962
        if revision_id is None:
 
963
            return 0
 
964
        history = self.revision_history()
 
965
        try:
 
966
            return history.index(revision_id) + 1
 
967
        except ValueError:
 
968
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
969
 
 
970
    def get_rev_id(self, revno, history=None):
 
971
        """Find the revision id of the specified revno."""
 
972
        if revno == 0:
 
973
            return None
 
974
        if history is None:
 
975
            history = self.revision_history()
 
976
        elif revno <= 0 or revno > len(history):
 
977
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
978
        return history[revno - 1]
1032
979
 
1033
980
    def revision_tree(self, revision_id):
1034
981
        """Return Tree for a revision on this branch.
1041
988
            return EmptyTree()
1042
989
        else:
1043
990
            inv = self.get_revision_inventory(revision_id)
1044
 
            return RevisionTree(self.text_store, inv)
 
991
            return RevisionTree(self.weave_store, inv, revision_id)
1045
992
 
1046
993
 
1047
994
    def working_tree(self):
1048
995
        """Return a `Tree` for the working copy."""
1049
 
        from workingtree import WorkingTree
1050
 
        return WorkingTree(self.base, self.read_working_inventory())
 
996
        from bzrlib.workingtree import WorkingTree
 
997
        # TODO: In the future, WorkingTree should utilize Transport
 
998
        # RobertCollins 20051003 - I don't think it should - working trees are
 
999
        # much more complex to keep consistent than our careful .bzr subset.
 
1000
        # instead, we should say that working trees are local only, and optimise
 
1001
        # for that.
 
1002
        return WorkingTree(self.base, branch=self)
1051
1003
 
1052
1004
 
1053
1005
    def basis_tree(self):
1055
1007
 
1056
1008
        If there are no revisions yet, return an `EmptyTree`.
1057
1009
        """
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
 
 
 
1010
        return self.revision_tree(self.last_revision())
1064
1011
 
1065
1012
 
1066
1013
    def rename_one(self, from_rel, to_rel):
1098
1045
 
1099
1046
            inv.rename(file_id, to_dir_id, to_tail)
1100
1047
 
1101
 
            print "%s => %s" % (from_rel, to_rel)
1102
 
 
1103
1048
            from_abs = self.abspath(from_rel)
1104
1049
            to_abs = self.abspath(to_rel)
1105
1050
            try:
1106
 
                os.rename(from_abs, to_abs)
 
1051
                rename(from_abs, to_abs)
1107
1052
            except OSError, e:
1108
1053
                raise BzrError("failed to rename %r to %r: %s"
1109
1054
                        % (from_abs, to_abs, e[1]),
1124
1069
 
1125
1070
        Note that to_name is only the last component of the new name;
1126
1071
        this doesn't change the directory.
 
1072
 
 
1073
        This returns a list of (from_path, to_path) pairs for each
 
1074
        entry that is moved.
1127
1075
        """
 
1076
        result = []
1128
1077
        self.lock_write()
1129
1078
        try:
1130
1079
            ## TODO: Option to move IDs only
1165
1114
            for f in from_paths:
1166
1115
                name_tail = splitpath(f)[-1]
1167
1116
                dest_path = appendpath(to_name, name_tail)
1168
 
                print "%s => %s" % (f, dest_path)
 
1117
                result.append((f, dest_path))
1169
1118
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1170
1119
                try:
1171
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1120
                    rename(self.abspath(f), self.abspath(dest_path))
1172
1121
                except OSError, e:
1173
1122
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
1123
                            ["rename rolled back"])
1177
1126
        finally:
1178
1127
            self.unlock()
1179
1128
 
 
1129
        return result
 
1130
 
1180
1131
 
1181
1132
    def revert(self, filenames, old_tree=None, backups=True):
1182
1133
        """Restore selected files to the versions from a previous tree.
1228
1179
        These are revisions that have been merged into the working
1229
1180
        directory but not yet committed.
1230
1181
        """
1231
 
        cfn = self.controlfilename('pending-merges')
1232
 
        if not os.path.exists(cfn):
 
1182
        cfn = self._rel_controlfilename('pending-merges')
 
1183
        if not self._transport.has(cfn):
1233
1184
            return []
1234
1185
        p = []
1235
1186
        for l in self.controlfile('pending-merges', 'r').readlines():
1237
1188
        return p
1238
1189
 
1239
1190
 
1240
 
    def add_pending_merge(self, revision_id):
1241
 
        from bzrlib.revision import validate_revision_id
1242
 
 
1243
 
        validate_revision_id(revision_id)
1244
 
 
 
1191
    def add_pending_merge(self, *revision_ids):
 
1192
        # TODO: Perhaps should check at this point that the
 
1193
        # history of the revision is actually present?
1245
1194
        p = self.pending_merges()
1246
 
        if revision_id in p:
1247
 
            return
1248
 
        p.append(revision_id)
1249
 
        self.set_pending_merges(p)
1250
 
 
 
1195
        updated = False
 
1196
        for rev_id in revision_ids:
 
1197
            if rev_id in p:
 
1198
                continue
 
1199
            p.append(rev_id)
 
1200
            updated = True
 
1201
        if updated:
 
1202
            self.set_pending_merges(p)
1251
1203
 
1252
1204
    def set_pending_merges(self, rev_list):
 
1205
        self.lock_write()
 
1206
        try:
 
1207
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
 
1208
        finally:
 
1209
            self.unlock()
 
1210
 
 
1211
 
 
1212
    def get_parent(self):
 
1213
        """Return the parent location of the branch.
 
1214
 
 
1215
        This is the default location for push/pull/missing.  The usual
 
1216
        pattern is that the user can override it by specifying a
 
1217
        location.
 
1218
        """
 
1219
        import errno
 
1220
        _locs = ['parent', 'pull', 'x-pull']
 
1221
        for l in _locs:
 
1222
            try:
 
1223
                return self.controlfile(l, 'r').read().strip('\n')
 
1224
            except IOError, e:
 
1225
                if e.errno != errno.ENOENT:
 
1226
                    raise
 
1227
        return None
 
1228
 
 
1229
 
 
1230
    def set_parent(self, url):
 
1231
        # TODO: Maybe delete old location files?
1253
1232
        from bzrlib.atomicfile import AtomicFile
1254
1233
        self.lock_write()
1255
1234
        try:
1256
 
            f = AtomicFile(self.controlfilename('pending-merges'))
 
1235
            f = AtomicFile(self.controlfilename('parent'))
1257
1236
            try:
1258
 
                for l in rev_list:
1259
 
                    print >>f, l
 
1237
                f.write(url + '\n')
1260
1238
                f.commit()
1261
1239
            finally:
1262
1240
                f.close()
1263
1241
        finally:
1264
1242
            self.unlock()
1265
1243
 
1266
 
 
1267
 
 
1268
 
class ScratchBranch(Branch):
 
1244
    def check_revno(self, revno):
 
1245
        """\
 
1246
        Check whether a revno corresponds to any revision.
 
1247
        Zero (the NULL revision) is considered valid.
 
1248
        """
 
1249
        if revno != 0:
 
1250
            self.check_real_revno(revno)
 
1251
            
 
1252
    def check_real_revno(self, revno):
 
1253
        """\
 
1254
        Check whether a revno corresponds to a real revision.
 
1255
        Zero (the NULL revision) is considered invalid
 
1256
        """
 
1257
        if revno < 1 or revno > self.revno():
 
1258
            raise InvalidRevisionNumber(revno)
 
1259
        
 
1260
        
 
1261
        
 
1262
 
 
1263
 
 
1264
class ScratchBranch(_Branch):
1269
1265
    """Special test class: a branch that cleans up after itself.
1270
1266
 
1271
1267
    >>> b = ScratchBranch()
1288
1284
        if base is None:
1289
1285
            base = mkdtemp()
1290
1286
            init = True
1291
 
        Branch.__init__(self, base, init=init)
 
1287
        if isinstance(base, basestring):
 
1288
            base = get_transport(base)
 
1289
        _Branch.__init__(self, base, init=init)
1292
1290
        for d in dirs:
1293
 
            os.mkdir(self.abspath(d))
 
1291
            self._transport.mkdir(d)
1294
1292
            
1295
1293
        for f in files:
1296
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1294
            self._transport.put(f, 'content of %s' % f)
1297
1295
 
1298
1296
 
1299
1297
    def clone(self):
1300
1298
        """
1301
1299
        >>> orig = ScratchBranch(files=["file1", "file2"])
1302
1300
        >>> clone = orig.clone()
1303
 
        >>> os.path.samefile(orig.base, clone.base)
 
1301
        >>> if os.name != 'nt':
 
1302
        ...   os.path.samefile(orig.base, clone.base)
 
1303
        ... else:
 
1304
        ...   orig.base == clone.base
 
1305
        ...
1304
1306
        False
1305
1307
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1306
1308
        True
1311
1313
        os.rmdir(base)
1312
1314
        copytree(self.base, base, symlinks=True)
1313
1315
        return ScratchBranch(base=base)
1314
 
        
 
1316
 
1315
1317
    def __del__(self):
1316
1318
        self.destroy()
1317
1319
 
1330
1332
                for name in files:
1331
1333
                    os.chmod(os.path.join(root, name), 0700)
1332
1334
            rmtree(self.base)
1333
 
        self.base = None
 
1335
        self._transport = None
1334
1336
 
1335
1337
    
1336
1338
 
1386
1388
    """Return a new tree-root file id."""
1387
1389
    return gen_file_id('TREE_ROOT')
1388
1390
 
 
1391