~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-10-09 23:12:35 UTC
  • Revision ID: robertc@robertcollins.net-20051009231235-93626e72cac71b78
clean up test dirs on make clean

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