/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: Robert Collins
  • Date: 2005-10-10 03:24:15 UTC
  • Revision ID: robertc@robertcollins.net-20051010032415-2d3840758bc6e9b8
merge in and make incremental Gustavo Niemeyers nested log patch, and remove all bare exceptions in store and transport packages.

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