/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

Rename supports_unix_modebits to _can_roundtrip_unix_modebits for clarity

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