/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

add ghost aware apis to knits.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from copy import deepcopy
 
18
from cStringIO import StringIO
 
19
from unittest import TestSuite
 
20
import xml.sax.saxutils
 
21
 
 
22
import bzrlib.bzrdir as bzrdir
 
23
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
24
import bzrlib.errors as errors
 
25
from bzrlib.errors import InvalidRevisionId
 
26
import bzrlib.gpg as gpg
 
27
from bzrlib.graph import Graph
 
28
from bzrlib.inter import InterObject
 
29
from bzrlib.knit import KnitVersionedFile
 
30
from bzrlib.lockable_files import LockableFiles, TransportLock
 
31
from bzrlib.lockdir import LockDir
 
32
from bzrlib.osutils import safe_unicode
 
33
from bzrlib.revision import NULL_REVISION
 
34
from bzrlib.store.versioned import VersionedFileStore, WeaveStore
 
35
from bzrlib.store.text import TextStore
 
36
from bzrlib.symbol_versioning import *
 
37
from bzrlib.trace import mutter
 
38
from bzrlib.tree import RevisionTree
 
39
from bzrlib.tsort import topo_sort
 
40
from bzrlib.testament import Testament
 
41
from bzrlib.tree import EmptyTree
 
42
import bzrlib.ui
 
43
from bzrlib.weave import WeaveFile
 
44
import bzrlib.xml5
 
45
 
 
46
 
 
47
class Repository(object):
 
48
    """Repository holding history for one or more branches.
 
49
 
 
50
    The repository holds and retrieves historical information including
 
51
    revisions and file history.  It's normally accessed only by the Branch,
 
52
    which views a particular line of development through that history.
 
53
 
 
54
    The Repository builds on top of Stores and a Transport, which respectively 
 
55
    describe the disk data format and the way of accessing the (possibly 
 
56
    remote) disk.
 
57
    """
 
58
 
 
59
    @needs_write_lock
 
60
    def add_inventory(self, revid, inv, parents):
 
61
        """Add the inventory inv to the repository as revid.
 
62
        
 
63
        :param parents: The revision ids of the parents that revid
 
64
                        is known to have and are in the repository already.
 
65
 
 
66
        returns the sha1 of the serialized inventory.
 
67
        """
 
68
        inv_text = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
69
        inv_sha1 = bzrlib.osutils.sha_string(inv_text)
 
70
        inv_vf = self.control_weaves.get_weave('inventory',
 
71
                                               self.get_transaction())
 
72
        inv_vf.add_lines(revid, parents, bzrlib.osutils.split_lines(inv_text))
 
73
        return inv_sha1
 
74
 
 
75
    @needs_write_lock
 
76
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
77
        """Add rev to the revision store as rev_id.
 
78
 
 
79
        :param rev_id: the revision id to use.
 
80
        :param rev: The revision object.
 
81
        :param inv: The inventory for the revision. if None, it will be looked
 
82
                    up in the inventory storer
 
83
        :param config: If None no digital signature will be created.
 
84
                       If supplied its signature_needed method will be used
 
85
                       to determine if a signature should be made.
 
86
        """
 
87
        if config is not None and config.signature_needed():
 
88
            if inv is None:
 
89
                inv = self.get_inventory(rev_id)
 
90
            plaintext = Testament(rev, inv).as_short_text()
 
91
            self.store_revision_signature(
 
92
                gpg.GPGStrategy(config), plaintext, rev_id)
 
93
        if not rev_id in self.get_inventory_weave():
 
94
            if inv is None:
 
95
                raise errors.WeaveRevisionNotPresent(rev_id,
 
96
                                                     self.get_inventory_weave())
 
97
            else:
 
98
                # yes, this is not suitable for adding with ghosts.
 
99
                self.add_inventory(rev_id, inv, rev.parent_ids)
 
100
        self._revision_store.add_revision(rev, self.get_transaction())   
 
101
 
 
102
    @needs_read_lock
 
103
    def _all_possible_ids(self):
 
104
        """Return all the possible revisions that we could find."""
 
105
        return self.get_inventory_weave().versions()
 
106
 
 
107
    @needs_read_lock
 
108
    def all_revision_ids(self):
 
109
        """Returns a list of all the revision ids in the repository. 
 
110
 
 
111
        These are in as much topological order as the underlying store can 
 
112
        present: for weaves ghosts may lead to a lack of correctness until
 
113
        the reweave updates the parents list.
 
114
        """
 
115
        if self._revision_store.text_store.listable():
 
116
            return self._revision_store.all_revision_ids(self.get_transaction())
 
117
        result = self._all_possible_ids()
 
118
        return self._eliminate_revisions_not_present(result)
 
119
 
 
120
    @needs_read_lock
 
121
    def _eliminate_revisions_not_present(self, revision_ids):
 
122
        """Check every revision id in revision_ids to see if we have it.
 
123
 
 
124
        Returns a set of the present revisions.
 
125
        """
 
126
        result = []
 
127
        for id in revision_ids:
 
128
            if self.has_revision(id):
 
129
               result.append(id)
 
130
        return result
 
131
 
 
132
    @staticmethod
 
133
    def create(a_bzrdir):
 
134
        """Construct the current default format repository in a_bzrdir."""
 
135
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
 
136
 
 
137
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
138
        """instantiate a Repository.
 
139
 
 
140
        :param _format: The format of the repository on disk.
 
141
        :param a_bzrdir: The BzrDir of the repository.
 
142
 
 
143
        In the future we will have a single api for all stores for
 
144
        getting file texts, inventories and revisions, then
 
145
        this construct will accept instances of those things.
 
146
        """
 
147
        object.__init__(self)
 
148
        self._format = _format
 
149
        # the following are part of the public API for Repository:
 
150
        self.bzrdir = a_bzrdir
 
151
        self.control_files = control_files
 
152
        self._revision_store = _revision_store
 
153
        self.text_store = text_store
 
154
        # backwards compatability
 
155
        self.weave_store = text_store
 
156
        # not right yet - should be more semantically clear ? 
 
157
        # 
 
158
        self.control_store = control_store
 
159
        self.control_weaves = control_store
 
160
 
 
161
    def lock_write(self):
 
162
        self.control_files.lock_write()
 
163
 
 
164
    def lock_read(self):
 
165
        self.control_files.lock_read()
 
166
 
 
167
    def is_locked(self):
 
168
        return self.control_files.is_locked()
 
169
 
 
170
    @needs_read_lock
 
171
    def missing_revision_ids(self, other, revision_id=None):
 
172
        """Return the revision ids that other has that this does not.
 
173
        
 
174
        These are returned in topological order.
 
175
 
 
176
        revision_id: only return revision ids included by revision_id.
 
177
        """
 
178
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
179
 
 
180
    @staticmethod
 
181
    def open(base):
 
182
        """Open the repository rooted at base.
 
183
 
 
184
        For instance, if the repository is at URL/.bzr/repository,
 
185
        Repository.open(URL) -> a Repository instance.
 
186
        """
 
187
        control = bzrlib.bzrdir.BzrDir.open(base)
 
188
        return control.open_repository()
 
189
 
 
190
    def copy_content_into(self, destination, revision_id=None, basis=None):
 
191
        """Make a complete copy of the content in self into destination.
 
192
        
 
193
        This is a destructive operation! Do not use it on existing 
 
194
        repositories.
 
195
        """
 
196
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
 
197
 
 
198
    def fetch(self, source, revision_id=None, pb=None):
 
199
        """Fetch the content required to construct revision_id from source.
 
200
 
 
201
        If revision_id is None all content is copied.
 
202
        """
 
203
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
 
204
                                                       pb=pb)
 
205
 
 
206
    def unlock(self):
 
207
        self.control_files.unlock()
 
208
 
 
209
    @needs_read_lock
 
210
    def clone(self, a_bzrdir, revision_id=None, basis=None):
 
211
        """Clone this repository into a_bzrdir using the current format.
 
212
 
 
213
        Currently no check is made that the format of this repository and
 
214
        the bzrdir format are compatible. FIXME RBC 20060201.
 
215
        """
 
216
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
217
            # use target default format.
 
218
            result = a_bzrdir.create_repository()
 
219
        # FIXME RBC 20060209 split out the repository type to avoid this check ?
 
220
        elif isinstance(a_bzrdir._format,
 
221
                      (bzrlib.bzrdir.BzrDirFormat4,
 
222
                       bzrlib.bzrdir.BzrDirFormat5,
 
223
                       bzrlib.bzrdir.BzrDirFormat6)):
 
224
            result = a_bzrdir.open_repository()
 
225
        else:
 
226
            result = self._format.initialize(a_bzrdir, shared=self.is_shared())
 
227
        self.copy_content_into(result, revision_id, basis)
 
228
        return result
 
229
 
 
230
    @needs_read_lock
 
231
    def has_revision(self, revision_id):
 
232
        """True if this repository has a copy of the revision."""
 
233
        return self._revision_store.has_revision_id(revision_id,
 
234
                                                    self.get_transaction())
 
235
 
 
236
    @needs_read_lock
 
237
    def get_revision_reconcile(self, revision_id):
 
238
        """'reconcile' helper routine that allows access to a revision always.
 
239
        
 
240
        This variant of get_revision does not cross check the weave graph
 
241
        against the revision one as get_revision does: but it should only
 
242
        be used by reconcile, or reconcile-alike commands that are correcting
 
243
        or testing the revision graph.
 
244
        """
 
245
        if not revision_id or not isinstance(revision_id, basestring):
 
246
            raise InvalidRevisionId(revision_id=revision_id, branch=self)
 
247
        return self._revision_store.get_revision(revision_id,
 
248
                                                 self.get_transaction())
 
249
 
 
250
    @needs_read_lock
 
251
    def get_revision_xml(self, revision_id):
 
252
        rev = self.get_revision(revision_id) 
 
253
        rev_tmp = StringIO()
 
254
        # the current serializer..
 
255
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
256
        rev_tmp.seek(0)
 
257
        return rev_tmp.getvalue()
 
258
 
 
259
    @needs_read_lock
 
260
    def get_revision(self, revision_id):
 
261
        """Return the Revision object for a named revision"""
 
262
        r = self.get_revision_reconcile(revision_id)
 
263
        # weave corruption can lead to absent revision markers that should be
 
264
        # present.
 
265
        # the following test is reasonably cheap (it needs a single weave read)
 
266
        # and the weave is cached in read transactions. In write transactions
 
267
        # it is not cached but typically we only read a small number of
 
268
        # revisions. For knits when they are introduced we will probably want
 
269
        # to ensure that caching write transactions are in use.
 
270
        inv = self.get_inventory_weave()
 
271
        self._check_revision_parents(r, inv)
 
272
        return r
 
273
 
 
274
    def _check_revision_parents(self, revision, inventory):
 
275
        """Private to Repository and Fetch.
 
276
        
 
277
        This checks the parentage of revision in an inventory weave for 
 
278
        consistency and is only applicable to inventory-weave-for-ancestry
 
279
        using repository formats & fetchers.
 
280
        """
 
281
        weave_parents = inventory.get_parents(revision.revision_id)
 
282
        weave_names = inventory.versions()
 
283
        for parent_id in revision.parent_ids:
 
284
            if parent_id in weave_names:
 
285
                # this parent must not be a ghost.
 
286
                if not parent_id in weave_parents:
 
287
                    # but it is a ghost
 
288
                    raise errors.CorruptRepository(self)
 
289
 
 
290
    @needs_write_lock
 
291
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
292
        signature = gpg_strategy.sign(plaintext)
 
293
        self._revision_store.add_revision_signature_text(revision_id,
 
294
                                                         signature,
 
295
                                                         self.get_transaction())
 
296
 
 
297
    def fileid_involved_between_revs(self, from_revid, to_revid):
 
298
        """Find file_id(s) which are involved in the changes between revisions.
 
299
 
 
300
        This determines the set of revisions which are involved, and then
 
301
        finds all file ids affected by those revisions.
 
302
        """
 
303
        w = self.get_inventory_weave()
 
304
        from_set = set(w.get_ancestry(from_revid))
 
305
        to_set = set(w.get_ancestry(to_revid))
 
306
        changed = to_set.difference(from_set)
 
307
        return self._fileid_involved_by_set(changed)
 
308
 
 
309
    def fileid_involved(self, last_revid=None):
 
310
        """Find all file_ids modified in the ancestry of last_revid.
 
311
 
 
312
        :param last_revid: If None, last_revision() will be used.
 
313
        """
 
314
        w = self.get_inventory_weave()
 
315
        if not last_revid:
 
316
            changed = set(w.versions())
 
317
        else:
 
318
            changed = set(w.get_ancestry(last_revid))
 
319
        return self._fileid_involved_by_set(changed)
 
320
 
 
321
    def fileid_involved_by_set(self, changes):
 
322
        """Find all file_ids modified by the set of revisions passed in.
 
323
 
 
324
        :param changes: A set() of revision ids
 
325
        """
 
326
        # TODO: jam 20060119 This line does *nothing*, remove it.
 
327
        #       or better yet, change _fileid_involved_by_set so
 
328
        #       that it takes the inventory weave, rather than
 
329
        #       pulling it out by itself.
 
330
        return self._fileid_involved_by_set(changes)
 
331
 
 
332
    def _fileid_involved_by_set(self, changes):
 
333
        """Find the set of file-ids affected by the set of revisions.
 
334
 
 
335
        :param changes: A set() of revision ids.
 
336
        :return: A set() of file ids.
 
337
        
 
338
        This peaks at the Weave, interpreting each line, looking to
 
339
        see if it mentions one of the revisions. And if so, includes
 
340
        the file id mentioned.
 
341
        This expects both the Weave format, and the serialization
 
342
        to have a single line per file/directory, and to have
 
343
        fileid="" and revision="" on that line.
 
344
        """
 
345
        assert isinstance(self._format, (RepositoryFormat5,
 
346
                                         RepositoryFormat6,
 
347
                                         RepositoryFormat7,
 
348
                                         RepositoryFormatKnit1)), \
 
349
            "fileid_involved only supported for branches which store inventory as unnested xml"
 
350
 
 
351
        w = self.get_inventory_weave()
 
352
        file_ids = set()
 
353
 
 
354
        # this code needs to read every line in every inventory for the
 
355
        # inventories [changes]. Seeing a line twice is ok. Seeing a line
 
356
        # not pesent in one of those inventories is unnecessary and not 
 
357
        # harmful because we are filtering by the revision id marker in the
 
358
        # inventory lines to only select file ids altered in one of those  
 
359
        # revisions. We dont need to see all lines in the inventory because
 
360
        # only those added in an inventory in rev X can contain a revision=X
 
361
        # line.
 
362
        for line in w.iter_lines_added_or_present_in_versions(changes):
 
363
            start = line.find('file_id="')+9
 
364
            if start < 9: continue
 
365
            end = line.find('"', start)
 
366
            assert end>= 0
 
367
            file_id = xml.sax.saxutils.unescape(line[start:end])
 
368
 
 
369
            # check if file_id is already present
 
370
            if file_id in file_ids: continue
 
371
 
 
372
            start = line.find('revision="')+10
 
373
            if start < 10: continue
 
374
            end = line.find('"', start)
 
375
            assert end>= 0
 
376
            revision_id = xml.sax.saxutils.unescape(line[start:end])
 
377
 
 
378
            if revision_id in changes:
 
379
                file_ids.add(file_id)
 
380
        return file_ids
 
381
 
 
382
    @needs_read_lock
 
383
    def get_inventory_weave(self):
 
384
        return self.control_weaves.get_weave('inventory',
 
385
            self.get_transaction())
 
386
 
 
387
    @needs_read_lock
 
388
    def get_inventory(self, revision_id):
 
389
        """Get Inventory object by hash."""
 
390
        xml = self.get_inventory_xml(revision_id)
 
391
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
392
 
 
393
    @needs_read_lock
 
394
    def get_inventory_xml(self, revision_id):
 
395
        """Get inventory XML as a file object."""
 
396
        try:
 
397
            assert isinstance(revision_id, basestring), type(revision_id)
 
398
            iw = self.get_inventory_weave()
 
399
            return iw.get_text(revision_id)
 
400
        except IndexError:
 
401
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
402
 
 
403
    @needs_read_lock
 
404
    def get_inventory_sha1(self, revision_id):
 
405
        """Return the sha1 hash of the inventory entry
 
406
        """
 
407
        return self.get_revision(revision_id).inventory_sha1
 
408
 
 
409
    @needs_read_lock
 
410
    def get_revision_graph(self, revision_id=None):
 
411
        """Return a dictionary containing the revision graph.
 
412
        
 
413
        :return: a dictionary of revision_id->revision_parents_list.
 
414
        """
 
415
        weave = self.get_inventory_weave()
 
416
        all_revisions = self._eliminate_revisions_not_present(weave.versions())
 
417
        entire_graph = dict([(node, weave.get_parents(node)) for 
 
418
                             node in all_revisions])
 
419
        if revision_id is None:
 
420
            return entire_graph
 
421
        elif revision_id not in entire_graph:
 
422
            raise errors.NoSuchRevision(self, revision_id)
 
423
        else:
 
424
            # add what can be reached from revision_id
 
425
            result = {}
 
426
            pending = set([revision_id])
 
427
            while len(pending) > 0:
 
428
                node = pending.pop()
 
429
                result[node] = entire_graph[node]
 
430
                for revision_id in result[node]:
 
431
                    if revision_id not in result:
 
432
                        pending.add(revision_id)
 
433
            return result
 
434
 
 
435
    @needs_read_lock
 
436
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
437
        """Return a graph of the revisions with ghosts marked as applicable.
 
438
 
 
439
        :param revision_ids: an iterable of revisions to graph or None for all.
 
440
        :return: a Graph object with the graph reachable from revision_ids.
 
441
        """
 
442
        result = Graph()
 
443
        if not revision_ids:
 
444
            pending = set(self.all_revision_ids())
 
445
            required = set([])
 
446
        else:
 
447
            pending = set(revision_ids)
 
448
            required = set(revision_ids)
 
449
        done = set([])
 
450
        while len(pending):
 
451
            revision_id = pending.pop()
 
452
            try:
 
453
                rev = self.get_revision(revision_id)
 
454
            except errors.NoSuchRevision:
 
455
                if revision_id in required:
 
456
                    raise
 
457
                # a ghost
 
458
                result.add_ghost(revision_id)
 
459
                continue
 
460
            for parent_id in rev.parent_ids:
 
461
                # is this queued or done ?
 
462
                if (parent_id not in pending and
 
463
                    parent_id not in done):
 
464
                    # no, queue it.
 
465
                    pending.add(parent_id)
 
466
            result.add_node(revision_id, rev.parent_ids)
 
467
            done.add(result)
 
468
        return result
 
469
 
 
470
    @needs_read_lock
 
471
    def get_revision_inventory(self, revision_id):
 
472
        """Return inventory of a past revision."""
 
473
        # TODO: Unify this with get_inventory()
 
474
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
475
        # must be the same as its revision, so this is trivial.
 
476
        if revision_id is None:
 
477
            # This does not make sense: if there is no revision,
 
478
            # then it is the current tree inventory surely ?!
 
479
            # and thus get_root_id() is something that looks at the last
 
480
            # commit on the branch, and the get_root_id is an inventory check.
 
481
            raise NotImplementedError
 
482
            # return Inventory(self.get_root_id())
 
483
        else:
 
484
            return self.get_inventory(revision_id)
 
485
 
 
486
    @needs_read_lock
 
487
    def is_shared(self):
 
488
        """Return True if this repository is flagged as a shared repository."""
 
489
        # FIXME format 4-6 cannot be shared, this is technically faulty.
 
490
        return self.control_files._transport.has('shared-storage')
 
491
 
 
492
    @needs_write_lock
 
493
    def reconcile(self):
 
494
        """Reconcile this repository."""
 
495
        from bzrlib.reconcile import RepoReconciler
 
496
        reconciler = RepoReconciler(self)
 
497
        reconciler.reconcile()
 
498
        return reconciler
 
499
    
 
500
    @needs_read_lock
 
501
    def revision_tree(self, revision_id):
 
502
        """Return Tree for a revision on this branch.
 
503
 
 
504
        `revision_id` may be None for the null revision, in which case
 
505
        an `EmptyTree` is returned."""
 
506
        # TODO: refactor this to use an existing revision object
 
507
        # so we don't need to read it in twice.
 
508
        if revision_id is None or revision_id == NULL_REVISION:
 
509
            return EmptyTree()
 
510
        else:
 
511
            inv = self.get_revision_inventory(revision_id)
 
512
            return RevisionTree(self, inv, revision_id)
 
513
 
 
514
    @needs_read_lock
 
515
    def get_ancestry(self, revision_id):
 
516
        """Return a list of revision-ids integrated by a revision.
 
517
        
 
518
        This is topologically sorted.
 
519
        """
 
520
        if revision_id is None:
 
521
            return [None]
 
522
        if not self.has_revision(revision_id):
 
523
            raise errors.NoSuchRevision(self, revision_id)
 
524
        w = self.get_inventory_weave()
 
525
        return [None] + w.get_ancestry(revision_id)
 
526
 
 
527
    @needs_read_lock
 
528
    def print_file(self, file, revision_id):
 
529
        """Print `file` to stdout.
 
530
        
 
531
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
532
        - it writes to stdout, it assumes that that is valid etc. Fix
 
533
        by creating a new more flexible convenience function.
 
534
        """
 
535
        tree = self.revision_tree(revision_id)
 
536
        # use inventory as it was in that revision
 
537
        file_id = tree.inventory.path2id(file)
 
538
        if not file_id:
 
539
            raise BzrError("%r is not present in revision %s" % (file, revno))
 
540
            try:
 
541
                revno = self.revision_id_to_revno(revision_id)
 
542
            except errors.NoSuchRevision:
 
543
                # TODO: This should not be BzrError,
 
544
                # but NoSuchFile doesn't fit either
 
545
                raise BzrError('%r is not present in revision %s' 
 
546
                                % (file, revision_id))
 
547
            else:
 
548
                raise BzrError('%r is not present in revision %s'
 
549
                                % (file, revno))
 
550
        tree.print_file(file_id)
 
551
 
 
552
    def get_transaction(self):
 
553
        return self.control_files.get_transaction()
 
554
 
 
555
    def revision_parents(self, revid):
 
556
        return self.get_inventory_weave().parent_names(revid)
 
557
 
 
558
    @needs_write_lock
 
559
    def set_make_working_trees(self, new_value):
 
560
        """Set the policy flag for making working trees when creating branches.
 
561
 
 
562
        This only applies to branches that use this repository.
 
563
 
 
564
        The default is 'True'.
 
565
        :param new_value: True to restore the default, False to disable making
 
566
                          working trees.
 
567
        """
 
568
        # FIXME: split out into a new class/strategy ?
 
569
        if isinstance(self._format, (RepositoryFormat4,
 
570
                                     RepositoryFormat5,
 
571
                                     RepositoryFormat6)):
 
572
            raise NotImplementedError(self.set_make_working_trees)
 
573
        if new_value:
 
574
            try:
 
575
                self.control_files._transport.delete('no-working-trees')
 
576
            except errors.NoSuchFile:
 
577
                pass
 
578
        else:
 
579
            self.control_files.put_utf8('no-working-trees', '')
 
580
    
 
581
    def make_working_trees(self):
 
582
        """Returns the policy for making working trees on new branches."""
 
583
        # FIXME: split out into a new class/strategy ?
 
584
        if isinstance(self._format, (RepositoryFormat4,
 
585
                                     RepositoryFormat5,
 
586
                                     RepositoryFormat6)):
 
587
            return True
 
588
        return not self.control_files._transport.has('no-working-trees')
 
589
 
 
590
    @needs_write_lock
 
591
    def sign_revision(self, revision_id, gpg_strategy):
 
592
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
593
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
594
 
 
595
    @needs_read_lock
 
596
    def has_signature_for_revision_id(self, revision_id):
 
597
        """Query for a revision signature for revision_id in the repository."""
 
598
        return self._revision_store.has_signature(revision_id,
 
599
                                                  self.get_transaction())
 
600
 
 
601
    @needs_read_lock
 
602
    def get_signature_text(self, revision_id):
 
603
        """Return the text for a signature."""
 
604
        return self._revision_store.get_signature_text(revision_id,
 
605
                                                       self.get_transaction())
 
606
 
 
607
 
 
608
class AllInOneRepository(Repository):
 
609
    """Legacy support - the repository behaviour for all-in-one branches."""
 
610
 
 
611
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
 
612
        # we reuse one control files instance.
 
613
        dir_mode = a_bzrdir._control_files._dir_mode
 
614
        file_mode = a_bzrdir._control_files._file_mode
 
615
 
 
616
        def get_weave(name, prefixed=False):
 
617
            if name:
 
618
                name = safe_unicode(name)
 
619
            else:
 
620
                name = ''
 
621
            relpath = a_bzrdir._control_files._escape(name)
 
622
            weave_transport = a_bzrdir._control_files._transport.clone(relpath)
 
623
            ws = WeaveStore(weave_transport, prefixed=prefixed,
 
624
                            dir_mode=dir_mode,
 
625
                            file_mode=file_mode)
 
626
            if a_bzrdir._control_files._transport.should_cache():
 
627
                ws.enable_cache = True
 
628
            return ws
 
629
 
 
630
        def get_store(name, compressed=True, prefixed=False):
 
631
            # FIXME: This approach of assuming stores are all entirely compressed
 
632
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
633
            # some existing branches where there's a mixture; we probably 
 
634
            # still want the option to look for both.
 
635
            relpath = a_bzrdir._control_files._escape(name)
 
636
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
 
637
                              prefixed=prefixed, compressed=compressed,
 
638
                              dir_mode=dir_mode,
 
639
                              file_mode=file_mode)
 
640
            #if self._transport.should_cache():
 
641
            #    cache_path = os.path.join(self.cache_root, name)
 
642
            #    os.mkdir(cache_path)
 
643
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
644
            return store
 
645
 
 
646
        # not broken out yet because the controlweaves|inventory_store
 
647
        # and text_store | weave_store bits are still different.
 
648
        if isinstance(_format, RepositoryFormat4):
 
649
            # cannot remove these - there is still no consistent api 
 
650
            # which allows access to this old info.
 
651
            self.inventory_store = get_store('inventory-store')
 
652
            text_store = get_store('text-store')
 
653
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
 
654
 
 
655
 
 
656
class MetaDirRepository(Repository):
 
657
    """Repositories in the new meta-dir layout."""
 
658
 
 
659
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
660
        super(MetaDirRepository, self).__init__(_format,
 
661
                                                a_bzrdir,
 
662
                                                control_files,
 
663
                                                _revision_store,
 
664
                                                control_store,
 
665
                                                text_store)
 
666
 
 
667
        dir_mode = self.control_files._dir_mode
 
668
        file_mode = self.control_files._file_mode
 
669
 
 
670
        def get_weave(name, prefixed=False):
 
671
            if name:
 
672
                name = safe_unicode(name)
 
673
            else:
 
674
                name = ''
 
675
            relpath = self.control_files._escape(name)
 
676
            weave_transport = self.control_files._transport.clone(relpath)
 
677
            ws = WeaveStore(weave_transport, prefixed=prefixed,
 
678
                            dir_mode=dir_mode,
 
679
                            file_mode=file_mode)
 
680
            if self.control_files._transport.should_cache():
 
681
                ws.enable_cache = True
 
682
            return ws
 
683
 
 
684
 
 
685
class KnitRepository(MetaDirRepository):
 
686
    """Knit format repository."""
 
687
 
 
688
    @needs_read_lock
 
689
    def all_revision_ids(self):
 
690
        """See Repository.all_revision_ids()."""
 
691
        return self._revision_store.all_revision_ids(self.get_transaction())
 
692
 
 
693
    @needs_read_lock
 
694
    def get_ancestry(self, revision_id):
 
695
        """Return a list of revision-ids integrated by a revision.
 
696
        
 
697
        This is topologically sorted.
 
698
        """
 
699
        if revision_id is None:
 
700
            return [None]
 
701
        vf = self._revision_store.get_revision_file(self.get_transaction())
 
702
        return [None] + vf.get_ancestry(revision_id)
 
703
 
 
704
    @needs_write_lock
 
705
    def reconcile(self):
 
706
        """Reconcile this repository."""
 
707
        from bzrlib.reconcile import KnitReconciler
 
708
        reconciler = KnitReconciler(self)
 
709
        reconciler.reconcile()
 
710
        return reconciler
 
711
    
 
712
 
 
713
class RepositoryFormat(object):
 
714
    """A repository format.
 
715
 
 
716
    Formats provide three things:
 
717
     * An initialization routine to construct repository data on disk.
 
718
     * a format string which is used when the BzrDir supports versioned
 
719
       children.
 
720
     * an open routine which returns a Repository instance.
 
721
 
 
722
    Formats are placed in an dict by their format string for reference 
 
723
    during opening. These should be subclasses of RepositoryFormat
 
724
    for consistency.
 
725
 
 
726
    Once a format is deprecated, just deprecate the initialize and open
 
727
    methods on the format class. Do not deprecate the object, as the 
 
728
    object will be created every system load.
 
729
 
 
730
    Common instance attributes:
 
731
    _matchingbzrdir - the bzrdir format that the repository format was
 
732
    originally written to work with. This can be used if manually
 
733
    constructing a bzrdir and repository, or more commonly for test suite
 
734
    parameterisation.
 
735
    """
 
736
 
 
737
    _default_format = None
 
738
    """The default format used for new repositories."""
 
739
 
 
740
    _formats = {}
 
741
    """The known formats."""
 
742
 
 
743
    @classmethod
 
744
    def find_format(klass, a_bzrdir):
 
745
        """Return the format for the repository object in a_bzrdir."""
 
746
        try:
 
747
            transport = a_bzrdir.get_repository_transport(None)
 
748
            format_string = transport.get("format").read()
 
749
            return klass._formats[format_string]
 
750
        except errors.NoSuchFile:
 
751
            raise errors.NoRepositoryPresent(a_bzrdir)
 
752
        except KeyError:
 
753
            raise errors.UnknownFormatError(format_string)
 
754
 
 
755
    def _get_control_store(self, repo_transport, control_files):
 
756
        """Return the control store for this repository."""
 
757
        raise NotImplementedError(self._get_control_store)
 
758
    
 
759
    @classmethod
 
760
    def get_default_format(klass):
 
761
        """Return the current default format."""
 
762
        return klass._default_format
 
763
 
 
764
    def get_format_string(self):
 
765
        """Return the ASCII format string that identifies this format.
 
766
        
 
767
        Note that in pre format ?? repositories the format string is 
 
768
        not permitted nor written to disk.
 
769
        """
 
770
        raise NotImplementedError(self.get_format_string)
 
771
 
 
772
    def _get_revision_store(self, repo_transport, control_files):
 
773
        """Return the revision store object for this a_bzrdir."""
 
774
        raise NotImplementedError(self._get_revision_store)
 
775
 
 
776
    def _get_text_rev_store(self,
 
777
                            transport,
 
778
                            control_files,
 
779
                            name,
 
780
                            compressed=True,
 
781
                            prefixed=False,
 
782
                            serializer=None):
 
783
        """Common logic for getting a revision store for a repository.
 
784
        
 
785
        see self._get_revision_store for the subclass-overridable method to 
 
786
        get the store for a repository.
 
787
        """
 
788
        from bzrlib.store.revision.text import TextRevisionStore
 
789
        dir_mode = control_files._dir_mode
 
790
        file_mode = control_files._file_mode
 
791
        text_store =TextStore(transport.clone(name),
 
792
                              prefixed=prefixed,
 
793
                              compressed=compressed,
 
794
                              dir_mode=dir_mode,
 
795
                              file_mode=file_mode)
 
796
        _revision_store = TextRevisionStore(text_store, serializer)
 
797
        return _revision_store
 
798
 
 
799
    def _get_versioned_file_store(self,
 
800
                                  name,
 
801
                                  transport,
 
802
                                  control_files,
 
803
                                  prefixed=True,
 
804
                                  versionedfile_class=WeaveFile):
 
805
        weave_transport = control_files._transport.clone(name)
 
806
        dir_mode = control_files._dir_mode
 
807
        file_mode = control_files._file_mode
 
808
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
809
                                dir_mode=dir_mode,
 
810
                                file_mode=file_mode,
 
811
                                versionedfile_class=versionedfile_class)
 
812
 
 
813
    def initialize(self, a_bzrdir, shared=False):
 
814
        """Initialize a repository of this format in a_bzrdir.
 
815
 
 
816
        :param a_bzrdir: The bzrdir to put the new repository in it.
 
817
        :param shared: The repository should be initialized as a sharable one.
 
818
 
 
819
        This may raise UninitializableFormat if shared repository are not
 
820
        compatible the a_bzrdir.
 
821
        """
 
822
 
 
823
    def is_supported(self):
 
824
        """Is this format supported?
 
825
 
 
826
        Supported formats must be initializable and openable.
 
827
        Unsupported formats may not support initialization or committing or 
 
828
        some other features depending on the reason for not being supported.
 
829
        """
 
830
        return True
 
831
 
 
832
    def open(self, a_bzrdir, _found=False):
 
833
        """Return an instance of this format for the bzrdir a_bzrdir.
 
834
        
 
835
        _found is a private parameter, do not use it.
 
836
        """
 
837
        raise NotImplementedError(self.open)
 
838
 
 
839
    @classmethod
 
840
    def register_format(klass, format):
 
841
        klass._formats[format.get_format_string()] = format
 
842
 
 
843
    @classmethod
 
844
    def set_default_format(klass, format):
 
845
        klass._default_format = format
 
846
 
 
847
    @classmethod
 
848
    def unregister_format(klass, format):
 
849
        assert klass._formats[format.get_format_string()] is format
 
850
        del klass._formats[format.get_format_string()]
 
851
 
 
852
 
 
853
class PreSplitOutRepositoryFormat(RepositoryFormat):
 
854
    """Base class for the pre split out repository formats."""
 
855
 
 
856
    def initialize(self, a_bzrdir, shared=False, _internal=False):
 
857
        """Create a weave repository.
 
858
        
 
859
        TODO: when creating split out bzr branch formats, move this to a common
 
860
        base for Format5, Format6. or something like that.
 
861
        """
 
862
        from bzrlib.weavefile import write_weave_v5
 
863
        from bzrlib.weave import Weave
 
864
 
 
865
        if shared:
 
866
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
867
 
 
868
        if not _internal:
 
869
            # always initialized when the bzrdir is.
 
870
            return self.open(a_bzrdir, _found=True)
 
871
        
 
872
        # Create an empty weave
 
873
        sio = StringIO()
 
874
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
875
        empty_weave = sio.getvalue()
 
876
 
 
877
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
878
        dirs = ['revision-store', 'weaves']
 
879
        files = [('inventory.weave', StringIO(empty_weave)),
 
880
                 ]
 
881
        
 
882
        # FIXME: RBC 20060125 dont peek under the covers
 
883
        # NB: no need to escape relative paths that are url safe.
 
884
        control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
 
885
                                      TransportLock)
 
886
        control_files.create_lock()
 
887
        control_files.lock_write()
 
888
        control_files._transport.mkdir_multi(dirs,
 
889
                mode=control_files._dir_mode)
 
890
        try:
 
891
            for file, content in files:
 
892
                control_files.put(file, content)
 
893
        finally:
 
894
            control_files.unlock()
 
895
        return self.open(a_bzrdir, _found=True)
 
896
 
 
897
    def _get_control_store(self, repo_transport, control_files):
 
898
        """Return the control store for this repository."""
 
899
        return self._get_versioned_file_store('',
 
900
                                              repo_transport,
 
901
                                              control_files,
 
902
                                              prefixed=False)
 
903
 
 
904
    def _get_text_store(self, transport, control_files):
 
905
        """Get a store for file texts for this format."""
 
906
        raise NotImplementedError(self._get_text_store)
 
907
 
 
908
    def open(self, a_bzrdir, _found=False):
 
909
        """See RepositoryFormat.open()."""
 
910
        if not _found:
 
911
            # we are being called directly and must probe.
 
912
            raise NotImplementedError
 
913
 
 
914
        repo_transport = a_bzrdir.get_repository_transport(None)
 
915
        control_files = a_bzrdir._control_files
 
916
        text_store = self._get_text_store(repo_transport, control_files)
 
917
        control_store = self._get_control_store(repo_transport, control_files)
 
918
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
919
        return AllInOneRepository(_format=self,
 
920
                                  a_bzrdir=a_bzrdir,
 
921
                                  _revision_store=_revision_store,
 
922
                                  control_store=control_store,
 
923
                                  text_store=text_store)
 
924
 
 
925
 
 
926
class RepositoryFormat4(PreSplitOutRepositoryFormat):
 
927
    """Bzr repository format 4.
 
928
 
 
929
    This repository format has:
 
930
     - flat stores
 
931
     - TextStores for texts, inventories,revisions.
 
932
 
 
933
    This format is deprecated: it indexes texts using a text id which is
 
934
    removed in format 5; initializationa and write support for this format
 
935
    has been removed.
 
936
    """
 
937
 
 
938
    def __init__(self):
 
939
        super(RepositoryFormat4, self).__init__()
 
940
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat4()
 
941
 
 
942
    def initialize(self, url, shared=False, _internal=False):
 
943
        """Format 4 branches cannot be created."""
 
944
        raise errors.UninitializableFormat(self)
 
945
 
 
946
    def is_supported(self):
 
947
        """Format 4 is not supported.
 
948
 
 
949
        It is not supported because the model changed from 4 to 5 and the
 
950
        conversion logic is expensive - so doing it on the fly was not 
 
951
        feasible.
 
952
        """
 
953
        return False
 
954
 
 
955
    def _get_control_store(self, repo_transport, control_files):
 
956
        """Format 4 repositories have no formal control store at this point.
 
957
        
 
958
        This will cause any control-file-needing apis to fail - this is desired.
 
959
        """
 
960
        return None
 
961
    
 
962
    def _get_revision_store(self, repo_transport, control_files):
 
963
        """See RepositoryFormat._get_revision_store()."""
 
964
        from bzrlib.xml4 import serializer_v4
 
965
        return self._get_text_rev_store(repo_transport,
 
966
                                        control_files,
 
967
                                        'revision-store',
 
968
                                        serializer=serializer_v4)
 
969
 
 
970
    def _get_text_store(self, transport, control_files):
 
971
        """See RepositoryFormat._get_text_store()."""
 
972
 
 
973
 
 
974
class RepositoryFormat5(PreSplitOutRepositoryFormat):
 
975
    """Bzr control format 5.
 
976
 
 
977
    This repository format has:
 
978
     - weaves for file texts and inventory
 
979
     - flat stores
 
980
     - TextStores for revisions and signatures.
 
981
    """
 
982
 
 
983
    def __init__(self):
 
984
        super(RepositoryFormat5, self).__init__()
 
985
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat5()
 
986
 
 
987
    def _get_revision_store(self, repo_transport, control_files):
 
988
        """See RepositoryFormat._get_revision_store()."""
 
989
        """Return the revision store object for this a_bzrdir."""
 
990
        return self._get_text_rev_store(repo_transport,
 
991
                                        control_files,
 
992
                                        'revision-store',
 
993
                                        compressed=False)
 
994
 
 
995
    def _get_text_store(self, transport, control_files):
 
996
        """See RepositoryFormat._get_text_store()."""
 
997
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
 
998
 
 
999
 
 
1000
class RepositoryFormat6(PreSplitOutRepositoryFormat):
 
1001
    """Bzr control format 6.
 
1002
 
 
1003
    This repository format has:
 
1004
     - weaves for file texts and inventory
 
1005
     - hash subdirectory based stores.
 
1006
     - TextStores for revisions and signatures.
 
1007
    """
 
1008
 
 
1009
    def __init__(self):
 
1010
        super(RepositoryFormat6, self).__init__()
 
1011
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat6()
 
1012
 
 
1013
    def _get_revision_store(self, repo_transport, control_files):
 
1014
        """See RepositoryFormat._get_revision_store()."""
 
1015
        return self._get_text_rev_store(repo_transport,
 
1016
                                        control_files,
 
1017
                                        'revision-store',
 
1018
                                        compressed=False,
 
1019
                                        prefixed=True)
 
1020
 
 
1021
    def _get_text_store(self, transport, control_files):
 
1022
        """See RepositoryFormat._get_text_store()."""
 
1023
        return self._get_versioned_file_store('weaves', transport, control_files)
 
1024
 
 
1025
 
 
1026
class MetaDirRepositoryFormat(RepositoryFormat):
 
1027
    """Common base class for the new repositories using the metadir layour."""
 
1028
 
 
1029
    def __init__(self):
 
1030
        super(MetaDirRepositoryFormat, self).__init__()
 
1031
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirMetaFormat1()
 
1032
 
 
1033
    def _create_control_files(self, a_bzrdir):
 
1034
        """Create the required files and the initial control_files object."""
 
1035
        # FIXME: RBC 20060125 dont peek under the covers
 
1036
        # NB: no need to escape relative paths that are url safe.
 
1037
        repository_transport = a_bzrdir.get_repository_transport(self)
 
1038
        control_files = LockableFiles(repository_transport, 'lock', LockDir)
 
1039
        control_files.create_lock()
 
1040
        return control_files
 
1041
 
 
1042
    def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
 
1043
        """Upload the initial blank content."""
 
1044
        control_files = self._create_control_files(a_bzrdir)
 
1045
        control_files.lock_write()
 
1046
        try:
 
1047
            control_files._transport.mkdir_multi(dirs,
 
1048
                    mode=control_files._dir_mode)
 
1049
            for file, content in files:
 
1050
                control_files.put(file, content)
 
1051
            for file, content in utf8_files:
 
1052
                control_files.put_utf8(file, content)
 
1053
            if shared == True:
 
1054
                control_files.put_utf8('shared-storage', '')
 
1055
        finally:
 
1056
            control_files.unlock()
 
1057
 
 
1058
 
 
1059
class RepositoryFormat7(MetaDirRepositoryFormat):
 
1060
    """Bzr repository 7.
 
1061
 
 
1062
    This repository format has:
 
1063
     - weaves for file texts and inventory
 
1064
     - hash subdirectory based stores.
 
1065
     - TextStores for revisions and signatures.
 
1066
     - a format marker of its own
 
1067
     - an optional 'shared-storage' flag
 
1068
     - an optional 'no-working-trees' flag
 
1069
    """
 
1070
 
 
1071
    def _get_control_store(self, repo_transport, control_files):
 
1072
        """Return the control store for this repository."""
 
1073
        return self._get_versioned_file_store('',
 
1074
                                              repo_transport,
 
1075
                                              control_files,
 
1076
                                              prefixed=False)
 
1077
 
 
1078
    def get_format_string(self):
 
1079
        """See RepositoryFormat.get_format_string()."""
 
1080
        return "Bazaar-NG Repository format 7"
 
1081
 
 
1082
    def _get_revision_store(self, repo_transport, control_files):
 
1083
        """See RepositoryFormat._get_revision_store()."""
 
1084
        return self._get_text_rev_store(repo_transport,
 
1085
                                        control_files,
 
1086
                                        'revision-store',
 
1087
                                        compressed=False,
 
1088
                                        prefixed=True,
 
1089
                                        )
 
1090
 
 
1091
    def _get_text_store(self, transport, control_files):
 
1092
        """See RepositoryFormat._get_text_store()."""
 
1093
        return self._get_versioned_file_store('weaves',
 
1094
                                              transport,
 
1095
                                              control_files)
 
1096
 
 
1097
    def initialize(self, a_bzrdir, shared=False):
 
1098
        """Create a weave repository.
 
1099
 
 
1100
        :param shared: If true the repository will be initialized as a shared
 
1101
                       repository.
 
1102
        """
 
1103
        from bzrlib.weavefile import write_weave_v5
 
1104
        from bzrlib.weave import Weave
 
1105
 
 
1106
        # Create an empty weave
 
1107
        sio = StringIO()
 
1108
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
1109
        empty_weave = sio.getvalue()
 
1110
 
 
1111
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1112
        dirs = ['revision-store', 'weaves']
 
1113
        files = [('inventory.weave', StringIO(empty_weave)), 
 
1114
                 ]
 
1115
        utf8_files = [('format', self.get_format_string())]
 
1116
 
 
1117
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1118
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1119
 
 
1120
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1121
        """See RepositoryFormat.open().
 
1122
        
 
1123
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1124
                                    repository at a slightly different url
 
1125
                                    than normal. I.e. during 'upgrade'.
 
1126
        """
 
1127
        if not _found:
 
1128
            format = RepositoryFormat.find_format(a_bzrdir)
 
1129
            assert format.__class__ ==  self.__class__
 
1130
        if _override_transport is not None:
 
1131
            repo_transport = _override_transport
 
1132
        else:
 
1133
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1134
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1135
        text_store = self._get_text_store(repo_transport, control_files)
 
1136
        control_store = self._get_control_store(repo_transport, control_files)
 
1137
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1138
        return MetaDirRepository(_format=self,
 
1139
                                 a_bzrdir=a_bzrdir,
 
1140
                                 control_files=control_files,
 
1141
                                 _revision_store=_revision_store,
 
1142
                                 control_store=control_store,
 
1143
                                 text_store=text_store)
 
1144
 
 
1145
 
 
1146
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
 
1147
    """Bzr repository knit format 1.
 
1148
 
 
1149
    This repository format has:
 
1150
     - knits for file texts and inventory
 
1151
     - hash subdirectory based stores.
 
1152
     - knits for revisions and signatures
 
1153
     - TextStores for revisions and signatures.
 
1154
     - a format marker of its own
 
1155
     - an optional 'shared-storage' flag
 
1156
     - an optional 'no-working-trees' flag
 
1157
     - a LockDir lock
 
1158
    """
 
1159
 
 
1160
    def _get_control_store(self, repo_transport, control_files):
 
1161
        """Return the control store for this repository."""
 
1162
        return self._get_versioned_file_store('',
 
1163
                                              repo_transport,
 
1164
                                              control_files,
 
1165
                                              prefixed=False,
 
1166
                                              versionedfile_class=KnitVersionedFile)
 
1167
 
 
1168
    def get_format_string(self):
 
1169
        """See RepositoryFormat.get_format_string()."""
 
1170
        return "Bazaar-NG Knit Repository Format 1"
 
1171
 
 
1172
    def _get_revision_store(self, repo_transport, control_files):
 
1173
        """See RepositoryFormat._get_revision_store()."""
 
1174
        from bzrlib.store.revision.knit import KnitRevisionStore
 
1175
        versioned_file_store = VersionedFileStore(
 
1176
            repo_transport,
 
1177
            file_mode = control_files._file_mode,
 
1178
            prefixed=False,
 
1179
            precious=True,
 
1180
            versionedfile_class=KnitVersionedFile)
 
1181
        return KnitRevisionStore(versioned_file_store)
 
1182
 
 
1183
    def _get_text_store(self, transport, control_files):
 
1184
        """See RepositoryFormat._get_text_store()."""
 
1185
        return self._get_versioned_file_store('knits',
 
1186
                                              transport,
 
1187
                                              control_files,
 
1188
                                              versionedfile_class=KnitVersionedFile)
 
1189
 
 
1190
    def initialize(self, a_bzrdir, shared=False):
 
1191
        """Create a knit format 1 repository.
 
1192
 
 
1193
        :param shared: If true the repository will be initialized as a shared
 
1194
                       repository.
 
1195
        XXX NOTE that this current uses a Weave for testing and will become 
 
1196
            A Knit in due course.
 
1197
        """
 
1198
        from bzrlib.weavefile import write_weave_v5
 
1199
        from bzrlib.weave import Weave
 
1200
 
 
1201
        # Create an empty weave
 
1202
        sio = StringIO()
 
1203
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
1204
        empty_weave = sio.getvalue()
 
1205
 
 
1206
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1207
        dirs = ['revision-store', 'knits', 'control']
 
1208
        files = [('control/inventory.weave', StringIO(empty_weave)), 
 
1209
                 ]
 
1210
        utf8_files = [('format', self.get_format_string())]
 
1211
        
 
1212
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1213
        repo_transport = a_bzrdir.get_repository_transport(None)
 
1214
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1215
        control_store = self._get_control_store(repo_transport, control_files)
 
1216
        transaction = bzrlib.transactions.PassThroughTransaction()
 
1217
        # trigger a write of the inventory store.
 
1218
        control_store.get_weave_or_empty('inventory', transaction)
 
1219
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1220
        _revision_store.has_revision_id('A', transaction)
 
1221
        _revision_store.get_signature_file(transaction)
 
1222
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1223
 
 
1224
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1225
        """See RepositoryFormat.open().
 
1226
        
 
1227
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1228
                                    repository at a slightly different url
 
1229
                                    than normal. I.e. during 'upgrade'.
 
1230
        """
 
1231
        if not _found:
 
1232
            format = RepositoryFormat.find_format(a_bzrdir)
 
1233
            assert format.__class__ ==  self.__class__
 
1234
        if _override_transport is not None:
 
1235
            repo_transport = _override_transport
 
1236
        else:
 
1237
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1238
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1239
        text_store = self._get_text_store(repo_transport, control_files)
 
1240
        control_store = self._get_control_store(repo_transport, control_files)
 
1241
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1242
        return KnitRepository(_format=self,
 
1243
                              a_bzrdir=a_bzrdir,
 
1244
                              control_files=control_files,
 
1245
                              _revision_store=_revision_store,
 
1246
                              control_store=control_store,
 
1247
                              text_store=text_store)
 
1248
 
 
1249
 
 
1250
# formats which have no format string are not discoverable
 
1251
# and not independently creatable, so are not registered.
 
1252
_default_format = RepositoryFormat7()
 
1253
RepositoryFormat.register_format(_default_format)
 
1254
RepositoryFormat.register_format(RepositoryFormatKnit1())
 
1255
RepositoryFormat.set_default_format(_default_format)
 
1256
_legacy_formats = [RepositoryFormat4(),
 
1257
                   RepositoryFormat5(),
 
1258
                   RepositoryFormat6()]
 
1259
 
 
1260
 
 
1261
class InterRepository(InterObject):
 
1262
    """This class represents operations taking place between two repositories.
 
1263
 
 
1264
    Its instances have methods like copy_content and fetch, and contain
 
1265
    references to the source and target repositories these operations can be 
 
1266
    carried out on.
 
1267
 
 
1268
    Often we will provide convenience methods on 'repository' which carry out
 
1269
    operations with another repository - they will always forward to
 
1270
    InterRepository.get(other).method_name(parameters).
 
1271
    """
 
1272
 
 
1273
    _optimisers = set()
 
1274
    """The available optimised InterRepository types."""
 
1275
 
 
1276
    @needs_write_lock
 
1277
    def copy_content(self, revision_id=None, basis=None):
 
1278
        """Make a complete copy of the content in self into destination.
 
1279
        
 
1280
        This is a destructive operation! Do not use it on existing 
 
1281
        repositories.
 
1282
 
 
1283
        :param revision_id: Only copy the content needed to construct
 
1284
                            revision_id and its parents.
 
1285
        :param basis: Copy the needed data preferentially from basis.
 
1286
        """
 
1287
        try:
 
1288
            self.target.set_make_working_trees(self.source.make_working_trees())
 
1289
        except NotImplementedError:
 
1290
            pass
 
1291
        # grab the basis available data
 
1292
        if basis is not None:
 
1293
            self.target.fetch(basis, revision_id=revision_id)
 
1294
        # but dont bother fetching if we have the needed data now.
 
1295
        if (revision_id not in (None, NULL_REVISION) and 
 
1296
            self.target.has_revision(revision_id)):
 
1297
            return
 
1298
        self.target.fetch(self.source, revision_id=revision_id)
 
1299
 
 
1300
    def _double_lock(self, lock_source, lock_target):
 
1301
        """Take out too locks, rolling back the first if the second throws."""
 
1302
        lock_source()
 
1303
        try:
 
1304
            lock_target()
 
1305
        except Exception:
 
1306
            # we want to ensure that we don't leave source locked by mistake.
 
1307
            # and any error on target should not confuse source.
 
1308
            self.source.unlock()
 
1309
            raise
 
1310
 
 
1311
    @needs_write_lock
 
1312
    def fetch(self, revision_id=None, pb=None):
 
1313
        """Fetch the content required to construct revision_id.
 
1314
 
 
1315
        The content is copied from source to target.
 
1316
 
 
1317
        :param revision_id: if None all content is copied, if NULL_REVISION no
 
1318
                            content is copied.
 
1319
        :param pb: optional progress bar to use for progress reports. If not
 
1320
                   provided a default one will be created.
 
1321
 
 
1322
        Returns the copied revision count and the failed revisions in a tuple:
 
1323
        (copied, failures).
 
1324
        """
 
1325
        from bzrlib.fetch import GenericRepoFetcher
 
1326
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1327
               self.source, self.source._format, self.target, self.target._format)
 
1328
        f = GenericRepoFetcher(to_repository=self.target,
 
1329
                               from_repository=self.source,
 
1330
                               last_revision=revision_id,
 
1331
                               pb=pb)
 
1332
        return f.count_copied, f.failed_revisions
 
1333
 
 
1334
    def lock_read(self):
 
1335
        """Take out a logical read lock.
 
1336
 
 
1337
        This will lock the source branch and the target branch. The source gets
 
1338
        a read lock and the target a read lock.
 
1339
        """
 
1340
        self._double_lock(self.source.lock_read, self.target.lock_read)
 
1341
 
 
1342
    def lock_write(self):
 
1343
        """Take out a logical write lock.
 
1344
 
 
1345
        This will lock the source branch and the target branch. The source gets
 
1346
        a read lock and the target a write lock.
 
1347
        """
 
1348
        self._double_lock(self.source.lock_read, self.target.lock_write)
 
1349
 
 
1350
    @needs_read_lock
 
1351
    def missing_revision_ids(self, revision_id=None):
 
1352
        """Return the revision ids that source has that target does not.
 
1353
        
 
1354
        These are returned in topological order.
 
1355
 
 
1356
        :param revision_id: only return revision ids included by this
 
1357
                            revision_id.
 
1358
        """
 
1359
        # generic, possibly worst case, slow code path.
 
1360
        target_ids = set(self.target.all_revision_ids())
 
1361
        if revision_id is not None:
 
1362
            source_ids = self.source.get_ancestry(revision_id)
 
1363
            assert source_ids.pop(0) == None
 
1364
        else:
 
1365
            source_ids = self.source.all_revision_ids()
 
1366
        result_set = set(source_ids).difference(target_ids)
 
1367
        # this may look like a no-op: its not. It preserves the ordering
 
1368
        # other_ids had while only returning the members from other_ids
 
1369
        # that we've decided we need.
 
1370
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
1371
 
 
1372
    def unlock(self):
 
1373
        """Release the locks on source and target."""
 
1374
        try:
 
1375
            self.target.unlock()
 
1376
        finally:
 
1377
            self.source.unlock()
 
1378
 
 
1379
 
 
1380
class InterWeaveRepo(InterRepository):
 
1381
    """Optimised code paths between Weave based repositories."""
 
1382
 
 
1383
    _matching_repo_format = _default_format
 
1384
    """Repository format for testing with."""
 
1385
 
 
1386
    @staticmethod
 
1387
    def is_compatible(source, target):
 
1388
        """Be compatible with known Weave formats.
 
1389
        
 
1390
        We dont test for the stores being of specific types becase that
 
1391
        could lead to confusing results, and there is no need to be 
 
1392
        overly general.
 
1393
        """
 
1394
        try:
 
1395
            return (isinstance(source._format, (RepositoryFormat5,
 
1396
                                                RepositoryFormat6,
 
1397
                                                RepositoryFormat7)) and
 
1398
                    isinstance(target._format, (RepositoryFormat5,
 
1399
                                                RepositoryFormat6,
 
1400
                                                RepositoryFormat7)))
 
1401
        except AttributeError:
 
1402
            return False
 
1403
    
 
1404
    @needs_write_lock
 
1405
    def copy_content(self, revision_id=None, basis=None):
 
1406
        """See InterRepository.copy_content()."""
 
1407
        # weave specific optimised path:
 
1408
        if basis is not None:
 
1409
            # copy the basis in, then fetch remaining data.
 
1410
            basis.copy_content_into(self.target, revision_id)
 
1411
            # the basis copy_content_into could misset this.
 
1412
            try:
 
1413
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1414
            except NotImplementedError:
 
1415
                pass
 
1416
            self.target.fetch(self.source, revision_id=revision_id)
 
1417
        else:
 
1418
            try:
 
1419
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1420
            except NotImplementedError:
 
1421
                pass
 
1422
            # FIXME do not peek!
 
1423
            if self.source.control_files._transport.listable():
 
1424
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1425
                try:
 
1426
                    self.target.weave_store.copy_all_ids(
 
1427
                        self.source.weave_store,
 
1428
                        pb=pb,
 
1429
                        from_transaction=self.source.get_transaction(),
 
1430
                        to_transaction=self.target.get_transaction())
 
1431
                    pb.update('copying inventory', 0, 1)
 
1432
                    self.target.control_weaves.copy_multi(
 
1433
                        self.source.control_weaves, ['inventory'],
 
1434
                        from_transaction=self.source.get_transaction(),
 
1435
                        to_transaction=self.target.get_transaction())
 
1436
                    self.target._revision_store.text_store.copy_all_ids(
 
1437
                        self.source._revision_store.text_store,
 
1438
                        pb=pb)
 
1439
                finally:
 
1440
                    pb.finished()
 
1441
            else:
 
1442
                self.target.fetch(self.source, revision_id=revision_id)
 
1443
 
 
1444
    @needs_write_lock
 
1445
    def fetch(self, revision_id=None, pb=None):
 
1446
        """See InterRepository.fetch()."""
 
1447
        from bzrlib.fetch import GenericRepoFetcher
 
1448
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1449
               self.source, self.source._format, self.target, self.target._format)
 
1450
        f = GenericRepoFetcher(to_repository=self.target,
 
1451
                               from_repository=self.source,
 
1452
                               last_revision=revision_id,
 
1453
                               pb=pb)
 
1454
        return f.count_copied, f.failed_revisions
 
1455
 
 
1456
    @needs_read_lock
 
1457
    def missing_revision_ids(self, revision_id=None):
 
1458
        """See InterRepository.missing_revision_ids()."""
 
1459
        # we want all revisions to satisfy revision_id in source.
 
1460
        # but we dont want to stat every file here and there.
 
1461
        # we want then, all revisions other needs to satisfy revision_id 
 
1462
        # checked, but not those that we have locally.
 
1463
        # so the first thing is to get a subset of the revisions to 
 
1464
        # satisfy revision_id in source, and then eliminate those that
 
1465
        # we do already have. 
 
1466
        # this is slow on high latency connection to self, but as as this
 
1467
        # disk format scales terribly for push anyway due to rewriting 
 
1468
        # inventory.weave, this is considered acceptable.
 
1469
        # - RBC 20060209
 
1470
        if revision_id is not None:
 
1471
            source_ids = self.source.get_ancestry(revision_id)
 
1472
            assert source_ids.pop(0) == None
 
1473
        else:
 
1474
            source_ids = self.source._all_possible_ids()
 
1475
        source_ids_set = set(source_ids)
 
1476
        # source_ids is the worst possible case we may need to pull.
 
1477
        # now we want to filter source_ids against what we actually
 
1478
        # have in target, but dont try to check for existence where we know
 
1479
        # we do not have a revision as that would be pointless.
 
1480
        target_ids = set(self.target._all_possible_ids())
 
1481
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
1482
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
1483
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
1484
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
1485
        if revision_id is not None:
 
1486
            # we used get_ancestry to determine source_ids then we are assured all
 
1487
            # revisions referenced are present as they are installed in topological order.
 
1488
            # and the tip revision was validated by get_ancestry.
 
1489
            return required_topo_revisions
 
1490
        else:
 
1491
            # if we just grabbed the possibly available ids, then 
 
1492
            # we only have an estimate of whats available and need to validate
 
1493
            # that against the revision records.
 
1494
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
1495
 
 
1496
 
 
1497
class InterKnitRepo(InterRepository):
 
1498
    """Optimised code paths between Knit based repositories."""
 
1499
 
 
1500
    _matching_repo_format = RepositoryFormatKnit1()
 
1501
    """Repository format for testing with."""
 
1502
 
 
1503
    @staticmethod
 
1504
    def is_compatible(source, target):
 
1505
        """Be compatible with known Knit formats.
 
1506
        
 
1507
        We dont test for the stores being of specific types becase that
 
1508
        could lead to confusing results, and there is no need to be 
 
1509
        overly general.
 
1510
        """
 
1511
        try:
 
1512
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
 
1513
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
1514
        except AttributeError:
 
1515
            return False
 
1516
 
 
1517
    @needs_write_lock
 
1518
    def fetch(self, revision_id=None, pb=None):
 
1519
        """See InterRepository.fetch()."""
 
1520
        from bzrlib.fetch import KnitRepoFetcher
 
1521
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1522
               self.source, self.source._format, self.target, self.target._format)
 
1523
        f = KnitRepoFetcher(to_repository=self.target,
 
1524
                            from_repository=self.source,
 
1525
                            last_revision=revision_id,
 
1526
                            pb=pb)
 
1527
        return f.count_copied, f.failed_revisions
 
1528
 
 
1529
    @needs_read_lock
 
1530
    def missing_revision_ids(self, revision_id=None):
 
1531
        """See InterRepository.missing_revision_ids()."""
 
1532
        if revision_id is not None:
 
1533
            source_ids = self.source.get_ancestry(revision_id)
 
1534
            assert source_ids.pop(0) == None
 
1535
        else:
 
1536
            source_ids = self.source._all_possible_ids()
 
1537
        source_ids_set = set(source_ids)
 
1538
        # source_ids is the worst possible case we may need to pull.
 
1539
        # now we want to filter source_ids against what we actually
 
1540
        # have in target, but dont try to check for existence where we know
 
1541
        # we do not have a revision as that would be pointless.
 
1542
        target_ids = set(self.target._all_possible_ids())
 
1543
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
1544
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
1545
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
1546
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
1547
        if revision_id is not None:
 
1548
            # we used get_ancestry to determine source_ids then we are assured all
 
1549
            # revisions referenced are present as they are installed in topological order.
 
1550
            # and the tip revision was validated by get_ancestry.
 
1551
            return required_topo_revisions
 
1552
        else:
 
1553
            # if we just grabbed the possibly available ids, then 
 
1554
            # we only have an estimate of whats available and need to validate
 
1555
            # that against the revision records.
 
1556
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
1557
 
 
1558
InterRepository.register_optimiser(InterWeaveRepo)
 
1559
InterRepository.register_optimiser(InterKnitRepo)
 
1560
 
 
1561
 
 
1562
class RepositoryTestProviderAdapter(object):
 
1563
    """A tool to generate a suite testing multiple repository formats at once.
 
1564
 
 
1565
    This is done by copying the test once for each transport and injecting
 
1566
    the transport_server, transport_readonly_server, and bzrdir_format and
 
1567
    repository_format classes into each copy. Each copy is also given a new id()
 
1568
    to make it easy to identify.
 
1569
    """
 
1570
 
 
1571
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1572
        self._transport_server = transport_server
 
1573
        self._transport_readonly_server = transport_readonly_server
 
1574
        self._formats = formats
 
1575
    
 
1576
    def adapt(self, test):
 
1577
        result = TestSuite()
 
1578
        for repository_format, bzrdir_format in self._formats:
 
1579
            new_test = deepcopy(test)
 
1580
            new_test.transport_server = self._transport_server
 
1581
            new_test.transport_readonly_server = self._transport_readonly_server
 
1582
            new_test.bzrdir_format = bzrdir_format
 
1583
            new_test.repository_format = repository_format
 
1584
            def make_new_test_id():
 
1585
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
 
1586
                return lambda: new_id
 
1587
            new_test.id = make_new_test_id()
 
1588
            result.addTest(new_test)
 
1589
        return result
 
1590
 
 
1591
 
 
1592
class InterRepositoryTestProviderAdapter(object):
 
1593
    """A tool to generate a suite testing multiple inter repository formats.
 
1594
 
 
1595
    This is done by copying the test once for each interrepo provider and injecting
 
1596
    the transport_server, transport_readonly_server, repository_format and 
 
1597
    repository_to_format classes into each copy.
 
1598
    Each copy is also given a new id() to make it easy to identify.
 
1599
    """
 
1600
 
 
1601
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1602
        self._transport_server = transport_server
 
1603
        self._transport_readonly_server = transport_readonly_server
 
1604
        self._formats = formats
 
1605
    
 
1606
    def adapt(self, test):
 
1607
        result = TestSuite()
 
1608
        for interrepo_class, repository_format, repository_format_to in self._formats:
 
1609
            new_test = deepcopy(test)
 
1610
            new_test.transport_server = self._transport_server
 
1611
            new_test.transport_readonly_server = self._transport_readonly_server
 
1612
            new_test.interrepo_class = interrepo_class
 
1613
            new_test.repository_format = repository_format
 
1614
            new_test.repository_format_to = repository_format_to
 
1615
            def make_new_test_id():
 
1616
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
 
1617
                return lambda: new_id
 
1618
            new_test.id = make_new_test_id()
 
1619
            result.addTest(new_test)
 
1620
        return result
 
1621
 
 
1622
    @staticmethod
 
1623
    def default_test_list():
 
1624
        """Generate the default list of interrepo permutations to test."""
 
1625
        result = []
 
1626
        # test the default InterRepository between format 6 and the current 
 
1627
        # default format.
 
1628
        # XXX: robertc 20060220 reinstate this when there are two supported
 
1629
        # formats which do not have an optimal code path between them.
 
1630
        result.append((InterRepository,
 
1631
                       RepositoryFormat6(),
 
1632
                       RepositoryFormatKnit1()))
 
1633
        for optimiser in InterRepository._optimisers:
 
1634
            result.append((optimiser,
 
1635
                           optimiser._matching_repo_format,
 
1636
                           optimiser._matching_repo_format
 
1637
                           ))
 
1638
        # if there are specific combinations we want to use, we can add them 
 
1639
        # here.
 
1640
        return result
 
1641
 
 
1642
 
 
1643
class CopyConverter(object):
 
1644
    """A repository conversion tool which just performs a copy of the content.
 
1645
    
 
1646
    This is slow but quite reliable.
 
1647
    """
 
1648
 
 
1649
    def __init__(self, target_format):
 
1650
        """Create a CopyConverter.
 
1651
 
 
1652
        :param target_format: The format the resulting repository should be.
 
1653
        """
 
1654
        self.target_format = target_format
 
1655
        
 
1656
    def convert(self, repo, pb):
 
1657
        """Perform the conversion of to_convert, giving feedback via pb.
 
1658
 
 
1659
        :param to_convert: The disk object to convert.
 
1660
        :param pb: a progress bar to use for progress information.
 
1661
        """
 
1662
        self.pb = pb
 
1663
        self.count = 0
 
1664
        self.total = 3
 
1665
        # this is only useful with metadir layouts - separated repo content.
 
1666
        # trigger an assertion if not such
 
1667
        repo._format.get_format_string()
 
1668
        self.repo_dir = repo.bzrdir
 
1669
        self.step('Moving repository to repository.backup')
 
1670
        self.repo_dir.transport.move('repository', 'repository.backup')
 
1671
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
1672
        self.source_repo = repo._format.open(self.repo_dir,
 
1673
            _found=True,
 
1674
            _override_transport=backup_transport)
 
1675
        self.step('Creating new repository')
 
1676
        converted = self.target_format.initialize(self.repo_dir,
 
1677
                                                  self.source_repo.is_shared())
 
1678
        converted.lock_write()
 
1679
        try:
 
1680
            self.step('Copying content into repository.')
 
1681
            self.source_repo.copy_content_into(converted)
 
1682
        finally:
 
1683
            converted.unlock()
 
1684
        self.step('Deleting old repository content.')
 
1685
        self.repo_dir.transport.delete_tree('repository.backup')
 
1686
        self.pb.note('repository converted')
 
1687
 
 
1688
    def step(self, message):
 
1689
        """Update the pb by a step."""
 
1690
        self.count +=1
 
1691
        self.pb.update(message, self.count, self.total)