1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
33
revision as _mod_revision,
34
testament as _mod_testament,
38
from bzrlib.bundle import serializer
39
from bzrlib.i18n import gettext
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.inter import InterObject
51
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
from bzrlib.trace import (
53
log_exception_quietly, note, mutter, mutter_callsite, warning)
56
# Old formats display a warning, but only once
57
_deprecation_warning_done = False
60
class IsInWriteGroupError(errors.InternalBzrError):
62
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
64
def __init__(self, repo):
65
errors.InternalBzrError.__init__(self, repo=repo)
68
class CommitBuilder(object):
69
"""Provides an interface to build up a commit.
71
This allows describing a tree to be committed without needing to
72
know the internals of the format of the repository.
75
# all clients should supply tree roots.
76
record_root_entry = True
77
# whether this commit builder supports the record_entry_contents interface
78
supports_record_entry_contents = False
79
# whether this commit builder will automatically update the branch that is
81
updates_branch = False
83
def __init__(self, repository, parents, config_stack, timestamp=None,
84
timezone=None, committer=None, revprops=None,
85
revision_id=None, lossy=False):
86
"""Initiate a CommitBuilder.
88
:param repository: Repository to commit to.
89
:param parents: Revision ids of the parents of the new revision.
90
:param timestamp: Optional timestamp recorded for commit.
91
:param timezone: Optional timezone for timestamp.
92
:param committer: Optional committer to set for commit.
93
:param revprops: Optional dictionary of revision properties.
94
:param revision_id: Optional revision id.
95
:param lossy: Whether to discard data that can not be natively
96
represented, when pushing to a foreign VCS
98
self._config_stack = config_stack
101
if committer is None:
102
self._committer = self._config_stack.get('email')
103
elif not isinstance(committer, unicode):
104
self._committer = committer.decode() # throw if non-ascii
106
self._committer = committer
108
self._new_revision_id = revision_id
109
self.parents = parents
110
self.repository = repository
113
if revprops is not None:
114
self._validate_revprops(revprops)
115
self._revprops.update(revprops)
117
if timestamp is None:
118
timestamp = time.time()
119
# Restrict resolution to 1ms
120
self._timestamp = round(timestamp, 3)
123
self._timezone = osutils.local_time_offset()
125
self._timezone = int(timezone)
127
self._generate_revision_if_needed()
129
def any_changes(self):
130
"""Return True if any entries were changed.
132
This includes merge-only changes. It is the core for the --unchanged
135
:return: True if any changes have occured.
137
raise NotImplementedError(self.any_changes)
139
def _validate_unicode_text(self, text, context):
140
"""Verify things like commit messages don't have bogus characters."""
142
raise ValueError('Invalid value for %s: %r' % (context, text))
144
def _validate_revprops(self, revprops):
145
for key, value in revprops.iteritems():
146
# We know that the XML serializers do not round trip '\r'
147
# correctly, so refuse to accept them
148
if not isinstance(value, basestring):
149
raise ValueError('revision property (%s) is not a valid'
150
' (unicode) string: %r' % (key, value))
151
self._validate_unicode_text(value,
152
'revision property (%s)' % (key,))
154
def commit(self, message):
155
"""Make the actual commit.
157
:return: The revision id of the recorded revision.
159
raise NotImplementedError(self.commit)
162
"""Abort the commit that is being built.
164
raise NotImplementedError(self.abort)
166
def revision_tree(self):
167
"""Return the tree that was just committed.
169
After calling commit() this can be called to get a
170
RevisionTree representing the newly committed tree. This is
171
preferred to calling Repository.revision_tree() because that may
172
require deserializing the inventory, while we already have a copy in
175
raise NotImplementedError(self.revision_tree)
177
def finish_inventory(self):
178
"""Tell the builder that the inventory is finished.
180
:return: The inventory id in the repository, which can be used with
181
repository.get_inventory.
183
raise NotImplementedError(self.finish_inventory)
185
def _gen_revision_id(self):
186
"""Return new revision-id."""
187
return generate_ids.gen_revision_id(self._committer, self._timestamp)
189
def _generate_revision_if_needed(self):
190
"""Create a revision id if None was supplied.
192
If the repository can not support user-specified revision ids
193
they should override this function and raise CannotSetRevisionId
194
if _new_revision_id is not None.
196
:raises: CannotSetRevisionId
198
if self._new_revision_id is None:
199
self._new_revision_id = self._gen_revision_id()
200
self.random_revid = True
202
self.random_revid = False
204
def will_record_deletes(self):
205
"""Tell the commit builder that deletes are being notified.
207
This enables the accumulation of an inventory delta; for the resulting
208
commit to be valid, deletes against the basis MUST be recorded via
209
builder.record_delete().
211
raise NotImplementedError(self.will_record_deletes)
213
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
214
"""Record a new tree via iter_changes.
216
:param tree: The tree to obtain text contents from for changed objects.
217
:param basis_revision_id: The revision id of the tree the iter_changes
218
has been generated against. Currently assumed to be the same
219
as self.parents[0] - if it is not, errors may occur.
220
:param iter_changes: An iter_changes iterator with the changes to apply
221
to basis_revision_id. The iterator must not include any items with
222
a current kind of None - missing items must be either filtered out
223
or errored-on beefore record_iter_changes sees the item.
224
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
227
raise NotImplementedError(self.record_iter_changes)
230
class RepositoryWriteLockResult(LogicalLockResult):
231
"""The result of write locking a repository.
233
:ivar repository_token: The token obtained from the underlying lock, or
235
:ivar unlock: A callable which will unlock the lock.
238
def __init__(self, unlock, repository_token):
239
LogicalLockResult.__init__(self, unlock)
240
self.repository_token = repository_token
243
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
247
######################################################################
251
class Repository(_RelockDebugMixin, controldir.ControlComponent):
252
"""Repository holding history for one or more branches.
254
The repository holds and retrieves historical information including
255
revisions and file history. It's normally accessed only by the Branch,
256
which views a particular line of development through that history.
258
See VersionedFileRepository in bzrlib.vf_repository for the
259
base class for most Bazaar repositories.
262
def abort_write_group(self, suppress_errors=False):
263
"""Commit the contents accrued within the current write group.
265
:param suppress_errors: if true, abort_write_group will catch and log
266
unexpected errors that happen during the abort, rather than
267
allowing them to propagate. Defaults to False.
269
:seealso: start_write_group.
271
if self._write_group is not self.get_transaction():
272
# has an unlock or relock occured ?
275
'(suppressed) mismatched lock context and write group. %r, %r',
276
self._write_group, self.get_transaction())
278
raise errors.BzrError(
279
'mismatched lock context and write group. %r, %r' %
280
(self._write_group, self.get_transaction()))
282
self._abort_write_group()
283
except Exception, exc:
284
self._write_group = None
285
if not suppress_errors:
287
mutter('abort_write_group failed')
288
log_exception_quietly()
289
note(gettext('bzr: ERROR (ignored): %s'), exc)
290
self._write_group = None
292
def _abort_write_group(self):
293
"""Template method for per-repository write group cleanup.
295
This is called during abort before the write group is considered to be
296
finished and should cleanup any internal state accrued during the write
297
group. There is no requirement that data handed to the repository be
298
*not* made available - this is not a rollback - but neither should any
299
attempt be made to ensure that data added is fully commited. Abort is
300
invoked when an error has occured so futher disk or network operations
301
may not be possible or may error and if possible should not be
305
def add_fallback_repository(self, repository):
306
"""Add a repository to use for looking up data not held locally.
308
:param repository: A repository.
310
raise NotImplementedError(self.add_fallback_repository)
312
def _check_fallback_repository(self, repository):
313
"""Check that this repository can fallback to repository safely.
315
Raise an error if not.
317
:param repository: A repository to fallback to.
319
return InterRepository._assert_same_model(self, repository)
321
def all_revision_ids(self):
322
"""Returns a list of all the revision ids in the repository.
324
This is conceptually deprecated because code should generally work on
325
the graph reachable from a particular revision, and ignore any other
326
revisions that might be present. There is no direct replacement
329
if 'evil' in debug.debug_flags:
330
mutter_callsite(2, "all_revision_ids is linear with history.")
331
return self._all_revision_ids()
333
def _all_revision_ids(self):
334
"""Returns a list of all the revision ids in the repository.
336
These are in as much topological order as the underlying store can
339
raise NotImplementedError(self._all_revision_ids)
341
def break_lock(self):
342
"""Break a lock if one is present from another instance.
344
Uses the ui factory to ask for confirmation if the lock may be from
347
self.control_files.break_lock()
350
def create(controldir):
351
"""Construct the current default format repository in controldir."""
352
return RepositoryFormat.get_default_format().initialize(controldir)
354
def __init__(self, _format, controldir, control_files):
355
"""instantiate a Repository.
357
:param _format: The format of the repository on disk.
358
:param controldir: The ControlDir of the repository.
359
:param control_files: Control files to use for locking, etc.
361
# In the future we will have a single api for all stores for
362
# getting file texts, inventories and revisions, then
363
# this construct will accept instances of those things.
364
super(Repository, self).__init__()
365
self._format = _format
366
# the following are part of the public API for Repository:
367
self.bzrdir = controldir
368
self.control_files = control_files
370
self._write_group = None
371
# Additional places to query for data.
372
self._fallback_repositories = []
375
def user_transport(self):
376
return self.bzrdir.user_transport
379
def control_transport(self):
380
return self._transport
383
if self._fallback_repositories:
384
return '%s(%r, fallback_repositories=%r)' % (
385
self.__class__.__name__,
387
self._fallback_repositories)
389
return '%s(%r)' % (self.__class__.__name__,
392
def _has_same_fallbacks(self, other_repo):
393
"""Returns true if the repositories have the same fallbacks."""
394
my_fb = self._fallback_repositories
395
other_fb = other_repo._fallback_repositories
396
if len(my_fb) != len(other_fb):
398
for f, g in zip(my_fb, other_fb):
399
if not f.has_same_location(g):
403
def has_same_location(self, other):
404
"""Returns a boolean indicating if this repository is at the same
405
location as another repository.
407
This might return False even when two repository objects are accessing
408
the same physical repository via different URLs.
410
if self.__class__ is not other.__class__:
412
return (self.control_url == other.control_url)
414
def is_in_write_group(self):
415
"""Return True if there is an open write group.
417
:seealso: start_write_group.
419
return self._write_group is not None
422
return self.control_files.is_locked()
424
def is_write_locked(self):
425
"""Return True if this object is write locked."""
426
return self.is_locked() and self.control_files._lock_mode == 'w'
428
def lock_write(self, token=None):
429
"""Lock this repository for writing.
431
This causes caching within the repository obejct to start accumlating
432
data during reads, and allows a 'write_group' to be obtained. Write
433
groups must be used for actual data insertion.
435
A token should be passed in if you know that you have locked the object
436
some other way, and need to synchronise this object's state with that
439
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
441
:param token: if this is already locked, then lock_write will fail
442
unless the token matches the existing lock.
443
:returns: a token if this instance supports tokens, otherwise None.
444
:raises TokenLockingNotSupported: when a token is given but this
445
instance doesn't support using token locks.
446
:raises MismatchedToken: if the specified token doesn't match the token
447
of the existing lock.
448
:seealso: start_write_group.
449
:return: A RepositoryWriteLockResult.
451
locked = self.is_locked()
452
token = self.control_files.lock_write(token=token)
454
self._warn_if_deprecated()
456
for repo in self._fallback_repositories:
457
# Writes don't affect fallback repos
460
return RepositoryWriteLockResult(self.unlock, token)
463
"""Lock the repository for read operations.
465
:return: An object with an unlock method which will release the lock
468
locked = self.is_locked()
469
self.control_files.lock_read()
471
self._warn_if_deprecated()
473
for repo in self._fallback_repositories:
476
return LogicalLockResult(self.unlock)
478
def get_physical_lock_status(self):
479
return self.control_files.get_physical_lock_status()
481
def leave_lock_in_place(self):
482
"""Tell this repository not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this repository to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
498
def gather_stats(self, revid=None, committers=None):
499
"""Gather statistics from a revision id.
501
:param revid: The revision id to gather statistics from, if None, then
502
no revision specific statistics are gathered.
503
:param committers: Optional parameter controlling whether to grab
504
a count of committers from the revision specific statistics.
505
:return: A dictionary of statistics. Currently this contains:
506
committers: The number of committers if requested.
507
firstrev: A tuple with timestamp, timezone for the penultimate left
508
most ancestor of revid, if revid is not the NULL_REVISION.
509
latestrev: A tuple with timestamp, timezone for revid, if revid is
510
not the NULL_REVISION.
511
revisions: The total revision count in the repository.
512
size: An estimate disk size of the repository in bytes.
515
if revid and committers:
516
result['committers'] = 0
517
if revid and revid != _mod_revision.NULL_REVISION:
518
graph = self.get_graph()
520
all_committers = set()
521
revisions = [r for (r, p) in graph.iter_ancestry([revid])
522
if r != _mod_revision.NULL_REVISION]
525
# ignore the revisions in the middle - just grab first and last
526
revisions = revisions[0], revisions[-1]
527
for revision in self.get_revisions(revisions):
528
if not last_revision:
529
last_revision = revision
531
all_committers.add(revision.committer)
532
first_revision = revision
534
result['committers'] = len(all_committers)
535
result['firstrev'] = (first_revision.timestamp,
536
first_revision.timezone)
537
result['latestrev'] = (last_revision.timestamp,
538
last_revision.timezone)
541
def find_branches(self, using=False):
542
"""Find branches underneath this repository.
544
This will include branches inside other branches.
546
:param using: If True, list only branches using this repository.
548
if using and not self.is_shared():
549
return self.bzrdir.list_branches()
550
class Evaluator(object):
553
self.first_call = True
555
def __call__(self, controldir):
556
# On the first call, the parameter is always the controldir
557
# containing the current repo.
558
if not self.first_call:
560
repository = controldir.open_repository()
561
except errors.NoRepositoryPresent:
564
return False, ([], repository)
565
self.first_call = False
566
value = (controldir.list_branches(), None)
570
for branches, repository in controldir.ControlDir.find_bzrdirs(
571
self.user_transport, evaluate=Evaluator()):
572
if branches is not None:
574
if not using and repository is not None:
575
ret.extend(repository.find_branches())
579
def search_missing_revision_ids(self, other,
580
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
581
find_ghosts=True, revision_ids=None, if_present_ids=None,
583
"""Return the revision ids that other has that this does not.
585
These are returned in topological order.
587
revision_id: only return revision ids included by revision_id.
589
if symbol_versioning.deprecated_passed(revision_id):
590
symbol_versioning.warn(
591
'search_missing_revision_ids(revision_id=...) was '
592
'deprecated in 2.4. Use revision_ids=[...] instead.',
593
DeprecationWarning, stacklevel=3)
594
if revision_ids is not None:
595
raise AssertionError(
596
'revision_ids is mutually exclusive with revision_id')
597
if revision_id is not None:
598
revision_ids = [revision_id]
599
return InterRepository.get(other, self).search_missing_revision_ids(
600
find_ghosts=find_ghosts, revision_ids=revision_ids,
601
if_present_ids=if_present_ids, limit=limit)
605
"""Open the repository rooted at base.
607
For instance, if the repository is at URL/.bzr/repository,
608
Repository.open(URL) -> a Repository instance.
610
control = controldir.ControlDir.open(base)
611
return control.open_repository()
613
def copy_content_into(self, destination, revision_id=None):
614
"""Make a complete copy of the content in self into destination.
616
This is a destructive operation! Do not use it on existing
619
return InterRepository.get(self, destination).copy_content(revision_id)
621
def commit_write_group(self):
622
"""Commit the contents accrued within the current write group.
624
:seealso: start_write_group.
626
:return: it may return an opaque hint that can be passed to 'pack'.
628
if self._write_group is not self.get_transaction():
629
# has an unlock or relock occured ?
630
raise errors.BzrError('mismatched lock context %r and '
632
(self.get_transaction(), self._write_group))
633
result = self._commit_write_group()
634
self._write_group = None
637
def _commit_write_group(self):
638
"""Template method for per-repository write group cleanup.
640
This is called before the write group is considered to be
641
finished and should ensure that all data handed to the repository
642
for writing during the write group is safely committed (to the
643
extent possible considering file system caching etc).
646
def suspend_write_group(self):
647
"""Suspend a write group.
649
:raise UnsuspendableWriteGroup: If the write group can not be
651
:return: List of tokens
653
raise errors.UnsuspendableWriteGroup(self)
655
def refresh_data(self):
656
"""Re-read any data needed to synchronise with disk.
658
This method is intended to be called after another repository instance
659
(such as one used by a smart server) has inserted data into the
660
repository. On all repositories this will work outside of write groups.
661
Some repository formats (pack and newer for bzrlib native formats)
662
support refresh_data inside write groups. If called inside a write
663
group on a repository that does not support refreshing in a write group
664
IsInWriteGroupError will be raised.
668
def resume_write_group(self, tokens):
669
if not self.is_write_locked():
670
raise errors.NotWriteLocked(self)
671
if self._write_group:
672
raise errors.BzrError('already in a write group')
673
self._resume_write_group(tokens)
674
# so we can detect unlock/relock - the write group is now entered.
675
self._write_group = self.get_transaction()
677
def _resume_write_group(self, tokens):
678
raise errors.UnsuspendableWriteGroup(self)
680
def fetch(self, source, revision_id=None, find_ghosts=False):
681
"""Fetch the content required to construct revision_id from source.
683
If revision_id is None, then all content is copied.
685
fetch() may not be used when the repository is in a write group -
686
either finish the current write group before using fetch, or use
687
fetch before starting the write group.
689
:param find_ghosts: Find and copy revisions in the source that are
690
ghosts in the target (and not reachable directly by walking out to
691
the first-present revision in target from revision_id).
692
:param revision_id: If specified, all the content needed for this
693
revision ID will be copied to the target. Fetch will determine for
694
itself which content needs to be copied.
696
if self.is_in_write_group():
697
raise errors.InternalBzrError(
698
"May not fetch while in a write group.")
699
# fast path same-url fetch operations
700
# TODO: lift out to somewhere common with RemoteRepository
701
# <https://bugs.launchpad.net/bzr/+bug/401646>
702
if (self.has_same_location(source)
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, find_ghosts=find_ghosts)
713
def create_bundle(self, target, base, fileobj, format=None):
714
return serializer.write_bundle(self, target, base, fileobj, format)
716
def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
717
timezone=None, committer=None, revprops=None,
718
revision_id=None, lossy=False):
719
"""Obtain a CommitBuilder for this repository.
721
:param branch: Branch to commit to.
722
:param parents: Revision ids of the parents of the new revision.
723
:param config_stack: Configuration stack to use.
724
:param timestamp: Optional timestamp recorded for commit.
725
:param timezone: Optional timezone for timestamp.
726
:param committer: Optional committer to set for commit.
727
:param revprops: Optional dictionary of revision properties.
728
:param revision_id: Optional revision id.
729
:param lossy: Whether to discard data that can not be natively
730
represented, when pushing to a foreign VCS
732
raise NotImplementedError(self.get_commit_builder)
734
@only_raises(errors.LockNotHeld, errors.LockBroken)
736
if (self.control_files._lock_count == 1 and
737
self.control_files._lock_mode == 'w'):
738
if self._write_group is not None:
739
self.abort_write_group()
740
self.control_files.unlock()
741
raise errors.BzrError(
742
'Must end write groups before releasing write locks.')
743
self.control_files.unlock()
744
if self.control_files._lock_count == 0:
745
for repo in self._fallback_repositories:
749
def clone(self, controldir, revision_id=None):
750
"""Clone this repository into controldir using the current format.
752
Currently no check is made that the format of this repository and
753
the bzrdir format are compatible. FIXME RBC 20060201.
755
:return: The newly created destination repository.
757
# TODO: deprecate after 0.16; cloning this with all its settings is
758
# probably not very useful -- mbp 20070423
759
dest_repo = self._create_sprouting_repo(
760
controldir, 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 iter_files_bytes(self, desired_files):
934
"""Iterate through file versions.
936
Files will not necessarily be returned in the order they occur in
937
desired_files. No specific order is guaranteed.
939
Yields pairs of identifier, bytes_iterator. identifier is an opaque
940
value supplied by the caller as part of desired_files. It should
941
uniquely identify the file version in the caller's context. (Examples:
942
an index number or a TreeTransform trans_id.)
944
:param desired_files: a list of (file_id, revision_id, identifier)
947
raise NotImplementedError(self.iter_files_bytes)
949
def get_rev_id_for_revno(self, revno, known_pair):
950
"""Return the revision id of a revno, given a later (revno, revid)
951
pair in the same history.
953
:return: if found (True, revid). If the available history ran out
954
before reaching the revno, then this returns
955
(False, (closest_revno, closest_revid)).
957
known_revno, known_revid = known_pair
958
partial_history = [known_revid]
959
distance_from_known = known_revno - revno
960
if distance_from_known < 0:
962
'requested revno (%d) is later than given known revno (%d)'
963
% (revno, known_revno))
966
self, partial_history, stop_index=distance_from_known)
967
except errors.RevisionNotPresent, err:
968
if err.revision_id == known_revid:
969
# The start revision (known_revid) wasn't found.
971
# This is a stacked repository with no fallbacks, or a there's a
972
# left-hand ghost. Either way, even though the revision named in
973
# the error isn't in this repo, we know it's the next step in this
975
partial_history.append(err.revision_id)
976
if len(partial_history) <= distance_from_known:
977
# Didn't find enough history to get a revid for the revno.
978
earliest_revno = known_revno - len(partial_history) + 1
979
return (False, (earliest_revno, partial_history[-1]))
980
if len(partial_history) - 1 > distance_from_known:
981
raise AssertionError('_iter_for_revno returned too much history')
982
return (True, partial_history[-1])
984
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
985
def iter_reverse_revision_history(self, revision_id):
986
"""Iterate backwards through revision ids in the lefthand history
988
:param revision_id: The revision id to start with. All its lefthand
989
ancestors will be traversed.
991
graph = self.get_graph()
992
stop_revisions = (None, _mod_revision.NULL_REVISION)
993
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
996
"""Return True if this repository is flagged as a shared repository."""
997
raise NotImplementedError(self.is_shared)
1000
def reconcile(self, other=None, thorough=False):
1001
"""Reconcile this repository."""
1002
from bzrlib.reconcile import RepoReconciler
1003
reconciler = RepoReconciler(self, thorough=thorough)
1004
reconciler.reconcile()
1007
def _refresh_data(self):
1008
"""Helper called from lock_* to ensure coherency with disk.
1010
The default implementation does nothing; it is however possible
1011
for repositories to maintain loaded indices across multiple locks
1012
by checking inside their implementation of this method to see
1013
whether their indices are still valid. This depends of course on
1014
the disk format being validatable in this manner. This method is
1015
also called by the refresh_data() public interface to cause a refresh
1016
to occur while in a write lock so that data inserted by a smart server
1017
push operation is visible on the client's instance of the physical
1022
def revision_tree(self, revision_id):
1023
"""Return Tree for a revision on this branch.
1025
`revision_id` may be NULL_REVISION for the empty tree revision.
1027
raise NotImplementedError(self.revision_tree)
1029
def revision_trees(self, revision_ids):
1030
"""Return Trees for revisions in this repository.
1032
:param revision_ids: a sequence of revision-ids;
1033
a revision-id may not be None or 'null:'
1035
raise NotImplementedError(self.revision_trees)
1038
@symbol_versioning.deprecated_method(
1039
symbol_versioning.deprecated_in((2, 4, 0)))
1040
def get_ancestry(self, revision_id, topo_sorted=True):
1041
"""Return a list of revision-ids integrated by a revision.
1043
The first element of the list is always None, indicating the origin
1044
revision. This might change when we have history horizons, or
1045
perhaps we should have a new API.
1047
This is topologically sorted.
1049
if 'evil' in debug.debug_flags:
1050
mutter_callsite(2, "get_ancestry is linear with history.")
1051
if _mod_revision.is_null(revision_id):
1053
if not self.has_revision(revision_id):
1054
raise errors.NoSuchRevision(self, revision_id)
1055
graph = self.get_graph()
1057
search = graph._make_breadth_first_searcher([revision_id])
1060
found, ghosts = search.next_with_ghosts()
1061
except StopIteration:
1064
if _mod_revision.NULL_REVISION in keys:
1065
keys.remove(_mod_revision.NULL_REVISION)
1067
parent_map = graph.get_parent_map(keys)
1068
keys = tsort.topo_sort(parent_map)
1069
return [None] + list(keys)
1071
def pack(self, hint=None, clean_obsolete_packs=False):
1072
"""Compress the data within the repository.
1074
This operation only makes sense for some repository types. For other
1075
types it should be a no-op that just returns.
1077
This stub method does not require a lock, but subclasses should use
1078
@needs_write_lock as this is a long running call it's reasonable to
1079
implicitly lock for the user.
1081
:param hint: If not supplied, the whole repository is packed.
1082
If supplied, the repository may use the hint parameter as a
1083
hint for the parts of the repository to pack. A hint can be
1084
obtained from the result of commit_write_group(). Out of
1085
date hints are simply ignored, because concurrent operations
1086
can obsolete them rapidly.
1088
:param clean_obsolete_packs: Clean obsolete packs immediately after
1092
def get_transaction(self):
1093
return self.control_files.get_transaction()
1095
def get_parent_map(self, revision_ids):
1096
"""See graph.StackedParentsProvider.get_parent_map"""
1097
raise NotImplementedError(self.get_parent_map)
1099
def _get_parent_map_no_fallbacks(self, revision_ids):
1100
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1101
# revisions index works in keys; this just works in revisions
1102
# therefore wrap and unwrap
1105
for revision_id in revision_ids:
1106
if revision_id == _mod_revision.NULL_REVISION:
1107
result[revision_id] = ()
1108
elif revision_id is None:
1109
raise ValueError('get_parent_map(None) is not valid')
1111
query_keys.append((revision_id ,))
1112
vf = self.revisions.without_fallbacks()
1113
for ((revision_id,), parent_keys) in \
1114
vf.get_parent_map(query_keys).iteritems():
1116
result[revision_id] = tuple([parent_revid
1117
for (parent_revid,) in parent_keys])
1119
result[revision_id] = (_mod_revision.NULL_REVISION,)
1122
def _make_parents_provider(self):
1123
if not self._format.supports_external_lookups:
1125
return graph.StackedParentsProvider(_LazyListJoin(
1126
[self._make_parents_provider_unstacked()],
1127
self._fallback_repositories))
1129
def _make_parents_provider_unstacked(self):
1130
return graph.CallableToParentsProviderAdapter(
1131
self._get_parent_map_no_fallbacks)
1134
def get_known_graph_ancestry(self, revision_ids):
1135
"""Return the known graph for a set of revision ids and their ancestors.
1137
raise NotImplementedError(self.get_known_graph_ancestry)
1139
def get_file_graph(self):
1140
"""Return the graph walker for files."""
1141
raise NotImplementedError(self.get_file_graph)
1143
def get_graph(self, other_repository=None):
1144
"""Return the graph walker for this repository format"""
1145
parents_provider = self._make_parents_provider()
1146
if (other_repository is not None and
1147
not self.has_same_location(other_repository)):
1148
parents_provider = graph.StackedParentsProvider(
1149
[parents_provider, other_repository._make_parents_provider()])
1150
return graph.Graph(parents_provider)
1153
def set_make_working_trees(self, new_value):
1154
"""Set the policy flag for making working trees when creating branches.
1156
This only applies to branches that use this repository.
1158
The default is 'True'.
1159
:param new_value: True to restore the default, False to disable making
1162
raise NotImplementedError(self.set_make_working_trees)
1164
def make_working_trees(self):
1165
"""Returns the policy for making working trees on new branches."""
1166
raise NotImplementedError(self.make_working_trees)
1169
def sign_revision(self, revision_id, gpg_strategy):
1170
testament = _mod_testament.Testament.from_revision(self, revision_id)
1171
plaintext = testament.as_short_text()
1172
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1175
def verify_revision_signature(self, revision_id, gpg_strategy):
1176
"""Verify the signature on a revision.
1178
:param revision_id: the revision to verify
1179
:gpg_strategy: the GPGStrategy object to used
1181
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1183
if not self.has_signature_for_revision_id(revision_id):
1184
return gpg.SIGNATURE_NOT_SIGNED, None
1185
signature = self.get_signature_text(revision_id)
1187
testament = _mod_testament.Testament.from_revision(self, revision_id)
1188
plaintext = testament.as_short_text()
1190
return gpg_strategy.verify(signature, plaintext)
1193
def verify_revision_signatures(self, revision_ids, gpg_strategy):
1194
"""Verify revision signatures for a number of revisions.
1196
:param revision_id: the revision to verify
1197
:gpg_strategy: the GPGStrategy object to used
1198
:return: Iterator over tuples with revision id, result and keys
1200
for revid in revision_ids:
1201
(result, key) = self.verify_revision_signature(revid, gpg_strategy)
1202
yield revid, result, key
1204
def has_signature_for_revision_id(self, revision_id):
1205
"""Query for a revision signature for revision_id in the repository."""
1206
raise NotImplementedError(self.has_signature_for_revision_id)
1208
def get_signature_text(self, revision_id):
1209
"""Return the text for a signature."""
1210
raise NotImplementedError(self.get_signature_text)
1212
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1213
"""Check consistency of all history of given revision_ids.
1215
Different repository implementations should override _check().
1217
:param revision_ids: A non-empty list of revision_ids whose ancestry
1218
will be checked. Typically the last revision_id of a branch.
1219
:param callback_refs: A dict of check-refs to resolve and callback
1220
the check/_check method on the items listed as wanting the ref.
1222
:param check_repo: If False do not check the repository contents, just
1223
calculate the data callback_refs requires and call them back.
1225
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1226
check_repo=check_repo)
1228
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1229
raise NotImplementedError(self.check)
1231
def _warn_if_deprecated(self, branch=None):
1232
if not self._format.is_deprecated():
1234
global _deprecation_warning_done
1235
if _deprecation_warning_done:
1239
conf = config.GlobalStack()
1241
conf = branch.get_config_stack()
1242
if 'format_deprecation' in conf.get('suppress_warnings'):
1244
warning("Format %s for %s is deprecated -"
1245
" please use 'bzr upgrade' to get better performance"
1246
% (self._format, self.bzrdir.transport.base))
1248
_deprecation_warning_done = True
1250
def supports_rich_root(self):
1251
return self._format.rich_root_data
1253
def _check_ascii_revisionid(self, revision_id, method):
1254
"""Private helper for ascii-only repositories."""
1255
# weave repositories refuse to store revisionids that are non-ascii.
1256
if revision_id is not None:
1257
# weaves require ascii revision ids.
1258
if isinstance(revision_id, unicode):
1260
revision_id.encode('ascii')
1261
except UnicodeEncodeError:
1262
raise errors.NonAsciiRevisionId(method, self)
1265
revision_id.decode('ascii')
1266
except UnicodeDecodeError:
1267
raise errors.NonAsciiRevisionId(method, self)
1270
class MetaDirRepository(Repository):
1271
"""Repositories in the new meta-dir layout.
1273
:ivar _transport: Transport for access to repository control files,
1274
typically pointing to .bzr/repository.
1277
def __init__(self, _format, a_bzrdir, control_files):
1278
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1279
self._transport = control_files._transport
1281
def is_shared(self):
1282
"""Return True if this repository is flagged as a shared repository."""
1283
return self._transport.has('shared-storage')
1286
def set_make_working_trees(self, new_value):
1287
"""Set the policy flag for making working trees when creating branches.
1289
This only applies to branches that use this repository.
1291
The default is 'True'.
1292
:param new_value: True to restore the default, False to disable making
1297
self._transport.delete('no-working-trees')
1298
except errors.NoSuchFile:
1301
self._transport.put_bytes('no-working-trees', '',
1302
mode=self.bzrdir._get_file_mode())
1304
def make_working_trees(self):
1305
"""Returns the policy for making working trees on new branches."""
1306
return not self._transport.has('no-working-trees')
1309
def update_feature_flags(self, updated_flags):
1310
"""Update the feature flags for this branch.
1312
:param updated_flags: Dictionary mapping feature names to necessities
1313
A necessity can be None to indicate the feature should be removed
1315
self._format._update_feature_flags(updated_flags)
1316
self.control_transport.put_bytes('format', self._format.as_string())
1319
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1320
"""Repository format registry."""
1322
def get_default(self):
1323
"""Return the current default format."""
1324
return controldir.format_registry.make_bzrdir('default').repository_format
1327
network_format_registry = registry.FormatRegistry()
1328
"""Registry of formats indexed by their network name.
1330
The network name for a repository format is an identifier that can be used when
1331
referring to formats with smart server operations. See
1332
RepositoryFormat.network_name() for more detail.
1336
format_registry = RepositoryFormatRegistry(network_format_registry)
1337
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1339
This can contain either format instances themselves, or classes/factories that
1340
can be called to obtain one.
1344
#####################################################################
1345
# Repository Formats
1347
class RepositoryFormat(controldir.ControlComponentFormat):
1348
"""A repository format.
1350
Formats provide four things:
1351
* An initialization routine to construct repository data on disk.
1352
* a optional format string which is used when the BzrDir supports
1354
* an open routine which returns a Repository instance.
1355
* A network name for referring to the format in smart server RPC
1358
There is one and only one Format subclass for each on-disk format. But
1359
there can be one Repository subclass that is used for several different
1360
formats. The _format attribute on a Repository instance can be used to
1361
determine the disk format.
1363
Formats are placed in a registry by their format string for reference
1364
during opening. These should be subclasses of RepositoryFormat for
1367
Once a format is deprecated, just deprecate the initialize and open
1368
methods on the format class. Do not deprecate the object, as the
1369
object may be created even when a repository instance hasn't been
1372
Common instance attributes:
1373
_matchingbzrdir - the controldir format that the repository format was
1374
originally written to work with. This can be used if manually
1375
constructing a bzrdir and repository, or more commonly for test suite
1379
# Set to True or False in derived classes. True indicates that the format
1380
# supports ghosts gracefully.
1381
supports_ghosts = None
1382
# Can this repository be given external locations to lookup additional
1383
# data. Set to True or False in derived classes.
1384
supports_external_lookups = None
1385
# Does this format support CHK bytestring lookups. Set to True or False in
1387
supports_chks = None
1388
# Should fetch trigger a reconcile after the fetch? Only needed for
1389
# some repository formats that can suffer internal inconsistencies.
1390
_fetch_reconcile = False
1391
# Does this format have < O(tree_size) delta generation. Used to hint what
1392
# code path for commit, amongst other things.
1394
# Does doing a pack operation compress data? Useful for the pack UI command
1395
# (so if there is one pack, the operation can still proceed because it may
1396
# help), and for fetching when data won't have come from the same
1398
pack_compresses = False
1399
# Does the repository storage understand references to trees?
1400
supports_tree_reference = None
1401
# Is the format experimental ?
1402
experimental = False
1403
# Does this repository format escape funky characters, or does it create
1404
# files with similar names as the versioned files in its contents on disk
1406
supports_funky_characters = None
1407
# Does this repository format support leaving locks?
1408
supports_leaving_lock = None
1409
# Does this format support the full VersionedFiles interface?
1410
supports_full_versioned_files = None
1411
# Does this format support signing revision signatures?
1412
supports_revision_signatures = True
1413
# Can the revision graph have incorrect parents?
1414
revision_graph_can_have_wrong_parents = None
1415
# Does this format support rich root data?
1416
rich_root_data = None
1417
# Does this format support explicitly versioned directories?
1418
supports_versioned_directories = None
1419
# Can other repositories be nested into one of this format?
1420
supports_nesting_repositories = None
1421
# Is it possible for revisions to be present without being referenced
1423
supports_unreferenced_revisions = None
1426
return "%s()" % self.__class__.__name__
1428
def __eq__(self, other):
1429
# format objects are generally stateless
1430
return isinstance(other, self.__class__)
1432
def __ne__(self, other):
1433
return not self == other
1436
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1437
def register_format(klass, format):
1438
format_registry.register(format)
1441
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1442
def unregister_format(klass, format):
1443
format_registry.remove(format)
1446
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1447
def get_default_format(klass):
1448
"""Return the current default format."""
1449
return format_registry.get_default()
1451
def get_format_description(self):
1452
"""Return the short description for this format."""
1453
raise NotImplementedError(self.get_format_description)
1455
def initialize(self, controldir, shared=False):
1456
"""Initialize a repository of this format in controldir.
1458
:param controldir: The controldir to put the new repository in it.
1459
:param shared: The repository should be initialized as a sharable one.
1460
:returns: The new repository object.
1462
This may raise UninitializableFormat if shared repository are not
1463
compatible the controldir.
1465
raise NotImplementedError(self.initialize)
1467
def is_supported(self):
1468
"""Is this format supported?
1470
Supported formats must be initializable and openable.
1471
Unsupported formats may not support initialization or committing or
1472
some other features depending on the reason for not being supported.
1476
def is_deprecated(self):
1477
"""Is this format deprecated?
1479
Deprecated formats may trigger a user-visible warning recommending
1480
the user to upgrade. They are still fully supported.
1484
def network_name(self):
1485
"""A simple byte string uniquely identifying this format for RPC calls.
1487
MetaDir repository formats use their disk format string to identify the
1488
repository over the wire. All in one formats such as bzr < 0.8, and
1489
foreign formats like svn/git and hg should use some marker which is
1490
unique and immutable.
1492
raise NotImplementedError(self.network_name)
1494
def check_conversion_target(self, target_format):
1495
if self.rich_root_data and not target_format.rich_root_data:
1496
raise errors.BadConversionTarget(
1497
'Does not support rich root data.', target_format,
1499
if (self.supports_tree_reference and
1500
not getattr(target_format, 'supports_tree_reference', False)):
1501
raise errors.BadConversionTarget(
1502
'Does not support nested trees', target_format,
1505
def open(self, controldir, _found=False):
1506
"""Return an instance of this format for a controldir.
1508
_found is a private parameter, do not use it.
1510
raise NotImplementedError(self.open)
1512
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1513
from bzrlib.controldir import ControlDir, RepoInitHookParams
1514
hooks = ControlDir.hooks['post_repo_init']
1517
params = RepoInitHookParams(repository, self, controldir, shared)
1522
class RepositoryFormatMetaDir(bzrdir.BzrFormat, RepositoryFormat):
1523
"""Common base class for the new repositories using the metadir layout."""
1525
rich_root_data = False
1526
supports_tree_reference = False
1527
supports_external_lookups = False
1528
supports_leaving_lock = True
1529
supports_nesting_repositories = True
1532
def _matchingbzrdir(self):
1533
matching = bzrdir.BzrDirMetaFormat1()
1534
matching.repository_format = self
1538
RepositoryFormat.__init__(self)
1539
bzrdir.BzrFormat.__init__(self)
1541
def _create_control_files(self, a_bzrdir):
1542
"""Create the required files and the initial control_files object."""
1543
# FIXME: RBC 20060125 don't peek under the covers
1544
# NB: no need to escape relative paths that are url safe.
1545
repository_transport = a_bzrdir.get_repository_transport(self)
1546
control_files = lockable_files.LockableFiles(repository_transport,
1547
'lock', lockdir.LockDir)
1548
control_files.create_lock()
1549
return control_files
1551
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1552
"""Upload the initial blank content."""
1553
control_files = self._create_control_files(a_bzrdir)
1554
control_files.lock_write()
1555
transport = control_files._transport
1557
utf8_files += [('shared-storage', '')]
1559
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1560
for (filename, content_stream) in files:
1561
transport.put_file(filename, content_stream,
1562
mode=a_bzrdir._get_file_mode())
1563
for (filename, content_bytes) in utf8_files:
1564
transport.put_bytes_non_atomic(filename, content_bytes,
1565
mode=a_bzrdir._get_file_mode())
1567
control_files.unlock()
1570
def find_format(klass, a_bzrdir):
1571
"""Return the format for the repository object in a_bzrdir.
1573
This is used by bzr native formats that have a "format" file in
1574
the repository. Other methods may be used by different types of
1578
transport = a_bzrdir.get_repository_transport(None)
1579
format_string = transport.get_bytes("format")
1580
except errors.NoSuchFile:
1581
raise errors.NoRepositoryPresent(a_bzrdir)
1582
return klass._find_format(format_registry, 'repository', format_string)
1584
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1586
RepositoryFormat.check_support_status(self,
1587
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1589
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1590
recommend_upgrade=recommend_upgrade, basedir=basedir)
1593
# formats which have no format string are not discoverable or independently
1594
# creatable on disk, so are not registered in format_registry. They're
1595
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1596
# needed, it's constructed directly by the ControlDir. Non-native formats where
1597
# the repository is not separately opened are similar.
1599
format_registry.register_lazy(
1600
'Bazaar-NG Knit Repository Format 1',
1601
'bzrlib.repofmt.knitrepo',
1602
'RepositoryFormatKnit1',
1605
format_registry.register_lazy(
1606
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1607
'bzrlib.repofmt.knitrepo',
1608
'RepositoryFormatKnit3',
1611
format_registry.register_lazy(
1612
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1613
'bzrlib.repofmt.knitrepo',
1614
'RepositoryFormatKnit4',
1617
# Pack-based formats. There is one format for pre-subtrees, and one for
1618
# post-subtrees to allow ease of testing.
1619
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1620
format_registry.register_lazy(
1621
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1622
'bzrlib.repofmt.knitpack_repo',
1623
'RepositoryFormatKnitPack1',
1625
format_registry.register_lazy(
1626
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1627
'bzrlib.repofmt.knitpack_repo',
1628
'RepositoryFormatKnitPack3',
1630
format_registry.register_lazy(
1631
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1632
'bzrlib.repofmt.knitpack_repo',
1633
'RepositoryFormatKnitPack4',
1635
format_registry.register_lazy(
1636
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1637
'bzrlib.repofmt.knitpack_repo',
1638
'RepositoryFormatKnitPack5',
1640
format_registry.register_lazy(
1641
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1642
'bzrlib.repofmt.knitpack_repo',
1643
'RepositoryFormatKnitPack5RichRoot',
1645
format_registry.register_lazy(
1646
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1647
'bzrlib.repofmt.knitpack_repo',
1648
'RepositoryFormatKnitPack5RichRootBroken',
1650
format_registry.register_lazy(
1651
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1652
'bzrlib.repofmt.knitpack_repo',
1653
'RepositoryFormatKnitPack6',
1655
format_registry.register_lazy(
1656
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1657
'bzrlib.repofmt.knitpack_repo',
1658
'RepositoryFormatKnitPack6RichRoot',
1660
format_registry.register_lazy(
1661
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1662
'bzrlib.repofmt.groupcompress_repo',
1663
'RepositoryFormat2a',
1666
# Development formats.
1667
# Check their docstrings to see if/when they are obsolete.
1668
format_registry.register_lazy(
1669
("Bazaar development format 2 with subtree support "
1670
"(needs bzr.dev from before 1.8)\n"),
1671
'bzrlib.repofmt.knitpack_repo',
1672
'RepositoryFormatPackDevelopment2Subtree',
1674
format_registry.register_lazy(
1675
'Bazaar development format 8\n',
1676
'bzrlib.repofmt.groupcompress_repo',
1677
'RepositoryFormat2aSubtree',
1681
class InterRepository(InterObject):
1682
"""This class represents operations taking place between two repositories.
1684
Its instances have methods like copy_content and fetch, and contain
1685
references to the source and target repositories these operations can be
1688
Often we will provide convenience methods on 'repository' which carry out
1689
operations with another repository - they will always forward to
1690
InterRepository.get(other).method_name(parameters).
1694
"""The available optimised InterRepository types."""
1697
def copy_content(self, revision_id=None):
1698
"""Make a complete copy of the content in self into destination.
1700
This is a destructive operation! Do not use it on existing
1703
:param revision_id: Only copy the content needed to construct
1704
revision_id and its parents.
1707
self.target.set_make_working_trees(self.source.make_working_trees())
1708
except NotImplementedError:
1710
self.target.fetch(self.source, revision_id=revision_id)
1713
def fetch(self, revision_id=None, find_ghosts=False):
1714
"""Fetch the content required to construct revision_id.
1716
The content is copied from self.source to self.target.
1718
:param revision_id: if None all content is copied, if NULL_REVISION no
1722
raise NotImplementedError(self.fetch)
1725
def search_missing_revision_ids(self,
1726
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1727
find_ghosts=True, revision_ids=None, if_present_ids=None,
1729
"""Return the revision ids that source has that target does not.
1731
:param revision_id: only return revision ids included by this
1733
:param revision_ids: return revision ids included by these
1734
revision_ids. NoSuchRevision will be raised if any of these
1735
revisions are not present.
1736
:param if_present_ids: like revision_ids, but will not cause
1737
NoSuchRevision if any of these are absent, instead they will simply
1738
not be in the result. This is useful for e.g. finding revisions
1739
to fetch for tags, which may reference absent revisions.
1740
:param find_ghosts: If True find missing revisions in deep history
1741
rather than just finding the surface difference.
1742
:param limit: Maximum number of revisions to return, topologically
1744
:return: A bzrlib.graph.SearchResult.
1746
raise NotImplementedError(self.search_missing_revision_ids)
1749
def _same_model(source, target):
1750
"""True if source and target have the same data representation.
1752
Note: this is always called on the base class; overriding it in a
1753
subclass will have no effect.
1756
InterRepository._assert_same_model(source, target)
1758
except errors.IncompatibleRepositories, e:
1762
def _assert_same_model(source, target):
1763
"""Raise an exception if two repositories do not use the same model.
1765
if source.supports_rich_root() != target.supports_rich_root():
1766
raise errors.IncompatibleRepositories(source, target,
1767
"different rich-root support")
1768
if source._serializer != target._serializer:
1769
raise errors.IncompatibleRepositories(source, target,
1770
"different serializers")
1773
class CopyConverter(object):
1774
"""A repository conversion tool which just performs a copy of the content.
1776
This is slow but quite reliable.
1779
def __init__(self, target_format):
1780
"""Create a CopyConverter.
1782
:param target_format: The format the resulting repository should be.
1784
self.target_format = target_format
1786
def convert(self, repo, pb):
1787
"""Perform the conversion of to_convert, giving feedback via pb.
1789
:param to_convert: The disk object to convert.
1790
:param pb: a progress bar to use for progress information.
1792
pb = ui.ui_factory.nested_progress_bar()
1795
# this is only useful with metadir layouts - separated repo content.
1796
# trigger an assertion if not such
1797
repo._format.get_format_string()
1798
self.repo_dir = repo.bzrdir
1799
pb.update(gettext('Moving repository to repository.backup'))
1800
self.repo_dir.transport.move('repository', 'repository.backup')
1801
backup_transport = self.repo_dir.transport.clone('repository.backup')
1802
repo._format.check_conversion_target(self.target_format)
1803
self.source_repo = repo._format.open(self.repo_dir,
1805
_override_transport=backup_transport)
1806
pb.update(gettext('Creating new repository'))
1807
converted = self.target_format.initialize(self.repo_dir,
1808
self.source_repo.is_shared())
1809
converted.lock_write()
1811
pb.update(gettext('Copying content'))
1812
self.source_repo.copy_content_into(converted)
1815
pb.update(gettext('Deleting old repository content'))
1816
self.repo_dir.transport.delete_tree('repository.backup')
1817
ui.ui_factory.note(gettext('repository converted'))
1821
def _strip_NULL_ghosts(revision_graph):
1822
"""Also don't use this. more compatibility code for unmigrated clients."""
1823
# Filter ghosts, and null:
1824
if _mod_revision.NULL_REVISION in revision_graph:
1825
del revision_graph[_mod_revision.NULL_REVISION]
1826
for key, parents in revision_graph.items():
1827
revision_graph[key] = tuple(parent for parent in parents if parent
1829
return revision_graph
1832
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1833
stop_revision=None):
1834
"""Extend the partial history to include a given index
1836
If a stop_index is supplied, stop when that index has been reached.
1837
If a stop_revision is supplied, stop when that revision is
1838
encountered. Otherwise, stop when the beginning of history is
1841
:param stop_index: The index which should be present. When it is
1842
present, history extension will stop.
1843
:param stop_revision: The revision id which should be present. When
1844
it is encountered, history extension will stop.
1846
start_revision = partial_history_cache[-1]
1847
graph = repo.get_graph()
1848
iterator = graph.iter_lefthand_ancestry(start_revision,
1849
(_mod_revision.NULL_REVISION,))
1851
# skip the last revision in the list
1854
if (stop_index is not None and
1855
len(partial_history_cache) > stop_index):
1857
if partial_history_cache[-1] == stop_revision:
1859
revision_id = iterator.next()
1860
partial_history_cache.append(revision_id)
1861
except StopIteration:
1866
class _LazyListJoin(object):
1867
"""An iterable yielding the contents of many lists as one list.
1869
Each iterator made from this will reflect the current contents of the lists
1870
at the time the iterator is made.
1872
This is used by Repository's _make_parents_provider implementation so that
1875
pp = repo._make_parents_provider() # uses a list of fallback repos
1876
pp.add_fallback_repository(other_repo) # appends to that list
1877
result = pp.get_parent_map(...)
1878
# The result will include revs from other_repo
1881
def __init__(self, *list_parts):
1882
self.list_parts = list_parts
1886
for list_part in self.list_parts:
1887
full_list.extend(list_part)
1888
return iter(full_list)
1891
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
added
removed
bzrlib/repository.py
