~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/knitrepo.py

- rules for using destructors

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, revisions_iterator=None):
233
 
        """Find revisions with different parent lists in the revision object
234
 
        and in the index graph.
235
 
 
236
 
        :param revisions_iterator: None, or an iterator of (revid,
237
 
            Revision-or-None). This iterator controls the revisions checked.
238
 
        :returns: an iterator yielding tuples of (revison-id, parents-in-index,
239
 
            parents-in-revision).
240
 
        """
241
 
        if not self.is_locked():
242
 
            raise AssertionError()
243
 
        vf = self.revisions
244
 
        if revisions_iterator is None:
245
 
            revisions_iterator = self._iter_revisions(None)
246
 
        for revid, revision in revisions_iterator:
247
 
            if revision is None:
248
 
                pass
249
 
            parent_map = vf.get_parent_map([(revid,)])
250
 
            parents_according_to_index = tuple(parent[-1] for parent in
251
 
                parent_map[(revid,)])
252
 
            parents_according_to_revision = tuple(revision.parent_ids)
253
 
            if parents_according_to_index != parents_according_to_revision:
254
 
                yield (revid, parents_according_to_index,
255
 
                    parents_according_to_revision)
256
 
 
257
 
    def _check_for_inconsistent_revision_parents(self):
258
 
        inconsistencies = list(self._find_inconsistent_revision_parents())
259
 
        if inconsistencies:
260
 
            raise errors.BzrCheckError(
261
 
                "Revision knit has inconsistent parents.")
262
 
 
263
 
    def revision_graph_can_have_wrong_parents(self):
264
 
        # The revision.kndx could potentially claim a revision has a different
265
 
        # parent to the revision text.
266
 
        return True
267
 
 
268
 
 
269
 
class RepositoryFormatKnit(MetaDirRepositoryFormat):
270
 
    """Bzr repository knit format (generalized).
271
 
 
272
 
    This repository format has:
273
 
     - knits for file texts and inventory
274
 
     - hash subdirectory based stores.
275
 
     - knits for revisions and signatures
276
 
     - TextStores for revisions and signatures.
277
 
     - a format marker of its own
278
 
     - an optional 'shared-storage' flag
279
 
     - an optional 'no-working-trees' flag
280
 
     - a LockDir lock
281
 
    """
282
 
 
283
 
    # Set this attribute in derived classes to control the repository class
284
 
    # created by open and initialize.
285
 
    repository_class = None
286
 
    # Set this attribute in derived classes to control the
287
 
    # _commit_builder_class that the repository objects will have passed to
288
 
    # their constructor.
289
 
    _commit_builder_class = None
290
 
    # Set this attribute in derived clases to control the _serializer that the
291
 
    # repository objects will have passed to their constructor.
292
 
    @property
293
 
    def _serializer(self):
294
 
        return xml5.serializer_v5
295
 
    # Knit based repositories handle ghosts reasonably well.
296
 
    supports_ghosts = True
297
 
    # External lookups are not supported in this format.
298
 
    supports_external_lookups = False
299
 
    # No CHK support.
300
 
    supports_chks = False
301
 
    _fetch_order = 'topological'
302
 
    _fetch_uses_deltas = True
303
 
    fast_deltas = False
304
 
 
305
 
    def _get_inventories(self, repo_transport, repo, name='inventory'):
306
 
        mapper = versionedfile.ConstantMapper(name)
307
 
        index = _mod_knit._KndxIndex(repo_transport, mapper,
308
 
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
309
 
        access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
310
 
        return _mod_knit.KnitVersionedFiles(index, access, annotated=False)
311
 
 
312
 
    def _get_revisions(self, repo_transport, repo):
313
 
        mapper = versionedfile.ConstantMapper('revisions')
314
 
        index = _mod_knit._KndxIndex(repo_transport, mapper,
315
 
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
316
 
        access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
317
 
        return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
318
 
            annotated=False)
319
 
 
320
 
    def _get_signatures(self, repo_transport, repo):
321
 
        mapper = versionedfile.ConstantMapper('signatures')
322
 
        index = _mod_knit._KndxIndex(repo_transport, mapper,
323
 
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
324
 
        access = _mod_knit._KnitKeyAccess(repo_transport, mapper)
325
 
        return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=0,
326
 
            annotated=False)
327
 
 
328
 
    def _get_texts(self, repo_transport, repo):
329
 
        mapper = versionedfile.HashEscapedPrefixMapper()
330
 
        base_transport = repo_transport.clone('knits')
331
 
        index = _mod_knit._KndxIndex(base_transport, mapper,
332
 
            repo.get_transaction, repo.is_write_locked, repo.is_locked)
333
 
        access = _mod_knit._KnitKeyAccess(base_transport, mapper)
334
 
        return _mod_knit.KnitVersionedFiles(index, access, max_delta_chain=200,
335
 
            annotated=True)
336
 
 
337
 
    def initialize(self, a_bzrdir, shared=False):
338
 
        """Create a knit format 1 repository.
339
 
 
340
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
341
 
            be initialized.
342
 
        :param shared: If true the repository will be initialized as a shared
343
 
                       repository.
344
 
        """
345
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
346
 
        dirs = ['knits']
347
 
        files = []
348
 
        utf8_files = [('format', self.get_format_string())]
349
 
 
350
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
351
 
        repo_transport = a_bzrdir.get_repository_transport(None)
352
 
        control_files = lockable_files.LockableFiles(repo_transport,
353
 
                                'lock', lockdir.LockDir)
354
 
        transaction = transactions.WriteTransaction()
355
 
        result = self.open(a_bzrdir=a_bzrdir, _found=True)
356
 
        result.lock_write()
357
 
        # the revision id here is irrelevant: it will not be stored, and cannot
358
 
        # already exist, we do this to create files on disk for older clients.
359
 
        result.inventories.get_parent_map([('A',)])
360
 
        result.revisions.get_parent_map([('A',)])
361
 
        result.signatures.get_parent_map([('A',)])
362
 
        result.unlock()
363
 
        return result
364
 
 
365
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
366
 
        """See RepositoryFormat.open().
367
 
 
368
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
369
 
                                    repository at a slightly different url
370
 
                                    than normal. I.e. during 'upgrade'.
371
 
        """
372
 
        if not _found:
373
 
            format = RepositoryFormat.find_format(a_bzrdir)
374
 
        if _override_transport is not None:
375
 
            repo_transport = _override_transport
376
 
        else:
377
 
            repo_transport = a_bzrdir.get_repository_transport(None)
378
 
        control_files = lockable_files.LockableFiles(repo_transport,
379
 
                                'lock', lockdir.LockDir)
380
 
        repo = self.repository_class(_format=self,
381
 
                              a_bzrdir=a_bzrdir,
382
 
                              control_files=control_files,
383
 
                              _commit_builder_class=self._commit_builder_class,
384
 
                              _serializer=self._serializer)
385
 
        repo.revisions = self._get_revisions(repo_transport, repo)
386
 
        repo.signatures = self._get_signatures(repo_transport, repo)
387
 
        repo.inventories = self._get_inventories(repo_transport, repo)
388
 
        repo.texts = self._get_texts(repo_transport, repo)
389
 
        repo.chk_bytes = None
390
 
        repo._transport = repo_transport
391
 
        return repo
392
 
 
393
 
 
394
 
class RepositoryFormatKnit1(RepositoryFormatKnit):
395
 
    """Bzr repository knit format 1.
396
 
 
397
 
    This repository format has:
398
 
     - knits for file texts and inventory
399
 
     - hash subdirectory based stores.
400
 
     - knits for revisions and signatures
401
 
     - TextStores for revisions and signatures.
402
 
     - a format marker of its own
403
 
     - an optional 'shared-storage' flag
404
 
     - an optional 'no-working-trees' flag
405
 
     - a LockDir lock
406
 
 
407
 
    This format was introduced in bzr 0.8.
408
 
    """
409
 
 
410
 
    repository_class = KnitRepository
411
 
    _commit_builder_class = CommitBuilder
412
 
    @property
413
 
    def _serializer(self):
414
 
        return xml5.serializer_v5
415
 
 
416
 
    def __ne__(self, other):
417
 
        return self.__class__ is not other.__class__
418
 
 
419
 
    def get_format_string(self):
420
 
        """See RepositoryFormat.get_format_string()."""
421
 
        return "Bazaar-NG Knit Repository Format 1"
422
 
 
423
 
    def get_format_description(self):
424
 
        """See RepositoryFormat.get_format_description()."""
425
 
        return "Knit repository format 1"
426
 
 
427
 
 
428
 
class RepositoryFormatKnit3(RepositoryFormatKnit):
429
 
    """Bzr repository knit format 3.
430
 
 
431
 
    This repository format has:
432
 
     - knits for file texts and inventory
433
 
     - hash subdirectory based stores.
434
 
     - knits for revisions and signatures
435
 
     - TextStores for revisions and signatures.
436
 
     - a format marker of its own
437
 
     - an optional 'shared-storage' flag
438
 
     - an optional 'no-working-trees' flag
439
 
     - a LockDir lock
440
 
     - support for recording full info about the tree root
441
 
     - support for recording tree-references
442
 
    """
443
 
 
444
 
    repository_class = KnitRepository
445
 
    _commit_builder_class = RootCommitBuilder
446
 
    rich_root_data = True
447
 
    experimental = True
448
 
    supports_tree_reference = True
449
 
    @property
450
 
    def _serializer(self):
451
 
        return xml7.serializer_v7
452
 
 
453
 
    def _get_matching_bzrdir(self):
454
 
        return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
455
 
 
456
 
    def _ignore_setting_bzrdir(self, format):
457
 
        pass
458
 
 
459
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
460
 
 
461
 
    def get_format_string(self):
462
 
        """See RepositoryFormat.get_format_string()."""
463
 
        return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
464
 
 
465
 
    def get_format_description(self):
466
 
        """See RepositoryFormat.get_format_description()."""
467
 
        return "Knit repository format 3"
468
 
 
469
 
 
470
 
class RepositoryFormatKnit4(RepositoryFormatKnit):
471
 
    """Bzr repository knit format 4.
472
 
 
473
 
    This repository format has everything in format 3, except for
474
 
    tree-references:
475
 
     - knits for file texts and inventory
476
 
     - hash subdirectory based stores.
477
 
     - knits for revisions and signatures
478
 
     - TextStores for revisions and signatures.
479
 
     - a format marker of its own
480
 
     - an optional 'shared-storage' flag
481
 
     - an optional 'no-working-trees' flag
482
 
     - a LockDir lock
483
 
     - support for recording full info about the tree root
484
 
    """
485
 
 
486
 
    repository_class = KnitRepository
487
 
    _commit_builder_class = RootCommitBuilder
488
 
    rich_root_data = True
489
 
    supports_tree_reference = False
490
 
    @property
491
 
    def _serializer(self):
492
 
        return xml6.serializer_v6
493
 
 
494
 
    def _get_matching_bzrdir(self):
495
 
        return bzrdir.format_registry.make_bzrdir('rich-root')
496
 
 
497
 
    def _ignore_setting_bzrdir(self, format):
498
 
        pass
499
 
 
500
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
501
 
 
502
 
    def get_format_string(self):
503
 
        """See RepositoryFormat.get_format_string()."""
504
 
        return 'Bazaar Knit Repository Format 4 (bzr 1.0)\n'
505
 
 
506
 
    def get_format_description(self):
507
 
        """See RepositoryFormat.get_format_description()."""
508
 
        return "Knit repository format 4"