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
17
"""Deprecated weave-based repository formats.
19
Weave based formats scaled linearly with history size and could not represent
23
from StringIO import StringIO
32
revision as _mod_revision,
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
from bzrlib.repository import (
41
MetaDirRepositoryFormat,
45
from bzrlib.store.text import TextStore
46
from bzrlib.trace import mutter
49
class AllInOneRepository(Repository):
50
"""Legacy support - the repository behaviour for all-in-one branches."""
52
_serializer = xml5.serializer_v5
54
def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
55
# we reuse one control files instance.
56
dir_mode = a_bzrdir._control_files._dir_mode
57
file_mode = a_bzrdir._control_files._file_mode
59
def get_store(name, compressed=True, prefixed=False):
60
# FIXME: This approach of assuming stores are all entirely compressed
61
# or entirely uncompressed is tidy, but breaks upgrade from
62
# some existing branches where there's a mixture; we probably
63
# still want the option to look for both.
64
relpath = a_bzrdir._control_files._escape(name)
65
store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
66
prefixed=prefixed, compressed=compressed,
71
# not broken out yet because the controlweaves|inventory_store
72
# and text_store | weave_store bits are still different.
73
if isinstance(_format, RepositoryFormat4):
74
# cannot remove these - there is still no consistent api
75
# which allows access to this old info.
76
self.inventory_store = get_store('inventory-store')
77
text_store = get_store('text-store')
78
super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
81
def _all_possible_ids(self):
82
"""Return all the possible revisions that we could find."""
83
if 'evil' in debug.debug_flags:
84
mutter_callsite(3, "_all_possible_ids scales with size of history.")
85
return self.get_inventory_weave().versions()
88
def _all_revision_ids(self):
89
"""Returns a list of all the revision ids in the repository.
91
These are in as much topological order as the underlying store can
92
present: for weaves ghosts may lead to a lack of correctness until
93
the reweave updates the parents list.
95
if self._revision_store.text_store.listable():
96
return self._revision_store.all_revision_ids(self.get_transaction())
97
result = self._all_possible_ids()
98
# TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
99
# ids. (It should, since _revision_store's API should change to
100
# return utf8 revision_ids)
101
return self._eliminate_revisions_not_present(result)
103
def _check_revision_parents(self, revision, inventory):
104
"""Private to Repository and Fetch.
106
This checks the parentage of revision in an inventory weave for
107
consistency and is only applicable to inventory-weave-for-ancestry
108
using repository formats & fetchers.
110
weave_parents = inventory.get_parents(revision.revision_id)
111
weave_names = inventory.versions()
112
for parent_id in revision.parent_ids:
113
if parent_id in weave_names:
114
# this parent must not be a ghost.
115
if not parent_id in weave_parents:
117
raise errors.CorruptRepository(self)
119
def get_commit_builder(self, branch, parents, config, timestamp=None,
120
timezone=None, committer=None, revprops=None,
122
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
123
revision_id = osutils.safe_revision_id(revision_id)
124
result = WeaveCommitBuilder(self, parents, config, timestamp, timezone,
125
committer, revprops, revision_id)
126
self.start_write_group()
130
def get_revisions(self, revision_ids):
131
revs = self._get_revisions(revision_ids)
132
# weave corruption can lead to absent revision markers that should be
134
# the following test is reasonably cheap (it needs a single weave read)
135
# and the weave is cached in read transactions. In write transactions
136
# it is not cached but typically we only read a small number of
137
# revisions. For knits when they are introduced we will probably want
138
# to ensure that caching write transactions are in use.
139
inv = self.get_inventory_weave()
141
self._check_revision_parents(rev, inv)
145
def get_revision_graph(self, revision_id=None):
146
"""Return a dictionary containing the revision graph.
148
:param revision_id: The revision_id to get a graph from. If None, then
149
the entire revision graph is returned. This is a deprecated mode of
150
operation and will be removed in the future.
151
:return: a dictionary of revision_id->revision_parents_list.
153
if 'evil' in debug.debug_flags:
155
"get_revision_graph scales with size of history.")
156
# special case NULL_REVISION
157
if revision_id == _mod_revision.NULL_REVISION:
159
revision_id = osutils.safe_revision_id(revision_id)
160
a_weave = self.get_inventory_weave()
161
all_revisions = self._eliminate_revisions_not_present(
163
entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for
164
node in all_revisions])
165
if revision_id is None:
167
elif revision_id not in entire_graph:
168
raise errors.NoSuchRevision(self, revision_id)
170
# add what can be reached from revision_id
172
pending = set([revision_id])
173
while len(pending) > 0:
175
result[node] = entire_graph[node]
176
for revision_id in result[node]:
177
if revision_id not in result:
178
pending.add(revision_id)
183
"""AllInOne repositories cannot be shared."""
187
def set_make_working_trees(self, new_value):
188
"""Set the policy flag for making working trees when creating branches.
190
This only applies to branches that use this repository.
192
The default is 'True'.
193
:param new_value: True to restore the default, False to disable making
196
raise NotImplementedError(self.set_make_working_trees)
198
def make_working_trees(self):
199
"""Returns the policy for making working trees on new branches."""
202
def revision_graph_can_have_wrong_parents(self):
203
# XXX: This is an old format that we don't support full checking on, so
204
# just claim that checking for this inconsistency is not required.
208
class WeaveMetaDirRepository(MetaDirRepository):
209
"""A subclass of MetaDirRepository to set weave specific policy."""
211
_serializer = xml5.serializer_v5
214
def _all_possible_ids(self):
215
"""Return all the possible revisions that we could find."""
216
if 'evil' in debug.debug_flags:
217
mutter_callsite(3, "_all_possible_ids scales with size of history.")
218
return self.get_inventory_weave().versions()
221
def _all_revision_ids(self):
222
"""Returns a list of all the revision ids in the repository.
224
These are in as much topological order as the underlying store can
225
present: for weaves ghosts may lead to a lack of correctness until
226
the reweave updates the parents list.
228
if self._revision_store.text_store.listable():
229
return self._revision_store.all_revision_ids(self.get_transaction())
230
result = self._all_possible_ids()
231
# TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
232
# ids. (It should, since _revision_store's API should change to
233
# return utf8 revision_ids)
234
return self._eliminate_revisions_not_present(result)
236
def _check_revision_parents(self, revision, inventory):
237
"""Private to Repository and Fetch.
239
This checks the parentage of revision in an inventory weave for
240
consistency and is only applicable to inventory-weave-for-ancestry
241
using repository formats & fetchers.
243
weave_parents = inventory.get_parents(revision.revision_id)
244
weave_names = inventory.versions()
245
for parent_id in revision.parent_ids:
246
if parent_id in weave_names:
247
# this parent must not be a ghost.
248
if not parent_id in weave_parents:
250
raise errors.CorruptRepository(self)
252
def get_commit_builder(self, branch, parents, config, timestamp=None,
253
timezone=None, committer=None, revprops=None,
255
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
256
revision_id = osutils.safe_revision_id(revision_id)
257
result = WeaveCommitBuilder(self, parents, config, timestamp, timezone,
258
committer, revprops, revision_id)
259
self.start_write_group()
263
def get_revision(self, revision_id):
264
"""Return the Revision object for a named revision"""
265
# TODO: jam 20070210 get_revision_reconcile should do this for us
266
revision_id = osutils.safe_revision_id(revision_id)
267
r = self.get_revision_reconcile(revision_id)
268
# weave corruption can lead to absent revision markers that should be
270
# the following test is reasonably cheap (it needs a single weave read)
271
# and the weave is cached in read transactions. In write transactions
272
# it is not cached but typically we only read a small number of
273
# revisions. For knits when they are introduced we will probably want
274
# to ensure that caching write transactions are in use.
275
inv = self.get_inventory_weave()
276
self._check_revision_parents(r, inv)
280
def get_revision_graph(self, revision_id=None):
281
"""Return a dictionary containing the revision graph.
283
:param revision_id: The revision_id to get a graph from. If None, then
284
the entire revision graph is returned. This is a deprecated mode of
285
operation and will be removed in the future.
286
:return: a dictionary of revision_id->revision_parents_list.
288
if 'evil' in debug.debug_flags:
290
"get_revision_graph scales with size of history.")
291
# special case NULL_REVISION
292
if revision_id == _mod_revision.NULL_REVISION:
294
revision_id = osutils.safe_revision_id(revision_id)
295
a_weave = self.get_inventory_weave()
296
all_revisions = self._eliminate_revisions_not_present(
298
entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for
299
node in all_revisions])
300
if revision_id is None:
302
elif revision_id not in entire_graph:
303
raise errors.NoSuchRevision(self, revision_id)
305
# add what can be reached from revision_id
307
pending = set([revision_id])
308
while len(pending) > 0:
310
result[node] = entire_graph[node]
311
for revision_id in result[node]:
312
if revision_id not in result:
313
pending.add(revision_id)
316
def revision_graph_can_have_wrong_parents(self):
317
# XXX: This is an old format that we don't support full checking on, so
318
# just claim that checking for this inconsistency is not required.
322
class PreSplitOutRepositoryFormat(RepositoryFormat):
323
"""Base class for the pre split out repository formats."""
325
rich_root_data = False
326
supports_tree_reference = False
328
def initialize(self, a_bzrdir, shared=False, _internal=False):
329
"""Create a weave repository.
331
TODO: when creating split out bzr branch formats, move this to a common
332
base for Format5, Format6. or something like that.
335
raise errors.IncompatibleFormat(self, a_bzrdir._format)
338
# always initialized when the bzrdir is.
339
return self.open(a_bzrdir, _found=True)
341
# Create an empty weave
343
weavefile.write_weave_v5(weave.Weave(), sio)
344
empty_weave = sio.getvalue()
346
mutter('creating repository in %s.', a_bzrdir.transport.base)
347
dirs = ['revision-store', 'weaves']
348
files = [('inventory.weave', StringIO(empty_weave)),
351
# FIXME: RBC 20060125 don't peek under the covers
352
# NB: no need to escape relative paths that are url safe.
353
control_files = lockable_files.LockableFiles(a_bzrdir.transport,
354
'branch-lock', lockable_files.TransportLock)
355
control_files.create_lock()
356
control_files.lock_write()
357
control_files._transport.mkdir_multi(dirs,
358
mode=control_files._dir_mode)
360
for file, content in files:
361
control_files.put(file, content)
363
control_files.unlock()
364
return self.open(a_bzrdir, _found=True)
366
def _get_control_store(self, repo_transport, control_files):
367
"""Return the control store for this repository."""
368
return self._get_versioned_file_store('',
373
def _get_text_store(self, transport, control_files):
374
"""Get a store for file texts for this format."""
375
raise NotImplementedError(self._get_text_store)
377
def open(self, a_bzrdir, _found=False):
378
"""See RepositoryFormat.open()."""
380
# we are being called directly and must probe.
381
raise NotImplementedError
383
repo_transport = a_bzrdir.get_repository_transport(None)
384
control_files = a_bzrdir._control_files
385
text_store = self._get_text_store(repo_transport, control_files)
386
control_store = self._get_control_store(repo_transport, control_files)
387
_revision_store = self._get_revision_store(repo_transport, control_files)
388
return AllInOneRepository(_format=self,
390
_revision_store=_revision_store,
391
control_store=control_store,
392
text_store=text_store)
394
def check_conversion_target(self, target_format):
398
class RepositoryFormat4(PreSplitOutRepositoryFormat):
399
"""Bzr repository format 4.
401
This repository format has:
403
- TextStores for texts, inventories,revisions.
405
This format is deprecated: it indexes texts using a text id which is
406
removed in format 5; initialization and write support for this format
410
_matchingbzrdir = bzrdir.BzrDirFormat4()
413
super(RepositoryFormat4, self).__init__()
415
def get_format_description(self):
416
"""See RepositoryFormat.get_format_description()."""
417
return "Repository format 4"
419
def initialize(self, url, shared=False, _internal=False):
420
"""Format 4 branches cannot be created."""
421
raise errors.UninitializableFormat(self)
423
def is_supported(self):
424
"""Format 4 is not supported.
426
It is not supported because the model changed from 4 to 5 and the
427
conversion logic is expensive - so doing it on the fly was not
432
def _get_control_store(self, repo_transport, control_files):
433
"""Format 4 repositories have no formal control store at this point.
435
This will cause any control-file-needing apis to fail - this is desired.
439
def _get_revision_store(self, repo_transport, control_files):
440
"""See RepositoryFormat._get_revision_store()."""
441
from bzrlib.xml4 import serializer_v4
442
return self._get_text_rev_store(repo_transport,
445
serializer=serializer_v4)
447
def _get_text_store(self, transport, control_files):
448
"""See RepositoryFormat._get_text_store()."""
451
class RepositoryFormat5(PreSplitOutRepositoryFormat):
452
"""Bzr control format 5.
454
This repository format has:
455
- weaves for file texts and inventory
457
- TextStores for revisions and signatures.
460
_versionedfile_class = weave.WeaveFile
461
_matchingbzrdir = bzrdir.BzrDirFormat5()
464
super(RepositoryFormat5, self).__init__()
466
def get_format_description(self):
467
"""See RepositoryFormat.get_format_description()."""
468
return "Weave repository format 5"
470
def _get_revision_store(self, repo_transport, control_files):
471
"""See RepositoryFormat._get_revision_store()."""
472
"""Return the revision store object for this a_bzrdir."""
473
return self._get_text_rev_store(repo_transport,
478
def _get_text_store(self, transport, control_files):
479
"""See RepositoryFormat._get_text_store()."""
480
return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
483
class RepositoryFormat6(PreSplitOutRepositoryFormat):
484
"""Bzr control format 6.
486
This repository format has:
487
- weaves for file texts and inventory
488
- hash subdirectory based stores.
489
- TextStores for revisions and signatures.
492
_versionedfile_class = weave.WeaveFile
493
_matchingbzrdir = bzrdir.BzrDirFormat6()
496
super(RepositoryFormat6, self).__init__()
498
def get_format_description(self):
499
"""See RepositoryFormat.get_format_description()."""
500
return "Weave repository format 6"
502
def _get_revision_store(self, repo_transport, control_files):
503
"""See RepositoryFormat._get_revision_store()."""
504
return self._get_text_rev_store(repo_transport,
510
def _get_text_store(self, transport, control_files):
511
"""See RepositoryFormat._get_text_store()."""
512
return self._get_versioned_file_store('weaves', transport, control_files)
514
class RepositoryFormat7(MetaDirRepositoryFormat):
517
This repository format has:
518
- weaves for file texts and inventory
519
- hash subdirectory based stores.
520
- TextStores for revisions and signatures.
521
- a format marker of its own
522
- an optional 'shared-storage' flag
523
- an optional 'no-working-trees' flag
526
_versionedfile_class = weave.WeaveFile
528
def _get_control_store(self, repo_transport, control_files):
529
"""Return the control store for this repository."""
530
return self._get_versioned_file_store('',
535
def get_format_string(self):
536
"""See RepositoryFormat.get_format_string()."""
537
return "Bazaar-NG Repository format 7"
539
def get_format_description(self):
540
"""See RepositoryFormat.get_format_description()."""
541
return "Weave repository format 7"
543
def check_conversion_target(self, target_format):
546
def _get_revision_store(self, repo_transport, control_files):
547
"""See RepositoryFormat._get_revision_store()."""
548
return self._get_text_rev_store(repo_transport,
555
def _get_text_store(self, transport, control_files):
556
"""See RepositoryFormat._get_text_store()."""
557
return self._get_versioned_file_store('weaves',
561
def initialize(self, a_bzrdir, shared=False):
562
"""Create a weave repository.
564
:param shared: If true the repository will be initialized as a shared
567
# Create an empty weave
569
weavefile.write_weave_v5(weave.Weave(), sio)
570
empty_weave = sio.getvalue()
572
mutter('creating repository in %s.', a_bzrdir.transport.base)
573
dirs = ['revision-store', 'weaves']
574
files = [('inventory.weave', StringIO(empty_weave)),
576
utf8_files = [('format', self.get_format_string())]
578
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
579
return self.open(a_bzrdir=a_bzrdir, _found=True)
581
def open(self, a_bzrdir, _found=False, _override_transport=None):
582
"""See RepositoryFormat.open().
584
:param _override_transport: INTERNAL USE ONLY. Allows opening the
585
repository at a slightly different url
586
than normal. I.e. during 'upgrade'.
589
format = RepositoryFormat.find_format(a_bzrdir)
590
assert format.__class__ == self.__class__
591
if _override_transport is not None:
592
repo_transport = _override_transport
594
repo_transport = a_bzrdir.get_repository_transport(None)
595
control_files = lockable_files.LockableFiles(repo_transport,
596
'lock', lockdir.LockDir)
597
text_store = self._get_text_store(repo_transport, control_files)
598
control_store = self._get_control_store(repo_transport, control_files)
599
_revision_store = self._get_revision_store(repo_transport, control_files)
600
return WeaveMetaDirRepository(_format=self,
602
control_files=control_files,
603
_revision_store=_revision_store,
604
control_store=control_store,
605
text_store=text_store)
608
class WeaveCommitBuilder(CommitBuilder):
609
"""A builder for weave based repos that don't support ghosts."""
611
def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
612
versionedfile = self.repository.weave_store.get_weave_or_empty(
613
file_id, self.repository.get_transaction())
614
result = versionedfile.add_lines(
615
self._new_revision_id, parents, new_lines,
616
nostore_sha=nostore_sha)[0:2]
617
versionedfile.clear_cache()
621
_legacy_formats = [RepositoryFormat4(),
added
removed
bzrlib/repofmt/weaverepo.py
