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
46
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
47
from bzrlib.inter import InterObject
48
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
49
from bzrlib.trace import (
50
log_exception_quietly, note, mutter, mutter_callsite, warning)
53
# Old formats display a warning, but only once
54
_deprecation_warning_done = False
57
class IsInWriteGroupError(errors.InternalBzrError):
59
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
61
def __init__(self, repo):
62
errors.InternalBzrError.__init__(self, repo=repo)
65
class CommitBuilder(object):
66
"""Provides an interface to build up a commit.
68
This allows describing a tree to be committed without needing to
69
know the internals of the format of the repository.
72
# all clients should supply tree roots.
73
record_root_entry = True
74
# whether this commit builder supports the record_entry_contents interface
75
supports_record_entry_contents = False
77
def __init__(self, repository, parents, config, timestamp=None,
78
timezone=None, committer=None, revprops=None,
79
revision_id=None, lossy=False):
80
"""Initiate a CommitBuilder.
82
:param repository: Repository to commit to.
83
:param parents: Revision ids of the parents of the new revision.
84
:param timestamp: Optional timestamp recorded for commit.
85
:param timezone: Optional timezone for timestamp.
86
:param committer: Optional committer to set for commit.
87
:param revprops: Optional dictionary of revision properties.
88
:param revision_id: Optional revision id.
89
:param lossy: Whether to discard data that can not be natively
90
represented, when pushing to a foreign VCS
96
self._committer = self._config.username()
97
elif not isinstance(committer, unicode):
98
self._committer = committer.decode() # throw if non-ascii
100
self._committer = committer
102
self._new_revision_id = revision_id
103
self.parents = parents
104
self.repository = repository
107
if revprops is not None:
108
self._validate_revprops(revprops)
109
self._revprops.update(revprops)
111
if timestamp is None:
112
timestamp = time.time()
113
# Restrict resolution to 1ms
114
self._timestamp = round(timestamp, 3)
117
self._timezone = osutils.local_time_offset()
119
self._timezone = int(timezone)
121
self._generate_revision_if_needed()
123
def any_changes(self):
124
"""Return True if any entries were changed.
126
This includes merge-only changes. It is the core for the --unchanged
129
:return: True if any changes have occured.
131
raise NotImplementedError(self.any_changes)
133
def _validate_unicode_text(self, text, context):
134
"""Verify things like commit messages don't have bogus characters."""
136
raise ValueError('Invalid value for %s: %r' % (context, text))
138
def _validate_revprops(self, revprops):
139
for key, value in revprops.iteritems():
140
# We know that the XML serializers do not round trip '\r'
141
# correctly, so refuse to accept them
142
if not isinstance(value, basestring):
143
raise ValueError('revision property (%s) is not a valid'
144
' (unicode) string: %r' % (key, value))
145
self._validate_unicode_text(value,
146
'revision property (%s)' % (key,))
148
def commit(self, message):
149
"""Make the actual commit.
151
:return: The revision id of the recorded revision.
153
raise NotImplementedError(self.commit)
156
"""Abort the commit that is being built.
158
raise NotImplementedError(self.abort)
160
def revision_tree(self):
161
"""Return the tree that was just committed.
163
After calling commit() this can be called to get a
164
RevisionTree representing the newly committed tree. This is
165
preferred to calling Repository.revision_tree() because that may
166
require deserializing the inventory, while we already have a copy in
169
raise NotImplementedError(self.revision_tree)
171
def finish_inventory(self):
172
"""Tell the builder that the inventory is finished.
174
:return: The inventory id in the repository, which can be used with
175
repository.get_inventory.
177
raise NotImplementedError(self.finish_inventory)
179
def _gen_revision_id(self):
180
"""Return new revision-id."""
181
return generate_ids.gen_revision_id(self._committer, self._timestamp)
183
def _generate_revision_if_needed(self):
184
"""Create a revision id if None was supplied.
186
If the repository can not support user-specified revision ids
187
they should override this function and raise CannotSetRevisionId
188
if _new_revision_id is not None.
190
:raises: CannotSetRevisionId
192
if self._new_revision_id is None:
193
self._new_revision_id = self._gen_revision_id()
194
self.random_revid = True
196
self.random_revid = False
198
def will_record_deletes(self):
199
"""Tell the commit builder that deletes are being notified.
201
This enables the accumulation of an inventory delta; for the resulting
202
commit to be valid, deletes against the basis MUST be recorded via
203
builder.record_delete().
205
raise NotImplementedError(self.will_record_deletes)
207
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
208
"""Record a new tree via iter_changes.
210
:param tree: The tree to obtain text contents from for changed objects.
211
:param basis_revision_id: The revision id of the tree the iter_changes
212
has been generated against. Currently assumed to be the same
213
as self.parents[0] - if it is not, errors may occur.
214
:param iter_changes: An iter_changes iterator with the changes to apply
215
to basis_revision_id. The iterator must not include any items with
216
a current kind of None - missing items must be either filtered out
217
or errored-on beefore record_iter_changes sees the item.
218
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
221
raise NotImplementedError(self.record_iter_changes)
224
class RepositoryWriteLockResult(LogicalLockResult):
225
"""The result of write locking a repository.
227
:ivar repository_token: The token obtained from the underlying lock, or
229
:ivar unlock: A callable which will unlock the lock.
232
def __init__(self, unlock, repository_token):
233
LogicalLockResult.__init__(self, unlock)
234
self.repository_token = repository_token
237
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
241
######################################################################
245
class Repository(_RelockDebugMixin, controldir.ControlComponent):
246
"""Repository holding history for one or more branches.
248
The repository holds and retrieves historical information including
249
revisions and file history. It's normally accessed only by the Branch,
250
which views a particular line of development through that history.
252
See VersionedFileRepository in bzrlib.vf_repository for the
253
base class for most Bazaar repositories.
256
def abort_write_group(self, suppress_errors=False):
257
"""Commit the contents accrued within the current write group.
259
:param suppress_errors: if true, abort_write_group will catch and log
260
unexpected errors that happen during the abort, rather than
261
allowing them to propagate. Defaults to False.
263
:seealso: start_write_group.
265
if self._write_group is not self.get_transaction():
266
# has an unlock or relock occured ?
269
'(suppressed) mismatched lock context and write group. %r, %r',
270
self._write_group, self.get_transaction())
272
raise errors.BzrError(
273
'mismatched lock context and write group. %r, %r' %
274
(self._write_group, self.get_transaction()))
276
self._abort_write_group()
277
except Exception, exc:
278
self._write_group = None
279
if not suppress_errors:
281
mutter('abort_write_group failed')
282
log_exception_quietly()
283
note('bzr: ERROR (ignored): %s', exc)
284
self._write_group = None
286
def _abort_write_group(self):
287
"""Template method for per-repository write group cleanup.
289
This is called during abort before the write group is considered to be
290
finished and should cleanup any internal state accrued during the write
291
group. There is no requirement that data handed to the repository be
292
*not* made available - this is not a rollback - but neither should any
293
attempt be made to ensure that data added is fully commited. Abort is
294
invoked when an error has occured so futher disk or network operations
295
may not be possible or may error and if possible should not be
299
def add_fallback_repository(self, repository):
300
"""Add a repository to use for looking up data not held locally.
302
:param repository: A repository.
304
raise NotImplementedError(self.add_fallback_repository)
306
def _check_fallback_repository(self, repository):
307
"""Check that this repository can fallback to repository safely.
309
Raise an error if not.
311
:param repository: A repository to fallback to.
313
return InterRepository._assert_same_model(self, repository)
315
def all_revision_ids(self):
316
"""Returns a list of all the revision ids in the repository.
318
This is conceptually deprecated because code should generally work on
319
the graph reachable from a particular revision, and ignore any other
320
revisions that might be present. There is no direct replacement
323
if 'evil' in debug.debug_flags:
324
mutter_callsite(2, "all_revision_ids is linear with history.")
325
return self._all_revision_ids()
327
def _all_revision_ids(self):
328
"""Returns a list of all the revision ids in the repository.
330
These are in as much topological order as the underlying store can
333
raise NotImplementedError(self._all_revision_ids)
335
def break_lock(self):
336
"""Break a lock if one is present from another instance.
338
Uses the ui factory to ask for confirmation if the lock may be from
341
self.control_files.break_lock()
344
def create(a_bzrdir):
345
"""Construct the current default format repository in a_bzrdir."""
346
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
348
def __init__(self, _format, a_bzrdir, control_files):
349
"""instantiate a Repository.
351
:param _format: The format of the repository on disk.
352
:param a_bzrdir: The BzrDir of the repository.
353
:param control_files: Control files to use for locking, etc.
355
# In the future we will have a single api for all stores for
356
# getting file texts, inventories and revisions, then
357
# this construct will accept instances of those things.
358
super(Repository, self).__init__()
359
self._format = _format
360
# the following are part of the public API for Repository:
361
self.bzrdir = a_bzrdir
362
self.control_files = control_files
363
self._transport = control_files._transport
364
self.base = self._transport.base
366
self._write_group = None
367
# Additional places to query for data.
368
self._fallback_repositories = []
371
def user_transport(self):
372
return self.bzrdir.user_transport
375
def control_transport(self):
376
return self._transport
379
if self._fallback_repositories:
380
return '%s(%r, fallback_repositories=%r)' % (
381
self.__class__.__name__,
383
self._fallback_repositories)
385
return '%s(%r)' % (self.__class__.__name__,
388
def _has_same_fallbacks(self, other_repo):
389
"""Returns true if the repositories have the same fallbacks."""
390
my_fb = self._fallback_repositories
391
other_fb = other_repo._fallback_repositories
392
if len(my_fb) != len(other_fb):
394
for f, g in zip(my_fb, other_fb):
395
if not f.has_same_location(g):
399
def has_same_location(self, other):
400
"""Returns a boolean indicating if this repository is at the same
401
location as another repository.
403
This might return False even when two repository objects are accessing
404
the same physical repository via different URLs.
406
if self.__class__ is not other.__class__:
408
return (self._transport.base == other._transport.base)
410
def is_in_write_group(self):
411
"""Return True if there is an open write group.
413
:seealso: start_write_group.
415
return self._write_group is not None
418
return self.control_files.is_locked()
420
def is_write_locked(self):
421
"""Return True if this object is write locked."""
422
return self.is_locked() and self.control_files._lock_mode == 'w'
424
def lock_write(self, token=None):
425
"""Lock this repository for writing.
427
This causes caching within the repository obejct to start accumlating
428
data during reads, and allows a 'write_group' to be obtained. Write
429
groups must be used for actual data insertion.
431
A token should be passed in if you know that you have locked the object
432
some other way, and need to synchronise this object's state with that
435
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
437
:param token: if this is already locked, then lock_write will fail
438
unless the token matches the existing lock.
439
:returns: a token if this instance supports tokens, otherwise None.
440
:raises TokenLockingNotSupported: when a token is given but this
441
instance doesn't support using token locks.
442
:raises MismatchedToken: if the specified token doesn't match the token
443
of the existing lock.
444
:seealso: start_write_group.
445
:return: A RepositoryWriteLockResult.
447
locked = self.is_locked()
448
token = self.control_files.lock_write(token=token)
450
self._warn_if_deprecated()
452
for repo in self._fallback_repositories:
453
# Writes don't affect fallback repos
456
return RepositoryWriteLockResult(self.unlock, token)
459
"""Lock the repository for read operations.
461
:return: An object with an unlock method which will release the lock
464
locked = self.is_locked()
465
self.control_files.lock_read()
467
self._warn_if_deprecated()
469
for repo in self._fallback_repositories:
472
return LogicalLockResult(self.unlock)
474
def get_physical_lock_status(self):
475
return self.control_files.get_physical_lock_status()
477
def leave_lock_in_place(self):
478
"""Tell this repository not to release the physical lock when this
481
If lock_write doesn't return a token, then this method is not supported.
483
self.control_files.leave_in_place()
485
def dont_leave_lock_in_place(self):
486
"""Tell this repository to release the physical lock when this
487
object is unlocked, even if it didn't originally acquire it.
489
If lock_write doesn't return a token, then this method is not supported.
491
self.control_files.dont_leave_in_place()
494
def gather_stats(self, revid=None, committers=None):
495
"""Gather statistics from a revision id.
497
:param revid: The revision id to gather statistics from, if None, then
498
no revision specific statistics are gathered.
499
:param committers: Optional parameter controlling whether to grab
500
a count of committers from the revision specific statistics.
501
:return: A dictionary of statistics. Currently this contains:
502
committers: The number of committers if requested.
503
firstrev: A tuple with timestamp, timezone for the penultimate left
504
most ancestor of revid, if revid is not the NULL_REVISION.
505
latestrev: A tuple with timestamp, timezone for revid, if revid is
506
not the NULL_REVISION.
507
revisions: The total revision count in the repository.
508
size: An estimate disk size of the repository in bytes.
511
if revid and committers:
512
result['committers'] = 0
513
if revid and revid != _mod_revision.NULL_REVISION:
514
graph = self.get_graph()
516
all_committers = set()
517
revisions = [r for (r, p) in graph.iter_ancestry([revid])
518
if r != _mod_revision.NULL_REVISION]
521
# ignore the revisions in the middle - just grab first and last
522
revisions = revisions[0], revisions[-1]
523
for revision in self.get_revisions(revisions):
524
if not last_revision:
525
last_revision = revision
527
all_committers.add(revision.committer)
528
first_revision = revision
530
result['committers'] = len(all_committers)
531
result['firstrev'] = (first_revision.timestamp,
532
first_revision.timezone)
533
result['latestrev'] = (last_revision.timestamp,
534
last_revision.timezone)
537
def find_branches(self, using=False):
538
"""Find branches underneath this repository.
540
This will include branches inside other branches.
542
:param using: If True, list only branches using this repository.
544
if using and not self.is_shared():
545
return self.bzrdir.list_branches()
546
class Evaluator(object):
549
self.first_call = True
551
def __call__(self, bzrdir):
552
# On the first call, the parameter is always the bzrdir
553
# containing the current repo.
554
if not self.first_call:
556
repository = bzrdir.open_repository()
557
except errors.NoRepositoryPresent:
560
return False, ([], repository)
561
self.first_call = False
562
value = (bzrdir.list_branches(), None)
566
for branches, repository in bzrdir.BzrDir.find_bzrdirs(
567
self.user_transport, evaluate=Evaluator()):
568
if branches is not None:
570
if not using and repository is not None:
571
ret.extend(repository.find_branches())
575
def search_missing_revision_ids(self, other,
576
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
577
find_ghosts=True, revision_ids=None, if_present_ids=None,
579
"""Return the revision ids that other has that this does not.
581
These are returned in topological order.
583
revision_id: only return revision ids included by revision_id.
585
if symbol_versioning.deprecated_passed(revision_id):
586
symbol_versioning.warn(
587
'search_missing_revision_ids(revision_id=...) was '
588
'deprecated in 2.4. Use revision_ids=[...] instead.',
589
DeprecationWarning, stacklevel=3)
590
if revision_ids is not None:
591
raise AssertionError(
592
'revision_ids is mutually exclusive with revision_id')
593
if revision_id is not None:
594
revision_ids = [revision_id]
595
return InterRepository.get(other, self).search_missing_revision_ids(
596
find_ghosts=find_ghosts, revision_ids=revision_ids,
597
if_present_ids=if_present_ids, limit=limit)
601
"""Open the repository rooted at base.
603
For instance, if the repository is at URL/.bzr/repository,
604
Repository.open(URL) -> a Repository instance.
606
control = bzrdir.BzrDir.open(base)
607
return control.open_repository()
609
def copy_content_into(self, destination, revision_id=None):
610
"""Make a complete copy of the content in self into destination.
612
This is a destructive operation! Do not use it on existing
615
return InterRepository.get(self, destination).copy_content(revision_id)
617
def commit_write_group(self):
618
"""Commit the contents accrued within the current write group.
620
:seealso: start_write_group.
622
:return: it may return an opaque hint that can be passed to 'pack'.
624
if self._write_group is not self.get_transaction():
625
# has an unlock or relock occured ?
626
raise errors.BzrError('mismatched lock context %r and '
628
(self.get_transaction(), self._write_group))
629
result = self._commit_write_group()
630
self._write_group = None
633
def _commit_write_group(self):
634
"""Template method for per-repository write group cleanup.
636
This is called before the write group is considered to be
637
finished and should ensure that all data handed to the repository
638
for writing during the write group is safely committed (to the
639
extent possible considering file system caching etc).
642
def suspend_write_group(self):
643
raise errors.UnsuspendableWriteGroup(self)
645
def refresh_data(self):
646
"""Re-read any data needed to synchronise with disk.
648
This method is intended to be called after another repository instance
649
(such as one used by a smart server) has inserted data into the
650
repository. On all repositories this will work outside of write groups.
651
Some repository formats (pack and newer for bzrlib native formats)
652
support refresh_data inside write groups. If called inside a write
653
group on a repository that does not support refreshing in a write group
654
IsInWriteGroupError will be raised.
658
def resume_write_group(self, tokens):
659
if not self.is_write_locked():
660
raise errors.NotWriteLocked(self)
661
if self._write_group:
662
raise errors.BzrError('already in a write group')
663
self._resume_write_group(tokens)
664
# so we can detect unlock/relock - the write group is now entered.
665
self._write_group = self.get_transaction()
667
def _resume_write_group(self, tokens):
668
raise errors.UnsuspendableWriteGroup(self)
670
def fetch(self, source, revision_id=None, find_ghosts=False,
672
"""Fetch the content required to construct revision_id from source.
674
If revision_id is None and fetch_spec is None, then all content is
677
fetch() may not be used when the repository is in a write group -
678
either finish the current write group before using fetch, or use
679
fetch before starting the write group.
681
:param find_ghosts: Find and copy revisions in the source that are
682
ghosts in the target (and not reachable directly by walking out to
683
the first-present revision in target from revision_id).
684
:param revision_id: If specified, all the content needed for this
685
revision ID will be copied to the target. Fetch will determine for
686
itself which content needs to be copied.
687
:param fetch_spec: If specified, a SearchResult or
688
PendingAncestryResult that describes which revisions to copy. This
689
allows copying multiple heads at once. Mutually exclusive with
692
if fetch_spec is not None and revision_id is not None:
693
raise AssertionError(
694
"fetch_spec and revision_id are mutually exclusive.")
695
if self.is_in_write_group():
696
raise errors.InternalBzrError(
697
"May not fetch while in a write group.")
698
# fast path same-url fetch operations
699
# TODO: lift out to somewhere common with RemoteRepository
700
# <https://bugs.launchpad.net/bzr/+bug/401646>
701
if (self.has_same_location(source)
702
and fetch_spec is None
703
and self._has_same_fallbacks(source)):
704
# check that last_revision is in 'from' and then return a
706
if (revision_id is not None and
707
not _mod_revision.is_null(revision_id)):
708
self.get_revision(revision_id)
710
inter = InterRepository.get(source, self)
711
return inter.fetch(revision_id=revision_id,
712
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
714
def create_bundle(self, target, base, fileobj, format=None):
715
return serializer.write_bundle(self, target, base, fileobj, format)
717
def get_commit_builder(self, branch, parents, config, timestamp=None,
718
timezone=None, committer=None, revprops=None,
719
revision_id=None, lossy=False):
720
"""Obtain a CommitBuilder for this repository.
722
:param branch: Branch to commit to.
723
:param parents: Revision ids of the parents of the new revision.
724
:param config: Configuration to use.
725
:param timestamp: Optional timestamp recorded for commit.
726
:param timezone: Optional timezone for timestamp.
727
:param committer: Optional committer to set for commit.
728
:param revprops: Optional dictionary of revision properties.
729
:param revision_id: Optional revision id.
730
:param lossy: Whether to discard data that can not be natively
731
represented, when pushing to a foreign VCS
733
raise NotImplementedError(self.get_commit_builder)
735
@only_raises(errors.LockNotHeld, errors.LockBroken)
737
if (self.control_files._lock_count == 1 and
738
self.control_files._lock_mode == 'w'):
739
if self._write_group is not None:
740
self.abort_write_group()
741
self.control_files.unlock()
742
raise errors.BzrError(
743
'Must end write groups before releasing write locks.')
744
self.control_files.unlock()
745
if self.control_files._lock_count == 0:
746
for repo in self._fallback_repositories:
750
def clone(self, a_bzrdir, revision_id=None):
751
"""Clone this repository into a_bzrdir using the current format.
753
Currently no check is made that the format of this repository and
754
the bzrdir format are compatible. FIXME RBC 20060201.
756
:return: The newly created destination repository.
758
# TODO: deprecate after 0.16; cloning this with all its settings is
759
# probably not very useful -- mbp 20070423
760
dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
761
self.copy_content_into(dest_repo, revision_id)
764
def start_write_group(self):
765
"""Start a write group in the repository.
767
Write groups are used by repositories which do not have a 1:1 mapping
768
between file ids and backend store to manage the insertion of data from
769
both fetch and commit operations.
771
A write lock is required around the start_write_group/commit_write_group
772
for the support of lock-requiring repository formats.
774
One can only insert data into a repository inside a write group.
778
if not self.is_write_locked():
779
raise errors.NotWriteLocked(self)
780
if self._write_group:
781
raise errors.BzrError('already in a write group')
782
self._start_write_group()
783
# so we can detect unlock/relock - the write group is now entered.
784
self._write_group = self.get_transaction()
786
def _start_write_group(self):
787
"""Template method for per-repository write group startup.
789
This is called before the write group is considered to be
794
def sprout(self, to_bzrdir, revision_id=None):
795
"""Create a descendent repository for new development.
797
Unlike clone, this does not copy the settings of the repository.
799
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
800
dest_repo.fetch(self, revision_id=revision_id)
803
def _create_sprouting_repo(self, a_bzrdir, shared):
804
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
805
# use target default format.
806
dest_repo = a_bzrdir.create_repository()
808
# Most control formats need the repository to be specifically
809
# created, but on some old all-in-one formats it's not needed
811
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
812
except errors.UninitializableFormat:
813
dest_repo = a_bzrdir.open_repository()
817
def has_revision(self, revision_id):
818
"""True if this repository has a copy of the revision."""
819
return revision_id in self.has_revisions((revision_id,))
822
def has_revisions(self, revision_ids):
823
"""Probe to find out the presence of multiple revisions.
825
:param revision_ids: An iterable of revision_ids.
826
:return: A set of the revision_ids that were present.
828
raise NotImplementedError(self.has_revisions)
831
def get_revision(self, revision_id):
832
"""Return the Revision object for a named revision."""
833
return self.get_revisions([revision_id])[0]
835
def get_revision_reconcile(self, revision_id):
836
"""'reconcile' helper routine that allows access to a revision always.
838
This variant of get_revision does not cross check the weave graph
839
against the revision one as get_revision does: but it should only
840
be used by reconcile, or reconcile-alike commands that are correcting
841
or testing the revision graph.
843
raise NotImplementedError(self.get_revision_reconcile)
845
def get_revisions(self, revision_ids):
846
"""Get many revisions at once.
848
Repositories that need to check data on every revision read should
849
subclass this method.
851
raise NotImplementedError(self.get_revisions)
853
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
854
"""Produce a generator of revision deltas.
856
Note that the input is a sequence of REVISIONS, not revision_ids.
857
Trees will be held in memory until the generator exits.
858
Each delta is relative to the revision's lefthand predecessor.
860
:param specific_fileids: if not None, the result is filtered
861
so that only those file-ids, their parents and their
862
children are included.
864
# Get the revision-ids of interest
865
required_trees = set()
866
for revision in revisions:
867
required_trees.add(revision.revision_id)
868
required_trees.update(revision.parent_ids[:1])
870
# Get the matching filtered trees. Note that it's more
871
# efficient to pass filtered trees to changes_from() rather
872
# than doing the filtering afterwards. changes_from() could
873
# arguably do the filtering itself but it's path-based, not
874
# file-id based, so filtering before or afterwards is
876
if specific_fileids is None:
877
trees = dict((t.get_revision_id(), t) for
878
t in self.revision_trees(required_trees))
880
trees = dict((t.get_revision_id(), t) for
881
t in self._filtered_revision_trees(required_trees,
884
# Calculate the deltas
885
for revision in revisions:
886
if not revision.parent_ids:
887
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
889
old_tree = trees[revision.parent_ids[0]]
890
yield trees[revision.revision_id].changes_from(old_tree)
893
def get_revision_delta(self, revision_id, specific_fileids=None):
894
"""Return the delta for one revision.
896
The delta is relative to the left-hand predecessor of the
899
:param specific_fileids: if not None, the result is filtered
900
so that only those file-ids, their parents and their
901
children are included.
903
r = self.get_revision(revision_id)
904
return list(self.get_deltas_for_revisions([r],
905
specific_fileids=specific_fileids))[0]
908
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
909
signature = gpg_strategy.sign(plaintext)
910
self.add_signature_text(revision_id, signature)
912
def add_signature_text(self, revision_id, signature):
913
"""Store a signature text for a revision.
915
:param revision_id: Revision id of the revision
916
:param signature: Signature text.
918
raise NotImplementedError(self.add_signature_text)
920
def _find_parent_ids_of_revisions(self, revision_ids):
921
"""Find all parent ids that are mentioned in the revision graph.
923
:return: set of revisions that are parents of revision_ids which are
924
not part of revision_ids themselves
926
parent_map = self.get_parent_map(revision_ids)
928
map(parent_ids.update, parent_map.itervalues())
929
parent_ids.difference_update(revision_ids)
930
parent_ids.discard(_mod_revision.NULL_REVISION)
933
def fileids_altered_by_revision_ids(self, revision_ids):
934
"""Find the file ids and versions affected by revisions.
936
:param revisions: an iterable containing revision ids.
937
:return: a dictionary mapping altered file-ids to an iterable of
938
revision_ids. Each altered file-ids has the exact revision_ids
939
that altered it listed explicitly.
941
raise NotImplementedError(self.fileids_altered_by_revision_ids)
943
def iter_files_bytes(self, desired_files):
944
"""Iterate through file versions.
946
Files will not necessarily be returned in the order they occur in
947
desired_files. No specific order is guaranteed.
949
Yields pairs of identifier, bytes_iterator. identifier is an opaque
950
value supplied by the caller as part of desired_files. It should
951
uniquely identify the file version in the caller's context. (Examples:
952
an index number or a TreeTransform trans_id.)
954
:param desired_files: a list of (file_id, revision_id, identifier)
957
raise NotImplementedError(self.iter_files_bytes)
959
def get_rev_id_for_revno(self, revno, known_pair):
960
"""Return the revision id of a revno, given a later (revno, revid)
961
pair in the same history.
963
:return: if found (True, revid). If the available history ran out
964
before reaching the revno, then this returns
965
(False, (closest_revno, closest_revid)).
967
known_revno, known_revid = known_pair
968
partial_history = [known_revid]
969
distance_from_known = known_revno - revno
970
if distance_from_known < 0:
972
'requested revno (%d) is later than given known revno (%d)'
973
% (revno, known_revno))
976
self, partial_history, stop_index=distance_from_known)
977
except errors.RevisionNotPresent, err:
978
if err.revision_id == known_revid:
979
# The start revision (known_revid) wasn't found.
981
# This is a stacked repository with no fallbacks, or a there's a
982
# left-hand ghost. Either way, even though the revision named in
983
# the error isn't in this repo, we know it's the next step in this
985
partial_history.append(err.revision_id)
986
if len(partial_history) <= distance_from_known:
987
# Didn't find enough history to get a revid for the revno.
988
earliest_revno = known_revno - len(partial_history) + 1
989
return (False, (earliest_revno, partial_history[-1]))
990
if len(partial_history) - 1 > distance_from_known:
991
raise AssertionError('_iter_for_revno returned too much history')
992
return (True, partial_history[-1])
994
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
995
def iter_reverse_revision_history(self, revision_id):
996
"""Iterate backwards through revision ids in the lefthand history
998
:param revision_id: The revision id to start with. All its lefthand
999
ancestors will be traversed.
1001
graph = self.get_graph()
1002
stop_revisions = (None, _mod_revision.NULL_REVISION)
1003
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
1005
def is_shared(self):
1006
"""Return True if this repository is flagged as a shared repository."""
1007
raise NotImplementedError(self.is_shared)
1010
def reconcile(self, other=None, thorough=False):
1011
"""Reconcile this repository."""
1012
from bzrlib.reconcile import RepoReconciler
1013
reconciler = RepoReconciler(self, thorough=thorough)
1014
reconciler.reconcile()
1017
def _refresh_data(self):
1018
"""Helper called from lock_* to ensure coherency with disk.
1020
The default implementation does nothing; it is however possible
1021
for repositories to maintain loaded indices across multiple locks
1022
by checking inside their implementation of this method to see
1023
whether their indices are still valid. This depends of course on
1024
the disk format being validatable in this manner. This method is
1025
also called by the refresh_data() public interface to cause a refresh
1026
to occur while in a write lock so that data inserted by a smart server
1027
push operation is visible on the client's instance of the physical
1032
def revision_tree(self, revision_id):
1033
"""Return Tree for a revision on this branch.
1035
`revision_id` may be NULL_REVISION for the empty tree revision.
1037
raise NotImplementedError(self.revision_tree)
1039
def revision_trees(self, revision_ids):
1040
"""Return Trees for revisions in this repository.
1042
:param revision_ids: a sequence of revision-ids;
1043
a revision-id may not be None or 'null:'
1045
raise NotImplementedError(self.revision_trees)
1048
@symbol_versioning.deprecated_method(
1049
symbol_versioning.deprecated_in((2, 4, 0)))
1050
def get_ancestry(self, revision_id, topo_sorted=True):
1051
"""Return a list of revision-ids integrated by a revision.
1053
The first element of the list is always None, indicating the origin
1054
revision. This might change when we have history horizons, or
1055
perhaps we should have a new API.
1057
This is topologically sorted.
1059
if 'evil' in debug.debug_flags:
1060
mutter_callsite(2, "get_ancestry is linear with history.")
1061
if _mod_revision.is_null(revision_id):
1063
if not self.has_revision(revision_id):
1064
raise errors.NoSuchRevision(self, revision_id)
1065
graph = self.get_graph()
1067
search = graph._make_breadth_first_searcher([revision_id])
1070
found, ghosts = search.next_with_ghosts()
1071
except StopIteration:
1074
if _mod_revision.NULL_REVISION in keys:
1075
keys.remove(_mod_revision.NULL_REVISION)
1077
parent_map = graph.get_parent_map(keys)
1078
keys = tsort.topo_sort(parent_map)
1079
return [None] + list(keys)
1081
def pack(self, hint=None, clean_obsolete_packs=False):
1082
"""Compress the data within the repository.
1084
This operation only makes sense for some repository types. For other
1085
types it should be a no-op that just returns.
1087
This stub method does not require a lock, but subclasses should use
1088
@needs_write_lock as this is a long running call it's reasonable to
1089
implicitly lock for the user.
1091
:param hint: If not supplied, the whole repository is packed.
1092
If supplied, the repository may use the hint parameter as a
1093
hint for the parts of the repository to pack. A hint can be
1094
obtained from the result of commit_write_group(). Out of
1095
date hints are simply ignored, because concurrent operations
1096
can obsolete them rapidly.
1098
:param clean_obsolete_packs: Clean obsolete packs immediately after
1102
def get_transaction(self):
1103
return self.control_files.get_transaction()
1105
def get_parent_map(self, revision_ids):
1106
"""See graph.StackedParentsProvider.get_parent_map"""
1107
raise NotImplementedError(self.get_parent_map)
1109
def _get_parent_map_no_fallbacks(self, revision_ids):
1110
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1111
# revisions index works in keys; this just works in revisions
1112
# therefore wrap and unwrap
1115
for revision_id in revision_ids:
1116
if revision_id == _mod_revision.NULL_REVISION:
1117
result[revision_id] = ()
1118
elif revision_id is None:
1119
raise ValueError('get_parent_map(None) is not valid')
1121
query_keys.append((revision_id ,))
1122
vf = self.revisions.without_fallbacks()
1123
for ((revision_id,), parent_keys) in \
1124
vf.get_parent_map(query_keys).iteritems():
1126
result[revision_id] = tuple([parent_revid
1127
for (parent_revid,) in parent_keys])
1129
result[revision_id] = (_mod_revision.NULL_REVISION,)
1132
def _make_parents_provider(self):
1133
if not self._format.supports_external_lookups:
1135
return graph.StackedParentsProvider(_LazyListJoin(
1136
[self._make_parents_provider_unstacked()],
1137
self._fallback_repositories))
1139
def _make_parents_provider_unstacked(self):
1140
return graph.CallableToParentsProviderAdapter(
1141
self._get_parent_map_no_fallbacks)
1144
def get_known_graph_ancestry(self, revision_ids):
1145
"""Return the known graph for a set of revision ids and their ancestors.
1147
raise NotImplementedError(self.get_known_graph_ancestry)
1149
def get_file_graph(self):
1150
"""Return the graph walker for files."""
1151
raise NotImplementedError(self.get_file_graph)
1153
def get_graph(self, other_repository=None):
1154
"""Return the graph walker for this repository format"""
1155
parents_provider = self._make_parents_provider()
1156
if (other_repository is not None and
1157
not self.has_same_location(other_repository)):
1158
parents_provider = graph.StackedParentsProvider(
1159
[parents_provider, other_repository._make_parents_provider()])
1160
return graph.Graph(parents_provider)
1162
def revision_ids_to_search_result(self, result_set):
1163
"""Convert a set of revision ids to a graph SearchResult."""
1164
result_parents = set()
1165
for parents in self.get_graph().get_parent_map(
1166
result_set).itervalues():
1167
result_parents.update(parents)
1168
included_keys = result_set.intersection(result_parents)
1169
start_keys = result_set.difference(included_keys)
1170
exclude_keys = result_parents.difference(result_set)
1171
result = graph.SearchResult(start_keys, exclude_keys,
1172
len(result_set), result_set)
1176
def set_make_working_trees(self, new_value):
1177
"""Set the policy flag for making working trees when creating branches.
1179
This only applies to branches that use this repository.
1181
The default is 'True'.
1182
:param new_value: True to restore the default, False to disable making
1185
raise NotImplementedError(self.set_make_working_trees)
1187
def make_working_trees(self):
1188
"""Returns the policy for making working trees on new branches."""
1189
raise NotImplementedError(self.make_working_trees)
1192
def sign_revision(self, revision_id, gpg_strategy):
1193
testament = _mod_testament.Testament.from_revision(self, revision_id)
1194
plaintext = testament.as_short_text()
1195
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1198
def verify_revision(self, revision_id, gpg_strategy):
1199
"""Verify the signature on a revision.
1201
:param revision_id: the revision to verify
1202
:gpg_strategy: the GPGStrategy object to used
1204
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1206
if not self.has_signature_for_revision_id(revision_id):
1207
return gpg.SIGNATURE_NOT_SIGNED, None
1208
signature = self.get_signature_text(revision_id)
1210
testament = _mod_testament.Testament.from_revision(self, revision_id)
1211
plaintext = testament.as_short_text()
1213
return gpg_strategy.verify(signature, plaintext)
1215
def has_signature_for_revision_id(self, revision_id):
1216
"""Query for a revision signature for revision_id in the repository."""
1217
raise NotImplementedError(self.has_signature_for_revision_id)
1219
def get_signature_text(self, revision_id):
1220
"""Return the text for a signature."""
1221
raise NotImplementedError(self.get_signature_text)
1223
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1224
"""Check consistency of all history of given revision_ids.
1226
Different repository implementations should override _check().
1228
:param revision_ids: A non-empty list of revision_ids whose ancestry
1229
will be checked. Typically the last revision_id of a branch.
1230
:param callback_refs: A dict of check-refs to resolve and callback
1231
the check/_check method on the items listed as wanting the ref.
1233
:param check_repo: If False do not check the repository contents, just
1234
calculate the data callback_refs requires and call them back.
1236
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1237
check_repo=check_repo)
1239
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1240
raise NotImplementedError(self.check)
1242
def _warn_if_deprecated(self, branch=None):
1243
if not self._format.is_deprecated():
1245
global _deprecation_warning_done
1246
if _deprecation_warning_done:
1250
conf = config.GlobalConfig()
1252
conf = branch.get_config()
1253
if conf.suppress_warning('format_deprecation'):
1255
warning("Format %s for %s is deprecated -"
1256
" please use 'bzr upgrade' to get better performance"
1257
% (self._format, self.bzrdir.transport.base))
1259
_deprecation_warning_done = True
1261
def supports_rich_root(self):
1262
return self._format.rich_root_data
1264
def _check_ascii_revisionid(self, revision_id, method):
1265
"""Private helper for ascii-only repositories."""
1266
# weave repositories refuse to store revisionids that are non-ascii.
1267
if revision_id is not None:
1268
# weaves require ascii revision ids.
1269
if isinstance(revision_id, unicode):
1271
revision_id.encode('ascii')
1272
except UnicodeEncodeError:
1273
raise errors.NonAsciiRevisionId(method, self)
1276
revision_id.decode('ascii')
1277
except UnicodeDecodeError:
1278
raise errors.NonAsciiRevisionId(method, self)
1281
class MetaDirRepository(Repository):
1282
"""Repositories in the new meta-dir layout.
1284
:ivar _transport: Transport for access to repository control files,
1285
typically pointing to .bzr/repository.
1288
def __init__(self, _format, a_bzrdir, control_files):
1289
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1290
self._transport = control_files._transport
1292
def is_shared(self):
1293
"""Return True if this repository is flagged as a shared repository."""
1294
return self._transport.has('shared-storage')
1297
def set_make_working_trees(self, new_value):
1298
"""Set the policy flag for making working trees when creating branches.
1300
This only applies to branches that use this repository.
1302
The default is 'True'.
1303
:param new_value: True to restore the default, False to disable making
1308
self._transport.delete('no-working-trees')
1309
except errors.NoSuchFile:
1312
self._transport.put_bytes('no-working-trees', '',
1313
mode=self.bzrdir._get_file_mode())
1315
def make_working_trees(self):
1316
"""Returns the policy for making working trees on new branches."""
1317
return not self._transport.has('no-working-trees')
1320
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1321
"""Repository format registry."""
1323
def get_default(self):
1324
"""Return the current default format."""
1325
from bzrlib import bzrdir
1326
return bzrdir.format_registry.make_bzrdir('default').repository_format
1329
network_format_registry = registry.FormatRegistry()
1330
"""Registry of formats indexed by their network name.
1332
The network name for a repository format is an identifier that can be used when
1333
referring to formats with smart server operations. See
1334
RepositoryFormat.network_name() for more detail.
1338
format_registry = RepositoryFormatRegistry(network_format_registry)
1339
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1341
This can contain either format instances themselves, or classes/factories that
1342
can be called to obtain one.
1346
#####################################################################
1347
# Repository Formats
1349
class RepositoryFormat(controldir.ControlComponentFormat):
1350
"""A repository format.
1352
Formats provide four things:
1353
* An initialization routine to construct repository data on disk.
1354
* a optional format string which is used when the BzrDir supports
1356
* an open routine which returns a Repository instance.
1357
* A network name for referring to the format in smart server RPC
1360
There is one and only one Format subclass for each on-disk format. But
1361
there can be one Repository subclass that is used for several different
1362
formats. The _format attribute on a Repository instance can be used to
1363
determine the disk format.
1365
Formats are placed in a registry by their format string for reference
1366
during opening. These should be subclasses of RepositoryFormat for
1369
Once a format is deprecated, just deprecate the initialize and open
1370
methods on the format class. Do not deprecate the object, as the
1371
object may be created even when a repository instance hasn't been
1374
Common instance attributes:
1375
_matchingbzrdir - the bzrdir format that the repository format was
1376
originally written to work with. This can be used if manually
1377
constructing a bzrdir and repository, or more commonly for test suite
1381
# Set to True or False in derived classes. True indicates that the format
1382
# supports ghosts gracefully.
1383
supports_ghosts = None
1384
# Can this repository be given external locations to lookup additional
1385
# data. Set to True or False in derived classes.
1386
supports_external_lookups = None
1387
# Does this format support CHK bytestring lookups. Set to True or False in
1389
supports_chks = None
1390
# Should fetch trigger a reconcile after the fetch? Only needed for
1391
# some repository formats that can suffer internal inconsistencies.
1392
_fetch_reconcile = False
1393
# Does this format have < O(tree_size) delta generation. Used to hint what
1394
# code path for commit, amongst other things.
1396
# Does doing a pack operation compress data? Useful for the pack UI command
1397
# (so if there is one pack, the operation can still proceed because it may
1398
# help), and for fetching when data won't have come from the same
1400
pack_compresses = False
1401
# Does the repository storage understand references to trees?
1402
supports_tree_reference = None
1403
# Is the format experimental ?
1404
experimental = False
1405
# Does this repository format escape funky characters, or does it create
1406
# files with similar names as the versioned files in its contents on disk
1408
supports_funky_characters = None
1409
# Does this repository format support leaving locks?
1410
supports_leaving_lock = None
1411
# Does this format support the full VersionedFiles interface?
1412
supports_full_versioned_files = None
1413
# Does this format support signing revision signatures?
1414
supports_revision_signatures = True
1415
# Can the revision graph have incorrect parents?
1416
revision_graph_can_have_wrong_parents = None
1417
# Does this format support rich root data?
1418
rich_root_data = None
1419
# Does this format support explicitly versioned directories?
1420
supports_versioned_directories = None
1423
return "%s()" % self.__class__.__name__
1425
def __eq__(self, other):
1426
# format objects are generally stateless
1427
return isinstance(other, self.__class__)
1429
def __ne__(self, other):
1430
return not self == other
1433
def find_format(klass, a_bzrdir):
1434
"""Return the format for the repository object in a_bzrdir.
1436
This is used by bzr native formats that have a "format" file in
1437
the repository. Other methods may be used by different types of
1441
transport = a_bzrdir.get_repository_transport(None)
1442
format_string = transport.get_bytes("format")
1443
return format_registry.get(format_string)
1444
except errors.NoSuchFile:
1445
raise errors.NoRepositoryPresent(a_bzrdir)
1447
raise errors.UnknownFormatError(format=format_string,
1451
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1452
def register_format(klass, format):
1453
format_registry.register(format)
1456
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1457
def unregister_format(klass, format):
1458
format_registry.remove(format)
1461
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1462
def get_default_format(klass):
1463
"""Return the current default format."""
1464
return format_registry.get_default()
1466
def get_format_string(self):
1467
"""Return the ASCII format string that identifies this format.
1469
Note that in pre format ?? repositories the format string is
1470
not permitted nor written to disk.
1472
raise NotImplementedError(self.get_format_string)
1474
def get_format_description(self):
1475
"""Return the short description for this format."""
1476
raise NotImplementedError(self.get_format_description)
1478
def initialize(self, a_bzrdir, shared=False):
1479
"""Initialize a repository of this format in a_bzrdir.
1481
:param a_bzrdir: The bzrdir to put the new repository in it.
1482
:param shared: The repository should be initialized as a sharable one.
1483
:returns: The new repository object.
1485
This may raise UninitializableFormat if shared repository are not
1486
compatible the a_bzrdir.
1488
raise NotImplementedError(self.initialize)
1490
def is_supported(self):
1491
"""Is this format supported?
1493
Supported formats must be initializable and openable.
1494
Unsupported formats may not support initialization or committing or
1495
some other features depending on the reason for not being supported.
1499
def is_deprecated(self):
1500
"""Is this format deprecated?
1502
Deprecated formats may trigger a user-visible warning recommending
1503
the user to upgrade. They are still fully supported.
1507
def network_name(self):
1508
"""A simple byte string uniquely identifying this format for RPC calls.
1510
MetaDir repository formats use their disk format string to identify the
1511
repository over the wire. All in one formats such as bzr < 0.8, and
1512
foreign formats like svn/git and hg should use some marker which is
1513
unique and immutable.
1515
raise NotImplementedError(self.network_name)
1517
def check_conversion_target(self, target_format):
1518
if self.rich_root_data and not target_format.rich_root_data:
1519
raise errors.BadConversionTarget(
1520
'Does not support rich root data.', target_format,
1522
if (self.supports_tree_reference and
1523
not getattr(target_format, 'supports_tree_reference', False)):
1524
raise errors.BadConversionTarget(
1525
'Does not support nested trees', target_format,
1528
def open(self, a_bzrdir, _found=False):
1529
"""Return an instance of this format for the bzrdir a_bzrdir.
1531
_found is a private parameter, do not use it.
1533
raise NotImplementedError(self.open)
1535
def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
1536
from bzrlib.bzrdir import BzrDir, RepoInitHookParams
1537
hooks = BzrDir.hooks['post_repo_init']
1540
params = RepoInitHookParams(repository, self, a_bzrdir, shared)
1545
class MetaDirRepositoryFormat(RepositoryFormat):
1546
"""Common base class for the new repositories using the metadir layout."""
1548
rich_root_data = False
1549
supports_tree_reference = False
1550
supports_external_lookups = False
1551
supports_leaving_lock = True
1554
def _matchingbzrdir(self):
1555
matching = bzrdir.BzrDirMetaFormat1()
1556
matching.repository_format = self
1560
super(MetaDirRepositoryFormat, self).__init__()
1562
def _create_control_files(self, a_bzrdir):
1563
"""Create the required files and the initial control_files object."""
1564
# FIXME: RBC 20060125 don't peek under the covers
1565
# NB: no need to escape relative paths that are url safe.
1566
repository_transport = a_bzrdir.get_repository_transport(self)
1567
control_files = lockable_files.LockableFiles(repository_transport,
1568
'lock', lockdir.LockDir)
1569
control_files.create_lock()
1570
return control_files
1572
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1573
"""Upload the initial blank content."""
1574
control_files = self._create_control_files(a_bzrdir)
1575
control_files.lock_write()
1576
transport = control_files._transport
1578
utf8_files += [('shared-storage', '')]
1580
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1581
for (filename, content_stream) in files:
1582
transport.put_file(filename, content_stream,
1583
mode=a_bzrdir._get_file_mode())
1584
for (filename, content_bytes) in utf8_files:
1585
transport.put_bytes_non_atomic(filename, content_bytes,
1586
mode=a_bzrdir._get_file_mode())
1588
control_files.unlock()
1590
def network_name(self):
1591
"""Metadir formats have matching disk and network format strings."""
1592
return self.get_format_string()
1595
# formats which have no format string are not discoverable or independently
1596
# creatable on disk, so are not registered in format_registry. They're
1597
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1598
# needed, it's constructed directly by the BzrDir. Non-native formats where
1599
# the repository is not separately opened are similar.
1601
format_registry.register_lazy(
1602
'Bazaar-NG Knit Repository Format 1',
1603
'bzrlib.repofmt.knitrepo',
1604
'RepositoryFormatKnit1',
1607
format_registry.register_lazy(
1608
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1609
'bzrlib.repofmt.knitrepo',
1610
'RepositoryFormatKnit3',
1613
format_registry.register_lazy(
1614
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1615
'bzrlib.repofmt.knitrepo',
1616
'RepositoryFormatKnit4',
1619
# Pack-based formats. There is one format for pre-subtrees, and one for
1620
# post-subtrees to allow ease of testing.
1621
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1622
format_registry.register_lazy(
1623
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1624
'bzrlib.repofmt.knitpack_repo',
1625
'RepositoryFormatKnitPack1',
1627
format_registry.register_lazy(
1628
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1629
'bzrlib.repofmt.knitpack_repo',
1630
'RepositoryFormatKnitPack3',
1632
format_registry.register_lazy(
1633
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1634
'bzrlib.repofmt.knitpack_repo',
1635
'RepositoryFormatKnitPack4',
1637
format_registry.register_lazy(
1638
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1639
'bzrlib.repofmt.knitpack_repo',
1640
'RepositoryFormatKnitPack5',
1642
format_registry.register_lazy(
1643
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1644
'bzrlib.repofmt.knitpack_repo',
1645
'RepositoryFormatKnitPack5RichRoot',
1647
format_registry.register_lazy(
1648
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1649
'bzrlib.repofmt.knitpack_repo',
1650
'RepositoryFormatKnitPack5RichRootBroken',
1652
format_registry.register_lazy(
1653
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1654
'bzrlib.repofmt.knitpack_repo',
1655
'RepositoryFormatKnitPack6',
1657
format_registry.register_lazy(
1658
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1659
'bzrlib.repofmt.knitpack_repo',
1660
'RepositoryFormatKnitPack6RichRoot',
1662
format_registry.register_lazy(
1663
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1664
'bzrlib.repofmt.groupcompress_repo',
1665
'RepositoryFormat2a',
1668
# Development formats.
1669
# Check their docstrings to see if/when they are obsolete.
1670
format_registry.register_lazy(
1671
("Bazaar development format 2 with subtree support "
1672
"(needs bzr.dev from before 1.8)\n"),
1673
'bzrlib.repofmt.knitpack_repo',
1674
'RepositoryFormatPackDevelopment2Subtree',
1676
format_registry.register_lazy(
1677
'Bazaar development format 8\n',
1678
'bzrlib.repofmt.groupcompress_repo',
1679
'RepositoryFormat2aSubtree',
1683
class InterRepository(InterObject):
1684
"""This class represents operations taking place between two repositories.
1686
Its instances have methods like copy_content and fetch, and contain
1687
references to the source and target repositories these operations can be
1690
Often we will provide convenience methods on 'repository' which carry out
1691
operations with another repository - they will always forward to
1692
InterRepository.get(other).method_name(parameters).
1696
"""The available optimised InterRepository types."""
1699
def copy_content(self, revision_id=None):
1700
"""Make a complete copy of the content in self into destination.
1702
This is a destructive operation! Do not use it on existing
1705
:param revision_id: Only copy the content needed to construct
1706
revision_id and its parents.
1709
self.target.set_make_working_trees(self.source.make_working_trees())
1710
except NotImplementedError:
1712
self.target.fetch(self.source, revision_id=revision_id)
1715
def fetch(self, revision_id=None, find_ghosts=False,
1717
"""Fetch the content required to construct revision_id.
1719
The content is copied from self.source to self.target.
1721
:param revision_id: if None all content is copied, if NULL_REVISION no
1725
raise NotImplementedError(self.fetch)
1728
def search_missing_revision_ids(self,
1729
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1730
find_ghosts=True, revision_ids=None, if_present_ids=None,
1732
"""Return the revision ids that source has that target does not.
1734
:param revision_id: only return revision ids included by this
1736
:param revision_ids: return revision ids included by these
1737
revision_ids. NoSuchRevision will be raised if any of these
1738
revisions are not present.
1739
:param if_present_ids: like revision_ids, but will not cause
1740
NoSuchRevision if any of these are absent, instead they will simply
1741
not be in the result. This is useful for e.g. finding revisions
1742
to fetch for tags, which may reference absent revisions.
1743
:param find_ghosts: If True find missing revisions in deep history
1744
rather than just finding the surface difference.
1745
:param limit: Maximum number of revisions to return, topologically
1747
:return: A bzrlib.graph.SearchResult.
1749
raise NotImplementedError(self.search_missing_revision_ids)
1752
def _same_model(source, target):
1753
"""True if source and target have the same data representation.
1755
Note: this is always called on the base class; overriding it in a
1756
subclass will have no effect.
1759
InterRepository._assert_same_model(source, target)
1761
except errors.IncompatibleRepositories, e:
1765
def _assert_same_model(source, target):
1766
"""Raise an exception if two repositories do not use the same model.
1768
if source.supports_rich_root() != target.supports_rich_root():
1769
raise errors.IncompatibleRepositories(source, target,
1770
"different rich-root support")
1771
if source._serializer != target._serializer:
1772
raise errors.IncompatibleRepositories(source, target,
1773
"different serializers")
1776
class CopyConverter(object):
1777
"""A repository conversion tool which just performs a copy of the content.
1779
This is slow but quite reliable.
1782
def __init__(self, target_format):
1783
"""Create a CopyConverter.
1785
:param target_format: The format the resulting repository should be.
1787
self.target_format = target_format
1789
def convert(self, repo, pb):
1790
"""Perform the conversion of to_convert, giving feedback via pb.
1792
:param to_convert: The disk object to convert.
1793
:param pb: a progress bar to use for progress information.
1795
pb = ui.ui_factory.nested_progress_bar()
1798
# this is only useful with metadir layouts - separated repo content.
1799
# trigger an assertion if not such
1800
repo._format.get_format_string()
1801
self.repo_dir = repo.bzrdir
1802
pb.update('Moving repository to repository.backup')
1803
self.repo_dir.transport.move('repository', 'repository.backup')
1804
backup_transport = self.repo_dir.transport.clone('repository.backup')
1805
repo._format.check_conversion_target(self.target_format)
1806
self.source_repo = repo._format.open(self.repo_dir,
1808
_override_transport=backup_transport)
1809
pb.update('Creating new repository')
1810
converted = self.target_format.initialize(self.repo_dir,
1811
self.source_repo.is_shared())
1812
converted.lock_write()
1814
pb.update('Copying content')
1815
self.source_repo.copy_content_into(converted)
1818
pb.update('Deleting old repository content')
1819
self.repo_dir.transport.delete_tree('repository.backup')
1820
ui.ui_factory.note('repository converted')
1824
def _strip_NULL_ghosts(revision_graph):
1825
"""Also don't use this. more compatibility code for unmigrated clients."""
1826
# Filter ghosts, and null:
1827
if _mod_revision.NULL_REVISION in revision_graph:
1828
del revision_graph[_mod_revision.NULL_REVISION]
1829
for key, parents in revision_graph.items():
1830
revision_graph[key] = tuple(parent for parent in parents if parent
1832
return revision_graph
1835
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1836
stop_revision=None):
1837
"""Extend the partial history to include a given index
1839
If a stop_index is supplied, stop when that index has been reached.
1840
If a stop_revision is supplied, stop when that revision is
1841
encountered. Otherwise, stop when the beginning of history is
1844
:param stop_index: The index which should be present. When it is
1845
present, history extension will stop.
1846
:param stop_revision: The revision id which should be present. When
1847
it is encountered, history extension will stop.
1849
start_revision = partial_history_cache[-1]
1850
graph = repo.get_graph()
1851
iterator = graph.iter_lefthand_ancestry(start_revision,
1852
(_mod_revision.NULL_REVISION,))
1854
# skip the last revision in the list
1857
if (stop_index is not None and
1858
len(partial_history_cache) > stop_index):
1860
if partial_history_cache[-1] == stop_revision:
1862
revision_id = iterator.next()
1863
partial_history_cache.append(revision_id)
1864
except StopIteration:
1869
class _LazyListJoin(object):
1870
"""An iterable yielding the contents of many lists as one list.
1872
Each iterator made from this will reflect the current contents of the lists
1873
at the time the iterator is made.
1875
This is used by Repository's _make_parents_provider implementation so that
1878
pp = repo._make_parents_provider() # uses a list of fallback repos
1879
pp.add_fallback_repository(other_repo) # appends to that list
1880
result = pp.get_parent_map(...)
1881
# The result will include revs from other_repo
1884
def __init__(self, *list_parts):
1885
self.list_parts = list_parts
1889
for list_part in self.list_parts:
1890
full_list.extend(list_part)
1891
return iter(full_list)
added
removed
bzrlib/repository.py
