~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/knitrepo.py

  • Committer: Martin Pool
  • Date: 2005-06-22 06:37:43 UTC
  • Revision ID: mbp@sourcefrog.net-20050622063743-e395f04c4db8977f
- move old blackbox code from testbzr into bzrlib.selftest.blackbox

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from bzrlib import (
18
 
    bzrdir,
19
 
    deprecated_graph,
20
 
    errors,
21
 
    knit,
22
 
    lockable_files,
23
 
    lockdir,
24
 
    osutils,
25
 
    transactions,
26
 
    xml5,
27
 
    xml7,
28
 
    )
29
 
 
30
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
 
from bzrlib.repository import (
32
 
    MetaDirRepository,
33
 
    MetaDirRepositoryFormat,
34
 
    RepositoryFormat,
35
 
    RootCommitBuilder,
36
 
    )
37
 
import bzrlib.revision as _mod_revision
38
 
from bzrlib.store.versioned import VersionedFileStore
39
 
from bzrlib.trace import mutter, note, warning
40
 
 
41
 
 
42
 
class _KnitParentsProvider(object):
43
 
 
44
 
    def __init__(self, knit):
45
 
        self._knit = knit
46
 
 
47
 
    def __repr__(self):
48
 
        return 'KnitParentsProvider(%r)' % self._knit
49
 
 
50
 
    def get_parents(self, revision_ids):
51
 
        parents_list = []
52
 
        for revision_id in revision_ids:
53
 
            if revision_id == _mod_revision.NULL_REVISION:
54
 
                parents = []
55
 
            else:
56
 
                try:
57
 
                    parents = self._knit.get_parents_with_ghosts(revision_id)
58
 
                except errors.RevisionNotPresent:
59
 
                    parents = None
60
 
                else:
61
 
                    if len(parents) == 0:
62
 
                        parents = [_mod_revision.NULL_REVISION]
63
 
            parents_list.append(parents)
64
 
        return parents_list
65
 
 
66
 
 
67
 
class KnitRepository(MetaDirRepository):
68
 
    """Knit format repository."""
69
 
 
70
 
    _serializer = xml5.serializer_v5
71
 
 
72
 
    def _warn_if_deprecated(self):
73
 
        # This class isn't deprecated
74
 
        pass
75
 
 
76
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
77
 
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
78
 
 
79
 
    @needs_read_lock
80
 
    def _all_revision_ids(self):
81
 
        """See Repository.all_revision_ids()."""
82
 
        # Knits get the revision graph from the index of the revision knit, so
83
 
        # it's always possible even if they're on an unlistable transport.
84
 
        return self._revision_store.all_revision_ids(self.get_transaction())
85
 
 
86
 
    def fileid_involved_between_revs(self, from_revid, to_revid):
87
 
        """Find file_id(s) which are involved in the changes between revisions.
88
 
 
89
 
        This determines the set of revisions which are involved, and then
90
 
        finds all file ids affected by those revisions.
91
 
        """
92
 
        from_revid = osutils.safe_revision_id(from_revid)
93
 
        to_revid = osutils.safe_revision_id(to_revid)
94
 
        vf = self._get_revision_vf()
95
 
        from_set = set(vf.get_ancestry(from_revid))
96
 
        to_set = set(vf.get_ancestry(to_revid))
97
 
        changed = to_set.difference(from_set)
98
 
        return self._fileid_involved_by_set(changed)
99
 
 
100
 
    def fileid_involved(self, last_revid=None):
101
 
        """Find all file_ids modified in the ancestry of last_revid.
102
 
 
103
 
        :param last_revid: If None, last_revision() will be used.
104
 
        """
105
 
        if not last_revid:
106
 
            changed = set(self.all_revision_ids())
107
 
        else:
108
 
            changed = set(self.get_ancestry(last_revid))
109
 
        if None in changed:
110
 
            changed.remove(None)
111
 
        return self._fileid_involved_by_set(changed)
112
 
 
113
 
    @needs_read_lock
114
 
    def get_ancestry(self, revision_id, topo_sorted=True):
115
 
        """Return a list of revision-ids integrated by a revision.
116
 
        
117
 
        This is topologically sorted, unless 'topo_sorted' is specified as
118
 
        False.
119
 
        """
120
 
        if revision_id is None:
121
 
            return [None]
122
 
        revision_id = osutils.safe_revision_id(revision_id)
123
 
        vf = self._get_revision_vf()
124
 
        try:
125
 
            return [None] + vf.get_ancestry(revision_id, topo_sorted)
126
 
        except errors.RevisionNotPresent:
127
 
            raise errors.NoSuchRevision(self, revision_id)
128
 
 
129
 
    @needs_read_lock
130
 
    def get_revision(self, revision_id):
131
 
        """Return the Revision object for a named revision"""
132
 
        revision_id = osutils.safe_revision_id(revision_id)
133
 
        return self.get_revision_reconcile(revision_id)
134
 
 
135
 
    @needs_read_lock
136
 
    def get_revision_graph(self, revision_id=None):
137
 
        """Return a dictionary containing the revision graph.
138
 
 
139
 
        :param revision_id: The revision_id to get a graph from. If None, then
140
 
        the entire revision graph is returned. This is a deprecated mode of
141
 
        operation and will be removed in the future.
142
 
        :return: a dictionary of revision_id->revision_parents_list.
143
 
        """
144
 
        # special case NULL_REVISION
145
 
        if revision_id == _mod_revision.NULL_REVISION:
146
 
            return {}
147
 
        revision_id = osutils.safe_revision_id(revision_id)
148
 
        a_weave = self._get_revision_vf()
149
 
        entire_graph = a_weave.get_graph()
150
 
        if revision_id is None:
151
 
            return a_weave.get_graph()
152
 
        elif revision_id not in a_weave:
153
 
            raise errors.NoSuchRevision(self, revision_id)
154
 
        else:
155
 
            # add what can be reached from revision_id
156
 
            result = {}
157
 
            pending = set([revision_id])
158
 
            while len(pending) > 0:
159
 
                node = pending.pop()
160
 
                result[node] = a_weave.get_parents(node)
161
 
                for revision_id in result[node]:
162
 
                    if revision_id not in result:
163
 
                        pending.add(revision_id)
164
 
            return result
165
 
 
166
 
    @needs_read_lock
167
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
168
 
        """Return a graph of the revisions with ghosts marked as applicable.
169
 
 
170
 
        :param revision_ids: an iterable of revisions to graph or None for all.
171
 
        :return: a Graph object with the graph reachable from revision_ids.
172
 
        """
173
 
        result = deprecated_graph.Graph()
174
 
        vf = self._get_revision_vf()
175
 
        versions = set(vf.versions())
176
 
        if not revision_ids:
177
 
            pending = set(self.all_revision_ids())
178
 
            required = set([])
179
 
        else:
180
 
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
181
 
            # special case NULL_REVISION
182
 
            if _mod_revision.NULL_REVISION in pending:
183
 
                pending.remove(_mod_revision.NULL_REVISION)
184
 
            required = set(pending)
185
 
        done = set([])
186
 
        while len(pending):
187
 
            revision_id = pending.pop()
188
 
            if not revision_id in versions:
189
 
                if revision_id in required:
190
 
                    raise errors.NoSuchRevision(self, revision_id)
191
 
                # a ghost
192
 
                result.add_ghost(revision_id)
193
 
                # mark it as done so we don't try for it again.
194
 
                done.add(revision_id)
195
 
                continue
196
 
            parent_ids = vf.get_parents_with_ghosts(revision_id)
197
 
            for parent_id in parent_ids:
198
 
                # is this queued or done ?
199
 
                if (parent_id not in pending and
200
 
                    parent_id not in done):
201
 
                    # no, queue it.
202
 
                    pending.add(parent_id)
203
 
            result.add_node(revision_id, parent_ids)
204
 
            done.add(revision_id)
205
 
        return result
206
 
 
207
 
    def _get_revision_vf(self):
208
 
        """:return: a versioned file containing the revisions."""
209
 
        vf = self._revision_store.get_revision_file(self.get_transaction())
210
 
        return vf
211
 
 
212
 
    def _get_history_vf(self):
213
 
        """Get a versionedfile whose history graph reflects all revisions.
214
 
 
215
 
        For knit repositories, this is the revision knit.
216
 
        """
217
 
        return self._get_revision_vf()
218
 
 
219
 
    @needs_write_lock
220
 
    def reconcile(self, other=None, thorough=False):
221
 
        """Reconcile this repository."""
222
 
        from bzrlib.reconcile import KnitReconciler
223
 
        reconciler = KnitReconciler(self, thorough=thorough)
224
 
        reconciler.reconcile()
225
 
        return reconciler
226
 
    
227
 
    def revision_parents(self, revision_id):
228
 
        revision_id = osutils.safe_revision_id(revision_id)
229
 
        return self._get_revision_vf().get_parents(revision_id)
230
 
 
231
 
    def _make_parents_provider(self):
232
 
        return _KnitParentsProvider(self._get_revision_vf())
233
 
 
234
 
 
235
 
class KnitRepository3(KnitRepository):
236
 
 
237
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store,
238
 
                 control_store, text_store):
239
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
240
 
                              _revision_store, control_store, text_store)
241
 
        self._serializer = xml7.serializer_v7
242
 
 
243
 
    def deserialise_inventory(self, revision_id, xml):
244
 
        """Transform the xml into an inventory object. 
245
 
 
246
 
        :param revision_id: The expected revision id of the inventory.
247
 
        :param xml: A serialised inventory.
248
 
        """
249
 
        result = self._serializer.read_inventory_from_string(xml)
250
 
        assert result.root.revision is not None
251
 
        return result
252
 
 
253
 
    def serialise_inventory(self, inv):
254
 
        """Transform the inventory object into XML text.
255
 
 
256
 
        :param revision_id: The expected revision id of the inventory.
257
 
        :param xml: A serialised inventory.
258
 
        """
259
 
        assert inv.revision_id is not None
260
 
        assert inv.root.revision is not None
261
 
        return KnitRepository.serialise_inventory(self, inv)
262
 
 
263
 
    def get_commit_builder(self, branch, parents, config, timestamp=None,
264
 
                           timezone=None, committer=None, revprops=None,
265
 
                           revision_id=None):
266
 
        """Obtain a CommitBuilder for this repository.
267
 
        
268
 
        :param branch: Branch to commit to.
269
 
        :param parents: Revision ids of the parents of the new revision.
270
 
        :param config: Configuration to use.
271
 
        :param timestamp: Optional timestamp recorded for commit.
272
 
        :param timezone: Optional timezone for timestamp.
273
 
        :param committer: Optional committer to set for commit.
274
 
        :param revprops: Optional dictionary of revision properties.
275
 
        :param revision_id: Optional revision id.
276
 
        """
277
 
        revision_id = osutils.safe_revision_id(revision_id)
278
 
        return RootCommitBuilder(self, parents, config, timestamp, timezone,
279
 
                                 committer, revprops, revision_id)
280
 
 
281
 
 
282
 
class RepositoryFormatKnit(MetaDirRepositoryFormat):
283
 
    """Bzr repository knit format (generalized). 
284
 
 
285
 
    This repository format has:
286
 
     - knits for file texts and inventory
287
 
     - hash subdirectory based stores.
288
 
     - knits for revisions and signatures
289
 
     - TextStores for revisions and signatures.
290
 
     - a format marker of its own
291
 
     - an optional 'shared-storage' flag
292
 
     - an optional 'no-working-trees' flag
293
 
     - a LockDir lock
294
 
    """
295
 
 
296
 
    def _get_control_store(self, repo_transport, control_files):
297
 
        """Return the control store for this repository."""
298
 
        return VersionedFileStore(
299
 
            repo_transport,
300
 
            prefixed=False,
301
 
            file_mode=control_files._file_mode,
302
 
            versionedfile_class=knit.KnitVersionedFile,
303
 
            versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
304
 
            )
305
 
 
306
 
    def _get_revision_store(self, repo_transport, control_files):
307
 
        """See RepositoryFormat._get_revision_store()."""
308
 
        from bzrlib.store.revision.knit import KnitRevisionStore
309
 
        versioned_file_store = VersionedFileStore(
310
 
            repo_transport,
311
 
            file_mode=control_files._file_mode,
312
 
            prefixed=False,
313
 
            precious=True,
314
 
            versionedfile_class=knit.KnitVersionedFile,
315
 
            versionedfile_kwargs={'delta':False,
316
 
                                  'factory':knit.KnitPlainFactory(),
317
 
                                 },
318
 
            escaped=True,
319
 
            )
320
 
        return KnitRevisionStore(versioned_file_store)
321
 
 
322
 
    def _get_text_store(self, transport, control_files):
323
 
        """See RepositoryFormat._get_text_store()."""
324
 
        return self._get_versioned_file_store('knits',
325
 
                                  transport,
326
 
                                  control_files,
327
 
                                  versionedfile_class=knit.KnitVersionedFile,
328
 
                                  versionedfile_kwargs={
329
 
                                      'create_parent_dir':True,
330
 
                                      'delay_create':True,
331
 
                                      'dir_mode':control_files._dir_mode,
332
 
                                  },
333
 
                                  escaped=True)
334
 
 
335
 
    def initialize(self, a_bzrdir, shared=False):
336
 
        """Create a knit format 1 repository.
337
 
 
338
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
339
 
            be initialized.
340
 
        :param shared: If true the repository will be initialized as a shared
341
 
                       repository.
342
 
        """
343
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
344
 
        dirs = ['revision-store', 'knits']
345
 
        files = []
346
 
        utf8_files = [('format', self.get_format_string())]
347
 
        
348
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
349
 
        repo_transport = a_bzrdir.get_repository_transport(None)
350
 
        control_files = lockable_files.LockableFiles(repo_transport,
351
 
                                'lock', lockdir.LockDir)
352
 
        control_store = self._get_control_store(repo_transport, control_files)
353
 
        transaction = transactions.WriteTransaction()
354
 
        # trigger a write of the inventory store.
355
 
        control_store.get_weave_or_empty('inventory', transaction)
356
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
357
 
        # the revision id here is irrelevant: it will not be stored, and cannot
358
 
        # already exist.
359
 
        _revision_store.has_revision_id('A', transaction)
360
 
        _revision_store.get_signature_file(transaction)
361
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
362
 
 
363
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
364
 
        """See RepositoryFormat.open().
365
 
        
366
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
367
 
                                    repository at a slightly different url
368
 
                                    than normal. I.e. during 'upgrade'.
369
 
        """
370
 
        if not _found:
371
 
            format = RepositoryFormat.find_format(a_bzrdir)
372
 
            assert format.__class__ ==  self.__class__
373
 
        if _override_transport is not None:
374
 
            repo_transport = _override_transport
375
 
        else:
376
 
            repo_transport = a_bzrdir.get_repository_transport(None)
377
 
        control_files = lockable_files.LockableFiles(repo_transport,
378
 
                                'lock', lockdir.LockDir)
379
 
        text_store = self._get_text_store(repo_transport, control_files)
380
 
        control_store = self._get_control_store(repo_transport, control_files)
381
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
382
 
        return KnitRepository(_format=self,
383
 
                              a_bzrdir=a_bzrdir,
384
 
                              control_files=control_files,
385
 
                              _revision_store=_revision_store,
386
 
                              control_store=control_store,
387
 
                              text_store=text_store)
388
 
 
389
 
 
390
 
class RepositoryFormatKnit1(RepositoryFormatKnit):
391
 
    """Bzr repository knit format 1.
392
 
 
393
 
    This repository format has:
394
 
     - knits for file texts and inventory
395
 
     - hash subdirectory based stores.
396
 
     - knits for revisions and signatures
397
 
     - TextStores for revisions and signatures.
398
 
     - a format marker of its own
399
 
     - an optional 'shared-storage' flag
400
 
     - an optional 'no-working-trees' flag
401
 
     - a LockDir lock
402
 
 
403
 
    This format was introduced in bzr 0.8.
404
 
    """
405
 
 
406
 
    def __ne__(self, other):
407
 
        return self.__class__ is not other.__class__
408
 
 
409
 
    def get_format_string(self):
410
 
        """See RepositoryFormat.get_format_string()."""
411
 
        return "Bazaar-NG Knit Repository Format 1"
412
 
 
413
 
    def get_format_description(self):
414
 
        """See RepositoryFormat.get_format_description()."""
415
 
        return "Knit repository format 1"
416
 
 
417
 
    def check_conversion_target(self, target_format):
418
 
        pass
419
 
 
420
 
 
421
 
class RepositoryFormatKnit3(RepositoryFormatKnit):
422
 
    """Bzr repository knit format 2.
423
 
 
424
 
    This repository format has:
425
 
     - knits for file texts and inventory
426
 
     - hash subdirectory based stores.
427
 
     - knits for revisions and signatures
428
 
     - TextStores for revisions and signatures.
429
 
     - a format marker of its own
430
 
     - an optional 'shared-storage' flag
431
 
     - an optional 'no-working-trees' flag
432
 
     - a LockDir lock
433
 
     - support for recording full info about the tree root
434
 
     - support for recording tree-references
435
 
    """
436
 
 
437
 
    repository_class = KnitRepository3
438
 
    rich_root_data = True
439
 
    supports_tree_reference = True
440
 
 
441
 
    def _get_matching_bzrdir(self):
442
 
        return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
443
 
 
444
 
    def _ignore_setting_bzrdir(self, format):
445
 
        pass
446
 
 
447
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
448
 
 
449
 
    def check_conversion_target(self, target_format):
450
 
        if not target_format.rich_root_data:
451
 
            raise errors.BadConversionTarget(
452
 
                'Does not support rich root data.', target_format)
453
 
        if not getattr(target_format, 'supports_tree_reference', False):
454
 
            raise errors.BadConversionTarget(
455
 
                'Does not support nested trees', target_format)
456
 
            
457
 
    def get_format_string(self):
458
 
        """See RepositoryFormat.get_format_string()."""
459
 
        return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
460
 
 
461
 
    def get_format_description(self):
462
 
        """See RepositoryFormat.get_format_description()."""
463
 
        return "Knit repository format 3"
464
 
 
465
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
466
 
        """See RepositoryFormat.open().
467
 
        
468
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
469
 
                                    repository at a slightly different url
470
 
                                    than normal. I.e. during 'upgrade'.
471
 
        """
472
 
        if not _found:
473
 
            format = RepositoryFormat.find_format(a_bzrdir)
474
 
            assert format.__class__ ==  self.__class__
475
 
        if _override_transport is not None:
476
 
            repo_transport = _override_transport
477
 
        else:
478
 
            repo_transport = a_bzrdir.get_repository_transport(None)
479
 
        control_files = lockable_files.LockableFiles(repo_transport, 'lock',
480
 
                                                     lockdir.LockDir)
481
 
        text_store = self._get_text_store(repo_transport, control_files)
482
 
        control_store = self._get_control_store(repo_transport, control_files)
483
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
484
 
        return self.repository_class(_format=self,
485
 
                                     a_bzrdir=a_bzrdir,
486
 
                                     control_files=control_files,
487
 
                                     _revision_store=_revision_store,
488
 
                                     control_store=control_store,
489
 
                                     text_store=text_store)