/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

Utf8 safety in knit indexes.

Show diffs side-by-side

added added

removed removed

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