~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/knitrepo.py

  • Committer: Martin Pool
  • Date: 2009-06-19 06:21:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4558.
  • Revision ID: mbp@sourcefrog.net-20090619062113-019bp0a3bl2y4nkx
Un-soft-deprecate _supports_progress - still useful

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from bzrlib.lazy_import import lazy_import
 
18
lazy_import(globals(), """
 
19
from bzrlib import (
 
20
    bzrdir,
 
21
    errors,
 
22
    knit as _mod_knit,
 
23
    lockable_files,
 
24
    lockdir,
 
25
    osutils,
 
26
    revision as _mod_revision,
 
27
    transactions,
 
28
    versionedfile,
 
29
    xml5,
 
30
    xml6,
 
31
    xml7,
 
32
    )
 
33
""")
 
34
from bzrlib import (
 
35
    symbol_versioning,
 
36
    )
 
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
38
from bzrlib.repository import (
 
39
    CommitBuilder,
 
40
    MetaDirRepository,
 
41
    MetaDirRepositoryFormat,
 
42
    RepositoryFormat,
 
43
    RootCommitBuilder,
 
44
    )
 
45
from bzrlib.trace import mutter, mutter_callsite
 
46
 
 
47
 
 
48
class _KnitParentsProvider(object):
 
49
 
 
50
    def __init__(self, knit):
 
51
        self._knit = knit
 
52
 
 
53
    def __repr__(self):
 
54
        return 'KnitParentsProvider(%r)' % self._knit
 
55
 
 
56
    def get_parent_map(self, keys):
 
57
        """See graph.StackedParentsProvider.get_parent_map"""
 
58
        parent_map = {}
 
59
        for revision_id in keys:
 
60
            if revision_id is None:
 
61
                raise ValueError('get_parent_map(None) is not valid')
 
62
            if revision_id == _mod_revision.NULL_REVISION:
 
63
                parent_map[revision_id] = ()
 
64
            else:
 
65
                try:
 
66
                    parents = tuple(
 
67
                        self._knit.get_parents_with_ghosts(revision_id))
 
68
                except errors.RevisionNotPresent:
 
69
                    continue
 
70
                else:
 
71
                    if len(parents) == 0:
 
72
                        parents = (_mod_revision.NULL_REVISION,)
 
73
                parent_map[revision_id] = parents
 
74
        return parent_map
 
75
 
 
76
 
 
77
class _KnitsParentsProvider(object):
 
78
 
 
79
    def __init__(self, knit, prefix=()):
 
80
        """Create a parent provider for string keys mapped to tuple keys."""
 
81
        self._knit = knit
 
82
        self._prefix = prefix
 
83
 
 
84
    def __repr__(self):
 
85
        return 'KnitsParentsProvider(%r)' % self._knit
 
86
 
 
87
    def get_parent_map(self, keys):
 
88
        """See graph.StackedParentsProvider.get_parent_map"""
 
89
        parent_map = self._knit.get_parent_map(
 
90
            [self._prefix + (key,) for key in keys])
 
91
        result = {}
 
92
        for key, parents in parent_map.items():
 
93
            revid = key[-1]
 
94
            if len(parents) == 0:
 
95
                parents = (_mod_revision.NULL_REVISION,)
 
96
            else:
 
97
                parents = tuple(parent[-1] for parent in parents)
 
98
            result[revid] = parents
 
99
        for revision_id in keys:
 
100
            if revision_id == _mod_revision.NULL_REVISION:
 
101
                result[revision_id] = ()
 
102
        return result
 
103
 
 
104
 
 
105
class KnitRepository(MetaDirRepository):
 
106
    """Knit format repository."""
 
107
 
 
108
    # These attributes are inherited from the Repository base class. Setting
 
109
    # them to None ensures that if the constructor is changed to not initialize
 
110
    # them, or a subclass fails to call the constructor, that an error will
 
111
    # occur rather than the system working but generating incorrect data.
 
112
    _commit_builder_class = None
 
113
    _serializer = None
 
114
 
 
115
    def __init__(self, _format, a_bzrdir, control_files, _commit_builder_class,
 
116
        _serializer):
 
117
        MetaDirRepository.__init__(self, _format, a_bzrdir, control_files)
 
118
        self._commit_builder_class = _commit_builder_class
 
119
        self._serializer = _serializer
 
120
        self._reconcile_fixes_text_parents = True
 
121
 
 
122
    @needs_read_lock
 
123
    def _all_revision_ids(self):
 
124
        """See Repository.all_revision_ids()."""
 
125
        return [key[0] for key in self.revisions.keys()]
 
126
 
 
127
    def _activate_new_inventory(self):
 
128
        """Put a replacement inventory.new into use as inventories."""
 
129
        # Copy the content across
 
130
        t = self._transport
 
131
        t.copy('inventory.new.kndx', 'inventory.kndx')
 
132
        try:
 
133
            t.copy('inventory.new.knit', 'inventory.knit')
 
134
        except errors.NoSuchFile:
 
135
            # empty inventories knit
 
136
            t.delete('inventory.knit')
 
137
        # delete the temp inventory
 
138
        t.delete('inventory.new.kndx')
 
139
        try:
 
140
            t.delete('inventory.new.knit')
 
141
        except errors.NoSuchFile:
 
142
            # empty inventories knit
 
143
            pass
 
144
        # Force index reload (sanity check)
 
145
        self.inventories._index._reset_cache()
 
146
        self.inventories.keys()
 
147
 
 
148
    def _backup_inventory(self):
 
149
        t = self._transport
 
150
        t.copy('inventory.kndx', 'inventory.backup.kndx')
 
151
        t.copy('inventory.knit', 'inventory.backup.knit')
 
152
 
 
153
    def _move_file_id(self, from_id, to_id):
 
154
        t = self._transport.clone('knits')
 
155
        from_rel_url = self.texts._index._mapper.map((from_id, None))
 
156
        to_rel_url = self.texts._index._mapper.map((to_id, None))
 
157
        # We expect both files to always exist in this case.
 
158
        for suffix in ('.knit', '.kndx'):
 
159
            t.rename(from_rel_url + suffix, to_rel_url + suffix)
 
160
 
 
161
    def _remove_file_id(self, file_id):
 
162
        t = self._transport.clone('knits')
 
163
        rel_url = self.texts._index._mapper.map((file_id, None))
 
164
        for suffix in ('.kndx', '.knit'):
 
165
            try:
 
166
                t.delete(rel_url + suffix)
 
167
            except errors.NoSuchFile:
 
168
                pass
 
169
 
 
170
    def _temp_inventories(self):
 
171
        result = self._format._get_inventories(self._transport, self,
 
172
            'inventory.new')
 
173
        # Reconciling when the output has no revisions would result in no
 
174
        # writes - but we want to ensure there is an inventory for
 
175
        # compatibility with older clients that don't lazy-load.
 
176
        result.get_parent_map([('A',)])
 
177
        return result
 
178
 
 
179
    def fileid_involved_between_revs(self, from_revid, to_revid):
 
180
        """Find file_id(s) which are involved in the changes between revisions.
 
181
 
 
182
        This determines the set of revisions which are involved, and then
 
183
        finds all file ids affected by those revisions.
 
184
        """
 
185
        vf = self._get_revision_vf()
 
186
        from_set = set(vf.get_ancestry(from_revid))
 
187
        to_set = set(vf.get_ancestry(to_revid))
 
188
        changed = to_set.difference(from_set)
 
189
        return self._fileid_involved_by_set(changed)
 
190
 
 
191
    def fileid_involved(self, last_revid=None):
 
192
        """Find all file_ids modified in the ancestry of last_revid.
 
193
 
 
194
        :param last_revid: If None, last_revision() will be used.
 
195
        """
 
196
        if not last_revid:
 
197
            changed = set(self.all_revision_ids())
 
198
        else:
 
199
            changed = set(self.get_ancestry(last_revid))
 
200
        if None in changed:
 
201
            changed.remove(None)
 
202
        return self._fileid_involved_by_set(changed)
 
203
 
 
204
    @needs_read_lock
 
205
    def get_revision(self, revision_id):
 
206
        """Return the Revision object for a named revision"""
 
207
        revision_id = osutils.safe_revision_id(revision_id)
 
208
        return self.get_revision_reconcile(revision_id)
 
209
 
 
210
    def _refresh_data(self):
 
211
        if not self.is_locked():
 
212
            return
 
213
        # Create a new transaction to force all knits to see the scope change.
 
214
        # This is safe because we're outside a write group.
 
215
        self.control_files._finish_transaction()
 
216
        if self.is_write_locked():
 
217
            self.control_files._set_write_transaction()
 
218
        else:
 
219
            self.control_files._set_read_transaction()
 
220
 
 
221
    @needs_write_lock
 
222
    def reconcile(self, other=None, thorough=False):
 
223
        """Reconcile this repository."""
 
224
        from bzrlib.reconcile import KnitReconciler
 
225
        reconciler = KnitReconciler(self, thorough=thorough)
 
226
        reconciler.reconcile()
 
227
        return reconciler
 
228
 
 
229
    def _make_parents_provider(self):
 
230
        return _KnitsParentsProvider(self.revisions)
 
231
 
 
232
    def _find_inconsistent_revision_parents(self):
 
233
        """Find revisions with different parent lists in the revision object
 
234
        and in the index graph.
 
235
 
 
236
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
 
237
            parents-in-revision).
 
238
        """
 
239
        if not self.is_locked():
 
240
            raise AssertionError()
 
241
        vf = self.revisions
 
242
        for index_version in vf.keys():
 
243
            parent_map = vf.get_parent_map([index_version])
 
244
            parents_according_to_index = tuple(parent[-1] for parent in
 
245
                parent_map[index_version])
 
246
            revision = self.get_revision(index_version[-1])
 
247
            parents_according_to_revision = tuple(revision.parent_ids)
 
248
            if parents_according_to_index != parents_according_to_revision:
 
249
                yield (index_version[-1], parents_according_to_index,
 
250
                    parents_according_to_revision)
 
251
 
 
252
    def _check_for_inconsistent_revision_parents(self):
 
253
        inconsistencies = list(self._find_inconsistent_revision_parents())
 
254
        if inconsistencies:
 
255
            raise errors.BzrCheckError(
 
256
                "Revision knit has inconsistent parents.")
 
257
 
 
258
    def revision_graph_can_have_wrong_parents(self):
 
259
        # The revision.kndx could potentially claim a revision has a different
 
260
        # parent to the revision text.
 
261
        return True
 
262
 
 
263
 
 
264
class RepositoryFormatKnit(MetaDirRepositoryFormat):
 
265
    """Bzr repository knit format (generalized).
 
266
 
 
267
    This repository format has:
 
268
     - knits for file texts and inventory
 
269
     - hash subdirectory based stores.
 
270
     - knits for revisions and signatures
 
271
     - TextStores for revisions and signatures.
 
272
     - a format marker of its own
 
273
     - an optional 'shared-storage' flag
 
274
     - an optional 'no-working-trees' flag
 
275
     - a LockDir lock
 
276
    """
 
277
 
 
278
    # Set this attribute in derived classes to control the repository class
 
279
    # created by open and initialize.
 
280
    repository_class = None
 
281
    # Set this attribute in derived classes to control the
 
282
    # _commit_builder_class that the repository objects will have passed to
 
283
    # their constructor.
 
284
    _commit_builder_class = None
 
285
    # Set this attribute in derived clases to control the _serializer that the
 
286
    # repository objects will have passed to their constructor.
 
287
    @property
 
288
    def _serializer(self):
 
289
        return xml5.serializer_v5
 
290
    # Knit based repositories handle ghosts reasonably well.
 
291
    supports_ghosts = True
 
292
    # External lookups are not supported in this format.
 
293
    supports_external_lookups = False
 
294
    # No CHK support.
 
295
    supports_chks = False
 
296
    _fetch_order = 'topological'
 
297
    _fetch_uses_deltas = True
 
298
    fast_deltas = False
 
299
 
 
300
    def _get_inventories(self, repo_transport, repo, name='inventory'):
 
301
        mapper = versionedfile.ConstantMapper(name)
 
302
        index = _mod_knit._KndxIndex(repo_transport, mapper,
 
303
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
 
304
        access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
 
305
        return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
 
306
 
 
307
    def _get_revisions(self, repo_transport, repo):
 
308
        mapper = versionedfile.ConstantMapper('revisions')
 
309
        index = _mod_knit._KndxIndex(repo_transport, mapper,
 
310
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
 
311
        access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
 
312
        return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
 
313
            annotated=False)
 
314
 
 
315
    def _get_signatures(self, repo_transport, repo):
 
316
        mapper = versionedfile.ConstantMapper('signatures')
 
317
        index = _mod_knit._KndxIndex(repo_transport, mapper,
 
318
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
 
319
        access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
 
320
        return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
 
321
            annotated=False)
 
322
 
 
323
    def _get_texts(self, repo_transport, repo):
 
324
        mapper = versionedfile.HashEscapedPrefixMapper()
 
325
        base_transport = repo_transport.clone('knits')
 
326
        index = _mod_knit._KndxIndex(base_transport, mapper,
 
327
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
 
328
        access = _mod_knit._KnitKeyAccess(base_transport, mapper)
 
329
        return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
 
330
            annotated=True)
 
331
 
 
332
    def initialize(self, a_bzrdir, shared=False):
 
333
        """Create a knit format 1 repository.
 
334
 
 
335
        :param a_bzrdir: bzrdir to contain the new repository; must already
 
336
            be initialized.
 
337
        :param shared: If true the repository will be initialized as a shared
 
338
                       repository.
 
339
        """
 
340
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
341
        dirs = ['knits']
 
342
        files = []
 
343
        utf8_files = [('format', self.get_format_string())]
 
344
 
 
345
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
346
        repo_transport = a_bzrdir.get_repository_transport(None)
 
347
        control_files = lockable_files.LockableFiles(repo_transport,
 
348
                                'lock', lockdir.LockDir)
 
349
        transaction = transactions.WriteTransaction()
 
350
        result = self.open(a_bzrdir=a_bzrdir, _found=True)
 
351
        result.lock_write()
 
352
        # the revision id here is irrelevant: it will not be stored, and cannot
 
353
        # already exist, we do this to create files on disk for older clients.
 
354
        result.inventories.get_parent_map([('A',)])
 
355
        result.revisions.get_parent_map([('A',)])
 
356
        result.signatures.get_parent_map([('A',)])
 
357
        result.unlock()
 
358
        return result
 
359
 
 
360
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
361
        """See RepositoryFormat.open().
 
362
 
 
363
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
364
                                    repository at a slightly different url
 
365
                                    than normal. I.e. during 'upgrade'.
 
366
        """
 
367
        if not _found:
 
368
            format = RepositoryFormat.find_format(a_bzrdir)
 
369
        if _override_transport is not None:
 
370
            repo_transport = _override_transport
 
371
        else:
 
372
            repo_transport = a_bzrdir.get_repository_transport(None)
 
373
        control_files = lockable_files.LockableFiles(repo_transport,
 
374
                                'lock', lockdir.LockDir)
 
375
        repo = self.repository_class(_format=self,
 
376
                              a_bzrdir=a_bzrdir,
 
377
                              control_files=control_files,
 
378
                              _commit_builder_class=self._commit_builder_class,
 
379
                              _serializer=self._serializer)
 
380
        repo.revisions = self._get_revisions(repo_transport, repo)
 
381
        repo.signatures = self._get_signatures(repo_transport, repo)
 
382
        repo.inventories = self._get_inventories(repo_transport, repo)
 
383
        repo.texts = self._get_texts(repo_transport, repo)
 
384
        repo.chk_bytes = None
 
385
        repo._transport = repo_transport
 
386
        return repo
 
387
 
 
388
 
 
389
class RepositoryFormatKnit1(RepositoryFormatKnit):
 
390
    """Bzr repository knit format 1.
 
391
 
 
392
    This repository format has:
 
393
     - knits for file texts and inventory
 
394
     - hash subdirectory based stores.
 
395
     - knits for revisions and signatures
 
396
     - TextStores for revisions and signatures.
 
397
     - a format marker of its own
 
398
     - an optional 'shared-storage' flag
 
399
     - an optional 'no-working-trees' flag
 
400
     - a LockDir lock
 
401
 
 
402
    This format was introduced in bzr 0.8.
 
403
    """
 
404
 
 
405
    repository_class = KnitRepository
 
406
    _commit_builder_class = CommitBuilder
 
407
    @property
 
408
    def _serializer(self):
 
409
        return xml5.serializer_v5
 
410
 
 
411
    def __ne__(self, other):
 
412
        return self.__class__ is not other.__class__
 
413
 
 
414
    def get_format_string(self):
 
415
        """See RepositoryFormat.get_format_string()."""
 
416
        return "Bazaar-NG Knit Repository Format 1"
 
417
 
 
418
    def get_format_description(self):
 
419
        """See RepositoryFormat.get_format_description()."""
 
420
        return "Knit repository format 1"
 
421
 
 
422
    def check_conversion_target(self, target_format):
 
423
        pass
 
424
 
 
425
 
 
426
class RepositoryFormatKnit3(RepositoryFormatKnit):
 
427
    """Bzr repository knit format 3.
 
428
 
 
429
    This repository format has:
 
430
     - knits for file texts and inventory
 
431
     - hash subdirectory based stores.
 
432
     - knits for revisions and signatures
 
433
     - TextStores for revisions and signatures.
 
434
     - a format marker of its own
 
435
     - an optional 'shared-storage' flag
 
436
     - an optional 'no-working-trees' flag
 
437
     - a LockDir lock
 
438
     - support for recording full info about the tree root
 
439
     - support for recording tree-references
 
440
    """
 
441
 
 
442
    repository_class = KnitRepository
 
443
    _commit_builder_class = RootCommitBuilder
 
444
    rich_root_data = True
 
445
    supports_tree_reference = True
 
446
    @property
 
447
    def _serializer(self):
 
448
        return xml7.serializer_v7
 
449
 
 
450
    def _get_matching_bzrdir(self):
 
451
        return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
 
452
 
 
453
    def _ignore_setting_bzrdir(self, format):
 
454
        pass
 
455
 
 
456
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
457
 
 
458
    def check_conversion_target(self, target_format):
 
459
        if not target_format.rich_root_data:
 
460
            raise errors.BadConversionTarget(
 
461
                'Does not support rich root data.', target_format)
 
462
        if not getattr(target_format, 'supports_tree_reference', False):
 
463
            raise errors.BadConversionTarget(
 
464
                'Does not support nested trees', target_format)
 
465
 
 
466
    def get_format_string(self):
 
467
        """See RepositoryFormat.get_format_string()."""
 
468
        return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
 
469
 
 
470
    def get_format_description(self):
 
471
        """See RepositoryFormat.get_format_description()."""
 
472
        return "Knit repository format 3"
 
473
 
 
474
 
 
475
class RepositoryFormatKnit4(RepositoryFormatKnit):
 
476
    """Bzr repository knit format 4.
 
477
 
 
478
    This repository format has everything in format 3, except for
 
479
    tree-references:
 
480
     - knits for file texts and inventory
 
481
     - hash subdirectory based stores.
 
482
     - knits for revisions and signatures
 
483
     - TextStores for revisions and signatures.
 
484
     - a format marker of its own
 
485
     - an optional 'shared-storage' flag
 
486
     - an optional 'no-working-trees' flag
 
487
     - a LockDir lock
 
488
     - support for recording full info about the tree root
 
489
    """
 
490
 
 
491
    repository_class = KnitRepository
 
492
    _commit_builder_class = RootCommitBuilder
 
493
    rich_root_data = True
 
494
    supports_tree_reference = False
 
495
    @property
 
496
    def _serializer(self):
 
497
        return xml6.serializer_v6
 
498
 
 
499
    def _get_matching_bzrdir(self):
 
500
        return bzrdir.format_registry.make_bzrdir('rich-root')
 
501
 
 
502
    def _ignore_setting_bzrdir(self, format):
 
503
        pass
 
504
 
 
505
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
 
506
 
 
507
    def check_conversion_target(self, target_format):
 
508
        if not target_format.rich_root_data:
 
509
            raise errors.BadConversionTarget(
 
510
                'Does not support rich root data.', target_format)
 
511
 
 
512
    def get_format_string(self):
 
513
        """See RepositoryFormat.get_format_string()."""
 
514
        return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
 
515
 
 
516
    def get_format_description(self):
 
517
        """See RepositoryFormat.get_format_description()."""
 
518
        return "Knit repository format 4"