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,
36
from bzrlib.bundle import serializer
45
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
46
from bzrlib.inter import InterObject
47
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
48
from bzrlib.trace import (
49
log_exception_quietly, note, mutter, mutter_callsite, warning)
52
# Old formats display a warning, but only once
53
_deprecation_warning_done = False
56
class IsInWriteGroupError(errors.InternalBzrError):
58
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
60
def __init__(self, repo):
61
errors.InternalBzrError.__init__(self, repo=repo)
64
class CommitBuilder(object):
65
"""Provides an interface to build up a commit.
67
This allows describing a tree to be committed without needing to
68
know the internals of the format of the repository.
71
# all clients should supply tree roots.
72
record_root_entry = True
73
# whether this commit builder supports the record_entry_contents interface
74
supports_record_entry_contents = False
76
def __init__(self, repository, parents, config, timestamp=None,
77
timezone=None, committer=None, revprops=None,
78
revision_id=None, lossy=False):
79
"""Initiate a CommitBuilder.
81
:param repository: Repository to commit to.
82
:param parents: Revision ids of the parents of the new revision.
83
:param timestamp: Optional timestamp recorded for commit.
84
:param timezone: Optional timezone for timestamp.
85
:param committer: Optional committer to set for commit.
86
:param revprops: Optional dictionary of revision properties.
87
:param revision_id: Optional revision id.
88
:param lossy: Whether to discard data that can not be natively
89
represented, when pushing to a foreign VCS
95
self._committer = self._config.username()
96
elif not isinstance(committer, unicode):
97
self._committer = committer.decode() # throw if non-ascii
99
self._committer = committer
101
self._new_revision_id = revision_id
102
self.parents = parents
103
self.repository = repository
106
if revprops is not None:
107
self._validate_revprops(revprops)
108
self._revprops.update(revprops)
110
if timestamp is None:
111
timestamp = time.time()
112
# Restrict resolution to 1ms
113
self._timestamp = round(timestamp, 3)
116
self._timezone = osutils.local_time_offset()
118
self._timezone = int(timezone)
120
self._generate_revision_if_needed()
122
def any_changes(self):
123
"""Return True if any entries were changed.
125
This includes merge-only changes. It is the core for the --unchanged
128
:return: True if any changes have occured.
130
raise NotImplementedError(self.any_changes)
132
def _validate_unicode_text(self, text, context):
133
"""Verify things like commit messages don't have bogus characters."""
135
raise ValueError('Invalid value for %s: %r' % (context, text))
137
def _validate_revprops(self, revprops):
138
for key, value in revprops.iteritems():
139
# We know that the XML serializers do not round trip '\r'
140
# correctly, so refuse to accept them
141
if not isinstance(value, basestring):
142
raise ValueError('revision property (%s) is not a valid'
143
' (unicode) string: %r' % (key, value))
144
self._validate_unicode_text(value,
145
'revision property (%s)' % (key,))
147
def commit(self, message):
148
"""Make the actual commit.
150
:return: The revision id of the recorded revision.
152
raise NotImplementedError(self.commit)
155
"""Abort the commit that is being built.
157
raise NotImplementedError(self.abort)
159
def revision_tree(self):
160
"""Return the tree that was just committed.
162
After calling commit() this can be called to get a
163
RevisionTree representing the newly committed tree. This is
164
preferred to calling Repository.revision_tree() because that may
165
require deserializing the inventory, while we already have a copy in
168
raise NotImplementedError(self.revision_tree)
170
def finish_inventory(self):
171
"""Tell the builder that the inventory is finished.
173
:return: The inventory id in the repository, which can be used with
174
repository.get_inventory.
176
raise NotImplementedError(self.finish_inventory)
178
def _gen_revision_id(self):
179
"""Return new revision-id."""
180
return generate_ids.gen_revision_id(self._committer, self._timestamp)
182
def _generate_revision_if_needed(self):
183
"""Create a revision id if None was supplied.
185
If the repository can not support user-specified revision ids
186
they should override this function and raise CannotSetRevisionId
187
if _new_revision_id is not None.
189
:raises: CannotSetRevisionId
191
if self._new_revision_id is None:
192
self._new_revision_id = self._gen_revision_id()
193
self.random_revid = True
195
self.random_revid = False
197
def will_record_deletes(self):
198
"""Tell the commit builder that deletes are being notified.
200
This enables the accumulation of an inventory delta; for the resulting
201
commit to be valid, deletes against the basis MUST be recorded via
202
builder.record_delete().
204
raise NotImplementedError(self.will_record_deletes)
206
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
207
"""Record a new tree via iter_changes.
209
:param tree: The tree to obtain text contents from for changed objects.
210
:param basis_revision_id: The revision id of the tree the iter_changes
211
has been generated against. Currently assumed to be the same
212
as self.parents[0] - if it is not, errors may occur.
213
:param iter_changes: An iter_changes iterator with the changes to apply
214
to basis_revision_id. The iterator must not include any items with
215
a current kind of None - missing items must be either filtered out
216
or errored-on beefore record_iter_changes sees the item.
217
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
220
raise NotImplementedError(self.record_iter_changes)
223
class RepositoryWriteLockResult(LogicalLockResult):
224
"""The result of write locking a repository.
226
:ivar repository_token: The token obtained from the underlying lock, or
228
:ivar unlock: A callable which will unlock the lock.
231
def __init__(self, unlock, repository_token):
232
LogicalLockResult.__init__(self, unlock)
233
self.repository_token = repository_token
236
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
240
######################################################################
244
class Repository(_RelockDebugMixin, controldir.ControlComponent):
245
"""Repository holding history for one or more branches.
247
The repository holds and retrieves historical information including
248
revisions and file history. It's normally accessed only by the Branch,
249
which views a particular line of development through that history.
251
See VersionedFileRepository in bzrlib.vf_repository for the
252
base class for most Bazaar repositories.
255
def abort_write_group(self, suppress_errors=False):
256
"""Commit the contents accrued within the current write group.
258
:param suppress_errors: if true, abort_write_group will catch and log
259
unexpected errors that happen during the abort, rather than
260
allowing them to propagate. Defaults to False.
262
:seealso: start_write_group.
264
if self._write_group is not self.get_transaction():
265
# has an unlock or relock occured ?
268
'(suppressed) mismatched lock context and write group. %r, %r',
269
self._write_group, self.get_transaction())
271
raise errors.BzrError(
272
'mismatched lock context and write group. %r, %r' %
273
(self._write_group, self.get_transaction()))
275
self._abort_write_group()
276
except Exception, exc:
277
self._write_group = None
278
if not suppress_errors:
280
mutter('abort_write_group failed')
281
log_exception_quietly()
282
note('bzr: ERROR (ignored): %s', exc)
283
self._write_group = None
285
def _abort_write_group(self):
286
"""Template method for per-repository write group cleanup.
288
This is called during abort before the write group is considered to be
289
finished and should cleanup any internal state accrued during the write
290
group. There is no requirement that data handed to the repository be
291
*not* made available - this is not a rollback - but neither should any
292
attempt be made to ensure that data added is fully commited. Abort is
293
invoked when an error has occured so futher disk or network operations
294
may not be possible or may error and if possible should not be
298
def add_fallback_repository(self, repository):
299
"""Add a repository to use for looking up data not held locally.
301
:param repository: A repository.
303
raise NotImplementedError(self.add_fallback_repository)
305
def _check_fallback_repository(self, repository):
306
"""Check that this repository can fallback to repository safely.
308
Raise an error if not.
310
:param repository: A repository to fallback to.
312
return InterRepository._assert_same_model(self, repository)
314
def all_revision_ids(self):
315
"""Returns a list of all the revision ids in the repository.
317
This is conceptually deprecated because code should generally work on
318
the graph reachable from a particular revision, and ignore any other
319
revisions that might be present. There is no direct replacement
322
if 'evil' in debug.debug_flags:
323
mutter_callsite(2, "all_revision_ids is linear with history.")
324
return self._all_revision_ids()
326
def _all_revision_ids(self):
327
"""Returns a list of all the revision ids in the repository.
329
These are in as much topological order as the underlying store can
332
raise NotImplementedError(self._all_revision_ids)
334
def break_lock(self):
335
"""Break a lock if one is present from another instance.
337
Uses the ui factory to ask for confirmation if the lock may be from
340
self.control_files.break_lock()
343
def _eliminate_revisions_not_present(self, revision_ids):
344
"""Check every revision id in revision_ids to see if we have it.
346
Returns a set of the present revisions.
349
graph = self.get_graph()
350
parent_map = graph.get_parent_map(revision_ids)
351
# The old API returned a list, should this actually be a set?
352
return parent_map.keys()
355
def create(a_bzrdir):
356
"""Construct the current default format repository in a_bzrdir."""
357
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
359
def __init__(self, _format, a_bzrdir, control_files):
360
"""instantiate a Repository.
362
:param _format: The format of the repository on disk.
363
:param a_bzrdir: The BzrDir of the repository.
364
:param control_files: Control files to use for locking, etc.
366
# In the future we will have a single api for all stores for
367
# getting file texts, inventories and revisions, then
368
# this construct will accept instances of those things.
369
super(Repository, self).__init__()
370
self._format = _format
371
# the following are part of the public API for Repository:
372
self.bzrdir = a_bzrdir
373
self.control_files = control_files
374
self._transport = control_files._transport
375
self.base = self._transport.base
377
self._write_group = None
378
# Additional places to query for data.
379
self._fallback_repositories = []
382
def user_transport(self):
383
return self.bzrdir.user_transport
386
def control_transport(self):
387
return self._transport
390
if self._fallback_repositories:
391
return '%s(%r, fallback_repositories=%r)' % (
392
self.__class__.__name__,
394
self._fallback_repositories)
396
return '%s(%r)' % (self.__class__.__name__,
399
def _has_same_fallbacks(self, other_repo):
400
"""Returns true if the repositories have the same fallbacks."""
401
my_fb = self._fallback_repositories
402
other_fb = other_repo._fallback_repositories
403
if len(my_fb) != len(other_fb):
405
for f, g in zip(my_fb, other_fb):
406
if not f.has_same_location(g):
410
def has_same_location(self, other):
411
"""Returns a boolean indicating if this repository is at the same
412
location as another repository.
414
This might return False even when two repository objects are accessing
415
the same physical repository via different URLs.
417
if self.__class__ is not other.__class__:
419
return (self._transport.base == other._transport.base)
421
def is_in_write_group(self):
422
"""Return True if there is an open write group.
424
:seealso: start_write_group.
426
return self._write_group is not None
429
return self.control_files.is_locked()
431
def is_write_locked(self):
432
"""Return True if this object is write locked."""
433
return self.is_locked() and self.control_files._lock_mode == 'w'
435
def lock_write(self, token=None):
436
"""Lock this repository for writing.
438
This causes caching within the repository obejct to start accumlating
439
data during reads, and allows a 'write_group' to be obtained. Write
440
groups must be used for actual data insertion.
442
A token should be passed in if you know that you have locked the object
443
some other way, and need to synchronise this object's state with that
446
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
448
:param token: if this is already locked, then lock_write will fail
449
unless the token matches the existing lock.
450
:returns: a token if this instance supports tokens, otherwise None.
451
:raises TokenLockingNotSupported: when a token is given but this
452
instance doesn't support using token locks.
453
:raises MismatchedToken: if the specified token doesn't match the token
454
of the existing lock.
455
:seealso: start_write_group.
456
:return: A RepositoryWriteLockResult.
458
locked = self.is_locked()
459
token = self.control_files.lock_write(token=token)
461
self._warn_if_deprecated()
463
for repo in self._fallback_repositories:
464
# Writes don't affect fallback repos
467
return RepositoryWriteLockResult(self.unlock, token)
470
"""Lock the repository for read operations.
472
:return: An object with an unlock method which will release the lock
475
locked = self.is_locked()
476
self.control_files.lock_read()
478
self._warn_if_deprecated()
480
for repo in self._fallback_repositories:
483
return LogicalLockResult(self.unlock)
485
def get_physical_lock_status(self):
486
return self.control_files.get_physical_lock_status()
488
def leave_lock_in_place(self):
489
"""Tell this repository not to release the physical lock when this
492
If lock_write doesn't return a token, then this method is not supported.
494
self.control_files.leave_in_place()
496
def dont_leave_lock_in_place(self):
497
"""Tell this repository to release the physical lock when this
498
object is unlocked, even if it didn't originally acquire it.
500
If lock_write doesn't return a token, then this method is not supported.
502
self.control_files.dont_leave_in_place()
505
def gather_stats(self, revid=None, committers=None):
506
"""Gather statistics from a revision id.
508
:param revid: The revision id to gather statistics from, if None, then
509
no revision specific statistics are gathered.
510
:param committers: Optional parameter controlling whether to grab
511
a count of committers from the revision specific statistics.
512
:return: A dictionary of statistics. Currently this contains:
513
committers: The number of committers if requested.
514
firstrev: A tuple with timestamp, timezone for the penultimate left
515
most ancestor of revid, if revid is not the NULL_REVISION.
516
latestrev: A tuple with timestamp, timezone for revid, if revid is
517
not the NULL_REVISION.
518
revisions: The total revision count in the repository.
519
size: An estimate disk size of the repository in bytes.
522
if revid and committers:
523
result['committers'] = 0
524
if revid and revid != _mod_revision.NULL_REVISION:
525
graph = self.get_graph()
527
all_committers = set()
528
revisions = [r for (r, p) in graph.iter_ancestry([revid])
529
if r != _mod_revision.NULL_REVISION]
532
# ignore the revisions in the middle - just grab first and last
533
revisions = revisions[0], revisions[-1]
534
for revision in self.get_revisions(revisions):
535
if not last_revision:
536
last_revision = revision
538
all_committers.add(revision.committer)
539
first_revision = revision
541
result['committers'] = len(all_committers)
542
result['firstrev'] = (first_revision.timestamp,
543
first_revision.timezone)
544
result['latestrev'] = (last_revision.timestamp,
545
last_revision.timezone)
548
def find_branches(self, using=False):
549
"""Find branches underneath this repository.
551
This will include branches inside other branches.
553
:param using: If True, list only branches using this repository.
555
if using and not self.is_shared():
556
return self.bzrdir.list_branches()
557
class Evaluator(object):
560
self.first_call = True
562
def __call__(self, bzrdir):
563
# On the first call, the parameter is always the bzrdir
564
# containing the current repo.
565
if not self.first_call:
567
repository = bzrdir.open_repository()
568
except errors.NoRepositoryPresent:
571
return False, ([], repository)
572
self.first_call = False
573
value = (bzrdir.list_branches(), None)
577
for branches, repository in bzrdir.BzrDir.find_bzrdirs(
578
self.user_transport, evaluate=Evaluator()):
579
if branches is not None:
581
if not using and repository is not None:
582
ret.extend(repository.find_branches())
586
def search_missing_revision_ids(self, other,
587
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
588
find_ghosts=True, revision_ids=None, if_present_ids=None,
590
"""Return the revision ids that other has that this does not.
592
These are returned in topological order.
594
revision_id: only return revision ids included by revision_id.
596
if symbol_versioning.deprecated_passed(revision_id):
597
symbol_versioning.warn(
598
'search_missing_revision_ids(revision_id=...) was '
599
'deprecated in 2.4. Use revision_ids=[...] instead.',
600
DeprecationWarning, stacklevel=3)
601
if revision_ids is not None:
602
raise AssertionError(
603
'revision_ids is mutually exclusive with revision_id')
604
if revision_id is not None:
605
revision_ids = [revision_id]
606
return InterRepository.get(other, self).search_missing_revision_ids(
607
find_ghosts=find_ghosts, revision_ids=revision_ids,
608
if_present_ids=if_present_ids, limit=limit)
612
"""Open the repository rooted at base.
614
For instance, if the repository is at URL/.bzr/repository,
615
Repository.open(URL) -> a Repository instance.
617
control = bzrdir.BzrDir.open(base)
618
return control.open_repository()
620
def copy_content_into(self, destination, revision_id=None):
621
"""Make a complete copy of the content in self into destination.
623
This is a destructive operation! Do not use it on existing
626
return InterRepository.get(self, destination).copy_content(revision_id)
628
def commit_write_group(self):
629
"""Commit the contents accrued within the current write group.
631
:seealso: start_write_group.
633
:return: it may return an opaque hint that can be passed to 'pack'.
635
if self._write_group is not self.get_transaction():
636
# has an unlock or relock occured ?
637
raise errors.BzrError('mismatched lock context %r and '
639
(self.get_transaction(), self._write_group))
640
result = self._commit_write_group()
641
self._write_group = None
644
def _commit_write_group(self):
645
"""Template method for per-repository write group cleanup.
647
This is called before the write group is considered to be
648
finished and should ensure that all data handed to the repository
649
for writing during the write group is safely committed (to the
650
extent possible considering file system caching etc).
653
def suspend_write_group(self):
654
raise errors.UnsuspendableWriteGroup(self)
656
def refresh_data(self):
657
"""Re-read any data needed to synchronise with disk.
659
This method is intended to be called after another repository instance
660
(such as one used by a smart server) has inserted data into the
661
repository. On all repositories this will work outside of write groups.
662
Some repository formats (pack and newer for bzrlib native formats)
663
support refresh_data inside write groups. If called inside a write
664
group on a repository that does not support refreshing in a write group
665
IsInWriteGroupError will be raised.
669
def resume_write_group(self, tokens):
670
if not self.is_write_locked():
671
raise errors.NotWriteLocked(self)
672
if self._write_group:
673
raise errors.BzrError('already in a write group')
674
self._resume_write_group(tokens)
675
# so we can detect unlock/relock - the write group is now entered.
676
self._write_group = self.get_transaction()
678
def _resume_write_group(self, tokens):
679
raise errors.UnsuspendableWriteGroup(self)
681
def fetch(self, source, revision_id=None, find_ghosts=False,
683
"""Fetch the content required to construct revision_id from source.
685
If revision_id is None and fetch_spec is None, then all content is
688
fetch() may not be used when the repository is in a write group -
689
either finish the current write group before using fetch, or use
690
fetch before starting the write group.
692
:param find_ghosts: Find and copy revisions in the source that are
693
ghosts in the target (and not reachable directly by walking out to
694
the first-present revision in target from revision_id).
695
:param revision_id: If specified, all the content needed for this
696
revision ID will be copied to the target. Fetch will determine for
697
itself which content needs to be copied.
698
:param fetch_spec: If specified, a SearchResult or
699
PendingAncestryResult that describes which revisions to copy. This
700
allows copying multiple heads at once. Mutually exclusive with
703
if fetch_spec is not None and revision_id is not None:
704
raise AssertionError(
705
"fetch_spec and revision_id are mutually exclusive.")
706
if self.is_in_write_group():
707
raise errors.InternalBzrError(
708
"May not fetch while in a write group.")
709
# fast path same-url fetch operations
710
# TODO: lift out to somewhere common with RemoteRepository
711
# <https://bugs.launchpad.net/bzr/+bug/401646>
712
if (self.has_same_location(source)
713
and fetch_spec is None
714
and self._has_same_fallbacks(source)):
715
# check that last_revision is in 'from' and then return a
717
if (revision_id is not None and
718
not _mod_revision.is_null(revision_id)):
719
self.get_revision(revision_id)
721
inter = InterRepository.get(source, self)
722
return inter.fetch(revision_id=revision_id,
723
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
725
def create_bundle(self, target, base, fileobj, format=None):
726
return serializer.write_bundle(self, target, base, fileobj, format)
728
def get_commit_builder(self, branch, parents, config, timestamp=None,
729
timezone=None, committer=None, revprops=None,
730
revision_id=None, lossy=False):
731
"""Obtain a CommitBuilder for this repository.
733
:param branch: Branch to commit to.
734
:param parents: Revision ids of the parents of the new revision.
735
:param config: Configuration to use.
736
:param timestamp: Optional timestamp recorded for commit.
737
:param timezone: Optional timezone for timestamp.
738
:param committer: Optional committer to set for commit.
739
:param revprops: Optional dictionary of revision properties.
740
:param revision_id: Optional revision id.
741
:param lossy: Whether to discard data that can not be natively
742
represented, when pushing to a foreign VCS
744
raise NotImplementedError(self.get_commit_builder)
746
@only_raises(errors.LockNotHeld, errors.LockBroken)
748
if (self.control_files._lock_count == 1 and
749
self.control_files._lock_mode == 'w'):
750
if self._write_group is not None:
751
self.abort_write_group()
752
self.control_files.unlock()
753
raise errors.BzrError(
754
'Must end write groups before releasing write locks.')
755
self.control_files.unlock()
756
if self.control_files._lock_count == 0:
757
for repo in self._fallback_repositories:
761
def clone(self, a_bzrdir, revision_id=None):
762
"""Clone this repository into a_bzrdir using the current format.
764
Currently no check is made that the format of this repository and
765
the bzrdir format are compatible. FIXME RBC 20060201.
767
:return: The newly created destination repository.
769
# TODO: deprecate after 0.16; cloning this with all its settings is
770
# probably not very useful -- mbp 20070423
771
dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
772
self.copy_content_into(dest_repo, revision_id)
775
def start_write_group(self):
776
"""Start a write group in the repository.
778
Write groups are used by repositories which do not have a 1:1 mapping
779
between file ids and backend store to manage the insertion of data from
780
both fetch and commit operations.
782
A write lock is required around the start_write_group/commit_write_group
783
for the support of lock-requiring repository formats.
785
One can only insert data into a repository inside a write group.
789
if not self.is_write_locked():
790
raise errors.NotWriteLocked(self)
791
if self._write_group:
792
raise errors.BzrError('already in a write group')
793
self._start_write_group()
794
# so we can detect unlock/relock - the write group is now entered.
795
self._write_group = self.get_transaction()
797
def _start_write_group(self):
798
"""Template method for per-repository write group startup.
800
This is called before the write group is considered to be
805
def sprout(self, to_bzrdir, revision_id=None):
806
"""Create a descendent repository for new development.
808
Unlike clone, this does not copy the settings of the repository.
810
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
811
dest_repo.fetch(self, revision_id=revision_id)
814
def _create_sprouting_repo(self, a_bzrdir, shared):
815
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
816
# use target default format.
817
dest_repo = a_bzrdir.create_repository()
819
# Most control formats need the repository to be specifically
820
# created, but on some old all-in-one formats it's not needed
822
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
823
except errors.UninitializableFormat:
824
dest_repo = a_bzrdir.open_repository()
828
def has_revision(self, revision_id):
829
"""True if this repository has a copy of the revision."""
830
return revision_id in self.has_revisions((revision_id,))
833
def has_revisions(self, revision_ids):
834
"""Probe to find out the presence of multiple revisions.
836
:param revision_ids: An iterable of revision_ids.
837
:return: A set of the revision_ids that were present.
839
raise NotImplementedError(self.has_revisions)
842
def get_revision(self, revision_id):
843
"""Return the Revision object for a named revision."""
844
return self.get_revisions([revision_id])[0]
846
def get_revision_reconcile(self, revision_id):
847
"""'reconcile' helper routine that allows access to a revision always.
849
This variant of get_revision does not cross check the weave graph
850
against the revision one as get_revision does: but it should only
851
be used by reconcile, or reconcile-alike commands that are correcting
852
or testing the revision graph.
854
raise NotImplementedError(self.get_revision_reconcile)
856
def get_revisions(self, revision_ids):
857
"""Get many revisions at once.
859
Repositories that need to check data on every revision read should
860
subclass this method.
862
raise NotImplementedError(self.get_revisions)
864
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
865
"""Produce a generator of revision deltas.
867
Note that the input is a sequence of REVISIONS, not revision_ids.
868
Trees will be held in memory until the generator exits.
869
Each delta is relative to the revision's lefthand predecessor.
871
:param specific_fileids: if not None, the result is filtered
872
so that only those file-ids, their parents and their
873
children are included.
875
# Get the revision-ids of interest
876
required_trees = set()
877
for revision in revisions:
878
required_trees.add(revision.revision_id)
879
required_trees.update(revision.parent_ids[:1])
881
# Get the matching filtered trees. Note that it's more
882
# efficient to pass filtered trees to changes_from() rather
883
# than doing the filtering afterwards. changes_from() could
884
# arguably do the filtering itself but it's path-based, not
885
# file-id based, so filtering before or afterwards is
887
if specific_fileids is None:
888
trees = dict((t.get_revision_id(), t) for
889
t in self.revision_trees(required_trees))
891
trees = dict((t.get_revision_id(), t) for
892
t in self._filtered_revision_trees(required_trees,
895
# Calculate the deltas
896
for revision in revisions:
897
if not revision.parent_ids:
898
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
900
old_tree = trees[revision.parent_ids[0]]
901
yield trees[revision.revision_id].changes_from(old_tree)
904
def get_revision_delta(self, revision_id, specific_fileids=None):
905
"""Return the delta for one revision.
907
The delta is relative to the left-hand predecessor of the
910
:param specific_fileids: if not None, the result is filtered
911
so that only those file-ids, their parents and their
912
children are included.
914
r = self.get_revision(revision_id)
915
return list(self.get_deltas_for_revisions([r],
916
specific_fileids=specific_fileids))[0]
919
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
920
signature = gpg_strategy.sign(plaintext)
921
self.add_signature_text(revision_id, signature)
923
def add_signature_text(self, revision_id, signature):
924
"""Store a signature text for a revision.
926
:param revision_id: Revision id of the revision
927
:param signature: Signature text.
929
raise NotImplementedError(self.add_signature_text)
931
def _find_parent_ids_of_revisions(self, revision_ids):
932
"""Find all parent ids that are mentioned in the revision graph.
934
:return: set of revisions that are parents of revision_ids which are
935
not part of revision_ids themselves
937
parent_map = self.get_parent_map(revision_ids)
939
map(parent_ids.update, parent_map.itervalues())
940
parent_ids.difference_update(revision_ids)
941
parent_ids.discard(_mod_revision.NULL_REVISION)
944
def fileids_altered_by_revision_ids(self, revision_ids):
945
"""Find the file ids and versions affected by revisions.
947
:param revisions: an iterable containing revision ids.
948
:return: a dictionary mapping altered file-ids to an iterable of
949
revision_ids. Each altered file-ids has the exact revision_ids
950
that altered it listed explicitly.
952
raise NotImplementedError(self.fileids_altered_by_revision_ids)
954
def iter_files_bytes(self, desired_files):
955
"""Iterate through file versions.
957
Files will not necessarily be returned in the order they occur in
958
desired_files. No specific order is guaranteed.
960
Yields pairs of identifier, bytes_iterator. identifier is an opaque
961
value supplied by the caller as part of desired_files. It should
962
uniquely identify the file version in the caller's context. (Examples:
963
an index number or a TreeTransform trans_id.)
965
:param desired_files: a list of (file_id, revision_id, identifier)
968
raise NotImplementedError(self.iter_files_bytes)
970
def get_rev_id_for_revno(self, revno, known_pair):
971
"""Return the revision id of a revno, given a later (revno, revid)
972
pair in the same history.
974
:return: if found (True, revid). If the available history ran out
975
before reaching the revno, then this returns
976
(False, (closest_revno, closest_revid)).
978
known_revno, known_revid = known_pair
979
partial_history = [known_revid]
980
distance_from_known = known_revno - revno
981
if distance_from_known < 0:
983
'requested revno (%d) is later than given known revno (%d)'
984
% (revno, known_revno))
987
self, partial_history, stop_index=distance_from_known)
988
except errors.RevisionNotPresent, err:
989
if err.revision_id == known_revid:
990
# The start revision (known_revid) wasn't found.
992
# This is a stacked repository with no fallbacks, or a there's a
993
# left-hand ghost. Either way, even though the revision named in
994
# the error isn't in this repo, we know it's the next step in this
996
partial_history.append(err.revision_id)
997
if len(partial_history) <= distance_from_known:
998
# Didn't find enough history to get a revid for the revno.
999
earliest_revno = known_revno - len(partial_history) + 1
1000
return (False, (earliest_revno, partial_history[-1]))
1001
if len(partial_history) - 1 > distance_from_known:
1002
raise AssertionError('_iter_for_revno returned too much history')
1003
return (True, partial_history[-1])
1005
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1006
def iter_reverse_revision_history(self, revision_id):
1007
"""Iterate backwards through revision ids in the lefthand history
1009
:param revision_id: The revision id to start with. All its lefthand
1010
ancestors will be traversed.
1012
graph = self.get_graph()
1013
stop_revisions = (None, _mod_revision.NULL_REVISION)
1014
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
1016
def is_shared(self):
1017
"""Return True if this repository is flagged as a shared repository."""
1018
raise NotImplementedError(self.is_shared)
1021
def reconcile(self, other=None, thorough=False):
1022
"""Reconcile this repository."""
1023
from bzrlib.reconcile import RepoReconciler
1024
reconciler = RepoReconciler(self, thorough=thorough)
1025
reconciler.reconcile()
1028
def _refresh_data(self):
1029
"""Helper called from lock_* to ensure coherency with disk.
1031
The default implementation does nothing; it is however possible
1032
for repositories to maintain loaded indices across multiple locks
1033
by checking inside their implementation of this method to see
1034
whether their indices are still valid. This depends of course on
1035
the disk format being validatable in this manner. This method is
1036
also called by the refresh_data() public interface to cause a refresh
1037
to occur while in a write lock so that data inserted by a smart server
1038
push operation is visible on the client's instance of the physical
1043
def revision_tree(self, revision_id):
1044
"""Return Tree for a revision on this branch.
1046
`revision_id` may be NULL_REVISION for the empty tree revision.
1048
raise NotImplementedError(self.revision_tree)
1050
def revision_trees(self, revision_ids):
1051
"""Return Trees for revisions in this repository.
1053
:param revision_ids: a sequence of revision-ids;
1054
a revision-id may not be None or 'null:'
1056
raise NotImplementedError(self.revision_trees)
1059
@symbol_versioning.deprecated_method(
1060
symbol_versioning.deprecated_in((2, 4, 0)))
1061
def get_ancestry(self, revision_id, topo_sorted=True):
1062
"""Return a list of revision-ids integrated by a revision.
1064
The first element of the list is always None, indicating the origin
1065
revision. This might change when we have history horizons, or
1066
perhaps we should have a new API.
1068
This is topologically sorted.
1070
if 'evil' in debug.debug_flags:
1071
mutter_callsite(2, "get_ancestry is linear with history.")
1072
if _mod_revision.is_null(revision_id):
1074
if not self.has_revision(revision_id):
1075
raise errors.NoSuchRevision(self, revision_id)
1076
graph = self.get_graph()
1078
search = graph._make_breadth_first_searcher([revision_id])
1081
found, ghosts = search.next_with_ghosts()
1082
except StopIteration:
1085
if _mod_revision.NULL_REVISION in keys:
1086
keys.remove(_mod_revision.NULL_REVISION)
1088
parent_map = graph.get_parent_map(keys)
1089
keys = tsort.topo_sort(parent_map)
1090
return [None] + list(keys)
1092
def pack(self, hint=None, clean_obsolete_packs=False):
1093
"""Compress the data within the repository.
1095
This operation only makes sense for some repository types. For other
1096
types it should be a no-op that just returns.
1098
This stub method does not require a lock, but subclasses should use
1099
@needs_write_lock as this is a long running call it's reasonable to
1100
implicitly lock for the user.
1102
:param hint: If not supplied, the whole repository is packed.
1103
If supplied, the repository may use the hint parameter as a
1104
hint for the parts of the repository to pack. A hint can be
1105
obtained from the result of commit_write_group(). Out of
1106
date hints are simply ignored, because concurrent operations
1107
can obsolete them rapidly.
1109
:param clean_obsolete_packs: Clean obsolete packs immediately after
1113
def get_transaction(self):
1114
return self.control_files.get_transaction()
1116
def get_parent_map(self, revision_ids):
1117
"""See graph.StackedParentsProvider.get_parent_map"""
1118
raise NotImplementedError(self.get_parent_map)
1120
def _get_parent_map_no_fallbacks(self, revision_ids):
1121
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1122
# revisions index works in keys; this just works in revisions
1123
# therefore wrap and unwrap
1126
for revision_id in revision_ids:
1127
if revision_id == _mod_revision.NULL_REVISION:
1128
result[revision_id] = ()
1129
elif revision_id is None:
1130
raise ValueError('get_parent_map(None) is not valid')
1132
query_keys.append((revision_id ,))
1133
vf = self.revisions.without_fallbacks()
1134
for ((revision_id,), parent_keys) in \
1135
vf.get_parent_map(query_keys).iteritems():
1137
result[revision_id] = tuple([parent_revid
1138
for (parent_revid,) in parent_keys])
1140
result[revision_id] = (_mod_revision.NULL_REVISION,)
1143
def _make_parents_provider(self):
1144
if not self._format.supports_external_lookups:
1146
return graph.StackedParentsProvider(_LazyListJoin(
1147
[self._make_parents_provider_unstacked()],
1148
self._fallback_repositories))
1150
def _make_parents_provider_unstacked(self):
1151
return graph.CallableToParentsProviderAdapter(
1152
self._get_parent_map_no_fallbacks)
1155
def get_known_graph_ancestry(self, revision_ids):
1156
"""Return the known graph for a set of revision ids and their ancestors.
1158
raise NotImplementedError(self.get_known_graph_ancestry)
1160
def get_file_graph(self):
1161
"""Return the graph walker for files."""
1162
raise NotImplementedError(self.get_file_graph)
1164
def get_graph(self, other_repository=None):
1165
"""Return the graph walker for this repository format"""
1166
parents_provider = self._make_parents_provider()
1167
if (other_repository is not None and
1168
not self.has_same_location(other_repository)):
1169
parents_provider = graph.StackedParentsProvider(
1170
[parents_provider, other_repository._make_parents_provider()])
1171
return graph.Graph(parents_provider)
1173
def revision_ids_to_search_result(self, result_set):
1174
"""Convert a set of revision ids to a graph SearchResult."""
1175
result_parents = set()
1176
for parents in self.get_graph().get_parent_map(
1177
result_set).itervalues():
1178
result_parents.update(parents)
1179
included_keys = result_set.intersection(result_parents)
1180
start_keys = result_set.difference(included_keys)
1181
exclude_keys = result_parents.difference(result_set)
1182
result = graph.SearchResult(start_keys, exclude_keys,
1183
len(result_set), result_set)
1187
def set_make_working_trees(self, new_value):
1188
"""Set the policy flag for making working trees when creating branches.
1190
This only applies to branches that use this repository.
1192
The default is 'True'.
1193
:param new_value: True to restore the default, False to disable making
1196
raise NotImplementedError(self.set_make_working_trees)
1198
def make_working_trees(self):
1199
"""Returns the policy for making working trees on new branches."""
1200
raise NotImplementedError(self.make_working_trees)
1203
def sign_revision(self, revision_id, gpg_strategy):
1204
testament = _mod_testament.Testament.from_revision(self, revision_id)
1205
plaintext = testament.as_short_text()
1206
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
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
from bzrlib import bzrdir
1319
return bzrdir.format_registry.make_bzrdir('default').repository_format
1322
network_format_registry = registry.FormatRegistry()
1323
"""Registry of formats indexed by their network name.
1325
The network name for a repository format is an identifier that can be used when
1326
referring to formats with smart server operations. See
1327
RepositoryFormat.network_name() for more detail.
1331
format_registry = RepositoryFormatRegistry(network_format_registry)
1332
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1334
This can contain either format instances themselves, or classes/factories that
1335
can be called to obtain one.
1339
#####################################################################
1340
# Repository Formats
1342
class RepositoryFormat(controldir.ControlComponentFormat):
1343
"""A repository format.
1345
Formats provide four things:
1346
* An initialization routine to construct repository data on disk.
1347
* a optional format string which is used when the BzrDir supports
1349
* an open routine which returns a Repository instance.
1350
* A network name for referring to the format in smart server RPC
1353
There is one and only one Format subclass for each on-disk format. But
1354
there can be one Repository subclass that is used for several different
1355
formats. The _format attribute on a Repository instance can be used to
1356
determine the disk format.
1358
Formats are placed in a registry by their format string for reference
1359
during opening. These should be subclasses of RepositoryFormat for
1362
Once a format is deprecated, just deprecate the initialize and open
1363
methods on the format class. Do not deprecate the object, as the
1364
object may be created even when a repository instance hasn't been
1367
Common instance attributes:
1368
_matchingbzrdir - the bzrdir format that the repository format was
1369
originally written to work with. This can be used if manually
1370
constructing a bzrdir and repository, or more commonly for test suite
1374
# Set to True or False in derived classes. True indicates that the format
1375
# supports ghosts gracefully.
1376
supports_ghosts = None
1377
# Can this repository be given external locations to lookup additional
1378
# data. Set to True or False in derived classes.
1379
supports_external_lookups = None
1380
# Does this format support CHK bytestring lookups. Set to True or False in
1382
supports_chks = None
1383
# Should fetch trigger a reconcile after the fetch? Only needed for
1384
# some repository formats that can suffer internal inconsistencies.
1385
_fetch_reconcile = False
1386
# Does this format have < O(tree_size) delta generation. Used to hint what
1387
# code path for commit, amongst other things.
1389
# Does doing a pack operation compress data? Useful for the pack UI command
1390
# (so if there is one pack, the operation can still proceed because it may
1391
# help), and for fetching when data won't have come from the same
1393
pack_compresses = False
1394
# Does the repository storage understand references to trees?
1395
supports_tree_reference = None
1396
# Is the format experimental ?
1397
experimental = False
1398
# Does this repository format escape funky characters, or does it create
1399
# files with similar names as the versioned files in its contents on disk
1401
supports_funky_characters = None
1402
# Does this repository format support leaving locks?
1403
supports_leaving_lock = None
1404
# Does this format support the full VersionedFiles interface?
1405
supports_full_versioned_files = None
1406
# Does this format support signing revision signatures?
1407
supports_revision_signatures = True
1408
# Can the revision graph have incorrect parents?
1409
revision_graph_can_have_wrong_parents = None
1410
# Does this format support rich root data?
1411
rich_root_data = None
1414
return "%s()" % self.__class__.__name__
1416
def __eq__(self, other):
1417
# format objects are generally stateless
1418
return isinstance(other, self.__class__)
1420
def __ne__(self, other):
1421
return not self == other
1424
def find_format(klass, a_bzrdir):
1425
"""Return the format for the repository object in a_bzrdir.
1427
This is used by bzr native formats that have a "format" file in
1428
the repository. Other methods may be used by different types of
1432
transport = a_bzrdir.get_repository_transport(None)
1433
format_string = transport.get_bytes("format")
1434
return format_registry.get(format_string)
1435
except errors.NoSuchFile:
1436
raise errors.NoRepositoryPresent(a_bzrdir)
1438
raise errors.UnknownFormatError(format=format_string,
1442
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1443
def register_format(klass, format):
1444
format_registry.register(format)
1447
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1448
def unregister_format(klass, format):
1449
format_registry.remove(format)
1452
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1453
def get_default_format(klass):
1454
"""Return the current default format."""
1455
return format_registry.get_default()
1457
def get_format_string(self):
1458
"""Return the ASCII format string that identifies this format.
1460
Note that in pre format ?? repositories the format string is
1461
not permitted nor written to disk.
1463
raise NotImplementedError(self.get_format_string)
1465
def get_format_description(self):
1466
"""Return the short description for this format."""
1467
raise NotImplementedError(self.get_format_description)
1469
def initialize(self, a_bzrdir, shared=False):
1470
"""Initialize a repository of this format in a_bzrdir.
1472
:param a_bzrdir: The bzrdir to put the new repository in it.
1473
:param shared: The repository should be initialized as a sharable one.
1474
:returns: The new repository object.
1476
This may raise UninitializableFormat if shared repository are not
1477
compatible the a_bzrdir.
1479
raise NotImplementedError(self.initialize)
1481
def is_supported(self):
1482
"""Is this format supported?
1484
Supported formats must be initializable and openable.
1485
Unsupported formats may not support initialization or committing or
1486
some other features depending on the reason for not being supported.
1490
def is_deprecated(self):
1491
"""Is this format deprecated?
1493
Deprecated formats may trigger a user-visible warning recommending
1494
the user to upgrade. They are still fully supported.
1498
def network_name(self):
1499
"""A simple byte string uniquely identifying this format for RPC calls.
1501
MetaDir repository formats use their disk format string to identify the
1502
repository over the wire. All in one formats such as bzr < 0.8, and
1503
foreign formats like svn/git and hg should use some marker which is
1504
unique and immutable.
1506
raise NotImplementedError(self.network_name)
1508
def check_conversion_target(self, target_format):
1509
if self.rich_root_data and not target_format.rich_root_data:
1510
raise errors.BadConversionTarget(
1511
'Does not support rich root data.', target_format,
1513
if (self.supports_tree_reference and
1514
not getattr(target_format, 'supports_tree_reference', False)):
1515
raise errors.BadConversionTarget(
1516
'Does not support nested trees', target_format,
1519
def open(self, a_bzrdir, _found=False):
1520
"""Return an instance of this format for the bzrdir a_bzrdir.
1522
_found is a private parameter, do not use it.
1524
raise NotImplementedError(self.open)
1526
def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
1527
from bzrlib.bzrdir import BzrDir, RepoInitHookParams
1528
hooks = BzrDir.hooks['post_repo_init']
1531
params = RepoInitHookParams(repository, self, a_bzrdir, shared)
1536
class MetaDirRepositoryFormat(RepositoryFormat):
1537
"""Common base class for the new repositories using the metadir layout."""
1539
rich_root_data = False
1540
supports_tree_reference = False
1541
supports_external_lookups = False
1542
supports_leaving_lock = True
1545
def _matchingbzrdir(self):
1546
matching = bzrdir.BzrDirMetaFormat1()
1547
matching.repository_format = self
1551
super(MetaDirRepositoryFormat, self).__init__()
1553
def _create_control_files(self, a_bzrdir):
1554
"""Create the required files and the initial control_files object."""
1555
# FIXME: RBC 20060125 don't peek under the covers
1556
# NB: no need to escape relative paths that are url safe.
1557
repository_transport = a_bzrdir.get_repository_transport(self)
1558
control_files = lockable_files.LockableFiles(repository_transport,
1559
'lock', lockdir.LockDir)
1560
control_files.create_lock()
1561
return control_files
1563
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1564
"""Upload the initial blank content."""
1565
control_files = self._create_control_files(a_bzrdir)
1566
control_files.lock_write()
1567
transport = control_files._transport
1569
utf8_files += [('shared-storage', '')]
1571
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1572
for (filename, content_stream) in files:
1573
transport.put_file(filename, content_stream,
1574
mode=a_bzrdir._get_file_mode())
1575
for (filename, content_bytes) in utf8_files:
1576
transport.put_bytes_non_atomic(filename, content_bytes,
1577
mode=a_bzrdir._get_file_mode())
1579
control_files.unlock()
1581
def network_name(self):
1582
"""Metadir formats have matching disk and network format strings."""
1583
return self.get_format_string()
1586
# formats which have no format string are not discoverable or independently
1587
# creatable on disk, so are not registered in format_registry. They're
1588
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1589
# needed, it's constructed directly by the BzrDir. Non-native formats where
1590
# the repository is not separately opened are similar.
1592
format_registry.register_lazy(
1593
'Bazaar-NG Knit Repository Format 1',
1594
'bzrlib.repofmt.knitrepo',
1595
'RepositoryFormatKnit1',
1598
format_registry.register_lazy(
1599
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1600
'bzrlib.repofmt.knitrepo',
1601
'RepositoryFormatKnit3',
1604
format_registry.register_lazy(
1605
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1606
'bzrlib.repofmt.knitrepo',
1607
'RepositoryFormatKnit4',
1610
# Pack-based formats. There is one format for pre-subtrees, and one for
1611
# post-subtrees to allow ease of testing.
1612
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1613
format_registry.register_lazy(
1614
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1615
'bzrlib.repofmt.knitpack_repo',
1616
'RepositoryFormatKnitPack1',
1618
format_registry.register_lazy(
1619
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1620
'bzrlib.repofmt.knitpack_repo',
1621
'RepositoryFormatKnitPack3',
1623
format_registry.register_lazy(
1624
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1625
'bzrlib.repofmt.knitpack_repo',
1626
'RepositoryFormatKnitPack4',
1628
format_registry.register_lazy(
1629
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1630
'bzrlib.repofmt.knitpack_repo',
1631
'RepositoryFormatKnitPack5',
1633
format_registry.register_lazy(
1634
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1635
'bzrlib.repofmt.knitpack_repo',
1636
'RepositoryFormatKnitPack5RichRoot',
1638
format_registry.register_lazy(
1639
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1640
'bzrlib.repofmt.knitpack_repo',
1641
'RepositoryFormatKnitPack5RichRootBroken',
1643
format_registry.register_lazy(
1644
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1645
'bzrlib.repofmt.knitpack_repo',
1646
'RepositoryFormatKnitPack6',
1648
format_registry.register_lazy(
1649
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1650
'bzrlib.repofmt.knitpack_repo',
1651
'RepositoryFormatKnitPack6RichRoot',
1653
format_registry.register_lazy(
1654
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1655
'bzrlib.repofmt.groupcompress_repo',
1656
'RepositoryFormat2a',
1659
# Development formats.
1660
# Check their docstrings to see if/when they are obsolete.
1661
format_registry.register_lazy(
1662
("Bazaar development format 2 with subtree support "
1663
"(needs bzr.dev from before 1.8)\n"),
1664
'bzrlib.repofmt.knitpack_repo',
1665
'RepositoryFormatPackDevelopment2Subtree',
1667
format_registry.register_lazy(
1668
'Bazaar development format 8\n',
1669
'bzrlib.repofmt.groupcompress_repo',
1670
'RepositoryFormat2aSubtree',
1674
class InterRepository(InterObject):
1675
"""This class represents operations taking place between two repositories.
1677
Its instances have methods like copy_content and fetch, and contain
1678
references to the source and target repositories these operations can be
1681
Often we will provide convenience methods on 'repository' which carry out
1682
operations with another repository - they will always forward to
1683
InterRepository.get(other).method_name(parameters).
1687
"""The available optimised InterRepository types."""
1690
def copy_content(self, revision_id=None):
1691
"""Make a complete copy of the content in self into destination.
1693
This is a destructive operation! Do not use it on existing
1696
:param revision_id: Only copy the content needed to construct
1697
revision_id and its parents.
1700
self.target.set_make_working_trees(self.source.make_working_trees())
1701
except NotImplementedError:
1703
self.target.fetch(self.source, revision_id=revision_id)
1706
def fetch(self, revision_id=None, find_ghosts=False,
1708
"""Fetch the content required to construct revision_id.
1710
The content is copied from self.source to self.target.
1712
:param revision_id: if None all content is copied, if NULL_REVISION no
1716
raise NotImplementedError(self.fetch)
1719
def search_missing_revision_ids(self,
1720
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1721
find_ghosts=True, revision_ids=None, if_present_ids=None,
1723
"""Return the revision ids that source has that target does not.
1725
:param revision_id: only return revision ids included by this
1727
:param revision_ids: return revision ids included by these
1728
revision_ids. NoSuchRevision will be raised if any of these
1729
revisions are not present.
1730
:param if_present_ids: like revision_ids, but will not cause
1731
NoSuchRevision if any of these are absent, instead they will simply
1732
not be in the result. This is useful for e.g. finding revisions
1733
to fetch for tags, which may reference absent revisions.
1734
:param find_ghosts: If True find missing revisions in deep history
1735
rather than just finding the surface difference.
1736
:param limit: Maximum number of revisions to return, topologically
1738
:return: A bzrlib.graph.SearchResult.
1740
raise NotImplementedError(self.search_missing_revision_ids)
1743
def _same_model(source, target):
1744
"""True if source and target have the same data representation.
1746
Note: this is always called on the base class; overriding it in a
1747
subclass will have no effect.
1750
InterRepository._assert_same_model(source, target)
1752
except errors.IncompatibleRepositories, e:
1756
def _assert_same_model(source, target):
1757
"""Raise an exception if two repositories do not use the same model.
1759
if source.supports_rich_root() != target.supports_rich_root():
1760
raise errors.IncompatibleRepositories(source, target,
1761
"different rich-root support")
1762
if source._serializer != target._serializer:
1763
raise errors.IncompatibleRepositories(source, target,
1764
"different serializers")
1767
class CopyConverter(object):
1768
"""A repository conversion tool which just performs a copy of the content.
1770
This is slow but quite reliable.
1773
def __init__(self, target_format):
1774
"""Create a CopyConverter.
1776
:param target_format: The format the resulting repository should be.
1778
self.target_format = target_format
1780
def convert(self, repo, pb):
1781
"""Perform the conversion of to_convert, giving feedback via pb.
1783
:param to_convert: The disk object to convert.
1784
:param pb: a progress bar to use for progress information.
1786
pb = ui.ui_factory.nested_progress_bar()
1789
# this is only useful with metadir layouts - separated repo content.
1790
# trigger an assertion if not such
1791
repo._format.get_format_string()
1792
self.repo_dir = repo.bzrdir
1793
pb.update('Moving repository to repository.backup')
1794
self.repo_dir.transport.move('repository', 'repository.backup')
1795
backup_transport = self.repo_dir.transport.clone('repository.backup')
1796
repo._format.check_conversion_target(self.target_format)
1797
self.source_repo = repo._format.open(self.repo_dir,
1799
_override_transport=backup_transport)
1800
pb.update('Creating new repository')
1801
converted = self.target_format.initialize(self.repo_dir,
1802
self.source_repo.is_shared())
1803
converted.lock_write()
1805
pb.update('Copying content')
1806
self.source_repo.copy_content_into(converted)
1809
pb.update('Deleting old repository content')
1810
self.repo_dir.transport.delete_tree('repository.backup')
1811
ui.ui_factory.note('repository converted')
1815
def _strip_NULL_ghosts(revision_graph):
1816
"""Also don't use this. more compatibility code for unmigrated clients."""
1817
# Filter ghosts, and null:
1818
if _mod_revision.NULL_REVISION in revision_graph:
1819
del revision_graph[_mod_revision.NULL_REVISION]
1820
for key, parents in revision_graph.items():
1821
revision_graph[key] = tuple(parent for parent in parents if parent
1823
return revision_graph
1826
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1827
stop_revision=None):
1828
"""Extend the partial history to include a given index
1830
If a stop_index is supplied, stop when that index has been reached.
1831
If a stop_revision is supplied, stop when that revision is
1832
encountered. Otherwise, stop when the beginning of history is
1835
:param stop_index: The index which should be present. When it is
1836
present, history extension will stop.
1837
:param stop_revision: The revision id which should be present. When
1838
it is encountered, history extension will stop.
1840
start_revision = partial_history_cache[-1]
1841
graph = repo.get_graph()
1842
iterator = graph.iter_lefthand_ancestry(start_revision,
1843
(_mod_revision.NULL_REVISION,))
1845
# skip the last revision in the list
1848
if (stop_index is not None and
1849
len(partial_history_cache) > stop_index):
1851
if partial_history_cache[-1] == stop_revision:
1853
revision_id = iterator.next()
1854
partial_history_cache.append(revision_id)
1855
except StopIteration:
1860
class _LazyListJoin(object):
1861
"""An iterable yielding the contents of many lists as one list.
1863
Each iterator made from this will reflect the current contents of the lists
1864
at the time the iterator is made.
1866
This is used by Repository's _make_parents_provider implementation so that
1869
pp = repo._make_parents_provider() # uses a list of fallback repos
1870
pp.add_fallback_repository(other_repo) # appends to that list
1871
result = pp.get_parent_map(...)
1872
# The result will include revs from other_repo
1875
def __init__(self, *list_parts):
1876
self.list_parts = list_parts
1880
for list_part in self.list_parts:
1881
full_list.extend(list_part)
1882
return iter(full_list)
added
removed
bzrlib/repository.py
