1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
from copy import deepcopy
18
from cStringIO import StringIO
19
from unittest import TestSuite
21
import bzrlib.bzrdir as bzrdir
22
from bzrlib.decorators import needs_read_lock, needs_write_lock
23
import bzrlib.errors as errors
24
from bzrlib.errors import InvalidRevisionId
25
import bzrlib.gpg as gpg
26
from bzrlib.graph import Graph
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
33
revision as _mod_revision,
34
testament as _mod_testament,
38
from bzrlib.bundle import serializer
39
from bzrlib.i18n import gettext
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
27
50
from bzrlib.inter import InterObject
28
from bzrlib.knit import KnitVersionedFile, KnitPlainFactory
29
from bzrlib.lockable_files import LockableFiles, TransportLock
30
from bzrlib.lockdir import LockDir
31
from bzrlib.osutils import safe_unicode
32
from bzrlib.revision import NULL_REVISION
33
from bzrlib.store.versioned import VersionedFileStore, WeaveStore
34
from bzrlib.store.text import TextStore
35
from bzrlib.symbol_versioning import *
36
from bzrlib.trace import mutter
37
from bzrlib.tree import RevisionTree
38
from bzrlib.tsort import topo_sort
39
from bzrlib.testament import Testament
40
from bzrlib.tree import EmptyTree
42
from bzrlib.weave import WeaveFile
46
class Repository(object):
51
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
from bzrlib.trace import (
53
log_exception_quietly, note, mutter, mutter_callsite, warning)
56
# Old formats display a warning, but only once
57
_deprecation_warning_done = False
60
class IsInWriteGroupError(errors.InternalBzrError):
62
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
64
def __init__(self, repo):
65
errors.InternalBzrError.__init__(self, repo=repo)
68
class CommitBuilder(object):
69
"""Provides an interface to build up a commit.
71
This allows describing a tree to be committed without needing to
72
know the internals of the format of the repository.
75
# all clients should supply tree roots.
76
record_root_entry = True
77
# whether this commit builder supports the record_entry_contents interface
78
supports_record_entry_contents = False
79
# whether this commit builder will automatically update the branch that is
81
updates_branch = False
83
def __init__(self, repository, parents, config_stack, timestamp=None,
84
timezone=None, committer=None, revprops=None,
85
revision_id=None, lossy=False):
86
"""Initiate a CommitBuilder.
88
:param repository: Repository to commit to.
89
:param parents: Revision ids of the parents of the new revision.
90
:param timestamp: Optional timestamp recorded for commit.
91
:param timezone: Optional timezone for timestamp.
92
:param committer: Optional committer to set for commit.
93
:param revprops: Optional dictionary of revision properties.
94
:param revision_id: Optional revision id.
95
:param lossy: Whether to discard data that can not be natively
96
represented, when pushing to a foreign VCS
98
self._config_stack = config_stack
101
if committer is None:
102
self._committer = self._config_stack.get('email')
103
elif not isinstance(committer, unicode):
104
self._committer = committer.decode() # throw if non-ascii
106
self._committer = committer
108
self._new_revision_id = revision_id
109
self.parents = parents
110
self.repository = repository
113
if revprops is not None:
114
self._validate_revprops(revprops)
115
self._revprops.update(revprops)
117
if timestamp is None:
118
timestamp = time.time()
119
# Restrict resolution to 1ms
120
self._timestamp = round(timestamp, 3)
123
self._timezone = osutils.local_time_offset()
125
self._timezone = int(timezone)
127
self._generate_revision_if_needed()
129
def any_changes(self):
130
"""Return True if any entries were changed.
132
This includes merge-only changes. It is the core for the --unchanged
135
:return: True if any changes have occured.
137
raise NotImplementedError(self.any_changes)
139
def _validate_unicode_text(self, text, context):
140
"""Verify things like commit messages don't have bogus characters."""
142
raise ValueError('Invalid value for %s: %r' % (context, text))
144
def _validate_revprops(self, revprops):
145
for key, value in revprops.iteritems():
146
# We know that the XML serializers do not round trip '\r'
147
# correctly, so refuse to accept them
148
if not isinstance(value, basestring):
149
raise ValueError('revision property (%s) is not a valid'
150
' (unicode) string: %r' % (key, value))
151
self._validate_unicode_text(value,
152
'revision property (%s)' % (key,))
154
def commit(self, message):
155
"""Make the actual commit.
157
:return: The revision id of the recorded revision.
159
raise NotImplementedError(self.commit)
162
"""Abort the commit that is being built.
164
raise NotImplementedError(self.abort)
166
def revision_tree(self):
167
"""Return the tree that was just committed.
169
After calling commit() this can be called to get a
170
RevisionTree representing the newly committed tree. This is
171
preferred to calling Repository.revision_tree() because that may
172
require deserializing the inventory, while we already have a copy in
175
raise NotImplementedError(self.revision_tree)
177
def finish_inventory(self):
178
"""Tell the builder that the inventory is finished.
180
:return: The inventory id in the repository, which can be used with
181
repository.get_inventory.
183
raise NotImplementedError(self.finish_inventory)
185
def _gen_revision_id(self):
186
"""Return new revision-id."""
187
return generate_ids.gen_revision_id(self._committer, self._timestamp)
189
def _generate_revision_if_needed(self):
190
"""Create a revision id if None was supplied.
192
If the repository can not support user-specified revision ids
193
they should override this function and raise CannotSetRevisionId
194
if _new_revision_id is not None.
196
:raises: CannotSetRevisionId
198
if self._new_revision_id is None:
199
self._new_revision_id = self._gen_revision_id()
200
self.random_revid = True
202
self.random_revid = False
204
def will_record_deletes(self):
205
"""Tell the commit builder that deletes are being notified.
207
This enables the accumulation of an inventory delta; for the resulting
208
commit to be valid, deletes against the basis MUST be recorded via
209
builder.record_delete().
211
raise NotImplementedError(self.will_record_deletes)
213
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
214
"""Record a new tree via iter_changes.
216
:param tree: The tree to obtain text contents from for changed objects.
217
:param basis_revision_id: The revision id of the tree the iter_changes
218
has been generated against. Currently assumed to be the same
219
as self.parents[0] - if it is not, errors may occur.
220
:param iter_changes: An iter_changes iterator with the changes to apply
221
to basis_revision_id. The iterator must not include any items with
222
a current kind of None - missing items must be either filtered out
223
or errored-on beefore record_iter_changes sees the item.
224
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
227
raise NotImplementedError(self.record_iter_changes)
230
class RepositoryWriteLockResult(LogicalLockResult):
231
"""The result of write locking a repository.
233
:ivar repository_token: The token obtained from the underlying lock, or
235
:ivar unlock: A callable which will unlock the lock.
238
def __init__(self, unlock, repository_token):
239
LogicalLockResult.__init__(self, unlock)
240
self.repository_token = repository_token
243
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
247
######################################################################
251
class Repository(_RelockDebugMixin, controldir.ControlComponent):
47
252
"""Repository holding history for one or more branches.
49
254
The repository holds and retrieves historical information including
50
255
revisions and file history. It's normally accessed only by the Branch,
51
256
which views a particular line of development through that history.
53
The Repository builds on top of Stores and a Transport, which respectively
54
describe the disk data format and the way of accessing the (possibly
258
See VersionedFileRepository in bzrlib.vf_repository for the
259
base class for most Bazaar repositories.
59
def add_inventory(self, revid, inv, parents):
60
"""Add the inventory inv to the repository as revid.
62
:param parents: The revision ids of the parents that revid
63
is known to have and are in the repository already.
65
returns the sha1 of the serialized inventory.
67
inv_text = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
68
inv_sha1 = bzrlib.osutils.sha_string(inv_text)
69
inv_vf = self.control_weaves.get_weave('inventory',
70
self.get_transaction())
71
inv_vf.add_lines(revid, parents, bzrlib.osutils.split_lines(inv_text))
75
def add_revision(self, rev_id, rev, inv=None, config=None):
76
"""Add rev to the revision store as rev_id.
78
:param rev_id: the revision id to use.
79
:param rev: The revision object.
80
:param inv: The inventory for the revision. if None, it will be looked
81
up in the inventory storer
82
:param config: If None no digital signature will be created.
83
If supplied its signature_needed method will be used
84
to determine if a signature should be made.
86
if config is not None and config.signature_needed():
88
inv = self.get_inventory(rev_id)
89
plaintext = Testament(rev, inv).as_short_text()
90
self.store_revision_signature(
91
gpg.GPGStrategy(config), plaintext, rev_id)
92
if not rev_id in self.get_inventory_weave():
94
raise errors.WeaveRevisionNotPresent(rev_id,
95
self.get_inventory_weave())
97
# yes, this is not suitable for adding with ghosts.
98
self.add_inventory(rev_id, inv, rev.parent_ids)
99
self._revision_store.add_revision(rev, self.get_transaction())
102
def _all_possible_ids(self):
103
"""Return all the possible revisions that we could find."""
104
return self.get_inventory_weave().versions()
262
def abort_write_group(self, suppress_errors=False):
263
"""Commit the contents accrued within the current write group.
265
:param suppress_errors: if true, abort_write_group will catch and log
266
unexpected errors that happen during the abort, rather than
267
allowing them to propagate. Defaults to False.
269
:seealso: start_write_group.
271
if self._write_group is not self.get_transaction():
272
# has an unlock or relock occured ?
275
'(suppressed) mismatched lock context and write group. %r, %r',
276
self._write_group, self.get_transaction())
278
raise errors.BzrError(
279
'mismatched lock context and write group. %r, %r' %
280
(self._write_group, self.get_transaction()))
282
self._abort_write_group()
283
except Exception, exc:
284
self._write_group = None
285
if not suppress_errors:
287
mutter('abort_write_group failed')
288
log_exception_quietly()
289
note(gettext('bzr: ERROR (ignored): %s'), exc)
290
self._write_group = None
292
def _abort_write_group(self):
293
"""Template method for per-repository write group cleanup.
295
This is called during abort before the write group is considered to be
296
finished and should cleanup any internal state accrued during the write
297
group. There is no requirement that data handed to the repository be
298
*not* made available - this is not a rollback - but neither should any
299
attempt be made to ensure that data added is fully commited. Abort is
300
invoked when an error has occured so futher disk or network operations
301
may not be possible or may error and if possible should not be
305
def add_fallback_repository(self, repository):
306
"""Add a repository to use for looking up data not held locally.
308
:param repository: A repository.
310
raise NotImplementedError(self.add_fallback_repository)
312
def _check_fallback_repository(self, repository):
313
"""Check that this repository can fallback to repository safely.
315
Raise an error if not.
317
:param repository: A repository to fallback to.
319
return InterRepository._assert_same_model(self, repository)
107
321
def all_revision_ids(self):
108
"""Returns a list of all the revision ids in the repository.
110
These are in as much topological order as the underlying store can
111
present: for weaves ghosts may lead to a lack of correctness until
112
the reweave updates the parents list.
114
if self._revision_store.text_store.listable():
115
return self._revision_store.all_revision_ids(self.get_transaction())
116
result = self._all_possible_ids()
117
return self._eliminate_revisions_not_present(result)
120
def _eliminate_revisions_not_present(self, revision_ids):
121
"""Check every revision id in revision_ids to see if we have it.
123
Returns a set of the present revisions.
126
for id in revision_ids:
127
if self.has_revision(id):
322
"""Returns a list of all the revision ids in the repository.
324
This is conceptually deprecated because code should generally work on
325
the graph reachable from a particular revision, and ignore any other
326
revisions that might be present. There is no direct replacement
329
if 'evil' in debug.debug_flags:
330
mutter_callsite(2, "all_revision_ids is linear with history.")
331
return self._all_revision_ids()
333
def _all_revision_ids(self):
334
"""Returns a list of all the revision ids in the repository.
336
These are in as much topological order as the underlying store can
339
raise NotImplementedError(self._all_revision_ids)
341
def break_lock(self):
342
"""Break a lock if one is present from another instance.
344
Uses the ui factory to ask for confirmation if the lock may be from
347
self.control_files.break_lock()
132
def create(a_bzrdir):
133
"""Construct the current default format repository in a_bzrdir."""
134
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
350
def create(controldir):
351
"""Construct the current default format repository in controldir."""
352
return RepositoryFormat.get_default_format().initialize(controldir)
136
def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
354
def __init__(self, _format, controldir, control_files):
137
355
"""instantiate a Repository.
139
357
:param _format: The format of the repository on disk.
140
:param a_bzrdir: The BzrDir of the repository.
142
In the future we will have a single api for all stores for
143
getting file texts, inventories and revisions, then
144
this construct will accept instances of those things.
358
:param controldir: The ControlDir of the repository.
359
:param control_files: Control files to use for locking, etc.
146
object.__init__(self)
361
# In the future we will have a single api for all stores for
362
# getting file texts, inventories and revisions, then
363
# this construct will accept instances of those things.
364
super(Repository, self).__init__()
147
365
self._format = _format
148
366
# the following are part of the public API for Repository:
149
self.bzrdir = a_bzrdir
367
self.bzrdir = controldir
150
368
self.control_files = control_files
151
self._revision_store = _revision_store
152
self.text_store = text_store
153
# backwards compatability
154
self.weave_store = text_store
155
# not right yet - should be more semantically clear ?
157
self.control_store = control_store
158
self.control_weaves = control_store
160
def lock_write(self):
161
self.control_files.lock_write()
164
self.control_files.lock_read()
370
self._write_group = None
371
# Additional places to query for data.
372
self._fallback_repositories = []
375
def user_transport(self):
376
return self.bzrdir.user_transport
379
def control_transport(self):
380
return self._transport
383
if self._fallback_repositories:
384
return '%s(%r, fallback_repositories=%r)' % (
385
self.__class__.__name__,
387
self._fallback_repositories)
389
return '%s(%r)' % (self.__class__.__name__,
392
def _has_same_fallbacks(self, other_repo):
393
"""Returns true if the repositories have the same fallbacks."""
394
my_fb = self._fallback_repositories
395
other_fb = other_repo._fallback_repositories
396
if len(my_fb) != len(other_fb):
398
for f, g in zip(my_fb, other_fb):
399
if not f.has_same_location(g):
403
def has_same_location(self, other):
404
"""Returns a boolean indicating if this repository is at the same
405
location as another repository.
407
This might return False even when two repository objects are accessing
408
the same physical repository via different URLs.
410
if self.__class__ is not other.__class__:
412
return (self.control_url == other.control_url)
414
def is_in_write_group(self):
415
"""Return True if there is an open write group.
417
:seealso: start_write_group.
419
return self._write_group is not None
166
421
def is_locked(self):
167
422
return self.control_files.is_locked()
170
def missing_revision_ids(self, other, revision_id=None):
424
def is_write_locked(self):
425
"""Return True if this object is write locked."""
426
return self.is_locked() and self.control_files._lock_mode == 'w'
428
def lock_write(self, token=None):
429
"""Lock this repository for writing.
431
This causes caching within the repository obejct to start accumlating
432
data during reads, and allows a 'write_group' to be obtained. Write
433
groups must be used for actual data insertion.
435
A token should be passed in if you know that you have locked the object
436
some other way, and need to synchronise this object's state with that
439
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
441
:param token: if this is already locked, then lock_write will fail
442
unless the token matches the existing lock.
443
:returns: a token if this instance supports tokens, otherwise None.
444
:raises TokenLockingNotSupported: when a token is given but this
445
instance doesn't support using token locks.
446
:raises MismatchedToken: if the specified token doesn't match the token
447
of the existing lock.
448
:seealso: start_write_group.
449
:return: A RepositoryWriteLockResult.
451
locked = self.is_locked()
452
token = self.control_files.lock_write(token=token)
454
self._warn_if_deprecated()
456
for repo in self._fallback_repositories:
457
# Writes don't affect fallback repos
460
return RepositoryWriteLockResult(self.unlock, token)
463
"""Lock the repository for read operations.
465
:return: An object with an unlock method which will release the lock
468
locked = self.is_locked()
469
self.control_files.lock_read()
471
self._warn_if_deprecated()
473
for repo in self._fallback_repositories:
476
return LogicalLockResult(self.unlock)
478
def get_physical_lock_status(self):
479
return self.control_files.get_physical_lock_status()
481
def leave_lock_in_place(self):
482
"""Tell this repository not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this repository to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
498
def gather_stats(self, revid=None, committers=None):
499
"""Gather statistics from a revision id.
501
:param revid: The revision id to gather statistics from, if None, then
502
no revision specific statistics are gathered.
503
:param committers: Optional parameter controlling whether to grab
504
a count of committers from the revision specific statistics.
505
:return: A dictionary of statistics. Currently this contains:
506
committers: The number of committers if requested.
507
firstrev: A tuple with timestamp, timezone for the penultimate left
508
most ancestor of revid, if revid is not the NULL_REVISION.
509
latestrev: A tuple with timestamp, timezone for revid, if revid is
510
not the NULL_REVISION.
511
revisions: The total revision count in the repository.
512
size: An estimate disk size of the repository in bytes.
515
if revid and committers:
516
result['committers'] = 0
517
if revid and revid != _mod_revision.NULL_REVISION:
518
graph = self.get_graph()
520
all_committers = set()
521
revisions = [r for (r, p) in graph.iter_ancestry([revid])
522
if r != _mod_revision.NULL_REVISION]
525
# ignore the revisions in the middle - just grab first and last
526
revisions = revisions[0], revisions[-1]
527
for revision in self.get_revisions(revisions):
528
if not last_revision:
529
last_revision = revision
531
all_committers.add(revision.committer)
532
first_revision = revision
534
result['committers'] = len(all_committers)
535
result['firstrev'] = (first_revision.timestamp,
536
first_revision.timezone)
537
result['latestrev'] = (last_revision.timestamp,
538
last_revision.timezone)
541
def find_branches(self, using=False):
542
"""Find branches underneath this repository.
544
This will include branches inside other branches.
546
:param using: If True, list only branches using this repository.
548
if using and not self.is_shared():
549
return self.bzrdir.list_branches()
550
class Evaluator(object):
553
self.first_call = True
555
def __call__(self, controldir):
556
# On the first call, the parameter is always the controldir
557
# containing the current repo.
558
if not self.first_call:
560
repository = controldir.open_repository()
561
except errors.NoRepositoryPresent:
564
return False, ([], repository)
565
self.first_call = False
566
value = (controldir.list_branches(), None)
570
for branches, repository in controldir.ControlDir.find_bzrdirs(
571
self.user_transport, evaluate=Evaluator()):
572
if branches is not None:
574
if not using and repository is not None:
575
ret.extend(repository.find_branches())
579
def search_missing_revision_ids(self, other,
580
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
581
find_ghosts=True, revision_ids=None, if_present_ids=None,
171
583
"""Return the revision ids that other has that this does not.
173
585
These are returned in topological order.
175
587
revision_id: only return revision ids included by revision_id.
177
return InterRepository.get(other, self).missing_revision_ids(revision_id)
589
if symbol_versioning.deprecated_passed(revision_id):
590
symbol_versioning.warn(
591
'search_missing_revision_ids(revision_id=...) was '
592
'deprecated in 2.4. Use revision_ids=[...] instead.',
593
DeprecationWarning, stacklevel=3)
594
if revision_ids is not None:
595
raise AssertionError(
596
'revision_ids is mutually exclusive with revision_id')
597
if revision_id is not None:
598
revision_ids = [revision_id]
599
return InterRepository.get(other, self).search_missing_revision_ids(
600
find_ghosts=find_ghosts, revision_ids=revision_ids,
601
if_present_ids=if_present_ids, limit=limit)
183
607
For instance, if the repository is at URL/.bzr/repository,
184
608
Repository.open(URL) -> a Repository instance.
186
control = bzrlib.bzrdir.BzrDir.open(base)
610
control = controldir.ControlDir.open(base)
187
611
return control.open_repository()
189
def copy_content_into(self, destination, revision_id=None, basis=None):
613
def copy_content_into(self, destination, revision_id=None):
190
614
"""Make a complete copy of the content in self into destination.
616
This is a destructive operation! Do not use it on existing
619
return InterRepository.get(self, destination).copy_content(revision_id)
621
def commit_write_group(self):
622
"""Commit the contents accrued within the current write group.
624
:seealso: start_write_group.
192
This is a destructive operation! Do not use it on existing
195
return InterRepository.get(self, destination).copy_content(revision_id, basis)
197
def fetch(self, source, revision_id=None, pb=None):
626
:return: it may return an opaque hint that can be passed to 'pack'.
628
if self._write_group is not self.get_transaction():
629
# has an unlock or relock occured ?
630
raise errors.BzrError('mismatched lock context %r and '
632
(self.get_transaction(), self._write_group))
633
result = self._commit_write_group()
634
self._write_group = None
637
def _commit_write_group(self):
638
"""Template method for per-repository write group cleanup.
640
This is called before the write group is considered to be
641
finished and should ensure that all data handed to the repository
642
for writing during the write group is safely committed (to the
643
extent possible considering file system caching etc).
646
def suspend_write_group(self):
647
"""Suspend a write group.
649
:raise UnsuspendableWriteGroup: If the write group can not be
651
:return: List of tokens
653
raise errors.UnsuspendableWriteGroup(self)
655
def refresh_data(self):
656
"""Re-read any data needed to synchronise with disk.
658
This method is intended to be called after another repository instance
659
(such as one used by a smart server) has inserted data into the
660
repository. On all repositories this will work outside of write groups.
661
Some repository formats (pack and newer for bzrlib native formats)
662
support refresh_data inside write groups. If called inside a write
663
group on a repository that does not support refreshing in a write group
664
IsInWriteGroupError will be raised.
668
def resume_write_group(self, tokens):
669
if not self.is_write_locked():
670
raise errors.NotWriteLocked(self)
671
if self._write_group:
672
raise errors.BzrError('already in a write group')
673
self._resume_write_group(tokens)
674
# so we can detect unlock/relock - the write group is now entered.
675
self._write_group = self.get_transaction()
677
def _resume_write_group(self, tokens):
678
raise errors.UnsuspendableWriteGroup(self)
680
def fetch(self, source, revision_id=None, find_ghosts=False):
198
681
"""Fetch the content required to construct revision_id from source.
200
If revision_id is None all content is copied.
202
return InterRepository.get(source, self).fetch(revision_id=revision_id,
683
If revision_id is None, then all content is copied.
685
fetch() may not be used when the repository is in a write group -
686
either finish the current write group before using fetch, or use
687
fetch before starting the write group.
689
:param find_ghosts: Find and copy revisions in the source that are
690
ghosts in the target (and not reachable directly by walking out to
691
the first-present revision in target from revision_id).
692
:param revision_id: If specified, all the content needed for this
693
revision ID will be copied to the target. Fetch will determine for
694
itself which content needs to be copied.
696
if self.is_in_write_group():
697
raise errors.InternalBzrError(
698
"May not fetch while in a write group.")
699
# fast path same-url fetch operations
700
# TODO: lift out to somewhere common with RemoteRepository
701
# <https://bugs.launchpad.net/bzr/+bug/401646>
702
if (self.has_same_location(source)
703
and self._has_same_fallbacks(source)):
704
# check that last_revision is in 'from' and then return a
706
if (revision_id is not None and
707
not _mod_revision.is_null(revision_id)):
708
self.get_revision(revision_id)
710
inter = InterRepository.get(source, self)
711
return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
713
def create_bundle(self, target, base, fileobj, format=None):
714
return serializer.write_bundle(self, target, base, fileobj, format)
716
def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
717
timezone=None, committer=None, revprops=None,
718
revision_id=None, lossy=False):
719
"""Obtain a CommitBuilder for this repository.
721
:param branch: Branch to commit to.
722
:param parents: Revision ids of the parents of the new revision.
723
:param config_stack: Configuration stack to use.
724
:param timestamp: Optional timestamp recorded for commit.
725
:param timezone: Optional timezone for timestamp.
726
:param committer: Optional committer to set for commit.
727
:param revprops: Optional dictionary of revision properties.
728
:param revision_id: Optional revision id.
729
:param lossy: Whether to discard data that can not be natively
730
represented, when pushing to a foreign VCS
732
raise NotImplementedError(self.get_commit_builder)
734
@only_raises(errors.LockNotHeld, errors.LockBroken)
205
735
def unlock(self):
736
if (self.control_files._lock_count == 1 and
737
self.control_files._lock_mode == 'w'):
738
if self._write_group is not None:
739
self.abort_write_group()
740
self.control_files.unlock()
741
raise errors.BzrError(
742
'Must end write groups before releasing write locks.')
206
743
self.control_files.unlock()
744
if self.control_files._lock_count == 0:
745
for repo in self._fallback_repositories:
209
def clone(self, a_bzrdir, revision_id=None, basis=None):
210
"""Clone this repository into a_bzrdir using the current format.
749
def clone(self, controldir, revision_id=None):
750
"""Clone this repository into controldir using the current format.
212
752
Currently no check is made that the format of this repository and
213
753
the bzrdir format are compatible. FIXME RBC 20060201.
755
:return: The newly created destination repository.
757
# TODO: deprecate after 0.16; cloning this with all its settings is
758
# probably not very useful -- mbp 20070423
759
dest_repo = self._create_sprouting_repo(
760
controldir, shared=self.is_shared())
761
self.copy_content_into(dest_repo, revision_id)
764
def start_write_group(self):
765
"""Start a write group in the repository.
767
Write groups are used by repositories which do not have a 1:1 mapping
768
between file ids and backend store to manage the insertion of data from
769
both fetch and commit operations.
771
A write lock is required around the start_write_group/commit_write_group
772
for the support of lock-requiring repository formats.
774
One can only insert data into a repository inside a write group.
778
if not self.is_write_locked():
779
raise errors.NotWriteLocked(self)
780
if self._write_group:
781
raise errors.BzrError('already in a write group')
782
self._start_write_group()
783
# so we can detect unlock/relock - the write group is now entered.
784
self._write_group = self.get_transaction()
786
def _start_write_group(self):
787
"""Template method for per-repository write group startup.
789
This is called before the write group is considered to be
794
def sprout(self, to_bzrdir, revision_id=None):
795
"""Create a descendent repository for new development.
797
Unlike clone, this does not copy the settings of the repository.
799
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
800
dest_repo.fetch(self, revision_id=revision_id)
803
def _create_sprouting_repo(self, a_bzrdir, shared):
215
804
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
216
805
# use target default format.
217
result = a_bzrdir.create_repository()
218
# FIXME RBC 20060209 split out the repository type to avoid this check ?
219
elif isinstance(a_bzrdir._format,
220
(bzrlib.bzrdir.BzrDirFormat4,
221
bzrlib.bzrdir.BzrDirFormat5,
222
bzrlib.bzrdir.BzrDirFormat6)):
223
result = a_bzrdir.open_repository()
806
dest_repo = a_bzrdir.create_repository()
225
result = self._format.initialize(a_bzrdir, shared=self.is_shared())
226
self.copy_content_into(result, revision_id, basis)
808
# Most control formats need the repository to be specifically
809
# created, but on some old all-in-one formats it's not needed
811
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
812
except errors.UninitializableFormat:
813
dest_repo = a_bzrdir.open_repository()
230
817
def has_revision(self, revision_id):
231
818
"""True if this repository has a copy of the revision."""
232
return self._revision_store.has_revision_id(revision_id,
233
self.get_transaction())
819
return revision_id in self.has_revisions((revision_id,))
822
def has_revisions(self, revision_ids):
823
"""Probe to find out the presence of multiple revisions.
825
:param revision_ids: An iterable of revision_ids.
826
:return: A set of the revision_ids that were present.
828
raise NotImplementedError(self.has_revisions)
831
def get_revision(self, revision_id):
832
"""Return the Revision object for a named revision."""
833
return self.get_revisions([revision_id])[0]
236
835
def get_revision_reconcile(self, revision_id):
237
836
"""'reconcile' helper routine that allows access to a revision always.
239
838
This variant of get_revision does not cross check the weave graph
240
839
against the revision one as get_revision does: but it should only
241
840
be used by reconcile, or reconcile-alike commands that are correcting
242
841
or testing the revision graph.
244
if not revision_id or not isinstance(revision_id, basestring):
245
raise InvalidRevisionId(revision_id=revision_id, branch=self)
246
return self._revision_store.get_revision(revision_id,
247
self.get_transaction())
250
def get_revision_xml(self, revision_id):
251
rev = self.get_revision(revision_id)
253
# the current serializer..
254
self._revision_store._serializer.write_revision(rev, rev_tmp)
256
return rev_tmp.getvalue()
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
r = self.get_revision_reconcile(revision_id)
262
# weave corruption can lead to absent revision markers that should be
264
# the following test is reasonably cheap (it needs a single weave read)
265
# and the weave is cached in read transactions. In write transactions
266
# it is not cached but typically we only read a small number of
267
# revisions. For knits when they are introduced we will probably want
268
# to ensure that caching write transactions are in use.
269
inv = self.get_inventory_weave()
270
self._check_revision_parents(r, inv)
273
def _check_revision_parents(self, revision, inventory):
274
"""Private to Repository and Fetch.
843
raise NotImplementedError(self.get_revision_reconcile)
845
def get_revisions(self, revision_ids):
846
"""Get many revisions at once.
276
This checks the parentage of revision in an inventory weave for
277
consistency and is only applicable to inventory-weave-for-ancestry
278
using repository formats & fetchers.
280
weave_parents = inventory.get_parents(revision.revision_id)
281
weave_names = inventory.versions()
282
for parent_id in revision.parent_ids:
283
if parent_id in weave_names:
284
# this parent must not be a ghost.
285
if not parent_id in weave_parents:
287
raise errors.CorruptRepository(self)
848
Repositories that need to check data on every revision read should
849
subclass this method.
851
raise NotImplementedError(self.get_revisions)
853
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
854
"""Produce a generator of revision deltas.
856
Note that the input is a sequence of REVISIONS, not revision_ids.
857
Trees will be held in memory until the generator exits.
858
Each delta is relative to the revision's lefthand predecessor.
860
:param specific_fileids: if not None, the result is filtered
861
so that only those file-ids, their parents and their
862
children are included.
864
# Get the revision-ids of interest
865
required_trees = set()
866
for revision in revisions:
867
required_trees.add(revision.revision_id)
868
required_trees.update(revision.parent_ids[:1])
870
# Get the matching filtered trees. Note that it's more
871
# efficient to pass filtered trees to changes_from() rather
872
# than doing the filtering afterwards. changes_from() could
873
# arguably do the filtering itself but it's path-based, not
874
# file-id based, so filtering before or afterwards is
876
if specific_fileids is None:
877
trees = dict((t.get_revision_id(), t) for
878
t in self.revision_trees(required_trees))
880
trees = dict((t.get_revision_id(), t) for
881
t in self._filtered_revision_trees(required_trees,
884
# Calculate the deltas
885
for revision in revisions:
886
if not revision.parent_ids:
887
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
889
old_tree = trees[revision.parent_ids[0]]
890
yield trees[revision.revision_id].changes_from(old_tree)
893
def get_revision_delta(self, revision_id, specific_fileids=None):
894
"""Return the delta for one revision.
896
The delta is relative to the left-hand predecessor of the
899
:param specific_fileids: if not None, the result is filtered
900
so that only those file-ids, their parents and their
901
children are included.
903
r = self.get_revision(revision_id)
904
return list(self.get_deltas_for_revisions([r],
905
specific_fileids=specific_fileids))[0]
289
907
@needs_write_lock
290
908
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
291
909
signature = gpg_strategy.sign(plaintext)
292
self._revision_store.add_revision_signature_text(revision_id,
294
self.get_transaction())
296
def fileid_involved_between_revs(self, from_revid, to_revid):
297
"""Find file_id(s) which are involved in the changes between revisions.
299
This determines the set of revisions which are involved, and then
300
finds all file ids affected by those revisions.
302
w = self.get_inventory_weave()
303
from_set = set(w.get_ancestry(from_revid))
304
to_set = set(w.get_ancestry(to_revid))
305
changed = to_set.difference(from_set)
306
return self._fileid_involved_by_set(changed)
308
def fileid_involved(self, last_revid=None):
309
"""Find all file_ids modified in the ancestry of last_revid.
311
:param last_revid: If None, last_revision() will be used.
313
w = self.get_inventory_weave()
315
changed = set(w.versions())
317
changed = set(w.get_ancestry(last_revid))
318
return self._fileid_involved_by_set(changed)
320
def fileid_involved_by_set(self, changes):
321
"""Find all file_ids modified by the set of revisions passed in.
323
:param changes: A set() of revision ids
325
# TODO: jam 20060119 This line does *nothing*, remove it.
326
# or better yet, change _fileid_involved_by_set so
327
# that it takes the inventory weave, rather than
328
# pulling it out by itself.
329
return self._fileid_involved_by_set(changes)
331
def _fileid_involved_by_set(self, changes):
332
"""Find the set of file-ids affected by the set of revisions.
334
:param changes: A set() of revision ids.
335
:return: A set() of file ids.
337
This peaks at the Weave, interpreting each line, looking to
338
see if it mentions one of the revisions. And if so, includes
339
the file id mentioned.
340
This expects both the Weave format, and the serialization
341
to have a single line per file/directory, and to have
342
fileid="" and revision="" on that line.
344
assert isinstance(self._format, (RepositoryFormat5,
347
RepositoryFormatKnit1)), \
348
"fileid_involved only supported for branches which store inventory as unnested xml"
350
w = self.get_inventory_weave()
353
# this code needs to read every line in every inventory for the
354
# inventories [changes]. Seeing a line twice is ok. Seeing a line
355
# not pesent in one of those inventories is unnecessary and not
356
# harmful because we are filtering by the revision id marker in the
357
# inventory lines to only select file ids altered in one of those
358
# revisions. We dont need to see all lines in the inventory because
359
# only those added in an inventory in rev X can contain a revision=X
361
for line in w.iter_lines_added_or_present_in_versions(changes):
362
start = line.find('file_id="')+9
363
if start < 9: continue
364
end = line.find('"', start)
366
file_id = _unescape_xml(line[start:end])
368
# check if file_id is already present
369
if file_id in file_ids: continue
371
start = line.find('revision="')+10
372
if start < 10: continue
373
end = line.find('"', start)
375
revision_id = _unescape_xml(line[start:end])
376
if revision_id in changes:
377
file_ids.add(file_id)
381
def get_inventory_weave(self):
382
return self.control_weaves.get_weave('inventory',
383
self.get_transaction())
386
def get_inventory(self, revision_id):
387
"""Get Inventory object by hash."""
388
xml = self.get_inventory_xml(revision_id)
389
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
392
def get_inventory_xml(self, revision_id):
393
"""Get inventory XML as a file object."""
910
self.add_signature_text(revision_id, signature)
912
def add_signature_text(self, revision_id, signature):
913
"""Store a signature text for a revision.
915
:param revision_id: Revision id of the revision
916
:param signature: Signature text.
918
raise NotImplementedError(self.add_signature_text)
920
def _find_parent_ids_of_revisions(self, revision_ids):
921
"""Find all parent ids that are mentioned in the revision graph.
923
:return: set of revisions that are parents of revision_ids which are
924
not part of revision_ids themselves
926
parent_map = self.get_parent_map(revision_ids)
928
map(parent_ids.update, parent_map.itervalues())
929
parent_ids.difference_update(revision_ids)
930
parent_ids.discard(_mod_revision.NULL_REVISION)
933
def iter_files_bytes(self, desired_files):
934
"""Iterate through file versions.
936
Files will not necessarily be returned in the order they occur in
937
desired_files. No specific order is guaranteed.
939
Yields pairs of identifier, bytes_iterator. identifier is an opaque
940
value supplied by the caller as part of desired_files. It should
941
uniquely identify the file version in the caller's context. (Examples:
942
an index number or a TreeTransform trans_id.)
944
:param desired_files: a list of (file_id, revision_id, identifier)
947
raise NotImplementedError(self.iter_files_bytes)
949
def get_rev_id_for_revno(self, revno, known_pair):
950
"""Return the revision id of a revno, given a later (revno, revid)
951
pair in the same history.
953
:return: if found (True, revid). If the available history ran out
954
before reaching the revno, then this returns
955
(False, (closest_revno, closest_revid)).
957
known_revno, known_revid = known_pair
958
partial_history = [known_revid]
959
distance_from_known = known_revno - revno
960
if distance_from_known < 0:
962
'requested revno (%d) is later than given known revno (%d)'
963
% (revno, known_revno))
395
assert isinstance(revision_id, basestring), type(revision_id)
396
iw = self.get_inventory_weave()
397
return iw.get_text(revision_id)
399
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
402
def get_inventory_sha1(self, revision_id):
403
"""Return the sha1 hash of the inventory entry
405
return self.get_revision(revision_id).inventory_sha1
408
def get_revision_graph(self, revision_id=None):
409
"""Return a dictionary containing the revision graph.
411
:return: a dictionary of revision_id->revision_parents_list.
413
weave = self.get_inventory_weave()
414
all_revisions = self._eliminate_revisions_not_present(weave.versions())
415
entire_graph = dict([(node, weave.get_parents(node)) for
416
node in all_revisions])
417
if revision_id is None:
419
elif revision_id not in entire_graph:
420
raise errors.NoSuchRevision(self, revision_id)
422
# add what can be reached from revision_id
424
pending = set([revision_id])
425
while len(pending) > 0:
427
result[node] = entire_graph[node]
428
for revision_id in result[node]:
429
if revision_id not in result:
430
pending.add(revision_id)
434
def get_revision_graph_with_ghosts(self, revision_ids=None):
435
"""Return a graph of the revisions with ghosts marked as applicable.
437
:param revision_ids: an iterable of revisions to graph or None for all.
438
:return: a Graph object with the graph reachable from revision_ids.
442
pending = set(self.all_revision_ids())
445
pending = set(revision_ids)
446
required = set(revision_ids)
449
revision_id = pending.pop()
451
rev = self.get_revision(revision_id)
452
except errors.NoSuchRevision:
453
if revision_id in required:
456
result.add_ghost(revision_id)
458
for parent_id in rev.parent_ids:
459
# is this queued or done ?
460
if (parent_id not in pending and
461
parent_id not in done):
463
pending.add(parent_id)
464
result.add_node(revision_id, rev.parent_ids)
465
done.add(revision_id)
469
def get_revision_inventory(self, revision_id):
470
"""Return inventory of a past revision."""
471
# TODO: Unify this with get_inventory()
472
# bzr 0.0.6 and later imposes the constraint that the inventory_id
473
# must be the same as its revision, so this is trivial.
474
if revision_id is None:
475
# This does not make sense: if there is no revision,
476
# then it is the current tree inventory surely ?!
477
# and thus get_root_id() is something that looks at the last
478
# commit on the branch, and the get_root_id is an inventory check.
479
raise NotImplementedError
480
# return Inventory(self.get_root_id())
482
return self.get_inventory(revision_id)
966
self, partial_history, stop_index=distance_from_known)
967
except errors.RevisionNotPresent, err:
968
if err.revision_id == known_revid:
969
# The start revision (known_revid) wasn't found.
971
# This is a stacked repository with no fallbacks, or a there's a
972
# left-hand ghost. Either way, even though the revision named in
973
# the error isn't in this repo, we know it's the next step in this
975
partial_history.append(err.revision_id)
976
if len(partial_history) <= distance_from_known:
977
# Didn't find enough history to get a revid for the revno.
978
earliest_revno = known_revno - len(partial_history) + 1
979
return (False, (earliest_revno, partial_history[-1]))
980
if len(partial_history) - 1 > distance_from_known:
981
raise AssertionError('_iter_for_revno returned too much history')
982
return (True, partial_history[-1])
485
984
def is_shared(self):
486
985
"""Return True if this repository is flagged as a shared repository."""
487
986
raise NotImplementedError(self.is_shared)
489
988
@needs_write_lock
989
def reconcile(self, other=None, thorough=False):
491
990
"""Reconcile this repository."""
492
991
from bzrlib.reconcile import RepoReconciler
493
reconciler = RepoReconciler(self)
992
reconciler = RepoReconciler(self, thorough=thorough)
494
993
reconciler.reconcile()
495
994
return reconciler
996
def _refresh_data(self):
997
"""Helper called from lock_* to ensure coherency with disk.
999
The default implementation does nothing; it is however possible
1000
for repositories to maintain loaded indices across multiple locks
1001
by checking inside their implementation of this method to see
1002
whether their indices are still valid. This depends of course on
1003
the disk format being validatable in this manner. This method is
1004
also called by the refresh_data() public interface to cause a refresh
1005
to occur while in a write lock so that data inserted by a smart server
1006
push operation is visible on the client's instance of the physical
497
1010
@needs_read_lock
498
1011
def revision_tree(self, revision_id):
499
1012
"""Return Tree for a revision on this branch.
501
`revision_id` may be None for the null revision, in which case
502
an `EmptyTree` is returned."""
503
# TODO: refactor this to use an existing revision object
504
# so we don't need to read it in twice.
505
if revision_id is None or revision_id == NULL_REVISION:
508
inv = self.get_revision_inventory(revision_id)
509
return RevisionTree(self, inv, revision_id)
512
def get_ancestry(self, revision_id):
513
"""Return a list of revision-ids integrated by a revision.
515
This is topologically sorted.
517
if revision_id is None:
519
if not self.has_revision(revision_id):
520
raise errors.NoSuchRevision(self, revision_id)
521
w = self.get_inventory_weave()
522
candidates = w.get_ancestry(revision_id)
523
return [None] + candidates # self._eliminate_revisions_not_present(candidates)
526
def print_file(self, file, revision_id):
527
"""Print `file` to stdout.
529
FIXME RBC 20060125 as John Meinel points out this is a bad api
530
- it writes to stdout, it assumes that that is valid etc. Fix
531
by creating a new more flexible convenience function.
533
tree = self.revision_tree(revision_id)
534
# use inventory as it was in that revision
535
file_id = tree.inventory.path2id(file)
537
raise BzrError("%r is not present in revision %s" % (file, revno))
539
revno = self.revision_id_to_revno(revision_id)
540
except errors.NoSuchRevision:
541
# TODO: This should not be BzrError,
542
# but NoSuchFile doesn't fit either
543
raise BzrError('%r is not present in revision %s'
544
% (file, revision_id))
546
raise BzrError('%r is not present in revision %s'
548
tree.print_file(file_id)
1014
`revision_id` may be NULL_REVISION for the empty tree revision.
1016
raise NotImplementedError(self.revision_tree)
1018
def revision_trees(self, revision_ids):
1019
"""Return Trees for revisions in this repository.
1021
:param revision_ids: a sequence of revision-ids;
1022
a revision-id may not be None or 'null:'
1024
raise NotImplementedError(self.revision_trees)
1026
def pack(self, hint=None, clean_obsolete_packs=False):
1027
"""Compress the data within the repository.
1029
This operation only makes sense for some repository types. For other
1030
types it should be a no-op that just returns.
1032
This stub method does not require a lock, but subclasses should use
1033
@needs_write_lock as this is a long running call it's reasonable to
1034
implicitly lock for the user.
1036
:param hint: If not supplied, the whole repository is packed.
1037
If supplied, the repository may use the hint parameter as a
1038
hint for the parts of the repository to pack. A hint can be
1039
obtained from the result of commit_write_group(). Out of
1040
date hints are simply ignored, because concurrent operations
1041
can obsolete them rapidly.
1043
:param clean_obsolete_packs: Clean obsolete packs immediately after
550
1047
def get_transaction(self):
551
1048
return self.control_files.get_transaction()
553
def revision_parents(self, revid):
554
return self.get_inventory_weave().parent_names(revid)
1050
def get_parent_map(self, revision_ids):
1051
"""See graph.StackedParentsProvider.get_parent_map"""
1052
raise NotImplementedError(self.get_parent_map)
1054
def _get_parent_map_no_fallbacks(self, revision_ids):
1055
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1056
# revisions index works in keys; this just works in revisions
1057
# therefore wrap and unwrap
1060
for revision_id in revision_ids:
1061
if revision_id == _mod_revision.NULL_REVISION:
1062
result[revision_id] = ()
1063
elif revision_id is None:
1064
raise ValueError('get_parent_map(None) is not valid')
1066
query_keys.append((revision_id ,))
1067
vf = self.revisions.without_fallbacks()
1068
for ((revision_id,), parent_keys) in \
1069
vf.get_parent_map(query_keys).iteritems():
1071
result[revision_id] = tuple([parent_revid
1072
for (parent_revid,) in parent_keys])
1074
result[revision_id] = (_mod_revision.NULL_REVISION,)
1077
def _make_parents_provider(self):
1078
if not self._format.supports_external_lookups:
1080
return graph.StackedParentsProvider(_LazyListJoin(
1081
[self._make_parents_provider_unstacked()],
1082
self._fallback_repositories))
1084
def _make_parents_provider_unstacked(self):
1085
return graph.CallableToParentsProviderAdapter(
1086
self._get_parent_map_no_fallbacks)
1089
def get_known_graph_ancestry(self, revision_ids):
1090
"""Return the known graph for a set of revision ids and their ancestors.
1092
raise NotImplementedError(self.get_known_graph_ancestry)
1094
def get_file_graph(self):
1095
"""Return the graph walker for files."""
1096
raise NotImplementedError(self.get_file_graph)
1098
def get_graph(self, other_repository=None):
1099
"""Return the graph walker for this repository format"""
1100
parents_provider = self._make_parents_provider()
1101
if (other_repository is not None and
1102
not self.has_same_location(other_repository)):
1103
parents_provider = graph.StackedParentsProvider(
1104
[parents_provider, other_repository._make_parents_provider()])
1105
return graph.Graph(parents_provider)
556
1107
@needs_write_lock
557
1108
def set_make_working_trees(self, new_value):
566
1117
raise NotImplementedError(self.set_make_working_trees)
568
1119
def make_working_trees(self):
569
1120
"""Returns the policy for making working trees on new branches."""
570
1121
raise NotImplementedError(self.make_working_trees)
572
1123
@needs_write_lock
573
1124
def sign_revision(self, revision_id, gpg_strategy):
574
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1125
testament = _mod_testament.Testament.from_revision(self, revision_id)
1126
plaintext = testament.as_short_text()
575
1127
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
577
1129
@needs_read_lock
1130
def verify_revision_signature(self, revision_id, gpg_strategy):
1131
"""Verify the signature on a revision.
1133
:param revision_id: the revision to verify
1134
:gpg_strategy: the GPGStrategy object to used
1136
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1138
if not self.has_signature_for_revision_id(revision_id):
1139
return gpg.SIGNATURE_NOT_SIGNED, None
1140
signature = self.get_signature_text(revision_id)
1142
testament = _mod_testament.Testament.from_revision(self, revision_id)
1143
plaintext = testament.as_short_text()
1145
return gpg_strategy.verify(signature, plaintext)
1148
def verify_revision_signatures(self, revision_ids, gpg_strategy):
1149
"""Verify revision signatures for a number of revisions.
1151
:param revision_id: the revision to verify
1152
:gpg_strategy: the GPGStrategy object to used
1153
:return: Iterator over tuples with revision id, result and keys
1155
for revid in revision_ids:
1156
(result, key) = self.verify_revision_signature(revid, gpg_strategy)
1157
yield revid, result, key
578
1159
def has_signature_for_revision_id(self, revision_id):
579
1160
"""Query for a revision signature for revision_id in the repository."""
580
return self._revision_store.has_signature(revision_id,
581
self.get_transaction())
1161
raise NotImplementedError(self.has_signature_for_revision_id)
584
1163
def get_signature_text(self, revision_id):
585
1164
"""Return the text for a signature."""
586
return self._revision_store.get_signature_text(revision_id,
587
self.get_transaction())
590
class AllInOneRepository(Repository):
591
"""Legacy support - the repository behaviour for all-in-one branches."""
593
def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
594
# we reuse one control files instance.
595
dir_mode = a_bzrdir._control_files._dir_mode
596
file_mode = a_bzrdir._control_files._file_mode
598
def get_store(name, compressed=True, prefixed=False):
599
# FIXME: This approach of assuming stores are all entirely compressed
600
# or entirely uncompressed is tidy, but breaks upgrade from
601
# some existing branches where there's a mixture; we probably
602
# still want the option to look for both.
603
relpath = a_bzrdir._control_files._escape(name)
604
store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
605
prefixed=prefixed, compressed=compressed,
608
#if self._transport.should_cache():
609
# cache_path = os.path.join(self.cache_root, name)
610
# os.mkdir(cache_path)
611
# store = bzrlib.store.CachedStore(store, cache_path)
614
# not broken out yet because the controlweaves|inventory_store
615
# and text_store | weave_store bits are still different.
616
if isinstance(_format, RepositoryFormat4):
617
# cannot remove these - there is still no consistent api
618
# which allows access to this old info.
619
self.inventory_store = get_store('inventory-store')
620
text_store = get_store('text-store')
621
super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
625
"""AllInOne repositories cannot be shared."""
629
def set_make_working_trees(self, new_value):
630
"""Set the policy flag for making working trees when creating branches.
632
This only applies to branches that use this repository.
634
The default is 'True'.
635
:param new_value: True to restore the default, False to disable making
1165
raise NotImplementedError(self.get_signature_text)
1167
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1168
"""Check consistency of all history of given revision_ids.
1170
Different repository implementations should override _check().
1172
:param revision_ids: A non-empty list of revision_ids whose ancestry
1173
will be checked. Typically the last revision_id of a branch.
1174
:param callback_refs: A dict of check-refs to resolve and callback
1175
the check/_check method on the items listed as wanting the ref.
1177
:param check_repo: If False do not check the repository contents, just
1178
calculate the data callback_refs requires and call them back.
638
raise NotImplementedError(self.set_make_working_trees)
640
def make_working_trees(self):
641
"""Returns the policy for making working trees on new branches."""
1180
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1181
check_repo=check_repo)
1183
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1184
raise NotImplementedError(self.check)
1186
def _warn_if_deprecated(self, branch=None):
1187
if not self._format.is_deprecated():
1189
global _deprecation_warning_done
1190
if _deprecation_warning_done:
1194
conf = config.GlobalStack()
1196
conf = branch.get_config_stack()
1197
if 'format_deprecation' in conf.get('suppress_warnings'):
1199
warning("Format %s for %s is deprecated -"
1200
" please use 'bzr upgrade' to get better performance"
1201
% (self._format, self.bzrdir.transport.base))
1203
_deprecation_warning_done = True
1205
def supports_rich_root(self):
1206
return self._format.rich_root_data
1208
def _check_ascii_revisionid(self, revision_id, method):
1209
"""Private helper for ascii-only repositories."""
1210
# weave repositories refuse to store revisionids that are non-ascii.
1211
if revision_id is not None:
1212
# weaves require ascii revision ids.
1213
if isinstance(revision_id, unicode):
1215
revision_id.encode('ascii')
1216
except UnicodeEncodeError:
1217
raise errors.NonAsciiRevisionId(method, self)
1220
revision_id.decode('ascii')
1221
except UnicodeDecodeError:
1222
raise errors.NonAsciiRevisionId(method, self)
645
1225
class MetaDirRepository(Repository):
646
"""Repositories in the new meta-dir layout."""
648
def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
649
super(MetaDirRepository, self).__init__(_format,
656
dir_mode = self.control_files._dir_mode
657
file_mode = self.control_files._file_mode
1226
"""Repositories in the new meta-dir layout.
1228
:ivar _transport: Transport for access to repository control files,
1229
typically pointing to .bzr/repository.
1232
def __init__(self, _format, a_bzrdir, control_files):
1233
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1234
self._transport = control_files._transport
660
1236
def is_shared(self):
661
1237
"""Return True if this repository is flagged as a shared repository."""
662
return self.control_files._transport.has('shared-storage')
1238
return self._transport.has('shared-storage')
664
1240
@needs_write_lock
665
1241
def set_make_working_trees(self, new_value):
676
self.control_files._transport.delete('no-working-trees')
1252
self._transport.delete('no-working-trees')
677
1253
except errors.NoSuchFile:
680
self.control_files.put_utf8('no-working-trees', '')
1256
self._transport.put_bytes('no-working-trees', '',
1257
mode=self.bzrdir._get_file_mode())
682
1259
def make_working_trees(self):
683
1260
"""Returns the policy for making working trees on new branches."""
684
return not self.control_files._transport.has('no-working-trees')
687
class KnitRepository(MetaDirRepository):
688
"""Knit format repository."""
691
def all_revision_ids(self):
692
"""See Repository.all_revision_ids()."""
693
return self._revision_store.all_revision_ids(self.get_transaction())
695
def fileid_involved_between_revs(self, from_revid, to_revid):
696
"""Find file_id(s) which are involved in the changes between revisions.
698
This determines the set of revisions which are involved, and then
699
finds all file ids affected by those revisions.
701
vf = self._get_revision_vf()
702
from_set = set(vf.get_ancestry(from_revid))
703
to_set = set(vf.get_ancestry(to_revid))
704
changed = to_set.difference(from_set)
705
return self._fileid_involved_by_set(changed)
707
def fileid_involved(self, last_revid=None):
708
"""Find all file_ids modified in the ancestry of last_revid.
710
:param last_revid: If None, last_revision() will be used.
713
changed = set(self.all_revision_ids())
715
changed = set(self.get_ancestry(last_revid))
718
return self._fileid_involved_by_set(changed)
721
def get_ancestry(self, revision_id):
722
"""Return a list of revision-ids integrated by a revision.
724
This is topologically sorted.
726
if revision_id is None:
728
vf = self._get_revision_vf()
730
return [None] + vf.get_ancestry(revision_id)
731
except errors.RevisionNotPresent:
732
raise errors.NoSuchRevision(self, revision_id)
735
def get_revision(self, revision_id):
736
"""Return the Revision object for a named revision"""
737
return self.get_revision_reconcile(revision_id)
740
def get_revision_graph(self, revision_id=None):
741
"""Return a dictionary containing the revision graph.
743
:return: a dictionary of revision_id->revision_parents_list.
745
weave = self._get_revision_vf()
746
entire_graph = weave.get_graph()
747
if revision_id is None:
748
return weave.get_graph()
749
elif revision_id not in weave:
750
raise errors.NoSuchRevision(self, revision_id)
752
# add what can be reached from revision_id
754
pending = set([revision_id])
755
while len(pending) > 0:
757
result[node] = weave.get_parents(node)
758
for revision_id in result[node]:
759
if revision_id not in result:
760
pending.add(revision_id)
764
def get_revision_graph_with_ghosts(self, revision_ids=None):
765
"""Return a graph of the revisions with ghosts marked as applicable.
767
:param revision_ids: an iterable of revisions to graph or None for all.
768
:return: a Graph object with the graph reachable from revision_ids.
771
vf = self._get_revision_vf()
772
versions = set(vf.versions())
774
pending = set(self.all_revision_ids())
777
pending = set(revision_ids)
778
required = set(revision_ids)
781
revision_id = pending.pop()
782
if not revision_id in versions:
783
if revision_id in required:
784
raise errors.NoSuchRevision(self, revision_id)
786
result.add_ghost(revision_id)
787
# mark it as done so we dont try for it again.
788
done.add(revision_id)
790
parent_ids = vf.get_parents_with_ghosts(revision_id)
791
for parent_id in parent_ids:
792
# is this queued or done ?
793
if (parent_id not in pending and
794
parent_id not in done):
796
pending.add(parent_id)
797
result.add_node(revision_id, parent_ids)
798
done.add(revision_id)
801
def _get_revision_vf(self):
802
""":return: a versioned file containing the revisions."""
803
vf = self._revision_store.get_revision_file(self.get_transaction())
1261
return not self._transport.has('no-working-trees')
806
1263
@needs_write_lock
808
"""Reconcile this repository."""
809
from bzrlib.reconcile import KnitReconciler
810
reconciler = KnitReconciler(self)
811
reconciler.reconcile()
814
def revision_parents(self, revid):
815
return self._get_revision_vf().get_parents(rev_id)
817
class RepositoryFormat(object):
1264
def update_feature_flags(self, updated_flags):
1265
"""Update the feature flags for this branch.
1267
:param updated_flags: Dictionary mapping feature names to necessities
1268
A necessity can be None to indicate the feature should be removed
1270
self._format._update_feature_flags(updated_flags)
1271
self.control_transport.put_bytes('format', self._format.as_string())
1274
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1275
"""Repository format registry."""
1277
def get_default(self):
1278
"""Return the current default format."""
1279
return controldir.format_registry.make_bzrdir('default').repository_format
1282
network_format_registry = registry.FormatRegistry()
1283
"""Registry of formats indexed by their network name.
1285
The network name for a repository format is an identifier that can be used when
1286
referring to formats with smart server operations. See
1287
RepositoryFormat.network_name() for more detail.
1291
format_registry = RepositoryFormatRegistry(network_format_registry)
1292
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1294
This can contain either format instances themselves, or classes/factories that
1295
can be called to obtain one.
1299
#####################################################################
1300
# Repository Formats
1302
class RepositoryFormat(controldir.ControlComponentFormat):
818
1303
"""A repository format.
820
Formats provide three things:
1305
Formats provide four things:
821
1306
* An initialization routine to construct repository data on disk.
822
* a format string which is used when the BzrDir supports versioned
1307
* a optional format string which is used when the BzrDir supports
824
1309
* an open routine which returns a Repository instance.
826
Formats are placed in an dict by their format string for reference
827
during opening. These should be subclasses of RepositoryFormat
1310
* A network name for referring to the format in smart server RPC
1313
There is one and only one Format subclass for each on-disk format. But
1314
there can be one Repository subclass that is used for several different
1315
formats. The _format attribute on a Repository instance can be used to
1316
determine the disk format.
1318
Formats are placed in a registry by their format string for reference
1319
during opening. These should be subclasses of RepositoryFormat for
830
1322
Once a format is deprecated, just deprecate the initialize and open
831
methods on the format class. Do not deprecate the object, as the
832
object will be created every system load.
1323
methods on the format class. Do not deprecate the object, as the
1324
object may be created even when a repository instance hasn't been
834
1327
Common instance attributes:
835
_matchingbzrdir - the bzrdir format that the repository format was
1328
_matchingbzrdir - the controldir format that the repository format was
836
1329
originally written to work with. This can be used if manually
837
1330
constructing a bzrdir and repository, or more commonly for test suite
841
_default_format = None
842
"""The default format used for new repositories."""
845
"""The known formats."""
848
def find_format(klass, a_bzrdir):
849
"""Return the format for the repository object in a_bzrdir."""
851
transport = a_bzrdir.get_repository_transport(None)
852
format_string = transport.get("format").read()
853
return klass._formats[format_string]
854
except errors.NoSuchFile:
855
raise errors.NoRepositoryPresent(a_bzrdir)
857
raise errors.UnknownFormatError(format_string)
859
def _get_control_store(self, repo_transport, control_files):
860
"""Return the control store for this repository."""
861
raise NotImplementedError(self._get_control_store)
864
def get_default_format(klass):
865
"""Return the current default format."""
866
return klass._default_format
868
def get_format_string(self):
869
"""Return the ASCII format string that identifies this format.
871
Note that in pre format ?? repositories the format string is
872
not permitted nor written to disk.
874
raise NotImplementedError(self.get_format_string)
876
def _get_revision_store(self, repo_transport, control_files):
877
"""Return the revision store object for this a_bzrdir."""
878
raise NotImplementedError(self._get_revision_store)
880
def _get_text_rev_store(self,
887
"""Common logic for getting a revision store for a repository.
889
see self._get_revision_store for the subclass-overridable method to
890
get the store for a repository.
892
from bzrlib.store.revision.text import TextRevisionStore
893
dir_mode = control_files._dir_mode
894
file_mode = control_files._file_mode
895
text_store =TextStore(transport.clone(name),
897
compressed=compressed,
900
_revision_store = TextRevisionStore(text_store, serializer)
901
return _revision_store
903
def _get_versioned_file_store(self,
908
versionedfile_class=WeaveFile):
909
weave_transport = control_files._transport.clone(name)
910
dir_mode = control_files._dir_mode
911
file_mode = control_files._file_mode
912
return VersionedFileStore(weave_transport, prefixed=prefixed,
915
versionedfile_class=versionedfile_class)
917
def initialize(self, a_bzrdir, shared=False):
918
"""Initialize a repository of this format in a_bzrdir.
920
:param a_bzrdir: The bzrdir to put the new repository in it.
1334
# Set to True or False in derived classes. True indicates that the format
1335
# supports ghosts gracefully.
1336
supports_ghosts = None
1337
# Can this repository be given external locations to lookup additional
1338
# data. Set to True or False in derived classes.
1339
supports_external_lookups = None
1340
# Does this format support CHK bytestring lookups. Set to True or False in
1342
supports_chks = None
1343
# Should fetch trigger a reconcile after the fetch? Only needed for
1344
# some repository formats that can suffer internal inconsistencies.
1345
_fetch_reconcile = False
1346
# Does this format have < O(tree_size) delta generation. Used to hint what
1347
# code path for commit, amongst other things.
1349
# Does doing a pack operation compress data? Useful for the pack UI command
1350
# (so if there is one pack, the operation can still proceed because it may
1351
# help), and for fetching when data won't have come from the same
1353
pack_compresses = False
1354
# Does the repository storage understand references to trees?
1355
supports_tree_reference = None
1356
# Is the format experimental ?
1357
experimental = False
1358
# Does this repository format escape funky characters, or does it create
1359
# files with similar names as the versioned files in its contents on disk
1361
supports_funky_characters = None
1362
# Does this repository format support leaving locks?
1363
supports_leaving_lock = None
1364
# Does this format support the full VersionedFiles interface?
1365
supports_full_versioned_files = None
1366
# Does this format support signing revision signatures?
1367
supports_revision_signatures = True
1368
# Can the revision graph have incorrect parents?
1369
revision_graph_can_have_wrong_parents = None
1370
# Does this format support rich root data?
1371
rich_root_data = None
1372
# Does this format support explicitly versioned directories?
1373
supports_versioned_directories = None
1374
# Can other repositories be nested into one of this format?
1375
supports_nesting_repositories = None
1376
# Is it possible for revisions to be present without being referenced
1378
supports_unreferenced_revisions = None
1381
return "%s()" % self.__class__.__name__
1383
def __eq__(self, other):
1384
# format objects are generally stateless
1385
return isinstance(other, self.__class__)
1387
def __ne__(self, other):
1388
return not self == other
1390
def get_format_description(self):
1391
"""Return the short description for this format."""
1392
raise NotImplementedError(self.get_format_description)
1394
def initialize(self, controldir, shared=False):
1395
"""Initialize a repository of this format in controldir.
1397
:param controldir: The controldir to put the new repository in it.
921
1398
:param shared: The repository should be initialized as a sharable one.
1399
:returns: The new repository object.
923
1401
This may raise UninitializableFormat if shared repository are not
924
compatible the a_bzrdir.
1402
compatible the controldir.
1404
raise NotImplementedError(self.initialize)
927
1406
def is_supported(self):
928
1407
"""Is this format supported?
930
1409
Supported formats must be initializable and openable.
931
Unsupported formats may not support initialization or committing or
1410
Unsupported formats may not support initialization or committing or
932
1411
some other features depending on the reason for not being supported.
936
def open(self, a_bzrdir, _found=False):
937
"""Return an instance of this format for the bzrdir a_bzrdir.
1415
def is_deprecated(self):
1416
"""Is this format deprecated?
1418
Deprecated formats may trigger a user-visible warning recommending
1419
the user to upgrade. They are still fully supported.
1423
def network_name(self):
1424
"""A simple byte string uniquely identifying this format for RPC calls.
1426
MetaDir repository formats use their disk format string to identify the
1427
repository over the wire. All in one formats such as bzr < 0.8, and
1428
foreign formats like svn/git and hg should use some marker which is
1429
unique and immutable.
1431
raise NotImplementedError(self.network_name)
1433
def check_conversion_target(self, target_format):
1434
if self.rich_root_data and not target_format.rich_root_data:
1435
raise errors.BadConversionTarget(
1436
'Does not support rich root data.', target_format,
1438
if (self.supports_tree_reference and
1439
not getattr(target_format, 'supports_tree_reference', False)):
1440
raise errors.BadConversionTarget(
1441
'Does not support nested trees', target_format,
1444
def open(self, controldir, _found=False):
1445
"""Return an instance of this format for a controldir.
939
1447
_found is a private parameter, do not use it.
941
1449
raise NotImplementedError(self.open)
944
def register_format(klass, format):
945
klass._formats[format.get_format_string()] = format
948
def set_default_format(klass, format):
949
klass._default_format = format
952
def unregister_format(klass, format):
953
assert klass._formats[format.get_format_string()] is format
954
del klass._formats[format.get_format_string()]
957
class PreSplitOutRepositoryFormat(RepositoryFormat):
958
"""Base class for the pre split out repository formats."""
960
def initialize(self, a_bzrdir, shared=False, _internal=False):
961
"""Create a weave repository.
963
TODO: when creating split out bzr branch formats, move this to a common
964
base for Format5, Format6. or something like that.
966
from bzrlib.weavefile import write_weave_v5
967
from bzrlib.weave import Weave
970
raise errors.IncompatibleFormat(self, a_bzrdir._format)
973
# always initialized when the bzrdir is.
974
return self.open(a_bzrdir, _found=True)
976
# Create an empty weave
978
bzrlib.weavefile.write_weave_v5(Weave(), sio)
979
empty_weave = sio.getvalue()
981
mutter('creating repository in %s.', a_bzrdir.transport.base)
982
dirs = ['revision-store', 'weaves']
983
files = [('inventory.weave', StringIO(empty_weave)),
986
# FIXME: RBC 20060125 dont peek under the covers
987
# NB: no need to escape relative paths that are url safe.
988
control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
990
control_files.create_lock()
991
control_files.lock_write()
992
control_files._transport.mkdir_multi(dirs,
993
mode=control_files._dir_mode)
995
for file, content in files:
996
control_files.put(file, content)
998
control_files.unlock()
999
return self.open(a_bzrdir, _found=True)
1001
def _get_control_store(self, repo_transport, control_files):
1002
"""Return the control store for this repository."""
1003
return self._get_versioned_file_store('',
1008
def _get_text_store(self, transport, control_files):
1009
"""Get a store for file texts for this format."""
1010
raise NotImplementedError(self._get_text_store)
1012
def open(self, a_bzrdir, _found=False):
1013
"""See RepositoryFormat.open()."""
1015
# we are being called directly and must probe.
1016
raise NotImplementedError
1018
repo_transport = a_bzrdir.get_repository_transport(None)
1019
control_files = a_bzrdir._control_files
1020
text_store = self._get_text_store(repo_transport, control_files)
1021
control_store = self._get_control_store(repo_transport, control_files)
1022
_revision_store = self._get_revision_store(repo_transport, control_files)
1023
return AllInOneRepository(_format=self,
1025
_revision_store=_revision_store,
1026
control_store=control_store,
1027
text_store=text_store)
1030
class RepositoryFormat4(PreSplitOutRepositoryFormat):
1031
"""Bzr repository format 4.
1033
This repository format has:
1035
- TextStores for texts, inventories,revisions.
1037
This format is deprecated: it indexes texts using a text id which is
1038
removed in format 5; initializationa and write support for this format
1043
super(RepositoryFormat4, self).__init__()
1044
self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat4()
1046
def initialize(self, url, shared=False, _internal=False):
1047
"""Format 4 branches cannot be created."""
1048
raise errors.UninitializableFormat(self)
1050
def is_supported(self):
1051
"""Format 4 is not supported.
1053
It is not supported because the model changed from 4 to 5 and the
1054
conversion logic is expensive - so doing it on the fly was not
1059
def _get_control_store(self, repo_transport, control_files):
1060
"""Format 4 repositories have no formal control store at this point.
1062
This will cause any control-file-needing apis to fail - this is desired.
1066
def _get_revision_store(self, repo_transport, control_files):
1067
"""See RepositoryFormat._get_revision_store()."""
1068
from bzrlib.xml4 import serializer_v4
1069
return self._get_text_rev_store(repo_transport,
1072
serializer=serializer_v4)
1074
def _get_text_store(self, transport, control_files):
1075
"""See RepositoryFormat._get_text_store()."""
1078
class RepositoryFormat5(PreSplitOutRepositoryFormat):
1079
"""Bzr control format 5.
1081
This repository format has:
1082
- weaves for file texts and inventory
1084
- TextStores for revisions and signatures.
1088
super(RepositoryFormat5, self).__init__()
1089
self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat5()
1091
def _get_revision_store(self, repo_transport, control_files):
1092
"""See RepositoryFormat._get_revision_store()."""
1093
"""Return the revision store object for this a_bzrdir."""
1094
return self._get_text_rev_store(repo_transport,
1099
def _get_text_store(self, transport, control_files):
1100
"""See RepositoryFormat._get_text_store()."""
1101
return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
1104
class RepositoryFormat6(PreSplitOutRepositoryFormat):
1105
"""Bzr control format 6.
1107
This repository format has:
1108
- weaves for file texts and inventory
1109
- hash subdirectory based stores.
1110
- TextStores for revisions and signatures.
1114
super(RepositoryFormat6, self).__init__()
1115
self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat6()
1117
def _get_revision_store(self, repo_transport, control_files):
1118
"""See RepositoryFormat._get_revision_store()."""
1119
return self._get_text_rev_store(repo_transport,
1125
def _get_text_store(self, transport, control_files):
1126
"""See RepositoryFormat._get_text_store()."""
1127
return self._get_versioned_file_store('weaves', transport, control_files)
1130
class MetaDirRepositoryFormat(RepositoryFormat):
1131
"""Common base class for the new repositories using the metadir layour."""
1134
super(MetaDirRepositoryFormat, self).__init__()
1135
self._matchingbzrdir = bzrlib.bzrdir.BzrDirMetaFormat1()
1451
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1452
from bzrlib.controldir import ControlDir, RepoInitHookParams
1453
hooks = ControlDir.hooks['post_repo_init']
1456
params = RepoInitHookParams(repository, self, controldir, shared)
1461
class RepositoryFormatMetaDir(bzrdir.BzrFormat, RepositoryFormat):
1462
"""Common base class for the new repositories using the metadir layout."""
1464
rich_root_data = False
1465
supports_tree_reference = False
1466
supports_external_lookups = False
1467
supports_leaving_lock = True
1468
supports_nesting_repositories = True
1471
def _matchingbzrdir(self):
1472
matching = bzrdir.BzrDirMetaFormat1()
1473
matching.repository_format = self
1477
RepositoryFormat.__init__(self)
1478
bzrdir.BzrFormat.__init__(self)
1137
1480
def _create_control_files(self, a_bzrdir):
1138
1481
"""Create the required files and the initial control_files object."""
1139
# FIXME: RBC 20060125 dont peek under the covers
1482
# FIXME: RBC 20060125 don't peek under the covers
1140
1483
# NB: no need to escape relative paths that are url safe.
1141
1484
repository_transport = a_bzrdir.get_repository_transport(self)
1142
control_files = LockableFiles(repository_transport, 'lock', LockDir)
1485
control_files = lockable_files.LockableFiles(repository_transport,
1486
'lock', lockdir.LockDir)
1143
1487
control_files.create_lock()
1144
1488
return control_files
1147
1491
"""Upload the initial blank content."""
1148
1492
control_files = self._create_control_files(a_bzrdir)
1149
1493
control_files.lock_write()
1494
transport = control_files._transport
1496
utf8_files += [('shared-storage', '')]
1151
control_files._transport.mkdir_multi(dirs,
1152
mode=control_files._dir_mode)
1153
for file, content in files:
1154
control_files.put(file, content)
1155
for file, content in utf8_files:
1156
control_files.put_utf8(file, content)
1158
control_files.put_utf8('shared-storage', '')
1498
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1499
for (filename, content_stream) in files:
1500
transport.put_file(filename, content_stream,
1501
mode=a_bzrdir._get_file_mode())
1502
for (filename, content_bytes) in utf8_files:
1503
transport.put_bytes_non_atomic(filename, content_bytes,
1504
mode=a_bzrdir._get_file_mode())
1160
1506
control_files.unlock()
1163
class RepositoryFormat7(MetaDirRepositoryFormat):
1164
"""Bzr repository 7.
1166
This repository format has:
1167
- weaves for file texts and inventory
1168
- hash subdirectory based stores.
1169
- TextStores for revisions and signatures.
1170
- a format marker of its own
1171
- an optional 'shared-storage' flag
1172
- an optional 'no-working-trees' flag
1175
def _get_control_store(self, repo_transport, control_files):
1176
"""Return the control store for this repository."""
1177
return self._get_versioned_file_store('',
1182
def get_format_string(self):
1183
"""See RepositoryFormat.get_format_string()."""
1184
return "Bazaar-NG Repository format 7"
1186
def _get_revision_store(self, repo_transport, control_files):
1187
"""See RepositoryFormat._get_revision_store()."""
1188
return self._get_text_rev_store(repo_transport,
1195
def _get_text_store(self, transport, control_files):
1196
"""See RepositoryFormat._get_text_store()."""
1197
return self._get_versioned_file_store('weaves',
1201
def initialize(self, a_bzrdir, shared=False):
1202
"""Create a weave repository.
1204
:param shared: If true the repository will be initialized as a shared
1207
from bzrlib.weavefile import write_weave_v5
1208
from bzrlib.weave import Weave
1210
# Create an empty weave
1212
bzrlib.weavefile.write_weave_v5(Weave(), sio)
1213
empty_weave = sio.getvalue()
1215
mutter('creating repository in %s.', a_bzrdir.transport.base)
1216
dirs = ['revision-store', 'weaves']
1217
files = [('inventory.weave', StringIO(empty_weave)),
1219
utf8_files = [('format', self.get_format_string())]
1221
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1222
return self.open(a_bzrdir=a_bzrdir, _found=True)
1224
def open(self, a_bzrdir, _found=False, _override_transport=None):
1225
"""See RepositoryFormat.open().
1227
:param _override_transport: INTERNAL USE ONLY. Allows opening the
1228
repository at a slightly different url
1229
than normal. I.e. during 'upgrade'.
1232
format = RepositoryFormat.find_format(a_bzrdir)
1233
assert format.__class__ == self.__class__
1234
if _override_transport is not None:
1235
repo_transport = _override_transport
1237
repo_transport = a_bzrdir.get_repository_transport(None)
1238
control_files = LockableFiles(repo_transport, 'lock', LockDir)
1239
text_store = self._get_text_store(repo_transport, control_files)
1240
control_store = self._get_control_store(repo_transport, control_files)
1241
_revision_store = self._get_revision_store(repo_transport, control_files)
1242
return MetaDirRepository(_format=self,
1244
control_files=control_files,
1245
_revision_store=_revision_store,
1246
control_store=control_store,
1247
text_store=text_store)
1250
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
1251
"""Bzr repository knit format 1.
1253
This repository format has:
1254
- knits for file texts and inventory
1255
- hash subdirectory based stores.
1256
- knits for revisions and signatures
1257
- TextStores for revisions and signatures.
1258
- a format marker of its own
1259
- an optional 'shared-storage' flag
1260
- an optional 'no-working-trees' flag
1264
def _get_control_store(self, repo_transport, control_files):
1265
"""Return the control store for this repository."""
1266
return VersionedFileStore(
1269
file_mode=control_files._file_mode,
1270
versionedfile_class=KnitVersionedFile,
1271
versionedfile_kwargs={'factory':KnitPlainFactory()},
1274
def get_format_string(self):
1275
"""See RepositoryFormat.get_format_string()."""
1276
return "Bazaar-NG Knit Repository Format 1"
1278
def _get_revision_store(self, repo_transport, control_files):
1279
"""See RepositoryFormat._get_revision_store()."""
1280
from bzrlib.store.revision.knit import KnitRevisionStore
1281
versioned_file_store = VersionedFileStore(
1283
file_mode = control_files._file_mode,
1286
versionedfile_class=KnitVersionedFile,
1287
versionedfile_kwargs={'delta':False, 'factory':KnitPlainFactory()})
1288
return KnitRevisionStore(versioned_file_store)
1290
def _get_text_store(self, transport, control_files):
1291
"""See RepositoryFormat._get_text_store()."""
1292
return self._get_versioned_file_store('knits',
1295
versionedfile_class=KnitVersionedFile)
1297
def initialize(self, a_bzrdir, shared=False):
1298
"""Create a knit format 1 repository.
1300
:param shared: If true the repository will be initialized as a shared
1302
XXX NOTE that this current uses a Weave for testing and will become
1303
A Knit in due course.
1305
from bzrlib.weavefile import write_weave_v5
1306
from bzrlib.weave import Weave
1308
# Create an empty weave
1310
bzrlib.weavefile.write_weave_v5(Weave(), sio)
1311
empty_weave = sio.getvalue()
1313
mutter('creating repository in %s.', a_bzrdir.transport.base)
1314
dirs = ['revision-store', 'knits', 'control']
1315
files = [('control/inventory.weave', StringIO(empty_weave)),
1317
utf8_files = [('format', self.get_format_string())]
1319
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1320
repo_transport = a_bzrdir.get_repository_transport(None)
1321
control_files = LockableFiles(repo_transport, 'lock', LockDir)
1322
control_store = self._get_control_store(repo_transport, control_files)
1323
transaction = bzrlib.transactions.WriteTransaction()
1324
# trigger a write of the inventory store.
1325
control_store.get_weave_or_empty('inventory', transaction)
1326
_revision_store = self._get_revision_store(repo_transport, control_files)
1327
_revision_store.has_revision_id('A', transaction)
1328
_revision_store.get_signature_file(transaction)
1329
return self.open(a_bzrdir=a_bzrdir, _found=True)
1331
def open(self, a_bzrdir, _found=False, _override_transport=None):
1332
"""See RepositoryFormat.open().
1334
:param _override_transport: INTERNAL USE ONLY. Allows opening the
1335
repository at a slightly different url
1336
than normal. I.e. during 'upgrade'.
1339
format = RepositoryFormat.find_format(a_bzrdir)
1340
assert format.__class__ == self.__class__
1341
if _override_transport is not None:
1342
repo_transport = _override_transport
1344
repo_transport = a_bzrdir.get_repository_transport(None)
1345
control_files = LockableFiles(repo_transport, 'lock', LockDir)
1346
text_store = self._get_text_store(repo_transport, control_files)
1347
control_store = self._get_control_store(repo_transport, control_files)
1348
_revision_store = self._get_revision_store(repo_transport, control_files)
1349
return KnitRepository(_format=self,
1351
control_files=control_files,
1352
_revision_store=_revision_store,
1353
control_store=control_store,
1354
text_store=text_store)
1357
# formats which have no format string are not discoverable
1358
# and not independently creatable, so are not registered.
1359
_default_format = RepositoryFormat7()
1360
RepositoryFormat.register_format(_default_format)
1361
RepositoryFormat.register_format(RepositoryFormatKnit1())
1362
RepositoryFormat.set_default_format(_default_format)
1363
_legacy_formats = [RepositoryFormat4(),
1364
RepositoryFormat5(),
1365
RepositoryFormat6()]
1509
def find_format(klass, a_bzrdir):
1510
"""Return the format for the repository object in a_bzrdir.
1512
This is used by bzr native formats that have a "format" file in
1513
the repository. Other methods may be used by different types of
1517
transport = a_bzrdir.get_repository_transport(None)
1518
format_string = transport.get_bytes("format")
1519
except errors.NoSuchFile:
1520
raise errors.NoRepositoryPresent(a_bzrdir)
1521
return klass._find_format(format_registry, 'repository', format_string)
1523
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1525
RepositoryFormat.check_support_status(self,
1526
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1528
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1529
recommend_upgrade=recommend_upgrade, basedir=basedir)
1532
# formats which have no format string are not discoverable or independently
1533
# creatable on disk, so are not registered in format_registry. They're
1534
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1535
# needed, it's constructed directly by the ControlDir. Non-native formats where
1536
# the repository is not separately opened are similar.
1538
format_registry.register_lazy(
1539
'Bazaar-NG Knit Repository Format 1',
1540
'bzrlib.repofmt.knitrepo',
1541
'RepositoryFormatKnit1',
1544
format_registry.register_lazy(
1545
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1546
'bzrlib.repofmt.knitrepo',
1547
'RepositoryFormatKnit3',
1550
format_registry.register_lazy(
1551
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1552
'bzrlib.repofmt.knitrepo',
1553
'RepositoryFormatKnit4',
1556
# Pack-based formats. There is one format for pre-subtrees, and one for
1557
# post-subtrees to allow ease of testing.
1558
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1559
format_registry.register_lazy(
1560
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1561
'bzrlib.repofmt.knitpack_repo',
1562
'RepositoryFormatKnitPack1',
1564
format_registry.register_lazy(
1565
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1566
'bzrlib.repofmt.knitpack_repo',
1567
'RepositoryFormatKnitPack3',
1569
format_registry.register_lazy(
1570
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1571
'bzrlib.repofmt.knitpack_repo',
1572
'RepositoryFormatKnitPack4',
1574
format_registry.register_lazy(
1575
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1576
'bzrlib.repofmt.knitpack_repo',
1577
'RepositoryFormatKnitPack5',
1579
format_registry.register_lazy(
1580
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1581
'bzrlib.repofmt.knitpack_repo',
1582
'RepositoryFormatKnitPack5RichRoot',
1584
format_registry.register_lazy(
1585
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1586
'bzrlib.repofmt.knitpack_repo',
1587
'RepositoryFormatKnitPack5RichRootBroken',
1589
format_registry.register_lazy(
1590
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1591
'bzrlib.repofmt.knitpack_repo',
1592
'RepositoryFormatKnitPack6',
1594
format_registry.register_lazy(
1595
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1596
'bzrlib.repofmt.knitpack_repo',
1597
'RepositoryFormatKnitPack6RichRoot',
1599
format_registry.register_lazy(
1600
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1601
'bzrlib.repofmt.groupcompress_repo',
1602
'RepositoryFormat2a',
1605
# Development formats.
1606
# Check their docstrings to see if/when they are obsolete.
1607
format_registry.register_lazy(
1608
("Bazaar development format 2 with subtree support "
1609
"(needs bzr.dev from before 1.8)\n"),
1610
'bzrlib.repofmt.knitpack_repo',
1611
'RepositoryFormatPackDevelopment2Subtree',
1613
format_registry.register_lazy(
1614
'Bazaar development format 8\n',
1615
'bzrlib.repofmt.groupcompress_repo',
1616
'RepositoryFormat2aSubtree',
1368
1620
class InterRepository(InterObject):
1369
1621
"""This class represents operations taking place between two repositories.
1371
1623
Its instances have methods like copy_content and fetch, and contain
1372
references to the source and target repositories these operations can be
1624
references to the source and target repositories these operations can be
1373
1625
carried out on.
1375
1627
Often we will provide convenience methods on 'repository' which carry out
1377
1629
InterRepository.get(other).method_name(parameters).
1381
1633
"""The available optimised InterRepository types."""
1383
1635
@needs_write_lock
1384
def copy_content(self, revision_id=None, basis=None):
1636
def copy_content(self, revision_id=None):
1385
1637
"""Make a complete copy of the content in self into destination.
1387
This is a destructive operation! Do not use it on existing
1639
This is a destructive operation! Do not use it on existing
1390
1642
:param revision_id: Only copy the content needed to construct
1391
1643
revision_id and its parents.
1392
:param basis: Copy the needed data preferentially from basis.
1395
1646
self.target.set_make_working_trees(self.source.make_working_trees())
1396
1647
except NotImplementedError:
1398
# grab the basis available data
1399
if basis is not None:
1400
self.target.fetch(basis, revision_id=revision_id)
1401
# but dont bother fetching if we have the needed data now.
1402
if (revision_id not in (None, NULL_REVISION) and
1403
self.target.has_revision(revision_id)):
1405
1649
self.target.fetch(self.source, revision_id=revision_id)
1407
def _double_lock(self, lock_source, lock_target):
1408
"""Take out too locks, rolling back the first if the second throws."""
1413
# we want to ensure that we don't leave source locked by mistake.
1414
# and any error on target should not confuse source.
1415
self.source.unlock()
1418
1651
@needs_write_lock
1419
def fetch(self, revision_id=None, pb=None):
1652
def fetch(self, revision_id=None, find_ghosts=False):
1420
1653
"""Fetch the content required to construct revision_id.
1422
The content is copied from source to target.
1655
The content is copied from self.source to self.target.
1424
1657
:param revision_id: if None all content is copied, if NULL_REVISION no
1425
1658
content is copied.
1426
:param pb: optional progress bar to use for progress reports. If not
1427
provided a default one will be created.
1429
Returns the copied revision count and the failed revisions in a tuple:
1432
from bzrlib.fetch import GenericRepoFetcher
1433
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1434
self.source, self.source._format, self.target, self.target._format)
1435
f = GenericRepoFetcher(to_repository=self.target,
1436
from_repository=self.source,
1437
last_revision=revision_id,
1439
return f.count_copied, f.failed_revisions
1441
def lock_read(self):
1442
"""Take out a logical read lock.
1444
This will lock the source branch and the target branch. The source gets
1445
a read lock and the target a read lock.
1447
self._double_lock(self.source.lock_read, self.target.lock_read)
1449
def lock_write(self):
1450
"""Take out a logical write lock.
1452
This will lock the source branch and the target branch. The source gets
1453
a read lock and the target a write lock.
1455
self._double_lock(self.source.lock_read, self.target.lock_write)
1661
raise NotImplementedError(self.fetch)
1457
1663
@needs_read_lock
1458
def missing_revision_ids(self, revision_id=None):
1664
def search_missing_revision_ids(self,
1665
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1666
find_ghosts=True, revision_ids=None, if_present_ids=None,
1459
1668
"""Return the revision ids that source has that target does not.
1461
These are returned in topological order.
1463
1670
:param revision_id: only return revision ids included by this
1466
# generic, possibly worst case, slow code path.
1467
target_ids = set(self.target.all_revision_ids())
1468
if revision_id is not None:
1469
source_ids = self.source.get_ancestry(revision_id)
1470
assert source_ids.pop(0) == None
1472
source_ids = self.source.all_revision_ids()
1473
result_set = set(source_ids).difference(target_ids)
1474
# this may look like a no-op: its not. It preserves the ordering
1475
# other_ids had while only returning the members from other_ids
1476
# that we've decided we need.
1477
return [rev_id for rev_id in source_ids if rev_id in result_set]
1480
"""Release the locks on source and target."""
1482
self.target.unlock()
1484
self.source.unlock()
1487
class InterWeaveRepo(InterRepository):
1488
"""Optimised code paths between Weave based repositories."""
1490
_matching_repo_format = _default_format
1491
"""Repository format for testing with."""
1494
def is_compatible(source, target):
1495
"""Be compatible with known Weave formats.
1497
We dont test for the stores being of specific types becase that
1498
could lead to confusing results, and there is no need to be
1502
return (isinstance(source._format, (RepositoryFormat5,
1504
RepositoryFormat7)) and
1505
isinstance(target._format, (RepositoryFormat5,
1507
RepositoryFormat7)))
1508
except AttributeError:
1512
def copy_content(self, revision_id=None, basis=None):
1513
"""See InterRepository.copy_content()."""
1514
# weave specific optimised path:
1515
if basis is not None:
1516
# copy the basis in, then fetch remaining data.
1517
basis.copy_content_into(self.target, revision_id)
1518
# the basis copy_content_into could misset this.
1520
self.target.set_make_working_trees(self.source.make_working_trees())
1521
except NotImplementedError:
1523
self.target.fetch(self.source, revision_id=revision_id)
1526
self.target.set_make_working_trees(self.source.make_working_trees())
1527
except NotImplementedError:
1529
# FIXME do not peek!
1530
if self.source.control_files._transport.listable():
1531
pb = bzrlib.ui.ui_factory.nested_progress_bar()
1533
self.target.weave_store.copy_all_ids(
1534
self.source.weave_store,
1536
from_transaction=self.source.get_transaction(),
1537
to_transaction=self.target.get_transaction())
1538
pb.update('copying inventory', 0, 1)
1539
self.target.control_weaves.copy_multi(
1540
self.source.control_weaves, ['inventory'],
1541
from_transaction=self.source.get_transaction(),
1542
to_transaction=self.target.get_transaction())
1543
self.target._revision_store.text_store.copy_all_ids(
1544
self.source._revision_store.text_store,
1549
self.target.fetch(self.source, revision_id=revision_id)
1552
def fetch(self, revision_id=None, pb=None):
1553
"""See InterRepository.fetch()."""
1554
from bzrlib.fetch import GenericRepoFetcher
1555
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1556
self.source, self.source._format, self.target, self.target._format)
1557
f = GenericRepoFetcher(to_repository=self.target,
1558
from_repository=self.source,
1559
last_revision=revision_id,
1561
return f.count_copied, f.failed_revisions
1564
def missing_revision_ids(self, revision_id=None):
1565
"""See InterRepository.missing_revision_ids()."""
1566
# we want all revisions to satisfy revision_id in source.
1567
# but we dont want to stat every file here and there.
1568
# we want then, all revisions other needs to satisfy revision_id
1569
# checked, but not those that we have locally.
1570
# so the first thing is to get a subset of the revisions to
1571
# satisfy revision_id in source, and then eliminate those that
1572
# we do already have.
1573
# this is slow on high latency connection to self, but as as this
1574
# disk format scales terribly for push anyway due to rewriting
1575
# inventory.weave, this is considered acceptable.
1577
if revision_id is not None:
1578
source_ids = self.source.get_ancestry(revision_id)
1579
assert source_ids.pop(0) == None
1581
source_ids = self.source._all_possible_ids()
1582
source_ids_set = set(source_ids)
1583
# source_ids is the worst possible case we may need to pull.
1584
# now we want to filter source_ids against what we actually
1585
# have in target, but dont try to check for existence where we know
1586
# we do not have a revision as that would be pointless.
1587
target_ids = set(self.target._all_possible_ids())
1588
possibly_present_revisions = target_ids.intersection(source_ids_set)
1589
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1590
required_revisions = source_ids_set.difference(actually_present_revisions)
1591
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1592
if revision_id is not None:
1593
# we used get_ancestry to determine source_ids then we are assured all
1594
# revisions referenced are present as they are installed in topological order.
1595
# and the tip revision was validated by get_ancestry.
1596
return required_topo_revisions
1598
# if we just grabbed the possibly available ids, then
1599
# we only have an estimate of whats available and need to validate
1600
# that against the revision records.
1601
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1604
class InterKnitRepo(InterRepository):
1605
"""Optimised code paths between Knit based repositories."""
1607
_matching_repo_format = RepositoryFormatKnit1()
1608
"""Repository format for testing with."""
1611
def is_compatible(source, target):
1612
"""Be compatible with known Knit formats.
1614
We dont test for the stores being of specific types becase that
1615
could lead to confusing results, and there is no need to be
1619
return (isinstance(source._format, (RepositoryFormatKnit1)) and
1620
isinstance(target._format, (RepositoryFormatKnit1)))
1621
except AttributeError:
1625
def fetch(self, revision_id=None, pb=None):
1626
"""See InterRepository.fetch()."""
1627
from bzrlib.fetch import KnitRepoFetcher
1628
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1629
self.source, self.source._format, self.target, self.target._format)
1630
f = KnitRepoFetcher(to_repository=self.target,
1631
from_repository=self.source,
1632
last_revision=revision_id,
1634
return f.count_copied, f.failed_revisions
1637
def missing_revision_ids(self, revision_id=None):
1638
"""See InterRepository.missing_revision_ids()."""
1639
if revision_id is not None:
1640
source_ids = self.source.get_ancestry(revision_id)
1641
assert source_ids.pop(0) == None
1643
source_ids = self.source._all_possible_ids()
1644
source_ids_set = set(source_ids)
1645
# source_ids is the worst possible case we may need to pull.
1646
# now we want to filter source_ids against what we actually
1647
# have in target, but dont try to check for existence where we know
1648
# we do not have a revision as that would be pointless.
1649
target_ids = set(self.target._all_possible_ids())
1650
possibly_present_revisions = target_ids.intersection(source_ids_set)
1651
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1652
required_revisions = source_ids_set.difference(actually_present_revisions)
1653
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1654
if revision_id is not None:
1655
# we used get_ancestry to determine source_ids then we are assured all
1656
# revisions referenced are present as they are installed in topological order.
1657
# and the tip revision was validated by get_ancestry.
1658
return required_topo_revisions
1660
# if we just grabbed the possibly available ids, then
1661
# we only have an estimate of whats available and need to validate
1662
# that against the revision records.
1663
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1665
InterRepository.register_optimiser(InterWeaveRepo)
1666
InterRepository.register_optimiser(InterKnitRepo)
1669
class RepositoryTestProviderAdapter(object):
1670
"""A tool to generate a suite testing multiple repository formats at once.
1672
This is done by copying the test once for each transport and injecting
1673
the transport_server, transport_readonly_server, and bzrdir_format and
1674
repository_format classes into each copy. Each copy is also given a new id()
1675
to make it easy to identify.
1678
def __init__(self, transport_server, transport_readonly_server, formats):
1679
self._transport_server = transport_server
1680
self._transport_readonly_server = transport_readonly_server
1681
self._formats = formats
1683
def adapt(self, test):
1684
result = TestSuite()
1685
for repository_format, bzrdir_format in self._formats:
1686
new_test = deepcopy(test)
1687
new_test.transport_server = self._transport_server
1688
new_test.transport_readonly_server = self._transport_readonly_server
1689
new_test.bzrdir_format = bzrdir_format
1690
new_test.repository_format = repository_format
1691
def make_new_test_id():
1692
new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
1693
return lambda: new_id
1694
new_test.id = make_new_test_id()
1695
result.addTest(new_test)
1699
class InterRepositoryTestProviderAdapter(object):
1700
"""A tool to generate a suite testing multiple inter repository formats.
1702
This is done by copying the test once for each interrepo provider and injecting
1703
the transport_server, transport_readonly_server, repository_format and
1704
repository_to_format classes into each copy.
1705
Each copy is also given a new id() to make it easy to identify.
1708
def __init__(self, transport_server, transport_readonly_server, formats):
1709
self._transport_server = transport_server
1710
self._transport_readonly_server = transport_readonly_server
1711
self._formats = formats
1713
def adapt(self, test):
1714
result = TestSuite()
1715
for interrepo_class, repository_format, repository_format_to in self._formats:
1716
new_test = deepcopy(test)
1717
new_test.transport_server = self._transport_server
1718
new_test.transport_readonly_server = self._transport_readonly_server
1719
new_test.interrepo_class = interrepo_class
1720
new_test.repository_format = repository_format
1721
new_test.repository_format_to = repository_format_to
1722
def make_new_test_id():
1723
new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
1724
return lambda: new_id
1725
new_test.id = make_new_test_id()
1726
result.addTest(new_test)
1730
def default_test_list():
1731
"""Generate the default list of interrepo permutations to test."""
1733
# test the default InterRepository between format 6 and the current
1735
# XXX: robertc 20060220 reinstate this when there are two supported
1736
# formats which do not have an optimal code path between them.
1737
result.append((InterRepository,
1738
RepositoryFormat6(),
1739
RepositoryFormatKnit1()))
1740
for optimiser in InterRepository._optimisers:
1741
result.append((optimiser,
1742
optimiser._matching_repo_format,
1743
optimiser._matching_repo_format
1745
# if there are specific combinations we want to use, we can add them
1672
:param revision_ids: return revision ids included by these
1673
revision_ids. NoSuchRevision will be raised if any of these
1674
revisions are not present.
1675
:param if_present_ids: like revision_ids, but will not cause
1676
NoSuchRevision if any of these are absent, instead they will simply
1677
not be in the result. This is useful for e.g. finding revisions
1678
to fetch for tags, which may reference absent revisions.
1679
:param find_ghosts: If True find missing revisions in deep history
1680
rather than just finding the surface difference.
1681
:param limit: Maximum number of revisions to return, topologically
1683
:return: A bzrlib.graph.SearchResult.
1685
raise NotImplementedError(self.search_missing_revision_ids)
1688
def _same_model(source, target):
1689
"""True if source and target have the same data representation.
1691
Note: this is always called on the base class; overriding it in a
1692
subclass will have no effect.
1695
InterRepository._assert_same_model(source, target)
1697
except errors.IncompatibleRepositories, e:
1701
def _assert_same_model(source, target):
1702
"""Raise an exception if two repositories do not use the same model.
1704
if source.supports_rich_root() != target.supports_rich_root():
1705
raise errors.IncompatibleRepositories(source, target,
1706
"different rich-root support")
1707
if source._serializer != target._serializer:
1708
raise errors.IncompatibleRepositories(source, target,
1709
"different serializers")
1750
1712
class CopyConverter(object):
1751
1713
"""A repository conversion tool which just performs a copy of the content.
1753
1715
This is slow but quite reliable.