/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 finished() notifications to transactions.

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(revision_id)
 
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
        candidates = w.get_ancestry(revision_id)
 
526
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
527
 
 
528
    @needs_read_lock
 
529
    def print_file(self, file, revision_id):
 
530
        """Print `file` to stdout.
 
531
        
 
532
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
533
        - it writes to stdout, it assumes that that is valid etc. Fix
 
534
        by creating a new more flexible convenience function.
 
535
        """
 
536
        tree = self.revision_tree(revision_id)
 
537
        # use inventory as it was in that revision
 
538
        file_id = tree.inventory.path2id(file)
 
539
        if not file_id:
 
540
            raise BzrError("%r is not present in revision %s" % (file, revno))
 
541
            try:
 
542
                revno = self.revision_id_to_revno(revision_id)
 
543
            except errors.NoSuchRevision:
 
544
                # TODO: This should not be BzrError,
 
545
                # but NoSuchFile doesn't fit either
 
546
                raise BzrError('%r is not present in revision %s' 
 
547
                                % (file, revision_id))
 
548
            else:
 
549
                raise BzrError('%r is not present in revision %s'
 
550
                                % (file, revno))
 
551
        tree.print_file(file_id)
 
552
 
 
553
    def get_transaction(self):
 
554
        return self.control_files.get_transaction()
 
555
 
 
556
    def revision_parents(self, revid):
 
557
        return self.get_inventory_weave().parent_names(revid)
 
558
 
 
559
    @needs_write_lock
 
560
    def set_make_working_trees(self, new_value):
 
561
        """Set the policy flag for making working trees when creating branches.
 
562
 
 
563
        This only applies to branches that use this repository.
 
564
 
 
565
        The default is 'True'.
 
566
        :param new_value: True to restore the default, False to disable making
 
567
                          working trees.
 
568
        """
 
569
        # FIXME: split out into a new class/strategy ?
 
570
        if isinstance(self._format, (RepositoryFormat4,
 
571
                                     RepositoryFormat5,
 
572
                                     RepositoryFormat6)):
 
573
            raise NotImplementedError(self.set_make_working_trees)
 
574
        if new_value:
 
575
            try:
 
576
                self.control_files._transport.delete('no-working-trees')
 
577
            except errors.NoSuchFile:
 
578
                pass
 
579
        else:
 
580
            self.control_files.put_utf8('no-working-trees', '')
 
581
    
 
582
    def make_working_trees(self):
 
583
        """Returns the policy for making working trees on new branches."""
 
584
        # FIXME: split out into a new class/strategy ?
 
585
        if isinstance(self._format, (RepositoryFormat4,
 
586
                                     RepositoryFormat5,
 
587
                                     RepositoryFormat6)):
 
588
            return True
 
589
        return not self.control_files._transport.has('no-working-trees')
 
590
 
 
591
    @needs_write_lock
 
592
    def sign_revision(self, revision_id, gpg_strategy):
 
593
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
594
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
595
 
 
596
    @needs_read_lock
 
597
    def has_signature_for_revision_id(self, revision_id):
 
598
        """Query for a revision signature for revision_id in the repository."""
 
599
        return self._revision_store.has_signature(revision_id,
 
600
                                                  self.get_transaction())
 
601
 
 
602
    @needs_read_lock
 
603
    def get_signature_text(self, revision_id):
 
604
        """Return the text for a signature."""
 
605
        return self._revision_store.get_signature_text(revision_id,
 
606
                                                       self.get_transaction())
 
607
 
 
608
 
 
609
class AllInOneRepository(Repository):
 
610
    """Legacy support - the repository behaviour for all-in-one branches."""
 
611
 
 
612
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
 
613
        # we reuse one control files instance.
 
614
        dir_mode = a_bzrdir._control_files._dir_mode
 
615
        file_mode = a_bzrdir._control_files._file_mode
 
616
 
 
617
        def get_weave(name, prefixed=False):
 
618
            if name:
 
619
                name = safe_unicode(name)
 
620
            else:
 
621
                name = ''
 
622
            relpath = a_bzrdir._control_files._escape(name)
 
623
            weave_transport = a_bzrdir._control_files._transport.clone(relpath)
 
624
            ws = WeaveStore(weave_transport, prefixed=prefixed,
 
625
                            dir_mode=dir_mode,
 
626
                            file_mode=file_mode)
 
627
            if a_bzrdir._control_files._transport.should_cache():
 
628
                ws.enable_cache = True
 
629
            return ws
 
630
 
 
631
        def get_store(name, compressed=True, prefixed=False):
 
632
            # FIXME: This approach of assuming stores are all entirely compressed
 
633
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
634
            # some existing branches where there's a mixture; we probably 
 
635
            # still want the option to look for both.
 
636
            relpath = a_bzrdir._control_files._escape(name)
 
637
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
 
638
                              prefixed=prefixed, compressed=compressed,
 
639
                              dir_mode=dir_mode,
 
640
                              file_mode=file_mode)
 
641
            #if self._transport.should_cache():
 
642
            #    cache_path = os.path.join(self.cache_root, name)
 
643
            #    os.mkdir(cache_path)
 
644
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
645
            return store
 
646
 
 
647
        # not broken out yet because the controlweaves|inventory_store
 
648
        # and text_store | weave_store bits are still different.
 
649
        if isinstance(_format, RepositoryFormat4):
 
650
            # cannot remove these - there is still no consistent api 
 
651
            # which allows access to this old info.
 
652
            self.inventory_store = get_store('inventory-store')
 
653
            text_store = get_store('text-store')
 
654
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
 
655
 
 
656
 
 
657
class MetaDirRepository(Repository):
 
658
    """Repositories in the new meta-dir layout."""
 
659
 
 
660
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
661
        super(MetaDirRepository, self).__init__(_format,
 
662
                                                a_bzrdir,
 
663
                                                control_files,
 
664
                                                _revision_store,
 
665
                                                control_store,
 
666
                                                text_store)
 
667
 
 
668
        dir_mode = self.control_files._dir_mode
 
669
        file_mode = self.control_files._file_mode
 
670
 
 
671
        def get_weave(name, prefixed=False):
 
672
            if name:
 
673
                name = safe_unicode(name)
 
674
            else:
 
675
                name = ''
 
676
            relpath = self.control_files._escape(name)
 
677
            weave_transport = self.control_files._transport.clone(relpath)
 
678
            ws = WeaveStore(weave_transport, prefixed=prefixed,
 
679
                            dir_mode=dir_mode,
 
680
                            file_mode=file_mode)
 
681
            if self.control_files._transport.should_cache():
 
682
                ws.enable_cache = True
 
683
            return ws
 
684
 
 
685
 
 
686
class KnitRepository(MetaDirRepository):
 
687
    """Knit format repository."""
 
688
 
 
689
    @needs_read_lock
 
690
    def all_revision_ids(self):
 
691
        """See Repository.all_revision_ids()."""
 
692
        return self._revision_store.all_revision_ids(self.get_transaction())
 
693
 
 
694
    @needs_read_lock
 
695
    def get_ancestry(self, revision_id):
 
696
        """Return a list of revision-ids integrated by a revision.
 
697
        
 
698
        This is topologically sorted.
 
699
        """
 
700
        if revision_id is None:
 
701
            return [None]
 
702
        vf = self._revision_store.get_revision_file(self.get_transaction())
 
703
        try:
 
704
            return [None] + vf.get_ancestry(revision_id)
 
705
        except errors.RevisionNotPresent:
 
706
            raise errors.NoSuchRevision(self, revision_id)
 
707
 
 
708
    @needs_read_lock
 
709
    def get_revision(self, revision_id):
 
710
        """Return the Revision object for a named revision"""
 
711
        return self.get_revision_reconcile(revision_id)
 
712
 
 
713
    @needs_read_lock
 
714
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
715
        """Return a graph of the revisions with ghosts marked as applicable.
 
716
 
 
717
        :param revision_ids: an iterable of revisions to graph or None for all.
 
718
        :return: a Graph object with the graph reachable from revision_ids.
 
719
        """
 
720
        result = Graph()
 
721
        vf = self._revision_store.get_revision_file(self.get_transaction())
 
722
        versions = vf.versions()
 
723
        if not revision_ids:
 
724
            pending = set(self.all_revision_ids())
 
725
            required = set([])
 
726
        else:
 
727
            pending = set(revision_ids)
 
728
            required = set(revision_ids)
 
729
        done = set([])
 
730
        while len(pending):
 
731
            revision_id = pending.pop()
 
732
            if not revision_id in versions:
 
733
                if revision_id in required:
 
734
                    raise errors.NoSuchRevision(self, revision_id)
 
735
                # a ghost
 
736
                result.add_ghost(revision_id)
 
737
                continue
 
738
            parent_ids = vf.get_parents_with_ghosts(revision_id)
 
739
            for parent_id in parent_ids:
 
740
                # is this queued or done ?
 
741
                if (parent_id not in pending and
 
742
                    parent_id not in done):
 
743
                    # no, queue it.
 
744
                    pending.add(parent_id)
 
745
            result.add_node(revision_id, parent_ids)
 
746
            done.add(result)
 
747
        return result
 
748
 
 
749
    @needs_write_lock
 
750
    def reconcile(self):
 
751
        """Reconcile this repository."""
 
752
        from bzrlib.reconcile import KnitReconciler
 
753
        reconciler = KnitReconciler(self)
 
754
        reconciler.reconcile()
 
755
        return reconciler
 
756
    
 
757
 
 
758
class RepositoryFormat(object):
 
759
    """A repository format.
 
760
 
 
761
    Formats provide three things:
 
762
     * An initialization routine to construct repository data on disk.
 
763
     * a format string which is used when the BzrDir supports versioned
 
764
       children.
 
765
     * an open routine which returns a Repository instance.
 
766
 
 
767
    Formats are placed in an dict by their format string for reference 
 
768
    during opening. These should be subclasses of RepositoryFormat
 
769
    for consistency.
 
770
 
 
771
    Once a format is deprecated, just deprecate the initialize and open
 
772
    methods on the format class. Do not deprecate the object, as the 
 
773
    object will be created every system load.
 
774
 
 
775
    Common instance attributes:
 
776
    _matchingbzrdir - the bzrdir format that the repository format was
 
777
    originally written to work with. This can be used if manually
 
778
    constructing a bzrdir and repository, or more commonly for test suite
 
779
    parameterisation.
 
780
    """
 
781
 
 
782
    _default_format = None
 
783
    """The default format used for new repositories."""
 
784
 
 
785
    _formats = {}
 
786
    """The known formats."""
 
787
 
 
788
    @classmethod
 
789
    def find_format(klass, a_bzrdir):
 
790
        """Return the format for the repository object in a_bzrdir."""
 
791
        try:
 
792
            transport = a_bzrdir.get_repository_transport(None)
 
793
            format_string = transport.get("format").read()
 
794
            return klass._formats[format_string]
 
795
        except errors.NoSuchFile:
 
796
            raise errors.NoRepositoryPresent(a_bzrdir)
 
797
        except KeyError:
 
798
            raise errors.UnknownFormatError(format_string)
 
799
 
 
800
    def _get_control_store(self, repo_transport, control_files):
 
801
        """Return the control store for this repository."""
 
802
        raise NotImplementedError(self._get_control_store)
 
803
    
 
804
    @classmethod
 
805
    def get_default_format(klass):
 
806
        """Return the current default format."""
 
807
        return klass._default_format
 
808
 
 
809
    def get_format_string(self):
 
810
        """Return the ASCII format string that identifies this format.
 
811
        
 
812
        Note that in pre format ?? repositories the format string is 
 
813
        not permitted nor written to disk.
 
814
        """
 
815
        raise NotImplementedError(self.get_format_string)
 
816
 
 
817
    def _get_revision_store(self, repo_transport, control_files):
 
818
        """Return the revision store object for this a_bzrdir."""
 
819
        raise NotImplementedError(self._get_revision_store)
 
820
 
 
821
    def _get_text_rev_store(self,
 
822
                            transport,
 
823
                            control_files,
 
824
                            name,
 
825
                            compressed=True,
 
826
                            prefixed=False,
 
827
                            serializer=None):
 
828
        """Common logic for getting a revision store for a repository.
 
829
        
 
830
        see self._get_revision_store for the subclass-overridable method to 
 
831
        get the store for a repository.
 
832
        """
 
833
        from bzrlib.store.revision.text import TextRevisionStore
 
834
        dir_mode = control_files._dir_mode
 
835
        file_mode = control_files._file_mode
 
836
        text_store =TextStore(transport.clone(name),
 
837
                              prefixed=prefixed,
 
838
                              compressed=compressed,
 
839
                              dir_mode=dir_mode,
 
840
                              file_mode=file_mode)
 
841
        _revision_store = TextRevisionStore(text_store, serializer)
 
842
        return _revision_store
 
843
 
 
844
    def _get_versioned_file_store(self,
 
845
                                  name,
 
846
                                  transport,
 
847
                                  control_files,
 
848
                                  prefixed=True,
 
849
                                  versionedfile_class=WeaveFile):
 
850
        weave_transport = control_files._transport.clone(name)
 
851
        dir_mode = control_files._dir_mode
 
852
        file_mode = control_files._file_mode
 
853
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
854
                                dir_mode=dir_mode,
 
855
                                file_mode=file_mode,
 
856
                                versionedfile_class=versionedfile_class)
 
857
 
 
858
    def initialize(self, a_bzrdir, shared=False):
 
859
        """Initialize a repository of this format in a_bzrdir.
 
860
 
 
861
        :param a_bzrdir: The bzrdir to put the new repository in it.
 
862
        :param shared: The repository should be initialized as a sharable one.
 
863
 
 
864
        This may raise UninitializableFormat if shared repository are not
 
865
        compatible the a_bzrdir.
 
866
        """
 
867
 
 
868
    def is_supported(self):
 
869
        """Is this format supported?
 
870
 
 
871
        Supported formats must be initializable and openable.
 
872
        Unsupported formats may not support initialization or committing or 
 
873
        some other features depending on the reason for not being supported.
 
874
        """
 
875
        return True
 
876
 
 
877
    def open(self, a_bzrdir, _found=False):
 
878
        """Return an instance of this format for the bzrdir a_bzrdir.
 
879
        
 
880
        _found is a private parameter, do not use it.
 
881
        """
 
882
        raise NotImplementedError(self.open)
 
883
 
 
884
    @classmethod
 
885
    def register_format(klass, format):
 
886
        klass._formats[format.get_format_string()] = format
 
887
 
 
888
    @classmethod
 
889
    def set_default_format(klass, format):
 
890
        klass._default_format = format
 
891
 
 
892
    @classmethod
 
893
    def unregister_format(klass, format):
 
894
        assert klass._formats[format.get_format_string()] is format
 
895
        del klass._formats[format.get_format_string()]
 
896
 
 
897
 
 
898
class PreSplitOutRepositoryFormat(RepositoryFormat):
 
899
    """Base class for the pre split out repository formats."""
 
900
 
 
901
    def initialize(self, a_bzrdir, shared=False, _internal=False):
 
902
        """Create a weave repository.
 
903
        
 
904
        TODO: when creating split out bzr branch formats, move this to a common
 
905
        base for Format5, Format6. or something like that.
 
906
        """
 
907
        from bzrlib.weavefile import write_weave_v5
 
908
        from bzrlib.weave import Weave
 
909
 
 
910
        if shared:
 
911
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
 
912
 
 
913
        if not _internal:
 
914
            # always initialized when the bzrdir is.
 
915
            return self.open(a_bzrdir, _found=True)
 
916
        
 
917
        # Create an empty weave
 
918
        sio = StringIO()
 
919
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
920
        empty_weave = sio.getvalue()
 
921
 
 
922
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
923
        dirs = ['revision-store', 'weaves']
 
924
        files = [('inventory.weave', StringIO(empty_weave)),
 
925
                 ]
 
926
        
 
927
        # FIXME: RBC 20060125 dont peek under the covers
 
928
        # NB: no need to escape relative paths that are url safe.
 
929
        control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
 
930
                                      TransportLock)
 
931
        control_files.create_lock()
 
932
        control_files.lock_write()
 
933
        control_files._transport.mkdir_multi(dirs,
 
934
                mode=control_files._dir_mode)
 
935
        try:
 
936
            for file, content in files:
 
937
                control_files.put(file, content)
 
938
        finally:
 
939
            control_files.unlock()
 
940
        return self.open(a_bzrdir, _found=True)
 
941
 
 
942
    def _get_control_store(self, repo_transport, control_files):
 
943
        """Return the control store for this repository."""
 
944
        return self._get_versioned_file_store('',
 
945
                                              repo_transport,
 
946
                                              control_files,
 
947
                                              prefixed=False)
 
948
 
 
949
    def _get_text_store(self, transport, control_files):
 
950
        """Get a store for file texts for this format."""
 
951
        raise NotImplementedError(self._get_text_store)
 
952
 
 
953
    def open(self, a_bzrdir, _found=False):
 
954
        """See RepositoryFormat.open()."""
 
955
        if not _found:
 
956
            # we are being called directly and must probe.
 
957
            raise NotImplementedError
 
958
 
 
959
        repo_transport = a_bzrdir.get_repository_transport(None)
 
960
        control_files = a_bzrdir._control_files
 
961
        text_store = self._get_text_store(repo_transport, control_files)
 
962
        control_store = self._get_control_store(repo_transport, control_files)
 
963
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
964
        return AllInOneRepository(_format=self,
 
965
                                  a_bzrdir=a_bzrdir,
 
966
                                  _revision_store=_revision_store,
 
967
                                  control_store=control_store,
 
968
                                  text_store=text_store)
 
969
 
 
970
 
 
971
class RepositoryFormat4(PreSplitOutRepositoryFormat):
 
972
    """Bzr repository format 4.
 
973
 
 
974
    This repository format has:
 
975
     - flat stores
 
976
     - TextStores for texts, inventories,revisions.
 
977
 
 
978
    This format is deprecated: it indexes texts using a text id which is
 
979
    removed in format 5; initializationa and write support for this format
 
980
    has been removed.
 
981
    """
 
982
 
 
983
    def __init__(self):
 
984
        super(RepositoryFormat4, self).__init__()
 
985
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat4()
 
986
 
 
987
    def initialize(self, url, shared=False, _internal=False):
 
988
        """Format 4 branches cannot be created."""
 
989
        raise errors.UninitializableFormat(self)
 
990
 
 
991
    def is_supported(self):
 
992
        """Format 4 is not supported.
 
993
 
 
994
        It is not supported because the model changed from 4 to 5 and the
 
995
        conversion logic is expensive - so doing it on the fly was not 
 
996
        feasible.
 
997
        """
 
998
        return False
 
999
 
 
1000
    def _get_control_store(self, repo_transport, control_files):
 
1001
        """Format 4 repositories have no formal control store at this point.
 
1002
        
 
1003
        This will cause any control-file-needing apis to fail - this is desired.
 
1004
        """
 
1005
        return None
 
1006
    
 
1007
    def _get_revision_store(self, repo_transport, control_files):
 
1008
        """See RepositoryFormat._get_revision_store()."""
 
1009
        from bzrlib.xml4 import serializer_v4
 
1010
        return self._get_text_rev_store(repo_transport,
 
1011
                                        control_files,
 
1012
                                        'revision-store',
 
1013
                                        serializer=serializer_v4)
 
1014
 
 
1015
    def _get_text_store(self, transport, control_files):
 
1016
        """See RepositoryFormat._get_text_store()."""
 
1017
 
 
1018
 
 
1019
class RepositoryFormat5(PreSplitOutRepositoryFormat):
 
1020
    """Bzr control format 5.
 
1021
 
 
1022
    This repository format has:
 
1023
     - weaves for file texts and inventory
 
1024
     - flat stores
 
1025
     - TextStores for revisions and signatures.
 
1026
    """
 
1027
 
 
1028
    def __init__(self):
 
1029
        super(RepositoryFormat5, self).__init__()
 
1030
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat5()
 
1031
 
 
1032
    def _get_revision_store(self, repo_transport, control_files):
 
1033
        """See RepositoryFormat._get_revision_store()."""
 
1034
        """Return the revision store object for this a_bzrdir."""
 
1035
        return self._get_text_rev_store(repo_transport,
 
1036
                                        control_files,
 
1037
                                        'revision-store',
 
1038
                                        compressed=False)
 
1039
 
 
1040
    def _get_text_store(self, transport, control_files):
 
1041
        """See RepositoryFormat._get_text_store()."""
 
1042
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
 
1043
 
 
1044
 
 
1045
class RepositoryFormat6(PreSplitOutRepositoryFormat):
 
1046
    """Bzr control format 6.
 
1047
 
 
1048
    This repository format has:
 
1049
     - weaves for file texts and inventory
 
1050
     - hash subdirectory based stores.
 
1051
     - TextStores for revisions and signatures.
 
1052
    """
 
1053
 
 
1054
    def __init__(self):
 
1055
        super(RepositoryFormat6, self).__init__()
 
1056
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat6()
 
1057
 
 
1058
    def _get_revision_store(self, repo_transport, control_files):
 
1059
        """See RepositoryFormat._get_revision_store()."""
 
1060
        return self._get_text_rev_store(repo_transport,
 
1061
                                        control_files,
 
1062
                                        'revision-store',
 
1063
                                        compressed=False,
 
1064
                                        prefixed=True)
 
1065
 
 
1066
    def _get_text_store(self, transport, control_files):
 
1067
        """See RepositoryFormat._get_text_store()."""
 
1068
        return self._get_versioned_file_store('weaves', transport, control_files)
 
1069
 
 
1070
 
 
1071
class MetaDirRepositoryFormat(RepositoryFormat):
 
1072
    """Common base class for the new repositories using the metadir layour."""
 
1073
 
 
1074
    def __init__(self):
 
1075
        super(MetaDirRepositoryFormat, self).__init__()
 
1076
        self._matchingbzrdir = bzrlib.bzrdir.BzrDirMetaFormat1()
 
1077
 
 
1078
    def _create_control_files(self, a_bzrdir):
 
1079
        """Create the required files and the initial control_files object."""
 
1080
        # FIXME: RBC 20060125 dont peek under the covers
 
1081
        # NB: no need to escape relative paths that are url safe.
 
1082
        repository_transport = a_bzrdir.get_repository_transport(self)
 
1083
        control_files = LockableFiles(repository_transport, 'lock', LockDir)
 
1084
        control_files.create_lock()
 
1085
        return control_files
 
1086
 
 
1087
    def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
 
1088
        """Upload the initial blank content."""
 
1089
        control_files = self._create_control_files(a_bzrdir)
 
1090
        control_files.lock_write()
 
1091
        try:
 
1092
            control_files._transport.mkdir_multi(dirs,
 
1093
                    mode=control_files._dir_mode)
 
1094
            for file, content in files:
 
1095
                control_files.put(file, content)
 
1096
            for file, content in utf8_files:
 
1097
                control_files.put_utf8(file, content)
 
1098
            if shared == True:
 
1099
                control_files.put_utf8('shared-storage', '')
 
1100
        finally:
 
1101
            control_files.unlock()
 
1102
 
 
1103
 
 
1104
class RepositoryFormat7(MetaDirRepositoryFormat):
 
1105
    """Bzr repository 7.
 
1106
 
 
1107
    This repository format has:
 
1108
     - weaves for file texts and inventory
 
1109
     - hash subdirectory based stores.
 
1110
     - TextStores for revisions and signatures.
 
1111
     - a format marker of its own
 
1112
     - an optional 'shared-storage' flag
 
1113
     - an optional 'no-working-trees' flag
 
1114
    """
 
1115
 
 
1116
    def _get_control_store(self, repo_transport, control_files):
 
1117
        """Return the control store for this repository."""
 
1118
        return self._get_versioned_file_store('',
 
1119
                                              repo_transport,
 
1120
                                              control_files,
 
1121
                                              prefixed=False)
 
1122
 
 
1123
    def get_format_string(self):
 
1124
        """See RepositoryFormat.get_format_string()."""
 
1125
        return "Bazaar-NG Repository format 7"
 
1126
 
 
1127
    def _get_revision_store(self, repo_transport, control_files):
 
1128
        """See RepositoryFormat._get_revision_store()."""
 
1129
        return self._get_text_rev_store(repo_transport,
 
1130
                                        control_files,
 
1131
                                        'revision-store',
 
1132
                                        compressed=False,
 
1133
                                        prefixed=True,
 
1134
                                        )
 
1135
 
 
1136
    def _get_text_store(self, transport, control_files):
 
1137
        """See RepositoryFormat._get_text_store()."""
 
1138
        return self._get_versioned_file_store('weaves',
 
1139
                                              transport,
 
1140
                                              control_files)
 
1141
 
 
1142
    def initialize(self, a_bzrdir, shared=False):
 
1143
        """Create a weave repository.
 
1144
 
 
1145
        :param shared: If true the repository will be initialized as a shared
 
1146
                       repository.
 
1147
        """
 
1148
        from bzrlib.weavefile import write_weave_v5
 
1149
        from bzrlib.weave import Weave
 
1150
 
 
1151
        # Create an empty weave
 
1152
        sio = StringIO()
 
1153
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
1154
        empty_weave = sio.getvalue()
 
1155
 
 
1156
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1157
        dirs = ['revision-store', 'weaves']
 
1158
        files = [('inventory.weave', StringIO(empty_weave)), 
 
1159
                 ]
 
1160
        utf8_files = [('format', self.get_format_string())]
 
1161
 
 
1162
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1163
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1164
 
 
1165
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1166
        """See RepositoryFormat.open().
 
1167
        
 
1168
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1169
                                    repository at a slightly different url
 
1170
                                    than normal. I.e. during 'upgrade'.
 
1171
        """
 
1172
        if not _found:
 
1173
            format = RepositoryFormat.find_format(a_bzrdir)
 
1174
            assert format.__class__ ==  self.__class__
 
1175
        if _override_transport is not None:
 
1176
            repo_transport = _override_transport
 
1177
        else:
 
1178
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1179
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1180
        text_store = self._get_text_store(repo_transport, control_files)
 
1181
        control_store = self._get_control_store(repo_transport, control_files)
 
1182
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1183
        return MetaDirRepository(_format=self,
 
1184
                                 a_bzrdir=a_bzrdir,
 
1185
                                 control_files=control_files,
 
1186
                                 _revision_store=_revision_store,
 
1187
                                 control_store=control_store,
 
1188
                                 text_store=text_store)
 
1189
 
 
1190
 
 
1191
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
 
1192
    """Bzr repository knit format 1.
 
1193
 
 
1194
    This repository format has:
 
1195
     - knits for file texts and inventory
 
1196
     - hash subdirectory based stores.
 
1197
     - knits for revisions and signatures
 
1198
     - TextStores for revisions and signatures.
 
1199
     - a format marker of its own
 
1200
     - an optional 'shared-storage' flag
 
1201
     - an optional 'no-working-trees' flag
 
1202
     - a LockDir lock
 
1203
    """
 
1204
 
 
1205
    def _get_control_store(self, repo_transport, control_files):
 
1206
        """Return the control store for this repository."""
 
1207
        return self._get_versioned_file_store('',
 
1208
                                              repo_transport,
 
1209
                                              control_files,
 
1210
                                              prefixed=False,
 
1211
                                              versionedfile_class=KnitVersionedFile)
 
1212
 
 
1213
    def get_format_string(self):
 
1214
        """See RepositoryFormat.get_format_string()."""
 
1215
        return "Bazaar-NG Knit Repository Format 1"
 
1216
 
 
1217
    def _get_revision_store(self, repo_transport, control_files):
 
1218
        """See RepositoryFormat._get_revision_store()."""
 
1219
        from bzrlib.store.revision.knit import KnitRevisionStore
 
1220
        versioned_file_store = VersionedFileStore(
 
1221
            repo_transport,
 
1222
            file_mode = control_files._file_mode,
 
1223
            prefixed=False,
 
1224
            precious=True,
 
1225
            versionedfile_class=KnitVersionedFile)
 
1226
        return KnitRevisionStore(versioned_file_store)
 
1227
 
 
1228
    def _get_text_store(self, transport, control_files):
 
1229
        """See RepositoryFormat._get_text_store()."""
 
1230
        return self._get_versioned_file_store('knits',
 
1231
                                              transport,
 
1232
                                              control_files,
 
1233
                                              versionedfile_class=KnitVersionedFile)
 
1234
 
 
1235
    def initialize(self, a_bzrdir, shared=False):
 
1236
        """Create a knit format 1 repository.
 
1237
 
 
1238
        :param shared: If true the repository will be initialized as a shared
 
1239
                       repository.
 
1240
        XXX NOTE that this current uses a Weave for testing and will become 
 
1241
            A Knit in due course.
 
1242
        """
 
1243
        from bzrlib.weavefile import write_weave_v5
 
1244
        from bzrlib.weave import Weave
 
1245
 
 
1246
        # Create an empty weave
 
1247
        sio = StringIO()
 
1248
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
1249
        empty_weave = sio.getvalue()
 
1250
 
 
1251
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
1252
        dirs = ['revision-store', 'knits', 'control']
 
1253
        files = [('control/inventory.weave', StringIO(empty_weave)), 
 
1254
                 ]
 
1255
        utf8_files = [('format', self.get_format_string())]
 
1256
        
 
1257
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
1258
        repo_transport = a_bzrdir.get_repository_transport(None)
 
1259
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1260
        control_store = self._get_control_store(repo_transport, control_files)
 
1261
        transaction = bzrlib.transactions.WriteTransaction()
 
1262
        # trigger a write of the inventory store.
 
1263
        control_store.get_weave_or_empty('inventory', transaction)
 
1264
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1265
        _revision_store.has_revision_id('A', transaction)
 
1266
        _revision_store.get_signature_file(transaction)
 
1267
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
1268
 
 
1269
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
1270
        """See RepositoryFormat.open().
 
1271
        
 
1272
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
1273
                                    repository at a slightly different url
 
1274
                                    than normal. I.e. during 'upgrade'.
 
1275
        """
 
1276
        if not _found:
 
1277
            format = RepositoryFormat.find_format(a_bzrdir)
 
1278
            assert format.__class__ ==  self.__class__
 
1279
        if _override_transport is not None:
 
1280
            repo_transport = _override_transport
 
1281
        else:
 
1282
            repo_transport = a_bzrdir.get_repository_transport(None)
 
1283
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
 
1284
        text_store = self._get_text_store(repo_transport, control_files)
 
1285
        control_store = self._get_control_store(repo_transport, control_files)
 
1286
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
1287
        return KnitRepository(_format=self,
 
1288
                              a_bzrdir=a_bzrdir,
 
1289
                              control_files=control_files,
 
1290
                              _revision_store=_revision_store,
 
1291
                              control_store=control_store,
 
1292
                              text_store=text_store)
 
1293
 
 
1294
 
 
1295
# formats which have no format string are not discoverable
 
1296
# and not independently creatable, so are not registered.
 
1297
_default_format = RepositoryFormat7()
 
1298
RepositoryFormat.register_format(_default_format)
 
1299
RepositoryFormat.register_format(RepositoryFormatKnit1())
 
1300
RepositoryFormat.set_default_format(_default_format)
 
1301
_legacy_formats = [RepositoryFormat4(),
 
1302
                   RepositoryFormat5(),
 
1303
                   RepositoryFormat6()]
 
1304
 
 
1305
 
 
1306
class InterRepository(InterObject):
 
1307
    """This class represents operations taking place between two repositories.
 
1308
 
 
1309
    Its instances have methods like copy_content and fetch, and contain
 
1310
    references to the source and target repositories these operations can be 
 
1311
    carried out on.
 
1312
 
 
1313
    Often we will provide convenience methods on 'repository' which carry out
 
1314
    operations with another repository - they will always forward to
 
1315
    InterRepository.get(other).method_name(parameters).
 
1316
    """
 
1317
 
 
1318
    _optimisers = set()
 
1319
    """The available optimised InterRepository types."""
 
1320
 
 
1321
    @needs_write_lock
 
1322
    def copy_content(self, revision_id=None, basis=None):
 
1323
        """Make a complete copy of the content in self into destination.
 
1324
        
 
1325
        This is a destructive operation! Do not use it on existing 
 
1326
        repositories.
 
1327
 
 
1328
        :param revision_id: Only copy the content needed to construct
 
1329
                            revision_id and its parents.
 
1330
        :param basis: Copy the needed data preferentially from basis.
 
1331
        """
 
1332
        try:
 
1333
            self.target.set_make_working_trees(self.source.make_working_trees())
 
1334
        except NotImplementedError:
 
1335
            pass
 
1336
        # grab the basis available data
 
1337
        if basis is not None:
 
1338
            self.target.fetch(basis, revision_id=revision_id)
 
1339
        # but dont bother fetching if we have the needed data now.
 
1340
        if (revision_id not in (None, NULL_REVISION) and 
 
1341
            self.target.has_revision(revision_id)):
 
1342
            return
 
1343
        self.target.fetch(self.source, revision_id=revision_id)
 
1344
 
 
1345
    def _double_lock(self, lock_source, lock_target):
 
1346
        """Take out too locks, rolling back the first if the second throws."""
 
1347
        lock_source()
 
1348
        try:
 
1349
            lock_target()
 
1350
        except Exception:
 
1351
            # we want to ensure that we don't leave source locked by mistake.
 
1352
            # and any error on target should not confuse source.
 
1353
            self.source.unlock()
 
1354
            raise
 
1355
 
 
1356
    @needs_write_lock
 
1357
    def fetch(self, revision_id=None, pb=None):
 
1358
        """Fetch the content required to construct revision_id.
 
1359
 
 
1360
        The content is copied from source to target.
 
1361
 
 
1362
        :param revision_id: if None all content is copied, if NULL_REVISION no
 
1363
                            content is copied.
 
1364
        :param pb: optional progress bar to use for progress reports. If not
 
1365
                   provided a default one will be created.
 
1366
 
 
1367
        Returns the copied revision count and the failed revisions in a tuple:
 
1368
        (copied, failures).
 
1369
        """
 
1370
        from bzrlib.fetch import GenericRepoFetcher
 
1371
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1372
               self.source, self.source._format, self.target, self.target._format)
 
1373
        f = GenericRepoFetcher(to_repository=self.target,
 
1374
                               from_repository=self.source,
 
1375
                               last_revision=revision_id,
 
1376
                               pb=pb)
 
1377
        return f.count_copied, f.failed_revisions
 
1378
 
 
1379
    def lock_read(self):
 
1380
        """Take out a logical read lock.
 
1381
 
 
1382
        This will lock the source branch and the target branch. The source gets
 
1383
        a read lock and the target a read lock.
 
1384
        """
 
1385
        self._double_lock(self.source.lock_read, self.target.lock_read)
 
1386
 
 
1387
    def lock_write(self):
 
1388
        """Take out a logical write lock.
 
1389
 
 
1390
        This will lock the source branch and the target branch. The source gets
 
1391
        a read lock and the target a write lock.
 
1392
        """
 
1393
        self._double_lock(self.source.lock_read, self.target.lock_write)
 
1394
 
 
1395
    @needs_read_lock
 
1396
    def missing_revision_ids(self, revision_id=None):
 
1397
        """Return the revision ids that source has that target does not.
 
1398
        
 
1399
        These are returned in topological order.
 
1400
 
 
1401
        :param revision_id: only return revision ids included by this
 
1402
                            revision_id.
 
1403
        """
 
1404
        # generic, possibly worst case, slow code path.
 
1405
        target_ids = set(self.target.all_revision_ids())
 
1406
        if revision_id is not None:
 
1407
            source_ids = self.source.get_ancestry(revision_id)
 
1408
            assert source_ids.pop(0) == None
 
1409
        else:
 
1410
            source_ids = self.source.all_revision_ids()
 
1411
        result_set = set(source_ids).difference(target_ids)
 
1412
        # this may look like a no-op: its not. It preserves the ordering
 
1413
        # other_ids had while only returning the members from other_ids
 
1414
        # that we've decided we need.
 
1415
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
1416
 
 
1417
    def unlock(self):
 
1418
        """Release the locks on source and target."""
 
1419
        try:
 
1420
            self.target.unlock()
 
1421
        finally:
 
1422
            self.source.unlock()
 
1423
 
 
1424
 
 
1425
class InterWeaveRepo(InterRepository):
 
1426
    """Optimised code paths between Weave based repositories."""
 
1427
 
 
1428
    _matching_repo_format = _default_format
 
1429
    """Repository format for testing with."""
 
1430
 
 
1431
    @staticmethod
 
1432
    def is_compatible(source, target):
 
1433
        """Be compatible with known Weave formats.
 
1434
        
 
1435
        We dont test for the stores being of specific types becase that
 
1436
        could lead to confusing results, and there is no need to be 
 
1437
        overly general.
 
1438
        """
 
1439
        try:
 
1440
            return (isinstance(source._format, (RepositoryFormat5,
 
1441
                                                RepositoryFormat6,
 
1442
                                                RepositoryFormat7)) and
 
1443
                    isinstance(target._format, (RepositoryFormat5,
 
1444
                                                RepositoryFormat6,
 
1445
                                                RepositoryFormat7)))
 
1446
        except AttributeError:
 
1447
            return False
 
1448
    
 
1449
    @needs_write_lock
 
1450
    def copy_content(self, revision_id=None, basis=None):
 
1451
        """See InterRepository.copy_content()."""
 
1452
        # weave specific optimised path:
 
1453
        if basis is not None:
 
1454
            # copy the basis in, then fetch remaining data.
 
1455
            basis.copy_content_into(self.target, revision_id)
 
1456
            # the basis copy_content_into could misset this.
 
1457
            try:
 
1458
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1459
            except NotImplementedError:
 
1460
                pass
 
1461
            self.target.fetch(self.source, revision_id=revision_id)
 
1462
        else:
 
1463
            try:
 
1464
                self.target.set_make_working_trees(self.source.make_working_trees())
 
1465
            except NotImplementedError:
 
1466
                pass
 
1467
            # FIXME do not peek!
 
1468
            if self.source.control_files._transport.listable():
 
1469
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1470
                try:
 
1471
                    self.target.weave_store.copy_all_ids(
 
1472
                        self.source.weave_store,
 
1473
                        pb=pb,
 
1474
                        from_transaction=self.source.get_transaction(),
 
1475
                        to_transaction=self.target.get_transaction())
 
1476
                    pb.update('copying inventory', 0, 1)
 
1477
                    self.target.control_weaves.copy_multi(
 
1478
                        self.source.control_weaves, ['inventory'],
 
1479
                        from_transaction=self.source.get_transaction(),
 
1480
                        to_transaction=self.target.get_transaction())
 
1481
                    self.target._revision_store.text_store.copy_all_ids(
 
1482
                        self.source._revision_store.text_store,
 
1483
                        pb=pb)
 
1484
                finally:
 
1485
                    pb.finished()
 
1486
            else:
 
1487
                self.target.fetch(self.source, revision_id=revision_id)
 
1488
 
 
1489
    @needs_write_lock
 
1490
    def fetch(self, revision_id=None, pb=None):
 
1491
        """See InterRepository.fetch()."""
 
1492
        from bzrlib.fetch import GenericRepoFetcher
 
1493
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1494
               self.source, self.source._format, self.target, self.target._format)
 
1495
        f = GenericRepoFetcher(to_repository=self.target,
 
1496
                               from_repository=self.source,
 
1497
                               last_revision=revision_id,
 
1498
                               pb=pb)
 
1499
        return f.count_copied, f.failed_revisions
 
1500
 
 
1501
    @needs_read_lock
 
1502
    def missing_revision_ids(self, revision_id=None):
 
1503
        """See InterRepository.missing_revision_ids()."""
 
1504
        # we want all revisions to satisfy revision_id in source.
 
1505
        # but we dont want to stat every file here and there.
 
1506
        # we want then, all revisions other needs to satisfy revision_id 
 
1507
        # checked, but not those that we have locally.
 
1508
        # so the first thing is to get a subset of the revisions to 
 
1509
        # satisfy revision_id in source, and then eliminate those that
 
1510
        # we do already have. 
 
1511
        # this is slow on high latency connection to self, but as as this
 
1512
        # disk format scales terribly for push anyway due to rewriting 
 
1513
        # inventory.weave, this is considered acceptable.
 
1514
        # - RBC 20060209
 
1515
        if revision_id is not None:
 
1516
            source_ids = self.source.get_ancestry(revision_id)
 
1517
            assert source_ids.pop(0) == None
 
1518
        else:
 
1519
            source_ids = self.source._all_possible_ids()
 
1520
        source_ids_set = set(source_ids)
 
1521
        # source_ids is the worst possible case we may need to pull.
 
1522
        # now we want to filter source_ids against what we actually
 
1523
        # have in target, but dont try to check for existence where we know
 
1524
        # we do not have a revision as that would be pointless.
 
1525
        target_ids = set(self.target._all_possible_ids())
 
1526
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
1527
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
1528
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
1529
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
1530
        if revision_id is not None:
 
1531
            # we used get_ancestry to determine source_ids then we are assured all
 
1532
            # revisions referenced are present as they are installed in topological order.
 
1533
            # and the tip revision was validated by get_ancestry.
 
1534
            return required_topo_revisions
 
1535
        else:
 
1536
            # if we just grabbed the possibly available ids, then 
 
1537
            # we only have an estimate of whats available and need to validate
 
1538
            # that against the revision records.
 
1539
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
1540
 
 
1541
 
 
1542
class InterKnitRepo(InterRepository):
 
1543
    """Optimised code paths between Knit based repositories."""
 
1544
 
 
1545
    _matching_repo_format = RepositoryFormatKnit1()
 
1546
    """Repository format for testing with."""
 
1547
 
 
1548
    @staticmethod
 
1549
    def is_compatible(source, target):
 
1550
        """Be compatible with known Knit formats.
 
1551
        
 
1552
        We dont test for the stores being of specific types becase that
 
1553
        could lead to confusing results, and there is no need to be 
 
1554
        overly general.
 
1555
        """
 
1556
        try:
 
1557
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
 
1558
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
1559
        except AttributeError:
 
1560
            return False
 
1561
 
 
1562
    @needs_write_lock
 
1563
    def fetch(self, revision_id=None, pb=None):
 
1564
        """See InterRepository.fetch()."""
 
1565
        from bzrlib.fetch import KnitRepoFetcher
 
1566
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
1567
               self.source, self.source._format, self.target, self.target._format)
 
1568
        f = KnitRepoFetcher(to_repository=self.target,
 
1569
                            from_repository=self.source,
 
1570
                            last_revision=revision_id,
 
1571
                            pb=pb)
 
1572
        return f.count_copied, f.failed_revisions
 
1573
 
 
1574
    @needs_read_lock
 
1575
    def missing_revision_ids(self, revision_id=None):
 
1576
        """See InterRepository.missing_revision_ids()."""
 
1577
        if revision_id is not None:
 
1578
            source_ids = self.source.get_ancestry(revision_id)
 
1579
            assert source_ids.pop(0) == None
 
1580
        else:
 
1581
            source_ids = self.source._all_possible_ids()
 
1582
        source_ids_set = set(source_ids)
 
1583
        # source_ids is the worst possible case we may need to pull.
 
1584
        # now we want to filter source_ids against what we actually
 
1585
        # have in target, but dont try to check for existence where we know
 
1586
        # we do not have a revision as that would be pointless.
 
1587
        target_ids = set(self.target._all_possible_ids())
 
1588
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
1589
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
1590
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
1591
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
1592
        if revision_id is not None:
 
1593
            # we used get_ancestry to determine source_ids then we are assured all
 
1594
            # revisions referenced are present as they are installed in topological order.
 
1595
            # and the tip revision was validated by get_ancestry.
 
1596
            return required_topo_revisions
 
1597
        else:
 
1598
            # if we just grabbed the possibly available ids, then 
 
1599
            # we only have an estimate of whats available and need to validate
 
1600
            # that against the revision records.
 
1601
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
1602
 
 
1603
InterRepository.register_optimiser(InterWeaveRepo)
 
1604
InterRepository.register_optimiser(InterKnitRepo)
 
1605
 
 
1606
 
 
1607
class RepositoryTestProviderAdapter(object):
 
1608
    """A tool to generate a suite testing multiple repository formats at once.
 
1609
 
 
1610
    This is done by copying the test once for each transport and injecting
 
1611
    the transport_server, transport_readonly_server, and bzrdir_format and
 
1612
    repository_format classes into each copy. Each copy is also given a new id()
 
1613
    to make it easy to identify.
 
1614
    """
 
1615
 
 
1616
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1617
        self._transport_server = transport_server
 
1618
        self._transport_readonly_server = transport_readonly_server
 
1619
        self._formats = formats
 
1620
    
 
1621
    def adapt(self, test):
 
1622
        result = TestSuite()
 
1623
        for repository_format, bzrdir_format in self._formats:
 
1624
            new_test = deepcopy(test)
 
1625
            new_test.transport_server = self._transport_server
 
1626
            new_test.transport_readonly_server = self._transport_readonly_server
 
1627
            new_test.bzrdir_format = bzrdir_format
 
1628
            new_test.repository_format = repository_format
 
1629
            def make_new_test_id():
 
1630
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
 
1631
                return lambda: new_id
 
1632
            new_test.id = make_new_test_id()
 
1633
            result.addTest(new_test)
 
1634
        return result
 
1635
 
 
1636
 
 
1637
class InterRepositoryTestProviderAdapter(object):
 
1638
    """A tool to generate a suite testing multiple inter repository formats.
 
1639
 
 
1640
    This is done by copying the test once for each interrepo provider and injecting
 
1641
    the transport_server, transport_readonly_server, repository_format and 
 
1642
    repository_to_format classes into each copy.
 
1643
    Each copy is also given a new id() to make it easy to identify.
 
1644
    """
 
1645
 
 
1646
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1647
        self._transport_server = transport_server
 
1648
        self._transport_readonly_server = transport_readonly_server
 
1649
        self._formats = formats
 
1650
    
 
1651
    def adapt(self, test):
 
1652
        result = TestSuite()
 
1653
        for interrepo_class, repository_format, repository_format_to in self._formats:
 
1654
            new_test = deepcopy(test)
 
1655
            new_test.transport_server = self._transport_server
 
1656
            new_test.transport_readonly_server = self._transport_readonly_server
 
1657
            new_test.interrepo_class = interrepo_class
 
1658
            new_test.repository_format = repository_format
 
1659
            new_test.repository_format_to = repository_format_to
 
1660
            def make_new_test_id():
 
1661
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
 
1662
                return lambda: new_id
 
1663
            new_test.id = make_new_test_id()
 
1664
            result.addTest(new_test)
 
1665
        return result
 
1666
 
 
1667
    @staticmethod
 
1668
    def default_test_list():
 
1669
        """Generate the default list of interrepo permutations to test."""
 
1670
        result = []
 
1671
        # test the default InterRepository between format 6 and the current 
 
1672
        # default format.
 
1673
        # XXX: robertc 20060220 reinstate this when there are two supported
 
1674
        # formats which do not have an optimal code path between them.
 
1675
        result.append((InterRepository,
 
1676
                       RepositoryFormat6(),
 
1677
                       RepositoryFormatKnit1()))
 
1678
        for optimiser in InterRepository._optimisers:
 
1679
            result.append((optimiser,
 
1680
                           optimiser._matching_repo_format,
 
1681
                           optimiser._matching_repo_format
 
1682
                           ))
 
1683
        # if there are specific combinations we want to use, we can add them 
 
1684
        # here.
 
1685
        return result
 
1686
 
 
1687
 
 
1688
class CopyConverter(object):
 
1689
    """A repository conversion tool which just performs a copy of the content.
 
1690
    
 
1691
    This is slow but quite reliable.
 
1692
    """
 
1693
 
 
1694
    def __init__(self, target_format):
 
1695
        """Create a CopyConverter.
 
1696
 
 
1697
        :param target_format: The format the resulting repository should be.
 
1698
        """
 
1699
        self.target_format = target_format
 
1700
        
 
1701
    def convert(self, repo, pb):
 
1702
        """Perform the conversion of to_convert, giving feedback via pb.
 
1703
 
 
1704
        :param to_convert: The disk object to convert.
 
1705
        :param pb: a progress bar to use for progress information.
 
1706
        """
 
1707
        self.pb = pb
 
1708
        self.count = 0
 
1709
        self.total = 3
 
1710
        # this is only useful with metadir layouts - separated repo content.
 
1711
        # trigger an assertion if not such
 
1712
        repo._format.get_format_string()
 
1713
        self.repo_dir = repo.bzrdir
 
1714
        self.step('Moving repository to repository.backup')
 
1715
        self.repo_dir.transport.move('repository', 'repository.backup')
 
1716
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
1717
        self.source_repo = repo._format.open(self.repo_dir,
 
1718
            _found=True,
 
1719
            _override_transport=backup_transport)
 
1720
        self.step('Creating new repository')
 
1721
        converted = self.target_format.initialize(self.repo_dir,
 
1722
                                                  self.source_repo.is_shared())
 
1723
        converted.lock_write()
 
1724
        try:
 
1725
            self.step('Copying content into repository.')
 
1726
            self.source_repo.copy_content_into(converted)
 
1727
        finally:
 
1728
            converted.unlock()
 
1729
        self.step('Deleting old repository content.')
 
1730
        self.repo_dir.transport.delete_tree('repository.backup')
 
1731
        self.pb.note('repository converted')
 
1732
 
 
1733
    def step(self, message):
 
1734
        """Update the pb by a step."""
 
1735
        self.count +=1
 
1736
        self.pb.update(message, self.count, self.total)