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 bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
32
revision as _mod_revision,
33
testament as _mod_testament,
37
from bzrlib.bundle import serializer
38
from bzrlib.i18n import gettext
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
48
from bzrlib.inter import InterObject
49
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
50
from bzrlib.trace import (
51
log_exception_quietly, note, mutter, mutter_callsite, warning)
54
# Old formats display a warning, but only once
55
_deprecation_warning_done = False
58
class IsInWriteGroupError(errors.InternalBzrError):
60
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
62
def __init__(self, repo):
63
errors.InternalBzrError.__init__(self, repo=repo)
66
class CommitBuilder(object):
67
"""Provides an interface to build up a commit.
69
This allows describing a tree to be committed without needing to
70
know the internals of the format of the repository.
73
# all clients should supply tree roots.
74
record_root_entry = True
75
# whether this commit builder supports the record_entry_contents interface
76
supports_record_entry_contents = False
77
# whether this commit builder will automatically update the branch that is
79
updates_branch = False
81
def __init__(self, repository, parents, config, timestamp=None,
82
timezone=None, committer=None, revprops=None,
83
revision_id=None, lossy=False):
84
"""Initiate a CommitBuilder.
86
:param repository: Repository to commit to.
87
:param parents: Revision ids of the parents of the new revision.
88
:param timestamp: Optional timestamp recorded for commit.
89
:param timezone: Optional timezone for timestamp.
90
:param committer: Optional committer to set for commit.
91
:param revprops: Optional dictionary of revision properties.
92
:param revision_id: Optional revision id.
93
:param lossy: Whether to discard data that can not be natively
94
represented, when pushing to a foreign VCS
100
self._committer = self._config.username()
101
elif not isinstance(committer, unicode):
102
self._committer = committer.decode() # throw if non-ascii
104
self._committer = committer
106
self._new_revision_id = revision_id
107
self.parents = parents
108
self.repository = repository
111
if revprops is not None:
112
self._validate_revprops(revprops)
113
self._revprops.update(revprops)
115
if timestamp is None:
116
timestamp = time.time()
117
# Restrict resolution to 1ms
118
self._timestamp = round(timestamp, 3)
121
self._timezone = osutils.local_time_offset()
123
self._timezone = int(timezone)
125
self._generate_revision_if_needed()
127
def any_changes(self):
128
"""Return True if any entries were changed.
130
This includes merge-only changes. It is the core for the --unchanged
133
:return: True if any changes have occured.
135
raise NotImplementedError(self.any_changes)
137
def _validate_unicode_text(self, text, context):
138
"""Verify things like commit messages don't have bogus characters."""
140
raise ValueError('Invalid value for %s: %r' % (context, text))
142
def _validate_revprops(self, revprops):
143
for key, value in revprops.iteritems():
144
# We know that the XML serializers do not round trip '\r'
145
# correctly, so refuse to accept them
146
if not isinstance(value, basestring):
147
raise ValueError('revision property (%s) is not a valid'
148
' (unicode) string: %r' % (key, value))
149
self._validate_unicode_text(value,
150
'revision property (%s)' % (key,))
152
def commit(self, message):
153
"""Make the actual commit.
155
:return: The revision id of the recorded revision.
157
raise NotImplementedError(self.commit)
160
"""Abort the commit that is being built.
162
raise NotImplementedError(self.abort)
164
def revision_tree(self):
165
"""Return the tree that was just committed.
167
After calling commit() this can be called to get a
168
RevisionTree representing the newly committed tree. This is
169
preferred to calling Repository.revision_tree() because that may
170
require deserializing the inventory, while we already have a copy in
173
raise NotImplementedError(self.revision_tree)
175
def finish_inventory(self):
176
"""Tell the builder that the inventory is finished.
178
:return: The inventory id in the repository, which can be used with
179
repository.get_inventory.
181
raise NotImplementedError(self.finish_inventory)
183
def _gen_revision_id(self):
184
"""Return new revision-id."""
185
return generate_ids.gen_revision_id(self._committer, self._timestamp)
187
def _generate_revision_if_needed(self):
188
"""Create a revision id if None was supplied.
190
If the repository can not support user-specified revision ids
191
they should override this function and raise CannotSetRevisionId
192
if _new_revision_id is not None.
194
:raises: CannotSetRevisionId
196
if self._new_revision_id is None:
197
self._new_revision_id = self._gen_revision_id()
198
self.random_revid = True
200
self.random_revid = False
202
def will_record_deletes(self):
203
"""Tell the commit builder that deletes are being notified.
205
This enables the accumulation of an inventory delta; for the resulting
206
commit to be valid, deletes against the basis MUST be recorded via
207
builder.record_delete().
209
raise NotImplementedError(self.will_record_deletes)
211
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
212
"""Record a new tree via iter_changes.
214
:param tree: The tree to obtain text contents from for changed objects.
215
:param basis_revision_id: The revision id of the tree the iter_changes
216
has been generated against. Currently assumed to be the same
217
as self.parents[0] - if it is not, errors may occur.
218
:param iter_changes: An iter_changes iterator with the changes to apply
219
to basis_revision_id. The iterator must not include any items with
220
a current kind of None - missing items must be either filtered out
221
or errored-on beefore record_iter_changes sees the item.
222
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
225
raise NotImplementedError(self.record_iter_changes)
228
class RepositoryWriteLockResult(LogicalLockResult):
229
"""The result of write locking a repository.
231
:ivar repository_token: The token obtained from the underlying lock, or
233
:ivar unlock: A callable which will unlock the lock.
236
def __init__(self, unlock, repository_token):
237
LogicalLockResult.__init__(self, unlock)
238
self.repository_token = repository_token
241
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
245
######################################################################
249
class Repository(_RelockDebugMixin, controldir.ControlComponent):
250
"""Repository holding history for one or more branches.
252
The repository holds and retrieves historical information including
253
revisions and file history. It's normally accessed only by the Branch,
254
which views a particular line of development through that history.
256
See VersionedFileRepository in bzrlib.vf_repository for the
257
base class for most Bazaar repositories.
260
def abort_write_group(self, suppress_errors=False):
261
"""Commit the contents accrued within the current write group.
263
:param suppress_errors: if true, abort_write_group will catch and log
264
unexpected errors that happen during the abort, rather than
265
allowing them to propagate. Defaults to False.
267
:seealso: start_write_group.
269
if self._write_group is not self.get_transaction():
270
# has an unlock or relock occured ?
273
'(suppressed) mismatched lock context and write group. %r, %r',
274
self._write_group, self.get_transaction())
276
raise errors.BzrError(
277
'mismatched lock context and write group. %r, %r' %
278
(self._write_group, self.get_transaction()))
280
self._abort_write_group()
281
except Exception, exc:
282
self._write_group = None
283
if not suppress_errors:
285
mutter('abort_write_group failed')
286
log_exception_quietly()
287
note(gettext('bzr: ERROR (ignored): %s'), exc)
288
self._write_group = None
290
def _abort_write_group(self):
291
"""Template method for per-repository write group cleanup.
293
This is called during abort before the write group is considered to be
294
finished and should cleanup any internal state accrued during the write
295
group. There is no requirement that data handed to the repository be
296
*not* made available - this is not a rollback - but neither should any
297
attempt be made to ensure that data added is fully commited. Abort is
298
invoked when an error has occured so futher disk or network operations
299
may not be possible or may error and if possible should not be
303
def add_fallback_repository(self, repository):
304
"""Add a repository to use for looking up data not held locally.
306
:param repository: A repository.
308
raise NotImplementedError(self.add_fallback_repository)
310
def _check_fallback_repository(self, repository):
311
"""Check that this repository can fallback to repository safely.
313
Raise an error if not.
315
:param repository: A repository to fallback to.
317
return InterRepository._assert_same_model(self, repository)
319
def all_revision_ids(self):
320
"""Returns a list of all the revision ids in the repository.
322
This is conceptually deprecated because code should generally work on
323
the graph reachable from a particular revision, and ignore any other
324
revisions that might be present. There is no direct replacement
327
if 'evil' in debug.debug_flags:
328
mutter_callsite(2, "all_revision_ids is linear with history.")
329
return self._all_revision_ids()
331
def _all_revision_ids(self):
332
"""Returns a list of all the revision ids in the repository.
334
These are in as much topological order as the underlying store can
337
raise NotImplementedError(self._all_revision_ids)
339
def break_lock(self):
340
"""Break a lock if one is present from another instance.
342
Uses the ui factory to ask for confirmation if the lock may be from
345
self.control_files.break_lock()
348
def create(controldir):
349
"""Construct the current default format repository in controldir."""
350
return RepositoryFormat.get_default_format().initialize(controldir)
352
def __init__(self, _format, controldir, control_files):
353
"""instantiate a Repository.
355
:param _format: The format of the repository on disk.
356
:param controldir: The ControlDir of the repository.
357
:param control_files: Control files to use for locking, etc.
359
# In the future we will have a single api for all stores for
360
# getting file texts, inventories and revisions, then
361
# this construct will accept instances of those things.
362
super(Repository, self).__init__()
363
self._format = _format
364
# the following are part of the public API for Repository:
365
self.bzrdir = controldir
366
self.control_files = control_files
368
self._write_group = None
369
# Additional places to query for data.
370
self._fallback_repositories = []
373
def user_transport(self):
374
return self.bzrdir.user_transport
377
def control_transport(self):
378
return self._transport
381
if self._fallback_repositories:
382
return '%s(%r, fallback_repositories=%r)' % (
383
self.__class__.__name__,
385
self._fallback_repositories)
387
return '%s(%r)' % (self.__class__.__name__,
390
def _has_same_fallbacks(self, other_repo):
391
"""Returns true if the repositories have the same fallbacks."""
392
my_fb = self._fallback_repositories
393
other_fb = other_repo._fallback_repositories
394
if len(my_fb) != len(other_fb):
396
for f, g in zip(my_fb, other_fb):
397
if not f.has_same_location(g):
401
def has_same_location(self, other):
402
"""Returns a boolean indicating if this repository is at the same
403
location as another repository.
405
This might return False even when two repository objects are accessing
406
the same physical repository via different URLs.
408
if self.__class__ is not other.__class__:
410
return (self.control_url == other.control_url)
412
def is_in_write_group(self):
413
"""Return True if there is an open write group.
415
:seealso: start_write_group.
417
return self._write_group is not None
420
return self.control_files.is_locked()
422
def is_write_locked(self):
423
"""Return True if this object is write locked."""
424
return self.is_locked() and self.control_files._lock_mode == 'w'
426
def lock_write(self, token=None):
427
"""Lock this repository for writing.
429
This causes caching within the repository obejct to start accumlating
430
data during reads, and allows a 'write_group' to be obtained. Write
431
groups must be used for actual data insertion.
433
A token should be passed in if you know that you have locked the object
434
some other way, and need to synchronise this object's state with that
437
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
439
:param token: if this is already locked, then lock_write will fail
440
unless the token matches the existing lock.
441
:returns: a token if this instance supports tokens, otherwise None.
442
:raises TokenLockingNotSupported: when a token is given but this
443
instance doesn't support using token locks.
444
:raises MismatchedToken: if the specified token doesn't match the token
445
of the existing lock.
446
:seealso: start_write_group.
447
:return: A RepositoryWriteLockResult.
449
locked = self.is_locked()
450
token = self.control_files.lock_write(token=token)
452
self._warn_if_deprecated()
454
for repo in self._fallback_repositories:
455
# Writes don't affect fallback repos
458
return RepositoryWriteLockResult(self.unlock, token)
461
"""Lock the repository for read operations.
463
:return: An object with an unlock method which will release the lock
466
locked = self.is_locked()
467
self.control_files.lock_read()
469
self._warn_if_deprecated()
471
for repo in self._fallback_repositories:
474
return LogicalLockResult(self.unlock)
476
def get_physical_lock_status(self):
477
return self.control_files.get_physical_lock_status()
479
def leave_lock_in_place(self):
480
"""Tell this repository not to release the physical lock when this
483
If lock_write doesn't return a token, then this method is not supported.
485
self.control_files.leave_in_place()
487
def dont_leave_lock_in_place(self):
488
"""Tell this repository to release the physical lock when this
489
object is unlocked, even if it didn't originally acquire it.
491
If lock_write doesn't return a token, then this method is not supported.
493
self.control_files.dont_leave_in_place()
496
def gather_stats(self, revid=None, committers=None):
497
"""Gather statistics from a revision id.
499
:param revid: The revision id to gather statistics from, if None, then
500
no revision specific statistics are gathered.
501
:param committers: Optional parameter controlling whether to grab
502
a count of committers from the revision specific statistics.
503
:return: A dictionary of statistics. Currently this contains:
504
committers: The number of committers if requested.
505
firstrev: A tuple with timestamp, timezone for the penultimate left
506
most ancestor of revid, if revid is not the NULL_REVISION.
507
latestrev: A tuple with timestamp, timezone for revid, if revid is
508
not the NULL_REVISION.
509
revisions: The total revision count in the repository.
510
size: An estimate disk size of the repository in bytes.
513
if revid and committers:
514
result['committers'] = 0
515
if revid and revid != _mod_revision.NULL_REVISION:
516
graph = self.get_graph()
518
all_committers = set()
519
revisions = [r for (r, p) in graph.iter_ancestry([revid])
520
if r != _mod_revision.NULL_REVISION]
523
# ignore the revisions in the middle - just grab first and last
524
revisions = revisions[0], revisions[-1]
525
for revision in self.get_revisions(revisions):
526
if not last_revision:
527
last_revision = revision
529
all_committers.add(revision.committer)
530
first_revision = revision
532
result['committers'] = len(all_committers)
533
result['firstrev'] = (first_revision.timestamp,
534
first_revision.timezone)
535
result['latestrev'] = (last_revision.timestamp,
536
last_revision.timezone)
539
def find_branches(self, using=False):
540
"""Find branches underneath this repository.
542
This will include branches inside other branches.
544
:param using: If True, list only branches using this repository.
546
if using and not self.is_shared():
547
return self.bzrdir.list_branches()
548
class Evaluator(object):
551
self.first_call = True
553
def __call__(self, controldir):
554
# On the first call, the parameter is always the controldir
555
# containing the current repo.
556
if not self.first_call:
558
repository = controldir.open_repository()
559
except errors.NoRepositoryPresent:
562
return False, ([], repository)
563
self.first_call = False
564
value = (controldir.list_branches(), None)
568
for branches, repository in controldir.ControlDir.find_bzrdirs(
569
self.user_transport, evaluate=Evaluator()):
570
if branches is not None:
572
if not using and repository is not None:
573
ret.extend(repository.find_branches())
577
def search_missing_revision_ids(self, other,
578
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
579
find_ghosts=True, revision_ids=None, if_present_ids=None,
581
"""Return the revision ids that other has that this does not.
583
These are returned in topological order.
585
revision_id: only return revision ids included by revision_id.
587
if symbol_versioning.deprecated_passed(revision_id):
588
symbol_versioning.warn(
589
'search_missing_revision_ids(revision_id=...) was '
590
'deprecated in 2.4. Use revision_ids=[...] instead.',
591
DeprecationWarning, stacklevel=3)
592
if revision_ids is not None:
593
raise AssertionError(
594
'revision_ids is mutually exclusive with revision_id')
595
if revision_id is not None:
596
revision_ids = [revision_id]
597
return InterRepository.get(other, self).search_missing_revision_ids(
598
find_ghosts=find_ghosts, revision_ids=revision_ids,
599
if_present_ids=if_present_ids, limit=limit)
603
"""Open the repository rooted at base.
605
For instance, if the repository is at URL/.bzr/repository,
606
Repository.open(URL) -> a Repository instance.
608
control = controldir.ControlDir.open(base)
609
return control.open_repository()
611
def copy_content_into(self, destination, revision_id=None):
612
"""Make a complete copy of the content in self into destination.
614
This is a destructive operation! Do not use it on existing
617
return InterRepository.get(self, destination).copy_content(revision_id)
619
def commit_write_group(self):
620
"""Commit the contents accrued within the current write group.
622
:seealso: start_write_group.
624
:return: it may return an opaque hint that can be passed to 'pack'.
626
if self._write_group is not self.get_transaction():
627
# has an unlock or relock occured ?
628
raise errors.BzrError('mismatched lock context %r and '
630
(self.get_transaction(), self._write_group))
631
result = self._commit_write_group()
632
self._write_group = None
635
def _commit_write_group(self):
636
"""Template method for per-repository write group cleanup.
638
This is called before the write group is considered to be
639
finished and should ensure that all data handed to the repository
640
for writing during the write group is safely committed (to the
641
extent possible considering file system caching etc).
644
def suspend_write_group(self):
645
"""Suspend a write group.
647
:raise UnsuspendableWriteGroup: If the write group can not be
649
:return: List of tokens
651
raise errors.UnsuspendableWriteGroup(self)
653
def refresh_data(self):
654
"""Re-read any data needed to synchronise with disk.
656
This method is intended to be called after another repository instance
657
(such as one used by a smart server) has inserted data into the
658
repository. On all repositories this will work outside of write groups.
659
Some repository formats (pack and newer for bzrlib native formats)
660
support refresh_data inside write groups. If called inside a write
661
group on a repository that does not support refreshing in a write group
662
IsInWriteGroupError will be raised.
666
def resume_write_group(self, tokens):
667
if not self.is_write_locked():
668
raise errors.NotWriteLocked(self)
669
if self._write_group:
670
raise errors.BzrError('already in a write group')
671
self._resume_write_group(tokens)
672
# so we can detect unlock/relock - the write group is now entered.
673
self._write_group = self.get_transaction()
675
def _resume_write_group(self, tokens):
676
raise errors.UnsuspendableWriteGroup(self)
678
def fetch(self, source, revision_id=None, find_ghosts=False,
680
"""Fetch the content required to construct revision_id from source.
682
If revision_id is None and fetch_spec is None, then all content is
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.
695
:param fetch_spec: If specified, a SearchResult or
696
PendingAncestryResult that describes which revisions to copy. This
697
allows copying multiple heads at once. Mutually exclusive with
700
if fetch_spec is not None and revision_id is not None:
701
raise AssertionError(
702
"fetch_spec and revision_id are mutually exclusive.")
703
if self.is_in_write_group():
704
raise errors.InternalBzrError(
705
"May not fetch while in a write group.")
706
# fast path same-url fetch operations
707
# TODO: lift out to somewhere common with RemoteRepository
708
# <https://bugs.launchpad.net/bzr/+bug/401646>
709
if (self.has_same_location(source)
710
and fetch_spec is None
711
and self._has_same_fallbacks(source)):
712
# check that last_revision is in 'from' and then return a
714
if (revision_id is not None and
715
not _mod_revision.is_null(revision_id)):
716
self.get_revision(revision_id)
718
inter = InterRepository.get(source, self)
719
return inter.fetch(revision_id=revision_id,
720
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
722
def create_bundle(self, target, base, fileobj, format=None):
723
return serializer.write_bundle(self, target, base, fileobj, format)
725
def get_commit_builder(self, branch, parents, config, timestamp=None,
726
timezone=None, committer=None, revprops=None,
727
revision_id=None, lossy=False):
728
"""Obtain a CommitBuilder for this repository.
730
:param branch: Branch to commit to.
731
:param parents: Revision ids of the parents of the new revision.
732
:param config: Configuration to use.
733
:param timestamp: Optional timestamp recorded for commit.
734
:param timezone: Optional timezone for timestamp.
735
:param committer: Optional committer to set for commit.
736
:param revprops: Optional dictionary of revision properties.
737
:param revision_id: Optional revision id.
738
:param lossy: Whether to discard data that can not be natively
739
represented, when pushing to a foreign VCS
741
raise NotImplementedError(self.get_commit_builder)
743
@only_raises(errors.LockNotHeld, errors.LockBroken)
745
if (self.control_files._lock_count == 1 and
746
self.control_files._lock_mode == 'w'):
747
if self._write_group is not None:
748
self.abort_write_group()
749
self.control_files.unlock()
750
raise errors.BzrError(
751
'Must end write groups before releasing write locks.')
752
self.control_files.unlock()
753
if self.control_files._lock_count == 0:
754
for repo in self._fallback_repositories:
758
def clone(self, controldir, revision_id=None):
759
"""Clone this repository into controldir using the current format.
761
Currently no check is made that the format of this repository and
762
the bzrdir format are compatible. FIXME RBC 20060201.
764
:return: The newly created destination repository.
766
# TODO: deprecate after 0.16; cloning this with all its settings is
767
# probably not very useful -- mbp 20070423
768
dest_repo = self._create_sprouting_repo(
769
controldir, shared=self.is_shared())
770
self.copy_content_into(dest_repo, revision_id)
773
def start_write_group(self):
774
"""Start a write group in the repository.
776
Write groups are used by repositories which do not have a 1:1 mapping
777
between file ids and backend store to manage the insertion of data from
778
both fetch and commit operations.
780
A write lock is required around the start_write_group/commit_write_group
781
for the support of lock-requiring repository formats.
783
One can only insert data into a repository inside a write group.
787
if not self.is_write_locked():
788
raise errors.NotWriteLocked(self)
789
if self._write_group:
790
raise errors.BzrError('already in a write group')
791
self._start_write_group()
792
# so we can detect unlock/relock - the write group is now entered.
793
self._write_group = self.get_transaction()
795
def _start_write_group(self):
796
"""Template method for per-repository write group startup.
798
This is called before the write group is considered to be
803
def sprout(self, to_bzrdir, revision_id=None):
804
"""Create a descendent repository for new development.
806
Unlike clone, this does not copy the settings of the repository.
808
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
809
dest_repo.fetch(self, revision_id=revision_id)
812
def _create_sprouting_repo(self, a_bzrdir, shared):
813
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
814
# use target default format.
815
dest_repo = a_bzrdir.create_repository()
817
# Most control formats need the repository to be specifically
818
# created, but on some old all-in-one formats it's not needed
820
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
821
except errors.UninitializableFormat:
822
dest_repo = a_bzrdir.open_repository()
826
def has_revision(self, revision_id):
827
"""True if this repository has a copy of the revision."""
828
return revision_id in self.has_revisions((revision_id,))
831
def has_revisions(self, revision_ids):
832
"""Probe to find out the presence of multiple revisions.
834
:param revision_ids: An iterable of revision_ids.
835
:return: A set of the revision_ids that were present.
837
raise NotImplementedError(self.has_revisions)
840
def get_revision(self, revision_id):
841
"""Return the Revision object for a named revision."""
842
return self.get_revisions([revision_id])[0]
844
def get_revision_reconcile(self, revision_id):
845
"""'reconcile' helper routine that allows access to a revision always.
847
This variant of get_revision does not cross check the weave graph
848
against the revision one as get_revision does: but it should only
849
be used by reconcile, or reconcile-alike commands that are correcting
850
or testing the revision graph.
852
raise NotImplementedError(self.get_revision_reconcile)
854
def get_revisions(self, revision_ids):
855
"""Get many revisions at once.
857
Repositories that need to check data on every revision read should
858
subclass this method.
860
raise NotImplementedError(self.get_revisions)
862
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
863
"""Produce a generator of revision deltas.
865
Note that the input is a sequence of REVISIONS, not revision_ids.
866
Trees will be held in memory until the generator exits.
867
Each delta is relative to the revision's lefthand predecessor.
869
:param specific_fileids: if not None, the result is filtered
870
so that only those file-ids, their parents and their
871
children are included.
873
# Get the revision-ids of interest
874
required_trees = set()
875
for revision in revisions:
876
required_trees.add(revision.revision_id)
877
required_trees.update(revision.parent_ids[:1])
879
# Get the matching filtered trees. Note that it's more
880
# efficient to pass filtered trees to changes_from() rather
881
# than doing the filtering afterwards. changes_from() could
882
# arguably do the filtering itself but it's path-based, not
883
# file-id based, so filtering before or afterwards is
885
if specific_fileids is None:
886
trees = dict((t.get_revision_id(), t) for
887
t in self.revision_trees(required_trees))
889
trees = dict((t.get_revision_id(), t) for
890
t in self._filtered_revision_trees(required_trees,
893
# Calculate the deltas
894
for revision in revisions:
895
if not revision.parent_ids:
896
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
898
old_tree = trees[revision.parent_ids[0]]
899
yield trees[revision.revision_id].changes_from(old_tree)
902
def get_revision_delta(self, revision_id, specific_fileids=None):
903
"""Return the delta for one revision.
905
The delta is relative to the left-hand predecessor of the
908
:param specific_fileids: if not None, the result is filtered
909
so that only those file-ids, their parents and their
910
children are included.
912
r = self.get_revision(revision_id)
913
return list(self.get_deltas_for_revisions([r],
914
specific_fileids=specific_fileids))[0]
917
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
918
signature = gpg_strategy.sign(plaintext)
919
self.add_signature_text(revision_id, signature)
921
def add_signature_text(self, revision_id, signature):
922
"""Store a signature text for a revision.
924
:param revision_id: Revision id of the revision
925
:param signature: Signature text.
927
raise NotImplementedError(self.add_signature_text)
929
def _find_parent_ids_of_revisions(self, revision_ids):
930
"""Find all parent ids that are mentioned in the revision graph.
932
:return: set of revisions that are parents of revision_ids which are
933
not part of revision_ids themselves
935
parent_map = self.get_parent_map(revision_ids)
937
map(parent_ids.update, parent_map.itervalues())
938
parent_ids.difference_update(revision_ids)
939
parent_ids.discard(_mod_revision.NULL_REVISION)
942
def iter_files_bytes(self, desired_files):
943
"""Iterate through file versions.
945
Files will not necessarily be returned in the order they occur in
946
desired_files. No specific order is guaranteed.
948
Yields pairs of identifier, bytes_iterator. identifier is an opaque
949
value supplied by the caller as part of desired_files. It should
950
uniquely identify the file version in the caller's context. (Examples:
951
an index number or a TreeTransform trans_id.)
953
:param desired_files: a list of (file_id, revision_id, identifier)
956
raise NotImplementedError(self.iter_files_bytes)
958
def get_rev_id_for_revno(self, revno, known_pair):
959
"""Return the revision id of a revno, given a later (revno, revid)
960
pair in the same history.
962
:return: if found (True, revid). If the available history ran out
963
before reaching the revno, then this returns
964
(False, (closest_revno, closest_revid)).
966
known_revno, known_revid = known_pair
967
partial_history = [known_revid]
968
distance_from_known = known_revno - revno
969
if distance_from_known < 0:
971
'requested revno (%d) is later than given known revno (%d)'
972
% (revno, known_revno))
975
self, partial_history, stop_index=distance_from_known)
976
except errors.RevisionNotPresent, err:
977
if err.revision_id == known_revid:
978
# The start revision (known_revid) wasn't found.
980
# This is a stacked repository with no fallbacks, or a there's a
981
# left-hand ghost. Either way, even though the revision named in
982
# the error isn't in this repo, we know it's the next step in this
984
partial_history.append(err.revision_id)
985
if len(partial_history) <= distance_from_known:
986
# Didn't find enough history to get a revid for the revno.
987
earliest_revno = known_revno - len(partial_history) + 1
988
return (False, (earliest_revno, partial_history[-1]))
989
if len(partial_history) - 1 > distance_from_known:
990
raise AssertionError('_iter_for_revno returned too much history')
991
return (True, partial_history[-1])
993
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
994
def iter_reverse_revision_history(self, revision_id):
995
"""Iterate backwards through revision ids in the lefthand history
997
:param revision_id: The revision id to start with. All its lefthand
998
ancestors will be traversed.
1000
graph = self.get_graph()
1001
stop_revisions = (None, _mod_revision.NULL_REVISION)
1002
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
1004
def is_shared(self):
1005
"""Return True if this repository is flagged as a shared repository."""
1006
raise NotImplementedError(self.is_shared)
1009
def reconcile(self, other=None, thorough=False):
1010
"""Reconcile this repository."""
1011
from bzrlib.reconcile import RepoReconciler
1012
reconciler = RepoReconciler(self, thorough=thorough)
1013
reconciler.reconcile()
1016
def _refresh_data(self):
1017
"""Helper called from lock_* to ensure coherency with disk.
1019
The default implementation does nothing; it is however possible
1020
for repositories to maintain loaded indices across multiple locks
1021
by checking inside their implementation of this method to see
1022
whether their indices are still valid. This depends of course on
1023
the disk format being validatable in this manner. This method is
1024
also called by the refresh_data() public interface to cause a refresh
1025
to occur while in a write lock so that data inserted by a smart server
1026
push operation is visible on the client's instance of the physical
1031
def revision_tree(self, revision_id):
1032
"""Return Tree for a revision on this branch.
1034
`revision_id` may be NULL_REVISION for the empty tree revision.
1036
raise NotImplementedError(self.revision_tree)
1038
def revision_trees(self, revision_ids):
1039
"""Return Trees for revisions in this repository.
1041
:param revision_ids: a sequence of revision-ids;
1042
a revision-id may not be None or 'null:'
1044
raise NotImplementedError(self.revision_trees)
1047
@symbol_versioning.deprecated_method(
1048
symbol_versioning.deprecated_in((2, 4, 0)))
1049
def get_ancestry(self, revision_id, topo_sorted=True):
1050
"""Return a list of revision-ids integrated by a revision.
1052
The first element of the list is always None, indicating the origin
1053
revision. This might change when we have history horizons, or
1054
perhaps we should have a new API.
1056
This is topologically sorted.
1058
if 'evil' in debug.debug_flags:
1059
mutter_callsite(2, "get_ancestry is linear with history.")
1060
if _mod_revision.is_null(revision_id):
1062
if not self.has_revision(revision_id):
1063
raise errors.NoSuchRevision(self, revision_id)
1064
graph = self.get_graph()
1066
search = graph._make_breadth_first_searcher([revision_id])
1069
found, ghosts = search.next_with_ghosts()
1070
except StopIteration:
1073
if _mod_revision.NULL_REVISION in keys:
1074
keys.remove(_mod_revision.NULL_REVISION)
1076
parent_map = graph.get_parent_map(keys)
1077
keys = tsort.topo_sort(parent_map)
1078
return [None] + list(keys)
1080
def pack(self, hint=None, clean_obsolete_packs=False):
1081
"""Compress the data within the repository.
1083
This operation only makes sense for some repository types. For other
1084
types it should be a no-op that just returns.
1086
This stub method does not require a lock, but subclasses should use
1087
@needs_write_lock as this is a long running call it's reasonable to
1088
implicitly lock for the user.
1090
:param hint: If not supplied, the whole repository is packed.
1091
If supplied, the repository may use the hint parameter as a
1092
hint for the parts of the repository to pack. A hint can be
1093
obtained from the result of commit_write_group(). Out of
1094
date hints are simply ignored, because concurrent operations
1095
can obsolete them rapidly.
1097
:param clean_obsolete_packs: Clean obsolete packs immediately after
1101
def get_transaction(self):
1102
return self.control_files.get_transaction()
1104
def get_parent_map(self, revision_ids):
1105
"""See graph.StackedParentsProvider.get_parent_map"""
1106
raise NotImplementedError(self.get_parent_map)
1108
def _get_parent_map_no_fallbacks(self, revision_ids):
1109
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1110
# revisions index works in keys; this just works in revisions
1111
# therefore wrap and unwrap
1114
for revision_id in revision_ids:
1115
if revision_id == _mod_revision.NULL_REVISION:
1116
result[revision_id] = ()
1117
elif revision_id is None:
1118
raise ValueError('get_parent_map(None) is not valid')
1120
query_keys.append((revision_id ,))
1121
vf = self.revisions.without_fallbacks()
1122
for ((revision_id,), parent_keys) in \
1123
vf.get_parent_map(query_keys).iteritems():
1125
result[revision_id] = tuple([parent_revid
1126
for (parent_revid,) in parent_keys])
1128
result[revision_id] = (_mod_revision.NULL_REVISION,)
1131
def _make_parents_provider(self):
1132
if not self._format.supports_external_lookups:
1134
return graph.StackedParentsProvider(_LazyListJoin(
1135
[self._make_parents_provider_unstacked()],
1136
self._fallback_repositories))
1138
def _make_parents_provider_unstacked(self):
1139
return graph.CallableToParentsProviderAdapter(
1140
self._get_parent_map_no_fallbacks)
1143
def get_known_graph_ancestry(self, revision_ids):
1144
"""Return the known graph for a set of revision ids and their ancestors.
1146
raise NotImplementedError(self.get_known_graph_ancestry)
1148
def get_file_graph(self):
1149
"""Return the graph walker for files."""
1150
raise NotImplementedError(self.get_file_graph)
1152
def get_graph(self, other_repository=None):
1153
"""Return the graph walker for this repository format"""
1154
parents_provider = self._make_parents_provider()
1155
if (other_repository is not None and
1156
not self.has_same_location(other_repository)):
1157
parents_provider = graph.StackedParentsProvider(
1158
[parents_provider, other_repository._make_parents_provider()])
1159
return graph.Graph(parents_provider)
1161
def revision_ids_to_search_result(self, result_set):
1162
"""Convert a set of revision ids to a graph SearchResult."""
1163
result_parents = set()
1164
for parents in self.get_graph().get_parent_map(
1165
result_set).itervalues():
1166
result_parents.update(parents)
1167
included_keys = result_set.intersection(result_parents)
1168
start_keys = result_set.difference(included_keys)
1169
exclude_keys = result_parents.difference(result_set)
1170
result = graph.SearchResult(start_keys, exclude_keys,
1171
len(result_set), result_set)
1175
def set_make_working_trees(self, new_value):
1176
"""Set the policy flag for making working trees when creating branches.
1178
This only applies to branches that use this repository.
1180
The default is 'True'.
1181
:param new_value: True to restore the default, False to disable making
1184
raise NotImplementedError(self.set_make_working_trees)
1186
def make_working_trees(self):
1187
"""Returns the policy for making working trees on new branches."""
1188
raise NotImplementedError(self.make_working_trees)
1191
def sign_revision(self, revision_id, gpg_strategy):
1192
testament = _mod_testament.Testament.from_revision(self, revision_id)
1193
plaintext = testament.as_short_text()
1194
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1197
def verify_revision_signature(self, revision_id, gpg_strategy):
1198
"""Verify the signature on a revision.
1200
:param revision_id: the revision to verify
1201
:gpg_strategy: the GPGStrategy object to used
1203
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1205
if not self.has_signature_for_revision_id(revision_id):
1206
return gpg.SIGNATURE_NOT_SIGNED, None
1207
signature = self.get_signature_text(revision_id)
1209
testament = _mod_testament.Testament.from_revision(self, revision_id)
1210
plaintext = testament.as_short_text()
1212
return gpg_strategy.verify(signature, plaintext)
1214
def has_signature_for_revision_id(self, revision_id):
1215
"""Query for a revision signature for revision_id in the repository."""
1216
raise NotImplementedError(self.has_signature_for_revision_id)
1218
def get_signature_text(self, revision_id):
1219
"""Return the text for a signature."""
1220
raise NotImplementedError(self.get_signature_text)
1222
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1223
"""Check consistency of all history of given revision_ids.
1225
Different repository implementations should override _check().
1227
:param revision_ids: A non-empty list of revision_ids whose ancestry
1228
will be checked. Typically the last revision_id of a branch.
1229
:param callback_refs: A dict of check-refs to resolve and callback
1230
the check/_check method on the items listed as wanting the ref.
1232
:param check_repo: If False do not check the repository contents, just
1233
calculate the data callback_refs requires and call them back.
1235
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1236
check_repo=check_repo)
1238
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1239
raise NotImplementedError(self.check)
1241
def _warn_if_deprecated(self, branch=None):
1242
if not self._format.is_deprecated():
1244
global _deprecation_warning_done
1245
if _deprecation_warning_done:
1249
conf = config.GlobalConfig()
1251
conf = branch.get_config()
1252
if conf.suppress_warning('format_deprecation'):
1254
warning("Format %s for %s is deprecated -"
1255
" please use 'bzr upgrade' to get better performance"
1256
% (self._format, self.bzrdir.transport.base))
1258
_deprecation_warning_done = True
1260
def supports_rich_root(self):
1261
return self._format.rich_root_data
1263
def _check_ascii_revisionid(self, revision_id, method):
1264
"""Private helper for ascii-only repositories."""
1265
# weave repositories refuse to store revisionids that are non-ascii.
1266
if revision_id is not None:
1267
# weaves require ascii revision ids.
1268
if isinstance(revision_id, unicode):
1270
revision_id.encode('ascii')
1271
except UnicodeEncodeError:
1272
raise errors.NonAsciiRevisionId(method, self)
1275
revision_id.decode('ascii')
1276
except UnicodeDecodeError:
1277
raise errors.NonAsciiRevisionId(method, self)
1280
class MetaDirRepository(Repository):
1281
"""Repositories in the new meta-dir layout.
1283
:ivar _transport: Transport for access to repository control files,
1284
typically pointing to .bzr/repository.
1287
def __init__(self, _format, a_bzrdir, control_files):
1288
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1289
self._transport = control_files._transport
1291
def is_shared(self):
1292
"""Return True if this repository is flagged as a shared repository."""
1293
return self._transport.has('shared-storage')
1296
def set_make_working_trees(self, new_value):
1297
"""Set the policy flag for making working trees when creating branches.
1299
This only applies to branches that use this repository.
1301
The default is 'True'.
1302
:param new_value: True to restore the default, False to disable making
1307
self._transport.delete('no-working-trees')
1308
except errors.NoSuchFile:
1311
self._transport.put_bytes('no-working-trees', '',
1312
mode=self.bzrdir._get_file_mode())
1314
def make_working_trees(self):
1315
"""Returns the policy for making working trees on new branches."""
1316
return not self._transport.has('no-working-trees')
1319
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1320
"""Repository format registry."""
1322
def get_default(self):
1323
"""Return the current default format."""
1324
return controldir.format_registry.make_bzrdir('default').repository_format
1327
network_format_registry = registry.FormatRegistry()
1328
"""Registry of formats indexed by their network name.
1330
The network name for a repository format is an identifier that can be used when
1331
referring to formats with smart server operations. See
1332
RepositoryFormat.network_name() for more detail.
1336
format_registry = RepositoryFormatRegistry(network_format_registry)
1337
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1339
This can contain either format instances themselves, or classes/factories that
1340
can be called to obtain one.
1344
#####################################################################
1345
# Repository Formats
1347
class RepositoryFormat(controldir.ControlComponentFormat):
1348
"""A repository format.
1350
Formats provide four things:
1351
* An initialization routine to construct repository data on disk.
1352
* a optional format string which is used when the BzrDir supports
1354
* an open routine which returns a Repository instance.
1355
* A network name for referring to the format in smart server RPC
1358
There is one and only one Format subclass for each on-disk format. But
1359
there can be one Repository subclass that is used for several different
1360
formats. The _format attribute on a Repository instance can be used to
1361
determine the disk format.
1363
Formats are placed in a registry by their format string for reference
1364
during opening. These should be subclasses of RepositoryFormat for
1367
Once a format is deprecated, just deprecate the initialize and open
1368
methods on the format class. Do not deprecate the object, as the
1369
object may be created even when a repository instance hasn't been
1372
Common instance attributes:
1373
_matchingbzrdir - the controldir format that the repository format was
1374
originally written to work with. This can be used if manually
1375
constructing a bzrdir and repository, or more commonly for test suite
1379
# Set to True or False in derived classes. True indicates that the format
1380
# supports ghosts gracefully.
1381
supports_ghosts = None
1382
# Can this repository be given external locations to lookup additional
1383
# data. Set to True or False in derived classes.
1384
supports_external_lookups = None
1385
# Does this format support CHK bytestring lookups. Set to True or False in
1387
supports_chks = None
1388
# Should fetch trigger a reconcile after the fetch? Only needed for
1389
# some repository formats that can suffer internal inconsistencies.
1390
_fetch_reconcile = False
1391
# Does this format have < O(tree_size) delta generation. Used to hint what
1392
# code path for commit, amongst other things.
1394
# Does doing a pack operation compress data? Useful for the pack UI command
1395
# (so if there is one pack, the operation can still proceed because it may
1396
# help), and for fetching when data won't have come from the same
1398
pack_compresses = False
1399
# Does the repository storage understand references to trees?
1400
supports_tree_reference = None
1401
# Is the format experimental ?
1402
experimental = False
1403
# Does this repository format escape funky characters, or does it create
1404
# files with similar names as the versioned files in its contents on disk
1406
supports_funky_characters = None
1407
# Does this repository format support leaving locks?
1408
supports_leaving_lock = None
1409
# Does this format support the full VersionedFiles interface?
1410
supports_full_versioned_files = None
1411
# Does this format support signing revision signatures?
1412
supports_revision_signatures = True
1413
# Can the revision graph have incorrect parents?
1414
revision_graph_can_have_wrong_parents = None
1415
# Does this format support rich root data?
1416
rich_root_data = None
1417
# Does this format support explicitly versioned directories?
1418
supports_versioned_directories = None
1419
# Can other repositories be nested into one of this format?
1420
supports_nesting_repositories = None
1421
# Is it possible for revisions to be present without being referenced
1423
supports_unreferenced_revisions = None
1426
return "%s()" % self.__class__.__name__
1428
def __eq__(self, other):
1429
# format objects are generally stateless
1430
return isinstance(other, self.__class__)
1432
def __ne__(self, other):
1433
return not self == other
1436
def find_format(klass, a_bzrdir):
1437
"""Return the format for the repository object in a_bzrdir.
1439
This is used by bzr native formats that have a "format" file in
1440
the repository. Other methods may be used by different types of
1444
transport = a_bzrdir.get_repository_transport(None)
1445
format_string = transport.get_bytes("format")
1446
return format_registry.get(format_string)
1447
except errors.NoSuchFile:
1448
raise errors.NoRepositoryPresent(a_bzrdir)
1450
raise errors.UnknownFormatError(format=format_string,
1454
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1455
def register_format(klass, format):
1456
format_registry.register(format)
1459
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1460
def unregister_format(klass, format):
1461
format_registry.remove(format)
1464
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1465
def get_default_format(klass):
1466
"""Return the current default format."""
1467
return format_registry.get_default()
1469
def get_format_string(self):
1470
"""Return the ASCII format string that identifies this format.
1472
Note that in pre format ?? repositories the format string is
1473
not permitted nor written to disk.
1475
raise NotImplementedError(self.get_format_string)
1477
def get_format_description(self):
1478
"""Return the short description for this format."""
1479
raise NotImplementedError(self.get_format_description)
1481
def initialize(self, controldir, shared=False):
1482
"""Initialize a repository of this format in controldir.
1484
:param controldir: The controldir to put the new repository in it.
1485
:param shared: The repository should be initialized as a sharable one.
1486
:returns: The new repository object.
1488
This may raise UninitializableFormat if shared repository are not
1489
compatible the controldir.
1491
raise NotImplementedError(self.initialize)
1493
def is_supported(self):
1494
"""Is this format supported?
1496
Supported formats must be initializable and openable.
1497
Unsupported formats may not support initialization or committing or
1498
some other features depending on the reason for not being supported.
1502
def is_deprecated(self):
1503
"""Is this format deprecated?
1505
Deprecated formats may trigger a user-visible warning recommending
1506
the user to upgrade. They are still fully supported.
1510
def network_name(self):
1511
"""A simple byte string uniquely identifying this format for RPC calls.
1513
MetaDir repository formats use their disk format string to identify the
1514
repository over the wire. All in one formats such as bzr < 0.8, and
1515
foreign formats like svn/git and hg should use some marker which is
1516
unique and immutable.
1518
raise NotImplementedError(self.network_name)
1520
def check_conversion_target(self, target_format):
1521
if self.rich_root_data and not target_format.rich_root_data:
1522
raise errors.BadConversionTarget(
1523
'Does not support rich root data.', target_format,
1525
if (self.supports_tree_reference and
1526
not getattr(target_format, 'supports_tree_reference', False)):
1527
raise errors.BadConversionTarget(
1528
'Does not support nested trees', target_format,
1531
def open(self, controldir, _found=False):
1532
"""Return an instance of this format for a controldir.
1534
_found is a private parameter, do not use it.
1536
raise NotImplementedError(self.open)
1538
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1539
from bzrlib.controldir import ControlDir, RepoInitHookParams
1540
hooks = ControlDir.hooks['post_repo_init']
1543
params = RepoInitHookParams(repository, self, controldir, shared)
1548
class MetaDirRepositoryFormat(RepositoryFormat):
1549
"""Common base class for the new repositories using the metadir layout."""
1551
rich_root_data = False
1552
supports_tree_reference = False
1553
supports_external_lookups = False
1554
supports_leaving_lock = True
1555
supports_nesting_repositories = True
1558
def _matchingbzrdir(self):
1559
matching = bzrdir.BzrDirMetaFormat1()
1560
matching.repository_format = self
1564
super(MetaDirRepositoryFormat, self).__init__()
1566
def _create_control_files(self, a_bzrdir):
1567
"""Create the required files and the initial control_files object."""
1568
# FIXME: RBC 20060125 don't peek under the covers
1569
# NB: no need to escape relative paths that are url safe.
1570
repository_transport = a_bzrdir.get_repository_transport(self)
1571
control_files = lockable_files.LockableFiles(repository_transport,
1572
'lock', lockdir.LockDir)
1573
control_files.create_lock()
1574
return control_files
1576
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1577
"""Upload the initial blank content."""
1578
control_files = self._create_control_files(a_bzrdir)
1579
control_files.lock_write()
1580
transport = control_files._transport
1582
utf8_files += [('shared-storage', '')]
1584
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1585
for (filename, content_stream) in files:
1586
transport.put_file(filename, content_stream,
1587
mode=a_bzrdir._get_file_mode())
1588
for (filename, content_bytes) in utf8_files:
1589
transport.put_bytes_non_atomic(filename, content_bytes,
1590
mode=a_bzrdir._get_file_mode())
1592
control_files.unlock()
1594
def network_name(self):
1595
"""Metadir formats have matching disk and network format strings."""
1596
return self.get_format_string()
1599
# formats which have no format string are not discoverable or independently
1600
# creatable on disk, so are not registered in format_registry. They're
1601
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1602
# needed, it's constructed directly by the ControlDir. Non-native formats where
1603
# the repository is not separately opened are similar.
1605
format_registry.register_lazy(
1606
'Bazaar-NG Knit Repository Format 1',
1607
'bzrlib.repofmt.knitrepo',
1608
'RepositoryFormatKnit1',
1611
format_registry.register_lazy(
1612
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1613
'bzrlib.repofmt.knitrepo',
1614
'RepositoryFormatKnit3',
1617
format_registry.register_lazy(
1618
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1619
'bzrlib.repofmt.knitrepo',
1620
'RepositoryFormatKnit4',
1623
# Pack-based formats. There is one format for pre-subtrees, and one for
1624
# post-subtrees to allow ease of testing.
1625
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1626
format_registry.register_lazy(
1627
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1628
'bzrlib.repofmt.knitpack_repo',
1629
'RepositoryFormatKnitPack1',
1631
format_registry.register_lazy(
1632
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1633
'bzrlib.repofmt.knitpack_repo',
1634
'RepositoryFormatKnitPack3',
1636
format_registry.register_lazy(
1637
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1638
'bzrlib.repofmt.knitpack_repo',
1639
'RepositoryFormatKnitPack4',
1641
format_registry.register_lazy(
1642
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1643
'bzrlib.repofmt.knitpack_repo',
1644
'RepositoryFormatKnitPack5',
1646
format_registry.register_lazy(
1647
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1648
'bzrlib.repofmt.knitpack_repo',
1649
'RepositoryFormatKnitPack5RichRoot',
1651
format_registry.register_lazy(
1652
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1653
'bzrlib.repofmt.knitpack_repo',
1654
'RepositoryFormatKnitPack5RichRootBroken',
1656
format_registry.register_lazy(
1657
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1658
'bzrlib.repofmt.knitpack_repo',
1659
'RepositoryFormatKnitPack6',
1661
format_registry.register_lazy(
1662
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1663
'bzrlib.repofmt.knitpack_repo',
1664
'RepositoryFormatKnitPack6RichRoot',
1666
format_registry.register_lazy(
1667
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1668
'bzrlib.repofmt.groupcompress_repo',
1669
'RepositoryFormat2a',
1672
# Development formats.
1673
# Check their docstrings to see if/when they are obsolete.
1674
format_registry.register_lazy(
1675
("Bazaar development format 2 with subtree support "
1676
"(needs bzr.dev from before 1.8)\n"),
1677
'bzrlib.repofmt.knitpack_repo',
1678
'RepositoryFormatPackDevelopment2Subtree',
1680
format_registry.register_lazy(
1681
'Bazaar development format 8\n',
1682
'bzrlib.repofmt.groupcompress_repo',
1683
'RepositoryFormat2aSubtree',
1687
class InterRepository(InterObject):
1688
"""This class represents operations taking place between two repositories.
1690
Its instances have methods like copy_content and fetch, and contain
1691
references to the source and target repositories these operations can be
1694
Often we will provide convenience methods on 'repository' which carry out
1695
operations with another repository - they will always forward to
1696
InterRepository.get(other).method_name(parameters).
1700
"""The available optimised InterRepository types."""
1703
def copy_content(self, revision_id=None):
1704
"""Make a complete copy of the content in self into destination.
1706
This is a destructive operation! Do not use it on existing
1709
:param revision_id: Only copy the content needed to construct
1710
revision_id and its parents.
1713
self.target.set_make_working_trees(self.source.make_working_trees())
1714
except NotImplementedError:
1716
self.target.fetch(self.source, revision_id=revision_id)
1719
def fetch(self, revision_id=None, find_ghosts=False,
1721
"""Fetch the content required to construct revision_id.
1723
The content is copied from self.source to self.target.
1725
:param revision_id: if None all content is copied, if NULL_REVISION no
1729
raise NotImplementedError(self.fetch)
1732
def search_missing_revision_ids(self,
1733
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1734
find_ghosts=True, revision_ids=None, if_present_ids=None,
1736
"""Return the revision ids that source has that target does not.
1738
:param revision_id: only return revision ids included by this
1740
:param revision_ids: return revision ids included by these
1741
revision_ids. NoSuchRevision will be raised if any of these
1742
revisions are not present.
1743
:param if_present_ids: like revision_ids, but will not cause
1744
NoSuchRevision if any of these are absent, instead they will simply
1745
not be in the result. This is useful for e.g. finding revisions
1746
to fetch for tags, which may reference absent revisions.
1747
:param find_ghosts: If True find missing revisions in deep history
1748
rather than just finding the surface difference.
1749
:param limit: Maximum number of revisions to return, topologically
1751
:return: A bzrlib.graph.SearchResult.
1753
raise NotImplementedError(self.search_missing_revision_ids)
1756
def _same_model(source, target):
1757
"""True if source and target have the same data representation.
1759
Note: this is always called on the base class; overriding it in a
1760
subclass will have no effect.
1763
InterRepository._assert_same_model(source, target)
1765
except errors.IncompatibleRepositories, e:
1769
def _assert_same_model(source, target):
1770
"""Raise an exception if two repositories do not use the same model.
1772
if source.supports_rich_root() != target.supports_rich_root():
1773
raise errors.IncompatibleRepositories(source, target,
1774
"different rich-root support")
1775
if source._serializer != target._serializer:
1776
raise errors.IncompatibleRepositories(source, target,
1777
"different serializers")
1780
class CopyConverter(object):
1781
"""A repository conversion tool which just performs a copy of the content.
1783
This is slow but quite reliable.
1786
def __init__(self, target_format):
1787
"""Create a CopyConverter.
1789
:param target_format: The format the resulting repository should be.
1791
self.target_format = target_format
1793
def convert(self, repo, pb):
1794
"""Perform the conversion of to_convert, giving feedback via pb.
1796
:param to_convert: The disk object to convert.
1797
:param pb: a progress bar to use for progress information.
1799
pb = ui.ui_factory.nested_progress_bar()
1802
# this is only useful with metadir layouts - separated repo content.
1803
# trigger an assertion if not such
1804
repo._format.get_format_string()
1805
self.repo_dir = repo.bzrdir
1806
pb.update(gettext('Moving repository to repository.backup'))
1807
self.repo_dir.transport.move('repository', 'repository.backup')
1808
backup_transport = self.repo_dir.transport.clone('repository.backup')
1809
repo._format.check_conversion_target(self.target_format)
1810
self.source_repo = repo._format.open(self.repo_dir,
1812
_override_transport=backup_transport)
1813
pb.update(gettext('Creating new repository'))
1814
converted = self.target_format.initialize(self.repo_dir,
1815
self.source_repo.is_shared())
1816
converted.lock_write()
1818
pb.update(gettext('Copying content'))
1819
self.source_repo.copy_content_into(converted)
1822
pb.update(gettext('Deleting old repository content'))
1823
self.repo_dir.transport.delete_tree('repository.backup')
1824
ui.ui_factory.note(gettext('repository converted'))
1828
def _strip_NULL_ghosts(revision_graph):
1829
"""Also don't use this. more compatibility code for unmigrated clients."""
1830
# Filter ghosts, and null:
1831
if _mod_revision.NULL_REVISION in revision_graph:
1832
del revision_graph[_mod_revision.NULL_REVISION]
1833
for key, parents in revision_graph.items():
1834
revision_graph[key] = tuple(parent for parent in parents if parent
1836
return revision_graph
1839
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1840
stop_revision=None):
1841
"""Extend the partial history to include a given index
1843
If a stop_index is supplied, stop when that index has been reached.
1844
If a stop_revision is supplied, stop when that revision is
1845
encountered. Otherwise, stop when the beginning of history is
1848
:param stop_index: The index which should be present. When it is
1849
present, history extension will stop.
1850
:param stop_revision: The revision id which should be present. When
1851
it is encountered, history extension will stop.
1853
start_revision = partial_history_cache[-1]
1854
graph = repo.get_graph()
1855
iterator = graph.iter_lefthand_ancestry(start_revision,
1856
(_mod_revision.NULL_REVISION,))
1858
# skip the last revision in the list
1861
if (stop_index is not None and
1862
len(partial_history_cache) > stop_index):
1864
if partial_history_cache[-1] == stop_revision:
1866
revision_id = iterator.next()
1867
partial_history_cache.append(revision_id)
1868
except StopIteration:
1873
class _LazyListJoin(object):
1874
"""An iterable yielding the contents of many lists as one list.
1876
Each iterator made from this will reflect the current contents of the lists
1877
at the time the iterator is made.
1879
This is used by Repository's _make_parents_provider implementation so that
1882
pp = repo._make_parents_provider() # uses a list of fallback repos
1883
pp.add_fallback_repository(other_repo) # appends to that list
1884
result = pp.get_parent_map(...)
1885
# The result will include revs from other_repo
1888
def __init__(self, *list_parts):
1889
self.list_parts = list_parts
1893
for list_part in self.list_parts:
1894
full_list.extend(list_part)
1895
return iter(full_list)
1898
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
added
removed
bzrlib/repository.py
