1
# Copyright (C) 2005, 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Deprecated weave-based repository formats.
19
Weave based formats scaled linearly with history size and could not represent
24
from cStringIO import StringIO
27
from bzrlib.lazy_import import lazy_import
28
lazy_import(globals(), """
40
revision as _mod_revision,
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.repository import (
49
MetaDirVersionedFileRepository,
50
MetaDirRepositoryFormat,
54
from bzrlib.store.text import TextStore
55
from bzrlib.trace import mutter
56
from bzrlib.tuned_gzip import GzipFile, bytes_to_gzip
57
from bzrlib.versionedfile import (
59
FulltextContentFactory,
64
class AllInOneRepository(Repository):
65
"""Legacy support - the repository behaviour for all-in-one branches."""
68
def _serializer(self):
69
return xml5.serializer_v5
71
def _escape(self, file_or_path):
72
if not isinstance(file_or_path, basestring):
73
file_or_path = '/'.join(file_or_path)
74
if file_or_path == '':
76
return urlutils.escape(osutils.safe_unicode(file_or_path))
78
def __init__(self, _format, a_bzrdir):
79
# we reuse one control files instance.
80
dir_mode = a_bzrdir._get_dir_mode()
81
file_mode = a_bzrdir._get_file_mode()
83
def get_store(name, compressed=True, prefixed=False):
84
# FIXME: This approach of assuming stores are all entirely compressed
85
# or entirely uncompressed is tidy, but breaks upgrade from
86
# some existing branches where there's a mixture; we probably
87
# still want the option to look for both.
88
relpath = self._escape(name)
89
store = TextStore(a_bzrdir.transport.clone(relpath),
90
prefixed=prefixed, compressed=compressed,
95
# not broken out yet because the controlweaves|inventory_store
96
# and texts bits are still different.
97
if isinstance(_format, RepositoryFormat4):
98
# cannot remove these - there is still no consistent api
99
# which allows access to this old info.
100
self.inventory_store = get_store('inventory-store')
101
self._text_store = get_store('text-store')
102
super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files)
105
def _all_possible_ids(self):
106
"""Return all the possible revisions that we could find."""
107
if 'evil' in debug.debug_flags:
108
mutter_callsite(3, "_all_possible_ids scales with size of history.")
109
return [key[-1] for key in self.inventories.keys()]
112
def _all_revision_ids(self):
113
"""Returns a list of all the revision ids in the repository.
115
These are in as much topological order as the underlying store can
116
present: for weaves ghosts may lead to a lack of correctness until
117
the reweave updates the parents list.
119
return [key[-1] for key in self.revisions.keys()]
121
def _activate_new_inventory(self):
122
"""Put a replacement inventory.new into use as inventories."""
123
# Copy the content across
124
t = self.bzrdir._control_files._transport
125
t.copy('inventory.new.weave', 'inventory.weave')
126
# delete the temp inventory
127
t.delete('inventory.new.weave')
128
# Check we can parse the new weave properly as a sanity check
129
self.inventories.keys()
131
def _backup_inventory(self):
132
t = self.bzrdir._control_files._transport
133
t.copy('inventory.weave', 'inventory.backup.weave')
135
def _temp_inventories(self):
136
t = self.bzrdir._control_files._transport
137
return self._format._get_inventories(t, self, 'inventory.new')
139
def get_commit_builder(self, branch, parents, config, timestamp=None,
140
timezone=None, committer=None, revprops=None,
142
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
143
result = CommitBuilder(self, parents, config, timestamp, timezone,
144
committer, revprops, revision_id)
145
self.start_write_group()
149
def get_revisions(self, revision_ids):
150
revs = self._get_revisions(revision_ids)
153
def _inventory_add_lines(self, revision_id, parents, lines,
155
"""Store lines in inv_vf and return the sha1 of the inventory."""
156
present_parents = self.get_graph().get_parent_map(parents)
158
for parent in parents:
159
if parent in present_parents:
160
final_parents.append((parent,))
161
return self.inventories.add_lines((revision_id,), final_parents, lines,
162
check_content=check_content)[0]
165
"""AllInOne repositories cannot be shared."""
169
def set_make_working_trees(self, new_value):
170
"""Set the policy flag for making working trees when creating branches.
172
This only applies to branches that use this repository.
174
The default is 'True'.
175
:param new_value: True to restore the default, False to disable making
178
raise errors.RepositoryUpgradeRequired(self.bzrdir.root_transport.base)
180
def make_working_trees(self):
181
"""Returns the policy for making working trees on new branches."""
184
def revision_graph_can_have_wrong_parents(self):
185
# XXX: This is an old format that we don't support full checking on, so
186
# just claim that checking for this inconsistency is not required.
190
class WeaveMetaDirRepository(MetaDirVersionedFileRepository):
191
"""A subclass of MetaDirRepository to set weave specific policy."""
193
def __init__(self, _format, a_bzrdir, control_files):
194
super(WeaveMetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
195
self._serializer = _format._serializer
198
def _all_possible_ids(self):
199
"""Return all the possible revisions that we could find."""
200
if 'evil' in debug.debug_flags:
201
mutter_callsite(3, "_all_possible_ids scales with size of history.")
202
return [key[-1] for key in self.inventories.keys()]
205
def _all_revision_ids(self):
206
"""Returns a list of all the revision ids in the repository.
208
These are in as much topological order as the underlying store can
209
present: for weaves ghosts may lead to a lack of correctness until
210
the reweave updates the parents list.
212
return [key[-1] for key in self.revisions.keys()]
214
def _activate_new_inventory(self):
215
"""Put a replacement inventory.new into use as inventories."""
216
# Copy the content across
218
t.copy('inventory.new.weave', 'inventory.weave')
219
# delete the temp inventory
220
t.delete('inventory.new.weave')
221
# Check we can parse the new weave properly as a sanity check
222
self.inventories.keys()
224
def _backup_inventory(self):
226
t.copy('inventory.weave', 'inventory.backup.weave')
228
def _temp_inventories(self):
230
return self._format._get_inventories(t, self, 'inventory.new')
232
def get_commit_builder(self, branch, parents, config, timestamp=None,
233
timezone=None, committer=None, revprops=None,
235
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
236
result = CommitBuilder(self, parents, config, timestamp, timezone,
237
committer, revprops, revision_id)
238
self.start_write_group()
242
def get_revision(self, revision_id):
243
"""Return the Revision object for a named revision"""
244
r = self.get_revision_reconcile(revision_id)
247
def _inventory_add_lines(self, revision_id, parents, lines,
249
"""Store lines in inv_vf and return the sha1 of the inventory."""
250
present_parents = self.get_graph().get_parent_map(parents)
252
for parent in parents:
253
if parent in present_parents:
254
final_parents.append((parent,))
255
return self.inventories.add_lines((revision_id,), final_parents, lines,
256
check_content=check_content)[0]
258
def revision_graph_can_have_wrong_parents(self):
262
class PreSplitOutRepositoryFormat(RepositoryFormat):
263
"""Base class for the pre split out repository formats."""
265
rich_root_data = False
266
supports_tree_reference = False
267
supports_ghosts = False
268
supports_external_lookups = False
269
_fetch_order = 'topological'
270
_fetch_reconcile = True
273
def initialize(self, a_bzrdir, shared=False, _internal=False):
274
"""Create a weave repository."""
276
raise errors.IncompatibleFormat(self, a_bzrdir._format)
279
# always initialized when the bzrdir is.
280
return self.open(a_bzrdir, _found=True)
282
# Create an empty weave
284
weavefile.write_weave_v5(weave.Weave(), sio)
285
empty_weave = sio.getvalue()
287
mutter('creating repository in %s.', a_bzrdir.transport.base)
289
# FIXME: RBC 20060125 don't peek under the covers
290
# NB: no need to escape relative paths that are url safe.
291
control_files = lockable_files.LockableFiles(a_bzrdir.transport,
292
'branch-lock', lockable_files.TransportLock)
293
control_files.create_lock()
294
control_files.lock_write()
295
transport = a_bzrdir.transport
297
transport.mkdir_multi(['revision-store', 'weaves'],
298
mode=a_bzrdir._get_dir_mode())
299
transport.put_bytes_non_atomic('inventory.weave', empty_weave,
300
mode=a_bzrdir._get_file_mode())
302
control_files.unlock()
303
return self.open(a_bzrdir, _found=True)
305
def open(self, a_bzrdir, _found=False):
306
"""See RepositoryFormat.open()."""
308
# we are being called directly and must probe.
309
raise NotImplementedError
311
repo_transport = a_bzrdir.get_repository_transport(None)
312
control_files = a_bzrdir._control_files
313
result = AllInOneRepository(_format=self, a_bzrdir=a_bzrdir)
314
result.revisions = self._get_revisions(repo_transport, result)
315
result.signatures = self._get_signatures(repo_transport, result)
316
result.inventories = self._get_inventories(repo_transport, result)
317
result.texts = self._get_texts(repo_transport, result)
320
def check_conversion_target(self, target_format):
324
class RepositoryFormat4(PreSplitOutRepositoryFormat):
325
"""Bzr repository format 4.
327
This repository format has:
329
- TextStores for texts, inventories,revisions.
331
This format is deprecated: it indexes texts using a text id which is
332
removed in format 5; initialization and write support for this format
336
_matchingbzrdir = bzrdir.BzrDirFormat4()
338
def get_format_description(self):
339
"""See RepositoryFormat.get_format_description()."""
340
return "Repository format 4"
342
def initialize(self, url, shared=False, _internal=False):
343
"""Format 4 branches cannot be created."""
344
raise errors.UninitializableFormat(self)
346
def is_supported(self):
347
"""Format 4 is not supported.
349
It is not supported because the model changed from 4 to 5 and the
350
conversion logic is expensive - so doing it on the fly was not
355
def _get_inventories(self, repo_transport, repo, name='inventory'):
356
# No inventories store written so far.
359
def _get_revisions(self, repo_transport, repo):
360
from bzrlib.xml4 import serializer_v4
361
return RevisionTextStore(repo_transport.clone('revision-store'),
362
serializer_v4, True, versionedfile.PrefixMapper(),
363
repo.is_locked, repo.is_write_locked)
365
def _get_signatures(self, repo_transport, repo):
366
return SignatureTextStore(repo_transport.clone('revision-store'),
367
False, versionedfile.PrefixMapper(),
368
repo.is_locked, repo.is_write_locked)
370
def _get_texts(self, repo_transport, repo):
374
class RepositoryFormat5(PreSplitOutRepositoryFormat):
375
"""Bzr control format 5.
377
This repository format has:
378
- weaves for file texts and inventory
380
- TextStores for revisions and signatures.
383
_versionedfile_class = weave.WeaveFile
384
_matchingbzrdir = bzrdir.BzrDirFormat5()
386
def _serializer(self):
387
return xml5.serializer_v5
389
def get_format_description(self):
390
"""See RepositoryFormat.get_format_description()."""
391
return "Weave repository format 5"
393
def network_name(self):
394
"""The network name for this format is the control dirs disk label."""
395
return self._matchingbzrdir.get_format_string()
397
def _get_inventories(self, repo_transport, repo, name='inventory'):
398
mapper = versionedfile.ConstantMapper(name)
399
return versionedfile.ThunkedVersionedFiles(repo_transport,
400
weave.WeaveFile, mapper, repo.is_locked)
402
def _get_revisions(self, repo_transport, repo):
403
return RevisionTextStore(repo_transport.clone('revision-store'),
404
xml5.serializer_v5, False, versionedfile.PrefixMapper(),
405
repo.is_locked, repo.is_write_locked)
407
def _get_signatures(self, repo_transport, repo):
408
return SignatureTextStore(repo_transport.clone('revision-store'),
409
False, versionedfile.PrefixMapper(),
410
repo.is_locked, repo.is_write_locked)
412
def _get_texts(self, repo_transport, repo):
413
mapper = versionedfile.PrefixMapper()
414
base_transport = repo_transport.clone('weaves')
415
return versionedfile.ThunkedVersionedFiles(base_transport,
416
weave.WeaveFile, mapper, repo.is_locked)
419
class RepositoryFormat6(PreSplitOutRepositoryFormat):
420
"""Bzr control format 6.
422
This repository format has:
423
- weaves for file texts and inventory
424
- hash subdirectory based stores.
425
- TextStores for revisions and signatures.
428
_versionedfile_class = weave.WeaveFile
429
_matchingbzrdir = bzrdir.BzrDirFormat6()
431
def _serializer(self):
432
return xml5.serializer_v5
434
def get_format_description(self):
435
"""See RepositoryFormat.get_format_description()."""
436
return "Weave repository format 6"
438
def network_name(self):
439
"""The network name for this format is the control dirs disk label."""
440
return self._matchingbzrdir.get_format_string()
442
def _get_inventories(self, repo_transport, repo, name='inventory'):
443
mapper = versionedfile.ConstantMapper(name)
444
return versionedfile.ThunkedVersionedFiles(repo_transport,
445
weave.WeaveFile, mapper, repo.is_locked)
447
def _get_revisions(self, repo_transport, repo):
448
return RevisionTextStore(repo_transport.clone('revision-store'),
449
xml5.serializer_v5, False, versionedfile.HashPrefixMapper(),
450
repo.is_locked, repo.is_write_locked)
452
def _get_signatures(self, repo_transport, repo):
453
return SignatureTextStore(repo_transport.clone('revision-store'),
454
False, versionedfile.HashPrefixMapper(),
455
repo.is_locked, repo.is_write_locked)
457
def _get_texts(self, repo_transport, repo):
458
mapper = versionedfile.HashPrefixMapper()
459
base_transport = repo_transport.clone('weaves')
460
return versionedfile.ThunkedVersionedFiles(base_transport,
461
weave.WeaveFile, mapper, repo.is_locked)
464
class RepositoryFormat7(MetaDirRepositoryFormat):
467
This repository format has:
468
- weaves for file texts and inventory
469
- hash subdirectory based stores.
470
- TextStores for revisions and signatures.
471
- a format marker of its own
472
- an optional 'shared-storage' flag
473
- an optional 'no-working-trees' flag
476
_versionedfile_class = weave.WeaveFile
477
supports_ghosts = False
478
_fetch_order = 'topological'
479
_fetch_reconcile = True
482
def _serializer(self):
483
return xml5.serializer_v5
485
def get_format_string(self):
486
"""See RepositoryFormat.get_format_string()."""
487
return "Bazaar-NG Repository format 7"
489
def get_format_description(self):
490
"""See RepositoryFormat.get_format_description()."""
491
return "Weave repository format 7"
493
def check_conversion_target(self, target_format):
496
def _get_inventories(self, repo_transport, repo, name='inventory'):
497
mapper = versionedfile.ConstantMapper(name)
498
return versionedfile.ThunkedVersionedFiles(repo_transport,
499
weave.WeaveFile, mapper, repo.is_locked)
501
def _get_revisions(self, repo_transport, repo):
502
return RevisionTextStore(repo_transport.clone('revision-store'),
503
xml5.serializer_v5, True, versionedfile.HashPrefixMapper(),
504
repo.is_locked, repo.is_write_locked)
506
def _get_signatures(self, repo_transport, repo):
507
return SignatureTextStore(repo_transport.clone('revision-store'),
508
True, versionedfile.HashPrefixMapper(),
509
repo.is_locked, repo.is_write_locked)
511
def _get_texts(self, repo_transport, repo):
512
mapper = versionedfile.HashPrefixMapper()
513
base_transport = repo_transport.clone('weaves')
514
return versionedfile.ThunkedVersionedFiles(base_transport,
515
weave.WeaveFile, mapper, repo.is_locked)
517
def initialize(self, a_bzrdir, shared=False):
518
"""Create a weave repository.
520
:param shared: If true the repository will be initialized as a shared
523
# Create an empty weave
525
weavefile.write_weave_v5(weave.Weave(), sio)
526
empty_weave = sio.getvalue()
528
mutter('creating repository in %s.', a_bzrdir.transport.base)
529
dirs = ['revision-store', 'weaves']
530
files = [('inventory.weave', StringIO(empty_weave)),
532
utf8_files = [('format', self.get_format_string())]
534
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
535
return self.open(a_bzrdir=a_bzrdir, _found=True)
537
def open(self, a_bzrdir, _found=False, _override_transport=None):
538
"""See RepositoryFormat.open().
540
:param _override_transport: INTERNAL USE ONLY. Allows opening the
541
repository at a slightly different url
542
than normal. I.e. during 'upgrade'.
545
format = RepositoryFormat.find_format(a_bzrdir)
546
if _override_transport is not None:
547
repo_transport = _override_transport
549
repo_transport = a_bzrdir.get_repository_transport(None)
550
control_files = lockable_files.LockableFiles(repo_transport,
551
'lock', lockdir.LockDir)
552
result = WeaveMetaDirRepository(_format=self, a_bzrdir=a_bzrdir,
553
control_files=control_files)
554
result.revisions = self._get_revisions(repo_transport, result)
555
result.signatures = self._get_signatures(repo_transport, result)
556
result.inventories = self._get_inventories(repo_transport, result)
557
result.texts = self._get_texts(repo_transport, result)
558
result._transport = repo_transport
562
class TextVersionedFiles(VersionedFiles):
563
"""Just-a-bunch-of-files based VersionedFile stores."""
565
def __init__(self, transport, compressed, mapper, is_locked, can_write):
566
self._compressed = compressed
567
self._transport = transport
568
self._mapper = mapper
573
self._is_locked = is_locked
574
self._can_write = can_write
576
def add_lines(self, key, parents, lines):
577
"""Add a revision to the store."""
578
if not self._is_locked():
579
raise errors.ObjectNotLocked(self)
580
if not self._can_write():
581
raise errors.ReadOnlyError(self)
583
raise ValueError('bad idea to put / in %r' % (key,))
584
text = ''.join(lines)
586
text = bytes_to_gzip(text)
587
path = self._map(key)
588
self._transport.put_bytes_non_atomic(path, text, create_parent_dir=True)
590
def insert_record_stream(self, stream):
592
for record in stream:
593
# Raise an error when a record is missing.
594
if record.storage_kind == 'absent':
595
raise errors.RevisionNotPresent([record.key[0]], self)
596
# adapt to non-tuple interface
597
if record.storage_kind == 'fulltext':
598
self.add_lines(record.key, None,
599
osutils.split_lines(record.get_bytes_as('fulltext')))
601
adapter_key = record.storage_kind, 'fulltext'
603
adapter = adapters[adapter_key]
605
adapter_factory = adapter_registry.get(adapter_key)
606
adapter = adapter_factory(self)
607
adapters[adapter_key] = adapter
608
lines = osutils.split_lines(adapter.get_bytes(
609
record, record.get_bytes_as(record.storage_kind)))
611
self.add_lines(record.key, None, lines)
612
except RevisionAlreadyPresent:
615
def _load_text(self, key):
616
if not self._is_locked():
617
raise errors.ObjectNotLocked(self)
618
path = self._map(key)
620
text = self._transport.get_bytes(path)
621
compressed = self._compressed
622
except errors.NoSuchFile:
624
# try without the .gz
627
text = self._transport.get_bytes(path)
629
except errors.NoSuchFile:
634
text = GzipFile(mode='rb', fileobj=StringIO(text)).read()
638
return self._mapper.map(key) + self._ext
641
class RevisionTextStore(TextVersionedFiles):
642
"""Legacy thunk for format 4 repositories."""
644
def __init__(self, transport, serializer, compressed, mapper, is_locked,
646
"""Create a RevisionTextStore at transport with serializer."""
647
TextVersionedFiles.__init__(self, transport, compressed, mapper,
648
is_locked, can_write)
649
self._serializer = serializer
651
def _load_text_parents(self, key):
652
text = self._load_text(key)
655
parents = self._serializer.read_revision_from_string(text).parent_ids
656
return text, tuple((parent,) for parent in parents)
658
def get_parent_map(self, keys):
661
parents = self._load_text_parents(key)[1]
664
result[key] = parents
667
def get_record_stream(self, keys, sort_order, include_delta_closure):
669
text, parents = self._load_text_parents(key)
671
yield AbsentContentFactory(key)
673
yield FulltextContentFactory(key, parents, None, text)
676
if not self._is_locked():
677
raise errors.ObjectNotLocked(self)
679
for quoted_relpath in self._transport.iter_files_recursive():
680
relpath = urllib.unquote(quoted_relpath)
681
path, ext = os.path.splitext(relpath)
684
if '.sig' not in relpath:
685
relpaths.add(relpath)
686
paths = list(relpaths)
687
return set([self._mapper.unmap(path) for path in paths])
690
class SignatureTextStore(TextVersionedFiles):
691
"""Legacy thunk for format 4-7 repositories."""
693
def __init__(self, transport, compressed, mapper, is_locked, can_write):
694
TextVersionedFiles.__init__(self, transport, compressed, mapper,
695
is_locked, can_write)
696
self._ext = '.sig' + self._ext
698
def get_parent_map(self, keys):
701
text = self._load_text(key)
707
def get_record_stream(self, keys, sort_order, include_delta_closure):
709
text = self._load_text(key)
711
yield AbsentContentFactory(key)
713
yield FulltextContentFactory(key, None, None, text)
716
if not self._is_locked():
717
raise errors.ObjectNotLocked(self)
719
for quoted_relpath in self._transport.iter_files_recursive():
720
relpath = urllib.unquote(quoted_relpath)
721
path, ext = os.path.splitext(relpath)
724
if not relpath.endswith('.sig'):
726
relpaths.add(relpath[:-4])
727
paths = list(relpaths)
728
return set([self._mapper.unmap(path) for path in paths])
730
_legacy_formats = [RepositoryFormat4(),