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
supports_chks = False
270
_fetch_order = 'topological'
271
_fetch_reconcile = True
274
def initialize(self, a_bzrdir, shared=False, _internal=False):
275
"""Create a weave repository."""
277
raise errors.IncompatibleFormat(self, a_bzrdir._format)
280
# always initialized when the bzrdir is.
281
return self.open(a_bzrdir, _found=True)
283
# Create an empty weave
285
weavefile.write_weave_v5(weave.Weave(), sio)
286
empty_weave = sio.getvalue()
288
mutter('creating repository in %s.', a_bzrdir.transport.base)
290
# FIXME: RBC 20060125 don't peek under the covers
291
# NB: no need to escape relative paths that are url safe.
292
control_files = lockable_files.LockableFiles(a_bzrdir.transport,
293
'branch-lock', lockable_files.TransportLock)
294
control_files.create_lock()
295
control_files.lock_write()
296
transport = a_bzrdir.transport
298
transport.mkdir_multi(['revision-store', 'weaves'],
299
mode=a_bzrdir._get_dir_mode())
300
transport.put_bytes_non_atomic('inventory.weave', empty_weave,
301
mode=a_bzrdir._get_file_mode())
303
control_files.unlock()
304
return self.open(a_bzrdir, _found=True)
306
def open(self, a_bzrdir, _found=False):
307
"""See RepositoryFormat.open()."""
309
# we are being called directly and must probe.
310
raise NotImplementedError
312
repo_transport = a_bzrdir.get_repository_transport(None)
313
control_files = a_bzrdir._control_files
314
result = AllInOneRepository(_format=self, a_bzrdir=a_bzrdir)
315
result.revisions = self._get_revisions(repo_transport, result)
316
result.signatures = self._get_signatures(repo_transport, result)
317
result.inventories = self._get_inventories(repo_transport, result)
318
result.texts = self._get_texts(repo_transport, result)
319
result.chk_bytes = None
322
def check_conversion_target(self, target_format):
326
class RepositoryFormat4(PreSplitOutRepositoryFormat):
327
"""Bzr repository format 4.
329
This repository format has:
331
- TextStores for texts, inventories,revisions.
333
This format is deprecated: it indexes texts using a text id which is
334
removed in format 5; initialization and write support for this format
338
_matchingbzrdir = bzrdir.BzrDirFormat4()
340
def get_format_description(self):
341
"""See RepositoryFormat.get_format_description()."""
342
return "Repository format 4"
344
def initialize(self, url, shared=False, _internal=False):
345
"""Format 4 branches cannot be created."""
346
raise errors.UninitializableFormat(self)
348
def is_supported(self):
349
"""Format 4 is not supported.
351
It is not supported because the model changed from 4 to 5 and the
352
conversion logic is expensive - so doing it on the fly was not
357
def _get_inventories(self, repo_transport, repo, name='inventory'):
358
# No inventories store written so far.
361
def _get_revisions(self, repo_transport, repo):
362
from bzrlib.xml4 import serializer_v4
363
return RevisionTextStore(repo_transport.clone('revision-store'),
364
serializer_v4, True, versionedfile.PrefixMapper(),
365
repo.is_locked, repo.is_write_locked)
367
def _get_signatures(self, repo_transport, repo):
368
return SignatureTextStore(repo_transport.clone('revision-store'),
369
False, versionedfile.PrefixMapper(),
370
repo.is_locked, repo.is_write_locked)
372
def _get_texts(self, repo_transport, repo):
376
class RepositoryFormat5(PreSplitOutRepositoryFormat):
377
"""Bzr control format 5.
379
This repository format has:
380
- weaves for file texts and inventory
382
- TextStores for revisions and signatures.
385
_versionedfile_class = weave.WeaveFile
386
_matchingbzrdir = bzrdir.BzrDirFormat5()
388
def _serializer(self):
389
return xml5.serializer_v5
391
def get_format_description(self):
392
"""See RepositoryFormat.get_format_description()."""
393
return "Weave repository format 5"
395
def network_name(self):
396
"""The network name for this format is the control dirs disk label."""
397
return self._matchingbzrdir.get_format_string()
399
def _get_inventories(self, repo_transport, repo, name='inventory'):
400
mapper = versionedfile.ConstantMapper(name)
401
return versionedfile.ThunkedVersionedFiles(repo_transport,
402
weave.WeaveFile, mapper, repo.is_locked)
404
def _get_revisions(self, repo_transport, repo):
405
return RevisionTextStore(repo_transport.clone('revision-store'),
406
xml5.serializer_v5, False, versionedfile.PrefixMapper(),
407
repo.is_locked, repo.is_write_locked)
409
def _get_signatures(self, repo_transport, repo):
410
return SignatureTextStore(repo_transport.clone('revision-store'),
411
False, versionedfile.PrefixMapper(),
412
repo.is_locked, repo.is_write_locked)
414
def _get_texts(self, repo_transport, repo):
415
mapper = versionedfile.PrefixMapper()
416
base_transport = repo_transport.clone('weaves')
417
return versionedfile.ThunkedVersionedFiles(base_transport,
418
weave.WeaveFile, mapper, repo.is_locked)
421
class RepositoryFormat6(PreSplitOutRepositoryFormat):
422
"""Bzr control format 6.
424
This repository format has:
425
- weaves for file texts and inventory
426
- hash subdirectory based stores.
427
- TextStores for revisions and signatures.
430
_versionedfile_class = weave.WeaveFile
431
_matchingbzrdir = bzrdir.BzrDirFormat6()
433
def _serializer(self):
434
return xml5.serializer_v5
436
def get_format_description(self):
437
"""See RepositoryFormat.get_format_description()."""
438
return "Weave repository format 6"
440
def network_name(self):
441
"""The network name for this format is the control dirs disk label."""
442
return self._matchingbzrdir.get_format_string()
444
def _get_inventories(self, repo_transport, repo, name='inventory'):
445
mapper = versionedfile.ConstantMapper(name)
446
return versionedfile.ThunkedVersionedFiles(repo_transport,
447
weave.WeaveFile, mapper, repo.is_locked)
449
def _get_revisions(self, repo_transport, repo):
450
return RevisionTextStore(repo_transport.clone('revision-store'),
451
xml5.serializer_v5, False, versionedfile.HashPrefixMapper(),
452
repo.is_locked, repo.is_write_locked)
454
def _get_signatures(self, repo_transport, repo):
455
return SignatureTextStore(repo_transport.clone('revision-store'),
456
False, versionedfile.HashPrefixMapper(),
457
repo.is_locked, repo.is_write_locked)
459
def _get_texts(self, repo_transport, repo):
460
mapper = versionedfile.HashPrefixMapper()
461
base_transport = repo_transport.clone('weaves')
462
return versionedfile.ThunkedVersionedFiles(base_transport,
463
weave.WeaveFile, mapper, repo.is_locked)
466
class RepositoryFormat7(MetaDirRepositoryFormat):
469
This repository format has:
470
- weaves for file texts and inventory
471
- hash subdirectory based stores.
472
- TextStores for revisions and signatures.
473
- a format marker of its own
474
- an optional 'shared-storage' flag
475
- an optional 'no-working-trees' flag
478
_versionedfile_class = weave.WeaveFile
479
supports_ghosts = False
480
supports_chks = False
482
_fetch_order = 'topological'
483
_fetch_reconcile = True
486
def _serializer(self):
487
return xml5.serializer_v5
489
def get_format_string(self):
490
"""See RepositoryFormat.get_format_string()."""
491
return "Bazaar-NG Repository format 7"
493
def get_format_description(self):
494
"""See RepositoryFormat.get_format_description()."""
495
return "Weave repository format 7"
497
def check_conversion_target(self, target_format):
500
def _get_inventories(self, repo_transport, repo, name='inventory'):
501
mapper = versionedfile.ConstantMapper(name)
502
return versionedfile.ThunkedVersionedFiles(repo_transport,
503
weave.WeaveFile, mapper, repo.is_locked)
505
def _get_revisions(self, repo_transport, repo):
506
return RevisionTextStore(repo_transport.clone('revision-store'),
507
xml5.serializer_v5, True, versionedfile.HashPrefixMapper(),
508
repo.is_locked, repo.is_write_locked)
510
def _get_signatures(self, repo_transport, repo):
511
return SignatureTextStore(repo_transport.clone('revision-store'),
512
True, versionedfile.HashPrefixMapper(),
513
repo.is_locked, repo.is_write_locked)
515
def _get_texts(self, repo_transport, repo):
516
mapper = versionedfile.HashPrefixMapper()
517
base_transport = repo_transport.clone('weaves')
518
return versionedfile.ThunkedVersionedFiles(base_transport,
519
weave.WeaveFile, mapper, repo.is_locked)
521
def initialize(self, a_bzrdir, shared=False):
522
"""Create a weave repository.
524
:param shared: If true the repository will be initialized as a shared
527
# Create an empty weave
529
weavefile.write_weave_v5(weave.Weave(), sio)
530
empty_weave = sio.getvalue()
532
mutter('creating repository in %s.', a_bzrdir.transport.base)
533
dirs = ['revision-store', 'weaves']
534
files = [('inventory.weave', StringIO(empty_weave)),
536
utf8_files = [('format', self.get_format_string())]
538
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
539
return self.open(a_bzrdir=a_bzrdir, _found=True)
541
def open(self, a_bzrdir, _found=False, _override_transport=None):
542
"""See RepositoryFormat.open().
544
:param _override_transport: INTERNAL USE ONLY. Allows opening the
545
repository at a slightly different url
546
than normal. I.e. during 'upgrade'.
549
format = RepositoryFormat.find_format(a_bzrdir)
550
if _override_transport is not None:
551
repo_transport = _override_transport
553
repo_transport = a_bzrdir.get_repository_transport(None)
554
control_files = lockable_files.LockableFiles(repo_transport,
555
'lock', lockdir.LockDir)
556
result = WeaveMetaDirRepository(_format=self, a_bzrdir=a_bzrdir,
557
control_files=control_files)
558
result.revisions = self._get_revisions(repo_transport, result)
559
result.signatures = self._get_signatures(repo_transport, result)
560
result.inventories = self._get_inventories(repo_transport, result)
561
result.texts = self._get_texts(repo_transport, result)
562
result.chk_bytes = None
563
result._transport = repo_transport
567
class TextVersionedFiles(VersionedFiles):
568
"""Just-a-bunch-of-files based VersionedFile stores."""
570
def __init__(self, transport, compressed, mapper, is_locked, can_write):
571
self._compressed = compressed
572
self._transport = transport
573
self._mapper = mapper
578
self._is_locked = is_locked
579
self._can_write = can_write
581
def add_lines(self, key, parents, lines):
582
"""Add a revision to the store."""
583
if not self._is_locked():
584
raise errors.ObjectNotLocked(self)
585
if not self._can_write():
586
raise errors.ReadOnlyError(self)
588
raise ValueError('bad idea to put / in %r' % (key,))
589
text = ''.join(lines)
591
text = bytes_to_gzip(text)
592
path = self._map(key)
593
self._transport.put_bytes_non_atomic(path, text, create_parent_dir=True)
595
def insert_record_stream(self, stream):
597
for record in stream:
598
# Raise an error when a record is missing.
599
if record.storage_kind == 'absent':
600
raise errors.RevisionNotPresent([record.key[0]], self)
601
# adapt to non-tuple interface
602
if record.storage_kind == 'fulltext':
603
self.add_lines(record.key, None,
604
osutils.split_lines(record.get_bytes_as('fulltext')))
606
adapter_key = record.storage_kind, 'fulltext'
608
adapter = adapters[adapter_key]
610
adapter_factory = adapter_registry.get(adapter_key)
611
adapter = adapter_factory(self)
612
adapters[adapter_key] = adapter
613
lines = osutils.split_lines(adapter.get_bytes(
614
record, record.get_bytes_as(record.storage_kind)))
616
self.add_lines(record.key, None, lines)
617
except RevisionAlreadyPresent:
620
def _load_text(self, key):
621
if not self._is_locked():
622
raise errors.ObjectNotLocked(self)
623
path = self._map(key)
625
text = self._transport.get_bytes(path)
626
compressed = self._compressed
627
except errors.NoSuchFile:
629
# try without the .gz
632
text = self._transport.get_bytes(path)
634
except errors.NoSuchFile:
639
text = GzipFile(mode='rb', fileobj=StringIO(text)).read()
643
return self._mapper.map(key) + self._ext
646
class RevisionTextStore(TextVersionedFiles):
647
"""Legacy thunk for format 4 repositories."""
649
def __init__(self, transport, serializer, compressed, mapper, is_locked,
651
"""Create a RevisionTextStore at transport with serializer."""
652
TextVersionedFiles.__init__(self, transport, compressed, mapper,
653
is_locked, can_write)
654
self._serializer = serializer
656
def _load_text_parents(self, key):
657
text = self._load_text(key)
660
parents = self._serializer.read_revision_from_string(text).parent_ids
661
return text, tuple((parent,) for parent in parents)
663
def get_parent_map(self, keys):
666
parents = self._load_text_parents(key)[1]
669
result[key] = parents
672
def get_record_stream(self, keys, sort_order, include_delta_closure):
674
text, parents = self._load_text_parents(key)
676
yield AbsentContentFactory(key)
678
yield FulltextContentFactory(key, parents, None, text)
681
if not self._is_locked():
682
raise errors.ObjectNotLocked(self)
684
for quoted_relpath in self._transport.iter_files_recursive():
685
relpath = urllib.unquote(quoted_relpath)
686
path, ext = os.path.splitext(relpath)
689
if '.sig' not in relpath:
690
relpaths.add(relpath)
691
paths = list(relpaths)
692
return set([self._mapper.unmap(path) for path in paths])
695
class SignatureTextStore(TextVersionedFiles):
696
"""Legacy thunk for format 4-7 repositories."""
698
def __init__(self, transport, compressed, mapper, is_locked, can_write):
699
TextVersionedFiles.__init__(self, transport, compressed, mapper,
700
is_locked, can_write)
701
self._ext = '.sig' + self._ext
703
def get_parent_map(self, keys):
706
text = self._load_text(key)
712
def get_record_stream(self, keys, sort_order, include_delta_closure):
714
text = self._load_text(key)
716
yield AbsentContentFactory(key)
718
yield FulltextContentFactory(key, None, None, text)
721
if not self._is_locked():
722
raise errors.ObjectNotLocked(self)
724
for quoted_relpath in self._transport.iter_files_recursive():
725
relpath = urllib.unquote(quoted_relpath)
726
path, ext = os.path.splitext(relpath)
729
if not relpath.endswith('.sig'):
731
relpaths.add(relpath[:-4])
732
paths = list(relpaths)
733
return set([self._mapper.unmap(path) for path in paths])
735
_legacy_formats = [RepositoryFormat4(),