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 (
40
MetaDirVersionedFileRepository,
41
MetaDirRepositoryFormat,
45
from bzrlib.store.text import TextStore
46
from bzrlib.symbol_versioning import deprecated_method, one_four
47
from bzrlib.trace import mutter
50
class AllInOneRepository(Repository):
51
"""Legacy support - the repository behaviour for all-in-one branches."""
53
_serializer = xml5.serializer_v5
55
def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
56
# we reuse one control files instance.
57
dir_mode = a_bzrdir._control_files._dir_mode
58
file_mode = a_bzrdir._control_files._file_mode
60
def get_store(name, compressed=True, prefixed=False):
61
# FIXME: This approach of assuming stores are all entirely compressed
62
# or entirely uncompressed is tidy, but breaks upgrade from
63
# some existing branches where there's a mixture; we probably
64
# still want the option to look for both.
65
relpath = a_bzrdir._control_files._escape(name)
66
store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
67
prefixed=prefixed, compressed=compressed,
72
# not broken out yet because the controlweaves|inventory_store
73
# and text_store | weave_store bits are still different.
74
if isinstance(_format, RepositoryFormat4):
75
# cannot remove these - there is still no consistent api
76
# which allows access to this old info.
77
self.inventory_store = get_store('inventory-store')
78
text_store = get_store('text-store')
79
super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
80
if control_store is not None:
81
control_store.get_scope = self.get_transaction
82
text_store.get_scope = self.get_transaction
85
def _all_possible_ids(self):
86
"""Return all the possible revisions that we could find."""
87
if 'evil' in debug.debug_flags:
88
mutter_callsite(3, "_all_possible_ids scales with size of history.")
89
return self.get_inventory_weave().versions()
92
def _all_revision_ids(self):
93
"""Returns a list of all the revision ids in the repository.
95
These are in as much topological order as the underlying store can
96
present: for weaves ghosts may lead to a lack of correctness until
97
the reweave updates the parents list.
99
if self._revision_store.text_store.listable():
100
return self._revision_store.all_revision_ids(self.get_transaction())
101
result = self._all_possible_ids()
102
# TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
103
# ids. (It should, since _revision_store's API should change to
104
# return utf8 revision_ids)
105
return self._eliminate_revisions_not_present(result)
107
def _check_revision_parents(self, revision, inventory):
108
"""Private to Repository and Fetch.
110
This checks the parentage of revision in an inventory weave for
111
consistency and is only applicable to inventory-weave-for-ancestry
112
using repository formats & fetchers.
114
weave_parents = inventory.get_parent_map(
115
[revision.revision_id])[revision.revision_id]
116
parent_map = inventory.get_parent_map(revision.parent_ids)
117
for parent_id in revision.parent_ids:
118
if parent_id in parent_map:
119
# this parent must not be a ghost.
120
if not parent_id in weave_parents:
122
raise errors.CorruptRepository(self)
124
def get_commit_builder(self, branch, parents, config, timestamp=None,
125
timezone=None, committer=None, revprops=None,
127
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
128
result = WeaveCommitBuilder(self, parents, config, timestamp, timezone,
129
committer, revprops, revision_id)
130
self.start_write_group()
134
def get_revisions(self, revision_ids):
135
revs = self._get_revisions(revision_ids)
136
# weave corruption can lead to absent revision markers that should be
138
# the following test is reasonably cheap (it needs a single weave read)
139
# and the weave is cached in read transactions. In write transactions
140
# it is not cached but typically we only read a small number of
141
# revisions. For knits when they are introduced we will probably want
142
# to ensure that caching write transactions are in use.
143
inv = self.get_inventory_weave()
145
self._check_revision_parents(rev, inv)
148
@deprecated_method(one_four)
150
def get_revision_graph(self, revision_id=None):
151
"""Return a dictionary containing the revision graph.
153
:param revision_id: The revision_id to get a graph from. If None, then
154
the entire revision graph is returned. This is a deprecated mode of
155
operation and will be removed in the future.
156
:return: a dictionary of revision_id->revision_parents_list.
158
if 'evil' in debug.debug_flags:
160
"get_revision_graph scales with size of history.")
161
# special case NULL_REVISION
162
if revision_id == _mod_revision.NULL_REVISION:
164
a_weave = self.get_inventory_weave()
165
all_revisions = self._eliminate_revisions_not_present(
167
entire_graph = a_weave.get_parent_map(all_revisions)
168
if revision_id is None:
170
elif revision_id not in entire_graph:
171
raise errors.NoSuchRevision(self, revision_id)
173
# add what can be reached from revision_id
175
pending = set([revision_id])
176
while len(pending) > 0:
178
result[node] = entire_graph[node]
179
for revision_id in result[node]:
180
if revision_id not in result:
181
pending.add(revision_id)
184
def has_revisions(self, revision_ids):
185
"""See Repository.has_revisions()."""
187
transaction = self.get_transaction()
188
for revision_id in revision_ids:
189
if self._revision_store.has_revision_id(revision_id, transaction):
190
result.add(revision_id)
195
"""AllInOne repositories cannot be shared."""
199
def set_make_working_trees(self, new_value):
200
"""Set the policy flag for making working trees when creating branches.
202
This only applies to branches that use this repository.
204
The default is 'True'.
205
:param new_value: True to restore the default, False to disable making
208
raise errors.RepositoryUpgradeRequired(self.bzrdir.root_transport.base)
210
def make_working_trees(self):
211
"""Returns the policy for making working trees on new branches."""
214
def revision_graph_can_have_wrong_parents(self):
215
# XXX: This is an old format that we don't support full checking on, so
216
# just claim that checking for this inconsistency is not required.
220
class WeaveMetaDirRepository(MetaDirVersionedFileRepository):
221
"""A subclass of MetaDirRepository to set weave specific policy."""
223
_serializer = xml5.serializer_v5
226
def _all_possible_ids(self):
227
"""Return all the possible revisions that we could find."""
228
if 'evil' in debug.debug_flags:
229
mutter_callsite(3, "_all_possible_ids scales with size of history.")
230
return self.get_inventory_weave().versions()
233
def _all_revision_ids(self):
234
"""Returns a list of all the revision ids in the repository.
236
These are in as much topological order as the underlying store can
237
present: for weaves ghosts may lead to a lack of correctness until
238
the reweave updates the parents list.
240
if self._revision_store.text_store.listable():
241
return self._revision_store.all_revision_ids(self.get_transaction())
242
result = self._all_possible_ids()
243
# TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
244
# ids. (It should, since _revision_store's API should change to
245
# return utf8 revision_ids)
246
return self._eliminate_revisions_not_present(result)
248
def _check_revision_parents(self, revision, inventory):
249
"""Private to Repository and Fetch.
251
This checks the parentage of revision in an inventory weave for
252
consistency and is only applicable to inventory-weave-for-ancestry
253
using repository formats & fetchers.
255
weave_parents = inventory.get_parent_map(
256
[revision.revision_id])[revision.revision_id]
257
parent_map = inventory.get_parent_map(revision.parent_ids)
258
for parent_id in revision.parent_ids:
259
if parent_id in parent_map:
260
# this parent must not be a ghost.
261
if not parent_id in weave_parents:
263
raise errors.CorruptRepository(self)
265
def get_commit_builder(self, branch, parents, config, timestamp=None,
266
timezone=None, committer=None, revprops=None,
268
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
269
result = WeaveCommitBuilder(self, parents, config, timestamp, timezone,
270
committer, revprops, revision_id)
271
self.start_write_group()
275
def get_revision(self, revision_id):
276
"""Return the Revision object for a named revision"""
277
# TODO: jam 20070210 get_revision_reconcile should do this for us
278
r = self.get_revision_reconcile(revision_id)
279
# weave corruption can lead to absent revision markers that should be
281
# the following test is reasonably cheap (it needs a single weave read)
282
# and the weave is cached in read transactions. In write transactions
283
# it is not cached but typically we only read a small number of
284
# revisions. For knits when they are introduced we will probably want
285
# to ensure that caching write transactions are in use.
286
inv = self.get_inventory_weave()
287
self._check_revision_parents(r, inv)
290
@deprecated_method(one_four)
292
def get_revision_graph(self, revision_id=None):
293
"""Return a dictionary containing the revision graph.
295
:param revision_id: The revision_id to get a graph from. If None, then
296
the entire revision graph is returned. This is a deprecated mode of
297
operation and will be removed in the future.
298
:return: a dictionary of revision_id->revision_parents_list.
300
if 'evil' in debug.debug_flags:
302
"get_revision_graph scales with size of history.")
303
# special case NULL_REVISION
304
if revision_id == _mod_revision.NULL_REVISION:
306
a_weave = self.get_inventory_weave()
307
all_revisions = self._eliminate_revisions_not_present(
309
entire_graph = a_weave.get_parent_map(all_revisions)
310
if revision_id is None:
312
elif revision_id not in entire_graph:
313
raise errors.NoSuchRevision(self, revision_id)
315
# add what can be reached from revision_id
317
pending = set([revision_id])
318
while len(pending) > 0:
320
result[node] = entire_graph[node]
321
for revision_id in result[node]:
322
if revision_id not in result:
323
pending.add(revision_id)
326
def has_revisions(self, revision_ids):
327
"""See Repository.has_revisions()."""
329
transaction = self.get_transaction()
330
for revision_id in revision_ids:
331
if self._revision_store.has_revision_id(revision_id, transaction):
332
result.add(revision_id)
335
def revision_graph_can_have_wrong_parents(self):
336
# XXX: This is an old format that we don't support full checking on, so
337
# just claim that checking for this inconsistency is not required.
341
class PreSplitOutRepositoryFormat(RepositoryFormat):
342
"""Base class for the pre split out repository formats."""
344
rich_root_data = False
345
supports_tree_reference = False
346
supports_ghosts = False
347
supports_external_lookups = False
349
def initialize(self, a_bzrdir, shared=False, _internal=False):
350
"""Create a weave repository."""
352
raise errors.IncompatibleFormat(self, a_bzrdir._format)
355
# always initialized when the bzrdir is.
356
return self.open(a_bzrdir, _found=True)
358
# Create an empty weave
360
weavefile.write_weave_v5(weave.Weave(), sio)
361
empty_weave = sio.getvalue()
363
mutter('creating repository in %s.', a_bzrdir.transport.base)
364
dirs = ['revision-store', 'weaves']
365
files = [('inventory.weave', StringIO(empty_weave)),
368
# FIXME: RBC 20060125 don't peek under the covers
369
# NB: no need to escape relative paths that are url safe.
370
control_files = lockable_files.LockableFiles(a_bzrdir.transport,
371
'branch-lock', lockable_files.TransportLock)
372
control_files.create_lock()
373
control_files.lock_write()
374
control_files._transport.mkdir_multi(dirs,
375
mode=control_files._dir_mode)
377
for file, content in files:
378
control_files.put(file, content)
380
control_files.unlock()
381
return self.open(a_bzrdir, _found=True)
383
def _get_control_store(self, repo_transport, control_files):
384
"""Return the control store for this repository."""
385
return self._get_versioned_file_store('',
390
def _get_text_store(self, transport, control_files):
391
"""Get a store for file texts for this format."""
392
raise NotImplementedError(self._get_text_store)
394
def open(self, a_bzrdir, _found=False):
395
"""See RepositoryFormat.open()."""
397
# we are being called directly and must probe.
398
raise NotImplementedError
400
repo_transport = a_bzrdir.get_repository_transport(None)
401
control_files = a_bzrdir._control_files
402
text_store = self._get_text_store(repo_transport, control_files)
403
control_store = self._get_control_store(repo_transport, control_files)
404
_revision_store = self._get_revision_store(repo_transport, control_files)
405
return AllInOneRepository(_format=self,
407
_revision_store=_revision_store,
408
control_store=control_store,
409
text_store=text_store)
411
def check_conversion_target(self, target_format):
415
class RepositoryFormat4(PreSplitOutRepositoryFormat):
416
"""Bzr repository format 4.
418
This repository format has:
420
- TextStores for texts, inventories,revisions.
422
This format is deprecated: it indexes texts using a text id which is
423
removed in format 5; initialization and write support for this format
427
_matchingbzrdir = bzrdir.BzrDirFormat4()
430
super(RepositoryFormat4, self).__init__()
432
def get_format_description(self):
433
"""See RepositoryFormat.get_format_description()."""
434
return "Repository format 4"
436
def initialize(self, url, shared=False, _internal=False):
437
"""Format 4 branches cannot be created."""
438
raise errors.UninitializableFormat(self)
440
def is_supported(self):
441
"""Format 4 is not supported.
443
It is not supported because the model changed from 4 to 5 and the
444
conversion logic is expensive - so doing it on the fly was not
449
def _get_control_store(self, repo_transport, control_files):
450
"""Format 4 repositories have no formal control store at this point.
452
This will cause any control-file-needing apis to fail - this is desired.
456
def _get_revision_store(self, repo_transport, control_files):
457
"""See RepositoryFormat._get_revision_store()."""
458
from bzrlib.xml4 import serializer_v4
459
return self._get_text_rev_store(repo_transport,
462
serializer=serializer_v4)
464
def _get_text_store(self, transport, control_files):
465
"""See RepositoryFormat._get_text_store()."""
468
class RepositoryFormat5(PreSplitOutRepositoryFormat):
469
"""Bzr control format 5.
471
This repository format has:
472
- weaves for file texts and inventory
474
- TextStores for revisions and signatures.
477
_versionedfile_class = weave.WeaveFile
478
_matchingbzrdir = bzrdir.BzrDirFormat5()
481
super(RepositoryFormat5, self).__init__()
483
def get_format_description(self):
484
"""See RepositoryFormat.get_format_description()."""
485
return "Weave repository format 5"
487
def _get_revision_store(self, repo_transport, control_files):
488
"""See RepositoryFormat._get_revision_store()."""
489
"""Return the revision store object for this a_bzrdir."""
490
return self._get_text_rev_store(repo_transport,
495
def _get_text_store(self, transport, control_files):
496
"""See RepositoryFormat._get_text_store()."""
497
return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
500
class RepositoryFormat6(PreSplitOutRepositoryFormat):
501
"""Bzr control format 6.
503
This repository format has:
504
- weaves for file texts and inventory
505
- hash subdirectory based stores.
506
- TextStores for revisions and signatures.
509
_versionedfile_class = weave.WeaveFile
510
_matchingbzrdir = bzrdir.BzrDirFormat6()
513
super(RepositoryFormat6, self).__init__()
515
def get_format_description(self):
516
"""See RepositoryFormat.get_format_description()."""
517
return "Weave repository format 6"
519
def _get_revision_store(self, repo_transport, control_files):
520
"""See RepositoryFormat._get_revision_store()."""
521
return self._get_text_rev_store(repo_transport,
527
def _get_text_store(self, transport, control_files):
528
"""See RepositoryFormat._get_text_store()."""
529
return self._get_versioned_file_store('weaves', transport, control_files)
531
class RepositoryFormat7(MetaDirRepositoryFormat):
534
This repository format has:
535
- weaves for file texts and inventory
536
- hash subdirectory based stores.
537
- TextStores for revisions and signatures.
538
- a format marker of its own
539
- an optional 'shared-storage' flag
540
- an optional 'no-working-trees' flag
543
_versionedfile_class = weave.WeaveFile
544
supports_ghosts = False
546
def _get_control_store(self, repo_transport, control_files):
547
"""Return the control store for this repository."""
548
return self._get_versioned_file_store('',
553
def get_format_string(self):
554
"""See RepositoryFormat.get_format_string()."""
555
return "Bazaar-NG Repository format 7"
557
def get_format_description(self):
558
"""See RepositoryFormat.get_format_description()."""
559
return "Weave repository format 7"
561
def check_conversion_target(self, target_format):
564
def _get_revision_store(self, repo_transport, control_files):
565
"""See RepositoryFormat._get_revision_store()."""
566
return self._get_text_rev_store(repo_transport,
573
def _get_text_store(self, transport, control_files):
574
"""See RepositoryFormat._get_text_store()."""
575
return self._get_versioned_file_store('weaves',
579
def initialize(self, a_bzrdir, shared=False):
580
"""Create a weave repository.
582
:param shared: If true the repository will be initialized as a shared
585
# Create an empty weave
587
weavefile.write_weave_v5(weave.Weave(), sio)
588
empty_weave = sio.getvalue()
590
mutter('creating repository in %s.', a_bzrdir.transport.base)
591
dirs = ['revision-store', 'weaves']
592
files = [('inventory.weave', StringIO(empty_weave)),
594
utf8_files = [('format', self.get_format_string())]
596
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
597
return self.open(a_bzrdir=a_bzrdir, _found=True)
599
def open(self, a_bzrdir, _found=False, _override_transport=None):
600
"""See RepositoryFormat.open().
602
:param _override_transport: INTERNAL USE ONLY. Allows opening the
603
repository at a slightly different url
604
than normal. I.e. during 'upgrade'.
607
format = RepositoryFormat.find_format(a_bzrdir)
608
assert format.__class__ == self.__class__
609
if _override_transport is not None:
610
repo_transport = _override_transport
612
repo_transport = a_bzrdir.get_repository_transport(None)
613
control_files = lockable_files.LockableFiles(repo_transport,
614
'lock', lockdir.LockDir)
615
text_store = self._get_text_store(repo_transport, control_files)
616
control_store = self._get_control_store(repo_transport, control_files)
617
_revision_store = self._get_revision_store(repo_transport, control_files)
618
return WeaveMetaDirRepository(_format=self,
620
control_files=control_files,
621
_revision_store=_revision_store,
622
control_store=control_store,
623
text_store=text_store)
626
class WeaveCommitBuilder(CommitBuilder):
627
"""A builder for weave based repos that don't support ghosts."""
629
def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
630
versionedfile = self.repository.weave_store.get_weave_or_empty(
631
file_id, self.repository.get_transaction())
632
result = versionedfile.add_lines(
633
self._new_revision_id, parents, new_lines,
634
nostore_sha=nostore_sha)[0:2]
638
_legacy_formats = [RepositoryFormat4(),