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., 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
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)
103
self._fetch_order = 'topological'
104
self._fetch_reconcile = True
107
def _all_possible_ids(self):
108
"""Return all the possible revisions that we could find."""
109
if 'evil' in debug.debug_flags:
110
mutter_callsite(3, "_all_possible_ids scales with size of history.")
111
return [key[-1] for key in self.inventories.keys()]
114
def _all_revision_ids(self):
115
"""Returns a list of all the revision ids in the repository.
117
These are in as much topological order as the underlying store can
118
present: for weaves ghosts may lead to a lack of correctness until
119
the reweave updates the parents list.
121
return [key[-1] for key in self.revisions.keys()]
123
def _activate_new_inventory(self):
124
"""Put a replacement inventory.new into use as inventories."""
125
# Copy the content across
126
t = self.bzrdir._control_files._transport
127
t.copy('inventory.new.weave', 'inventory.weave')
128
# delete the temp inventory
129
t.delete('inventory.new.weave')
130
# Check we can parse the new weave properly as a sanity check
131
self.inventories.keys()
133
def _backup_inventory(self):
134
t = self.bzrdir._control_files._transport
135
t.copy('inventory.weave', 'inventory.backup.weave')
137
def _temp_inventories(self):
138
t = self.bzrdir._control_files._transport
139
return self._format._get_inventories(t, self, 'inventory.new')
141
def get_commit_builder(self, branch, parents, config, timestamp=None,
142
timezone=None, committer=None, revprops=None,
144
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
145
result = CommitBuilder(self, parents, config, timestamp, timezone,
146
committer, revprops, revision_id)
147
self.start_write_group()
151
def get_revisions(self, revision_ids):
152
revs = self._get_revisions(revision_ids)
155
def _inventory_add_lines(self, revision_id, parents, lines,
157
"""Store lines in inv_vf and return the sha1 of the inventory."""
158
present_parents = self.get_graph().get_parent_map(parents)
160
for parent in parents:
161
if parent in present_parents:
162
final_parents.append((parent,))
163
return self.inventories.add_lines((revision_id,), final_parents, lines,
164
check_content=check_content)[0]
167
"""AllInOne repositories cannot be shared."""
171
def set_make_working_trees(self, new_value):
172
"""Set the policy flag for making working trees when creating branches.
174
This only applies to branches that use this repository.
176
The default is 'True'.
177
:param new_value: True to restore the default, False to disable making
180
raise errors.RepositoryUpgradeRequired(self.bzrdir.root_transport.base)
182
def make_working_trees(self):
183
"""Returns the policy for making working trees on new branches."""
186
def revision_graph_can_have_wrong_parents(self):
187
# XXX: This is an old format that we don't support full checking on, so
188
# just claim that checking for this inconsistency is not required.
192
class WeaveMetaDirRepository(MetaDirVersionedFileRepository):
193
"""A subclass of MetaDirRepository to set weave specific policy."""
195
def __init__(self, _format, a_bzrdir, control_files):
196
super(WeaveMetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
197
self._fetch_order = 'topological'
198
self._fetch_reconcile = True
199
self._serializer = _format._serializer
202
def _all_possible_ids(self):
203
"""Return all the possible revisions that we could find."""
204
if 'evil' in debug.debug_flags:
205
mutter_callsite(3, "_all_possible_ids scales with size of history.")
206
return [key[-1] for key in self.inventories.keys()]
209
def _all_revision_ids(self):
210
"""Returns a list of all the revision ids in the repository.
212
These are in as much topological order as the underlying store can
213
present: for weaves ghosts may lead to a lack of correctness until
214
the reweave updates the parents list.
216
return [key[-1] for key in self.revisions.keys()]
218
def _activate_new_inventory(self):
219
"""Put a replacement inventory.new into use as inventories."""
220
# Copy the content across
222
t.copy('inventory.new.weave', 'inventory.weave')
223
# delete the temp inventory
224
t.delete('inventory.new.weave')
225
# Check we can parse the new weave properly as a sanity check
226
self.inventories.keys()
228
def _backup_inventory(self):
230
t.copy('inventory.weave', 'inventory.backup.weave')
232
def _temp_inventories(self):
234
return self._format._get_inventories(t, self, 'inventory.new')
236
def get_commit_builder(self, branch, parents, config, timestamp=None,
237
timezone=None, committer=None, revprops=None,
239
self._check_ascii_revisionid(revision_id, self.get_commit_builder)
240
result = CommitBuilder(self, parents, config, timestamp, timezone,
241
committer, revprops, revision_id)
242
self.start_write_group()
246
def get_revision(self, revision_id):
247
"""Return the Revision object for a named revision"""
248
r = self.get_revision_reconcile(revision_id)
251
def _inventory_add_lines(self, revision_id, parents, lines,
253
"""Store lines in inv_vf and return the sha1 of the inventory."""
254
present_parents = self.get_graph().get_parent_map(parents)
256
for parent in parents:
257
if parent in present_parents:
258
final_parents.append((parent,))
259
return self.inventories.add_lines((revision_id,), final_parents, lines,
260
check_content=check_content)[0]
262
def revision_graph_can_have_wrong_parents(self):
266
class PreSplitOutRepositoryFormat(RepositoryFormat):
267
"""Base class for the pre split out repository formats."""
269
rich_root_data = False
270
supports_tree_reference = False
271
supports_ghosts = False
272
supports_external_lookups = False
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)
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()
339
super(RepositoryFormat4, self).__init__()
340
self._fetch_order = 'topological'
341
self._fetch_reconcile = True
343
def get_format_description(self):
344
"""See RepositoryFormat.get_format_description()."""
345
return "Repository format 4"
347
def initialize(self, url, shared=False, _internal=False):
348
"""Format 4 branches cannot be created."""
349
raise errors.UninitializableFormat(self)
351
def is_supported(self):
352
"""Format 4 is not supported.
354
It is not supported because the model changed from 4 to 5 and the
355
conversion logic is expensive - so doing it on the fly was not
360
def _get_inventories(self, repo_transport, repo, name='inventory'):
361
# No inventories store written so far.
364
def _get_revisions(self, repo_transport, repo):
365
from bzrlib.xml4 import serializer_v4
366
return RevisionTextStore(repo_transport.clone('revision-store'),
367
serializer_v4, True, versionedfile.PrefixMapper(),
368
repo.is_locked, repo.is_write_locked)
370
def _get_signatures(self, repo_transport, repo):
371
return SignatureTextStore(repo_transport.clone('revision-store'),
372
False, versionedfile.PrefixMapper(),
373
repo.is_locked, repo.is_write_locked)
375
def _get_texts(self, repo_transport, repo):
379
class RepositoryFormat5(PreSplitOutRepositoryFormat):
380
"""Bzr control format 5.
382
This repository format has:
383
- weaves for file texts and inventory
385
- TextStores for revisions and signatures.
388
_versionedfile_class = weave.WeaveFile
389
_matchingbzrdir = bzrdir.BzrDirFormat5()
391
def _serializer(self):
392
return xml5.serializer_v5
395
super(RepositoryFormat5, self).__init__()
396
self._fetch_order = 'topological'
397
self._fetch_reconcile = True
399
def get_format_description(self):
400
"""See RepositoryFormat.get_format_description()."""
401
return "Weave repository format 5"
403
def network_name(self):
404
"""The network name for this format is the control dirs disk label."""
405
return self._matchingbzrdir.get_format_string()
407
def _get_inventories(self, repo_transport, repo, name='inventory'):
408
mapper = versionedfile.ConstantMapper(name)
409
return versionedfile.ThunkedVersionedFiles(repo_transport,
410
weave.WeaveFile, mapper, repo.is_locked)
412
def _get_revisions(self, repo_transport, repo):
413
return RevisionTextStore(repo_transport.clone('revision-store'),
414
xml5.serializer_v5, False, versionedfile.PrefixMapper(),
415
repo.is_locked, repo.is_write_locked)
417
def _get_signatures(self, repo_transport, repo):
418
return SignatureTextStore(repo_transport.clone('revision-store'),
419
False, versionedfile.PrefixMapper(),
420
repo.is_locked, repo.is_write_locked)
422
def _get_texts(self, repo_transport, repo):
423
mapper = versionedfile.PrefixMapper()
424
base_transport = repo_transport.clone('weaves')
425
return versionedfile.ThunkedVersionedFiles(base_transport,
426
weave.WeaveFile, mapper, repo.is_locked)
429
class RepositoryFormat6(PreSplitOutRepositoryFormat):
430
"""Bzr control format 6.
432
This repository format has:
433
- weaves for file texts and inventory
434
- hash subdirectory based stores.
435
- TextStores for revisions and signatures.
438
_versionedfile_class = weave.WeaveFile
439
_matchingbzrdir = bzrdir.BzrDirFormat6()
441
def _serializer(self):
442
return xml5.serializer_v5
445
super(RepositoryFormat6, self).__init__()
446
self._fetch_order = 'topological'
447
self._fetch_reconcile = True
449
def get_format_description(self):
450
"""See RepositoryFormat.get_format_description()."""
451
return "Weave repository format 6"
453
def network_name(self):
454
"""The network name for this format is the control dirs disk label."""
455
return self._matchingbzrdir.get_format_string()
457
def _get_inventories(self, repo_transport, repo, name='inventory'):
458
mapper = versionedfile.ConstantMapper(name)
459
return versionedfile.ThunkedVersionedFiles(repo_transport,
460
weave.WeaveFile, mapper, repo.is_locked)
462
def _get_revisions(self, repo_transport, repo):
463
return RevisionTextStore(repo_transport.clone('revision-store'),
464
xml5.serializer_v5, False, versionedfile.HashPrefixMapper(),
465
repo.is_locked, repo.is_write_locked)
467
def _get_signatures(self, repo_transport, repo):
468
return SignatureTextStore(repo_transport.clone('revision-store'),
469
False, versionedfile.HashPrefixMapper(),
470
repo.is_locked, repo.is_write_locked)
472
def _get_texts(self, repo_transport, repo):
473
mapper = versionedfile.HashPrefixMapper()
474
base_transport = repo_transport.clone('weaves')
475
return versionedfile.ThunkedVersionedFiles(base_transport,
476
weave.WeaveFile, mapper, repo.is_locked)
479
class RepositoryFormat7(MetaDirRepositoryFormat):
482
This repository format has:
483
- weaves for file texts and inventory
484
- hash subdirectory based stores.
485
- TextStores for revisions and signatures.
486
- a format marker of its own
487
- an optional 'shared-storage' flag
488
- an optional 'no-working-trees' flag
491
_versionedfile_class = weave.WeaveFile
492
supports_ghosts = False
494
def _serializer(self):
495
return xml5.serializer_v5
497
def get_format_string(self):
498
"""See RepositoryFormat.get_format_string()."""
499
return "Bazaar-NG Repository format 7"
501
def get_format_description(self):
502
"""See RepositoryFormat.get_format_description()."""
503
return "Weave repository format 7"
505
def check_conversion_target(self, target_format):
508
def _get_inventories(self, repo_transport, repo, name='inventory'):
509
mapper = versionedfile.ConstantMapper(name)
510
return versionedfile.ThunkedVersionedFiles(repo_transport,
511
weave.WeaveFile, mapper, repo.is_locked)
513
def _get_revisions(self, repo_transport, repo):
514
return RevisionTextStore(repo_transport.clone('revision-store'),
515
xml5.serializer_v5, True, versionedfile.HashPrefixMapper(),
516
repo.is_locked, repo.is_write_locked)
518
def _get_signatures(self, repo_transport, repo):
519
return SignatureTextStore(repo_transport.clone('revision-store'),
520
True, versionedfile.HashPrefixMapper(),
521
repo.is_locked, repo.is_write_locked)
523
def _get_texts(self, repo_transport, repo):
524
mapper = versionedfile.HashPrefixMapper()
525
base_transport = repo_transport.clone('weaves')
526
return versionedfile.ThunkedVersionedFiles(base_transport,
527
weave.WeaveFile, mapper, repo.is_locked)
529
def initialize(self, a_bzrdir, shared=False):
530
"""Create a weave repository.
532
:param shared: If true the repository will be initialized as a shared
535
# Create an empty weave
537
weavefile.write_weave_v5(weave.Weave(), sio)
538
empty_weave = sio.getvalue()
540
mutter('creating repository in %s.', a_bzrdir.transport.base)
541
dirs = ['revision-store', 'weaves']
542
files = [('inventory.weave', StringIO(empty_weave)),
544
utf8_files = [('format', self.get_format_string())]
546
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
547
return self.open(a_bzrdir=a_bzrdir, _found=True)
549
def open(self, a_bzrdir, _found=False, _override_transport=None):
550
"""See RepositoryFormat.open().
552
:param _override_transport: INTERNAL USE ONLY. Allows opening the
553
repository at a slightly different url
554
than normal. I.e. during 'upgrade'.
557
format = RepositoryFormat.find_format(a_bzrdir)
558
if _override_transport is not None:
559
repo_transport = _override_transport
561
repo_transport = a_bzrdir.get_repository_transport(None)
562
control_files = lockable_files.LockableFiles(repo_transport,
563
'lock', lockdir.LockDir)
564
result = WeaveMetaDirRepository(_format=self, a_bzrdir=a_bzrdir,
565
control_files=control_files)
566
result.revisions = self._get_revisions(repo_transport, result)
567
result.signatures = self._get_signatures(repo_transport, result)
568
result.inventories = self._get_inventories(repo_transport, result)
569
result.texts = self._get_texts(repo_transport, result)
570
result._transport = repo_transport
574
class TextVersionedFiles(VersionedFiles):
575
"""Just-a-bunch-of-files based VersionedFile stores."""
577
def __init__(self, transport, compressed, mapper, is_locked, can_write):
578
self._compressed = compressed
579
self._transport = transport
580
self._mapper = mapper
585
self._is_locked = is_locked
586
self._can_write = can_write
588
def add_lines(self, key, parents, lines):
589
"""Add a revision to the store."""
590
if not self._is_locked():
591
raise errors.ObjectNotLocked(self)
592
if not self._can_write():
593
raise errors.ReadOnlyError(self)
595
raise ValueError('bad idea to put / in %r' % (key,))
596
text = ''.join(lines)
598
text = bytes_to_gzip(text)
599
path = self._map(key)
600
self._transport.put_bytes_non_atomic(path, text, create_parent_dir=True)
602
def insert_record_stream(self, stream):
604
for record in stream:
605
# Raise an error when a record is missing.
606
if record.storage_kind == 'absent':
607
raise errors.RevisionNotPresent([record.key[0]], self)
608
# adapt to non-tuple interface
609
if record.storage_kind == 'fulltext':
610
self.add_lines(record.key, None,
611
osutils.split_lines(record.get_bytes_as('fulltext')))
613
adapter_key = record.storage_kind, 'fulltext'
615
adapter = adapters[adapter_key]
617
adapter_factory = adapter_registry.get(adapter_key)
618
adapter = adapter_factory(self)
619
adapters[adapter_key] = adapter
620
lines = osutils.split_lines(adapter.get_bytes(
621
record, record.get_bytes_as(record.storage_kind)))
623
self.add_lines(record.key, None, lines)
624
except RevisionAlreadyPresent:
627
def _load_text(self, key):
628
if not self._is_locked():
629
raise errors.ObjectNotLocked(self)
630
path = self._map(key)
632
text = self._transport.get_bytes(path)
633
compressed = self._compressed
634
except errors.NoSuchFile:
636
# try without the .gz
639
text = self._transport.get_bytes(path)
641
except errors.NoSuchFile:
646
text = GzipFile(mode='rb', fileobj=StringIO(text)).read()
650
return self._mapper.map(key) + self._ext
653
class RevisionTextStore(TextVersionedFiles):
654
"""Legacy thunk for format 4 repositories."""
656
def __init__(self, transport, serializer, compressed, mapper, is_locked,
658
"""Create a RevisionTextStore at transport with serializer."""
659
TextVersionedFiles.__init__(self, transport, compressed, mapper,
660
is_locked, can_write)
661
self._serializer = serializer
663
def _load_text_parents(self, key):
664
text = self._load_text(key)
667
parents = self._serializer.read_revision_from_string(text).parent_ids
668
return text, tuple((parent,) for parent in parents)
670
def get_parent_map(self, keys):
673
parents = self._load_text_parents(key)[1]
676
result[key] = parents
679
def get_record_stream(self, keys, sort_order, include_delta_closure):
681
text, parents = self._load_text_parents(key)
683
yield AbsentContentFactory(key)
685
yield FulltextContentFactory(key, parents, None, text)
688
if not self._is_locked():
689
raise errors.ObjectNotLocked(self)
691
for quoted_relpath in self._transport.iter_files_recursive():
692
relpath = urllib.unquote(quoted_relpath)
693
path, ext = os.path.splitext(relpath)
696
if '.sig' not in relpath:
697
relpaths.add(relpath)
698
paths = list(relpaths)
699
return set([self._mapper.unmap(path) for path in paths])
702
class SignatureTextStore(TextVersionedFiles):
703
"""Legacy thunk for format 4-7 repositories."""
705
def __init__(self, transport, compressed, mapper, is_locked, can_write):
706
TextVersionedFiles.__init__(self, transport, compressed, mapper,
707
is_locked, can_write)
708
self._ext = '.sig' + self._ext
710
def get_parent_map(self, keys):
713
text = self._load_text(key)
719
def get_record_stream(self, keys, sort_order, include_delta_closure):
721
text = self._load_text(key)
723
yield AbsentContentFactory(key)
725
yield FulltextContentFactory(key, None, None, text)
728
if not self._is_locked():
729
raise errors.ObjectNotLocked(self)
731
for quoted_relpath in self._transport.iter_files_recursive():
732
relpath = urllib.unquote(quoted_relpath)
733
path, ext = os.path.splitext(relpath)
736
if not relpath.endswith('.sig'):
738
relpaths.add(relpath[:-4])
739
paths = list(relpaths)
740
return set([self._mapper.unmap(path) for path in paths])
742
_legacy_formats = [RepositoryFormat4(),