~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repofmt/knitrepo.py

  • Committer: Alexander Belchenko
  • Date: 2007-01-04 23:36:44 UTC
  • mfrom: (2224 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2225.
  • Revision ID: bialix@ukr.net-20070104233644-7znkxoj9b0y7ev28
merge bzr.dev

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 _mod_revision.is_null(revision_id):
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
 
        if revision_id is None:
150
 
            return a_weave.get_graph()
151
 
        elif revision_id not in a_weave:
152
 
            raise errors.NoSuchRevision(self, revision_id)
153
 
        else:
154
 
            # add what can be reached from revision_id
155
 
            return a_weave.get_graph([revision_id])
156
 
 
157
 
    @needs_read_lock
158
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
159
 
        """Return a graph of the revisions with ghosts marked as applicable.
160
 
 
161
 
        :param revision_ids: an iterable of revisions to graph or None for all.
162
 
        :return: a Graph object with the graph reachable from revision_ids.
163
 
        """
164
 
        result = deprecated_graph.Graph()
165
 
        vf = self._get_revision_vf()
166
 
        versions = set(vf.versions())
167
 
        if not revision_ids:
168
 
            pending = set(self.all_revision_ids())
169
 
            required = set([])
170
 
        else:
171
 
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
172
 
            # special case NULL_REVISION
173
 
            if _mod_revision.NULL_REVISION in pending:
174
 
                pending.remove(_mod_revision.NULL_REVISION)
175
 
            required = set(pending)
176
 
        done = set([])
177
 
        while len(pending):
178
 
            revision_id = pending.pop()
179
 
            if not revision_id in versions:
180
 
                if revision_id in required:
181
 
                    raise errors.NoSuchRevision(self, revision_id)
182
 
                # a ghost
183
 
                result.add_ghost(revision_id)
184
 
                # mark it as done so we don't try for it again.
185
 
                done.add(revision_id)
186
 
                continue
187
 
            parent_ids = vf.get_parents_with_ghosts(revision_id)
188
 
            for parent_id in parent_ids:
189
 
                # is this queued or done ?
190
 
                if (parent_id not in pending and
191
 
                    parent_id not in done):
192
 
                    # no, queue it.
193
 
                    pending.add(parent_id)
194
 
            result.add_node(revision_id, parent_ids)
195
 
            done.add(revision_id)
196
 
        return result
197
 
 
198
 
    def _get_revision_vf(self):
199
 
        """:return: a versioned file containing the revisions."""
200
 
        vf = self._revision_store.get_revision_file(self.get_transaction())
201
 
        return vf
202
 
 
203
 
    def _get_history_vf(self):
204
 
        """Get a versionedfile whose history graph reflects all revisions.
205
 
 
206
 
        For knit repositories, this is the revision knit.
207
 
        """
208
 
        return self._get_revision_vf()
209
 
 
210
 
    @needs_write_lock
211
 
    def reconcile(self, other=None, thorough=False):
212
 
        """Reconcile this repository."""
213
 
        from bzrlib.reconcile import KnitReconciler
214
 
        reconciler = KnitReconciler(self, thorough=thorough)
215
 
        reconciler.reconcile()
216
 
        return reconciler
217
 
    
218
 
    def revision_parents(self, revision_id):
219
 
        revision_id = osutils.safe_revision_id(revision_id)
220
 
        return self._get_revision_vf().get_parents(revision_id)
221
 
 
222
 
    def _make_parents_provider(self):
223
 
        return _KnitParentsProvider(self._get_revision_vf())
224
 
 
225
 
 
226
 
class KnitRepository3(KnitRepository):
227
 
 
228
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store,
229
 
                 control_store, text_store):
230
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
231
 
                              _revision_store, control_store, text_store)
232
 
        self._serializer = xml7.serializer_v7
233
 
 
234
 
    def deserialise_inventory(self, revision_id, xml):
235
 
        """Transform the xml into an inventory object. 
236
 
 
237
 
        :param revision_id: The expected revision id of the inventory.
238
 
        :param xml: A serialised inventory.
239
 
        """
240
 
        result = self._serializer.read_inventory_from_string(xml)
241
 
        assert result.root.revision is not None
242
 
        return result
243
 
 
244
 
    def serialise_inventory(self, inv):
245
 
        """Transform the inventory object into XML text.
246
 
 
247
 
        :param revision_id: The expected revision id of the inventory.
248
 
        :param xml: A serialised inventory.
249
 
        """
250
 
        assert inv.revision_id is not None
251
 
        assert inv.root.revision is not None
252
 
        return KnitRepository.serialise_inventory(self, inv)
253
 
 
254
 
    def get_commit_builder(self, branch, parents, config, timestamp=None,
255
 
                           timezone=None, committer=None, revprops=None,
256
 
                           revision_id=None):
257
 
        """Obtain a CommitBuilder for this repository.
258
 
        
259
 
        :param branch: Branch to commit to.
260
 
        :param parents: Revision ids of the parents of the new revision.
261
 
        :param config: Configuration to use.
262
 
        :param timestamp: Optional timestamp recorded for commit.
263
 
        :param timezone: Optional timezone for timestamp.
264
 
        :param committer: Optional committer to set for commit.
265
 
        :param revprops: Optional dictionary of revision properties.
266
 
        :param revision_id: Optional revision id.
267
 
        """
268
 
        revision_id = osutils.safe_revision_id(revision_id)
269
 
        return RootCommitBuilder(self, parents, config, timestamp, timezone,
270
 
                                 committer, revprops, revision_id)
271
 
 
272
 
 
273
 
class RepositoryFormatKnit(MetaDirRepositoryFormat):
274
 
    """Bzr repository knit format (generalized). 
275
 
 
276
 
    This repository format has:
277
 
     - knits for file texts and inventory
278
 
     - hash subdirectory based stores.
279
 
     - knits for revisions and signatures
280
 
     - TextStores for revisions and signatures.
281
 
     - a format marker of its own
282
 
     - an optional 'shared-storage' flag
283
 
     - an optional 'no-working-trees' flag
284
 
     - a LockDir lock
285
 
    """
286
 
 
287
 
    def _get_control_store(self, repo_transport, control_files):
288
 
        """Return the control store for this repository."""
289
 
        return VersionedFileStore(
290
 
            repo_transport,
291
 
            prefixed=False,
292
 
            file_mode=control_files._file_mode,
293
 
            versionedfile_class=knit.KnitVersionedFile,
294
 
            versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
295
 
            )
296
 
 
297
 
    def _get_revision_store(self, repo_transport, control_files):
298
 
        """See RepositoryFormat._get_revision_store()."""
299
 
        from bzrlib.store.revision.knit import KnitRevisionStore
300
 
        versioned_file_store = VersionedFileStore(
301
 
            repo_transport,
302
 
            file_mode=control_files._file_mode,
303
 
            prefixed=False,
304
 
            precious=True,
305
 
            versionedfile_class=knit.KnitVersionedFile,
306
 
            versionedfile_kwargs={'delta':False,
307
 
                                  'factory':knit.KnitPlainFactory(),
308
 
                                 },
309
 
            escaped=True,
310
 
            )
311
 
        return KnitRevisionStore(versioned_file_store)
312
 
 
313
 
    def _get_text_store(self, transport, control_files):
314
 
        """See RepositoryFormat._get_text_store()."""
315
 
        return self._get_versioned_file_store('knits',
316
 
                                  transport,
317
 
                                  control_files,
318
 
                                  versionedfile_class=knit.KnitVersionedFile,
319
 
                                  versionedfile_kwargs={
320
 
                                      'create_parent_dir':True,
321
 
                                      'delay_create':True,
322
 
                                      'dir_mode':control_files._dir_mode,
323
 
                                  },
324
 
                                  escaped=True)
325
 
 
326
 
    def initialize(self, a_bzrdir, shared=False):
327
 
        """Create a knit format 1 repository.
328
 
 
329
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
330
 
            be initialized.
331
 
        :param shared: If true the repository will be initialized as a shared
332
 
                       repository.
333
 
        """
334
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
335
 
        dirs = ['revision-store', 'knits']
336
 
        files = []
337
 
        utf8_files = [('format', self.get_format_string())]
338
 
        
339
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
340
 
        repo_transport = a_bzrdir.get_repository_transport(None)
341
 
        control_files = lockable_files.LockableFiles(repo_transport,
342
 
                                'lock', lockdir.LockDir)
343
 
        control_store = self._get_control_store(repo_transport, control_files)
344
 
        transaction = transactions.WriteTransaction()
345
 
        # trigger a write of the inventory store.
346
 
        control_store.get_weave_or_empty('inventory', transaction)
347
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
348
 
        # the revision id here is irrelevant: it will not be stored, and cannot
349
 
        # already exist.
350
 
        _revision_store.has_revision_id('A', transaction)
351
 
        _revision_store.get_signature_file(transaction)
352
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
353
 
 
354
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
355
 
        """See RepositoryFormat.open().
356
 
        
357
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
358
 
                                    repository at a slightly different url
359
 
                                    than normal. I.e. during 'upgrade'.
360
 
        """
361
 
        if not _found:
362
 
            format = RepositoryFormat.find_format(a_bzrdir)
363
 
            assert format.__class__ ==  self.__class__
364
 
        if _override_transport is not None:
365
 
            repo_transport = _override_transport
366
 
        else:
367
 
            repo_transport = a_bzrdir.get_repository_transport(None)
368
 
        control_files = lockable_files.LockableFiles(repo_transport,
369
 
                                'lock', lockdir.LockDir)
370
 
        text_store = self._get_text_store(repo_transport, control_files)
371
 
        control_store = self._get_control_store(repo_transport, control_files)
372
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
373
 
        return KnitRepository(_format=self,
374
 
                              a_bzrdir=a_bzrdir,
375
 
                              control_files=control_files,
376
 
                              _revision_store=_revision_store,
377
 
                              control_store=control_store,
378
 
                              text_store=text_store)
379
 
 
380
 
 
381
 
class RepositoryFormatKnit1(RepositoryFormatKnit):
382
 
    """Bzr repository knit format 1.
383
 
 
384
 
    This repository format has:
385
 
     - knits for file texts and inventory
386
 
     - hash subdirectory based stores.
387
 
     - knits for revisions and signatures
388
 
     - TextStores for revisions and signatures.
389
 
     - a format marker of its own
390
 
     - an optional 'shared-storage' flag
391
 
     - an optional 'no-working-trees' flag
392
 
     - a LockDir lock
393
 
 
394
 
    This format was introduced in bzr 0.8.
395
 
    """
396
 
 
397
 
    def __ne__(self, other):
398
 
        return self.__class__ is not other.__class__
399
 
 
400
 
    def get_format_string(self):
401
 
        """See RepositoryFormat.get_format_string()."""
402
 
        return "Bazaar-NG Knit Repository Format 1"
403
 
 
404
 
    def get_format_description(self):
405
 
        """See RepositoryFormat.get_format_description()."""
406
 
        return "Knit repository format 1"
407
 
 
408
 
    def check_conversion_target(self, target_format):
409
 
        pass
410
 
 
411
 
 
412
 
class RepositoryFormatKnit3(RepositoryFormatKnit):
413
 
    """Bzr repository knit format 2.
414
 
 
415
 
    This repository format has:
416
 
     - knits for file texts and inventory
417
 
     - hash subdirectory based stores.
418
 
     - knits for revisions and signatures
419
 
     - TextStores for revisions and signatures.
420
 
     - a format marker of its own
421
 
     - an optional 'shared-storage' flag
422
 
     - an optional 'no-working-trees' flag
423
 
     - a LockDir lock
424
 
     - support for recording full info about the tree root
425
 
     - support for recording tree-references
426
 
    """
427
 
 
428
 
    repository_class = KnitRepository3
429
 
    rich_root_data = True
430
 
    supports_tree_reference = True
431
 
 
432
 
    def _get_matching_bzrdir(self):
433
 
        return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
434
 
 
435
 
    def _ignore_setting_bzrdir(self, format):
436
 
        pass
437
 
 
438
 
    _matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
439
 
 
440
 
    def check_conversion_target(self, target_format):
441
 
        if not target_format.rich_root_data:
442
 
            raise errors.BadConversionTarget(
443
 
                'Does not support rich root data.', target_format)
444
 
        if not getattr(target_format, 'supports_tree_reference', False):
445
 
            raise errors.BadConversionTarget(
446
 
                'Does not support nested trees', target_format)
447
 
            
448
 
    def get_format_string(self):
449
 
        """See RepositoryFormat.get_format_string()."""
450
 
        return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
451
 
 
452
 
    def get_format_description(self):
453
 
        """See RepositoryFormat.get_format_description()."""
454
 
        return "Knit repository format 3"
455
 
 
456
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
457
 
        """See RepositoryFormat.open().
458
 
        
459
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
460
 
                                    repository at a slightly different url
461
 
                                    than normal. I.e. during 'upgrade'.
462
 
        """
463
 
        if not _found:
464
 
            format = RepositoryFormat.find_format(a_bzrdir)
465
 
            assert format.__class__ ==  self.__class__
466
 
        if _override_transport is not None:
467
 
            repo_transport = _override_transport
468
 
        else:
469
 
            repo_transport = a_bzrdir.get_repository_transport(None)
470
 
        control_files = lockable_files.LockableFiles(repo_transport, 'lock',
471
 
                                                     lockdir.LockDir)
472
 
        text_store = self._get_text_store(repo_transport, control_files)
473
 
        control_store = self._get_control_store(repo_transport, control_files)
474
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
475
 
        return self.repository_class(_format=self,
476
 
                                     a_bzrdir=a_bzrdir,
477
 
                                     control_files=control_files,
478
 
                                     _revision_store=_revision_store,
479
 
                                     control_store=control_store,
480
 
                                     text_store=text_store)