1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from .lazy_import import lazy_import
20
lazy_import(globals(), """
29
revision as _mod_revision,
32
from breezy.i18n import gettext
40
from .decorators import only_raises
41
from .inter import InterObject
42
from .lock import _RelockDebugMixin, LogicalLockResult
48
log_exception_quietly, note, mutter, mutter_callsite, warning)
51
# Old formats display a warning, but only once
52
_deprecation_warning_done = False
55
class IsInWriteGroupError(errors.InternalBzrError):
57
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
59
def __init__(self, repo):
60
errors.InternalBzrError.__init__(self, repo=repo)
63
class CannotSetRevisionId(errors.BzrError):
65
_fmt = "Repository format does not support setting revision ids."
68
class FetchResult(object):
69
"""Result of a fetch operation.
71
:ivar revidmap: For lossy fetches, map from source revid to target revid.
72
:ivar total_fetched: Number of revisions fetched
75
def __init__(self, total_fetched=None, revidmap=None):
76
self.total_fetched = total_fetched
77
self.revidmap = revidmap
80
class CommitBuilder(object):
81
"""Provides an interface to build up a commit.
83
This allows describing a tree to be committed without needing to
84
know the internals of the format of the repository.
87
# all clients should supply tree roots.
88
record_root_entry = True
89
# whether this commit builder will automatically update the branch that is
91
updates_branch = False
93
def __init__(self, repository, parents, config_stack, timestamp=None,
94
timezone=None, committer=None, revprops=None,
95
revision_id=None, lossy=False):
96
"""Initiate a CommitBuilder.
98
:param repository: Repository to commit to.
99
:param parents: Revision ids of the parents of the new revision.
100
:param timestamp: Optional timestamp recorded for commit.
101
:param timezone: Optional timezone for timestamp.
102
:param committer: Optional committer to set for commit.
103
:param revprops: Optional dictionary of revision properties.
104
:param revision_id: Optional revision id.
105
:param lossy: Whether to discard data that can not be natively
106
represented, when pushing to a foreign VCS
108
self._config_stack = config_stack
111
if committer is None:
112
self._committer = self._config_stack.get('email')
113
elif not isinstance(committer, text_type):
114
self._committer = committer.decode() # throw if non-ascii
116
self._committer = committer
118
self.parents = parents
119
self.repository = repository
122
if revprops is not None:
123
self._validate_revprops(revprops)
124
self._revprops.update(revprops)
126
if timestamp is None:
127
timestamp = time.time()
128
# Restrict resolution to 1ms
129
self._timestamp = round(timestamp, 3)
132
self._timezone = osutils.local_time_offset()
134
self._timezone = int(timezone)
136
self._generate_revision_if_needed(revision_id)
138
def any_changes(self):
139
"""Return True if any entries were changed.
141
This includes merge-only changes. It is the core for the --unchanged
144
:return: True if any changes have occured.
146
raise NotImplementedError(self.any_changes)
148
def _validate_unicode_text(self, text, context):
149
"""Verify things like commit messages don't have bogus characters."""
150
# TODO(jelmer): Make this repository-format specific
152
raise ValueError('Invalid value for %s: %r' % (context, text))
154
def _validate_revprops(self, revprops):
155
for key, value in viewitems(revprops):
156
# We know that the XML serializers do not round trip '\r'
157
# correctly, so refuse to accept them
158
if not isinstance(value, (text_type, str)):
159
raise ValueError('revision property (%s) is not a valid'
160
' (unicode) string: %r' % (key, value))
161
# TODO(jelmer): Make this repository-format specific
162
self._validate_unicode_text(value,
163
'revision property (%s)' % (key,))
165
def commit(self, message):
166
"""Make the actual commit.
168
:return: The revision id of the recorded revision.
170
raise NotImplementedError(self.commit)
173
"""Abort the commit that is being built.
175
raise NotImplementedError(self.abort)
177
def revision_tree(self):
178
"""Return the tree that was just committed.
180
After calling commit() this can be called to get a
181
RevisionTree representing the newly committed tree. This is
182
preferred to calling Repository.revision_tree() because that may
183
require deserializing the inventory, while we already have a copy in
186
raise NotImplementedError(self.revision_tree)
188
def finish_inventory(self):
189
"""Tell the builder that the inventory is finished.
191
:return: The inventory id in the repository, which can be used with
192
repository.get_inventory.
194
raise NotImplementedError(self.finish_inventory)
196
def _generate_revision_if_needed(self, revision_id):
197
"""Create a revision id if None was supplied.
199
If the repository can not support user-specified revision ids
200
they should override this function and raise CannotSetRevisionId
201
if _new_revision_id is not None.
203
:raises: CannotSetRevisionId
205
if not self.repository._format.supports_setting_revision_ids:
206
if revision_id is not None:
207
raise CannotSetRevisionId()
209
if revision_id is None:
210
self._new_revision_id = self._gen_revision_id()
211
self.random_revid = True
213
self._new_revision_id = revision_id
214
self.random_revid = False
216
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
217
"""Record a new tree via iter_changes.
219
:param tree: The tree to obtain text contents from for changed objects.
220
:param basis_revision_id: The revision id of the tree the iter_changes
221
has been generated against. Currently assumed to be the same
222
as self.parents[0] - if it is not, errors may occur.
223
:param iter_changes: An iter_changes iterator with the changes to apply
224
to basis_revision_id. The iterator must not include any items with
225
a current kind of None - missing items must be either filtered out
226
or errored-on beefore record_iter_changes sees the item.
227
:return: A generator of (relpath, fs_hash) tuples for use with
230
raise NotImplementedError(self.record_iter_changes)
233
class RepositoryWriteLockResult(LogicalLockResult):
234
"""The result of write locking a repository.
236
:ivar repository_token: The token obtained from the underlying lock, or
238
:ivar unlock: A callable which will unlock the lock.
241
def __init__(self, unlock, repository_token):
242
LogicalLockResult.__init__(self, unlock)
243
self.repository_token = repository_token
246
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
250
class WriteGroup(object):
251
"""Context manager that manages a write group.
253
Raising an exception will result in the write group being aborted.
256
def __init__(self, repository, suppress_errors=False):
257
self.repository = repository
258
self._suppress_errors = suppress_errors
261
self.repository.start_write_group()
264
def __exit__(self, exc_type, exc_val, exc_tb):
266
self.repository.abort_write_group(self._suppress_errors)
269
self.repository.commit_write_group()
272
######################################################################
276
class Repository(controldir.ControlComponent, _RelockDebugMixin):
277
"""Repository holding history for one or more branches.
279
The repository holds and retrieves historical information including
280
revisions and file history. It's normally accessed only by the Branch,
281
which views a particular line of development through that history.
283
See VersionedFileRepository in breezy.vf_repository for the
284
base class for most Bazaar repositories.
287
# Does this repository implementation support random access to
288
# items in the tree, or just bulk fetching/pushing of data?
289
supports_random_access = True
291
def abort_write_group(self, suppress_errors=False):
292
"""Commit the contents accrued within the current write group.
294
:param suppress_errors: if true, abort_write_group will catch and log
295
unexpected errors that happen during the abort, rather than
296
allowing them to propagate. Defaults to False.
298
:seealso: start_write_group.
300
if self._write_group is not self.get_transaction():
301
# has an unlock or relock occured ?
304
'(suppressed) mismatched lock context and write group. %r, %r',
305
self._write_group, self.get_transaction())
307
raise errors.BzrError(
308
'mismatched lock context and write group. %r, %r' %
309
(self._write_group, self.get_transaction()))
311
self._abort_write_group()
312
except Exception as exc:
313
self._write_group = None
314
if not suppress_errors:
316
mutter('abort_write_group failed')
317
log_exception_quietly()
318
note(gettext('brz: ERROR (ignored): %s'), exc)
319
self._write_group = None
321
def _abort_write_group(self):
322
"""Template method for per-repository write group cleanup.
324
This is called during abort before the write group is considered to be
325
finished and should cleanup any internal state accrued during the write
326
group. There is no requirement that data handed to the repository be
327
*not* made available - this is not a rollback - but neither should any
328
attempt be made to ensure that data added is fully commited. Abort is
329
invoked when an error has occured so futher disk or network operations
330
may not be possible or may error and if possible should not be
334
def add_fallback_repository(self, repository):
335
"""Add a repository to use for looking up data not held locally.
337
:param repository: A repository.
339
raise NotImplementedError(self.add_fallback_repository)
341
def _check_fallback_repository(self, repository):
342
"""Check that this repository can fallback to repository safely.
344
Raise an error if not.
346
:param repository: A repository to fallback to.
348
return InterRepository._assert_same_model(self, repository)
350
def all_revision_ids(self):
351
"""Returns a list of all the revision ids in the repository.
353
This is conceptually deprecated because code should generally work on
354
the graph reachable from a particular revision, and ignore any other
355
revisions that might be present. There is no direct replacement
358
if 'evil' in debug.debug_flags:
359
mutter_callsite(2, "all_revision_ids is linear with history.")
360
return self._all_revision_ids()
362
def _all_revision_ids(self):
363
"""Returns a list of all the revision ids in the repository.
365
These are in as much topological order as the underlying store can
368
raise NotImplementedError(self._all_revision_ids)
370
def break_lock(self):
371
"""Break a lock if one is present from another instance.
373
Uses the ui factory to ask for confirmation if the lock may be from
376
self.control_files.break_lock()
379
def create(controldir):
380
"""Construct the current default format repository in controldir."""
381
return RepositoryFormat.get_default_format().initialize(controldir)
383
def __init__(self, _format, controldir, control_files):
384
"""instantiate a Repository.
386
:param _format: The format of the repository on disk.
387
:param controldir: The ControlDir of the repository.
388
:param control_files: Control files to use for locking, etc.
390
# In the future we will have a single api for all stores for
391
# getting file texts, inventories and revisions, then
392
# this construct will accept instances of those things.
393
super(Repository, self).__init__()
394
self._format = _format
395
# the following are part of the public API for Repository:
396
self.controldir = controldir
397
self.control_files = control_files
399
self._write_group = None
400
# Additional places to query for data.
401
self._fallback_repositories = []
404
def user_transport(self):
405
return self.controldir.user_transport
408
def control_transport(self):
409
return self._transport
412
if self._fallback_repositories:
413
return '%s(%r, fallback_repositories=%r)' % (
414
self.__class__.__name__,
416
self._fallback_repositories)
418
return '%s(%r)' % (self.__class__.__name__,
421
def _has_same_fallbacks(self, other_repo):
422
"""Returns true if the repositories have the same fallbacks."""
423
my_fb = self._fallback_repositories
424
other_fb = other_repo._fallback_repositories
425
if len(my_fb) != len(other_fb):
427
for f, g in zip(my_fb, other_fb):
428
if not f.has_same_location(g):
432
def has_same_location(self, other):
433
"""Returns a boolean indicating if this repository is at the same
434
location as another repository.
436
This might return False even when two repository objects are accessing
437
the same physical repository via different URLs.
439
if self.__class__ is not other.__class__:
441
return (self.control_url == other.control_url)
443
def is_in_write_group(self):
444
"""Return True if there is an open write group.
446
:seealso: start_write_group.
448
return self._write_group is not None
451
return self.control_files.is_locked()
453
def is_write_locked(self):
454
"""Return True if this object is write locked."""
455
return self.is_locked() and self.control_files._lock_mode == 'w'
457
def lock_write(self, token=None):
458
"""Lock this repository for writing.
460
This causes caching within the repository obejct to start accumlating
461
data during reads, and allows a 'write_group' to be obtained. Write
462
groups must be used for actual data insertion.
464
A token should be passed in if you know that you have locked the object
465
some other way, and need to synchronise this object's state with that
468
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
470
:param token: if this is already locked, then lock_write will fail
471
unless the token matches the existing lock.
472
:returns: a token if this instance supports tokens, otherwise None.
473
:raises TokenLockingNotSupported: when a token is given but this
474
instance doesn't support using token locks.
475
:raises MismatchedToken: if the specified token doesn't match the token
476
of the existing lock.
477
:seealso: start_write_group.
478
:return: A RepositoryWriteLockResult.
480
locked = self.is_locked()
481
token = self.control_files.lock_write(token=token)
483
self._warn_if_deprecated()
485
for repo in self._fallback_repositories:
486
# Writes don't affect fallback repos
489
return RepositoryWriteLockResult(self.unlock, token)
492
"""Lock the repository for read operations.
494
:return: An object with an unlock method which will release the lock
497
locked = self.is_locked()
498
self.control_files.lock_read()
500
self._warn_if_deprecated()
502
for repo in self._fallback_repositories:
505
return LogicalLockResult(self.unlock)
507
def get_physical_lock_status(self):
508
return self.control_files.get_physical_lock_status()
510
def leave_lock_in_place(self):
511
"""Tell this repository not to release the physical lock when this
514
If lock_write doesn't return a token, then this method is not supported.
516
self.control_files.leave_in_place()
518
def dont_leave_lock_in_place(self):
519
"""Tell this repository to release the physical lock when this
520
object is unlocked, even if it didn't originally acquire it.
522
If lock_write doesn't return a token, then this method is not supported.
524
self.control_files.dont_leave_in_place()
526
def gather_stats(self, revid=None, committers=None):
527
"""Gather statistics from a revision id.
529
:param revid: The revision id to gather statistics from, if None, then
530
no revision specific statistics are gathered.
531
:param committers: Optional parameter controlling whether to grab
532
a count of committers from the revision specific statistics.
533
:return: A dictionary of statistics. Currently this contains:
534
committers: The number of committers if requested.
535
firstrev: A tuple with timestamp, timezone for the penultimate left
536
most ancestor of revid, if revid is not the NULL_REVISION.
537
latestrev: A tuple with timestamp, timezone for revid, if revid is
538
not the NULL_REVISION.
539
revisions: The total revision count in the repository.
540
size: An estimate disk size of the repository in bytes.
542
with self.lock_read():
544
if revid and committers:
545
result['committers'] = 0
546
if revid and revid != _mod_revision.NULL_REVISION:
547
graph = self.get_graph()
549
all_committers = set()
550
revisions = [r for (r, p) in graph.iter_ancestry([revid])
551
if r != _mod_revision.NULL_REVISION]
554
# ignore the revisions in the middle - just grab first and last
555
revisions = revisions[0], revisions[-1]
556
for revision in self.get_revisions(revisions):
557
if not last_revision:
558
last_revision = revision
560
all_committers.add(revision.committer)
561
first_revision = revision
563
result['committers'] = len(all_committers)
564
result['firstrev'] = (first_revision.timestamp,
565
first_revision.timezone)
566
result['latestrev'] = (last_revision.timestamp,
567
last_revision.timezone)
570
def find_branches(self, using=False):
571
"""Find branches underneath this repository.
573
This will include branches inside other branches.
575
:param using: If True, list only branches using this repository.
577
if using and not self.is_shared():
578
for branch in self.controldir.list_branches():
582
class Evaluator(object):
585
self.first_call = True
587
def __call__(self, controldir):
588
# On the first call, the parameter is always the controldir
589
# containing the current repo.
590
if not self.first_call:
592
repository = controldir.open_repository()
593
except errors.NoRepositoryPresent:
596
return False, ([], repository)
597
self.first_call = False
598
value = (controldir.list_branches(), None)
601
for branches, repository in controldir.ControlDir.find_controldirs(
602
self.user_transport, evaluate=Evaluator()):
603
if branches is not None:
604
for branch in branches:
606
if not using and repository is not None:
607
for branch in repository.find_branches():
610
def search_missing_revision_ids(self, other,
611
find_ghosts=True, revision_ids=None, if_present_ids=None,
613
"""Return the revision ids that other has that this does not.
615
These are returned in topological order.
617
revision_ids: only return revision ids included by revision_id.
619
with self.lock_read():
620
return InterRepository.get(other, self).search_missing_revision_ids(
621
find_ghosts=find_ghosts, revision_ids=revision_ids,
622
if_present_ids=if_present_ids, limit=limit)
626
"""Open the repository rooted at base.
628
For instance, if the repository is at URL/.bzr/repository,
629
Repository.open(URL) -> a Repository instance.
631
control = controldir.ControlDir.open(base)
632
return control.open_repository()
634
def copy_content_into(self, destination, revision_id=None):
635
"""Make a complete copy of the content in self into destination.
637
This is a destructive operation! Do not use it on existing
640
return InterRepository.get(self, destination).copy_content(revision_id)
642
def commit_write_group(self):
643
"""Commit the contents accrued within the current write group.
645
:seealso: start_write_group.
647
:return: it may return an opaque hint that can be passed to 'pack'.
649
if self._write_group is not self.get_transaction():
650
# has an unlock or relock occured ?
651
raise errors.BzrError('mismatched lock context %r and '
653
(self.get_transaction(), self._write_group))
654
result = self._commit_write_group()
655
self._write_group = None
658
def _commit_write_group(self):
659
"""Template method for per-repository write group cleanup.
661
This is called before the write group is considered to be
662
finished and should ensure that all data handed to the repository
663
for writing during the write group is safely committed (to the
664
extent possible considering file system caching etc).
667
def suspend_write_group(self):
668
"""Suspend a write group.
670
:raise UnsuspendableWriteGroup: If the write group can not be
672
:return: List of tokens
674
raise errors.UnsuspendableWriteGroup(self)
676
def refresh_data(self):
677
"""Re-read any data needed to synchronise with disk.
679
This method is intended to be called after another repository instance
680
(such as one used by a smart server) has inserted data into the
681
repository. On all repositories this will work outside of write groups.
682
Some repository formats (pack and newer for breezy native formats)
683
support refresh_data inside write groups. If called inside a write
684
group on a repository that does not support refreshing in a write group
685
IsInWriteGroupError will be raised.
689
def resume_write_group(self, tokens):
690
if not self.is_write_locked():
691
raise errors.NotWriteLocked(self)
692
if self._write_group:
693
raise errors.BzrError('already in a write group')
694
self._resume_write_group(tokens)
695
# so we can detect unlock/relock - the write group is now entered.
696
self._write_group = self.get_transaction()
698
def _resume_write_group(self, tokens):
699
raise errors.UnsuspendableWriteGroup(self)
701
def fetch(self, source, revision_id=None, find_ghosts=False, lossy=False):
702
"""Fetch the content required to construct revision_id from source.
704
If revision_id is None, then all content is copied.
706
fetch() may not be used when the repository is in a write group -
707
either finish the current write group before using fetch, or use
708
fetch before starting the write group.
710
:param find_ghosts: Find and copy revisions in the source that are
711
ghosts in the target (and not reachable directly by walking out to
712
the first-present revision in target from revision_id).
713
:param revision_id: If specified, all the content needed for this
714
revision ID will be copied to the target. Fetch will determine for
715
itself which content needs to be copied.
716
:return: A FetchResult object
718
if self.is_in_write_group():
719
raise errors.InternalBzrError(
720
"May not fetch while in a write group.")
721
# fast path same-url fetch operations
722
# TODO: lift out to somewhere common with RemoteRepository
723
# <https://bugs.launchpad.net/bzr/+bug/401646>
724
if (self.has_same_location(source)
725
and self._has_same_fallbacks(source)):
726
# check that last_revision is in 'from' and then return a
728
if (revision_id is not None and
729
not _mod_revision.is_null(revision_id)):
730
self.get_revision(revision_id)
732
inter = InterRepository.get(source, self)
734
revision_id=revision_id, find_ghosts=find_ghosts, lossy=lossy)
736
def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
737
timezone=None, committer=None, revprops=None,
738
revision_id=None, lossy=False):
739
"""Obtain a CommitBuilder for this repository.
741
:param branch: Branch to commit to.
742
:param parents: Revision ids of the parents of the new revision.
743
:param config_stack: Configuration stack to use.
744
:param timestamp: Optional timestamp recorded for commit.
745
:param timezone: Optional timezone for timestamp.
746
:param committer: Optional committer to set for commit.
747
:param revprops: Optional dictionary of revision properties.
748
:param revision_id: Optional revision id.
749
:param lossy: Whether to discard data that can not be natively
750
represented, when pushing to a foreign VCS
752
raise NotImplementedError(self.get_commit_builder)
754
@only_raises(errors.LockNotHeld, errors.LockBroken)
756
if (self.control_files._lock_count == 1 and
757
self.control_files._lock_mode == 'w'):
758
if self._write_group is not None:
759
self.abort_write_group()
760
self.control_files.unlock()
761
raise errors.BzrError(
762
'Must end write groups before releasing write locks.')
763
self.control_files.unlock()
764
if self.control_files._lock_count == 0:
765
for repo in self._fallback_repositories:
768
def clone(self, controldir, revision_id=None):
769
"""Clone this repository into controldir using the current format.
771
Currently no check is made that the format of this repository and
772
the bzrdir format are compatible. FIXME RBC 20060201.
774
:return: The newly created destination repository.
776
with self.lock_read():
777
# TODO: deprecate after 0.16; cloning this with all its settings is
778
# probably not very useful -- mbp 20070423
779
dest_repo = self._create_sprouting_repo(
780
controldir, shared=self.is_shared())
781
self.copy_content_into(dest_repo, revision_id)
784
def start_write_group(self):
785
"""Start a write group in the repository.
787
Write groups are used by repositories which do not have a 1:1 mapping
788
between file ids and backend store to manage the insertion of data from
789
both fetch and commit operations.
791
A write lock is required around the
792
start_write_group/commit_write_group for the support of lock-requiring
795
One can only insert data into a repository inside a write group.
799
if not self.is_write_locked():
800
raise errors.NotWriteLocked(self)
801
if self._write_group:
802
raise errors.BzrError('already in a write group')
803
self._start_write_group()
804
# so we can detect unlock/relock - the write group is now entered.
805
self._write_group = self.get_transaction()
807
def _start_write_group(self):
808
"""Template method for per-repository write group startup.
810
This is called before the write group is considered to be
814
def sprout(self, to_bzrdir, revision_id=None):
815
"""Create a descendent repository for new development.
817
Unlike clone, this does not copy the settings of the repository.
819
with self.lock_read():
820
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
821
dest_repo.fetch(self, revision_id=revision_id)
824
def _create_sprouting_repo(self, a_controldir, shared):
826
a_controldir._format, self.controldir._format.__class__):
827
# use target default format.
828
dest_repo = a_controldir.create_repository()
830
# Most control formats need the repository to be specifically
831
# created, but on some old all-in-one formats it's not needed
833
dest_repo = self._format.initialize(
834
a_controldir, shared=shared)
835
except errors.UninitializableFormat:
836
dest_repo = a_controldir.open_repository()
839
def has_revision(self, revision_id):
840
"""True if this repository has a copy of the revision."""
841
with self.lock_read():
842
return revision_id in self.has_revisions((revision_id,))
844
def has_revisions(self, revision_ids):
845
"""Probe to find out the presence of multiple revisions.
847
:param revision_ids: An iterable of revision_ids.
848
:return: A set of the revision_ids that were present.
850
raise NotImplementedError(self.has_revisions)
852
def get_revision(self, revision_id):
853
"""Return the Revision object for a named revision."""
854
with self.lock_read():
855
return self.get_revisions([revision_id])[0]
857
def get_revision_reconcile(self, revision_id):
858
"""'reconcile' helper routine that allows access to a revision always.
860
This variant of get_revision does not cross check the weave graph
861
against the revision one as get_revision does: but it should only
862
be used by reconcile, or reconcile-alike commands that are correcting
863
or testing the revision graph.
865
raise NotImplementedError(self.get_revision_reconcile)
867
def get_revisions(self, revision_ids):
868
"""Get many revisions at once.
870
Repositories that need to check data on every revision read should
871
subclass this method.
874
for revid, rev in self.iter_revisions(revision_ids):
876
raise errors.NoSuchRevision(self, revid)
878
return [revs[revid] for revid in revision_ids]
880
def iter_revisions(self, revision_ids):
881
"""Iterate over revision objects.
883
:param revision_ids: An iterable of revisions to examine. None may be
884
passed to request all revisions known to the repository. Note that
885
not all repositories can find unreferenced revisions; for those
886
repositories only referenced ones will be returned.
887
:return: An iterator of (revid, revision) tuples. Absent revisions (
888
those asked for but not available) are returned as (revid, None).
889
N.B.: Revisions are not necessarily yielded in order.
891
raise NotImplementedError(self.iter_revisions)
893
def get_revision_delta(self, revision_id):
894
"""Return the delta for one revision.
896
The delta is relative to the left-hand predecessor of the
899
with self.lock_read():
900
r = self.get_revision(revision_id)
901
return list(self.get_revision_deltas([r]))[0]
903
def get_revision_deltas(self, revisions, specific_files=None):
904
"""Produce a generator of revision deltas.
906
Note that the input is a sequence of REVISIONS, not revision ids.
907
Trees will be held in memory until the generator exits.
908
Each delta is relative to the revision's lefthand predecessor.
910
specific_files should exist in the first revision.
912
:param specific_files: if not None, the result is filtered
913
so that only those files, their parents and their
914
children are included.
916
from .tree import InterTree
917
# Get the revision-ids of interest
918
required_trees = set()
919
for revision in revisions:
920
required_trees.add(revision.revision_id)
921
required_trees.update(revision.parent_ids[:1])
924
t.get_revision_id(): t
925
for t in self.revision_trees(required_trees)}
927
# Calculate the deltas
928
for revision in revisions:
929
if not revision.parent_ids:
930
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
932
old_tree = trees[revision.parent_ids[0]]
933
intertree = InterTree.get(old_tree, trees[revision.revision_id])
934
yield intertree.compare(specific_files=specific_files)
935
if specific_files is not None:
937
p for p in intertree.find_source_paths(
938
specific_files).values()
941
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
942
raise NotImplementedError(self.store_revision_signature)
944
def add_signature_text(self, revision_id, signature):
945
"""Store a signature text for a revision.
947
:param revision_id: Revision id of the revision
948
:param signature: Signature text.
950
raise NotImplementedError(self.add_signature_text)
952
def iter_files_bytes(self, desired_files):
953
"""Iterate through file versions.
955
Files will not necessarily be returned in the order they occur in
956
desired_files. No specific order is guaranteed.
958
Yields pairs of identifier, bytes_iterator. identifier is an opaque
959
value supplied by the caller as part of desired_files. It should
960
uniquely identify the file version in the caller's context. (Examples:
961
an index number or a TreeTransform trans_id.)
963
:param desired_files: a list of (file_id, revision_id, identifier)
966
raise NotImplementedError(self.iter_files_bytes)
968
def get_rev_id_for_revno(self, revno, known_pair):
969
"""Return the revision id of a revno, given a later (revno, revid)
970
pair in the same history.
972
:return: if found (True, revid). If the available history ran out
973
before reaching the revno, then this returns
974
(False, (closest_revno, closest_revid)).
976
known_revno, known_revid = known_pair
977
partial_history = [known_revid]
978
distance_from_known = known_revno - revno
979
if distance_from_known < 0:
980
raise errors.RevnoOutOfBounds(revno, (0, known_revno))
983
self, partial_history, stop_index=distance_from_known)
984
except errors.RevisionNotPresent as err:
985
if err.revision_id == known_revid:
986
# The start revision (known_revid) wasn't found.
987
raise errors.NoSuchRevision(self, known_revid)
988
# This is a stacked repository with no fallbacks, or a there's a
989
# left-hand ghost. Either way, even though the revision named in
990
# the error isn't in this repo, we know it's the next step in this
992
partial_history.append(err.revision_id)
993
if len(partial_history) <= distance_from_known:
994
# Didn't find enough history to get a revid for the revno.
995
earliest_revno = known_revno - len(partial_history) + 1
996
return (False, (earliest_revno, partial_history[-1]))
997
if len(partial_history) - 1 > distance_from_known:
998
raise AssertionError('_iter_for_revno returned too much history')
999
return (True, partial_history[-1])
1001
def is_shared(self):
1002
"""Return True if this repository is flagged as a shared repository."""
1003
raise NotImplementedError(self.is_shared)
1005
def reconcile(self, other=None, thorough=False):
1006
"""Reconcile this repository."""
1007
raise NotImplementedError(self.reconcile)
1009
def _refresh_data(self):
1010
"""Helper called from lock_* to ensure coherency with disk.
1012
The default implementation does nothing; it is however possible
1013
for repositories to maintain loaded indices across multiple locks
1014
by checking inside their implementation of this method to see
1015
whether their indices are still valid. This depends of course on
1016
the disk format being validatable in this manner. This method is
1017
also called by the refresh_data() public interface to cause a refresh
1018
to occur while in a write lock so that data inserted by a smart server
1019
push operation is visible on the client's instance of the physical
1023
def revision_tree(self, revision_id):
1024
"""Return Tree for a revision on this branch.
1026
`revision_id` may be NULL_REVISION for the empty tree revision.
1028
raise NotImplementedError(self.revision_tree)
1030
def revision_trees(self, revision_ids):
1031
"""Return Trees for revisions in this repository.
1033
:param revision_ids: a sequence of revision-ids;
1034
a revision-id may not be None or b'null:'
1036
raise NotImplementedError(self.revision_trees)
1038
def pack(self, hint=None, clean_obsolete_packs=False):
1039
"""Compress the data within the repository.
1041
This operation only makes sense for some repository types. For other
1042
types it should be a no-op that just returns.
1044
This stub method does not require a lock, but subclasses should use
1045
self.write_lock as this is a long running call it's reasonable to
1046
implicitly lock for the user.
1048
:param hint: If not supplied, the whole repository is packed.
1049
If supplied, the repository may use the hint parameter as a
1050
hint for the parts of the repository to pack. A hint can be
1051
obtained from the result of commit_write_group(). Out of
1052
date hints are simply ignored, because concurrent operations
1053
can obsolete them rapidly.
1055
:param clean_obsolete_packs: Clean obsolete packs immediately after
1059
def get_transaction(self):
1060
return self.control_files.get_transaction()
1062
def get_parent_map(self, revision_ids):
1063
"""See graph.StackedParentsProvider.get_parent_map"""
1064
raise NotImplementedError(self.get_parent_map)
1066
def _get_parent_map_no_fallbacks(self, revision_ids):
1067
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1068
# revisions index works in keys; this just works in revisions
1069
# therefore wrap and unwrap
1072
for revision_id in revision_ids:
1073
if revision_id == _mod_revision.NULL_REVISION:
1074
result[revision_id] = ()
1075
elif revision_id is None:
1076
raise ValueError('get_parent_map(None) is not valid')
1078
query_keys.append((revision_id,))
1079
vf = self.revisions.without_fallbacks()
1080
for (revision_id,), parent_keys in viewitems(
1081
vf.get_parent_map(query_keys)):
1083
result[revision_id] = tuple([parent_revid
1084
for (parent_revid,) in parent_keys])
1086
result[revision_id] = (_mod_revision.NULL_REVISION,)
1089
def _make_parents_provider(self):
1090
if not self._format.supports_external_lookups:
1092
return graph.StackedParentsProvider(_LazyListJoin(
1093
[self._make_parents_provider_unstacked()],
1094
self._fallback_repositories))
1096
def _make_parents_provider_unstacked(self):
1097
return graph.CallableToParentsProviderAdapter(
1098
self._get_parent_map_no_fallbacks)
1100
def get_known_graph_ancestry(self, revision_ids):
1101
"""Return the known graph for a set of revision ids and their ancestors.
1103
raise NotImplementedError(self.get_known_graph_ancestry)
1105
def get_file_graph(self):
1106
"""Return the graph walker for files."""
1107
raise NotImplementedError(self.get_file_graph)
1109
def get_graph(self, other_repository=None):
1110
"""Return the graph walker for this repository format"""
1111
parents_provider = self._make_parents_provider()
1112
if (other_repository is not None and
1113
not self.has_same_location(other_repository)):
1114
parents_provider = graph.StackedParentsProvider(
1115
[parents_provider, other_repository._make_parents_provider()])
1116
return graph.Graph(parents_provider)
1118
def set_make_working_trees(self, new_value):
1119
"""Set the policy flag for making working trees when creating branches.
1121
This only applies to branches that use this repository.
1123
The default is 'True'.
1124
:param new_value: True to restore the default, False to disable making
1127
raise NotImplementedError(self.set_make_working_trees)
1129
def make_working_trees(self):
1130
"""Returns the policy for making working trees on new branches."""
1131
raise NotImplementedError(self.make_working_trees)
1133
def sign_revision(self, revision_id, gpg_strategy):
1134
raise NotImplementedError(self.sign_revision)
1136
def verify_revision_signature(self, revision_id, gpg_strategy):
1137
"""Verify the signature on a revision.
1139
:param revision_id: the revision to verify
1140
:gpg_strategy: the GPGStrategy object to used
1142
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1144
raise NotImplementedError(self.verify_revision_signature)
1146
def verify_revision_signatures(self, revision_ids, gpg_strategy):
1147
"""Verify revision signatures for a number of revisions.
1149
:param revision_id: the revision to verify
1150
:gpg_strategy: the GPGStrategy object to used
1151
:return: Iterator over tuples with revision id, result and keys
1153
with self.lock_read():
1154
for revid in revision_ids:
1155
(result, key) = self.verify_revision_signature(revid, gpg_strategy)
1156
yield revid, result, key
1158
def has_signature_for_revision_id(self, revision_id):
1159
"""Query for a revision signature for revision_id in the repository."""
1160
raise NotImplementedError(self.has_signature_for_revision_id)
1162
def get_signature_text(self, revision_id):
1163
"""Return the text for a signature."""
1164
raise NotImplementedError(self.get_signature_text)
1166
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1167
"""Check consistency of all history of given revision_ids.
1169
Different repository implementations should override _check().
1171
:param revision_ids: A non-empty list of revision_ids whose ancestry
1172
will be checked. Typically the last revision_id of a branch.
1173
:param callback_refs: A dict of check-refs to resolve and callback
1174
the check/_check method on the items listed as wanting the ref.
1176
:param check_repo: If False do not check the repository contents, just
1177
calculate the data callback_refs requires and call them back.
1179
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1180
check_repo=check_repo)
1182
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1183
raise NotImplementedError(self.check)
1185
def _warn_if_deprecated(self, branch=None):
1186
if not self._format.is_deprecated():
1188
global _deprecation_warning_done
1189
if _deprecation_warning_done:
1193
conf = config.GlobalStack()
1195
conf = branch.get_config_stack()
1196
if 'format_deprecation' in conf.get('suppress_warnings'):
1198
warning("Format %s for %s is deprecated -"
1199
" please use 'brz upgrade' to get better performance"
1200
% (self._format, self.controldir.transport.base))
1202
_deprecation_warning_done = True
1204
def supports_rich_root(self):
1205
return self._format.rich_root_data
1207
def _check_ascii_revisionid(self, revision_id, method):
1208
"""Private helper for ascii-only repositories."""
1209
# weave repositories refuse to store revisionids that are non-ascii.
1210
if revision_id is not None:
1211
# weaves require ascii revision ids.
1212
if isinstance(revision_id, text_type):
1214
revision_id.encode('ascii')
1215
except UnicodeEncodeError:
1216
raise errors.NonAsciiRevisionId(method, self)
1219
revision_id.decode('ascii')
1220
except UnicodeDecodeError:
1221
raise errors.NonAsciiRevisionId(method, self)
1224
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1225
"""Repository format registry."""
1227
def get_default(self):
1228
"""Return the current default format."""
1229
return controldir.format_registry.make_controldir('default').repository_format
1232
network_format_registry = registry.FormatRegistry()
1233
"""Registry of formats indexed by their network name.
1235
The network name for a repository format is an identifier that can be used when
1236
referring to formats with smart server operations. See
1237
RepositoryFormat.network_name() for more detail.
1241
format_registry = RepositoryFormatRegistry(network_format_registry)
1242
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1244
This can contain either format instances themselves, or classes/factories that
1245
can be called to obtain one.
1249
#####################################################################
1250
# Repository Formats
1252
class RepositoryFormat(controldir.ControlComponentFormat):
1253
"""A repository format.
1255
Formats provide four things:
1256
* An initialization routine to construct repository data on disk.
1257
* a optional format string which is used when the BzrDir supports
1259
* an open routine which returns a Repository instance.
1260
* A network name for referring to the format in smart server RPC
1263
There is one and only one Format subclass for each on-disk format. But
1264
there can be one Repository subclass that is used for several different
1265
formats. The _format attribute on a Repository instance can be used to
1266
determine the disk format.
1268
Formats are placed in a registry by their format string for reference
1269
during opening. These should be subclasses of RepositoryFormat for
1272
Once a format is deprecated, just deprecate the initialize and open
1273
methods on the format class. Do not deprecate the object, as the
1274
object may be created even when a repository instance hasn't been
1277
Common instance attributes:
1278
_matchingcontroldir - the controldir format that the repository format was
1279
originally written to work with. This can be used if manually
1280
constructing a bzrdir and repository, or more commonly for test suite
1284
# Set to True or False in derived classes. True indicates that the format
1285
# supports ghosts gracefully.
1286
supports_ghosts = None
1287
# Can this repository be given external locations to lookup additional
1288
# data. Set to True or False in derived classes.
1289
supports_external_lookups = None
1290
# Does this format support CHK bytestring lookups. Set to True or False in
1292
supports_chks = None
1293
# Should fetch trigger a reconcile after the fetch? Only needed for
1294
# some repository formats that can suffer internal inconsistencies.
1295
_fetch_reconcile = False
1296
# Does this format have < O(tree_size) delta generation. Used to hint what
1297
# code path for commit, amongst other things.
1299
# Does doing a pack operation compress data? Useful for the pack UI command
1300
# (so if there is one pack, the operation can still proceed because it may
1301
# help), and for fetching when data won't have come from the same
1303
pack_compresses = False
1304
# Does the repository storage understand references to trees?
1305
supports_tree_reference = None
1306
# Is the format experimental ?
1307
experimental = False
1308
# Does this repository format escape funky characters, or does it create
1309
# files with similar names as the versioned files in its contents on disk
1311
supports_funky_characters = None
1312
# Does this repository format support leaving locks?
1313
supports_leaving_lock = None
1314
# Does this format support the full VersionedFiles interface?
1315
supports_full_versioned_files = None
1316
# Does this format support signing revision signatures?
1317
supports_revision_signatures = True
1318
# Can the revision graph have incorrect parents?
1319
revision_graph_can_have_wrong_parents = None
1320
# Does this format support setting revision ids?
1321
supports_setting_revision_ids = True
1322
# Does this format support rich root data?
1323
rich_root_data = None
1324
# Does this format support explicitly versioned directories?
1325
supports_versioned_directories = None
1326
# Can other repositories be nested into one of this format?
1327
supports_nesting_repositories = None
1328
# Is it possible for revisions to be present without being referenced
1330
supports_unreferenced_revisions = None
1331
# Does this format store the current Branch.nick in a revision when
1333
supports_storing_branch_nick = True
1334
# Does the format support overriding the transport to use
1335
supports_overriding_transport = True
1336
# Does the format support setting custom revision properties?
1337
supports_custom_revision_properties = True
1338
# Does the format record per-file revision metadata?
1339
records_per_file_revision = True
1342
return "%s()" % self.__class__.__name__
1344
def __eq__(self, other):
1345
# format objects are generally stateless
1346
return isinstance(other, self.__class__)
1348
def __ne__(self, other):
1349
return not self == other
1351
def get_format_description(self):
1352
"""Return the short description for this format."""
1353
raise NotImplementedError(self.get_format_description)
1355
def initialize(self, controldir, shared=False):
1356
"""Initialize a repository of this format in controldir.
1358
:param controldir: The controldir to put the new repository in it.
1359
:param shared: The repository should be initialized as a sharable one.
1360
:returns: The new repository object.
1362
This may raise UninitializableFormat if shared repository are not
1363
compatible the controldir.
1365
raise NotImplementedError(self.initialize)
1367
def is_supported(self):
1368
"""Is this format supported?
1370
Supported formats must be initializable and openable.
1371
Unsupported formats may not support initialization or committing or
1372
some other features depending on the reason for not being supported.
1376
def is_deprecated(self):
1377
"""Is this format deprecated?
1379
Deprecated formats may trigger a user-visible warning recommending
1380
the user to upgrade. They are still fully supported.
1384
def network_name(self):
1385
"""A simple byte string uniquely identifying this format for RPC calls.
1387
MetaDir repository formats use their disk format string to identify the
1388
repository over the wire. All in one formats such as bzr < 0.8, and
1389
foreign formats like svn/git and hg should use some marker which is
1390
unique and immutable.
1392
raise NotImplementedError(self.network_name)
1394
def check_conversion_target(self, target_format):
1395
if self.rich_root_data and not target_format.rich_root_data:
1396
raise errors.BadConversionTarget(
1397
'Does not support rich root data.', target_format,
1399
if (self.supports_tree_reference
1400
and not getattr(target_format, 'supports_tree_reference', False)):
1401
raise errors.BadConversionTarget(
1402
'Does not support nested trees', target_format,
1405
def open(self, controldir, _found=False):
1406
"""Return an instance of this format for a controldir.
1408
_found is a private parameter, do not use it.
1410
raise NotImplementedError(self.open)
1412
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1413
from .controldir import ControlDir, RepoInitHookParams
1414
hooks = ControlDir.hooks['post_repo_init']
1417
params = RepoInitHookParams(repository, self, controldir, shared)
1422
# formats which have no format string are not discoverable or independently
1423
# creatable on disk, so are not registered in format_registry. They're
1424
# all in breezy.bzr.knitreponow. When an instance of one of these is
1425
# needed, it's constructed directly by the ControlDir. Non-native formats where
1426
# the repository is not separately opened are similar.
1428
format_registry.register_lazy(
1429
b'Bazaar-NG Knit Repository Format 1',
1430
'breezy.bzr.knitrepo',
1431
'RepositoryFormatKnit1',
1434
format_registry.register_lazy(
1435
b'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1436
'breezy.bzr.knitrepo',
1437
'RepositoryFormatKnit3',
1440
format_registry.register_lazy(
1441
b'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1442
'breezy.bzr.knitrepo',
1443
'RepositoryFormatKnit4',
1446
# Pack-based formats. There is one format for pre-subtrees, and one for
1447
# post-subtrees to allow ease of testing.
1448
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1449
format_registry.register_lazy(
1450
b'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1451
'breezy.bzr.knitpack_repo',
1452
'RepositoryFormatKnitPack1',
1454
format_registry.register_lazy(
1455
b'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1456
'breezy.bzr.knitpack_repo',
1457
'RepositoryFormatKnitPack3',
1459
format_registry.register_lazy(
1460
b'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1461
'breezy.bzr.knitpack_repo',
1462
'RepositoryFormatKnitPack4',
1464
format_registry.register_lazy(
1465
b'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1466
'breezy.bzr.knitpack_repo',
1467
'RepositoryFormatKnitPack5',
1469
format_registry.register_lazy(
1470
b'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1471
'breezy.bzr.knitpack_repo',
1472
'RepositoryFormatKnitPack5RichRoot',
1474
format_registry.register_lazy(
1475
b'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1476
'breezy.bzr.knitpack_repo',
1477
'RepositoryFormatKnitPack5RichRootBroken',
1479
format_registry.register_lazy(
1480
b'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1481
'breezy.bzr.knitpack_repo',
1482
'RepositoryFormatKnitPack6',
1484
format_registry.register_lazy(
1485
b'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1486
'breezy.bzr.knitpack_repo',
1487
'RepositoryFormatKnitPack6RichRoot',
1489
format_registry.register_lazy(
1490
b'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1491
'breezy.bzr.groupcompress_repo',
1492
'RepositoryFormat2a',
1495
# Development formats.
1496
# Check their docstrings to see if/when they are obsolete.
1497
format_registry.register_lazy(
1498
(b"Bazaar development format 2 with subtree support "
1499
b"(needs bzr.dev from before 1.8)\n"),
1500
'breezy.bzr.knitpack_repo',
1501
'RepositoryFormatPackDevelopment2Subtree',
1503
format_registry.register_lazy(
1504
b'Bazaar development format 8\n',
1505
'breezy.bzr.groupcompress_repo',
1506
'RepositoryFormat2aSubtree',
1510
class InterRepository(InterObject):
1511
"""This class represents operations taking place between two repositories.
1513
Its instances have methods like copy_content and fetch, and contain
1514
references to the source and target repositories these operations can be
1517
Often we will provide convenience methods on 'repository' which carry out
1518
operations with another repository - they will always forward to
1519
InterRepository.get(other).method_name(parameters).
1523
"""The available optimised InterRepository types."""
1525
def copy_content(self, revision_id=None):
1526
"""Make a complete copy of the content in self into destination.
1528
This is a destructive operation! Do not use it on existing
1531
:param revision_id: Only copy the content needed to construct
1532
revision_id and its parents.
1534
with self.lock_write():
1536
self.target.set_make_working_trees(
1537
self.source.make_working_trees())
1538
except (NotImplementedError, errors.RepositoryUpgradeRequired):
1540
self.target.fetch(self.source, revision_id=revision_id)
1542
def fetch(self, revision_id=None, find_ghosts=False, lossy=False):
1543
"""Fetch the content required to construct revision_id.
1545
The content is copied from self.source to self.target.
1547
:param revision_id: if None all content is copied, if NULL_REVISION no
1549
:return: FetchResult
1551
raise NotImplementedError(self.fetch)
1553
def search_missing_revision_ids(
1554
self, find_ghosts=True, revision_ids=None, if_present_ids=None,
1556
"""Return the revision ids that source has that target does not.
1558
:param revision_ids: return revision ids included by these
1559
revision_ids. NoSuchRevision will be raised if any of these
1560
revisions are not present.
1561
:param if_present_ids: like revision_ids, but will not cause
1562
NoSuchRevision if any of these are absent, instead they will simply
1563
not be in the result. This is useful for e.g. finding revisions
1564
to fetch for tags, which may reference absent revisions.
1565
:param find_ghosts: If True find missing revisions in deep history
1566
rather than just finding the surface difference.
1567
:param limit: Maximum number of revisions to return, topologically
1569
:return: A breezy.graph.SearchResult.
1571
raise NotImplementedError(self.search_missing_revision_ids)
1574
def _same_model(source, target):
1575
"""True if source and target have the same data representation.
1577
Note: this is always called on the base class; overriding it in a
1578
subclass will have no effect.
1581
InterRepository._assert_same_model(source, target)
1583
except errors.IncompatibleRepositories as e:
1587
def _assert_same_model(source, target):
1588
"""Raise an exception if two repositories do not use the same model.
1590
if source.supports_rich_root() != target.supports_rich_root():
1591
raise errors.IncompatibleRepositories(source, target,
1592
"different rich-root support")
1593
if source._serializer != target._serializer:
1594
raise errors.IncompatibleRepositories(source, target,
1595
"different serializers")
1598
class CopyConverter(object):
1599
"""A repository conversion tool which just performs a copy of the content.
1601
This is slow but quite reliable.
1604
def __init__(self, target_format):
1605
"""Create a CopyConverter.
1607
:param target_format: The format the resulting repository should be.
1609
self.target_format = target_format
1611
def convert(self, repo, pb):
1612
"""Perform the conversion of to_convert, giving feedback via pb.
1614
:param to_convert: The disk object to convert.
1615
:param pb: a progress bar to use for progress information.
1617
with ui.ui_factory.nested_progress_bar() as pb:
1620
# this is only useful with metadir layouts - separated repo content.
1621
# trigger an assertion if not such
1622
repo._format.get_format_string()
1623
self.repo_dir = repo.controldir
1624
pb.update(gettext('Moving repository to repository.backup'))
1625
self.repo_dir.transport.move('repository', 'repository.backup')
1626
backup_transport = self.repo_dir.transport.clone(
1627
'repository.backup')
1628
repo._format.check_conversion_target(self.target_format)
1629
self.source_repo = repo._format.open(self.repo_dir,
1631
_override_transport=backup_transport)
1632
pb.update(gettext('Creating new repository'))
1633
converted = self.target_format.initialize(self.repo_dir,
1634
self.source_repo.is_shared())
1635
with converted.lock_write():
1636
pb.update(gettext('Copying content'))
1637
self.source_repo.copy_content_into(converted)
1638
pb.update(gettext('Deleting old repository content'))
1639
self.repo_dir.transport.delete_tree('repository.backup')
1640
ui.ui_factory.note(gettext('repository converted'))
1643
def _strip_NULL_ghosts(revision_graph):
1644
"""Also don't use this. more compatibility code for unmigrated clients."""
1645
# Filter ghosts, and null:
1646
if _mod_revision.NULL_REVISION in revision_graph:
1647
del revision_graph[_mod_revision.NULL_REVISION]
1648
for key, parents in viewitems(revision_graph):
1649
revision_graph[key] = tuple(parent for parent in parents if parent
1651
return revision_graph
1654
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1655
stop_revision=None):
1656
"""Extend the partial history to include a given index
1658
If a stop_index is supplied, stop when that index has been reached.
1659
If a stop_revision is supplied, stop when that revision is
1660
encountered. Otherwise, stop when the beginning of history is
1663
:param stop_index: The index which should be present. When it is
1664
present, history extension will stop.
1665
:param stop_revision: The revision id which should be present. When
1666
it is encountered, history extension will stop.
1668
start_revision = partial_history_cache[-1]
1669
graph = repo.get_graph()
1670
iterator = graph.iter_lefthand_ancestry(start_revision,
1671
(_mod_revision.NULL_REVISION,))
1673
# skip the last revision in the list
1676
if (stop_index is not None and
1677
len(partial_history_cache) > stop_index):
1679
if partial_history_cache[-1] == stop_revision:
1681
revision_id = next(iterator)
1682
partial_history_cache.append(revision_id)
1683
except StopIteration:
1688
class _LazyListJoin(object):
1689
"""An iterable yielding the contents of many lists as one list.
1691
Each iterator made from this will reflect the current contents of the lists
1692
at the time the iterator is made.
1694
This is used by Repository's _make_parents_provider implementation so that
1697
pp = repo._make_parents_provider() # uses a list of fallback repos
1698
pp.add_fallback_repository(other_repo) # appends to that list
1699
result = pp.get_parent_map(...)
1700
# The result will include revs from other_repo
1703
def __init__(self, *list_parts):
1704
self.list_parts = list_parts
1708
for list_part in self.list_parts:
1709
full_list.extend(list_part)
1710
return iter(full_list)
1713
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,