~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

- constraints on revprops
- tests for this

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