~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-10-21 04:02:58 UTC
  • mto: This revision was merged to the branch mainline in revision 1503.
  • Revision ID: robertc@robertcollins.net-20051021040258-84a5db1be67b30b9
make build-api have a hasbang

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
 
 
 
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
27
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
28
 
                           NoSuchRevision)
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError, UnlistableStore,
 
36
                           UnlistableBranch, NoSuchFile)
29
37
from bzrlib.textui import show_status
30
38
from bzrlib.revision import Revision
31
39
from bzrlib.delta import compare_trees
32
40
from bzrlib.tree import EmptyTree, RevisionTree
33
41
from bzrlib.inventory import Inventory
34
 
from bzrlib.weavestore import WeaveStore
 
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
35
48
import bzrlib.xml5
36
49
import bzrlib.ui
37
50
 
38
51
 
39
 
 
40
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
41
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
54
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
42
55
## TODO: Maybe include checks for common corruption of newlines, etc?
43
56
 
44
57
 
45
58
# TODO: Some operations like log might retrieve the same revisions
46
59
# repeatedly to calculate deltas.  We could perhaps have a weakref
47
 
# cache in memory to make this faster.
48
 
 
49
 
# TODO: please move the revision-string syntax stuff out of the branch
50
 
# object; it's clutter
51
 
 
52
 
 
53
 
def find_branch(f, **args):
54
 
    if f and (f.startswith('http://') or f.startswith('https://')):
55
 
        import remotebranch 
56
 
        return remotebranch.RemoteBranch(f, **args)
57
 
    else:
58
 
        return Branch(f, **args)
59
 
 
60
 
 
61
 
def find_cached_branch(f, cache_root, **args):
62
 
    from remotebranch import RemoteBranch
63
 
    br = find_branch(f, **args)
64
 
    def cacheify(br, store_name):
65
 
        from meta_store import CachedStore
66
 
        cache_path = os.path.join(cache_root, store_name)
67
 
        os.mkdir(cache_path)
68
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
69
 
        setattr(br, store_name, new_store)
70
 
 
71
 
    if isinstance(br, RemoteBranch):
72
 
        cacheify(br, 'inventory_store')
73
 
        cacheify(br, 'text_store')
74
 
        cacheify(br, 'revision_store')
75
 
    return br
76
 
 
77
 
 
78
 
def _relpath(base, path):
79
 
    """Return path relative to base, or raise exception.
80
 
 
81
 
    The path may be either an absolute path or a path relative to the
82
 
    current working directory.
83
 
 
84
 
    Lifted out of Branch.relpath for ease of testing.
85
 
 
86
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
87
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
88
 
    avoids that problem."""
89
 
    rp = os.path.abspath(path)
90
 
 
91
 
    s = []
92
 
    head = rp
93
 
    while len(head) >= len(base):
94
 
        if head == base:
95
 
            break
96
 
        head, tail = os.path.split(head)
97
 
        if tail:
98
 
            s.insert(0, tail)
99
 
    else:
100
 
        from errors import NotBranchError
101
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
102
 
 
103
 
    return os.sep.join(s)
104
 
        
105
 
 
106
 
def find_branch_root(f=None):
107
 
    """Find the branch root enclosing f, or pwd.
108
 
 
109
 
    f may be a filename or a URL.
110
 
 
111
 
    It is not necessary that f exists.
112
 
 
113
 
    Basically we keep looking up until we find the control directory or
114
 
    run into the root.  If there isn't one, raises NotBranchError.
115
 
    """
116
 
    if f == None:
117
 
        f = os.getcwd()
118
 
    elif hasattr(os.path, 'realpath'):
119
 
        f = os.path.realpath(f)
120
 
    else:
121
 
        f = os.path.abspath(f)
122
 
    if not os.path.exists(f):
123
 
        raise BzrError('%r does not exist' % f)
124
 
        
125
 
 
126
 
    orig_f = f
127
 
 
128
 
    while True:
129
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
130
 
            return f
131
 
        head, tail = os.path.split(f)
132
 
        if head == f:
133
 
            # reached the root, whatever that may be
134
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
135
 
        f = head
136
 
 
137
 
 
138
 
 
139
 
# XXX: move into bzrlib.errors; subclass BzrError    
140
 
class DivergedBranches(Exception):
141
 
    def __init__(self, branch1, branch2):
142
 
        self.branch1 = branch1
143
 
        self.branch2 = branch2
144
 
        Exception.__init__(self, "These branches have diverged.")
145
 
 
 
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')
146
67
 
147
68
######################################################################
148
69
# branch objects
151
72
    """Branch holding a history of revisions.
152
73
 
153
74
    base
154
 
        Base directory of the branch.
 
75
        Base directory/url of the branch.
 
76
    """
 
77
    base = None
 
78
 
 
79
    def __init__(self, *ignored, **ignored_too):
 
80
        raise NotImplementedError('The Branch class is abstract')
 
81
 
 
82
    @staticmethod
 
83
    def open_downlevel(base):
 
84
        """Open a branch which may be of an old format.
 
85
        
 
86
        Only local branches are supported."""
 
87
        return _Branch(get_transport(base), relax_version_check=True)
 
88
        
 
89
    @staticmethod
 
90
    def open(base):
 
91
        """Open an existing branch, rooted at 'base' (url)"""
 
92
        t = get_transport(base)
 
93
        mutter("trying to open %r with transport %r", base, t)
 
94
        return _Branch(t)
 
95
 
 
96
    @staticmethod
 
97
    def open_containing(url):
 
98
        """Open an existing branch which contains url.
 
99
        
 
100
        This probes for a branch at url, and searches upwards from there.
 
101
 
 
102
        Basically we keep looking up until we find the control directory or
 
103
        run into the root.  If there isn't one, raises NotBranchError.
 
104
        """
 
105
        t = get_transport(url)
 
106
        while True:
 
107
            try:
 
108
                return _Branch(t)
 
109
            except NotBranchError:
 
110
                pass
 
111
            new_t = t.clone('..')
 
112
            if new_t.base == t.base:
 
113
                # reached the root, whatever that may be
 
114
                raise NotBranchError('%s is not in a branch' % url)
 
115
            t = new_t
 
116
 
 
117
    @staticmethod
 
118
    def initialize(base):
 
119
        """Create a new branch, rooted at 'base' (url)"""
 
120
        t = get_transport(base)
 
121
        return _Branch(t, init=True)
 
122
 
 
123
    def setup_caching(self, cache_root):
 
124
        """Subclasses that care about caching should override this, and set
 
125
        up cached stores located under cache_root.
 
126
        """
 
127
        self.cache_root = cache_root
 
128
 
 
129
 
 
130
class _Branch(Branch):
 
131
    """A branch stored in the actual filesystem.
 
132
 
 
133
    Note that it's "local" in the context of the filesystem; it doesn't
 
134
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
135
    it's writable, and can be accessed via the normal filesystem API.
155
136
 
156
137
    _lock_mode
157
138
        None, or 'r' or 'w'
163
144
    _lock
164
145
        Lock object from bzrlib.lock.
165
146
    """
166
 
    base = None
 
147
    # We actually expect this class to be somewhat short-lived; part of its
 
148
    # purpose is to try to isolate what bits of the branch logic are tied to
 
149
    # filesystem access, so that in a later step, we can extricate them to
 
150
    # a separarte ("storage") class.
167
151
    _lock_mode = None
168
152
    _lock_count = None
169
153
    _lock = None
 
154
    _inventory_weave = None
170
155
    
171
156
    # Map some sort of prefix into a namespace
172
157
    # stuff like "revno:10", "revid:", etc.
173
158
    # This should match a prefix with a function which accepts
174
159
    REVISION_NAMESPACES = {}
175
160
 
176
 
    def __init__(self, base, init=False, find_root=True):
 
161
    def push_stores(self, branch_to):
 
162
        """Copy the content of this branches store to branch_to."""
 
163
        if (self._branch_format != branch_to._branch_format
 
164
            or self._branch_format != 4):
 
165
            from bzrlib.fetch import greedy_fetch
 
166
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
 
167
                   self, self._branch_format, branch_to, branch_to._branch_format)
 
168
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
169
                         revision=self.last_revision())
 
170
            return
 
171
 
 
172
        store_pairs = ((self.text_store,      branch_to.text_store),
 
173
                       (self.inventory_store, branch_to.inventory_store),
 
174
                       (self.revision_store,  branch_to.revision_store))
 
175
        try:
 
176
            for from_store, to_store in store_pairs: 
 
177
                copy_all(from_store, to_store)
 
178
        except UnlistableStore:
 
179
            raise UnlistableBranch(from_store)
 
180
 
 
181
    def __init__(self, transport, init=False,
 
182
                 relax_version_check=False):
177
183
        """Create new branch object at a particular location.
178
184
 
179
 
        base -- Base directory for the branch.
 
185
        transport -- A Transport object, defining how to access files.
 
186
                (If a string, transport.transport() will be used to
 
187
                create a Transport object)
180
188
        
181
189
        init -- If True, create new control files in a previously
182
190
             unversioned directory.  If False, the branch must already
183
191
             be versioned.
184
192
 
185
 
        find_root -- If true and init is false, find the root of the
186
 
             existing branch containing base.
 
193
        relax_version_check -- If true, the usual check for the branch
 
194
            version is not applied.  This is intended only for
 
195
            upgrade/recovery type use; it's not guaranteed that
 
196
            all operations will work on old format branches.
187
197
 
188
198
        In the test suite, creation of new trees is tested using the
189
199
        `ScratchBranch` class.
190
200
        """
191
 
        from bzrlib.store import ImmutableStore
 
201
        assert isinstance(transport, Transport), \
 
202
            "%r is not a Transport" % transport
 
203
        self._transport = transport
192
204
        if init:
193
 
            self.base = os.path.realpath(base)
194
205
            self._make_control()
195
 
        elif find_root:
196
 
            self.base = find_branch_root(base)
197
 
        else:
198
 
            self.base = os.path.realpath(base)
199
 
            if not isdir(self.controlfilename('.')):
200
 
                from errors import NotBranchError
201
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
202
 
                                     ['use "bzr init" to initialize a new working tree',
203
 
                                      'current bzr can only operate from top-of-tree'])
204
 
        self._check_format()
205
 
 
206
 
        self.weave_store = WeaveStore(self.controlfilename('weaves'))
207
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
208
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
209
 
 
 
206
        self._check_format(relax_version_check)
 
207
 
 
208
        def get_store(name, compressed=True, prefixed=False):
 
209
            # FIXME: This approach of assuming stores are all entirely compressed
 
210
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
211
            # some existing branches where there's a mixture; we probably 
 
212
            # still want the option to look for both.
 
213
            relpath = self._rel_controlfilename(name)
 
214
            if compressed:
 
215
                store = CompressedTextStore(self._transport.clone(relpath),
 
216
                                            prefixed=prefixed)
 
217
            else:
 
218
                store = TextStore(self._transport.clone(relpath),
 
219
                                  prefixed=prefixed)
 
220
            #if self._transport.should_cache():
 
221
            #    cache_path = os.path.join(self.cache_root, name)
 
222
            #    os.mkdir(cache_path)
 
223
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
224
            return store
 
225
        def get_weave(name, prefixed=False):
 
226
            relpath = self._rel_controlfilename(name)
 
227
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
 
228
            if self._transport.should_cache():
 
229
                ws.enable_cache = True
 
230
            return ws
 
231
 
 
232
        if self._branch_format == 4:
 
233
            self.inventory_store = get_store('inventory-store')
 
234
            self.text_store = get_store('text-store')
 
235
            self.revision_store = get_store('revision-store')
 
236
        elif self._branch_format == 5:
 
237
            self.control_weaves = get_weave([])
 
238
            self.weave_store = get_weave('weaves')
 
239
            self.revision_store = get_store('revision-store', compressed=False)
 
240
        elif self._branch_format == 6:
 
241
            self.control_weaves = get_weave([])
 
242
            self.weave_store = get_weave('weaves', prefixed=True)
 
243
            self.revision_store = get_store('revision-store', compressed=False,
 
244
                                            prefixed=True)
 
245
        self._transaction = None
210
246
 
211
247
    def __str__(self):
212
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
248
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
213
249
 
214
250
 
215
251
    __repr__ = __str__
217
253
 
218
254
    def __del__(self):
219
255
        if self._lock_mode or self._lock:
220
 
            from warnings import warn
 
256
            # XXX: This should show something every time, and be suitable for
 
257
            # headless operation and embedding
221
258
            warn("branch %r was not explicitly unlocked" % self)
222
259
            self._lock.unlock()
223
260
 
 
261
        # TODO: It might be best to do this somewhere else,
 
262
        # but it is nice for a Branch object to automatically
 
263
        # cache it's information.
 
264
        # Alternatively, we could have the Transport objects cache requests
 
265
        # See the earlier discussion about how major objects (like Branch)
 
266
        # should never expect their __del__ function to run.
 
267
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
268
            try:
 
269
                import shutil
 
270
                shutil.rmtree(self.cache_root)
 
271
            except:
 
272
                pass
 
273
            self.cache_root = None
 
274
 
 
275
    def _get_base(self):
 
276
        if self._transport:
 
277
            return self._transport.base
 
278
        return None
 
279
 
 
280
    base = property(_get_base, doc="The URL for the root of this branch.")
 
281
 
 
282
    def _finish_transaction(self):
 
283
        """Exit the current transaction."""
 
284
        if self._transaction is None:
 
285
            raise errors.LockError('Branch %s is not in a transaction' %
 
286
                                   self)
 
287
        transaction = self._transaction
 
288
        self._transaction = None
 
289
        transaction.finish()
 
290
 
 
291
    def get_transaction(self):
 
292
        """Return the current active transaction.
 
293
 
 
294
        If no transaction is active, this returns a passthrough object
 
295
        for which all data is immedaitely flushed and no caching happens.
 
296
        """
 
297
        if self._transaction is None:
 
298
            return transactions.PassThroughTransaction()
 
299
        else:
 
300
            return self._transaction
 
301
 
 
302
    def _set_transaction(self, new_transaction):
 
303
        """Set a new active transaction."""
 
304
        if self._transaction is not None:
 
305
            raise errors.LockError('Branch %s is in a transaction already.' %
 
306
                                   self)
 
307
        self._transaction = new_transaction
224
308
 
225
309
    def lock_write(self):
 
310
        mutter("lock write: %s (%s)", self, self._lock_count)
 
311
        # TODO: Upgrade locking to support using a Transport,
 
312
        # and potentially a remote locking protocol
226
313
        if self._lock_mode:
227
314
            if self._lock_mode != 'w':
228
 
                from errors import LockError
229
315
                raise LockError("can't upgrade to a write lock from %r" %
230
316
                                self._lock_mode)
231
317
            self._lock_count += 1
232
318
        else:
233
 
            from bzrlib.lock import WriteLock
234
 
 
235
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
319
            self._lock = self._transport.lock_write(
 
320
                    self._rel_controlfilename('branch-lock'))
236
321
            self._lock_mode = 'w'
237
322
            self._lock_count = 1
238
 
 
 
323
            self._set_transaction(transactions.PassThroughTransaction())
239
324
 
240
325
    def lock_read(self):
 
326
        mutter("lock read: %s (%s)", self, self._lock_count)
241
327
        if self._lock_mode:
242
328
            assert self._lock_mode in ('r', 'w'), \
243
329
                   "invalid lock mode %r" % self._lock_mode
244
330
            self._lock_count += 1
245
331
        else:
246
 
            from bzrlib.lock import ReadLock
247
 
 
248
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
332
            self._lock = self._transport.lock_read(
 
333
                    self._rel_controlfilename('branch-lock'))
249
334
            self._lock_mode = 'r'
250
335
            self._lock_count = 1
 
336
            self._set_transaction(transactions.ReadOnlyTransaction())
 
337
            # 5K may be excessive, but hey, its a knob.
 
338
            self.get_transaction().set_cache_size(5000)
251
339
                        
252
340
    def unlock(self):
 
341
        mutter("unlock: %s (%s)", self, self._lock_count)
253
342
        if not self._lock_mode:
254
 
            from errors import LockError
255
343
            raise LockError('branch %r is not locked' % (self))
256
344
 
257
345
        if self._lock_count > 1:
258
346
            self._lock_count -= 1
259
347
        else:
 
348
            self._finish_transaction()
260
349
            self._lock.unlock()
261
350
            self._lock = None
262
351
            self._lock_mode = self._lock_count = None
263
352
 
264
353
    def abspath(self, name):
265
 
        """Return absolute filename for something in the branch"""
266
 
        return os.path.join(self.base, name)
267
 
 
268
 
    def relpath(self, path):
269
 
        """Return path relative to this branch of something inside it.
270
 
 
271
 
        Raises an error if path is not in this branch."""
272
 
        return _relpath(self.base, path)
 
354
        """Return absolute filename for something in the branch
 
355
        
 
356
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
357
        method and not a tree method.
 
358
        """
 
359
        return self._transport.abspath(name)
 
360
 
 
361
    def _rel_controlfilename(self, file_or_path):
 
362
        if isinstance(file_or_path, basestring):
 
363
            file_or_path = [file_or_path]
 
364
        return [bzrlib.BZRDIR] + file_or_path
273
365
 
274
366
    def controlfilename(self, file_or_path):
275
367
        """Return location relative to branch."""
276
 
        if isinstance(file_or_path, basestring):
277
 
            file_or_path = [file_or_path]
278
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
368
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
279
369
 
280
370
 
281
371
    def controlfile(self, file_or_path, mode='r'):
289
379
        Controlfiles should almost never be opened in write mode but
290
380
        rather should be atomically copied and replaced using atomicfile.
291
381
        """
292
 
 
293
 
        fn = self.controlfilename(file_or_path)
294
 
 
295
 
        if mode == 'rb' or mode == 'wb':
296
 
            return file(fn, mode)
297
 
        elif mode == 'r' or mode == 'w':
298
 
            # open in binary mode anyhow so there's no newline translation;
299
 
            # codecs uses line buffering by default; don't want that.
300
 
            import codecs
301
 
            return codecs.open(fn, mode + 'b', 'utf-8',
302
 
                               buffering=60000)
 
382
        import codecs
 
383
 
 
384
        relpath = self._rel_controlfilename(file_or_path)
 
385
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
386
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
387
        if mode == 'rb': 
 
388
            return self._transport.get(relpath)
 
389
        elif mode == 'wb':
 
390
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
391
        elif mode == 'r':
 
392
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
393
        elif mode == 'w':
 
394
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
303
395
        else:
304
396
            raise BzrError("invalid controlfile mode %r" % mode)
305
397
 
 
398
    def put_controlfile(self, path, f, encode=True):
 
399
        """Write an entry as a controlfile.
 
400
 
 
401
        :param path: The path to put the file, relative to the .bzr control
 
402
                     directory
 
403
        :param f: A file-like or string object whose contents should be copied.
 
404
        :param encode:  If true, encode the contents as utf-8
 
405
        """
 
406
        self.put_controlfiles([(path, f)], encode=encode)
 
407
 
 
408
    def put_controlfiles(self, files, encode=True):
 
409
        """Write several entries as controlfiles.
 
410
 
 
411
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
412
                      underneath the bzr control directory
 
413
        :param encode:  If true, encode the contents as utf-8
 
414
        """
 
415
        import codecs
 
416
        ctrl_files = []
 
417
        for path, f in files:
 
418
            if encode:
 
419
                if isinstance(f, basestring):
 
420
                    f = f.encode('utf-8', 'replace')
 
421
                else:
 
422
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
423
            path = self._rel_controlfilename(path)
 
424
            ctrl_files.append((path, f))
 
425
        self._transport.put_multi(ctrl_files)
 
426
 
306
427
    def _make_control(self):
307
 
        os.mkdir(self.controlfilename([]))
308
 
        self.controlfile('README', 'w').write(
309
 
            "This is a Bazaar-NG control directory.\n"
310
 
            "Do not change any files in this directory.\n")
311
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
312
 
        for d in ('text-store', 'inventory-store', 'revision-store',
313
 
                  'weaves'):
314
 
            os.mkdir(self.controlfilename(d))
315
 
        for f in ('revision-history', 'merged-patches',
316
 
                  'pending-merged-patches', 'branch-name',
317
 
                  'branch-lock',
318
 
                  'pending-merges'):
319
 
            self.controlfile(f, 'w').write('')
320
 
        mutter('created control directory in ' + self.base)
321
 
 
 
428
        from bzrlib.inventory import Inventory
 
429
        from bzrlib.weavefile import write_weave_v5
 
430
        from bzrlib.weave import Weave
 
431
        
 
432
        # Create an empty inventory
 
433
        sio = StringIO()
322
434
        # if we want per-tree root ids then this is the place to set
323
435
        # them; they're not needed for now and so ommitted for
324
436
        # simplicity.
325
 
        f = self.controlfile('inventory','w')
326
 
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
327
 
 
328
 
 
329
 
    def _check_format(self):
 
437
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
 
438
        empty_inv = sio.getvalue()
 
439
        sio = StringIO()
 
440
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
441
        empty_weave = sio.getvalue()
 
442
 
 
443
        dirs = [[], 'revision-store', 'weaves']
 
444
        files = [('README', 
 
445
            "This is a Bazaar-NG control directory.\n"
 
446
            "Do not change any files in this directory.\n"),
 
447
            ('branch-format', BZR_BRANCH_FORMAT_6),
 
448
            ('revision-history', ''),
 
449
            ('branch-name', ''),
 
450
            ('branch-lock', ''),
 
451
            ('pending-merges', ''),
 
452
            ('inventory', empty_inv),
 
453
            ('inventory.weave', empty_weave),
 
454
            ('ancestry.weave', empty_weave)
 
455
        ]
 
456
        cfn = self._rel_controlfilename
 
457
        self._transport.mkdir_multi([cfn(d) for d in dirs])
 
458
        self.put_controlfiles(files)
 
459
        mutter('created control directory in ' + self._transport.base)
 
460
 
 
461
    def _check_format(self, relax_version_check):
330
462
        """Check this branch format is supported.
331
463
 
332
464
        The format level is stored, as an integer, in
335
467
        In the future, we might need different in-memory Branch
336
468
        classes to support downlevel branches.  But not yet.
337
469
        """
338
 
        fmt = self.controlfile('branch-format', 'r').read()
339
 
        if fmt == BZR_BRANCH_FORMAT_5:
 
470
        try:
 
471
            fmt = self.controlfile('branch-format', 'r').read()
 
472
        except NoSuchFile:
 
473
            raise NotBranchError(self.base)
 
474
        mutter("got branch format %r", fmt)
 
475
        if fmt == BZR_BRANCH_FORMAT_6:
 
476
            self._branch_format = 6
 
477
        elif fmt == BZR_BRANCH_FORMAT_5:
340
478
            self._branch_format = 5
341
 
        else:
342
 
            raise BzrError('sorry, branch format "%s" not supported; ' 
343
 
                           'use a different bzr version, '
344
 
                           'or run "bzr upgrade", '
345
 
                           'or remove the .bzr directory and "bzr init" again'
346
 
                           % fmt.rstrip('\n\r'))
 
479
        elif fmt == BZR_BRANCH_FORMAT_4:
 
480
            self._branch_format = 4
 
481
 
 
482
        if (not relax_version_check
 
483
            and self._branch_format not in (5, 6)):
 
484
            raise errors.UnsupportedFormatError(
 
485
                           'sorry, branch format %r not supported' % fmt,
 
486
                           ['use a different bzr version',
 
487
                            'or remove the .bzr directory'
 
488
                            ' and "bzr init" again'])
347
489
 
348
490
    def get_root_id(self):
349
491
        """Return the id of this branches root"""
380
522
        That is to say, the inventory describing changes underway, that
381
523
        will be committed to the next revision.
382
524
        """
383
 
        from bzrlib.atomicfile import AtomicFile
384
 
        
 
525
        from cStringIO import StringIO
385
526
        self.lock_write()
386
527
        try:
387
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
388
 
            try:
389
 
                bzrlib.xml5.serializer_v5.write_inventory(inv, f)
390
 
                f.commit()
391
 
            finally:
392
 
                f.close()
 
528
            sio = StringIO()
 
529
            bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
530
            sio.seek(0)
 
531
            # Transport handles atomicity
 
532
            self.put_controlfile('inventory', sio)
393
533
        finally:
394
534
            self.unlock()
395
535
        
396
536
        mutter('wrote working inventory')
397
537
            
398
 
 
399
538
    inventory = property(read_working_inventory, _write_inventory, None,
400
539
                         """Inventory for the working copy.""")
401
540
 
402
 
 
403
541
    def add(self, files, ids=None):
404
542
        """Make files versioned.
405
543
 
453
591
                    kind = file_kind(fullpath)
454
592
                except OSError:
455
593
                    # maybe something better?
456
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
594
                    raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
457
595
 
458
 
                if kind != 'file' and kind != 'directory':
459
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
596
                if not InventoryEntry.versionable_kind(kind):
 
597
                    raise BzrError('cannot add: not a versionable file ('
 
598
                                   'i.e. regular file, symlink or directory): %s' % quotefn(f))
460
599
 
461
600
                if file_id is None:
462
601
                    file_id = gen_file_id(f)
473
612
        """Print `file` to stdout."""
474
613
        self.lock_read()
475
614
        try:
476
 
            tree = self.revision_tree(self.lookup_revision(revno))
 
615
            tree = self.revision_tree(self.get_rev_id(revno))
477
616
            # use inventory as it was in that revision
478
617
            file_id = tree.inventory.path2id(file)
479
618
            if not file_id:
527
666
        finally:
528
667
            self.unlock()
529
668
 
530
 
 
531
669
    # FIXME: this doesn't need to be a branch method
532
670
    def set_inventory(self, new_inventory_list):
533
671
        from bzrlib.inventory import Inventory, InventoryEntry
536
674
            name = os.path.basename(path)
537
675
            if name == "":
538
676
                continue
539
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
677
            # fixme, there should be a factory function inv,add_?? 
 
678
            if kind == 'directory':
 
679
                inv.add(inventory.InventoryDirectory(file_id, name, parent))
 
680
            elif kind == 'file':
 
681
                inv.add(inventory.InventoryFile(file_id, name, parent))
 
682
            elif kind == 'symlink':
 
683
                inv.add(inventory.InventoryLink(file_id, name, parent))
 
684
            else:
 
685
                raise BzrError("unknown kind %r" % kind)
540
686
        self._write_inventory(inv)
541
687
 
542
 
 
543
688
    def unknowns(self):
544
689
        """Return all unknown files.
545
690
 
560
705
 
561
706
 
562
707
    def append_revision(self, *revision_ids):
563
 
        from bzrlib.atomicfile import AtomicFile
564
 
 
565
708
        for revision_id in revision_ids:
566
709
            mutter("add {%s} to revision-history" % revision_id)
567
 
 
568
 
        rev_history = self.revision_history()
569
 
        rev_history.extend(revision_ids)
570
 
 
571
 
        f = AtomicFile(self.controlfilename('revision-history'))
 
710
        self.lock_write()
572
711
        try:
573
 
            for rev_id in rev_history:
574
 
                print >>f, rev_id
575
 
            f.commit()
 
712
            rev_history = self.revision_history()
 
713
            rev_history.extend(revision_ids)
 
714
            self.put_controlfile('revision-history', '\n'.join(rev_history))
576
715
        finally:
577
 
            f.close()
578
 
 
 
716
            self.unlock()
 
717
 
 
718
    def has_revision(self, revision_id):
 
719
        """True if this branch has a copy of the revision.
 
720
 
 
721
        This does not necessarily imply the revision is merge
 
722
        or on the mainline."""
 
723
        return (revision_id is None
 
724
                or revision_id in self.revision_store)
579
725
 
580
726
    def get_revision_xml_file(self, revision_id):
581
727
        """Return XML file object for revision object."""
586
732
        try:
587
733
            try:
588
734
                return self.revision_store[revision_id]
589
 
            except IndexError:
 
735
            except (IndexError, KeyError):
590
736
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
591
737
        finally:
592
738
            self.unlock()
593
739
 
594
 
 
595
740
    #deprecated
596
741
    get_revision_xml = get_revision_xml_file
597
742
 
 
743
    def get_revision_xml(self, revision_id):
 
744
        return self.get_revision_xml_file(revision_id).read()
 
745
 
598
746
 
599
747
    def get_revision(self, revision_id):
600
748
        """Return the Revision object for a named revision"""
610
758
        assert r.revision_id == revision_id
611
759
        return r
612
760
 
613
 
 
614
761
    def get_revision_delta(self, revno):
615
762
        """Return the delta for one revision.
616
763
 
632
779
 
633
780
        return compare_trees(old_tree, new_tree)
634
781
 
635
 
        
636
 
 
637
782
    def get_revision_sha1(self, revision_id):
638
783
        """Hash the stored value of a revision, and return it."""
639
784
        # In the future, revision entries will be signed. At that
642
787
        # the revision, (add signatures/remove signatures) and still
643
788
        # have all hash pointers stay consistent.
644
789
        # But for now, just hash the contents.
645
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
646
 
 
 
790
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
791
 
 
792
    def get_ancestry(self, revision_id):
 
793
        """Return a list of revision-ids integrated by a revision.
 
794
        
 
795
        This currently returns a list, but the ordering is not guaranteed:
 
796
        treat it as a set.
 
797
        """
 
798
        if revision_id is None:
 
799
            return [None]
 
800
        w = self.get_inventory_weave()
 
801
        return [None] + map(w.idx_to_name,
 
802
                            w.inclusions([w.lookup(revision_id)]))
 
803
 
 
804
    def get_inventory_weave(self):
 
805
        return self.control_weaves.get_weave('inventory',
 
806
                                             self.get_transaction())
647
807
 
648
808
    def get_inventory(self, revision_id):
649
 
        """Get Inventory object by hash.
650
 
 
651
 
        TODO: Perhaps for this and similar methods, take a revision
652
 
               parameter which can be either an integer revno or a
653
 
               string hash."""
654
 
        f = self.get_inventory_xml_file(revision_id)
655
 
        return bzrlib.xml5.serializer_v5.read_inventory(f)
656
 
 
 
809
        """Get Inventory object by hash."""
 
810
        xml = self.get_inventory_xml(revision_id)
 
811
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
657
812
 
658
813
    def get_inventory_xml(self, revision_id):
659
814
        """Get inventory XML as a file object."""
660
815
        try:
661
816
            assert isinstance(revision_id, basestring), type(revision_id)
662
 
            return self.inventory_store[revision_id]
 
817
            iw = self.get_inventory_weave()
 
818
            return iw.get_text(iw.lookup(revision_id))
663
819
        except IndexError:
664
820
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
665
821
 
666
 
    get_inventory_xml_file = get_inventory_xml
667
 
            
668
 
 
669
822
    def get_inventory_sha1(self, revision_id):
670
823
        """Return the sha1 hash of the inventory entry
671
824
        """
672
 
        return sha_file(self.get_inventory_xml_file(revision_id))
673
 
 
 
825
        return self.get_revision(revision_id).inventory_sha1
674
826
 
675
827
    def get_revision_inventory(self, revision_id):
676
828
        """Return inventory of a past revision."""
677
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
829
        # TODO: Unify this with get_inventory()
 
830
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
678
831
        # must be the same as its revision, so this is trivial.
679
832
        if revision_id == None:
680
833
            return Inventory(self.get_root_id())
681
834
        else:
682
835
            return self.get_inventory(revision_id)
683
836
 
684
 
 
685
837
    def revision_history(self):
686
 
        """Return sequence of revision hashes on to this branch.
687
 
 
688
 
        >>> ScratchBranch().revision_history()
689
 
        []
690
 
        """
 
838
        """Return sequence of revision hashes on to this branch."""
691
839
        self.lock_read()
692
840
        try:
693
 
            return [l.rstrip('\r\n') for l in
 
841
            transaction = self.get_transaction()
 
842
            history = transaction.map.find_revision_history()
 
843
            if history is not None:
 
844
                mutter("cache hit for revision-history in %s", self)
 
845
                return list(history)
 
846
            history = [l.rstrip('\r\n') for l in
694
847
                    self.controlfile('revision-history', 'r').readlines()]
 
848
            transaction.map.add_revision_history(history)
 
849
            # this call is disabled because revision_history is 
 
850
            # not really an object yet, and the transaction is for objects.
 
851
            # transaction.register_clean(history, precious=True)
 
852
            return list(history)
695
853
        finally:
696
854
            self.unlock()
697
855
 
698
 
 
699
856
    def common_ancestor(self, other, self_revno=None, other_revno=None):
700
857
        """
701
 
        >>> import commit
 
858
        >>> from bzrlib.commit import commit
702
859
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
703
860
        >>> sb.common_ancestor(sb) == (None, None)
704
861
        True
705
 
        >>> commit.commit(sb, "Committing first revision", verbose=False)
 
862
        >>> commit(sb, "Committing first revision", verbose=False)
706
863
        >>> sb.common_ancestor(sb)[0]
707
864
        1
708
865
        >>> clone = sb.clone()
709
 
        >>> commit.commit(sb, "Committing second revision", verbose=False)
 
866
        >>> commit(sb, "Committing second revision", verbose=False)
710
867
        >>> sb.common_ancestor(sb)[0]
711
868
        2
712
869
        >>> sb.common_ancestor(clone)[0]
713
870
        1
714
 
        >>> commit.commit(clone, "Committing divergent second revision", 
 
871
        >>> commit(clone, "Committing divergent second revision", 
715
872
        ...               verbose=False)
716
873
        >>> sb.common_ancestor(clone)[0]
717
874
        1
750
907
        return len(self.revision_history())
751
908
 
752
909
 
753
 
    def last_patch(self):
 
910
    def last_revision(self):
754
911
        """Return last patch hash, or None if no history.
755
912
        """
756
913
        ph = self.revision_history()
761
918
 
762
919
 
763
920
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
764
 
        """
 
921
        """Return a list of new revisions that would perfectly fit.
 
922
        
765
923
        If self and other have not diverged, return a list of the revisions
766
924
        present in other, but missing from self.
767
925
 
787
945
        Traceback (most recent call last):
788
946
        DivergedBranches: These branches have diverged.
789
947
        """
 
948
        # FIXME: If the branches have diverged, but the latest
 
949
        # revision in this branch is completely merged into the other,
 
950
        # then we should still be able to pull.
790
951
        self_history = self.revision_history()
791
952
        self_len = len(self_history)
792
953
        other_history = other.revision_history()
798
959
 
799
960
        if stop_revision is None:
800
961
            stop_revision = other_len
801
 
        elif stop_revision > other_len:
802
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
803
 
        
 
962
        else:
 
963
            assert isinstance(stop_revision, int)
 
964
            if stop_revision > other_len:
 
965
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
804
966
        return other_history[self_len:stop_revision]
805
967
 
806
 
 
807
968
    def update_revisions(self, other, stop_revision=None):
808
 
        """Pull in all new revisions from other branch.
809
 
        """
 
969
        """Pull in new perfect-fit revisions."""
810
970
        from bzrlib.fetch import greedy_fetch
811
 
 
812
 
        pb = bzrlib.ui.ui_factory.progress_bar()
813
 
        pb.update('comparing histories')
814
 
 
815
 
        revision_ids = self.missing_revisions(other, stop_revision)
816
 
 
817
 
        if len(revision_ids) > 0:
818
 
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
819
 
        else:
820
 
            count = 0
821
 
        self.append_revision(*revision_ids)
822
 
        ## note("Added %d revisions." % count)
823
 
        pb.clear()
824
 
 
825
 
    def install_revisions(self, other, revision_ids, pb):
826
 
        if hasattr(other.revision_store, "prefetch"):
827
 
            other.revision_store.prefetch(revision_ids)
828
 
        if hasattr(other.inventory_store, "prefetch"):
829
 
            inventory_ids = [other.get_revision(r).inventory_id
830
 
                             for r in revision_ids]
831
 
            other.inventory_store.prefetch(inventory_ids)
832
 
 
833
 
        if pb is None:
834
 
            pb = bzrlib.ui.ui_factory.progress_bar()
835
 
                
836
 
        revisions = []
837
 
        needed_texts = set()
838
 
        i = 0
839
 
 
840
 
        failures = set()
841
 
        for i, rev_id in enumerate(revision_ids):
842
 
            pb.update('fetching revision', i+1, len(revision_ids))
843
 
            try:
844
 
                rev = other.get_revision(rev_id)
845
 
            except bzrlib.errors.NoSuchRevision:
846
 
                failures.add(rev_id)
847
 
                continue
848
 
 
849
 
            revisions.append(rev)
850
 
            inv = other.get_inventory(str(rev.inventory_id))
851
 
            for key, entry in inv.iter_entries():
852
 
                if entry.text_id is None:
853
 
                    continue
854
 
                if entry.text_id not in self.text_store:
855
 
                    needed_texts.add(entry.text_id)
856
 
 
857
 
        pb.clear()
858
 
                    
859
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
860
 
                                                    needed_texts)
861
 
        #print "Added %d texts." % count 
862
 
        inventory_ids = [ f.inventory_id for f in revisions ]
863
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
864
 
                                                         inventory_ids)
865
 
        #print "Added %d inventories." % count 
866
 
        revision_ids = [ f.revision_id for f in revisions]
867
 
 
868
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
869
 
                                                          revision_ids,
870
 
                                                          permit_failure=True)
871
 
        assert len(cp_fail) == 0 
872
 
        return count, failures
873
 
       
 
971
        from bzrlib.revision import get_intervening_revisions
 
972
        if stop_revision is None:
 
973
            stop_revision = other.last_revision()
 
974
        if (stop_revision is not None and 
 
975
            stop_revision in self.revision_history()):
 
976
            return
 
977
        greedy_fetch(to_branch=self, from_branch=other,
 
978
                     revision=stop_revision)
 
979
        pullable_revs = self.missing_revisions(
 
980
            other, other.revision_id_to_revno(stop_revision))
 
981
        if pullable_revs:
 
982
            greedy_fetch(to_branch=self,
 
983
                         from_branch=other,
 
984
                         revision=pullable_revs[-1])
 
985
            self.append_revision(*pullable_revs)
 
986
    
874
987
 
875
988
    def commit(self, *args, **kw):
876
989
        from bzrlib.commit import Commit
877
990
        Commit().commit(self, *args, **kw)
878
 
        
879
 
 
880
 
    def lookup_revision(self, revision):
881
 
        """Return the revision identifier for a given revision information."""
882
 
        revno, info = self._get_revision_info(revision)
883
 
        return info
884
 
 
885
 
 
 
991
    
886
992
    def revision_id_to_revno(self, revision_id):
887
993
        """Given a revision id, return its revno"""
 
994
        if revision_id is None:
 
995
            return 0
888
996
        history = self.revision_history()
889
997
        try:
890
998
            return history.index(revision_id) + 1
891
999
        except ValueError:
892
1000
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
893
1001
 
894
 
 
895
 
    def get_revision_info(self, revision):
896
 
        """Return (revno, revision id) for revision identifier.
897
 
 
898
 
        revision can be an integer, in which case it is assumed to be revno (though
899
 
            this will translate negative values into positive ones)
900
 
        revision can also be a string, in which case it is parsed for something like
901
 
            'date:' or 'revid:' etc.
902
 
        """
903
 
        revno, rev_id = self._get_revision_info(revision)
904
 
        if revno is None:
905
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
906
 
        return revno, rev_id
907
 
 
908
1002
    def get_rev_id(self, revno, history=None):
909
1003
        """Find the revision id of the specified revno."""
910
1004
        if revno == 0:
915
1009
            raise bzrlib.errors.NoSuchRevision(self, revno)
916
1010
        return history[revno - 1]
917
1011
 
918
 
    def _get_revision_info(self, revision):
919
 
        """Return (revno, revision id) for revision specifier.
920
 
 
921
 
        revision can be an integer, in which case it is assumed to be revno
922
 
        (though this will translate negative values into positive ones)
923
 
        revision can also be a string, in which case it is parsed for something
924
 
        like 'date:' or 'revid:' etc.
925
 
 
926
 
        A revid is always returned.  If it is None, the specifier referred to
927
 
        the null revision.  If the revid does not occur in the revision
928
 
        history, revno will be None.
929
 
        """
930
 
        
931
 
        if revision is None:
932
 
            return 0, None
933
 
        revno = None
934
 
        try:# Convert to int if possible
935
 
            revision = int(revision)
936
 
        except ValueError:
937
 
            pass
938
 
        revs = self.revision_history()
939
 
        if isinstance(revision, int):
940
 
            if revision < 0:
941
 
                revno = len(revs) + revision + 1
942
 
            else:
943
 
                revno = revision
944
 
            rev_id = self.get_rev_id(revno, revs)
945
 
        elif isinstance(revision, basestring):
946
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
947
 
                if revision.startswith(prefix):
948
 
                    result = func(self, revs, revision)
949
 
                    if len(result) > 1:
950
 
                        revno, rev_id = result
951
 
                    else:
952
 
                        revno = result[0]
953
 
                        rev_id = self.get_rev_id(revno, revs)
954
 
                    break
955
 
            else:
956
 
                raise BzrError('No namespace registered for string: %r' %
957
 
                               revision)
958
 
        else:
959
 
            raise TypeError('Unhandled revision type %s' % revision)
960
 
 
961
 
        if revno is None:
962
 
            if rev_id is None:
963
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
964
 
        return revno, rev_id
965
 
 
966
 
    def _namespace_revno(self, revs, revision):
967
 
        """Lookup a revision by revision number"""
968
 
        assert revision.startswith('revno:')
969
 
        try:
970
 
            return (int(revision[6:]),)
971
 
        except ValueError:
972
 
            return None
973
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
974
 
 
975
 
    def _namespace_revid(self, revs, revision):
976
 
        assert revision.startswith('revid:')
977
 
        rev_id = revision[len('revid:'):]
978
 
        try:
979
 
            return revs.index(rev_id) + 1, rev_id
980
 
        except ValueError:
981
 
            return None, rev_id
982
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
983
 
 
984
 
    def _namespace_last(self, revs, revision):
985
 
        assert revision.startswith('last:')
986
 
        try:
987
 
            offset = int(revision[5:])
988
 
        except ValueError:
989
 
            return (None,)
990
 
        else:
991
 
            if offset <= 0:
992
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
993
 
            return (len(revs) - offset + 1,)
994
 
    REVISION_NAMESPACES['last:'] = _namespace_last
995
 
 
996
 
    def _namespace_tag(self, revs, revision):
997
 
        assert revision.startswith('tag:')
998
 
        raise BzrError('tag: namespace registered, but not implemented.')
999
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
1000
 
 
1001
 
    def _namespace_date(self, revs, revision):
1002
 
        assert revision.startswith('date:')
1003
 
        import datetime
1004
 
        # Spec for date revisions:
1005
 
        #   date:value
1006
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
1007
 
        #   it can also start with a '+/-/='. '+' says match the first
1008
 
        #   entry after the given date. '-' is match the first entry before the date
1009
 
        #   '=' is match the first entry after, but still on the given date.
1010
 
        #
1011
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
1012
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
1013
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
1014
 
        #       May 13th, 2005 at 0:00
1015
 
        #
1016
 
        #   So the proper way of saying 'give me all entries for today' is:
1017
 
        #       -r {date:+today}:{date:-tomorrow}
1018
 
        #   The default is '=' when not supplied
1019
 
        val = revision[5:]
1020
 
        match_style = '='
1021
 
        if val[:1] in ('+', '-', '='):
1022
 
            match_style = val[:1]
1023
 
            val = val[1:]
1024
 
 
1025
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
1026
 
        if val.lower() == 'yesterday':
1027
 
            dt = today - datetime.timedelta(days=1)
1028
 
        elif val.lower() == 'today':
1029
 
            dt = today
1030
 
        elif val.lower() == 'tomorrow':
1031
 
            dt = today + datetime.timedelta(days=1)
1032
 
        else:
1033
 
            import re
1034
 
            # This should be done outside the function to avoid recompiling it.
1035
 
            _date_re = re.compile(
1036
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1037
 
                    r'(,|T)?\s*'
1038
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1039
 
                )
1040
 
            m = _date_re.match(val)
1041
 
            if not m or (not m.group('date') and not m.group('time')):
1042
 
                raise BzrError('Invalid revision date %r' % revision)
1043
 
 
1044
 
            if m.group('date'):
1045
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1046
 
            else:
1047
 
                year, month, day = today.year, today.month, today.day
1048
 
            if m.group('time'):
1049
 
                hour = int(m.group('hour'))
1050
 
                minute = int(m.group('minute'))
1051
 
                if m.group('second'):
1052
 
                    second = int(m.group('second'))
1053
 
                else:
1054
 
                    second = 0
1055
 
            else:
1056
 
                hour, minute, second = 0,0,0
1057
 
 
1058
 
            dt = datetime.datetime(year=year, month=month, day=day,
1059
 
                    hour=hour, minute=minute, second=second)
1060
 
        first = dt
1061
 
        last = None
1062
 
        reversed = False
1063
 
        if match_style == '-':
1064
 
            reversed = True
1065
 
        elif match_style == '=':
1066
 
            last = dt + datetime.timedelta(days=1)
1067
 
 
1068
 
        if reversed:
1069
 
            for i in range(len(revs)-1, -1, -1):
1070
 
                r = self.get_revision(revs[i])
1071
 
                # TODO: Handle timezone.
1072
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1073
 
                if first >= dt and (last is None or dt >= last):
1074
 
                    return (i+1,)
1075
 
        else:
1076
 
            for i in range(len(revs)):
1077
 
                r = self.get_revision(revs[i])
1078
 
                # TODO: Handle timezone.
1079
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1080
 
                if first <= dt and (last is None or dt <= last):
1081
 
                    return (i+1,)
1082
 
    REVISION_NAMESPACES['date:'] = _namespace_date
1083
 
 
1084
1012
    def revision_tree(self, revision_id):
1085
1013
        """Return Tree for a revision on this branch.
1086
1014
 
1097
1025
 
1098
1026
    def working_tree(self):
1099
1027
        """Return a `Tree` for the working copy."""
1100
 
        from workingtree import WorkingTree
1101
 
        return WorkingTree(self.base, self.read_working_inventory())
 
1028
        from bzrlib.workingtree import WorkingTree
 
1029
        # TODO: In the future, WorkingTree should utilize Transport
 
1030
        # RobertCollins 20051003 - I don't think it should - working trees are
 
1031
        # much more complex to keep consistent than our careful .bzr subset.
 
1032
        # instead, we should say that working trees are local only, and optimise
 
1033
        # for that.
 
1034
        return WorkingTree(self.base, branch=self)
1102
1035
 
1103
1036
 
1104
1037
    def basis_tree(self):
1106
1039
 
1107
1040
        If there are no revisions yet, return an `EmptyTree`.
1108
1041
        """
1109
 
        return self.revision_tree(self.last_patch())
 
1042
        return self.revision_tree(self.last_revision())
1110
1043
 
1111
1044
 
1112
1045
    def rename_one(self, from_rel, to_rel):
1147
1080
            from_abs = self.abspath(from_rel)
1148
1081
            to_abs = self.abspath(to_rel)
1149
1082
            try:
1150
 
                os.rename(from_abs, to_abs)
 
1083
                rename(from_abs, to_abs)
1151
1084
            except OSError, e:
1152
1085
                raise BzrError("failed to rename %r to %r: %s"
1153
1086
                        % (from_abs, to_abs, e[1]),
1216
1149
                result.append((f, dest_path))
1217
1150
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1218
1151
                try:
1219
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1152
                    rename(self.abspath(f), self.abspath(dest_path))
1220
1153
                except OSError, e:
1221
1154
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1222
1155
                            ["rename rolled back"])
1278
1211
        These are revisions that have been merged into the working
1279
1212
        directory but not yet committed.
1280
1213
        """
1281
 
        cfn = self.controlfilename('pending-merges')
1282
 
        if not os.path.exists(cfn):
 
1214
        cfn = self._rel_controlfilename('pending-merges')
 
1215
        if not self._transport.has(cfn):
1283
1216
            return []
1284
1217
        p = []
1285
1218
        for l in self.controlfile('pending-merges', 'r').readlines():
1287
1220
        return p
1288
1221
 
1289
1222
 
1290
 
    def add_pending_merge(self, revision_id):
1291
 
        from bzrlib.revision import validate_revision_id
1292
 
 
1293
 
        validate_revision_id(revision_id)
1294
 
 
 
1223
    def add_pending_merge(self, *revision_ids):
 
1224
        # TODO: Perhaps should check at this point that the
 
1225
        # history of the revision is actually present?
1295
1226
        p = self.pending_merges()
1296
 
        if revision_id in p:
1297
 
            return
1298
 
        p.append(revision_id)
1299
 
        self.set_pending_merges(p)
1300
 
 
 
1227
        updated = False
 
1228
        for rev_id in revision_ids:
 
1229
            if rev_id in p:
 
1230
                continue
 
1231
            p.append(rev_id)
 
1232
            updated = True
 
1233
        if updated:
 
1234
            self.set_pending_merges(p)
1301
1235
 
1302
1236
    def set_pending_merges(self, rev_list):
1303
 
        from bzrlib.atomicfile import AtomicFile
1304
1237
        self.lock_write()
1305
1238
        try:
1306
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1307
 
            try:
1308
 
                for l in rev_list:
1309
 
                    print >>f, l
1310
 
                f.commit()
1311
 
            finally:
1312
 
                f.close()
 
1239
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
1313
1240
        finally:
1314
1241
            self.unlock()
1315
1242
 
1363
1290
            raise InvalidRevisionNumber(revno)
1364
1291
        
1365
1292
        
1366
 
 
1367
 
 
1368
 
class ScratchBranch(Branch):
 
1293
        
 
1294
 
 
1295
 
 
1296
class ScratchBranch(_Branch):
1369
1297
    """Special test class: a branch that cleans up after itself.
1370
1298
 
1371
1299
    >>> b = ScratchBranch()
1388
1316
        if base is None:
1389
1317
            base = mkdtemp()
1390
1318
            init = True
1391
 
        Branch.__init__(self, base, init=init)
 
1319
        if isinstance(base, basestring):
 
1320
            base = get_transport(base)
 
1321
        _Branch.__init__(self, base, init=init)
1392
1322
        for d in dirs:
1393
 
            os.mkdir(self.abspath(d))
 
1323
            self._transport.mkdir(d)
1394
1324
            
1395
1325
        for f in files:
1396
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1326
            self._transport.put(f, 'content of %s' % f)
1397
1327
 
1398
1328
 
1399
1329
    def clone(self):
1400
1330
        """
1401
1331
        >>> orig = ScratchBranch(files=["file1", "file2"])
1402
1332
        >>> clone = orig.clone()
1403
 
        >>> os.path.samefile(orig.base, clone.base)
 
1333
        >>> if os.name != 'nt':
 
1334
        ...   os.path.samefile(orig.base, clone.base)
 
1335
        ... else:
 
1336
        ...   orig.base == clone.base
 
1337
        ...
1404
1338
        False
1405
1339
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1406
1340
        True
1412
1346
        copytree(self.base, base, symlinks=True)
1413
1347
        return ScratchBranch(base=base)
1414
1348
 
1415
 
 
1416
 
        
1417
1349
    def __del__(self):
1418
1350
        self.destroy()
1419
1351
 
1432
1364
                for name in files:
1433
1365
                    os.chmod(os.path.join(root, name), 0700)
1434
1366
            rmtree(self.base)
1435
 
        self.base = None
 
1367
        self._transport = None
1436
1368
 
1437
1369
    
1438
1370
 
1489
1421
    return gen_file_id('TREE_ROOT')
1490
1422
 
1491
1423
 
1492
 
def pull_loc(branch):
1493
 
    # TODO: Should perhaps just make attribute be 'base' in
1494
 
    # RemoteBranch and Branch?
1495
 
    if hasattr(branch, "baseurl"):
1496
 
        return branch.baseurl
1497
 
    else:
1498
 
        return branch.base
1499
 
 
1500
 
 
1501
 
def copy_branch(branch_from, to_location, revision=None):
1502
 
    """Copy branch_from into the existing directory to_location.
1503
 
 
1504
 
    revision
1505
 
        If not None, only revisions up to this point will be copied.
1506
 
        The head of the new branch will be that revision.
1507
 
 
1508
 
    to_location
1509
 
        The name of a local directory that exists but is empty.
1510
 
    """
1511
 
    from bzrlib.merge import merge
1512
 
    from bzrlib.branch import Branch
1513
 
 
1514
 
    assert isinstance(branch_from, Branch)
1515
 
    assert isinstance(to_location, basestring)
1516
 
    
1517
 
    br_to = Branch(to_location, init=True)
1518
 
    br_to.set_root_id(branch_from.get_root_id())
1519
 
    if revision is None:
1520
 
        revno = branch_from.revno()
1521
 
    else:
1522
 
        revno, rev_id = branch_from.get_revision_info(revision)
1523
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1524
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1525
 
          check_clean=False, ignore_zero=True)
1526
 
    
1527
 
    from_location = pull_loc(branch_from)
1528
 
    br_to.set_parent(pull_loc(branch_from))
1529