← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

- rules for using destructors

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
from sets import Set
 
18
import sys
 
19
import os
 
20
import errno
 
21
from warnings import warn
 
22
from cStringIO import StringIO
19
23
 
20
 
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
21
 
import traceback, socket, fnmatch, difflib, time
22
 
from binascii import hexlify
23
24
 
24
25
import bzrlib
25
 
from inventory import Inventory
26
 
from trace import mutter, note
27
 
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
28
 
from inventory import InventoryEntry, Inventory
29
 
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
30
 
     format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
31
 
     joinpath, sha_string, file_kind, local_time_offset
32
 
from store import ImmutableStore
33
 
from revision import Revision
34
 
from errors import bailout
35
 
from textui import show_status
36
 
from diff import diff_trees
37
 
 
38
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
26
from bzrlib.inventory import InventoryEntry
 
27
import bzrlib.inventory as inventory
 
28
from bzrlib.trace import mutter, note
 
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
 
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError, UnlistableStore,
 
36
                           UnlistableBranch, NoSuchFile, NotVersionedError)
 
37
from bzrlib.textui import show_status
 
38
from bzrlib.revision import Revision, is_ancestor, get_intervening_revisions
 
39
 
 
40
from bzrlib.delta import compare_trees
 
41
from bzrlib.tree import EmptyTree, RevisionTree
 
42
from bzrlib.inventory import Inventory
 
43
from bzrlib.store import copy_all
 
44
from bzrlib.store.compressed_text import CompressedTextStore
 
45
from bzrlib.store.text import TextStore
 
46
from bzrlib.store.weave import WeaveStore
 
47
from bzrlib.testament import Testament
 
48
import bzrlib.transactions as transactions
 
49
from bzrlib.transport import Transport, get_transport
 
50
import bzrlib.xml5
 
51
import bzrlib.ui
 
52
 
 
53
 
 
54
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
55
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
56
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
39
57
## TODO: Maybe include checks for common corruption of newlines, etc?
40
58
 
41
59
 
42
 
 
43
 
def find_branch_root(f=None):
44
 
    """Find the branch root enclosing f, or pwd.
45
 
 
46
 
    It is not necessary that f exists.
47
 
 
48
 
    Basically we keep looking up until we find the control directory or
49
 
    run into the root."""
50
 
    if f is None:
51
 
        f = os.getcwd()
52
 
    elif hasattr(os.path, 'realpath'):
53
 
        f = os.path.realpath(f)
54
 
    else:
55
 
        f = os.path.abspath(f)
56
 
 
57
 
    orig_f = f
58
 
 
59
 
    last_f = f
60
 
    while True:
61
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
62
 
            return f
63
 
        head, tail = os.path.split(f)
64
 
        if head == f:
65
 
            # reached the root, whatever that may be
66
 
            bailout('%r is not in a branch' % orig_f)
67
 
        f = head
68
 
    
69
 
 
 
60
# TODO: Some operations like log might retrieve the same revisions
 
61
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
62
# cache in memory to make this faster.  In general anything can be
 
63
# cached in memory between lock and unlock operations.
 
64
 
 
65
def find_branch(*ignored, **ignored_too):
 
66
    # XXX: leave this here for about one release, then remove it
 
67
    raise NotImplementedError('find_branch() is not supported anymore, '
 
68
                              'please use one of the new branch constructors')
 
69
 
 
70
 
 
71
def needs_read_lock(unbound):
 
72
    """Decorate unbound to take out and release a read lock."""
 
73
    def decorated(self, *args, **kwargs):
 
74
        self.lock_read()
 
75
        try:
 
76
            return unbound(self, *args, **kwargs)
 
77
        finally:
 
78
            self.unlock()
 
79
    return decorated
 
80
 
 
81
 
 
82
def needs_write_lock(unbound):
 
83
    """Decorate unbound to take out and release a write lock."""
 
84
    def decorated(self, *args, **kwargs):
 
85
        self.lock_write()
 
86
        try:
 
87
            return unbound(self, *args, **kwargs)
 
88
        finally:
 
89
            self.unlock()
 
90
    return decorated
70
91
 
71
92
######################################################################
72
93
# branch objects
73
94
 
74
 
class Branch:
 
95
class Branch(object):
75
96
    """Branch holding a history of revisions.
76
97
 
77
 
    :todo: Perhaps use different stores for different classes of object,
78
 
           so that we can keep track of how much space each one uses,
79
 
           or garbage-collect them.
80
 
 
81
 
    :todo: Add a RemoteBranch subclass.  For the basic case of read-only
82
 
           HTTP access this should be very easy by, 
83
 
           just redirecting controlfile access into HTTP requests.
84
 
           We would need a RemoteStore working similarly.
85
 
 
86
 
    :todo: Keep the on-disk branch locked while the object exists.
87
 
 
88
 
    :todo: mkdir() method.
89
 
    """
90
 
    def __init__(self, base, init=False, find_root=True):
 
98
    base
 
99
        Base directory/url of the branch.
 
100
    """
 
101
    base = None
 
102
 
 
103
    def __init__(self, *ignored, **ignored_too):
 
104
        raise NotImplementedError('The Branch class is abstract')
 
105
 
 
106
    @staticmethod
 
107
    def open_downlevel(base):
 
108
        """Open a branch which may be of an old format.
 
109
        
 
110
        Only local branches are supported."""
 
111
        return _Branch(get_transport(base), relax_version_check=True)
 
112
        
 
113
    @staticmethod
 
114
    def open(base):
 
115
        """Open an existing branch, rooted at 'base' (url)"""
 
116
        t = get_transport(base)
 
117
        mutter("trying to open %r with transport %r", base, t)
 
118
        return _Branch(t)
 
119
 
 
120
    @staticmethod
 
121
    def open_containing(url):
 
122
        """Open an existing branch which contains url.
 
123
        
 
124
        This probes for a branch at url, and searches upwards from there.
 
125
 
 
126
        Basically we keep looking up until we find the control directory or
 
127
        run into the root.  If there isn't one, raises NotBranchError.
 
128
        If there is one, it is returned, along with the unused portion of url.
 
129
        """
 
130
        t = get_transport(url)
 
131
        while True:
 
132
            try:
 
133
                return _Branch(t), t.relpath(url)
 
134
            except NotBranchError:
 
135
                pass
 
136
            new_t = t.clone('..')
 
137
            if new_t.base == t.base:
 
138
                # reached the root, whatever that may be
 
139
                raise NotBranchError(path=url)
 
140
            t = new_t
 
141
 
 
142
    @staticmethod
 
143
    def initialize(base):
 
144
        """Create a new branch, rooted at 'base' (url)"""
 
145
        t = get_transport(base)
 
146
        return _Branch(t, init=True)
 
147
 
 
148
    def setup_caching(self, cache_root):
 
149
        """Subclasses that care about caching should override this, and set
 
150
        up cached stores located under cache_root.
 
151
        """
 
152
        self.cache_root = cache_root
 
153
 
 
154
 
 
155
class _Branch(Branch):
 
156
    """A branch stored in the actual filesystem.
 
157
 
 
158
    Note that it's "local" in the context of the filesystem; it doesn't
 
159
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
 
160
    it's writable, and can be accessed via the normal filesystem API.
 
161
 
 
162
    _lock_mode
 
163
        None, or 'r' or 'w'
 
164
 
 
165
    _lock_count
 
166
        If _lock_mode is true, a positive count of the number of times the
 
167
        lock has been taken.
 
168
 
 
169
    _lock
 
170
        Lock object from bzrlib.lock.
 
171
    """
 
172
    # We actually expect this class to be somewhat short-lived; part of its
 
173
    # purpose is to try to isolate what bits of the branch logic are tied to
 
174
    # filesystem access, so that in a later step, we can extricate them to
 
175
    # a separarte ("storage") class.
 
176
    _lock_mode = None
 
177
    _lock_count = None
 
178
    _lock = None
 
179
    _inventory_weave = None
 
180
    
 
181
    # Map some sort of prefix into a namespace
 
182
    # stuff like "revno:10", "revid:", etc.
 
183
    # This should match a prefix with a function which accepts
 
184
    REVISION_NAMESPACES = {}
 
185
 
 
186
    def push_stores(self, branch_to):
 
187
        """Copy the content of this branches store to branch_to."""
 
188
        if (self._branch_format != branch_to._branch_format
 
189
            or self._branch_format != 4):
 
190
            from bzrlib.fetch import greedy_fetch
 
191
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
 
192
                   self, self._branch_format, branch_to, branch_to._branch_format)
 
193
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
194
                         revision=self.last_revision())
 
195
            return
 
196
 
 
197
        store_pairs = ((self.text_store,      branch_to.text_store),
 
198
                       (self.inventory_store, branch_to.inventory_store),
 
199
                       (self.revision_store,  branch_to.revision_store))
 
200
        try:
 
201
            for from_store, to_store in store_pairs: 
 
202
                copy_all(from_store, to_store)
 
203
        except UnlistableStore:
 
204
            raise UnlistableBranch(from_store)
 
205
 
 
206
    def __init__(self, transport, init=False,
 
207
                 relax_version_check=False):
91
208
        """Create new branch object at a particular location.
92
209
 
93
 
        :param base: Base directory for the branch.
 
210
        transport -- A Transport object, defining how to access files.
 
211
                (If a string, transport.transport() will be used to
 
212
                create a Transport object)
94
213
        
95
 
        :param init: If True, create new control files in a previously
 
214
        init -- If True, create new control files in a previously
96
215
             unversioned directory.  If False, the branch must already
97
216
             be versioned.
98
217
 
99
 
        :param find_root: If true and init is false, find the root of the
100
 
             existing branch containing base.
 
218
        relax_version_check -- If true, the usual check for the branch
 
219
            version is not applied.  This is intended only for
 
220
            upgrade/recovery type use; it's not guaranteed that
 
221
            all operations will work on old format branches.
101
222
 
102
223
        In the test suite, creation of new trees is tested using the
103
224
        `ScratchBranch` class.
104
225
        """
 
226
        assert isinstance(transport, Transport), \
 
227
            "%r is not a Transport" % transport
 
228
        self._transport = transport
105
229
        if init:
106
 
            self.base = os.path.realpath(base)
107
230
            self._make_control()
108
 
        elif find_root:
109
 
            self.base = find_branch_root(base)
110
 
        else:
111
 
            self.base = os.path.realpath(base)
112
 
            if not isdir(self.controlfilename('.')):
113
 
                bailout("not a bzr branch: %s" % quotefn(base),
114
 
                        ['use "bzr init" to initialize a new working tree',
115
 
                         'current bzr can only operate from top-of-tree'])
116
 
        self._check_format()
117
 
 
118
 
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
119
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
120
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
121
 
 
 
231
        self._check_format(relax_version_check)
 
232
 
 
233
        def get_store(name, compressed=True, prefixed=False):
 
234
            # FIXME: This approach of assuming stores are all entirely compressed
 
235
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
236
            # some existing branches where there's a mixture; we probably 
 
237
            # still want the option to look for both.
 
238
            relpath = self._rel_controlfilename(name)
 
239
            if compressed:
 
240
                store = CompressedTextStore(self._transport.clone(relpath),
 
241
                                            prefixed=prefixed)
 
242
            else:
 
243
                store = TextStore(self._transport.clone(relpath),
 
244
                                  prefixed=prefixed)
 
245
            #if self._transport.should_cache():
 
246
            #    cache_path = os.path.join(self.cache_root, name)
 
247
            #    os.mkdir(cache_path)
 
248
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
249
            return store
 
250
        def get_weave(name, prefixed=False):
 
251
            relpath = self._rel_controlfilename(name)
 
252
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
 
253
            if self._transport.should_cache():
 
254
                ws.enable_cache = True
 
255
            return ws
 
256
 
 
257
        if self._branch_format == 4:
 
258
            self.inventory_store = get_store('inventory-store')
 
259
            self.text_store = get_store('text-store')
 
260
            self.revision_store = get_store('revision-store')
 
261
        elif self._branch_format == 5:
 
262
            self.control_weaves = get_weave('')
 
263
            self.weave_store = get_weave('weaves')
 
264
            self.revision_store = get_store('revision-store', compressed=False)
 
265
        elif self._branch_format == 6:
 
266
            self.control_weaves = get_weave('')
 
267
            self.weave_store = get_weave('weaves', prefixed=True)
 
268
            self.revision_store = get_store('revision-store', compressed=False,
 
269
                                            prefixed=True)
 
270
        self.revision_store.register_suffix('sig')
 
271
        self._transaction = None
122
272
 
123
273
    def __str__(self):
124
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
274
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
125
275
 
126
276
 
127
277
    __repr__ = __str__
128
278
 
129
279
 
 
280
    def __del__(self):
 
281
        if self._lock_mode or self._lock:
 
282
            # XXX: This should show something every time, and be suitable for
 
283
            # headless operation and embedding
 
284
            warn("branch %r was not explicitly unlocked" % self)
 
285
            self._lock.unlock()
 
286
 
 
287
        # TODO: It might be best to do this somewhere else,
 
288
        # but it is nice for a Branch object to automatically
 
289
        # cache it's information.
 
290
        # Alternatively, we could have the Transport objects cache requests
 
291
        # See the earlier discussion about how major objects (like Branch)
 
292
        # should never expect their __del__ function to run.
 
293
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
294
            try:
 
295
                import shutil
 
296
                shutil.rmtree(self.cache_root)
 
297
            except:
 
298
                pass
 
299
            self.cache_root = None
 
300
 
 
301
    def _get_base(self):
 
302
        if self._transport:
 
303
            return self._transport.base
 
304
        return None
 
305
 
 
306
    base = property(_get_base, doc="The URL for the root of this branch.")
 
307
 
 
308
    def _finish_transaction(self):
 
309
        """Exit the current transaction."""
 
310
        if self._transaction is None:
 
311
            raise errors.LockError('Branch %s is not in a transaction' %
 
312
                                   self)
 
313
        transaction = self._transaction
 
314
        self._transaction = None
 
315
        transaction.finish()
 
316
 
 
317
    def get_transaction(self):
 
318
        """Return the current active transaction.
 
319
 
 
320
        If no transaction is active, this returns a passthrough object
 
321
        for which all data is immedaitely flushed and no caching happens.
 
322
        """
 
323
        if self._transaction is None:
 
324
            return transactions.PassThroughTransaction()
 
325
        else:
 
326
            return self._transaction
 
327
 
 
328
    def _set_transaction(self, new_transaction):
 
329
        """Set a new active transaction."""
 
330
        if self._transaction is not None:
 
331
            raise errors.LockError('Branch %s is in a transaction already.' %
 
332
                                   self)
 
333
        self._transaction = new_transaction
 
334
 
 
335
    def lock_write(self):
 
336
        mutter("lock write: %s (%s)", self, self._lock_count)
 
337
        # TODO: Upgrade locking to support using a Transport,
 
338
        # and potentially a remote locking protocol
 
339
        if self._lock_mode:
 
340
            if self._lock_mode != 'w':
 
341
                raise LockError("can't upgrade to a write lock from %r" %
 
342
                                self._lock_mode)
 
343
            self._lock_count += 1
 
344
        else:
 
345
            self._lock = self._transport.lock_write(
 
346
                    self._rel_controlfilename('branch-lock'))
 
347
            self._lock_mode = 'w'
 
348
            self._lock_count = 1
 
349
            self._set_transaction(transactions.PassThroughTransaction())
 
350
 
 
351
    def lock_read(self):
 
352
        mutter("lock read: %s (%s)", self, self._lock_count)
 
353
        if self._lock_mode:
 
354
            assert self._lock_mode in ('r', 'w'), \
 
355
                   "invalid lock mode %r" % self._lock_mode
 
356
            self._lock_count += 1
 
357
        else:
 
358
            self._lock = self._transport.lock_read(
 
359
                    self._rel_controlfilename('branch-lock'))
 
360
            self._lock_mode = 'r'
 
361
            self._lock_count = 1
 
362
            self._set_transaction(transactions.ReadOnlyTransaction())
 
363
            # 5K may be excessive, but hey, its a knob.
 
364
            self.get_transaction().set_cache_size(5000)
 
365
                        
 
366
    def unlock(self):
 
367
        mutter("unlock: %s (%s)", self, self._lock_count)
 
368
        if not self._lock_mode:
 
369
            raise LockError('branch %r is not locked' % (self))
 
370
 
 
371
        if self._lock_count > 1:
 
372
            self._lock_count -= 1
 
373
        else:
 
374
            self._finish_transaction()
 
375
            self._lock.unlock()
 
376
            self._lock = None
 
377
            self._lock_mode = self._lock_count = None
 
378
 
130
379
    def abspath(self, name):
131
 
        """Return absolute filename for something in the branch"""
132
 
        return os.path.join(self.base, name)
133
 
 
134
 
 
135
 
    def relpath(self, path):
136
 
        """Return path relative to this branch of something inside it.
137
 
 
138
 
        Raises an error if path is not in this branch."""
139
 
        rp = os.path.realpath(path)
140
 
        # FIXME: windows
141
 
        if not rp.startswith(self.base):
142
 
            bailout("path %r is not within branch %r" % (rp, self.base))
143
 
        rp = rp[len(self.base):]
144
 
        rp = rp.lstrip(os.sep)
145
 
        return rp
146
 
 
 
380
        """Return absolute filename for something in the branch
 
381
        
 
382
        XXX: Robert Collins 20051017 what is this used for? why is it a branch
 
383
        method and not a tree method.
 
384
        """
 
385
        return self._transport.abspath(name)
 
386
 
 
387
    def _rel_controlfilename(self, file_or_path):
 
388
        if not isinstance(file_or_path, basestring):
 
389
            file_or_path = '/'.join(file_or_path)
 
390
        if file_or_path == '':
 
391
            return bzrlib.BZRDIR
 
392
        return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
147
393
 
148
394
    def controlfilename(self, file_or_path):
149
395
        """Return location relative to branch."""
150
 
        if isinstance(file_or_path, types.StringTypes):
151
 
            file_or_path = [file_or_path]
152
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
396
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
153
397
 
154
398
 
155
399
    def controlfile(self, file_or_path, mode='r'):
156
 
        """Open a control file for this branch"""
157
 
        return file(self.controlfilename(file_or_path), mode)
158
 
 
 
400
        """Open a control file for this branch.
 
401
 
 
402
        There are two classes of file in the control directory: text
 
403
        and binary.  binary files are untranslated byte streams.  Text
 
404
        control files are stored with Unix newlines and in UTF-8, even
 
405
        if the platform or locale defaults are different.
 
406
 
 
407
        Controlfiles should almost never be opened in write mode but
 
408
        rather should be atomically copied and replaced using atomicfile.
 
409
        """
 
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")
 
423
        else:
 
424
            raise BzrError("invalid controlfile mode %r" % mode)
 
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)
159
454
 
160
455
    def _make_control(self):
161
 
        os.mkdir(self.controlfilename([]))
162
 
        self.controlfile('README', 'w').write(
 
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()
 
462
        # if we want per-tree root ids then this is the place to set
 
463
        # them; they're not needed for now and so ommitted for
 
464
        # simplicity.
 
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', 
163
473
            "This is a Bazaar-NG control directory.\n"
164
 
            "Do not change any files in this directory.")
165
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
166
 
        for d in ('text-store', 'inventory-store', 'revision-store'):
167
 
            os.mkdir(self.controlfilename(d))
168
 
        for f in ('revision-history', 'merged-patches',
169
 
                  'pending-merged-patches', 'branch-name'):
170
 
            self.controlfile(f, 'w').write('')
171
 
        mutter('created control directory in ' + self.base)
172
 
        Inventory().write_xml(self.controlfile('inventory','w'))
173
 
 
174
 
 
175
 
    def _check_format(self):
 
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):
176
490
        """Check this branch format is supported.
177
491
 
178
 
        The current tool only supports the current unstable format.
 
492
        The format level is stored, as an integer, in
 
493
        self._branch_format for code that needs to check it later.
179
494
 
180
495
        In the future, we might need different in-memory Branch
181
496
        classes to support downlevel branches.  But not yet.
182
 
        """        
183
 
        # read in binary mode to detect newline wierdness.
184
 
        fmt = self.controlfile('branch-format', 'rb').read()
185
 
        if fmt != BZR_BRANCH_FORMAT:
186
 
            bailout('sorry, branch format %r not supported' % fmt,
187
 
                    ['use a different bzr version',
188
 
                     'or remove the .bzr directory and "bzr init" again'])
189
 
 
190
 
 
 
497
        """
 
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:
 
506
            self._branch_format = 5
 
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'])
 
517
 
 
518
    def get_root_id(self):
 
519
        """Return the id of this branches root"""
 
520
        inv = self.read_working_inventory()
 
521
        return inv.root.file_id
 
522
 
 
523
    def set_root_id(self, file_id):
 
524
        inv = self.read_working_inventory()
 
525
        orig_root_id = inv.root.file_id
 
526
        del inv._byid[inv.root.file_id]
 
527
        inv.root.file_id = file_id
 
528
        inv._byid[inv.root.file_id] = inv.root
 
529
        for fid in inv:
 
530
            entry = inv[fid]
 
531
            if entry.parent_id in (None, orig_root_id):
 
532
                entry.parent_id = inv.root.file_id
 
533
        self._write_inventory(inv)
 
534
 
 
535
    @needs_read_lock
191
536
    def read_working_inventory(self):
192
537
        """Read the working inventory."""
193
 
        before = time.time()
194
 
        inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
195
 
        mutter("loaded inventory of %d items in %f"
196
 
               % (len(inv), time.time() - before))
197
 
        return inv
198
 
 
199
 
 
 
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)
 
542
 
 
543
    @needs_write_lock
200
544
    def _write_inventory(self, inv):
201
545
        """Update the working inventory.
202
546
 
203
547
        That is to say, the inventory describing changes underway, that
204
548
        will be committed to the next revision.
205
549
        """
206
 
        ## TODO: factor out to atomicfile?  is rename safe on windows?
207
 
        ## TODO: Maybe some kind of clean/dirty marker on inventory?
208
 
        tmpfname = self.controlfilename('inventory.tmp')
209
 
        tmpf = file(tmpfname, 'w')
210
 
        inv.write_xml(tmpf)
211
 
        tmpf.close()
212
 
        os.rename(tmpfname, self.controlfilename('inventory'))
 
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)
 
556
        
213
557
        mutter('wrote working inventory')
214
 
 
215
 
 
 
558
            
216
559
    inventory = property(read_working_inventory, _write_inventory, None,
217
560
                         """Inventory for the working copy.""")
218
561
 
219
 
 
220
 
    def add(self, files, verbose=False):
 
562
    @needs_write_lock
 
563
    def add(self, files, ids=None):
221
564
        """Make files versioned.
222
565
 
 
566
        Note that the command line normally calls smart_add instead,
 
567
        which can automatically recurse.
 
568
 
223
569
        This puts the files in the Added state, so that they will be
224
570
        recorded by the next commit.
225
571
 
226
 
        :todo: Perhaps have an option to add the ids even if the files do
227
 
               not (yet) exist.
228
 
 
229
 
        :todo: Perhaps return the ids of the files?  But then again it
230
 
               is easy to retrieve them if they're needed.
231
 
 
232
 
        :todo: Option to specify file id.
233
 
 
234
 
        :todo: Adding a directory should optionally recurse down and
235
 
               add all non-ignored children.  Perhaps do that in a
236
 
               higher-level method.
237
 
 
238
 
        >>> b = ScratchBranch(files=['foo'])
239
 
        >>> 'foo' in b.unknowns()
240
 
        True
241
 
        >>> b.show_status()
242
 
        ?       foo
243
 
        >>> b.add('foo')
244
 
        >>> 'foo' in b.unknowns()
245
 
        False
246
 
        >>> bool(b.inventory.path2id('foo'))
247
 
        True
248
 
        >>> b.show_status()
249
 
        A       foo
250
 
 
251
 
        >>> b.add('foo')
252
 
        Traceback (most recent call last):
253
 
        ...
254
 
        BzrError: ('foo is already versioned', [])
255
 
 
256
 
        >>> b.add(['nothere'])
257
 
        Traceback (most recent call last):
258
 
        BzrError: ('cannot add: not a regular file or directory: nothere', [])
 
572
        files
 
573
            List of paths to add, relative to the base of the tree.
 
574
 
 
575
        ids
 
576
            If set, use these instead of automatically generated ids.
 
577
            Must be the same length as the list of files, but may
 
578
            contain None for ids that are to be autogenerated.
 
579
 
 
580
        TODO: Perhaps have an option to add the ids even if the files do
 
581
              not (yet) exist.
 
582
 
 
583
        TODO: Perhaps yield the ids and paths as they're added.
259
584
        """
260
 
 
261
585
        # TODO: Re-adding a file that is removed in the working copy
262
586
        # should probably put it back with the previous ID.
263
 
        if isinstance(files, types.StringTypes):
 
587
        if isinstance(files, basestring):
 
588
            assert(ids is None or isinstance(ids, basestring))
264
589
            files = [files]
265
 
        
 
590
            if ids is not None:
 
591
                ids = [ids]
 
592
 
 
593
        if ids is None:
 
594
            ids = [None] * len(files)
 
595
        else:
 
596
            assert(len(ids) == len(files))
 
597
 
266
598
        inv = self.read_working_inventory()
267
 
        for f in files:
 
599
        for f,file_id in zip(files, ids):
268
600
            if is_control_file(f):
269
 
                bailout("cannot add control file %s" % quotefn(f))
 
601
                raise BzrError("cannot add control file %s" % quotefn(f))
270
602
 
271
603
            fp = splitpath(f)
272
604
 
273
605
            if len(fp) == 0:
274
 
                bailout("cannot add top-level %r" % f)
275
 
                
 
606
                raise BzrError("cannot add top-level %r" % f)
 
607
 
276
608
            fullpath = os.path.normpath(self.abspath(f))
277
609
 
278
610
            try:
279
611
                kind = file_kind(fullpath)
280
612
            except OSError:
281
613
                # maybe something better?
282
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
283
 
            
284
 
            if kind != 'file' and kind != 'directory':
285
 
                bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
286
 
 
287
 
            file_id = gen_file_id(f)
 
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)
288
622
            inv.add_path(f, kind=kind, file_id=file_id)
289
623
 
290
 
            if verbose:
291
 
                show_status('A', kind, quotefn(f))
292
 
                
293
624
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
294
 
            
295
 
        self._write_inventory(inv)
296
 
 
297
 
 
298
 
 
299
 
    def remove(self, files, verbose=False):
300
 
        """Mark nominated files for removal from the inventory.
301
 
 
302
 
        This does not remove their text.  This does not run on 
303
 
 
304
 
        :todo: Refuse to remove modified files unless --force is given?
305
 
 
306
 
        >>> b = ScratchBranch(files=['foo'])
307
 
        >>> b.add('foo')
308
 
        >>> b.inventory.has_filename('foo')
309
 
        True
310
 
        >>> b.remove('foo')
311
 
        >>> b.working_tree().has_filename('foo')
312
 
        True
313
 
        >>> b.inventory.has_filename('foo')
314
 
        False
315
 
        
316
 
        >>> b = ScratchBranch(files=['foo'])
317
 
        >>> b.add('foo')
318
 
        >>> b.commit('one')
319
 
        >>> b.remove('foo')
320
 
        >>> b.commit('two')
321
 
        >>> b.inventory.has_filename('foo') 
322
 
        False
323
 
        >>> b.basis_tree().has_filename('foo') 
324
 
        False
325
 
        >>> b.working_tree().has_filename('foo') 
326
 
        True
327
 
 
328
 
        :todo: Do something useful with directories.
329
 
 
330
 
        :todo: Should this remove the text or not?  Tough call; not
331
 
        removing may be useful and the user can just use use rm, and
332
 
        is the opposite of add.  Removing it is consistent with most
333
 
        other tools.  Maybe an option.
334
 
        """
335
 
        ## TODO: Normalize names
336
 
        ## TODO: Remove nested loops; better scalability
337
 
 
338
 
        if isinstance(files, types.StringTypes):
339
 
            files = [files]
340
 
        
341
 
        tree = self.working_tree()
342
 
        inv = tree.inventory
343
 
 
344
 
        # do this before any modifications
345
 
        for f in files:
346
 
            fid = inv.path2id(f)
347
 
            if not fid:
348
 
                bailout("cannot remove unversioned file %s" % quotefn(f))
349
 
            mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
350
 
            if verbose:
351
 
                # having remove it, it must be either ignored or unknown
352
 
                if tree.is_ignored(f):
353
 
                    new_status = 'I'
354
 
                else:
355
 
                    new_status = '?'
356
 
                show_status(new_status, inv[fid].kind, quotefn(f))
357
 
            del inv[fid]
358
 
 
359
 
        self._write_inventory(inv)
360
 
 
 
625
 
 
626
        self._write_inventory(inv)
 
627
 
 
628
    @needs_read_lock
 
629
    def print_file(self, file, revno):
 
630
        """Print `file` to stdout."""
 
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)
 
637
 
 
638
    # FIXME: this doesn't need to be a branch method
 
639
    def set_inventory(self, new_inventory_list):
 
640
        from bzrlib.inventory import Inventory, InventoryEntry
 
641
        inv = Inventory(self.get_root_id())
 
642
        for path, file_id, parent, kind in new_inventory_list:
 
643
            name = os.path.basename(path)
 
644
            if name == "":
 
645
                continue
 
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)
 
655
        self._write_inventory(inv)
361
656
 
362
657
    def unknowns(self):
363
658
        """Return all unknown files.
365
660
        These are files in the working directory that are not versioned or
366
661
        control files or ignored.
367
662
        
 
663
        >>> from bzrlib.workingtree import WorkingTree
368
664
        >>> b = ScratchBranch(files=['foo', 'foo~'])
369
 
        >>> list(b.unknowns())
 
665
        >>> map(str, b.unknowns())
370
666
        ['foo']
371
667
        >>> b.add('foo')
372
668
        >>> list(b.unknowns())
373
669
        []
374
 
        >>> b.remove('foo')
 
670
        >>> WorkingTree(b.base, b).remove('foo')
375
671
        >>> list(b.unknowns())
376
 
        ['foo']
 
672
        [u'foo']
377
673
        """
378
674
        return self.working_tree().unknowns()
379
675
 
380
 
 
381
 
    def commit(self, message, timestamp=None, timezone=None,
382
 
               committer=None,
383
 
               verbose=False):
384
 
        """Commit working copy as a new revision.
385
 
        
386
 
        The basic approach is to add all the file texts into the
387
 
        store, then the inventory, then make a new revision pointing
388
 
        to that inventory and store that.
389
 
        
390
 
        This is not quite safe if the working copy changes during the
391
 
        commit; for the moment that is simply not allowed.  A better
392
 
        approach is to make a temporary copy of the files before
393
 
        computing their hashes, and then add those hashes in turn to
394
 
        the inventory.  This should mean at least that there are no
395
 
        broken hash pointers.  There is no way we can get a snapshot
396
 
        of the whole directory at an instant.  This would also have to
397
 
        be robust against files disappearing, moving, etc.  So the
398
 
        whole thing is a bit hard.
399
 
 
400
 
        :param timestamp: if not None, seconds-since-epoch for a
401
 
             postdated/predated commit.
402
 
        """
403
 
 
404
 
        ## TODO: Show branch names
405
 
 
406
 
        # TODO: Don't commit if there are no changes, unless forced?
407
 
 
408
 
        # First walk over the working inventory; and both update that
409
 
        # and also build a new revision inventory.  The revision
410
 
        # inventory needs to hold the text-id, sha1 and size of the
411
 
        # actual file versions committed in the revision.  (These are
412
 
        # not present in the working inventory.)  We also need to
413
 
        # detect missing/deleted files, and remove them from the
414
 
        # working inventory.
415
 
 
416
 
        work_inv = self.read_working_inventory()
417
 
        inv = Inventory()
418
 
        basis = self.basis_tree()
419
 
        basis_inv = basis.inventory
420
 
        missing_ids = []
421
 
        for path, entry in work_inv.iter_entries():
422
 
            ## TODO: Cope with files that have gone missing.
423
 
 
424
 
            ## TODO: Check that the file kind has not changed from the previous
425
 
            ## revision of this file (if any).
426
 
 
427
 
            entry = entry.copy()
428
 
 
429
 
            p = self.abspath(path)
430
 
            file_id = entry.file_id
431
 
            mutter('commit prep file %s, id %r ' % (p, file_id))
432
 
 
433
 
            if not os.path.exists(p):
434
 
                mutter("    file is missing, removing from inventory")
435
 
                if verbose:
436
 
                    show_status('D', entry.kind, quotefn(path))
437
 
                missing_ids.append(file_id)
438
 
                continue
439
 
 
440
 
            # TODO: Handle files that have been deleted
441
 
 
442
 
            # TODO: Maybe a special case for empty files?  Seems a
443
 
            # waste to store them many times.
444
 
 
445
 
            inv.add(entry)
446
 
 
447
 
            if basis_inv.has_id(file_id):
448
 
                old_kind = basis_inv[file_id].kind
449
 
                if old_kind != entry.kind:
450
 
                    bailout("entry %r changed kind from %r to %r"
451
 
                            % (file_id, old_kind, entry.kind))
452
 
 
453
 
            if entry.kind == 'directory':
454
 
                if not isdir(p):
455
 
                    bailout("%s is entered as directory but not a directory" % quotefn(p))
456
 
            elif entry.kind == 'file':
457
 
                if not isfile(p):
458
 
                    bailout("%s is entered as file but is not a file" % quotefn(p))
459
 
 
460
 
                content = file(p, 'rb').read()
461
 
 
462
 
                entry.text_sha1 = sha_string(content)
463
 
                entry.text_size = len(content)
464
 
 
465
 
                old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
466
 
                if (old_ie
467
 
                    and (old_ie.text_size == entry.text_size)
468
 
                    and (old_ie.text_sha1 == entry.text_sha1)):
469
 
                    ## assert content == basis.get_file(file_id).read()
470
 
                    entry.text_id = basis_inv[file_id].text_id
471
 
                    mutter('    unchanged from previous text_id {%s}' %
472
 
                           entry.text_id)
473
 
                    
474
 
                else:
475
 
                    entry.text_id = gen_file_id(entry.name)
476
 
                    self.text_store.add(content, entry.text_id)
477
 
                    mutter('    stored with text_id {%s}' % entry.text_id)
478
 
                    if verbose:
479
 
                        if not old_ie:
480
 
                            state = 'A'
481
 
                        elif (old_ie.name == entry.name
482
 
                              and old_ie.parent_id == entry.parent_id):
483
 
                            state = 'R'
484
 
                        else:
485
 
                            state = 'M'
486
 
 
487
 
                        show_status(state, entry.kind, quotefn(path))
488
 
 
489
 
        for file_id in missing_ids:
490
 
            # have to do this later so we don't mess up the iterator.
491
 
            # since parents may be removed before their children we
492
 
            # have to test.
493
 
 
494
 
            # FIXME: There's probably a better way to do this; perhaps
495
 
            # the workingtree should know how to filter itself.
496
 
            if work_inv.has_id(file_id):
497
 
                del work_inv[file_id]
498
 
 
499
 
 
500
 
        inv_id = rev_id = _gen_revision_id(time.time())
501
 
        
502
 
        inv_tmp = tempfile.TemporaryFile()
503
 
        inv.write_xml(inv_tmp)
504
 
        inv_tmp.seek(0)
505
 
        self.inventory_store.add(inv_tmp, inv_id)
506
 
        mutter('new inventory_id is {%s}' % inv_id)
507
 
 
508
 
        self._write_inventory(work_inv)
509
 
 
510
 
        if timestamp == None:
511
 
            timestamp = time.time()
512
 
 
513
 
        if committer == None:
514
 
            committer = username()
515
 
 
516
 
        if timezone == None:
517
 
            timezone = local_time_offset()
518
 
 
519
 
        mutter("building commit log message")
520
 
        rev = Revision(timestamp=timestamp,
521
 
                       timezone=timezone,
522
 
                       committer=committer,
523
 
                       precursor = self.last_patch(),
524
 
                       message = message,
525
 
                       inventory_id=inv_id,
526
 
                       revision_id=rev_id)
527
 
 
528
 
        rev_tmp = tempfile.TemporaryFile()
529
 
        rev.write_xml(rev_tmp)
530
 
        rev_tmp.seek(0)
531
 
        self.revision_store.add(rev_tmp, rev_id)
532
 
        mutter("new revision_id is {%s}" % rev_id)
533
 
        
534
 
        ## XXX: Everything up to here can simply be orphaned if we abort
535
 
        ## the commit; it will leave junk files behind but that doesn't
536
 
        ## matter.
537
 
 
538
 
        ## TODO: Read back the just-generated changeset, and make sure it
539
 
        ## applies and recreates the right state.
540
 
 
541
 
        ## TODO: Also calculate and store the inventory SHA1
542
 
        mutter("committing patch r%d" % (self.revno() + 1))
543
 
 
544
 
        mutter("append to revision-history")
545
 
        self.controlfile('revision-history', 'at').write(rev_id + '\n')
546
 
 
547
 
        mutter("done!")
 
676
    @needs_write_lock
 
677
    def append_revision(self, *revision_ids):
 
678
        for revision_id in revision_ids:
 
679
            mutter("add {%s} to revision-history" % revision_id)
 
680
        rev_history = self.revision_history()
 
681
        rev_history.extend(revision_ids)
 
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
 
697
    def get_revision_xml_file(self, revision_id):
 
698
        """Return XML file object for revision object."""
 
699
        if not revision_id or not isinstance(revision_id, basestring):
 
700
            raise InvalidRevisionId(revision_id)
 
701
        try:
 
702
            return self.revision_store.get(revision_id)
 
703
        except (IndexError, KeyError):
 
704
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
705
 
 
706
    #deprecated
 
707
    get_revision_xml = get_revision_xml_file
 
708
 
 
709
    def get_revision_xml(self, revision_id):
 
710
        return self.get_revision_xml_file(revision_id).read()
548
711
 
549
712
 
550
713
    def get_revision(self, revision_id):
551
714
        """Return the Revision object for a named revision"""
552
 
        r = Revision.read_xml(self.revision_store[revision_id])
 
715
        xml_file = self.get_revision_xml_file(revision_id)
 
716
 
 
717
        try:
 
718
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
 
719
        except SyntaxError, e:
 
720
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
 
721
                                         [revision_id,
 
722
                                          str(e)])
 
723
            
553
724
        assert r.revision_id == revision_id
554
725
        return r
555
726
 
556
 
 
557
 
    def get_inventory(self, inventory_id):
558
 
        """Get Inventory object by hash.
559
 
 
560
 
        :todo: Perhaps for this and similar methods, take a revision
561
 
               parameter which can be either an integer revno or a
562
 
               string hash."""
563
 
        i = Inventory.read_xml(self.inventory_store[inventory_id])
564
 
        return i
565
 
 
 
727
    def get_revision_delta(self, revno):
 
728
        """Return the delta for one revision.
 
729
 
 
730
        The delta is relative to its mainline predecessor, or the
 
731
        empty tree for revision 1.
 
732
        """
 
733
        assert isinstance(revno, int)
 
734
        rh = self.revision_history()
 
735
        if not (1 <= revno <= len(rh)):
 
736
            raise InvalidRevisionNumber(revno)
 
737
 
 
738
        # revno is 1-based; list is 0-based
 
739
 
 
740
        new_tree = self.revision_tree(rh[revno-1])
 
741
        if revno == 1:
 
742
            old_tree = EmptyTree()
 
743
        else:
 
744
            old_tree = self.revision_tree(rh[revno-2])
 
745
 
 
746
        return compare_trees(old_tree, new_tree)
 
747
 
 
748
    def get_revision_sha1(self, revision_id):
 
749
        """Hash the stored value of a revision, and return it."""
 
750
        # In the future, revision entries will be signed. At that
 
751
        # point, it is probably best *not* to include the signature
 
752
        # in the revision hash. Because that lets you re-sign
 
753
        # the revision, (add signatures/remove signatures) and still
 
754
        # have all hash pointers stay consistent.
 
755
        # But for now, just hash the contents.
 
756
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
757
 
 
758
    def get_ancestry(self, revision_id):
 
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.
 
763
        """
 
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)]))
 
769
 
 
770
    def get_inventory_weave(self):
 
771
        return self.control_weaves.get_weave('inventory',
 
772
                                             self.get_transaction())
 
773
 
 
774
    def get_inventory(self, revision_id):
 
775
        """Get Inventory object by hash."""
 
776
        xml = self.get_inventory_xml(revision_id)
 
777
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
778
 
 
779
    def get_inventory_xml(self, revision_id):
 
780
        """Get inventory XML as a file object."""
 
781
        try:
 
782
            assert isinstance(revision_id, basestring), type(revision_id)
 
783
            iw = self.get_inventory_weave()
 
784
            return iw.get_text(iw.lookup(revision_id))
 
785
        except IndexError:
 
786
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
787
 
 
788
    def get_inventory_sha1(self, revision_id):
 
789
        """Return the sha1 hash of the inventory entry
 
790
        """
 
791
        return self.get_revision(revision_id).inventory_sha1
566
792
 
567
793
    def get_revision_inventory(self, revision_id):
568
794
        """Return inventory of a past revision."""
 
795
        # TODO: Unify this with get_inventory()
 
796
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
797
        # must be the same as its revision, so this is trivial.
569
798
        if revision_id == None:
570
 
            return Inventory()
 
799
            return Inventory(self.get_root_id())
571
800
        else:
572
 
            return self.get_inventory(self.get_revision(revision_id).inventory_id)
573
 
 
574
 
 
 
801
            return self.get_inventory(revision_id)
 
802
 
 
803
    @needs_read_lock
575
804
    def revision_history(self):
576
 
        """Return sequence of revision hashes on to this branch.
577
 
 
578
 
        >>> ScratchBranch().revision_history()
579
 
        []
580
 
        """
581
 
        return [chomp(l) for l in self.controlfile('revision-history').readlines()]
582
 
 
 
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)
583
818
 
584
819
    def revno(self):
585
820
        """Return current revision number for this branch.
586
821
 
587
822
        That is equivalent to the number of revisions committed to
588
823
        this branch.
589
 
 
590
 
        >>> b = ScratchBranch()
591
 
        >>> b.revno()
592
 
        0
593
 
        >>> b.commit('no foo')
594
 
        >>> b.revno()
595
 
        1
596
824
        """
597
825
        return len(self.revision_history())
598
826
 
599
 
 
600
 
    def last_patch(self):
 
827
    def last_revision(self):
601
828
        """Return last patch hash, or None if no history.
602
 
 
603
 
        >>> ScratchBranch().last_patch() == None
604
 
        True
605
829
        """
606
830
        ph = self.revision_history()
607
831
        if ph:
608
832
            return ph[-1]
609
 
 
610
 
 
611
 
    def lookup_revision(self, revno):
612
 
        """Return revision hash for revision number."""
 
833
        else:
 
834
            return None
 
835
 
 
836
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
 
837
        """Return a list of new revisions that would perfectly fit.
 
838
        
 
839
        If self and other have not diverged, return a list of the revisions
 
840
        present in other, but missing from self.
 
841
 
 
842
        >>> from bzrlib.commit import commit
 
843
        >>> bzrlib.trace.silent = True
 
844
        >>> br1 = ScratchBranch()
 
845
        >>> br2 = ScratchBranch()
 
846
        >>> br1.missing_revisions(br2)
 
847
        []
 
848
        >>> commit(br2, "lala!", rev_id="REVISION-ID-1")
 
849
        >>> br1.missing_revisions(br2)
 
850
        [u'REVISION-ID-1']
 
851
        >>> br2.missing_revisions(br1)
 
852
        []
 
853
        >>> commit(br1, "lala!", rev_id="REVISION-ID-1")
 
854
        >>> br1.missing_revisions(br2)
 
855
        []
 
856
        >>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
 
857
        >>> br1.missing_revisions(br2)
 
858
        [u'REVISION-ID-2A']
 
859
        >>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
 
860
        >>> br1.missing_revisions(br2)
 
861
        Traceback (most recent call last):
 
862
        DivergedBranches: These branches have diverged.
 
863
        """
 
864
        self_history = self.revision_history()
 
865
        self_len = len(self_history)
 
866
        other_history = other.revision_history()
 
867
        other_len = len(other_history)
 
868
        common_index = min(self_len, other_len) -1
 
869
        if common_index >= 0 and \
 
870
            self_history[common_index] != other_history[common_index]:
 
871
            raise DivergedBranches(self, other)
 
872
 
 
873
        if stop_revision is None:
 
874
            stop_revision = other_len
 
875
        else:
 
876
            assert isinstance(stop_revision, int)
 
877
            if stop_revision > other_len:
 
878
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
 
879
        return other_history[self_len:stop_revision]
 
880
 
 
881
    def update_revisions(self, other, stop_revision=None):
 
882
        """Pull in new perfect-fit revisions."""
 
883
        # FIXME: If the branches have diverged, but the latest
 
884
        # revision in this branch is completely merged into the other,
 
885
        # then we should still be able to pull.
 
886
        from bzrlib.fetch import greedy_fetch
 
887
        if stop_revision is None:
 
888
            stop_revision = other.last_revision()
 
889
        ### Should this be checking is_ancestor instead of revision_history?
 
890
        if (stop_revision is not None and 
 
891
            stop_revision in self.revision_history()):
 
892
            return
 
893
        greedy_fetch(to_branch=self, from_branch=other,
 
894
                     revision=stop_revision)
 
895
        pullable_revs = self.pullable_revisions(other, stop_revision)
 
896
        if len(pullable_revs) > 0:
 
897
            self.append_revision(*pullable_revs)
 
898
 
 
899
    def pullable_revisions(self, other, stop_revision):
 
900
        other_revno = other.revision_id_to_revno(stop_revision)
 
901
        try:
 
902
            return self.missing_revisions(other, other_revno)
 
903
        except DivergedBranches, e:
 
904
            try:
 
905
                pullable_revs = get_intervening_revisions(self.last_revision(),
 
906
                                                          stop_revision, self)
 
907
                assert self.last_revision() not in pullable_revs
 
908
                return pullable_revs
 
909
            except bzrlib.errors.NotAncestor:
 
910
                if is_ancestor(self.last_revision(), stop_revision, self):
 
911
                    return []
 
912
                else:
 
913
                    raise e
 
914
        
 
915
    def commit(self, *args, **kw):
 
916
        from bzrlib.commit import Commit
 
917
        Commit().commit(self, *args, **kw)
 
918
    
 
919
    def revision_id_to_revno(self, revision_id):
 
920
        """Given a revision id, return its revno"""
 
921
        if revision_id is None:
 
922
            return 0
 
923
        history = self.revision_history()
 
924
        try:
 
925
            return history.index(revision_id) + 1
 
926
        except ValueError:
 
927
            raise bzrlib.errors.NoSuchRevision(self, revision_id)
 
928
 
 
929
    def get_rev_id(self, revno, history=None):
 
930
        """Find the revision id of the specified revno."""
613
931
        if revno == 0:
614
932
            return None
615
 
 
616
 
        try:
617
 
            # list is 0-based; revisions are 1-based
618
 
            return self.revision_history()[revno-1]
619
 
        except IndexError:
620
 
            bailout("no such revision %s" % revno)
621
 
 
 
933
        if history is None:
 
934
            history = self.revision_history()
 
935
        elif revno <= 0 or revno > len(history):
 
936
            raise bzrlib.errors.NoSuchRevision(self, revno)
 
937
        return history[revno - 1]
622
938
 
623
939
    def revision_tree(self, revision_id):
624
940
        """Return Tree for a revision on this branch.
625
941
 
626
942
        `revision_id` may be None for the null revision, in which case
627
943
        an `EmptyTree` is returned."""
628
 
 
 
944
        # TODO: refactor this to use an existing revision object
 
945
        # so we don't need to read it in twice.
629
946
        if revision_id == None:
630
947
            return EmptyTree()
631
948
        else:
632
949
            inv = self.get_revision_inventory(revision_id)
633
 
            return RevisionTree(self.text_store, inv)
634
 
 
 
950
            return RevisionTree(self.weave_store, inv, revision_id)
635
951
 
636
952
    def working_tree(self):
637
953
        """Return a `Tree` for the working copy."""
638
 
        return WorkingTree(self.base, self.read_working_inventory())
 
954
        from bzrlib.workingtree import WorkingTree
 
955
        # TODO: In the future, perhaps WorkingTree should utilize Transport
 
956
        # RobertCollins 20051003 - I don't think it should - working trees are
 
957
        # much more complex to keep consistent than our careful .bzr subset.
 
958
        # instead, we should say that working trees are local only, and optimise
 
959
        # for that.
 
960
        return WorkingTree(self.base, branch=self)
639
961
 
640
962
 
641
963
    def basis_tree(self):
642
964
        """Return `Tree` object for last revision.
643
965
 
644
966
        If there are no revisions yet, return an `EmptyTree`.
645
 
 
646
 
        >>> b = ScratchBranch(files=['foo'])
647
 
        >>> b.basis_tree().has_filename('foo')
648
 
        False
649
 
        >>> b.working_tree().has_filename('foo')
650
 
        True
651
 
        >>> b.add('foo')
652
 
        >>> b.commit('add foo')
653
 
        >>> b.basis_tree().has_filename('foo')
654
 
        True
655
 
        """
656
 
        r = self.last_patch()
657
 
        if r == None:
658
 
            return EmptyTree()
659
 
        else:
660
 
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
661
 
 
662
 
 
663
 
 
664
 
    def write_log(self, show_timezone='original'):
665
 
        """Write out human-readable log of commits to this branch
666
 
 
667
 
        :param utc: If true, show dates in universal time, not local time."""
668
 
        ## TODO: Option to choose either original, utc or local timezone
669
 
        revno = 1
670
 
        precursor = None
671
 
        for p in self.revision_history():
672
 
            print '-' * 40
673
 
            print 'revno:', revno
674
 
            ## TODO: Show hash if --id is given.
675
 
            ##print 'revision-hash:', p
676
 
            rev = self.get_revision(p)
677
 
            print 'committer:', rev.committer
678
 
            print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
679
 
                                                 show_timezone))
680
 
 
681
 
            ## opportunistic consistency check, same as check_patch_chaining
682
 
            if rev.precursor != precursor:
683
 
                bailout("mismatched precursor!")
684
 
 
685
 
            print 'message:'
686
 
            if not rev.message:
687
 
                print '  (no message)'
688
 
            else:
689
 
                for l in rev.message.split('\n'):
690
 
                    print '  ' + l
691
 
 
692
 
            revno += 1
693
 
            precursor = p
694
 
 
695
 
 
696
 
 
697
 
    def show_status(branch, show_all=False):
698
 
        """Display single-line status for non-ignored working files.
699
 
 
700
 
        The list is show sorted in order by file name.
701
 
 
702
 
        >>> b = ScratchBranch(files=['foo', 'foo~'])
703
 
        >>> b.show_status()
704
 
        ?       foo
705
 
        >>> b.add('foo')
706
 
        >>> b.show_status()
707
 
        A       foo
708
 
        >>> b.commit("add foo")
709
 
        >>> b.show_status()
710
 
        >>> os.unlink(b.abspath('foo'))
711
 
        >>> b.show_status()
712
 
        D       foo
713
 
        
714
 
 
715
 
        :todo: Get state for single files.
716
 
 
717
 
        :todo: Perhaps show a slash at the end of directory names.        
718
 
 
719
 
        """
720
 
 
721
 
        # We have to build everything into a list first so that it can
722
 
        # sorted by name, incorporating all the different sources.
723
 
 
724
 
        # FIXME: Rather than getting things in random order and then sorting,
725
 
        # just step through in order.
726
 
 
727
 
        # Interesting case: the old ID for a file has been removed,
728
 
        # but a new file has been created under that name.
729
 
 
730
 
        old = branch.basis_tree()
731
 
        old_inv = old.inventory
732
 
        new = branch.working_tree()
733
 
        new_inv = new.inventory
734
 
 
735
 
        for fs, fid, oldname, newname, kind in diff_trees(old, new):
736
 
            if fs == 'R':
737
 
                show_status(fs, kind,
738
 
                            oldname + ' => ' + newname)
739
 
            elif fs == 'A' or fs == 'M':
740
 
                show_status(fs, kind, newname)
741
 
            elif fs == 'D':
742
 
                show_status(fs, kind, oldname)
743
 
            elif fs == '.':
744
 
                if show_all:
745
 
                    show_status(fs, kind, newname)
746
 
            elif fs == 'I':
747
 
                if show_all:
748
 
                    show_status(fs, kind, newname)
749
 
            elif fs == '?':
750
 
                show_status(fs, kind, newname)
751
 
            else:
752
 
                bailout("wierd file state %r" % ((fs, fid),))
753
 
                
754
 
 
755
 
 
756
 
class ScratchBranch(Branch):
 
967
        """
 
968
        return self.revision_tree(self.last_revision())
 
969
 
 
970
    @needs_write_lock
 
971
    def rename_one(self, from_rel, to_rel):
 
972
        """Rename one file.
 
973
 
 
974
        This can change the directory or the filename or both.
 
975
        """
 
976
        tree = self.working_tree()
 
977
        inv = tree.inventory
 
978
        if not tree.has_filename(from_rel):
 
979
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
980
        if tree.has_filename(to_rel):
 
981
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
982
 
 
983
        file_id = inv.path2id(from_rel)
 
984
        if file_id == None:
 
985
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
986
 
 
987
        if inv.path2id(to_rel):
 
988
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
989
 
 
990
        to_dir, to_tail = os.path.split(to_rel)
 
991
        to_dir_id = inv.path2id(to_dir)
 
992
        if to_dir_id == None and to_dir != '':
 
993
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
994
 
 
995
        mutter("rename_one:")
 
996
        mutter("  file_id    {%s}" % file_id)
 
997
        mutter("  from_rel   %r" % from_rel)
 
998
        mutter("  to_rel     %r" % to_rel)
 
999
        mutter("  to_dir     %r" % to_dir)
 
1000
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
1001
 
 
1002
        inv.rename(file_id, to_dir_id, to_tail)
 
1003
 
 
1004
        from_abs = self.abspath(from_rel)
 
1005
        to_abs = self.abspath(to_rel)
 
1006
        try:
 
1007
            rename(from_abs, to_abs)
 
1008
        except OSError, e:
 
1009
            raise BzrError("failed to rename %r to %r: %s"
 
1010
                    % (from_abs, to_abs, e[1]),
 
1011
                    ["rename rolled back"])
 
1012
 
 
1013
        self._write_inventory(inv)
 
1014
 
 
1015
    @needs_write_lock
 
1016
    def move(self, from_paths, to_name):
 
1017
        """Rename files.
 
1018
 
 
1019
        to_name must exist as a versioned directory.
 
1020
 
 
1021
        If to_name exists and is a directory, the files are moved into
 
1022
        it, keeping their old names.  If it is a directory, 
 
1023
 
 
1024
        Note that to_name is only the last component of the new name;
 
1025
        this doesn't change the directory.
 
1026
 
 
1027
        This returns a list of (from_path, to_path) pairs for each
 
1028
        entry that is moved.
 
1029
        """
 
1030
        result = []
 
1031
        ## TODO: Option to move IDs only
 
1032
        assert not isinstance(from_paths, basestring)
 
1033
        tree = self.working_tree()
 
1034
        inv = tree.inventory
 
1035
        to_abs = self.abspath(to_name)
 
1036
        if not isdir(to_abs):
 
1037
            raise BzrError("destination %r is not a directory" % to_abs)
 
1038
        if not tree.has_filename(to_name):
 
1039
            raise BzrError("destination %r not in working directory" % to_abs)
 
1040
        to_dir_id = inv.path2id(to_name)
 
1041
        if to_dir_id == None and to_name != '':
 
1042
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1043
        to_dir_ie = inv[to_dir_id]
 
1044
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1045
            raise BzrError("destination %r is not a directory" % to_abs)
 
1046
 
 
1047
        to_idpath = inv.get_idpath(to_dir_id)
 
1048
 
 
1049
        for f in from_paths:
 
1050
            if not tree.has_filename(f):
 
1051
                raise BzrError("%r does not exist in working tree" % f)
 
1052
            f_id = inv.path2id(f)
 
1053
            if f_id == None:
 
1054
                raise BzrError("%r is not versioned" % f)
 
1055
            name_tail = splitpath(f)[-1]
 
1056
            dest_path = appendpath(to_name, name_tail)
 
1057
            if tree.has_filename(dest_path):
 
1058
                raise BzrError("destination %r already exists" % dest_path)
 
1059
            if f_id in to_idpath:
 
1060
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
1061
 
 
1062
        # OK, so there's a race here, it's possible that someone will
 
1063
        # create a file in this interval and then the rename might be
 
1064
        # left half-done.  But we should have caught most problems.
 
1065
 
 
1066
        for f in from_paths:
 
1067
            name_tail = splitpath(f)[-1]
 
1068
            dest_path = appendpath(to_name, name_tail)
 
1069
            result.append((f, dest_path))
 
1070
            inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
1071
            try:
 
1072
                rename(self.abspath(f), self.abspath(dest_path))
 
1073
            except OSError, e:
 
1074
                raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
 
1075
                        ["rename rolled back"])
 
1076
 
 
1077
        self._write_inventory(inv)
 
1078
        return result
 
1079
 
 
1080
 
 
1081
    def revert(self, filenames, old_tree=None, backups=True):
 
1082
        """Restore selected files to the versions from a previous tree.
 
1083
 
 
1084
        backups
 
1085
            If true (default) backups are made of files before
 
1086
            they're renamed.
 
1087
        """
 
1088
        from bzrlib.atomicfile import AtomicFile
 
1089
        from bzrlib.osutils import backup_file
 
1090
        
 
1091
        inv = self.read_working_inventory()
 
1092
        if old_tree is None:
 
1093
            old_tree = self.basis_tree()
 
1094
        old_inv = old_tree.inventory
 
1095
 
 
1096
        nids = []
 
1097
        for fn in filenames:
 
1098
            file_id = inv.path2id(fn)
 
1099
            if not file_id:
 
1100
                raise NotVersionedError(path=fn)
 
1101
            if not old_inv.has_id(file_id):
 
1102
                raise BzrError("file not present in old tree", fn, file_id)
 
1103
            nids.append((fn, file_id))
 
1104
            
 
1105
        # TODO: Rename back if it was previously at a different location
 
1106
 
 
1107
        # TODO: If given a directory, restore the entire contents from
 
1108
        # the previous version.
 
1109
 
 
1110
        # TODO: Make a backup to a temporary file.
 
1111
 
 
1112
        # TODO: If the file previously didn't exist, delete it?
 
1113
        for fn, file_id in nids:
 
1114
            backup_file(fn)
 
1115
            
 
1116
            f = AtomicFile(fn, 'wb')
 
1117
            try:
 
1118
                f.write(old_tree.get_file(file_id).read())
 
1119
                f.commit()
 
1120
            finally:
 
1121
                f.close()
 
1122
 
 
1123
 
 
1124
    def pending_merges(self):
 
1125
        """Return a list of pending merges.
 
1126
 
 
1127
        These are revisions that have been merged into the working
 
1128
        directory but not yet committed.
 
1129
        """
 
1130
        cfn = self._rel_controlfilename('pending-merges')
 
1131
        if not self._transport.has(cfn):
 
1132
            return []
 
1133
        p = []
 
1134
        for l in self.controlfile('pending-merges', 'r').readlines():
 
1135
            p.append(l.rstrip('\n'))
 
1136
        return p
 
1137
 
 
1138
 
 
1139
    def add_pending_merge(self, *revision_ids):
 
1140
        # TODO: Perhaps should check at this point that the
 
1141
        # history of the revision is actually present?
 
1142
        p = self.pending_merges()
 
1143
        updated = False
 
1144
        for rev_id in revision_ids:
 
1145
            if rev_id in p:
 
1146
                continue
 
1147
            p.append(rev_id)
 
1148
            updated = True
 
1149
        if updated:
 
1150
            self.set_pending_merges(p)
 
1151
 
 
1152
    @needs_write_lock
 
1153
    def set_pending_merges(self, rev_list):
 
1154
        self.put_controlfile('pending-merges', '\n'.join(rev_list))
 
1155
 
 
1156
    def get_parent(self):
 
1157
        """Return the parent location of the branch.
 
1158
 
 
1159
        This is the default location for push/pull/missing.  The usual
 
1160
        pattern is that the user can override it by specifying a
 
1161
        location.
 
1162
        """
 
1163
        import errno
 
1164
        _locs = ['parent', 'pull', 'x-pull']
 
1165
        for l in _locs:
 
1166
            try:
 
1167
                return self.controlfile(l, 'r').read().strip('\n')
 
1168
            except IOError, e:
 
1169
                if e.errno != errno.ENOENT:
 
1170
                    raise
 
1171
        return None
 
1172
 
 
1173
    @needs_write_lock
 
1174
    def set_parent(self, url):
 
1175
        # TODO: Maybe delete old location files?
 
1176
        from bzrlib.atomicfile import AtomicFile
 
1177
        f = AtomicFile(self.controlfilename('parent'))
 
1178
        try:
 
1179
            f.write(url + '\n')
 
1180
            f.commit()
 
1181
        finally:
 
1182
            f.close()
 
1183
 
 
1184
    def check_revno(self, revno):
 
1185
        """\
 
1186
        Check whether a revno corresponds to any revision.
 
1187
        Zero (the NULL revision) is considered valid.
 
1188
        """
 
1189
        if revno != 0:
 
1190
            self.check_real_revno(revno)
 
1191
            
 
1192
    def check_real_revno(self, revno):
 
1193
        """\
 
1194
        Check whether a revno corresponds to a real revision.
 
1195
        Zero (the NULL revision) is considered invalid
 
1196
        """
 
1197
        if revno < 1 or revno > self.revno():
 
1198
            raise InvalidRevisionNumber(revno)
 
1199
        
 
1200
    def sign_revision(self, revision_id, gpg_strategy):
 
1201
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
1202
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
1203
 
 
1204
    @needs_write_lock
 
1205
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
1206
        self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)), 
 
1207
                                revision_id, "sig")
 
1208
 
 
1209
 
 
1210
class ScratchBranch(_Branch):
757
1211
    """Special test class: a branch that cleans up after itself.
758
1212
 
759
1213
    >>> b = ScratchBranch()
760
1214
    >>> isdir(b.base)
761
1215
    True
762
1216
    >>> bd = b.base
763
 
    >>> del b
 
1217
    >>> b._transport.__del__()
764
1218
    >>> isdir(bd)
765
1219
    False
766
1220
    """
767
 
    def __init__(self, files = []):
 
1221
 
 
1222
    def __init__(self, files=[], dirs=[], transport=None):
768
1223
        """Make a test branch.
769
1224
 
770
1225
        This creates a temporary directory and runs init-tree in it.
771
1226
 
772
1227
        If any files are listed, they are created in the working copy.
773
1228
        """
774
 
        Branch.__init__(self, tempfile.mkdtemp(), init=True)
 
1229
        if transport is None:
 
1230
            transport = bzrlib.transport.local.ScratchTransport()
 
1231
            super(ScratchBranch, self).__init__(transport, init=True)
 
1232
        else:
 
1233
            super(ScratchBranch, self).__init__(transport)
 
1234
 
 
1235
        for d in dirs:
 
1236
            self._transport.mkdir(d)
 
1237
            
775
1238
        for f in files:
776
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
777
 
 
778
 
 
779
 
    def __del__(self):
780
 
        """Destroy the test branch, removing the scratch directory."""
781
 
        shutil.rmtree(self.base)
782
 
 
 
1239
            self._transport.put(f, 'content of %s' % f)
 
1240
 
 
1241
 
 
1242
    def clone(self):
 
1243
        """
 
1244
        >>> orig = ScratchBranch(files=["file1", "file2"])
 
1245
        >>> clone = orig.clone()
 
1246
        >>> if os.name != 'nt':
 
1247
        ...   os.path.samefile(orig.base, clone.base)
 
1248
        ... else:
 
1249
        ...   orig.base == clone.base
 
1250
        ...
 
1251
        False
 
1252
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
 
1253
        True
 
1254
        """
 
1255
        from shutil import copytree
 
1256
        from tempfile import mkdtemp
 
1257
        base = mkdtemp()
 
1258
        os.rmdir(base)
 
1259
        copytree(self.base, base, symlinks=True)
 
1260
        return ScratchBranch(
 
1261
            transport=bzrlib.transport.local.ScratchTransport(base))
783
1262
    
784
1263
 
785
1264
######################################################################
801
1280
 
802
1281
 
803
1282
 
804
 
def _gen_revision_id(when):
805
 
    """Return new revision-id."""
806
 
    s = '%s-%s-' % (user_email(), compact_date(when))
807
 
    s += hexlify(rand_bytes(8))
808
 
    return s
809
 
 
810
 
 
811
1283
def gen_file_id(name):
812
1284
    """Return new file id.
813
1285
 
814
1286
    This should probably generate proper UUIDs, but for the moment we
815
1287
    cope with just randomness because running uuidgen every time is
816
1288
    slow."""
 
1289
    import re
 
1290
    from binascii import hexlify
 
1291
    from time import time
 
1292
 
 
1293
    # get last component
817
1294
    idx = name.rfind('/')
818
1295
    if idx != -1:
819
1296
        name = name[idx+1 : ]
 
1297
    idx = name.rfind('\\')
 
1298
    if idx != -1:
 
1299
        name = name[idx+1 : ]
820
1300
 
 
1301
    # make it not a hidden file
821
1302
    name = name.lstrip('.')
822
1303
 
 
1304
    # remove any wierd characters; we don't escape them but rather
 
1305
    # just pull them out
 
1306
    name = re.sub(r'[^\w.]', '', name)
 
1307
 
823
1308
    s = hexlify(rand_bytes(8))
824
 
    return '-'.join((name, compact_date(time.time()), s))
 
1309
    return '-'.join((name, compact_date(time()), s))
 
1310
 
 
1311
 
 
1312
def gen_root_id():
 
1313
    """Return a new tree-root file id."""
 
1314
    return gen_file_id('TREE_ROOT')
825
1315
 
826
1316