~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2005-10-27 23:09:26 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1491.
  • Revision ID: abentley@panoramicfeedback.com-20051027230926-4e9911d404596430
Got reprocessing working

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
20
22
from cStringIO import StringIO
21
23
 
 
24
 
22
25
import bzrlib
 
26
from bzrlib.inventory import InventoryEntry
 
27
import bzrlib.inventory as inventory
23
28
from bzrlib.trace import mutter, note
24
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
 
     splitpath, \
26
 
     sha_file, appendpath, file_kind
27
 
 
 
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes, 
 
30
                            rename, splitpath, sha_file, appendpath, 
 
31
                            file_kind, abspath)
 
32
import bzrlib.errors as errors
28
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
 
                           NoSuchRevision)
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError, UnlistableStore,
 
36
                           UnlistableBranch, NoSuchFile, NotVersionedError)
30
37
from bzrlib.textui import show_status
31
 
from bzrlib.revision import Revision
 
38
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
 
39
                             NULL_REVISION)
 
40
 
32
41
from bzrlib.delta import compare_trees
33
42
from bzrlib.tree import EmptyTree, RevisionTree
34
43
from bzrlib.inventory import Inventory
35
 
from bzrlib.weavestore import WeaveStore
36
 
from bzrlib.store import ImmutableStore
 
44
from bzrlib.store import copy_all
 
45
from bzrlib.store.compressed_text import CompressedTextStore
 
46
from bzrlib.store.text import TextStore
 
47
from bzrlib.store.weave import WeaveStore
 
48
from bzrlib.testament import Testament
 
49
import bzrlib.transactions as transactions
 
50
from bzrlib.transport import Transport, get_transport
37
51
import bzrlib.xml5
38
52
import bzrlib.ui
39
53
 
40
54
 
41
 
INVENTORY_FILEID = '__inventory'
42
 
ANCESTRY_FILEID = '__ancestry'
43
 
 
44
 
 
45
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
46
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
57
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
47
58
## TODO: Maybe include checks for common corruption of newlines, etc?
48
59
 
49
60
 
52
63
# cache in memory to make this faster.  In general anything can be
53
64
# cached in memory between lock and unlock operations.
54
65
 
55
 
# TODO: please move the revision-string syntax stuff out of the branch
56
 
# object; it's clutter
57
 
 
58
 
 
59
 
def find_branch(f, **args):
60
 
    if f and (f.startswith('http://') or f.startswith('https://')):
61
 
        import remotebranch 
62
 
        return remotebranch.RemoteBranch(f, **args)
63
 
    else:
64
 
        return Branch(f, **args)
65
 
 
66
 
 
67
 
def find_cached_branch(f, cache_root, **args):
68
 
    from remotebranch import RemoteBranch
69
 
    br = find_branch(f, **args)
70
 
    def cacheify(br, store_name):
71
 
        from meta_store import CachedStore
72
 
        cache_path = os.path.join(cache_root, store_name)
73
 
        os.mkdir(cache_path)
74
 
        new_store = CachedStore(getattr(br, store_name), cache_path)
75
 
        setattr(br, store_name, new_store)
76
 
 
77
 
    if isinstance(br, RemoteBranch):
78
 
        cacheify(br, 'inventory_store')
79
 
        cacheify(br, 'text_store')
80
 
        cacheify(br, 'revision_store')
81
 
    return br
82
 
 
83
 
 
84
 
def _relpath(base, path):
85
 
    """Return path relative to base, or raise exception.
86
 
 
87
 
    The path may be either an absolute path or a path relative to the
88
 
    current working directory.
89
 
 
90
 
    Lifted out of Branch.relpath for ease of testing.
91
 
 
92
 
    os.path.commonprefix (python2.4) has a bad bug that it works just
93
 
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
94
 
    avoids that problem."""
95
 
    rp = os.path.abspath(path)
96
 
 
97
 
    s = []
98
 
    head = rp
99
 
    while len(head) >= len(base):
100
 
        if head == base:
101
 
            break
102
 
        head, tail = os.path.split(head)
103
 
        if tail:
104
 
            s.insert(0, tail)
105
 
    else:
106
 
        from errors import NotBranchError
107
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
108
 
 
109
 
    return os.sep.join(s)
110
 
        
111
 
 
112
 
def find_branch_root(f=None):
113
 
    """Find the branch root enclosing f, or pwd.
114
 
 
115
 
    f may be a filename or a URL.
116
 
 
117
 
    It is not necessary that f exists.
118
 
 
119
 
    Basically we keep looking up until we find the control directory or
120
 
    run into the root.  If there isn't one, raises NotBranchError.
121
 
    """
122
 
    if f == None:
123
 
        f = os.getcwd()
124
 
    elif hasattr(os.path, 'realpath'):
125
 
        f = os.path.realpath(f)
126
 
    else:
127
 
        f = os.path.abspath(f)
128
 
    if not os.path.exists(f):
129
 
        raise BzrError('%r does not exist' % f)
130
 
        
131
 
 
132
 
    orig_f = f
133
 
 
134
 
    while True:
135
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
136
 
            return f
137
 
        head, tail = os.path.split(f)
138
 
        if head == f:
139
 
            # reached the root, whatever that may be
140
 
            raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
141
 
        f = head
142
 
 
143
 
 
144
 
 
145
 
# XXX: move into bzrlib.errors; subclass BzrError    
146
 
class DivergedBranches(Exception):
147
 
    def __init__(self, branch1, branch2):
148
 
        self.branch1 = branch1
149
 
        self.branch2 = branch2
150
 
        Exception.__init__(self, "These branches have diverged.")
151
 
 
 
66
def find_branch(*ignored, **ignored_too):
 
67
    # XXX: leave this here for about one release, then remove it
 
68
    raise NotImplementedError('find_branch() is not supported anymore, '
 
69
                              'please use one of the new branch constructors')
 
70
 
 
71
 
 
72
def needs_read_lock(unbound):
 
73
    """Decorate unbound to take out and release a read lock."""
 
74
    def decorated(self, *args, **kwargs):
 
75
        self.lock_read()
 
76
        try:
 
77
            return unbound(self, *args, **kwargs)
 
78
        finally:
 
79
            self.unlock()
 
80
    return decorated
 
81
 
 
82
 
 
83
def needs_write_lock(unbound):
 
84
    """Decorate unbound to take out and release a write lock."""
 
85
    def decorated(self, *args, **kwargs):
 
86
        self.lock_write()
 
87
        try:
 
88
            return unbound(self, *args, **kwargs)
 
89
        finally:
 
90
            self.unlock()
 
91
    return decorated
152
92
 
153
93
######################################################################
154
94
# branch objects
157
97
    """Branch holding a history of revisions.
158
98
 
159
99
    base
160
 
        Base directory of the branch.
 
100
        Base directory/url of the branch.
 
101
    """
 
102
    base = None
 
103
 
 
104
    def __init__(self, *ignored, **ignored_too):
 
105
        raise NotImplementedError('The Branch class is abstract')
 
106
 
 
107
    @staticmethod
 
108
    def open_downlevel(base):
 
109
        """Open a branch which may be of an old format.
 
110
        
 
111
        Only local branches are supported."""
 
112
        return _Branch(get_transport(base), relax_version_check=True)
 
113
        
 
114
    @staticmethod
 
115
    def open(base):
 
116
        """Open an existing branch, rooted at 'base' (url)"""
 
117
        t = get_transport(base)
 
118
        mutter("trying to open %r with transport %r", base, t)
 
119
        return _Branch(t)
 
120
 
 
121
    @staticmethod
 
122
    def open_containing(url):
 
123
        """Open an existing branch which contains url.
 
124
        
 
125
        This probes for a branch at url, and searches upwards from there.
 
126
 
 
127
        Basically we keep looking up until we find the control directory or
 
128
        run into the root.  If there isn't one, raises NotBranchError.
 
129
        If there is one, it is returned, along with the unused portion of url.
 
130
        """
 
131
        t = get_transport(url)
 
132
        while True:
 
133
            try:
 
134
                return _Branch(t), t.relpath(url)
 
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(path=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.
161
162
 
162
163
    _lock_mode
163
164
        None, or 'r' or 'w'
169
170
    _lock
170
171
        Lock object from bzrlib.lock.
171
172
    """
172
 
    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.
173
177
    _lock_mode = None
174
178
    _lock_count = None
175
179
    _lock = None
180
184
    # This should match a prefix with a function which accepts
181
185
    REVISION_NAMESPACES = {}
182
186
 
183
 
    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):
184
209
        """Create new branch object at a particular location.
185
210
 
186
 
        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)
187
214
        
188
215
        init -- If True, create new control files in a previously
189
216
             unversioned directory.  If False, the branch must already
190
217
             be versioned.
191
218
 
192
 
        find_root -- If true and init is false, find the root of the
193
 
             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.
194
223
 
195
224
        In the test suite, creation of new trees is tested using the
196
225
        `ScratchBranch` class.
197
226
        """
 
227
        assert isinstance(transport, Transport), \
 
228
            "%r is not a Transport" % transport
 
229
        self._transport = transport
198
230
        if init:
199
 
            self.base = os.path.realpath(base)
200
231
            self._make_control()
201
 
        elif find_root:
202
 
            self.base = find_branch_root(base)
203
 
        else:
204
 
            self.base = os.path.realpath(base)
205
 
            if not isdir(self.controlfilename('.')):
206
 
                from errors import NotBranchError
207
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
 
                                     ['use "bzr init" to initialize a new working tree',
209
 
                                      'current bzr can only operate from top-of-tree'])
210
 
        self._check_format()
211
 
 
212
 
        self.weave_store = WeaveStore(self.controlfilename('weaves'))
213
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
214
 
 
 
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.revision_store.register_suffix('sig')
 
272
        self._transaction = None
215
273
 
216
274
    def __str__(self):
217
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
275
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
218
276
 
219
277
 
220
278
    __repr__ = __str__
222
280
 
223
281
    def __del__(self):
224
282
        if self._lock_mode or self._lock:
225
 
            from warnings import warn
 
283
            # XXX: This should show something every time, and be suitable for
 
284
            # headless operation and embedding
226
285
            warn("branch %r was not explicitly unlocked" % self)
227
286
            self._lock.unlock()
228
287
 
 
288
        # TODO: It might be best to do this somewhere else,
 
289
        # but it is nice for a Branch object to automatically
 
290
        # cache it's information.
 
291
        # Alternatively, we could have the Transport objects cache requests
 
292
        # See the earlier discussion about how major objects (like Branch)
 
293
        # should never expect their __del__ function to run.
 
294
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
295
            try:
 
296
                import shutil
 
297
                shutil.rmtree(self.cache_root)
 
298
            except:
 
299
                pass
 
300
            self.cache_root = None
 
301
 
 
302
    def _get_base(self):
 
303
        if self._transport:
 
304
            return self._transport.base
 
305
        return None
 
306
 
 
307
    base = property(_get_base, doc="The URL for the root of this branch.")
 
308
 
 
309
    def _finish_transaction(self):
 
310
        """Exit the current transaction."""
 
311
        if self._transaction is None:
 
312
            raise errors.LockError('Branch %s is not in a transaction' %
 
313
                                   self)
 
314
        transaction = self._transaction
 
315
        self._transaction = None
 
316
        transaction.finish()
 
317
 
 
318
    def get_transaction(self):
 
319
        """Return the current active transaction.
 
320
 
 
321
        If no transaction is active, this returns a passthrough object
 
322
        for which all data is immedaitely flushed and no caching happens.
 
323
        """
 
324
        if self._transaction is None:
 
325
            return transactions.PassThroughTransaction()
 
326
        else:
 
327
            return self._transaction
 
328
 
 
329
    def _set_transaction(self, new_transaction):
 
330
        """Set a new active transaction."""
 
331
        if self._transaction is not None:
 
332
            raise errors.LockError('Branch %s is in a transaction already.' %
 
333
                                   self)
 
334
        self._transaction = new_transaction
229
335
 
230
336
    def lock_write(self):
 
337
        mutter("lock write: %s (%s)", self, self._lock_count)
 
338
        # TODO: Upgrade locking to support using a Transport,
 
339
        # and potentially a remote locking protocol
231
340
        if self._lock_mode:
232
341
            if self._lock_mode != 'w':
233
 
                from errors import LockError
234
342
                raise LockError("can't upgrade to a write lock from %r" %
235
343
                                self._lock_mode)
236
344
            self._lock_count += 1
237
345
        else:
238
 
            from bzrlib.lock import WriteLock
239
 
 
240
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
346
            self._lock = self._transport.lock_write(
 
347
                    self._rel_controlfilename('branch-lock'))
241
348
            self._lock_mode = 'w'
242
349
            self._lock_count = 1
243
 
 
 
350
            self._set_transaction(transactions.PassThroughTransaction())
244
351
 
245
352
    def lock_read(self):
 
353
        mutter("lock read: %s (%s)", self, self._lock_count)
246
354
        if self._lock_mode:
247
355
            assert self._lock_mode in ('r', 'w'), \
248
356
                   "invalid lock mode %r" % self._lock_mode
249
357
            self._lock_count += 1
250
358
        else:
251
 
            from bzrlib.lock import ReadLock
252
 
 
253
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
359
            self._lock = self._transport.lock_read(
 
360
                    self._rel_controlfilename('branch-lock'))
254
361
            self._lock_mode = 'r'
255
362
            self._lock_count = 1
 
363
            self._set_transaction(transactions.ReadOnlyTransaction())
 
364
            # 5K may be excessive, but hey, its a knob.
 
365
            self.get_transaction().set_cache_size(5000)
256
366
                        
257
367
    def unlock(self):
 
368
        mutter("unlock: %s (%s)", self, self._lock_count)
258
369
        if not self._lock_mode:
259
 
            from errors import LockError
260
370
            raise LockError('branch %r is not locked' % (self))
261
371
 
262
372
        if self._lock_count > 1:
263
373
            self._lock_count -= 1
264
374
        else:
 
375
            self._finish_transaction()
265
376
            self._lock.unlock()
266
377
            self._lock = None
267
378
            self._lock_mode = self._lock_count = None
268
379
 
269
380
    def abspath(self, name):
270
 
        """Return absolute filename for something in the branch"""
271
 
        return os.path.join(self.base, name)
272
 
 
273
 
    def relpath(self, path):
274
 
        """Return path relative to this branch of something inside it.
275
 
 
276
 
        Raises an error if path is not in this branch."""
277
 
        return _relpath(self.base, path)
 
381
        """Return absolute filename for something in the branch
 
382
        
 
383
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
384
        method and not a tree method.
 
385
        """
 
386
        return self._transport.abspath(name)
 
387
 
 
388
    def _rel_controlfilename(self, file_or_path):
 
389
        if not isinstance(file_or_path, basestring):
 
390
            file_or_path = '/'.join(file_or_path)
 
391
        if file_or_path == '':
 
392
            return bzrlib.BZRDIR
 
393
        return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
278
394
 
279
395
    def controlfilename(self, file_or_path):
280
396
        """Return location relative to branch."""
281
 
        if isinstance(file_or_path, basestring):
282
 
            file_or_path = [file_or_path]
283
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
284
 
 
 
397
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
285
398
 
286
399
    def controlfile(self, file_or_path, mode='r'):
287
400
        """Open a control file for this branch.
294
407
        Controlfiles should almost never be opened in write mode but
295
408
        rather should be atomically copied and replaced using atomicfile.
296
409
        """
297
 
 
298
 
        fn = self.controlfilename(file_or_path)
299
 
 
300
 
        if mode == 'rb' or mode == 'wb':
301
 
            return file(fn, mode)
302
 
        elif mode == 'r' or mode == 'w':
303
 
            # open in binary mode anyhow so there's no newline translation;
304
 
            # codecs uses line buffering by default; don't want that.
305
 
            import codecs
306
 
            return codecs.open(fn, mode + 'b', 'utf-8',
307
 
                               buffering=60000)
 
410
        import codecs
 
411
 
 
412
        relpath = self._rel_controlfilename(file_or_path)
 
413
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
414
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
415
        if mode == 'rb': 
 
416
            return self._transport.get(relpath)
 
417
        elif mode == 'wb':
 
418
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
419
        elif mode == 'r':
 
420
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
421
        elif mode == 'w':
 
422
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
308
423
        else:
309
424
            raise BzrError("invalid controlfile mode %r" % mode)
310
425
 
 
426
    def put_controlfile(self, path, f, encode=True):
 
427
        """Write an entry as a controlfile.
 
428
 
 
429
        :param path: The path to put the file, relative to the .bzr control
 
430
                     directory
 
431
        :param f: A file-like or string object whose contents should be copied.
 
432
        :param encode:  If true, encode the contents as utf-8
 
433
        """
 
434
        self.put_controlfiles([(path, f)], encode=encode)
 
435
 
 
436
    def put_controlfiles(self, files, encode=True):
 
437
        """Write several entries as controlfiles.
 
438
 
 
439
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
440
                      underneath the bzr control directory
 
441
        :param encode:  If true, encode the contents as utf-8
 
442
        """
 
443
        import codecs
 
444
        ctrl_files = []
 
445
        for path, f in files:
 
446
            if encode:
 
447
                if isinstance(f, basestring):
 
448
                    f = f.encode('utf-8', 'replace')
 
449
                else:
 
450
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
451
            path = self._rel_controlfilename(path)
 
452
            ctrl_files.append((path, f))
 
453
        self._transport.put_multi(ctrl_files)
 
454
 
311
455
    def _make_control(self):
312
 
        os.mkdir(self.controlfilename([]))
313
 
        self.controlfile('README', 'w').write(
314
 
            "This is a Bazaar-NG control directory.\n"
315
 
            "Do not change any files in this directory.\n")
316
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
 
        for d in ('text-store', 'revision-store',
318
 
                  'weaves'):
319
 
            os.mkdir(self.controlfilename(d))
320
 
        for f in ('revision-history', 'merged-patches',
321
 
                  'pending-merged-patches', 'branch-name',
322
 
                  'branch-lock',
323
 
                  'pending-merges'):
324
 
            self.controlfile(f, 'w').write('')
325
 
        mutter('created control directory in ' + self.base)
326
 
 
 
456
        from bzrlib.inventory import Inventory
 
457
        from bzrlib.weavefile import write_weave_v5
 
458
        from bzrlib.weave import Weave
 
459
        
 
460
        # Create an empty inventory
 
461
        sio = StringIO()
327
462
        # if we want per-tree root ids then this is the place to set
328
463
        # them; they're not needed for now and so ommitted for
329
464
        # simplicity.
330
 
        f = self.controlfile('inventory','w')
331
 
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
332
 
        
333
 
 
334
 
 
335
 
    def _check_format(self):
 
465
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
 
466
        empty_inv = sio.getvalue()
 
467
        sio = StringIO()
 
468
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
469
        empty_weave = sio.getvalue()
 
470
 
 
471
        dirs = [[], 'revision-store', 'weaves']
 
472
        files = [('README', 
 
473
            "This is a Bazaar-NG control directory.\n"
 
474
            "Do not change any files in this directory.\n"),
 
475
            ('branch-format', BZR_BRANCH_FORMAT_6),
 
476
            ('revision-history', ''),
 
477
            ('branch-name', ''),
 
478
            ('branch-lock', ''),
 
479
            ('pending-merges', ''),
 
480
            ('inventory', empty_inv),
 
481
            ('inventory.weave', empty_weave),
 
482
            ('ancestry.weave', empty_weave)
 
483
        ]
 
484
        cfn = self._rel_controlfilename
 
485
        self._transport.mkdir_multi([cfn(d) for d in dirs])
 
486
        self.put_controlfiles(files)
 
487
        mutter('created control directory in ' + self._transport.base)
 
488
 
 
489
    def _check_format(self, relax_version_check):
336
490
        """Check this branch format is supported.
337
491
 
338
492
        The format level is stored, as an integer, in
341
495
        In the future, we might need different in-memory Branch
342
496
        classes to support downlevel branches.  But not yet.
343
497
        """
344
 
        fmt = self.controlfile('branch-format', 'r').read()
345
 
        if fmt == BZR_BRANCH_FORMAT_5:
 
498
        try:
 
499
            fmt = self.controlfile('branch-format', 'r').read()
 
500
        except NoSuchFile:
 
501
            raise NotBranchError(path=self.base)
 
502
        mutter("got branch format %r", fmt)
 
503
        if fmt == BZR_BRANCH_FORMAT_6:
 
504
            self._branch_format = 6
 
505
        elif fmt == BZR_BRANCH_FORMAT_5:
346
506
            self._branch_format = 5
347
 
        else:
348
 
            raise BzrError('sorry, branch format "%s" not supported; ' 
349
 
                           'use a different bzr version, '
350
 
                           'or run "bzr upgrade", '
351
 
                           'or remove the .bzr directory and "bzr init" again'
352
 
                           % fmt.rstrip('\n\r'))
 
507
        elif fmt == BZR_BRANCH_FORMAT_4:
 
508
            self._branch_format = 4
 
509
 
 
510
        if (not relax_version_check
 
511
            and self._branch_format not in (5, 6)):
 
512
            raise errors.UnsupportedFormatError(
 
513
                           'sorry, branch format %r not supported' % fmt,
 
514
                           ['use a different bzr version',
 
515
                            'or remove the .bzr directory'
 
516
                            ' and "bzr init" again'])
353
517
 
354
518
    def get_root_id(self):
355
519
        """Return the id of this branches root"""
368
532
                entry.parent_id = inv.root.file_id
369
533
        self._write_inventory(inv)
370
534
 
 
535
    @needs_read_lock
371
536
    def read_working_inventory(self):
372
537
        """Read the working inventory."""
373
 
        self.lock_read()
374
 
        try:
375
 
            # ElementTree does its own conversion from UTF-8, so open in
376
 
            # binary.
377
 
            f = self.controlfile('inventory', 'rb')
378
 
            return bzrlib.xml5.serializer_v5.read_inventory(f)
379
 
        finally:
380
 
            self.unlock()
381
 
            
 
538
        # ElementTree does its own conversion from UTF-8, so open in
 
539
        # binary.
 
540
        f = self.controlfile('inventory', 'rb')
 
541
        return bzrlib.xml5.serializer_v5.read_inventory(f)
382
542
 
 
543
    @needs_write_lock
383
544
    def _write_inventory(self, inv):
384
545
        """Update the working inventory.
385
546
 
386
547
        That is to say, the inventory describing changes underway, that
387
548
        will be committed to the next revision.
388
549
        """
389
 
        from bzrlib.atomicfile import AtomicFile
390
 
        
391
 
        self.lock_write()
392
 
        try:
393
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
394
 
            try:
395
 
                bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
 
                f.commit()
397
 
            finally:
398
 
                f.close()
399
 
        finally:
400
 
            self.unlock()
 
550
        from cStringIO import StringIO
 
551
        sio = StringIO()
 
552
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
553
        sio.seek(0)
 
554
        # Transport handles atomicity
 
555
        self.put_controlfile('inventory', sio)
401
556
        
402
557
        mutter('wrote working inventory')
403
558
            
404
 
 
405
559
    inventory = property(read_working_inventory, _write_inventory, None,
406
560
                         """Inventory for the working copy.""")
407
561
 
408
 
 
 
562
    @needs_write_lock
409
563
    def add(self, files, ids=None):
410
564
        """Make files versioned.
411
565
 
441
595
        else:
442
596
            assert(len(ids) == len(files))
443
597
 
444
 
        self.lock_write()
445
 
        try:
446
 
            inv = self.read_working_inventory()
447
 
            for f,file_id in zip(files, ids):
448
 
                if is_control_file(f):
449
 
                    raise BzrError("cannot add control file %s" % quotefn(f))
450
 
 
451
 
                fp = splitpath(f)
452
 
 
453
 
                if len(fp) == 0:
454
 
                    raise BzrError("cannot add top-level %r" % f)
455
 
 
456
 
                fullpath = os.path.normpath(self.abspath(f))
457
 
 
458
 
                try:
459
 
                    kind = file_kind(fullpath)
460
 
                except OSError:
461
 
                    # maybe something better?
462
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
463
 
 
464
 
                if kind != 'file' and kind != 'directory':
465
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
 
 
467
 
                if file_id is None:
468
 
                    file_id = gen_file_id(f)
469
 
                inv.add_path(f, kind=kind, file_id=file_id)
470
 
 
471
 
                mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
472
 
 
473
 
            self._write_inventory(inv)
474
 
        finally:
475
 
            self.unlock()
476
 
            
477
 
 
 
598
        inv = self.read_working_inventory()
 
599
        for f,file_id in zip(files, ids):
 
600
            if is_control_file(f):
 
601
                raise BzrError("cannot add control file %s" % quotefn(f))
 
602
 
 
603
            fp = splitpath(f)
 
604
 
 
605
            if len(fp) == 0:
 
606
                raise BzrError("cannot add top-level %r" % f)
 
607
 
 
608
            fullpath = os.path.normpath(self.abspath(f))
 
609
 
 
610
            try:
 
611
                kind = file_kind(fullpath)
 
612
            except OSError:
 
613
                # maybe something better?
 
614
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
 
615
 
 
616
            if not InventoryEntry.versionable_kind(kind):
 
617
                raise BzrError('cannot add: not a versionable file ('
 
618
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
 
619
 
 
620
            if file_id is None:
 
621
                file_id = gen_file_id(f)
 
622
            inv.add_path(f, kind=kind, file_id=file_id)
 
623
 
 
624
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
625
 
 
626
        self._write_inventory(inv)
 
627
 
 
628
    @needs_read_lock
478
629
    def print_file(self, file, revno):
479
630
        """Print `file` to stdout."""
480
 
        self.lock_read()
481
 
        try:
482
 
            tree = self.revision_tree(self.lookup_revision(revno))
483
 
            # use inventory as it was in that revision
484
 
            file_id = tree.inventory.path2id(file)
485
 
            if not file_id:
486
 
                raise BzrError("%r is not present in revision %s" % (file, revno))
487
 
            tree.print_file(file_id)
488
 
        finally:
489
 
            self.unlock()
490
 
 
491
 
 
492
 
    def remove(self, files, verbose=False):
493
 
        """Mark nominated files for removal from the inventory.
494
 
 
495
 
        This does not remove their text.  This does not run on 
496
 
 
497
 
        TODO: Refuse to remove modified files unless --force is given?
498
 
 
499
 
        TODO: Do something useful with directories.
500
 
 
501
 
        TODO: Should this remove the text or not?  Tough call; not
502
 
        removing may be useful and the user can just use use rm, and
503
 
        is the opposite of add.  Removing it is consistent with most
504
 
        other tools.  Maybe an option.
505
 
        """
506
 
        ## TODO: Normalize names
507
 
        ## TODO: Remove nested loops; better scalability
508
 
        if isinstance(files, basestring):
509
 
            files = [files]
510
 
 
511
 
        self.lock_write()
512
 
 
513
 
        try:
514
 
            tree = self.working_tree()
515
 
            inv = tree.inventory
516
 
 
517
 
            # do this before any modifications
518
 
            for f in files:
519
 
                fid = inv.path2id(f)
520
 
                if not fid:
521
 
                    raise BzrError("cannot remove unversioned file %s" % quotefn(f))
522
 
                mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
523
 
                if verbose:
524
 
                    # having remove it, it must be either ignored or unknown
525
 
                    if tree.is_ignored(f):
526
 
                        new_status = 'I'
527
 
                    else:
528
 
                        new_status = '?'
529
 
                    show_status(new_status, inv[fid].kind, quotefn(f))
530
 
                del inv[fid]
531
 
 
532
 
            self._write_inventory(inv)
533
 
        finally:
534
 
            self.unlock()
535
 
 
 
631
        tree = self.revision_tree(self.get_rev_id(revno))
 
632
        # use inventory as it was in that revision
 
633
        file_id = tree.inventory.path2id(file)
 
634
        if not file_id:
 
635
            raise BzrError("%r is not present in revision %s" % (file, revno))
 
636
        tree.print_file(file_id)
536
637
 
537
638
    # FIXME: this doesn't need to be a branch method
538
639
    def set_inventory(self, new_inventory_list):
542
643
            name = os.path.basename(path)
543
644
            if name == "":
544
645
                continue
545
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
646
            # fixme, there should be a factory function inv,add_?? 
 
647
            if kind == 'directory':
 
648
                inv.add(inventory.InventoryDirectory(file_id, name, parent))
 
649
            elif kind == 'file':
 
650
                inv.add(inventory.InventoryFile(file_id, name, parent))
 
651
            elif kind == 'symlink':
 
652
                inv.add(inventory.InventoryLink(file_id, name, parent))
 
653
            else:
 
654
                raise BzrError("unknown kind %r" % kind)
546
655
        self._write_inventory(inv)
547
656
 
548
 
 
549
657
    def unknowns(self):
550
658
        """Return all unknown files.
551
659
 
552
660
        These are files in the working directory that are not versioned or
553
661
        control files or ignored.
554
662
        
 
663
        >>> from bzrlib.workingtree import WorkingTree
555
664
        >>> b = ScratchBranch(files=['foo', 'foo~'])
556
 
        >>> list(b.unknowns())
 
665
        >>> map(str, b.unknowns())
557
666
        ['foo']
558
667
        >>> b.add('foo')
559
668
        >>> list(b.unknowns())
560
669
        []
561
 
        >>> b.remove('foo')
 
670
        >>> WorkingTree(b.base, b).remove('foo')
562
671
        >>> list(b.unknowns())
563
 
        ['foo']
 
672
        [u'foo']
564
673
        """
565
674
        return self.working_tree().unknowns()
566
675
 
567
 
 
 
676
    @needs_write_lock
568
677
    def append_revision(self, *revision_ids):
569
 
        from bzrlib.atomicfile import AtomicFile
570
 
 
571
678
        for revision_id in revision_ids:
572
679
            mutter("add {%s} to revision-history" % revision_id)
573
 
 
574
680
        rev_history = self.revision_history()
575
681
        rev_history.extend(revision_ids)
576
 
 
577
 
        f = AtomicFile(self.controlfilename('revision-history'))
578
 
        try:
579
 
            for rev_id in rev_history:
580
 
                print >>f, rev_id
581
 
            f.commit()
582
 
        finally:
583
 
            f.close()
584
 
 
585
 
 
 
682
        self.set_revision_history(rev_history)
 
683
 
 
684
    @needs_write_lock
 
685
    def set_revision_history(self, rev_history):
 
686
        self.put_controlfile('revision-history', '\n'.join(rev_history))
 
687
 
 
688
    def has_revision(self, revision_id):
 
689
        """True if this branch has a copy of the revision.
 
690
 
 
691
        This does not necessarily imply the revision is merge
 
692
        or on the mainline."""
 
693
        return (revision_id is None
 
694
                or self.revision_store.has_id(revision_id))
 
695
 
 
696
    @needs_read_lock
586
697
    def get_revision_xml_file(self, revision_id):
587
698
        """Return XML file object for revision object."""
588
699
        if not revision_id or not isinstance(revision_id, basestring):
589
700
            raise InvalidRevisionId(revision_id)
590
 
 
591
 
        self.lock_read()
592
701
        try:
593
 
            try:
594
 
                return self.revision_store[revision_id]
595
 
            except IndexError:
596
 
                raise bzrlib.errors.NoSuchRevision(self, revision_id)
597
 
        finally:
598
 
            self.unlock()
599
 
 
 
702
            return self.revision_store.get(revision_id)
 
703
        except (IndexError, KeyError):
 
704
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
600
705
 
601
706
    #deprecated
602
707
    get_revision_xml = get_revision_xml_file
603
708
 
 
709
    def get_revision_xml(self, revision_id):
 
710
        return self.get_revision_xml_file(revision_id).read()
 
711
 
604
712
 
605
713
    def get_revision(self, revision_id):
606
714
        """Return the Revision object for a named revision"""
616
724
        assert r.revision_id == revision_id
617
725
        return r
618
726
 
619
 
 
620
727
    def get_revision_delta(self, revno):
621
728
        """Return the delta for one revision.
622
729
 
638
745
 
639
746
        return compare_trees(old_tree, new_tree)
640
747
 
641
 
        
642
 
 
643
748
    def get_revision_sha1(self, revision_id):
644
749
        """Hash the stored value of a revision, and return it."""
645
750
        # In the future, revision entries will be signed. At that
648
753
        # the revision, (add signatures/remove signatures) and still
649
754
        # have all hash pointers stay consistent.
650
755
        # But for now, just hash the contents.
651
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
652
 
 
 
756
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
653
757
 
654
758
    def get_ancestry(self, revision_id):
655
759
        """Return a list of revision-ids integrated by a revision.
 
760
        
 
761
        This currently returns a list, but the ordering is not guaranteed:
 
762
        treat it as a set.
656
763
        """
657
 
        w = self.weave_store.get_weave(ANCESTRY_FILEID)
658
 
        # strip newlines
659
 
        return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
660
 
 
 
764
        if revision_id is None:
 
765
            return [None]
 
766
        w = self.get_inventory_weave()
 
767
        return [None] + map(w.idx_to_name,
 
768
                            w.inclusions([w.lookup(revision_id)]))
661
769
 
662
770
    def get_inventory_weave(self):
663
 
        return self.weave_store.get_weave(INVENTORY_FILEID)
664
 
 
 
771
        return self.control_weaves.get_weave('inventory',
 
772
                                             self.get_transaction())
665
773
 
666
774
    def get_inventory(self, revision_id):
667
775
        """Get Inventory object by hash."""
668
 
        # FIXME: The text gets passed around a lot coming from the weave.
669
 
        f = StringIO(self.get_inventory_xml(revision_id))
670
 
        return bzrlib.xml5.serializer_v5.read_inventory(f)
671
 
 
 
776
        xml = self.get_inventory_xml(revision_id)
 
777
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
672
778
 
673
779
    def get_inventory_xml(self, revision_id):
674
780
        """Get inventory XML as a file object."""
679
785
        except IndexError:
680
786
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
681
787
 
682
 
 
683
788
    def get_inventory_sha1(self, revision_id):
684
789
        """Return the sha1 hash of the inventory entry
685
790
        """
686
791
        return self.get_revision(revision_id).inventory_sha1
687
792
 
688
 
 
689
793
    def get_revision_inventory(self, revision_id):
690
794
        """Return inventory of a past revision."""
 
795
        # TODO: Unify this with get_inventory()
691
796
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
692
797
        # must be the same as its revision, so this is trivial.
693
798
        if revision_id == None:
695
800
        else:
696
801
            return self.get_inventory(revision_id)
697
802
 
698
 
 
 
803
    @needs_read_lock
699
804
    def revision_history(self):
700
 
        """Return sequence of revision hashes on to this branch.
701
 
 
702
 
        >>> ScratchBranch().revision_history()
703
 
        []
704
 
        """
705
 
        self.lock_read()
706
 
        try:
707
 
            return [l.rstrip('\r\n') for l in
708
 
                    self.controlfile('revision-history', 'r').readlines()]
709
 
        finally:
710
 
            self.unlock()
711
 
 
712
 
 
713
 
    def common_ancestor(self, other, self_revno=None, other_revno=None):
714
 
        """
715
 
        >>> import commit
716
 
        >>> sb = ScratchBranch(files=['foo', 'foo~'])
717
 
        >>> sb.common_ancestor(sb) == (None, None)
718
 
        True
719
 
        >>> commit.commit(sb, "Committing first revision")
720
 
        >>> sb.common_ancestor(sb)[0]
721
 
        1
722
 
        >>> clone = sb.clone()
723
 
        >>> commit.commit(sb, "Committing second revision")
724
 
        >>> sb.common_ancestor(sb)[0]
725
 
        2
726
 
        >>> sb.common_ancestor(clone)[0]
727
 
        1
728
 
        >>> commit.commit(clone, "Committing divergent second revision")
729
 
        >>> sb.common_ancestor(clone)[0]
730
 
        1
731
 
        >>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
732
 
        True
733
 
        >>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
734
 
        True
735
 
        >>> clone2 = sb.clone()
736
 
        >>> sb.common_ancestor(clone2)[0]
737
 
        2
738
 
        >>> sb.common_ancestor(clone2, self_revno=1)[0]
739
 
        1
740
 
        >>> sb.common_ancestor(clone2, other_revno=1)[0]
741
 
        1
742
 
        """
743
 
        my_history = self.revision_history()
744
 
        other_history = other.revision_history()
745
 
        if self_revno is None:
746
 
            self_revno = len(my_history)
747
 
        if other_revno is None:
748
 
            other_revno = len(other_history)
749
 
        indices = range(min((self_revno, other_revno)))
750
 
        indices.reverse()
751
 
        for r in indices:
752
 
            if my_history[r] == other_history[r]:
753
 
                return r+1, my_history[r]
754
 
        return None, None
755
 
 
 
805
        """Return sequence of revision hashes on to this branch."""
 
806
        transaction = self.get_transaction()
 
807
        history = transaction.map.find_revision_history()
 
808
        if history is not None:
 
809
            mutter("cache hit for revision-history in %s", self)
 
810
            return list(history)
 
811
        history = [l.rstrip('\r\n') for l in
 
812
                self.controlfile('revision-history', 'r').readlines()]
 
813
        transaction.map.add_revision_history(history)
 
814
        # this call is disabled because revision_history is 
 
815
        # not really an object yet, and the transaction is for objects.
 
816
        # transaction.register_clean(history, precious=True)
 
817
        return list(history)
756
818
 
757
819
    def revno(self):
758
820
        """Return current revision number for this branch.
762
824
        """
763
825
        return len(self.revision_history())
764
826
 
765
 
 
766
 
    def last_patch(self):
 
827
    def last_revision(self):
767
828
        """Return last patch hash, or None if no history.
768
829
        """
769
830
        ph = self.revision_history()
772
833
        else:
773
834
            return None
774
835
 
775
 
 
776
836
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
777
 
        """
 
837
        """Return a list of new revisions that would perfectly fit.
 
838
        
778
839
        If self and other have not diverged, return a list of the revisions
779
840
        present in other, but missing from self.
780
841
 
811
872
 
812
873
        if stop_revision is None:
813
874
            stop_revision = other_len
814
 
        elif stop_revision > other_len:
815
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
816
 
        
 
875
        else:
 
876
            assert isinstance(stop_revision, int)
 
877
            if stop_revision > other_len:
 
878
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
817
879
        return other_history[self_len:stop_revision]
818
880
 
819
 
 
820
881
    def update_revisions(self, other, stop_revision=None):
821
 
        """Pull in all new revisions from other branch.
822
 
        """
 
882
        """Pull in new perfect-fit revisions."""
823
883
        from bzrlib.fetch import greedy_fetch
824
 
 
825
 
        pb = bzrlib.ui.ui_factory.progress_bar()
826
 
        pb.update('comparing histories')
827
 
 
828
 
        revision_ids = self.missing_revisions(other, stop_revision)
829
 
 
830
 
        if len(revision_ids) > 0:
831
 
            count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
832
 
        else:
833
 
            count = 0
834
 
        self.append_revision(*revision_ids)
835
 
        ## note("Added %d revisions." % count)
836
 
        pb.clear()
837
 
 
838
 
 
 
884
        if stop_revision is None:
 
885
            stop_revision = other.last_revision()
 
886
        ### Should this be checking is_ancestor instead of revision_history?
 
887
        if (stop_revision is not None and 
 
888
            stop_revision in self.revision_history()):
 
889
            return
 
890
        greedy_fetch(to_branch=self, from_branch=other,
 
891
                     revision=stop_revision)
 
892
        pullable_revs = self.pullable_revisions(other, stop_revision)
 
893
        if len(pullable_revs) > 0:
 
894
            self.append_revision(*pullable_revs)
 
895
 
 
896
    def pullable_revisions(self, other, stop_revision):
 
897
        other_revno = other.revision_id_to_revno(stop_revision)
 
898
        try:
 
899
            return self.missing_revisions(other, other_revno)
 
900
        except DivergedBranches, e:
 
901
            try:
 
902
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
903
                                                          stop_revision, self)
 
904
                assert self.last_revision() not in pullable_revs
 
905
                return pullable_revs
 
906
            except bzrlib.errors.NotAncestor:
 
907
                if is_ancestor(self.last_revision(), stop_revision, self):
 
908
                    return []
 
909
                else:
 
910
                    raise e
 
911
        
839
912
    def commit(self, *args, **kw):
840
913
        from bzrlib.commit import Commit
841
914
        Commit().commit(self, *args, **kw)
842
 
        
843
 
 
844
 
    def lookup_revision(self, revision):
845
 
        """Return the revision identifier for a given revision information."""
846
 
        revno, info = self._get_revision_info(revision)
847
 
        return info
848
 
 
849
 
 
 
915
    
850
916
    def revision_id_to_revno(self, revision_id):
851
917
        """Given a revision id, return its revno"""
 
918
        if revision_id is None:
 
919
            return 0
852
920
        history = self.revision_history()
853
921
        try:
854
922
            return history.index(revision_id) + 1
855
923
        except ValueError:
856
924
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
857
925
 
858
 
 
859
 
    def get_revision_info(self, revision):
860
 
        """Return (revno, revision id) for revision identifier.
861
 
 
862
 
        revision can be an integer, in which case it is assumed to be revno (though
863
 
            this will translate negative values into positive ones)
864
 
        revision can also be a string, in which case it is parsed for something like
865
 
            'date:' or 'revid:' etc.
866
 
        """
867
 
        revno, rev_id = self._get_revision_info(revision)
868
 
        if revno is None:
869
 
            raise bzrlib.errors.NoSuchRevision(self, revision)
870
 
        return revno, rev_id
871
 
 
872
926
    def get_rev_id(self, revno, history=None):
873
927
        """Find the revision id of the specified revno."""
874
928
        if revno == 0:
879
933
            raise bzrlib.errors.NoSuchRevision(self, revno)
880
934
        return history[revno - 1]
881
935
 
882
 
    def _get_revision_info(self, revision):
883
 
        """Return (revno, revision id) for revision specifier.
884
 
 
885
 
        revision can be an integer, in which case it is assumed to be revno
886
 
        (though this will translate negative values into positive ones)
887
 
        revision can also be a string, in which case it is parsed for something
888
 
        like 'date:' or 'revid:' etc.
889
 
 
890
 
        A revid is always returned.  If it is None, the specifier referred to
891
 
        the null revision.  If the revid does not occur in the revision
892
 
        history, revno will be None.
893
 
        """
894
 
        
895
 
        if revision is None:
896
 
            return 0, None
897
 
        revno = None
898
 
        try:# Convert to int if possible
899
 
            revision = int(revision)
900
 
        except ValueError:
901
 
            pass
902
 
        revs = self.revision_history()
903
 
        if isinstance(revision, int):
904
 
            if revision < 0:
905
 
                revno = len(revs) + revision + 1
906
 
            else:
907
 
                revno = revision
908
 
            rev_id = self.get_rev_id(revno, revs)
909
 
        elif isinstance(revision, basestring):
910
 
            for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
 
                if revision.startswith(prefix):
912
 
                    result = func(self, revs, revision)
913
 
                    if len(result) > 1:
914
 
                        revno, rev_id = result
915
 
                    else:
916
 
                        revno = result[0]
917
 
                        rev_id = self.get_rev_id(revno, revs)
918
 
                    break
919
 
            else:
920
 
                raise BzrError('No namespace registered for string: %r' %
921
 
                               revision)
922
 
        else:
923
 
            raise TypeError('Unhandled revision type %s' % revision)
924
 
 
925
 
        if revno is None:
926
 
            if rev_id is None:
927
 
                raise bzrlib.errors.NoSuchRevision(self, revision)
928
 
        return revno, rev_id
929
 
 
930
 
    def _namespace_revno(self, revs, revision):
931
 
        """Lookup a revision by revision number"""
932
 
        assert revision.startswith('revno:')
933
 
        try:
934
 
            return (int(revision[6:]),)
935
 
        except ValueError:
936
 
            return None
937
 
    REVISION_NAMESPACES['revno:'] = _namespace_revno
938
 
 
939
 
    def _namespace_revid(self, revs, revision):
940
 
        assert revision.startswith('revid:')
941
 
        rev_id = revision[len('revid:'):]
942
 
        try:
943
 
            return revs.index(rev_id) + 1, rev_id
944
 
        except ValueError:
945
 
            return None, rev_id
946
 
    REVISION_NAMESPACES['revid:'] = _namespace_revid
947
 
 
948
 
    def _namespace_last(self, revs, revision):
949
 
        assert revision.startswith('last:')
950
 
        try:
951
 
            offset = int(revision[5:])
952
 
        except ValueError:
953
 
            return (None,)
954
 
        else:
955
 
            if offset <= 0:
956
 
                raise BzrError('You must supply a positive value for --revision last:XXX')
957
 
            return (len(revs) - offset + 1,)
958
 
    REVISION_NAMESPACES['last:'] = _namespace_last
959
 
 
960
 
    def _namespace_tag(self, revs, revision):
961
 
        assert revision.startswith('tag:')
962
 
        raise BzrError('tag: namespace registered, but not implemented.')
963
 
    REVISION_NAMESPACES['tag:'] = _namespace_tag
964
 
 
965
 
    def _namespace_date(self, revs, revision):
966
 
        assert revision.startswith('date:')
967
 
        import datetime
968
 
        # Spec for date revisions:
969
 
        #   date:value
970
 
        #   value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
 
        #   it can also start with a '+/-/='. '+' says match the first
972
 
        #   entry after the given date. '-' is match the first entry before the date
973
 
        #   '=' is match the first entry after, but still on the given date.
974
 
        #
975
 
        #   +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
 
        #   -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
 
        #   =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
 
        #       May 13th, 2005 at 0:00
979
 
        #
980
 
        #   So the proper way of saying 'give me all entries for today' is:
981
 
        #       -r {date:+today}:{date:-tomorrow}
982
 
        #   The default is '=' when not supplied
983
 
        val = revision[5:]
984
 
        match_style = '='
985
 
        if val[:1] in ('+', '-', '='):
986
 
            match_style = val[:1]
987
 
            val = val[1:]
988
 
 
989
 
        today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
 
        if val.lower() == 'yesterday':
991
 
            dt = today - datetime.timedelta(days=1)
992
 
        elif val.lower() == 'today':
993
 
            dt = today
994
 
        elif val.lower() == 'tomorrow':
995
 
            dt = today + datetime.timedelta(days=1)
996
 
        else:
997
 
            import re
998
 
            # This should be done outside the function to avoid recompiling it.
999
 
            _date_re = re.compile(
1000
 
                    r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1001
 
                    r'(,|T)?\s*'
1002
 
                    r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1003
 
                )
1004
 
            m = _date_re.match(val)
1005
 
            if not m or (not m.group('date') and not m.group('time')):
1006
 
                raise BzrError('Invalid revision date %r' % revision)
1007
 
 
1008
 
            if m.group('date'):
1009
 
                year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1010
 
            else:
1011
 
                year, month, day = today.year, today.month, today.day
1012
 
            if m.group('time'):
1013
 
                hour = int(m.group('hour'))
1014
 
                minute = int(m.group('minute'))
1015
 
                if m.group('second'):
1016
 
                    second = int(m.group('second'))
1017
 
                else:
1018
 
                    second = 0
1019
 
            else:
1020
 
                hour, minute, second = 0,0,0
1021
 
 
1022
 
            dt = datetime.datetime(year=year, month=month, day=day,
1023
 
                    hour=hour, minute=minute, second=second)
1024
 
        first = dt
1025
 
        last = None
1026
 
        reversed = False
1027
 
        if match_style == '-':
1028
 
            reversed = True
1029
 
        elif match_style == '=':
1030
 
            last = dt + datetime.timedelta(days=1)
1031
 
 
1032
 
        if reversed:
1033
 
            for i in range(len(revs)-1, -1, -1):
1034
 
                r = self.get_revision(revs[i])
1035
 
                # TODO: Handle timezone.
1036
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
 
                if first >= dt and (last is None or dt >= last):
1038
 
                    return (i+1,)
1039
 
        else:
1040
 
            for i in range(len(revs)):
1041
 
                r = self.get_revision(revs[i])
1042
 
                # TODO: Handle timezone.
1043
 
                dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
 
                if first <= dt and (last is None or dt <= last):
1045
 
                    return (i+1,)
1046
 
    REVISION_NAMESPACES['date:'] = _namespace_date
1047
 
 
1048
936
    def revision_tree(self, revision_id):
1049
937
        """Return Tree for a revision on this branch.
1050
938
 
1052
940
        an `EmptyTree` is returned."""
1053
941
        # TODO: refactor this to use an existing revision object
1054
942
        # so we don't need to read it in twice.
1055
 
        if revision_id == None:
 
943
        if revision_id == None or revision_id == NULL_REVISION:
1056
944
            return EmptyTree()
1057
945
        else:
1058
946
            inv = self.get_revision_inventory(revision_id)
1059
947
            return RevisionTree(self.weave_store, inv, revision_id)
1060
948
 
1061
 
 
1062
949
    def working_tree(self):
1063
950
        """Return a `Tree` for the working copy."""
1064
 
        from workingtree import WorkingTree
1065
 
        return WorkingTree(self.base, self.read_working_inventory())
 
951
        from bzrlib.workingtree import WorkingTree
 
952
        # TODO: In the future, perhaps WorkingTree should utilize Transport
 
953
        # RobertCollins 20051003 - I don't think it should - working trees are
 
954
        # much more complex to keep consistent than our careful .bzr subset.
 
955
        # instead, we should say that working trees are local only, and optimise
 
956
        # for that.
 
957
        return WorkingTree(self.base, branch=self)
1066
958
 
1067
959
 
1068
960
    def basis_tree(self):
1070
962
 
1071
963
        If there are no revisions yet, return an `EmptyTree`.
1072
964
        """
1073
 
        return self.revision_tree(self.last_patch())
1074
 
 
1075
 
 
 
965
        return self.revision_tree(self.last_revision())
 
966
 
 
967
    @needs_write_lock
1076
968
    def rename_one(self, from_rel, to_rel):
1077
969
        """Rename one file.
1078
970
 
1079
971
        This can change the directory or the filename or both.
1080
972
        """
1081
 
        self.lock_write()
 
973
        tree = self.working_tree()
 
974
        inv = tree.inventory
 
975
        if not tree.has_filename(from_rel):
 
976
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
977
        if tree.has_filename(to_rel):
 
978
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
979
 
 
980
        file_id = inv.path2id(from_rel)
 
981
        if file_id == None:
 
982
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
983
 
 
984
        if inv.path2id(to_rel):
 
985
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
986
 
 
987
        to_dir, to_tail = os.path.split(to_rel)
 
988
        to_dir_id = inv.path2id(to_dir)
 
989
        if to_dir_id == None and to_dir != '':
 
990
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
991
 
 
992
        mutter("rename_one:")
 
993
        mutter("  file_id    {%s}" % file_id)
 
994
        mutter("  from_rel   %r" % from_rel)
 
995
        mutter("  to_rel     %r" % to_rel)
 
996
        mutter("  to_dir     %r" % to_dir)
 
997
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
998
 
 
999
        inv.rename(file_id, to_dir_id, to_tail)
 
1000
 
 
1001
        from_abs = self.abspath(from_rel)
 
1002
        to_abs = self.abspath(to_rel)
1082
1003
        try:
1083
 
            tree = self.working_tree()
1084
 
            inv = tree.inventory
1085
 
            if not tree.has_filename(from_rel):
1086
 
                raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1087
 
            if tree.has_filename(to_rel):
1088
 
                raise BzrError("can't rename: new working file %r already exists" % to_rel)
1089
 
 
1090
 
            file_id = inv.path2id(from_rel)
1091
 
            if file_id == None:
1092
 
                raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1093
 
 
1094
 
            if inv.path2id(to_rel):
1095
 
                raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1096
 
 
1097
 
            to_dir, to_tail = os.path.split(to_rel)
1098
 
            to_dir_id = inv.path2id(to_dir)
1099
 
            if to_dir_id == None and to_dir != '':
1100
 
                raise BzrError("can't determine destination directory id for %r" % to_dir)
1101
 
 
1102
 
            mutter("rename_one:")
1103
 
            mutter("  file_id    {%s}" % file_id)
1104
 
            mutter("  from_rel   %r" % from_rel)
1105
 
            mutter("  to_rel     %r" % to_rel)
1106
 
            mutter("  to_dir     %r" % to_dir)
1107
 
            mutter("  to_dir_id  {%s}" % to_dir_id)
1108
 
 
1109
 
            inv.rename(file_id, to_dir_id, to_tail)
1110
 
 
1111
 
            from_abs = self.abspath(from_rel)
1112
 
            to_abs = self.abspath(to_rel)
1113
 
            try:
1114
 
                os.rename(from_abs, to_abs)
1115
 
            except OSError, e:
1116
 
                raise BzrError("failed to rename %r to %r: %s"
1117
 
                        % (from_abs, to_abs, e[1]),
1118
 
                        ["rename rolled back"])
1119
 
 
1120
 
            self._write_inventory(inv)
1121
 
        finally:
1122
 
            self.unlock()
1123
 
 
1124
 
 
 
1004
            rename(from_abs, to_abs)
 
1005
        except OSError, e:
 
1006
            raise BzrError("failed to rename %r to %r: %s"
 
1007
                    % (from_abs, to_abs, e[1]),
 
1008
                    ["rename rolled back"])
 
1009
 
 
1010
        self._write_inventory(inv)
 
1011
 
 
1012
    @needs_write_lock
1125
1013
    def move(self, from_paths, to_name):
1126
1014
        """Rename files.
1127
1015
 
1137
1025
        entry that is moved.
1138
1026
        """
1139
1027
        result = []
1140
 
        self.lock_write()
1141
 
        try:
1142
 
            ## TODO: Option to move IDs only
1143
 
            assert not isinstance(from_paths, basestring)
1144
 
            tree = self.working_tree()
1145
 
            inv = tree.inventory
1146
 
            to_abs = self.abspath(to_name)
1147
 
            if not isdir(to_abs):
1148
 
                raise BzrError("destination %r is not a directory" % to_abs)
1149
 
            if not tree.has_filename(to_name):
1150
 
                raise BzrError("destination %r not in working directory" % to_abs)
1151
 
            to_dir_id = inv.path2id(to_name)
1152
 
            if to_dir_id == None and to_name != '':
1153
 
                raise BzrError("destination %r is not a versioned directory" % to_name)
1154
 
            to_dir_ie = inv[to_dir_id]
1155
 
            if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
 
                raise BzrError("destination %r is not a directory" % to_abs)
1157
 
 
1158
 
            to_idpath = inv.get_idpath(to_dir_id)
1159
 
 
1160
 
            for f in from_paths:
1161
 
                if not tree.has_filename(f):
1162
 
                    raise BzrError("%r does not exist in working tree" % f)
1163
 
                f_id = inv.path2id(f)
1164
 
                if f_id == None:
1165
 
                    raise BzrError("%r is not versioned" % f)
1166
 
                name_tail = splitpath(f)[-1]
1167
 
                dest_path = appendpath(to_name, name_tail)
1168
 
                if tree.has_filename(dest_path):
1169
 
                    raise BzrError("destination %r already exists" % dest_path)
1170
 
                if f_id in to_idpath:
1171
 
                    raise BzrError("can't move %r to a subdirectory of itself" % f)
1172
 
 
1173
 
            # OK, so there's a race here, it's possible that someone will
1174
 
            # create a file in this interval and then the rename might be
1175
 
            # left half-done.  But we should have caught most problems.
1176
 
 
1177
 
            for f in from_paths:
1178
 
                name_tail = splitpath(f)[-1]
1179
 
                dest_path = appendpath(to_name, name_tail)
1180
 
                result.append((f, dest_path))
1181
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1182
 
                try:
1183
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
1184
 
                except OSError, e:
1185
 
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
 
                            ["rename rolled back"])
1187
 
 
1188
 
            self._write_inventory(inv)
1189
 
        finally:
1190
 
            self.unlock()
1191
 
 
 
1028
        ## TODO: Option to move IDs only
 
1029
        assert not isinstance(from_paths, basestring)
 
1030
        tree = self.working_tree()
 
1031
        inv = tree.inventory
 
1032
        to_abs = self.abspath(to_name)
 
1033
        if not isdir(to_abs):
 
1034
            raise BzrError("destination %r is not a directory" % to_abs)
 
1035
        if not tree.has_filename(to_name):
 
1036
            raise BzrError("destination %r not in working directory" % to_abs)
 
1037
        to_dir_id = inv.path2id(to_name)
 
1038
        if to_dir_id == None and to_name != '':
 
1039
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1040
        to_dir_ie = inv[to_dir_id]
 
1041
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1042
            raise BzrError("destination %r is not a directory" % to_abs)
 
1043
 
 
1044
        to_idpath = inv.get_idpath(to_dir_id)
 
1045
 
 
1046
        for f in from_paths:
 
1047
            if not tree.has_filename(f):
 
1048
                raise BzrError("%r does not exist in working tree" % f)
 
1049
            f_id = inv.path2id(f)
 
1050
            if f_id == None:
 
1051
                raise BzrError("%r is not versioned" % f)
 
1052
            name_tail = splitpath(f)[-1]
 
1053
            dest_path = appendpath(to_name, name_tail)
 
1054
            if tree.has_filename(dest_path):
 
1055
                raise BzrError("destination %r already exists" % dest_path)
 
1056
            if f_id in to_idpath:
 
1057
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1058
 
 
1059
        # OK, so there's a race here, it's possible that someone will
 
1060
        # create a file in this interval and then the rename might be
 
1061
        # left half-done.  But we should have caught most problems.
 
1062
 
 
1063
        for f in from_paths:
 
1064
            name_tail = splitpath(f)[-1]
 
1065
            dest_path = appendpath(to_name, name_tail)
 
1066
            result.append((f, dest_path))
 
1067
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1068
            try:
 
1069
                rename(self.abspath(f), self.abspath(dest_path))
 
1070
            except OSError, e:
 
1071
                raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1072
                        ["rename rolled back"])
 
1073
 
 
1074
        self._write_inventory(inv)
1192
1075
        return result
1193
1076
 
1194
1077
 
1199
1082
            If true (default) backups are made of files before
1200
1083
            they're renamed.
1201
1084
        """
1202
 
        from bzrlib.errors import NotVersionedError, BzrError
1203
1085
        from bzrlib.atomicfile import AtomicFile
1204
1086
        from bzrlib.osutils import backup_file
1205
1087
        
1212
1094
        for fn in filenames:
1213
1095
            file_id = inv.path2id(fn)
1214
1096
            if not file_id:
1215
 
                raise NotVersionedError("not a versioned file", fn)
 
1097
                raise NotVersionedError(path=fn)
1216
1098
            if not old_inv.has_id(file_id):
1217
1099
                raise BzrError("file not present in old tree", fn, file_id)
1218
1100
            nids.append((fn, file_id))
1242
1124
        These are revisions that have been merged into the working
1243
1125
        directory but not yet committed.
1244
1126
        """
1245
 
        cfn = self.controlfilename('pending-merges')
1246
 
        if not os.path.exists(cfn):
 
1127
        cfn = self._rel_controlfilename('pending-merges')
 
1128
        if not self._transport.has(cfn):
1247
1129
            return []
1248
1130
        p = []
1249
1131
        for l in self.controlfile('pending-merges', 'r').readlines():
1251
1133
        return p
1252
1134
 
1253
1135
 
1254
 
    def add_pending_merge(self, revision_id):
1255
 
        from bzrlib.revision import validate_revision_id
1256
 
 
1257
 
        validate_revision_id(revision_id)
1258
 
 
 
1136
    def add_pending_merge(self, *revision_ids):
 
1137
        # TODO: Perhaps should check at this point that the
 
1138
        # history of the revision is actually present?
1259
1139
        p = self.pending_merges()
1260
 
        if revision_id in p:
1261
 
            return
1262
 
        p.append(revision_id)
1263
 
        self.set_pending_merges(p)
1264
 
 
1265
 
 
 
1140
        updated = False
 
1141
        for rev_id in revision_ids:
 
1142
            if rev_id in p:
 
1143
                continue
 
1144
            p.append(rev_id)
 
1145
            updated = True
 
1146
        if updated:
 
1147
            self.set_pending_merges(p)
 
1148
 
 
1149
    @needs_write_lock
1266
1150
    def set_pending_merges(self, rev_list):
1267
 
        from bzrlib.atomicfile import AtomicFile
1268
 
        self.lock_write()
1269
 
        try:
1270
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1271
 
            try:
1272
 
                for l in rev_list:
1273
 
                    print >>f, l
1274
 
                f.commit()
1275
 
            finally:
1276
 
                f.close()
1277
 
        finally:
1278
 
            self.unlock()
1279
 
 
 
1151
        self.put_controlfile('pending-merges', '\n'.join(rev_list))
1280
1152
 
1281
1153
    def get_parent(self):
1282
1154
        """Return the parent location of the branch.
1295
1167
                    raise
1296
1168
        return None
1297
1169
 
1298
 
 
 
1170
    @needs_write_lock
1299
1171
    def set_parent(self, url):
1300
1172
        # TODO: Maybe delete old location files?
1301
1173
        from bzrlib.atomicfile import AtomicFile
1302
 
        self.lock_write()
 
1174
        f = AtomicFile(self.controlfilename('parent'))
1303
1175
        try:
1304
 
            f = AtomicFile(self.controlfilename('parent'))
1305
 
            try:
1306
 
                f.write(url + '\n')
1307
 
                f.commit()
1308
 
            finally:
1309
 
                f.close()
 
1176
            f.write(url + '\n')
 
1177
            f.commit()
1310
1178
        finally:
1311
 
            self.unlock()
 
1179
            f.close()
1312
1180
 
1313
1181
    def check_revno(self, revno):
1314
1182
        """\
1326
1194
        if revno < 1 or revno > self.revno():
1327
1195
            raise InvalidRevisionNumber(revno)
1328
1196
        
1329
 
        
1330
 
 
1331
 
 
1332
 
class ScratchBranch(Branch):
 
1197
    def sign_revision(self, revision_id, gpg_strategy):
 
1198
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
1199
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1200
 
 
1201
    @needs_write_lock
 
1202
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
1203
        self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)), 
 
1204
                                revision_id, "sig")
 
1205
 
 
1206
 
 
1207
class ScratchBranch(_Branch):
1333
1208
    """Special test class: a branch that cleans up after itself.
1334
1209
 
1335
1210
    >>> b = ScratchBranch()
1336
1211
    >>> isdir(b.base)
1337
1212
    True
1338
1213
    >>> bd = b.base
1339
 
    >>> b.destroy()
 
1214
    >>> b._transport.__del__()
1340
1215
    >>> isdir(bd)
1341
1216
    False
1342
1217
    """
1343
 
    def __init__(self, files=[], dirs=[], base=None):
 
1218
 
 
1219
    def __init__(self, files=[], dirs=[], transport=None):
1344
1220
        """Make a test branch.
1345
1221
 
1346
1222
        This creates a temporary directory and runs init-tree in it.
1347
1223
 
1348
1224
        If any files are listed, they are created in the working copy.
1349
1225
        """
1350
 
        from tempfile import mkdtemp
1351
 
        init = False
1352
 
        if base is None:
1353
 
            base = mkdtemp()
1354
 
            init = True
1355
 
        Branch.__init__(self, base, init=init)
 
1226
        if transport is None:
 
1227
            transport = bzrlib.transport.local.ScratchTransport()
 
1228
            super(ScratchBranch, self).__init__(transport, init=True)
 
1229
        else:
 
1230
            super(ScratchBranch, self).__init__(transport)
 
1231
 
1356
1232
        for d in dirs:
1357
 
            os.mkdir(self.abspath(d))
 
1233
            self._transport.mkdir(d)
1358
1234
            
1359
1235
        for f in files:
1360
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1236
            self._transport.put(f, 'content of %s' % f)
1361
1237
 
1362
1238
 
1363
1239
    def clone(self):
1364
1240
        """
1365
1241
        >>> orig = ScratchBranch(files=["file1", "file2"])
1366
1242
        >>> clone = orig.clone()
1367
 
        >>> os.path.samefile(orig.base, clone.base)
 
1243
        >>> if os.name != 'nt':
 
1244
        ...   os.path.samefile(orig.base, clone.base)
 
1245
        ... else:
 
1246
        ...   orig.base == clone.base
 
1247
        ...
1368
1248
        False
1369
1249
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1370
1250
        True
1374
1254
        base = mkdtemp()
1375
1255
        os.rmdir(base)
1376
1256
        copytree(self.base, base, symlinks=True)
1377
 
        return ScratchBranch(base=base)
1378
 
 
1379
 
 
1380
 
        
1381
 
    def __del__(self):
1382
 
        self.destroy()
1383
 
 
1384
 
    def destroy(self):
1385
 
        """Destroy the test branch, removing the scratch directory."""
1386
 
        from shutil import rmtree
1387
 
        try:
1388
 
            if self.base:
1389
 
                mutter("delete ScratchBranch %s" % self.base)
1390
 
                rmtree(self.base)
1391
 
        except OSError, e:
1392
 
            # Work around for shutil.rmtree failing on Windows when
1393
 
            # readonly files are encountered
1394
 
            mutter("hit exception in destroying ScratchBranch: %s" % e)
1395
 
            for root, dirs, files in os.walk(self.base, topdown=False):
1396
 
                for name in files:
1397
 
                    os.chmod(os.path.join(root, name), 0700)
1398
 
            rmtree(self.base)
1399
 
        self.base = None
1400
 
 
 
1257
        return ScratchBranch(
 
1258
            transport=bzrlib.transport.local.ScratchTransport(base))
1401
1259
    
1402
1260
 
1403
1261
######################################################################
1453
1311
    return gen_file_id('TREE_ROOT')
1454
1312
 
1455
1313
 
1456
 
def pull_loc(branch):
1457
 
    # TODO: Should perhaps just make attribute be 'base' in
1458
 
    # RemoteBranch and Branch?
1459
 
    if hasattr(branch, "baseurl"):
1460
 
        return branch.baseurl
1461
 
    else:
1462
 
        return branch.base
1463
 
 
1464
 
 
1465
 
def copy_branch(branch_from, to_location, revision=None):
1466
 
    """Copy branch_from into the existing directory to_location.
1467
 
 
1468
 
    revision
1469
 
        If not None, only revisions up to this point will be copied.
1470
 
        The head of the new branch will be that revision.
1471
 
 
1472
 
    to_location
1473
 
        The name of a local directory that exists but is empty.
1474
 
    """
1475
 
    from bzrlib.merge import merge
1476
 
    from bzrlib.branch import Branch
1477
 
 
1478
 
    assert isinstance(branch_from, Branch)
1479
 
    assert isinstance(to_location, basestring)
1480
 
    
1481
 
    br_to = Branch(to_location, init=True)
1482
 
    br_to.set_root_id(branch_from.get_root_id())
1483
 
    if revision is None:
1484
 
        revno = branch_from.revno()
1485
 
    else:
1486
 
        revno, rev_id = branch_from.get_revision_info(revision)
1487
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1488
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
 
          check_clean=False, ignore_zero=True)
1490
 
    
1491
 
    from_location = pull_loc(branch_from)
1492
 
    br_to.set_parent(pull_loc(branch_from))
1493