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
raise errors.UnsuspendableWriteGroup(self)
647
def refresh_data(self):
648
"""Re-read any data needed to synchronise with disk.
650
This method is intended to be called after another repository instance
651
(such as one used by a smart server) has inserted data into the
652
repository. On all repositories this will work outside of write groups.
653
Some repository formats (pack and newer for bzrlib native formats)
654
support refresh_data inside write groups. If called inside a write
655
group on a repository that does not support refreshing in a write group
656
IsInWriteGroupError will be raised.
660
def resume_write_group(self, tokens):
661
if not self.is_write_locked():
662
raise errors.NotWriteLocked(self)
663
if self._write_group:
664
raise errors.BzrError('already in a write group')
665
self._resume_write_group(tokens)
666
# so we can detect unlock/relock - the write group is now entered.
667
self._write_group = self.get_transaction()
669
def _resume_write_group(self, tokens):
670
raise errors.UnsuspendableWriteGroup(self)
672
def fetch(self, source, revision_id=None, find_ghosts=False,
674
"""Fetch the content required to construct revision_id from source.
676
If revision_id is None and fetch_spec is None, then all content is
679
fetch() may not be used when the repository is in a write group -
680
either finish the current write group before using fetch, or use
681
fetch before starting the write group.
683
:param find_ghosts: Find and copy revisions in the source that are
684
ghosts in the target (and not reachable directly by walking out to
685
the first-present revision in target from revision_id).
686
:param revision_id: If specified, all the content needed for this
687
revision ID will be copied to the target. Fetch will determine for
688
itself which content needs to be copied.
689
:param fetch_spec: If specified, a SearchResult or
690
PendingAncestryResult that describes which revisions to copy. This
691
allows copying multiple heads at once. Mutually exclusive with
694
if fetch_spec is not None and revision_id is not None:
695
raise AssertionError(
696
"fetch_spec and revision_id are mutually exclusive.")
697
if self.is_in_write_group():
698
raise errors.InternalBzrError(
699
"May not fetch while in a write group.")
700
# fast path same-url fetch operations
701
# TODO: lift out to somewhere common with RemoteRepository
702
# <https://bugs.launchpad.net/bzr/+bug/401646>
703
if (self.has_same_location(source)
704
and fetch_spec is None
705
and self._has_same_fallbacks(source)):
706
# check that last_revision is in 'from' and then return a
708
if (revision_id is not None and
709
not _mod_revision.is_null(revision_id)):
710
self.get_revision(revision_id)
712
inter = InterRepository.get(source, self)
713
return inter.fetch(revision_id=revision_id,
714
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
716
def create_bundle(self, target, base, fileobj, format=None):
717
return serializer.write_bundle(self, target, base, fileobj, format)
719
def get_commit_builder(self, branch, parents, config, timestamp=None,
720
timezone=None, committer=None, revprops=None,
721
revision_id=None, lossy=False):
722
"""Obtain a CommitBuilder for this repository.
724
:param branch: Branch to commit to.
725
:param parents: Revision ids of the parents of the new revision.
726
:param config: Configuration to use.
727
:param timestamp: Optional timestamp recorded for commit.
728
:param timezone: Optional timezone for timestamp.
729
:param committer: Optional committer to set for commit.
730
:param revprops: Optional dictionary of revision properties.
731
:param revision_id: Optional revision id.
732
:param lossy: Whether to discard data that can not be natively
733
represented, when pushing to a foreign VCS
735
raise NotImplementedError(self.get_commit_builder)
737
@only_raises(errors.LockNotHeld, errors.LockBroken)
739
if (self.control_files._lock_count == 1 and
740
self.control_files._lock_mode == 'w'):
741
if self._write_group is not None:
742
self.abort_write_group()
743
self.control_files.unlock()
744
raise errors.BzrError(
745
'Must end write groups before releasing write locks.')
746
self.control_files.unlock()
747
if self.control_files._lock_count == 0:
748
for repo in self._fallback_repositories:
752
def clone(self, controldir, revision_id=None):
753
"""Clone this repository into controldir using the current format.
755
Currently no check is made that the format of this repository and
756
the bzrdir format are compatible. FIXME RBC 20060201.
758
:return: The newly created destination repository.
760
# TODO: deprecate after 0.16; cloning this with all its settings is
761
# probably not very useful -- mbp 20070423
762
dest_repo = self._create_sprouting_repo(
763
controldir, shared=self.is_shared())
764
self.copy_content_into(dest_repo, revision_id)
767
def start_write_group(self):
768
"""Start a write group in the repository.
770
Write groups are used by repositories which do not have a 1:1 mapping
771
between file ids and backend store to manage the insertion of data from
772
both fetch and commit operations.
774
A write lock is required around the start_write_group/commit_write_group
775
for the support of lock-requiring repository formats.
777
One can only insert data into a repository inside a write group.
781
if not self.is_write_locked():
782
raise errors.NotWriteLocked(self)
783
if self._write_group:
784
raise errors.BzrError('already in a write group')
785
self._start_write_group()
786
# so we can detect unlock/relock - the write group is now entered.
787
self._write_group = self.get_transaction()
789
def _start_write_group(self):
790
"""Template method for per-repository write group startup.
792
This is called before the write group is considered to be
797
def sprout(self, to_bzrdir, revision_id=None):
798
"""Create a descendent repository for new development.
800
Unlike clone, this does not copy the settings of the repository.
802
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
803
dest_repo.fetch(self, revision_id=revision_id)
806
def _create_sprouting_repo(self, a_bzrdir, shared):
807
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
808
# use target default format.
809
dest_repo = a_bzrdir.create_repository()
811
# Most control formats need the repository to be specifically
812
# created, but on some old all-in-one formats it's not needed
814
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
815
except errors.UninitializableFormat:
816
dest_repo = a_bzrdir.open_repository()
820
def has_revision(self, revision_id):
821
"""True if this repository has a copy of the revision."""
822
return revision_id in self.has_revisions((revision_id,))
825
def has_revisions(self, revision_ids):
826
"""Probe to find out the presence of multiple revisions.
828
:param revision_ids: An iterable of revision_ids.
829
:return: A set of the revision_ids that were present.
831
raise NotImplementedError(self.has_revisions)
834
def get_revision(self, revision_id):
835
"""Return the Revision object for a named revision."""
836
return self.get_revisions([revision_id])[0]
838
def get_revision_reconcile(self, revision_id):
839
"""'reconcile' helper routine that allows access to a revision always.
841
This variant of get_revision does not cross check the weave graph
842
against the revision one as get_revision does: but it should only
843
be used by reconcile, or reconcile-alike commands that are correcting
844
or testing the revision graph.
846
raise NotImplementedError(self.get_revision_reconcile)
848
def get_revisions(self, revision_ids):
849
"""Get many revisions at once.
851
Repositories that need to check data on every revision read should
852
subclass this method.
854
raise NotImplementedError(self.get_revisions)
856
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
857
"""Produce a generator of revision deltas.
859
Note that the input is a sequence of REVISIONS, not revision_ids.
860
Trees will be held in memory until the generator exits.
861
Each delta is relative to the revision's lefthand predecessor.
863
:param specific_fileids: if not None, the result is filtered
864
so that only those file-ids, their parents and their
865
children are included.
867
# Get the revision-ids of interest
868
required_trees = set()
869
for revision in revisions:
870
required_trees.add(revision.revision_id)
871
required_trees.update(revision.parent_ids[:1])
873
# Get the matching filtered trees. Note that it's more
874
# efficient to pass filtered trees to changes_from() rather
875
# than doing the filtering afterwards. changes_from() could
876
# arguably do the filtering itself but it's path-based, not
877
# file-id based, so filtering before or afterwards is
879
if specific_fileids is None:
880
trees = dict((t.get_revision_id(), t) for
881
t in self.revision_trees(required_trees))
883
trees = dict((t.get_revision_id(), t) for
884
t in self._filtered_revision_trees(required_trees,
887
# Calculate the deltas
888
for revision in revisions:
889
if not revision.parent_ids:
890
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
892
old_tree = trees[revision.parent_ids[0]]
893
yield trees[revision.revision_id].changes_from(old_tree)
896
def get_revision_delta(self, revision_id, specific_fileids=None):
897
"""Return the delta for one revision.
899
The delta is relative to the left-hand predecessor of the
902
:param specific_fileids: if not None, the result is filtered
903
so that only those file-ids, their parents and their
904
children are included.
906
r = self.get_revision(revision_id)
907
return list(self.get_deltas_for_revisions([r],
908
specific_fileids=specific_fileids))[0]
911
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
912
signature = gpg_strategy.sign(plaintext)
913
self.add_signature_text(revision_id, signature)
915
def add_signature_text(self, revision_id, signature):
916
"""Store a signature text for a revision.
918
:param revision_id: Revision id of the revision
919
:param signature: Signature text.
921
raise NotImplementedError(self.add_signature_text)
923
def _find_parent_ids_of_revisions(self, revision_ids):
924
"""Find all parent ids that are mentioned in the revision graph.
926
:return: set of revisions that are parents of revision_ids which are
927
not part of revision_ids themselves
929
parent_map = self.get_parent_map(revision_ids)
931
map(parent_ids.update, parent_map.itervalues())
932
parent_ids.difference_update(revision_ids)
933
parent_ids.discard(_mod_revision.NULL_REVISION)
936
def iter_files_bytes(self, desired_files):
937
"""Iterate through file versions.
939
Files will not necessarily be returned in the order they occur in
940
desired_files. No specific order is guaranteed.
942
Yields pairs of identifier, bytes_iterator. identifier is an opaque
943
value supplied by the caller as part of desired_files. It should
944
uniquely identify the file version in the caller's context. (Examples:
945
an index number or a TreeTransform trans_id.)
947
:param desired_files: a list of (file_id, revision_id, identifier)
950
raise NotImplementedError(self.iter_files_bytes)
952
def get_rev_id_for_revno(self, revno, known_pair):
953
"""Return the revision id of a revno, given a later (revno, revid)
954
pair in the same history.
956
:return: if found (True, revid). If the available history ran out
957
before reaching the revno, then this returns
958
(False, (closest_revno, closest_revid)).
960
known_revno, known_revid = known_pair
961
partial_history = [known_revid]
962
distance_from_known = known_revno - revno
963
if distance_from_known < 0:
965
'requested revno (%d) is later than given known revno (%d)'
966
% (revno, known_revno))
969
self, partial_history, stop_index=distance_from_known)
970
except errors.RevisionNotPresent, err:
971
if err.revision_id == known_revid:
972
# The start revision (known_revid) wasn't found.
974
# This is a stacked repository with no fallbacks, or a there's a
975
# left-hand ghost. Either way, even though the revision named in
976
# the error isn't in this repo, we know it's the next step in this
978
partial_history.append(err.revision_id)
979
if len(partial_history) <= distance_from_known:
980
# Didn't find enough history to get a revid for the revno.
981
earliest_revno = known_revno - len(partial_history) + 1
982
return (False, (earliest_revno, partial_history[-1]))
983
if len(partial_history) - 1 > distance_from_known:
984
raise AssertionError('_iter_for_revno returned too much history')
985
return (True, partial_history[-1])
987
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
988
def iter_reverse_revision_history(self, revision_id):
989
"""Iterate backwards through revision ids in the lefthand history
991
:param revision_id: The revision id to start with. All its lefthand
992
ancestors will be traversed.
994
graph = self.get_graph()
995
stop_revisions = (None, _mod_revision.NULL_REVISION)
996
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
999
"""Return True if this repository is flagged as a shared repository."""
1000
raise NotImplementedError(self.is_shared)
1003
def reconcile(self, other=None, thorough=False):
1004
"""Reconcile this repository."""
1005
from bzrlib.reconcile import RepoReconciler
1006
reconciler = RepoReconciler(self, thorough=thorough)
1007
reconciler.reconcile()
1010
def _refresh_data(self):
1011
"""Helper called from lock_* to ensure coherency with disk.
1013
The default implementation does nothing; it is however possible
1014
for repositories to maintain loaded indices across multiple locks
1015
by checking inside their implementation of this method to see
1016
whether their indices are still valid. This depends of course on
1017
the disk format being validatable in this manner. This method is
1018
also called by the refresh_data() public interface to cause a refresh
1019
to occur while in a write lock so that data inserted by a smart server
1020
push operation is visible on the client's instance of the physical
1025
def revision_tree(self, revision_id):
1026
"""Return Tree for a revision on this branch.
1028
`revision_id` may be NULL_REVISION for the empty tree revision.
1030
raise NotImplementedError(self.revision_tree)
1032
def revision_trees(self, revision_ids):
1033
"""Return Trees for revisions in this repository.
1035
:param revision_ids: a sequence of revision-ids;
1036
a revision-id may not be None or 'null:'
1038
raise NotImplementedError(self.revision_trees)
1041
@symbol_versioning.deprecated_method(
1042
symbol_versioning.deprecated_in((2, 4, 0)))
1043
def get_ancestry(self, revision_id, topo_sorted=True):
1044
"""Return a list of revision-ids integrated by a revision.
1046
The first element of the list is always None, indicating the origin
1047
revision. This might change when we have history horizons, or
1048
perhaps we should have a new API.
1050
This is topologically sorted.
1052
if 'evil' in debug.debug_flags:
1053
mutter_callsite(2, "get_ancestry is linear with history.")
1054
if _mod_revision.is_null(revision_id):
1056
if not self.has_revision(revision_id):
1057
raise errors.NoSuchRevision(self, revision_id)
1058
graph = self.get_graph()
1060
search = graph._make_breadth_first_searcher([revision_id])
1063
found, ghosts = search.next_with_ghosts()
1064
except StopIteration:
1067
if _mod_revision.NULL_REVISION in keys:
1068
keys.remove(_mod_revision.NULL_REVISION)
1070
parent_map = graph.get_parent_map(keys)
1071
keys = tsort.topo_sort(parent_map)
1072
return [None] + list(keys)
1074
def pack(self, hint=None, clean_obsolete_packs=False):
1075
"""Compress the data within the repository.
1077
This operation only makes sense for some repository types. For other
1078
types it should be a no-op that just returns.
1080
This stub method does not require a lock, but subclasses should use
1081
@needs_write_lock as this is a long running call it's reasonable to
1082
implicitly lock for the user.
1084
:param hint: If not supplied, the whole repository is packed.
1085
If supplied, the repository may use the hint parameter as a
1086
hint for the parts of the repository to pack. A hint can be
1087
obtained from the result of commit_write_group(). Out of
1088
date hints are simply ignored, because concurrent operations
1089
can obsolete them rapidly.
1091
:param clean_obsolete_packs: Clean obsolete packs immediately after
1095
def get_transaction(self):
1096
return self.control_files.get_transaction()
1098
def get_parent_map(self, revision_ids):
1099
"""See graph.StackedParentsProvider.get_parent_map"""
1100
raise NotImplementedError(self.get_parent_map)
1102
def _get_parent_map_no_fallbacks(self, revision_ids):
1103
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1104
# revisions index works in keys; this just works in revisions
1105
# therefore wrap and unwrap
1108
for revision_id in revision_ids:
1109
if revision_id == _mod_revision.NULL_REVISION:
1110
result[revision_id] = ()
1111
elif revision_id is None:
1112
raise ValueError('get_parent_map(None) is not valid')
1114
query_keys.append((revision_id ,))
1115
vf = self.revisions.without_fallbacks()
1116
for ((revision_id,), parent_keys) in \
1117
vf.get_parent_map(query_keys).iteritems():
1119
result[revision_id] = tuple([parent_revid
1120
for (parent_revid,) in parent_keys])
1122
result[revision_id] = (_mod_revision.NULL_REVISION,)
1125
def _make_parents_provider(self):
1126
if not self._format.supports_external_lookups:
1128
return graph.StackedParentsProvider(_LazyListJoin(
1129
[self._make_parents_provider_unstacked()],
1130
self._fallback_repositories))
1132
def _make_parents_provider_unstacked(self):
1133
return graph.CallableToParentsProviderAdapter(
1134
self._get_parent_map_no_fallbacks)
1137
def get_known_graph_ancestry(self, revision_ids):
1138
"""Return the known graph for a set of revision ids and their ancestors.
1140
raise NotImplementedError(self.get_known_graph_ancestry)
1142
def get_file_graph(self):
1143
"""Return the graph walker for files."""
1144
raise NotImplementedError(self.get_file_graph)
1146
def get_graph(self, other_repository=None):
1147
"""Return the graph walker for this repository format"""
1148
parents_provider = self._make_parents_provider()
1149
if (other_repository is not None and
1150
not self.has_same_location(other_repository)):
1151
parents_provider = graph.StackedParentsProvider(
1152
[parents_provider, other_repository._make_parents_provider()])
1153
return graph.Graph(parents_provider)
1155
def revision_ids_to_search_result(self, result_set):
1156
"""Convert a set of revision ids to a graph SearchResult."""
1157
result_parents = set()
1158
for parents in self.get_graph().get_parent_map(
1159
result_set).itervalues():
1160
result_parents.update(parents)
1161
included_keys = result_set.intersection(result_parents)
1162
start_keys = result_set.difference(included_keys)
1163
exclude_keys = result_parents.difference(result_set)
1164
result = graph.SearchResult(start_keys, exclude_keys,
1165
len(result_set), result_set)
1169
def set_make_working_trees(self, new_value):
1170
"""Set the policy flag for making working trees when creating branches.
1172
This only applies to branches that use this repository.
1174
The default is 'True'.
1175
:param new_value: True to restore the default, False to disable making
1178
raise NotImplementedError(self.set_make_working_trees)
1180
def make_working_trees(self):
1181
"""Returns the policy for making working trees on new branches."""
1182
raise NotImplementedError(self.make_working_trees)
1185
def sign_revision(self, revision_id, gpg_strategy):
1186
testament = _mod_testament.Testament.from_revision(self, revision_id)
1187
plaintext = testament.as_short_text()
1188
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1191
def verify_revision_signature(self, revision_id, gpg_strategy):
1192
"""Verify the signature on a revision.
1194
:param revision_id: the revision to verify
1195
:gpg_strategy: the GPGStrategy object to used
1197
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1199
if not self.has_signature_for_revision_id(revision_id):
1200
return gpg.SIGNATURE_NOT_SIGNED, None
1201
signature = self.get_signature_text(revision_id)
1203
testament = _mod_testament.Testament.from_revision(self, revision_id)
1204
plaintext = testament.as_short_text()
1206
return gpg_strategy.verify(signature, plaintext)
1208
def has_signature_for_revision_id(self, revision_id):
1209
"""Query for a revision signature for revision_id in the repository."""
1210
raise NotImplementedError(self.has_signature_for_revision_id)
1212
def get_signature_text(self, revision_id):
1213
"""Return the text for a signature."""
1214
raise NotImplementedError(self.get_signature_text)
1216
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1217
"""Check consistency of all history of given revision_ids.
1219
Different repository implementations should override _check().
1221
:param revision_ids: A non-empty list of revision_ids whose ancestry
1222
will be checked. Typically the last revision_id of a branch.
1223
:param callback_refs: A dict of check-refs to resolve and callback
1224
the check/_check method on the items listed as wanting the ref.
1226
:param check_repo: If False do not check the repository contents, just
1227
calculate the data callback_refs requires and call them back.
1229
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1230
check_repo=check_repo)
1232
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1233
raise NotImplementedError(self.check)
1235
def _warn_if_deprecated(self, branch=None):
1236
if not self._format.is_deprecated():
1238
global _deprecation_warning_done
1239
if _deprecation_warning_done:
1243
conf = config.GlobalConfig()
1245
conf = branch.get_config()
1246
if conf.suppress_warning('format_deprecation'):
1248
warning("Format %s for %s is deprecated -"
1249
" please use 'bzr upgrade' to get better performance"
1250
% (self._format, self.bzrdir.transport.base))
1252
_deprecation_warning_done = True
1254
def supports_rich_root(self):
1255
return self._format.rich_root_data
1257
def _check_ascii_revisionid(self, revision_id, method):
1258
"""Private helper for ascii-only repositories."""
1259
# weave repositories refuse to store revisionids that are non-ascii.
1260
if revision_id is not None:
1261
# weaves require ascii revision ids.
1262
if isinstance(revision_id, unicode):
1264
revision_id.encode('ascii')
1265
except UnicodeEncodeError:
1266
raise errors.NonAsciiRevisionId(method, self)
1269
revision_id.decode('ascii')
1270
except UnicodeDecodeError:
1271
raise errors.NonAsciiRevisionId(method, self)
1274
class MetaDirRepository(Repository):
1275
"""Repositories in the new meta-dir layout.
1277
:ivar _transport: Transport for access to repository control files,
1278
typically pointing to .bzr/repository.
1281
def __init__(self, _format, a_bzrdir, control_files):
1282
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1283
self._transport = control_files._transport
1285
def is_shared(self):
1286
"""Return True if this repository is flagged as a shared repository."""
1287
return self._transport.has('shared-storage')
1290
def set_make_working_trees(self, new_value):
1291
"""Set the policy flag for making working trees when creating branches.
1293
This only applies to branches that use this repository.
1295
The default is 'True'.
1296
:param new_value: True to restore the default, False to disable making
1301
self._transport.delete('no-working-trees')
1302
except errors.NoSuchFile:
1305
self._transport.put_bytes('no-working-trees', '',
1306
mode=self.bzrdir._get_file_mode())
1308
def make_working_trees(self):
1309
"""Returns the policy for making working trees on new branches."""
1310
return not self._transport.has('no-working-trees')
1313
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1314
"""Repository format registry."""
1316
def get_default(self):
1317
"""Return the current default format."""
1318
return controldir.format_registry.make_bzrdir('default').repository_format
1321
network_format_registry = registry.FormatRegistry()
1322
"""Registry of formats indexed by their network name.
1324
The network name for a repository format is an identifier that can be used when
1325
referring to formats with smart server operations. See
1326
RepositoryFormat.network_name() for more detail.
1330
format_registry = RepositoryFormatRegistry(network_format_registry)
1331
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1333
This can contain either format instances themselves, or classes/factories that
1334
can be called to obtain one.
1338
#####################################################################
1339
# Repository Formats
1341
class RepositoryFormat(controldir.ControlComponentFormat):
1342
"""A repository format.
1344
Formats provide four things:
1345
* An initialization routine to construct repository data on disk.
1346
* a optional format string which is used when the BzrDir supports
1348
* an open routine which returns a Repository instance.
1349
* A network name for referring to the format in smart server RPC
1352
There is one and only one Format subclass for each on-disk format. But
1353
there can be one Repository subclass that is used for several different
1354
formats. The _format attribute on a Repository instance can be used to
1355
determine the disk format.
1357
Formats are placed in a registry by their format string for reference
1358
during opening. These should be subclasses of RepositoryFormat for
1361
Once a format is deprecated, just deprecate the initialize and open
1362
methods on the format class. Do not deprecate the object, as the
1363
object may be created even when a repository instance hasn't been
1366
Common instance attributes:
1367
_matchingbzrdir - the controldir format that the repository format was
1368
originally written to work with. This can be used if manually
1369
constructing a bzrdir and repository, or more commonly for test suite
1373
# Set to True or False in derived classes. True indicates that the format
1374
# supports ghosts gracefully.
1375
supports_ghosts = None
1376
# Can this repository be given external locations to lookup additional
1377
# data. Set to True or False in derived classes.
1378
supports_external_lookups = None
1379
# Does this format support CHK bytestring lookups. Set to True or False in
1381
supports_chks = None
1382
# Should fetch trigger a reconcile after the fetch? Only needed for
1383
# some repository formats that can suffer internal inconsistencies.
1384
_fetch_reconcile = False
1385
# Does this format have < O(tree_size) delta generation. Used to hint what
1386
# code path for commit, amongst other things.
1388
# Does doing a pack operation compress data? Useful for the pack UI command
1389
# (so if there is one pack, the operation can still proceed because it may
1390
# help), and for fetching when data won't have come from the same
1392
pack_compresses = False
1393
# Does the repository storage understand references to trees?
1394
supports_tree_reference = None
1395
# Is the format experimental ?
1396
experimental = False
1397
# Does this repository format escape funky characters, or does it create
1398
# files with similar names as the versioned files in its contents on disk
1400
supports_funky_characters = None
1401
# Does this repository format support leaving locks?
1402
supports_leaving_lock = None
1403
# Does this format support the full VersionedFiles interface?
1404
supports_full_versioned_files = None
1405
# Does this format support signing revision signatures?
1406
supports_revision_signatures = True
1407
# Can the revision graph have incorrect parents?
1408
revision_graph_can_have_wrong_parents = None
1409
# Does this format support rich root data?
1410
rich_root_data = None
1411
# Does this format support explicitly versioned directories?
1412
supports_versioned_directories = None
1413
# Can other repositories be nested into one of this format?
1414
supports_nesting_repositories = None
1415
# Is it possible for revisions to be present without being referenced
1417
supports_unreferenced_revisions = None
1420
return "%s()" % self.__class__.__name__
1422
def __eq__(self, other):
1423
# format objects are generally stateless
1424
return isinstance(other, self.__class__)
1426
def __ne__(self, other):
1427
return not self == other
1430
def find_format(klass, a_bzrdir):
1431
"""Return the format for the repository object in a_bzrdir.
1433
This is used by bzr native formats that have a "format" file in
1434
the repository. Other methods may be used by different types of
1438
transport = a_bzrdir.get_repository_transport(None)
1439
format_string = transport.get_bytes("format")
1440
return format_registry.get(format_string)
1441
except errors.NoSuchFile:
1442
raise errors.NoRepositoryPresent(a_bzrdir)
1444
raise errors.UnknownFormatError(format=format_string,
1448
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1449
def register_format(klass, format):
1450
format_registry.register(format)
1453
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1454
def unregister_format(klass, format):
1455
format_registry.remove(format)
1458
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1459
def get_default_format(klass):
1460
"""Return the current default format."""
1461
return format_registry.get_default()
1463
def get_format_string(self):
1464
"""Return the ASCII format string that identifies this format.
1466
Note that in pre format ?? repositories the format string is
1467
not permitted nor written to disk.
1469
raise NotImplementedError(self.get_format_string)
1471
def get_format_description(self):
1472
"""Return the short description for this format."""
1473
raise NotImplementedError(self.get_format_description)
1475
def initialize(self, controldir, shared=False):
1476
"""Initialize a repository of this format in controldir.
1478
:param controldir: The controldir to put the new repository in it.
1479
:param shared: The repository should be initialized as a sharable one.
1480
:returns: The new repository object.
1482
This may raise UninitializableFormat if shared repository are not
1483
compatible the controldir.
1485
raise NotImplementedError(self.initialize)
1487
def is_supported(self):
1488
"""Is this format supported?
1490
Supported formats must be initializable and openable.
1491
Unsupported formats may not support initialization or committing or
1492
some other features depending on the reason for not being supported.
1496
def is_deprecated(self):
1497
"""Is this format deprecated?
1499
Deprecated formats may trigger a user-visible warning recommending
1500
the user to upgrade. They are still fully supported.
1504
def network_name(self):
1505
"""A simple byte string uniquely identifying this format for RPC calls.
1507
MetaDir repository formats use their disk format string to identify the
1508
repository over the wire. All in one formats such as bzr < 0.8, and
1509
foreign formats like svn/git and hg should use some marker which is
1510
unique and immutable.
1512
raise NotImplementedError(self.network_name)
1514
def check_conversion_target(self, target_format):
1515
if self.rich_root_data and not target_format.rich_root_data:
1516
raise errors.BadConversionTarget(
1517
'Does not support rich root data.', target_format,
1519
if (self.supports_tree_reference and
1520
not getattr(target_format, 'supports_tree_reference', False)):
1521
raise errors.BadConversionTarget(
1522
'Does not support nested trees', target_format,
1525
def open(self, controldir, _found=False):
1526
"""Return an instance of this format for a controldir.
1528
_found is a private parameter, do not use it.
1530
raise NotImplementedError(self.open)
1532
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1533
from bzrlib.controldir import ControlDir, RepoInitHookParams
1534
hooks = ControlDir.hooks['post_repo_init']
1537
params = RepoInitHookParams(repository, self, controldir, shared)
1542
class MetaDirRepositoryFormat(RepositoryFormat):
1543
"""Common base class for the new repositories using the metadir layout."""
1545
rich_root_data = False
1546
supports_tree_reference = False
1547
supports_external_lookups = False
1548
supports_leaving_lock = True
1549
supports_nesting_repositories = True
1552
def _matchingbzrdir(self):
1553
matching = bzrdir.BzrDirMetaFormat1()
1554
matching.repository_format = self
1558
super(MetaDirRepositoryFormat, self).__init__()
1560
def _create_control_files(self, a_bzrdir):
1561
"""Create the required files and the initial control_files object."""
1562
# FIXME: RBC 20060125 don't peek under the covers
1563
# NB: no need to escape relative paths that are url safe.
1564
repository_transport = a_bzrdir.get_repository_transport(self)
1565
control_files = lockable_files.LockableFiles(repository_transport,
1566
'lock', lockdir.LockDir)
1567
control_files.create_lock()
1568
return control_files
1570
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1571
"""Upload the initial blank content."""
1572
control_files = self._create_control_files(a_bzrdir)
1573
control_files.lock_write()
1574
transport = control_files._transport
1576
utf8_files += [('shared-storage', '')]
1578
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1579
for (filename, content_stream) in files:
1580
transport.put_file(filename, content_stream,
1581
mode=a_bzrdir._get_file_mode())
1582
for (filename, content_bytes) in utf8_files:
1583
transport.put_bytes_non_atomic(filename, content_bytes,
1584
mode=a_bzrdir._get_file_mode())
1586
control_files.unlock()
1588
def network_name(self):
1589
"""Metadir formats have matching disk and network format strings."""
1590
return self.get_format_string()
1593
# formats which have no format string are not discoverable or independently
1594
# creatable on disk, so are not registered in format_registry. They're
1595
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1596
# needed, it's constructed directly by the ControlDir. Non-native formats where
1597
# the repository is not separately opened are similar.
1599
format_registry.register_lazy(
1600
'Bazaar-NG Knit Repository Format 1',
1601
'bzrlib.repofmt.knitrepo',
1602
'RepositoryFormatKnit1',
1605
format_registry.register_lazy(
1606
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1607
'bzrlib.repofmt.knitrepo',
1608
'RepositoryFormatKnit3',
1611
format_registry.register_lazy(
1612
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1613
'bzrlib.repofmt.knitrepo',
1614
'RepositoryFormatKnit4',
1617
# Pack-based formats. There is one format for pre-subtrees, and one for
1618
# post-subtrees to allow ease of testing.
1619
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1620
format_registry.register_lazy(
1621
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1622
'bzrlib.repofmt.knitpack_repo',
1623
'RepositoryFormatKnitPack1',
1625
format_registry.register_lazy(
1626
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1627
'bzrlib.repofmt.knitpack_repo',
1628
'RepositoryFormatKnitPack3',
1630
format_registry.register_lazy(
1631
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1632
'bzrlib.repofmt.knitpack_repo',
1633
'RepositoryFormatKnitPack4',
1635
format_registry.register_lazy(
1636
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1637
'bzrlib.repofmt.knitpack_repo',
1638
'RepositoryFormatKnitPack5',
1640
format_registry.register_lazy(
1641
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1642
'bzrlib.repofmt.knitpack_repo',
1643
'RepositoryFormatKnitPack5RichRoot',
1645
format_registry.register_lazy(
1646
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1647
'bzrlib.repofmt.knitpack_repo',
1648
'RepositoryFormatKnitPack5RichRootBroken',
1650
format_registry.register_lazy(
1651
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1652
'bzrlib.repofmt.knitpack_repo',
1653
'RepositoryFormatKnitPack6',
1655
format_registry.register_lazy(
1656
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1657
'bzrlib.repofmt.knitpack_repo',
1658
'RepositoryFormatKnitPack6RichRoot',
1660
format_registry.register_lazy(
1661
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1662
'bzrlib.repofmt.groupcompress_repo',
1663
'RepositoryFormat2a',
1666
# Development formats.
1667
# Check their docstrings to see if/when they are obsolete.
1668
format_registry.register_lazy(
1669
("Bazaar development format 2 with subtree support "
1670
"(needs bzr.dev from before 1.8)\n"),
1671
'bzrlib.repofmt.knitpack_repo',
1672
'RepositoryFormatPackDevelopment2Subtree',
1674
format_registry.register_lazy(
1675
'Bazaar development format 8\n',
1676
'bzrlib.repofmt.groupcompress_repo',
1677
'RepositoryFormat2aSubtree',
1681
class InterRepository(InterObject):
1682
"""This class represents operations taking place between two repositories.
1684
Its instances have methods like copy_content and fetch, and contain
1685
references to the source and target repositories these operations can be
1688
Often we will provide convenience methods on 'repository' which carry out
1689
operations with another repository - they will always forward to
1690
InterRepository.get(other).method_name(parameters).
1694
"""The available optimised InterRepository types."""
1697
def copy_content(self, revision_id=None):
1698
"""Make a complete copy of the content in self into destination.
1700
This is a destructive operation! Do not use it on existing
1703
:param revision_id: Only copy the content needed to construct
1704
revision_id and its parents.
1707
self.target.set_make_working_trees(self.source.make_working_trees())
1708
except NotImplementedError:
1710
self.target.fetch(self.source, revision_id=revision_id)
1713
def fetch(self, revision_id=None, find_ghosts=False,
1715
"""Fetch the content required to construct revision_id.
1717
The content is copied from self.source to self.target.
1719
:param revision_id: if None all content is copied, if NULL_REVISION no
1723
raise NotImplementedError(self.fetch)
1726
def search_missing_revision_ids(self,
1727
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1728
find_ghosts=True, revision_ids=None, if_present_ids=None,
1730
"""Return the revision ids that source has that target does not.
1732
:param revision_id: only return revision ids included by this
1734
:param revision_ids: return revision ids included by these
1735
revision_ids. NoSuchRevision will be raised if any of these
1736
revisions are not present.
1737
:param if_present_ids: like revision_ids, but will not cause
1738
NoSuchRevision if any of these are absent, instead they will simply
1739
not be in the result. This is useful for e.g. finding revisions
1740
to fetch for tags, which may reference absent revisions.
1741
:param find_ghosts: If True find missing revisions in deep history
1742
rather than just finding the surface difference.
1743
:param limit: Maximum number of revisions to return, topologically
1745
:return: A bzrlib.graph.SearchResult.
1747
raise NotImplementedError(self.search_missing_revision_ids)
1750
def _same_model(source, target):
1751
"""True if source and target have the same data representation.
1753
Note: this is always called on the base class; overriding it in a
1754
subclass will have no effect.
1757
InterRepository._assert_same_model(source, target)
1759
except errors.IncompatibleRepositories, e:
1763
def _assert_same_model(source, target):
1764
"""Raise an exception if two repositories do not use the same model.
1766
if source.supports_rich_root() != target.supports_rich_root():
1767
raise errors.IncompatibleRepositories(source, target,
1768
"different rich-root support")
1769
if source._serializer != target._serializer:
1770
raise errors.IncompatibleRepositories(source, target,
1771
"different serializers")
1774
class CopyConverter(object):
1775
"""A repository conversion tool which just performs a copy of the content.
1777
This is slow but quite reliable.
1780
def __init__(self, target_format):
1781
"""Create a CopyConverter.
1783
:param target_format: The format the resulting repository should be.
1785
self.target_format = target_format
1787
def convert(self, repo, pb):
1788
"""Perform the conversion of to_convert, giving feedback via pb.
1790
:param to_convert: The disk object to convert.
1791
:param pb: a progress bar to use for progress information.
1793
pb = ui.ui_factory.nested_progress_bar()
1796
# this is only useful with metadir layouts - separated repo content.
1797
# trigger an assertion if not such
1798
repo._format.get_format_string()
1799
self.repo_dir = repo.bzrdir
1800
pb.update(gettext('Moving repository to repository.backup'))
1801
self.repo_dir.transport.move('repository', 'repository.backup')
1802
backup_transport = self.repo_dir.transport.clone('repository.backup')
1803
repo._format.check_conversion_target(self.target_format)
1804
self.source_repo = repo._format.open(self.repo_dir,
1806
_override_transport=backup_transport)
1807
pb.update(gettext('Creating new repository'))
1808
converted = self.target_format.initialize(self.repo_dir,
1809
self.source_repo.is_shared())
1810
converted.lock_write()
1812
pb.update(gettext('Copying content'))
1813
self.source_repo.copy_content_into(converted)
1816
pb.update(gettext('Deleting old repository content'))
1817
self.repo_dir.transport.delete_tree('repository.backup')
1818
ui.ui_factory.note(gettext('repository converted'))
1822
def _strip_NULL_ghosts(revision_graph):
1823
"""Also don't use this. more compatibility code for unmigrated clients."""
1824
# Filter ghosts, and null:
1825
if _mod_revision.NULL_REVISION in revision_graph:
1826
del revision_graph[_mod_revision.NULL_REVISION]
1827
for key, parents in revision_graph.items():
1828
revision_graph[key] = tuple(parent for parent in parents if parent
1830
return revision_graph
1833
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1834
stop_revision=None):
1835
"""Extend the partial history to include a given index
1837
If a stop_index is supplied, stop when that index has been reached.
1838
If a stop_revision is supplied, stop when that revision is
1839
encountered. Otherwise, stop when the beginning of history is
1842
:param stop_index: The index which should be present. When it is
1843
present, history extension will stop.
1844
:param stop_revision: The revision id which should be present. When
1845
it is encountered, history extension will stop.
1847
start_revision = partial_history_cache[-1]
1848
graph = repo.get_graph()
1849
iterator = graph.iter_lefthand_ancestry(start_revision,
1850
(_mod_revision.NULL_REVISION,))
1852
# skip the last revision in the list
1855
if (stop_index is not None and
1856
len(partial_history_cache) > stop_index):
1858
if partial_history_cache[-1] == stop_revision:
1860
revision_id = iterator.next()
1861
partial_history_cache.append(revision_id)
1862
except StopIteration:
1867
class _LazyListJoin(object):
1868
"""An iterable yielding the contents of many lists as one list.
1870
Each iterator made from this will reflect the current contents of the lists
1871
at the time the iterator is made.
1873
This is used by Repository's _make_parents_provider implementation so that
1876
pp = repo._make_parents_provider() # uses a list of fallback repos
1877
pp.add_fallback_repository(other_repo) # appends to that list
1878
result = pp.get_parent_map(...)
1879
# The result will include revs from other_repo
1882
def __init__(self, *list_parts):
1883
self.list_parts = list_parts
1887
for list_part in self.list_parts:
1888
full_list.extend(list_part)
1889
return iter(full_list)
1892
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
added
removed
bzrlib/repository.py
