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
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.repository import (
33
MetaDirRepositoryFormat,
37
import bzrlib.revision as _mod_revision
38
from bzrlib.store.versioned import VersionedFileStore
39
from bzrlib.trace import mutter, note, warning
42
class _KnitParentsProvider(object):
44
def __init__(self, knit):
48
return 'KnitParentsProvider(%r)' % self._knit
50
def get_parents(self, revision_ids):
52
for revision_id in revision_ids:
53
if revision_id == _mod_revision.NULL_REVISION:
57
parents = self._knit.get_parents_with_ghosts(revision_id)
58
except errors.RevisionNotPresent:
62
parents = [_mod_revision.NULL_REVISION]
63
parents_list.append(parents)
67
class KnitRepository(MetaDirRepository):
68
"""Knit format repository."""
70
_serializer = xml5.serializer_v5
72
def _warn_if_deprecated(self):
73
# This class isn't deprecated
76
def _inventory_add_lines(self, inv_vf, revid, parents, lines):
77
inv_vf.add_lines_with_ghosts(revid, parents, lines)
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())
86
def fileid_involved_between_revs(self, from_revid, to_revid):
87
"""Find file_id(s) which are involved in the changes between revisions.
89
This determines the set of revisions which are involved, and then
90
finds all file ids affected by those revisions.
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)
100
def fileid_involved(self, last_revid=None):
101
"""Find all file_ids modified in the ancestry of last_revid.
103
:param last_revid: If None, last_revision() will be used.
106
changed = set(self.all_revision_ids())
108
changed = set(self.get_ancestry(last_revid))
111
return self._fileid_involved_by_set(changed)
114
def get_ancestry(self, revision_id, topo_sorted=True):
115
"""Return a list of revision-ids integrated by a revision.
117
This is topologically sorted, unless 'topo_sorted' is specified as
120
if _mod_revision.is_null(revision_id):
122
revision_id = osutils.safe_revision_id(revision_id)
123
vf = self._get_revision_vf()
125
return [None] + vf.get_ancestry(revision_id, topo_sorted)
126
except errors.RevisionNotPresent:
127
raise errors.NoSuchRevision(self, revision_id)
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)
136
def get_revision_graph(self, revision_id=None):
137
"""Return a dictionary containing the revision graph.
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.
144
# special case NULL_REVISION
145
if revision_id == _mod_revision.NULL_REVISION:
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)
154
# add what can be reached from revision_id
155
return a_weave.get_graph([revision_id])
158
def get_revision_graph_with_ghosts(self, revision_ids=None):
159
"""Return a graph of the revisions with ghosts marked as applicable.
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.
164
result = deprecated_graph.Graph()
165
vf = self._get_revision_vf()
166
versions = set(vf.versions())
168
pending = set(self.all_revision_ids())
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)
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)
183
result.add_ghost(revision_id)
184
# mark it as done so we don't try for it again.
185
done.add(revision_id)
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):
193
pending.add(parent_id)
194
result.add_node(revision_id, parent_ids)
195
done.add(revision_id)
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())
203
def _get_history_vf(self):
204
"""Get a versionedfile whose history graph reflects all revisions.
206
For knit repositories, this is the revision knit.
208
return self._get_revision_vf()
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()
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)
222
def _make_parents_provider(self):
223
return _KnitParentsProvider(self._get_revision_vf())
226
class KnitRepository3(KnitRepository):
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
234
def deserialise_inventory(self, revision_id, xml):
235
"""Transform the xml into an inventory object.
237
:param revision_id: The expected revision id of the inventory.
238
:param xml: A serialised inventory.
240
result = self._serializer.read_inventory_from_string(xml)
241
assert result.root.revision is not None
244
def serialise_inventory(self, inv):
245
"""Transform the inventory object into XML text.
247
:param revision_id: The expected revision id of the inventory.
248
:param xml: A serialised inventory.
250
assert inv.revision_id is not None
251
assert inv.root.revision is not None
252
return KnitRepository.serialise_inventory(self, inv)
254
def get_commit_builder(self, branch, parents, config, timestamp=None,
255
timezone=None, committer=None, revprops=None,
257
"""Obtain a CommitBuilder for this repository.
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.
268
revision_id = osutils.safe_revision_id(revision_id)
269
result = RootCommitBuilder(self, parents, config, timestamp, timezone,
270
committer, revprops, revision_id)
271
self.start_write_group()
275
class RepositoryFormatKnit(MetaDirRepositoryFormat):
276
"""Bzr repository knit format (generalized).
278
This repository format has:
279
- knits for file texts and inventory
280
- hash subdirectory based stores.
281
- knits for revisions and signatures
282
- TextStores for revisions and signatures.
283
- a format marker of its own
284
- an optional 'shared-storage' flag
285
- an optional 'no-working-trees' flag
289
def _get_control_store(self, repo_transport, control_files):
290
"""Return the control store for this repository."""
291
return VersionedFileStore(
294
file_mode=control_files._file_mode,
295
versionedfile_class=knit.KnitVersionedFile,
296
versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
299
def _get_revision_store(self, repo_transport, control_files):
300
"""See RepositoryFormat._get_revision_store()."""
301
from bzrlib.store.revision.knit import KnitRevisionStore
302
versioned_file_store = VersionedFileStore(
304
file_mode=control_files._file_mode,
307
versionedfile_class=knit.KnitVersionedFile,
308
versionedfile_kwargs={'delta':False,
309
'factory':knit.KnitPlainFactory(),
313
return KnitRevisionStore(versioned_file_store)
315
def _get_text_store(self, transport, control_files):
316
"""See RepositoryFormat._get_text_store()."""
317
return self._get_versioned_file_store('knits',
320
versionedfile_class=knit.KnitVersionedFile,
321
versionedfile_kwargs={
322
'create_parent_dir':True,
324
'dir_mode':control_files._dir_mode,
328
def initialize(self, a_bzrdir, shared=False):
329
"""Create a knit format 1 repository.
331
:param a_bzrdir: bzrdir to contain the new repository; must already
333
:param shared: If true the repository will be initialized as a shared
336
mutter('creating repository in %s.', a_bzrdir.transport.base)
337
dirs = ['revision-store', 'knits']
339
utf8_files = [('format', self.get_format_string())]
341
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
342
repo_transport = a_bzrdir.get_repository_transport(None)
343
control_files = lockable_files.LockableFiles(repo_transport,
344
'lock', lockdir.LockDir)
345
control_store = self._get_control_store(repo_transport, control_files)
346
transaction = transactions.WriteTransaction()
347
# trigger a write of the inventory store.
348
control_store.get_weave_or_empty('inventory', transaction)
349
_revision_store = self._get_revision_store(repo_transport, control_files)
350
# the revision id here is irrelevant: it will not be stored, and cannot
352
_revision_store.has_revision_id('A', transaction)
353
_revision_store.get_signature_file(transaction)
354
return self.open(a_bzrdir=a_bzrdir, _found=True)
356
def open(self, a_bzrdir, _found=False, _override_transport=None):
357
"""See RepositoryFormat.open().
359
:param _override_transport: INTERNAL USE ONLY. Allows opening the
360
repository at a slightly different url
361
than normal. I.e. during 'upgrade'.
364
format = RepositoryFormat.find_format(a_bzrdir)
365
assert format.__class__ == self.__class__
366
if _override_transport is not None:
367
repo_transport = _override_transport
369
repo_transport = a_bzrdir.get_repository_transport(None)
370
control_files = lockable_files.LockableFiles(repo_transport,
371
'lock', lockdir.LockDir)
372
text_store = self._get_text_store(repo_transport, control_files)
373
control_store = self._get_control_store(repo_transport, control_files)
374
_revision_store = self._get_revision_store(repo_transport, control_files)
375
return KnitRepository(_format=self,
377
control_files=control_files,
378
_revision_store=_revision_store,
379
control_store=control_store,
380
text_store=text_store)
383
class RepositoryFormatKnit1(RepositoryFormatKnit):
384
"""Bzr repository knit format 1.
386
This repository format has:
387
- knits for file texts and inventory
388
- hash subdirectory based stores.
389
- knits for revisions and signatures
390
- TextStores for revisions and signatures.
391
- a format marker of its own
392
- an optional 'shared-storage' flag
393
- an optional 'no-working-trees' flag
396
This format was introduced in bzr 0.8.
399
def __ne__(self, other):
400
return self.__class__ is not other.__class__
402
def get_format_string(self):
403
"""See RepositoryFormat.get_format_string()."""
404
return "Bazaar-NG Knit Repository Format 1"
406
def get_format_description(self):
407
"""See RepositoryFormat.get_format_description()."""
408
return "Knit repository format 1"
410
def check_conversion_target(self, target_format):
414
class RepositoryFormatKnit3(RepositoryFormatKnit):
415
"""Bzr repository knit format 2.
417
This repository format has:
418
- knits for file texts and inventory
419
- hash subdirectory based stores.
420
- knits for revisions and signatures
421
- TextStores for revisions and signatures.
422
- a format marker of its own
423
- an optional 'shared-storage' flag
424
- an optional 'no-working-trees' flag
426
- support for recording full info about the tree root
427
- support for recording tree-references
430
repository_class = KnitRepository3
431
rich_root_data = True
432
supports_tree_reference = True
434
def _get_matching_bzrdir(self):
435
return bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
437
def _ignore_setting_bzrdir(self, format):
440
_matchingbzrdir = property(_get_matching_bzrdir, _ignore_setting_bzrdir)
442
def check_conversion_target(self, target_format):
443
if not target_format.rich_root_data:
444
raise errors.BadConversionTarget(
445
'Does not support rich root data.', target_format)
446
if not getattr(target_format, 'supports_tree_reference', False):
447
raise errors.BadConversionTarget(
448
'Does not support nested trees', target_format)
450
def get_format_string(self):
451
"""See RepositoryFormat.get_format_string()."""
452
return "Bazaar Knit Repository Format 3 (bzr 0.15)\n"
454
def get_format_description(self):
455
"""See RepositoryFormat.get_format_description()."""
456
return "Knit repository format 3"
458
def open(self, a_bzrdir, _found=False, _override_transport=None):
459
"""See RepositoryFormat.open().
461
:param _override_transport: INTERNAL USE ONLY. Allows opening the
462
repository at a slightly different url
463
than normal. I.e. during 'upgrade'.
466
format = RepositoryFormat.find_format(a_bzrdir)
467
assert format.__class__ == self.__class__
468
if _override_transport is not None:
469
repo_transport = _override_transport
471
repo_transport = a_bzrdir.get_repository_transport(None)
472
control_files = lockable_files.LockableFiles(repo_transport, 'lock',
474
text_store = self._get_text_store(repo_transport, control_files)
475
control_store = self._get_control_store(repo_transport, control_files)
476
_revision_store = self._get_revision_store(repo_transport, control_files)
477
return self.repository_class(_format=self,
479
control_files=control_files,
480
_revision_store=_revision_store,
481
control_store=control_store,
482
text_store=text_store)