1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
29
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
30
from bzrlib.repository import (
 
 
32
    MetaDirRepositoryFormat,
 
 
36
import bzrlib.revision as _mod_revision
 
 
37
from bzrlib.store.versioned import VersionedFileStore
 
 
38
from bzrlib.trace import mutter, note, warning
 
 
41
class KnitRepository(MetaDirRepository):
 
 
42
    """Knit format repository."""
 
 
45
    _serializer = xml5.serializer_v5
 
 
47
    def _warn_if_deprecated(self):
 
 
48
        # This class isn't deprecated
 
 
51
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
 
 
52
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
 
 
55
    def _all_revision_ids(self):
 
 
56
        """See Repository.all_revision_ids()."""
 
 
57
        # Knits get the revision graph from the index of the revision knit, so
 
 
58
        # it's always possible even if they're on an unlistable transport.
 
 
59
        return self._revision_store.all_revision_ids(self.get_transaction())
 
 
61
    def fileid_involved_between_revs(self, from_revid, to_revid):
 
 
62
        """Find file_id(s) which are involved in the changes between revisions.
 
 
64
        This determines the set of revisions which are involved, and then
 
 
65
        finds all file ids affected by those revisions.
 
 
67
        from_revid = osutils.safe_revision_id(from_revid)
 
 
68
        to_revid = osutils.safe_revision_id(to_revid)
 
 
69
        vf = self._get_revision_vf()
 
 
70
        from_set = set(vf.get_ancestry(from_revid))
 
 
71
        to_set = set(vf.get_ancestry(to_revid))
 
 
72
        changed = to_set.difference(from_set)
 
 
73
        return self._fileid_involved_by_set(changed)
 
 
75
    def fileid_involved(self, last_revid=None):
 
 
76
        """Find all file_ids modified in the ancestry of last_revid.
 
 
78
        :param last_revid: If None, last_revision() will be used.
 
 
81
            changed = set(self.all_revision_ids())
 
 
83
            changed = set(self.get_ancestry(last_revid))
 
 
86
        return self._fileid_involved_by_set(changed)
 
 
89
    def get_ancestry(self, revision_id):
 
 
90
        """Return a list of revision-ids integrated by a revision.
 
 
92
        This is topologically sorted.
 
 
94
        if revision_id is None:
 
 
96
        revision_id = osutils.safe_revision_id(revision_id)
 
 
97
        vf = self._get_revision_vf()
 
 
99
            return [None] + vf.get_ancestry(revision_id)
 
 
100
        except errors.RevisionNotPresent:
 
 
101
            raise errors.NoSuchRevision(self, revision_id)
 
 
104
    def get_revision(self, revision_id):
 
 
105
        """Return the Revision object for a named revision"""
 
 
106
        revision_id = osutils.safe_revision_id(revision_id)
 
 
107
        return self.get_revision_reconcile(revision_id)
 
 
110
    def get_revision_graph(self, revision_id=None):
 
 
111
        """Return a dictionary containing the revision graph.
 
 
113
        :param revision_id: The revision_id to get a graph from. If None, then
 
 
114
        the entire revision graph is returned. This is a deprecated mode of
 
 
115
        operation and will be removed in the future.
 
 
116
        :return: a dictionary of revision_id->revision_parents_list.
 
 
118
        # special case NULL_REVISION
 
 
119
        if revision_id == _mod_revision.NULL_REVISION:
 
 
121
        revision_id = osutils.safe_revision_id(revision_id)
 
 
122
        a_weave = self._get_revision_vf()
 
 
123
        entire_graph = a_weave.get_graph()
 
 
124
        if revision_id is None:
 
 
125
            return a_weave.get_graph()
 
 
126
        elif revision_id not in a_weave:
 
 
127
            raise errors.NoSuchRevision(self, revision_id)
 
 
129
            # add what can be reached from revision_id
 
 
131
            pending = set([revision_id])
 
 
132
            while len(pending) > 0:
 
 
134
                result[node] = a_weave.get_parents(node)
 
 
135
                for revision_id in result[node]:
 
 
136
                    if revision_id not in result:
 
 
137
                        pending.add(revision_id)
 
 
141
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
 
142
        """Return a graph of the revisions with ghosts marked as applicable.
 
 
144
        :param revision_ids: an iterable of revisions to graph or None for all.
 
 
145
        :return: a Graph object with the graph reachable from revision_ids.
 
 
147
        result = graph.Graph()
 
 
148
        vf = self._get_revision_vf()
 
 
149
        versions = set(vf.versions())
 
 
151
            pending = set(self.all_revision_ids())
 
 
154
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
 
 
155
            # special case NULL_REVISION
 
 
156
            if _mod_revision.NULL_REVISION in pending:
 
 
157
                pending.remove(_mod_revision.NULL_REVISION)
 
 
158
            required = set(pending)
 
 
161
            revision_id = pending.pop()
 
 
162
            if not revision_id in versions:
 
 
163
                if revision_id in required:
 
 
164
                    raise errors.NoSuchRevision(self, revision_id)
 
 
166
                result.add_ghost(revision_id)
 
 
167
                # mark it as done so we don't try for it again.
 
 
168
                done.add(revision_id)
 
 
170
            parent_ids = vf.get_parents_with_ghosts(revision_id)
 
 
171
            for parent_id in parent_ids:
 
 
172
                # is this queued or done ?
 
 
173
                if (parent_id not in pending and
 
 
174
                    parent_id not in done):
 
 
176
                    pending.add(parent_id)
 
 
177
            result.add_node(revision_id, parent_ids)
 
 
178
            done.add(revision_id)
 
 
181
    def _get_revision_vf(self):
 
 
182
        """:return: a versioned file containing the revisions."""
 
 
183
        vf = self._revision_store.get_revision_file(self.get_transaction())
 
 
186
    def _get_history_vf(self):
 
 
187
        """Get a versionedfile whose history graph reflects all revisions.
 
 
189
        For knit repositories, this is the revision knit.
 
 
191
        return self._get_revision_vf()
 
 
194
    def reconcile(self, other=None, thorough=False):
 
 
195
        """Reconcile this repository."""
 
 
196
        from bzrlib.reconcile import KnitReconciler
 
 
197
        reconciler = KnitReconciler(self, thorough=thorough)
 
 
198
        reconciler.reconcile()
 
 
201
    def revision_parents(self, revision_id):
 
 
202
        revision_id = osutils.safe_revision_id(revision_id)
 
 
203
        return self._get_revision_vf().get_parents(revision_id)
 
 
206
class KnitRepository2(KnitRepository):
 
 
208
    def __init__(self, _format, a_bzrdir, control_files, _revision_store,
 
 
209
                 control_store, text_store):
 
 
210
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
 
 
211
                              _revision_store, control_store, text_store)
 
 
212
        self._serializer = xml6.serializer_v6
 
 
214
    def deserialise_inventory(self, revision_id, xml):
 
 
215
        """Transform the xml into an inventory object. 
 
 
217
        :param revision_id: The expected revision id of the inventory.
 
 
218
        :param xml: A serialised inventory.
 
 
220
        result = self._serializer.read_inventory_from_string(xml)
 
 
221
        assert result.root.revision is not None
 
 
224
    def serialise_inventory(self, inv):
 
 
225
        """Transform the inventory object into XML text.
 
 
227
        :param revision_id: The expected revision id of the inventory.
 
 
228
        :param xml: A serialised inventory.
 
 
230
        assert inv.revision_id is not None
 
 
231
        assert inv.root.revision is not None
 
 
232
        return KnitRepository.serialise_inventory(self, inv)
 
 
234
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
 
235
                           timezone=None, committer=None, revprops=None,
 
 
237
        """Obtain a CommitBuilder for this repository.
 
 
239
        :param branch: Branch to commit to.
 
 
240
        :param parents: Revision ids of the parents of the new revision.
 
 
241
        :param config: Configuration to use.
 
 
242
        :param timestamp: Optional timestamp recorded for commit.
 
 
243
        :param timezone: Optional timezone for timestamp.
 
 
244
        :param committer: Optional committer to set for commit.
 
 
245
        :param revprops: Optional dictionary of revision properties.
 
 
246
        :param revision_id: Optional revision id.
 
 
248
        revision_id = osutils.safe_revision_id(revision_id)
 
 
249
        return RootCommitBuilder(self, parents, config, timestamp, timezone,
 
 
250
                                 committer, revprops, revision_id)
 
 
253
class RepositoryFormatKnit(MetaDirRepositoryFormat):
 
 
254
    """Bzr repository knit format (generalized). 
 
 
256
    This repository format has:
 
 
257
     - knits for file texts and inventory
 
 
258
     - hash subdirectory based stores.
 
 
259
     - knits for revisions and signatures
 
 
260
     - TextStores for revisions and signatures.
 
 
261
     - a format marker of its own
 
 
262
     - an optional 'shared-storage' flag
 
 
263
     - an optional 'no-working-trees' flag
 
 
267
    def _get_control_store(self, repo_transport, control_files):
 
 
268
        """Return the control store for this repository."""
 
 
269
        return VersionedFileStore(
 
 
272
            file_mode=control_files._file_mode,
 
 
273
            versionedfile_class=knit.KnitVersionedFile,
 
 
274
            versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
 
 
277
    def _get_revision_store(self, repo_transport, control_files):
 
 
278
        """See RepositoryFormat._get_revision_store()."""
 
 
279
        from bzrlib.store.revision.knit import KnitRevisionStore
 
 
280
        versioned_file_store = VersionedFileStore(
 
 
282
            file_mode=control_files._file_mode,
 
 
285
            versionedfile_class=knit.KnitVersionedFile,
 
 
286
            versionedfile_kwargs={'delta':False,
 
 
287
                                  'factory':knit.KnitPlainFactory(),
 
 
291
        return KnitRevisionStore(versioned_file_store)
 
 
293
    def _get_text_store(self, transport, control_files):
 
 
294
        """See RepositoryFormat._get_text_store()."""
 
 
295
        return self._get_versioned_file_store('knits',
 
 
298
                                  versionedfile_class=knit.KnitVersionedFile,
 
 
299
                                  versionedfile_kwargs={
 
 
300
                                      'create_parent_dir':True,
 
 
302
                                      'dir_mode':control_files._dir_mode,
 
 
306
    def initialize(self, a_bzrdir, shared=False):
 
 
307
        """Create a knit format 1 repository.
 
 
309
        :param a_bzrdir: bzrdir to contain the new repository; must already
 
 
311
        :param shared: If true the repository will be initialized as a shared
 
 
314
        mutter('creating repository in %s.', a_bzrdir.transport.base)
 
 
315
        dirs = ['revision-store', 'knits']
 
 
317
        utf8_files = [('format', self.get_format_string())]
 
 
319
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
 
 
320
        repo_transport = a_bzrdir.get_repository_transport(None)
 
 
321
        control_files = lockable_files.LockableFiles(repo_transport,
 
 
322
                                'lock', lockdir.LockDir)
 
 
323
        control_store = self._get_control_store(repo_transport, control_files)
 
 
324
        transaction = transactions.WriteTransaction()
 
 
325
        # trigger a write of the inventory store.
 
 
326
        control_store.get_weave_or_empty('inventory', transaction)
 
 
327
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
 
328
        # the revision id here is irrelevant: it will not be stored, and cannot
 
 
330
        _revision_store.has_revision_id('A', transaction)
 
 
331
        _revision_store.get_signature_file(transaction)
 
 
332
        return self.open(a_bzrdir=a_bzrdir, _found=True)
 
 
334
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
 
335
        """See RepositoryFormat.open().
 
 
337
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
 
338
                                    repository at a slightly different url
 
 
339
                                    than normal. I.e. during 'upgrade'.
 
 
342
            format = RepositoryFormat.find_format(a_bzrdir)
 
 
343
            assert format.__class__ ==  self.__class__
 
 
344
        if _override_transport is not None:
 
 
345
            repo_transport = _override_transport
 
 
347
            repo_transport = a_bzrdir.get_repository_transport(None)
 
 
348
        control_files = lockable_files.LockableFiles(repo_transport,
 
 
349
                                'lock', lockdir.LockDir)
 
 
350
        text_store = self._get_text_store(repo_transport, control_files)
 
 
351
        control_store = self._get_control_store(repo_transport, control_files)
 
 
352
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
 
353
        return KnitRepository(_format=self,
 
 
355
                              control_files=control_files,
 
 
356
                              _revision_store=_revision_store,
 
 
357
                              control_store=control_store,
 
 
358
                              text_store=text_store)
 
 
361
class RepositoryFormatKnit1(RepositoryFormatKnit):
 
 
362
    """Bzr repository knit format 1.
 
 
364
    This repository format has:
 
 
365
     - knits for file texts and inventory
 
 
366
     - hash subdirectory based stores.
 
 
367
     - knits for revisions and signatures
 
 
368
     - TextStores for revisions and signatures.
 
 
369
     - a format marker of its own
 
 
370
     - an optional 'shared-storage' flag
 
 
371
     - an optional 'no-working-trees' flag
 
 
374
    This format was introduced in bzr 0.8.
 
 
377
    def get_format_string(self):
 
 
378
        """See RepositoryFormat.get_format_string()."""
 
 
379
        return "Bazaar-NG Knit Repository Format 1"
 
 
381
    def get_format_description(self):
 
 
382
        """See RepositoryFormat.get_format_description()."""
 
 
383
        return "Knit repository format 1"
 
 
385
    def check_conversion_target(self, target_format):
 
 
389
class RepositoryFormatKnit2(RepositoryFormatKnit):
 
 
390
    """Bzr repository knit format 2.
 
 
392
    THIS FORMAT IS EXPERIMENTAL
 
 
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
 
 
402
     - Support for recording full info about the tree root
 
 
406
    rich_root_data = True
 
 
408
    def get_format_string(self):
 
 
409
        """See RepositoryFormat.get_format_string()."""
 
 
410
        return "Bazaar Knit Repository Format 2\n"
 
 
412
    def get_format_description(self):
 
 
413
        """See RepositoryFormat.get_format_description()."""
 
 
414
        return "Knit repository format 2"
 
 
416
    def check_conversion_target(self, target_format):
 
 
417
        if not target_format.rich_root_data:
 
 
418
            raise errors.BadConversionTarget(
 
 
419
                'Does not support rich root data.', target_format)
 
 
421
    def open(self, a_bzrdir, _found=False, _override_transport=None):
 
 
422
        """See RepositoryFormat.open().
 
 
424
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
 
 
425
                                    repository at a slightly different url
 
 
426
                                    than normal. I.e. during 'upgrade'.
 
 
429
            format = RepositoryFormat.find_format(a_bzrdir)
 
 
430
            assert format.__class__ ==  self.__class__
 
 
431
        if _override_transport is not None:
 
 
432
            repo_transport = _override_transport
 
 
434
            repo_transport = a_bzrdir.get_repository_transport(None)
 
 
435
        control_files = lockable_files.LockableFiles(repo_transport, 'lock',
 
 
437
        text_store = self._get_text_store(repo_transport, control_files)
 
 
438
        control_store = self._get_control_store(repo_transport, control_files)
 
 
439
        _revision_store = self._get_revision_store(repo_transport, control_files)
 
 
440
        return KnitRepository2(_format=self,
 
 
442
                               control_files=control_files,
 
 
443
                               _revision_store=_revision_store,
 
 
444
                               control_store=control_store,
 
 
445
                               text_store=text_store)