1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
32
revision as _mod_revision,
33
testament as _mod_testament,
37
from bzrlib.bundle import serializer
38
from bzrlib.i18n import gettext
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
48
from bzrlib.inter import InterObject
49
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
50
from bzrlib.trace import (
51
log_exception_quietly, note, mutter, mutter_callsite, warning)
54
# Old formats display a warning, but only once
55
_deprecation_warning_done = False
58
class IsInWriteGroupError(errors.InternalBzrError):
60
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
62
def __init__(self, repo):
63
errors.InternalBzrError.__init__(self, repo=repo)
66
class CommitBuilder(object):
67
"""Provides an interface to build up a commit.
69
This allows describing a tree to be committed without needing to
70
know the internals of the format of the repository.
73
# all clients should supply tree roots.
74
record_root_entry = True
75
# whether this commit builder supports the record_entry_contents interface
76
supports_record_entry_contents = False
78
def __init__(self, repository, parents, config, timestamp=None,
79
timezone=None, committer=None, revprops=None,
80
revision_id=None, lossy=False):
81
"""Initiate a CommitBuilder.
83
:param repository: Repository to commit to.
84
:param parents: Revision ids of the parents of the new revision.
85
:param timestamp: Optional timestamp recorded for commit.
86
:param timezone: Optional timezone for timestamp.
87
:param committer: Optional committer to set for commit.
88
:param revprops: Optional dictionary of revision properties.
89
:param revision_id: Optional revision id.
90
:param lossy: Whether to discard data that can not be natively
91
represented, when pushing to a foreign VCS
97
self._committer = self._config.username()
98
elif not isinstance(committer, unicode):
99
self._committer = committer.decode() # throw if non-ascii
101
self._committer = committer
103
self._new_revision_id = revision_id
104
self.parents = parents
105
self.repository = repository
108
if revprops is not None:
109
self._validate_revprops(revprops)
110
self._revprops.update(revprops)
112
if timestamp is None:
113
timestamp = time.time()
114
# Restrict resolution to 1ms
115
self._timestamp = round(timestamp, 3)
118
self._timezone = osutils.local_time_offset()
120
self._timezone = int(timezone)
122
self._generate_revision_if_needed()
124
def any_changes(self):
125
"""Return True if any entries were changed.
127
This includes merge-only changes. It is the core for the --unchanged
130
:return: True if any changes have occured.
132
raise NotImplementedError(self.any_changes)
134
def _validate_unicode_text(self, text, context):
135
"""Verify things like commit messages don't have bogus characters."""
137
raise ValueError('Invalid value for %s: %r' % (context, text))
139
def _validate_revprops(self, revprops):
140
for key, value in revprops.iteritems():
141
# We know that the XML serializers do not round trip '\r'
142
# correctly, so refuse to accept them
143
if not isinstance(value, basestring):
144
raise ValueError('revision property (%s) is not a valid'
145
' (unicode) string: %r' % (key, value))
146
self._validate_unicode_text(value,
147
'revision property (%s)' % (key,))
149
def commit(self, message):
150
"""Make the actual commit.
152
:return: The revision id of the recorded revision.
154
raise NotImplementedError(self.commit)
157
"""Abort the commit that is being built.
159
raise NotImplementedError(self.abort)
161
def revision_tree(self):
162
"""Return the tree that was just committed.
164
After calling commit() this can be called to get a
165
RevisionTree representing the newly committed tree. This is
166
preferred to calling Repository.revision_tree() because that may
167
require deserializing the inventory, while we already have a copy in
170
raise NotImplementedError(self.revision_tree)
172
def finish_inventory(self):
173
"""Tell the builder that the inventory is finished.
175
:return: The inventory id in the repository, which can be used with
176
repository.get_inventory.
178
raise NotImplementedError(self.finish_inventory)
180
def _gen_revision_id(self):
181
"""Return new revision-id."""
182
return generate_ids.gen_revision_id(self._committer, self._timestamp)
184
def _generate_revision_if_needed(self):
185
"""Create a revision id if None was supplied.
187
If the repository can not support user-specified revision ids
188
they should override this function and raise CannotSetRevisionId
189
if _new_revision_id is not None.
191
:raises: CannotSetRevisionId
193
if self._new_revision_id is None:
194
self._new_revision_id = self._gen_revision_id()
195
self.random_revid = True
197
self.random_revid = False
199
def will_record_deletes(self):
200
"""Tell the commit builder that deletes are being notified.
202
This enables the accumulation of an inventory delta; for the resulting
203
commit to be valid, deletes against the basis MUST be recorded via
204
builder.record_delete().
206
raise NotImplementedError(self.will_record_deletes)
208
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
209
"""Record a new tree via iter_changes.
211
:param tree: The tree to obtain text contents from for changed objects.
212
:param basis_revision_id: The revision id of the tree the iter_changes
213
has been generated against. Currently assumed to be the same
214
as self.parents[0] - if it is not, errors may occur.
215
:param iter_changes: An iter_changes iterator with the changes to apply
216
to basis_revision_id. The iterator must not include any items with
217
a current kind of None - missing items must be either filtered out
218
or errored-on beefore record_iter_changes sees the item.
219
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
222
raise NotImplementedError(self.record_iter_changes)
225
class RepositoryWriteLockResult(LogicalLockResult):
226
"""The result of write locking a repository.
228
:ivar repository_token: The token obtained from the underlying lock, or
230
:ivar unlock: A callable which will unlock the lock.
233
def __init__(self, unlock, repository_token):
234
LogicalLockResult.__init__(self, unlock)
235
self.repository_token = repository_token
238
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
242
######################################################################
246
class Repository(_RelockDebugMixin, controldir.ControlComponent):
247
"""Repository holding history for one or more branches.
249
The repository holds and retrieves historical information including
250
revisions and file history. It's normally accessed only by the Branch,
251
which views a particular line of development through that history.
253
See VersionedFileRepository in bzrlib.vf_repository for the
254
base class for most Bazaar repositories.
257
def abort_write_group(self, suppress_errors=False):
258
"""Commit the contents accrued within the current write group.
260
:param suppress_errors: if true, abort_write_group will catch and log
261
unexpected errors that happen during the abort, rather than
262
allowing them to propagate. Defaults to False.
264
:seealso: start_write_group.
266
if self._write_group is not self.get_transaction():
267
# has an unlock or relock occured ?
270
'(suppressed) mismatched lock context and write group. %r, %r',
271
self._write_group, self.get_transaction())
273
raise errors.BzrError(
274
'mismatched lock context and write group. %r, %r' %
275
(self._write_group, self.get_transaction()))
277
self._abort_write_group()
278
except Exception, exc:
279
self._write_group = None
280
if not suppress_errors:
282
mutter('abort_write_group failed')
283
log_exception_quietly()
284
note(gettext('bzr: ERROR (ignored): %s'), exc)
285
self._write_group = None
287
def _abort_write_group(self):
288
"""Template method for per-repository write group cleanup.
290
This is called during abort before the write group is considered to be
291
finished and should cleanup any internal state accrued during the write
292
group. There is no requirement that data handed to the repository be
293
*not* made available - this is not a rollback - but neither should any
294
attempt be made to ensure that data added is fully commited. Abort is
295
invoked when an error has occured so futher disk or network operations
296
may not be possible or may error and if possible should not be
300
def add_fallback_repository(self, repository):
301
"""Add a repository to use for looking up data not held locally.
303
:param repository: A repository.
305
raise NotImplementedError(self.add_fallback_repository)
307
def _check_fallback_repository(self, repository):
308
"""Check that this repository can fallback to repository safely.
310
Raise an error if not.
312
:param repository: A repository to fallback to.
314
return InterRepository._assert_same_model(self, repository)
316
def all_revision_ids(self):
317
"""Returns a list of all the revision ids in the repository.
319
This is conceptually deprecated because code should generally work on
320
the graph reachable from a particular revision, and ignore any other
321
revisions that might be present. There is no direct replacement
324
if 'evil' in debug.debug_flags:
325
mutter_callsite(2, "all_revision_ids is linear with history.")
326
return self._all_revision_ids()
328
def _all_revision_ids(self):
329
"""Returns a list of all the revision ids in the repository.
331
These are in as much topological order as the underlying store can
334
raise NotImplementedError(self._all_revision_ids)
336
def break_lock(self):
337
"""Break a lock if one is present from another instance.
339
Uses the ui factory to ask for confirmation if the lock may be from
342
self.control_files.break_lock()
345
def create(controldir):
346
"""Construct the current default format repository in controldir."""
347
return RepositoryFormat.get_default_format().initialize(controldir)
349
def __init__(self, _format, controldir, control_files):
350
"""instantiate a Repository.
352
:param _format: The format of the repository on disk.
353
:param controldir: The ControlDir of the repository.
354
:param control_files: Control files to use for locking, etc.
356
# In the future we will have a single api for all stores for
357
# getting file texts, inventories and revisions, then
358
# this construct will accept instances of those things.
359
super(Repository, self).__init__()
360
self._format = _format
361
# the following are part of the public API for Repository:
362
self.bzrdir = controldir
363
self.control_files = control_files
365
self._write_group = None
366
# Additional places to query for data.
367
self._fallback_repositories = []
370
def user_transport(self):
371
return self.bzrdir.user_transport
374
def control_transport(self):
375
return self._transport
378
if self._fallback_repositories:
379
return '%s(%r, fallback_repositories=%r)' % (
380
self.__class__.__name__,
382
self._fallback_repositories)
384
return '%s(%r)' % (self.__class__.__name__,
387
def _has_same_fallbacks(self, other_repo):
388
"""Returns true if the repositories have the same fallbacks."""
389
my_fb = self._fallback_repositories
390
other_fb = other_repo._fallback_repositories
391
if len(my_fb) != len(other_fb):
393
for f, g in zip(my_fb, other_fb):
394
if not f.has_same_location(g):
398
def has_same_location(self, other):
399
"""Returns a boolean indicating if this repository is at the same
400
location as another repository.
402
This might return False even when two repository objects are accessing
403
the same physical repository via different URLs.
405
if self.__class__ is not other.__class__:
407
return (self.control_url == other.control_url)
409
def is_in_write_group(self):
410
"""Return True if there is an open write group.
412
:seealso: start_write_group.
414
return self._write_group is not None
417
return self.control_files.is_locked()
419
def is_write_locked(self):
420
"""Return True if this object is write locked."""
421
return self.is_locked() and self.control_files._lock_mode == 'w'
423
def lock_write(self, token=None):
424
"""Lock this repository for writing.
426
This causes caching within the repository obejct to start accumlating
427
data during reads, and allows a 'write_group' to be obtained. Write
428
groups must be used for actual data insertion.
430
A token should be passed in if you know that you have locked the object
431
some other way, and need to synchronise this object's state with that
434
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
436
:param token: if this is already locked, then lock_write will fail
437
unless the token matches the existing lock.
438
:returns: a token if this instance supports tokens, otherwise None.
439
:raises TokenLockingNotSupported: when a token is given but this
440
instance doesn't support using token locks.
441
:raises MismatchedToken: if the specified token doesn't match the token
442
of the existing lock.
443
:seealso: start_write_group.
444
:return: A RepositoryWriteLockResult.
446
locked = self.is_locked()
447
token = self.control_files.lock_write(token=token)
449
self._warn_if_deprecated()
451
for repo in self._fallback_repositories:
452
# Writes don't affect fallback repos
455
return RepositoryWriteLockResult(self.unlock, token)
458
"""Lock the repository for read operations.
460
:return: An object with an unlock method which will release the lock
463
locked = self.is_locked()
464
self.control_files.lock_read()
466
self._warn_if_deprecated()
468
for repo in self._fallback_repositories:
471
return LogicalLockResult(self.unlock)
473
def get_physical_lock_status(self):
474
return self.control_files.get_physical_lock_status()
476
def leave_lock_in_place(self):
477
"""Tell this repository not to release the physical lock when this
480
If lock_write doesn't return a token, then this method is not supported.
482
self.control_files.leave_in_place()
484
def dont_leave_lock_in_place(self):
485
"""Tell this repository to release the physical lock when this
486
object is unlocked, even if it didn't originally acquire it.
488
If lock_write doesn't return a token, then this method is not supported.
490
self.control_files.dont_leave_in_place()
493
def gather_stats(self, revid=None, committers=None):
494
"""Gather statistics from a revision id.
496
:param revid: The revision id to gather statistics from, if None, then
497
no revision specific statistics are gathered.
498
:param committers: Optional parameter controlling whether to grab
499
a count of committers from the revision specific statistics.
500
:return: A dictionary of statistics. Currently this contains:
501
committers: The number of committers if requested.
502
firstrev: A tuple with timestamp, timezone for the penultimate left
503
most ancestor of revid, if revid is not the NULL_REVISION.
504
latestrev: A tuple with timestamp, timezone for revid, if revid is
505
not the NULL_REVISION.
506
revisions: The total revision count in the repository.
507
size: An estimate disk size of the repository in bytes.
510
if revid and committers:
511
result['committers'] = 0
512
if revid and revid != _mod_revision.NULL_REVISION:
513
graph = self.get_graph()
515
all_committers = set()
516
revisions = [r for (r, p) in graph.iter_ancestry([revid])
517
if r != _mod_revision.NULL_REVISION]
520
# ignore the revisions in the middle - just grab first and last
521
revisions = revisions[0], revisions[-1]
522
for revision in self.get_revisions(revisions):
523
if not last_revision:
524
last_revision = revision
526
all_committers.add(revision.committer)
527
first_revision = revision
529
result['committers'] = len(all_committers)
530
result['firstrev'] = (first_revision.timestamp,
531
first_revision.timezone)
532
result['latestrev'] = (last_revision.timestamp,
533
last_revision.timezone)
536
def find_branches(self, using=False):
537
"""Find branches underneath this repository.
539
This will include branches inside other branches.
541
:param using: If True, list only branches using this repository.
543
if using and not self.is_shared():
544
return self.bzrdir.list_branches()
545
class Evaluator(object):
548
self.first_call = True
550
def __call__(self, controldir):
551
# On the first call, the parameter is always the controldir
552
# containing the current repo.
553
if not self.first_call:
555
repository = controldir.open_repository()
556
except errors.NoRepositoryPresent:
559
return False, ([], repository)
560
self.first_call = False
561
value = (controldir.list_branches(), None)
565
for branches, repository in controldir.ControlDir.find_bzrdirs(
566
self.user_transport, evaluate=Evaluator()):
567
if branches is not None:
569
if not using and repository is not None:
570
ret.extend(repository.find_branches())
574
def search_missing_revision_ids(self, other,
575
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
576
find_ghosts=True, revision_ids=None, if_present_ids=None,
578
"""Return the revision ids that other has that this does not.
580
These are returned in topological order.
582
revision_id: only return revision ids included by revision_id.
584
if symbol_versioning.deprecated_passed(revision_id):
585
symbol_versioning.warn(
586
'search_missing_revision_ids(revision_id=...) was '
587
'deprecated in 2.4. Use revision_ids=[...] instead.',
588
DeprecationWarning, stacklevel=3)
589
if revision_ids is not None:
590
raise AssertionError(
591
'revision_ids is mutually exclusive with revision_id')
592
if revision_id is not None:
593
revision_ids = [revision_id]
594
return InterRepository.get(other, self).search_missing_revision_ids(
595
find_ghosts=find_ghosts, revision_ids=revision_ids,
596
if_present_ids=if_present_ids, limit=limit)
600
"""Open the repository rooted at base.
602
For instance, if the repository is at URL/.bzr/repository,
603
Repository.open(URL) -> a Repository instance.
605
control = controldir.ControlDir.open(base)
606
return control.open_repository()
608
def copy_content_into(self, destination, revision_id=None):
609
"""Make a complete copy of the content in self into destination.
611
This is a destructive operation! Do not use it on existing
614
return InterRepository.get(self, destination).copy_content(revision_id)
616
def commit_write_group(self):
617
"""Commit the contents accrued within the current write group.
619
:seealso: start_write_group.
621
:return: it may return an opaque hint that can be passed to 'pack'.
623
if self._write_group is not self.get_transaction():
624
# has an unlock or relock occured ?
625
raise errors.BzrError('mismatched lock context %r and '
627
(self.get_transaction(), self._write_group))
628
result = self._commit_write_group()
629
self._write_group = None
632
def _commit_write_group(self):
633
"""Template method for per-repository write group cleanup.
635
This is called before the write group is considered to be
636
finished and should ensure that all data handed to the repository
637
for writing during the write group is safely committed (to the
638
extent possible considering file system caching etc).
641
def suspend_write_group(self):
642
raise errors.UnsuspendableWriteGroup(self)
644
def refresh_data(self):
645
"""Re-read any data needed to synchronise with disk.
647
This method is intended to be called after another repository instance
648
(such as one used by a smart server) has inserted data into the
649
repository. On all repositories this will work outside of write groups.
650
Some repository formats (pack and newer for bzrlib native formats)
651
support refresh_data inside write groups. If called inside a write
652
group on a repository that does not support refreshing in a write group
653
IsInWriteGroupError will be raised.
657
def resume_write_group(self, tokens):
658
if not self.is_write_locked():
659
raise errors.NotWriteLocked(self)
660
if self._write_group:
661
raise errors.BzrError('already in a write group')
662
self._resume_write_group(tokens)
663
# so we can detect unlock/relock - the write group is now entered.
664
self._write_group = self.get_transaction()
666
def _resume_write_group(self, tokens):
667
raise errors.UnsuspendableWriteGroup(self)
669
def fetch(self, source, revision_id=None, find_ghosts=False,
671
"""Fetch the content required to construct revision_id from source.
673
If revision_id is None and fetch_spec is None, then all content is
676
fetch() may not be used when the repository is in a write group -
677
either finish the current write group before using fetch, or use
678
fetch before starting the write group.
680
:param find_ghosts: Find and copy revisions in the source that are
681
ghosts in the target (and not reachable directly by walking out to
682
the first-present revision in target from revision_id).
683
:param revision_id: If specified, all the content needed for this
684
revision ID will be copied to the target. Fetch will determine for
685
itself which content needs to be copied.
686
:param fetch_spec: If specified, a SearchResult or
687
PendingAncestryResult that describes which revisions to copy. This
688
allows copying multiple heads at once. Mutually exclusive with
691
if fetch_spec is not None and revision_id is not None:
692
raise AssertionError(
693
"fetch_spec and revision_id are mutually exclusive.")
694
if self.is_in_write_group():
695
raise errors.InternalBzrError(
696
"May not fetch while in a write group.")
697
# fast path same-url fetch operations
698
# TODO: lift out to somewhere common with RemoteRepository
699
# <https://bugs.launchpad.net/bzr/+bug/401646>
700
if (self.has_same_location(source)
701
and fetch_spec is None
702
and self._has_same_fallbacks(source)):
703
# check that last_revision is in 'from' and then return a
705
if (revision_id is not None and
706
not _mod_revision.is_null(revision_id)):
707
self.get_revision(revision_id)
709
inter = InterRepository.get(source, self)
710
return inter.fetch(revision_id=revision_id,
711
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
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, 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: Configuration 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)
1152
def revision_ids_to_search_result(self, result_set):
1153
"""Convert a set of revision ids to a graph SearchResult."""
1154
result_parents = set()
1155
for parents in self.get_graph().get_parent_map(
1156
result_set).itervalues():
1157
result_parents.update(parents)
1158
included_keys = result_set.intersection(result_parents)
1159
start_keys = result_set.difference(included_keys)
1160
exclude_keys = result_parents.difference(result_set)
1161
result = graph.SearchResult(start_keys, exclude_keys,
1162
len(result_set), result_set)
1166
def set_make_working_trees(self, new_value):
1167
"""Set the policy flag for making working trees when creating branches.
1169
This only applies to branches that use this repository.
1171
The default is 'True'.
1172
:param new_value: True to restore the default, False to disable making
1175
raise NotImplementedError(self.set_make_working_trees)
1177
def make_working_trees(self):
1178
"""Returns the policy for making working trees on new branches."""
1179
raise NotImplementedError(self.make_working_trees)
1182
def sign_revision(self, revision_id, gpg_strategy):
1183
testament = _mod_testament.Testament.from_revision(self, revision_id)
1184
plaintext = testament.as_short_text()
1185
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1188
def verify_revision(self, revision_id, gpg_strategy):
1189
"""Verify the signature on a revision.
1191
:param revision_id: the revision to verify
1192
:gpg_strategy: the GPGStrategy object to used
1194
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1196
if not self.has_signature_for_revision_id(revision_id):
1197
return gpg.SIGNATURE_NOT_SIGNED, None
1198
signature = self.get_signature_text(revision_id)
1200
testament = _mod_testament.Testament.from_revision(self, revision_id)
1201
plaintext = testament.as_short_text()
1203
return gpg_strategy.verify(signature, plaintext)
1205
def has_signature_for_revision_id(self, revision_id):
1206
"""Query for a revision signature for revision_id in the repository."""
1207
raise NotImplementedError(self.has_signature_for_revision_id)
1209
def get_signature_text(self, revision_id):
1210
"""Return the text for a signature."""
1211
raise NotImplementedError(self.get_signature_text)
1213
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1214
"""Check consistency of all history of given revision_ids.
1216
Different repository implementations should override _check().
1218
:param revision_ids: A non-empty list of revision_ids whose ancestry
1219
will be checked. Typically the last revision_id of a branch.
1220
:param callback_refs: A dict of check-refs to resolve and callback
1221
the check/_check method on the items listed as wanting the ref.
1223
:param check_repo: If False do not check the repository contents, just
1224
calculate the data callback_refs requires and call them back.
1226
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1227
check_repo=check_repo)
1229
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1230
raise NotImplementedError(self.check)
1232
def _warn_if_deprecated(self, branch=None):
1233
if not self._format.is_deprecated():
1235
global _deprecation_warning_done
1236
if _deprecation_warning_done:
1240
conf = config.GlobalConfig()
1242
conf = branch.get_config()
1243
if conf.suppress_warning('format_deprecation'):
1245
warning("Format %s for %s is deprecated -"
1246
" please use 'bzr upgrade' to get better performance"
1247
% (self._format, self.bzrdir.transport.base))
1249
_deprecation_warning_done = True
1251
def supports_rich_root(self):
1252
return self._format.rich_root_data
1254
def _check_ascii_revisionid(self, revision_id, method):
1255
"""Private helper for ascii-only repositories."""
1256
# weave repositories refuse to store revisionids that are non-ascii.
1257
if revision_id is not None:
1258
# weaves require ascii revision ids.
1259
if isinstance(revision_id, unicode):
1261
revision_id.encode('ascii')
1262
except UnicodeEncodeError:
1263
raise errors.NonAsciiRevisionId(method, self)
1266
revision_id.decode('ascii')
1267
except UnicodeDecodeError:
1268
raise errors.NonAsciiRevisionId(method, self)
1271
class MetaDirRepository(Repository):
1272
"""Repositories in the new meta-dir layout.
1274
:ivar _transport: Transport for access to repository control files,
1275
typically pointing to .bzr/repository.
1278
def __init__(self, _format, a_bzrdir, control_files):
1279
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1280
self._transport = control_files._transport
1282
def is_shared(self):
1283
"""Return True if this repository is flagged as a shared repository."""
1284
return self._transport.has('shared-storage')
1287
def set_make_working_trees(self, new_value):
1288
"""Set the policy flag for making working trees when creating branches.
1290
This only applies to branches that use this repository.
1292
The default is 'True'.
1293
:param new_value: True to restore the default, False to disable making
1298
self._transport.delete('no-working-trees')
1299
except errors.NoSuchFile:
1302
self._transport.put_bytes('no-working-trees', '',
1303
mode=self.bzrdir._get_file_mode())
1305
def make_working_trees(self):
1306
"""Returns the policy for making working trees on new branches."""
1307
return not self._transport.has('no-working-trees')
1310
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1311
"""Repository format registry."""
1313
def get_default(self):
1314
"""Return the current default format."""
1315
return controldir.format_registry.make_bzrdir('default').repository_format
1318
network_format_registry = registry.FormatRegistry()
1319
"""Registry of formats indexed by their network name.
1321
The network name for a repository format is an identifier that can be used when
1322
referring to formats with smart server operations. See
1323
RepositoryFormat.network_name() for more detail.
1327
format_registry = RepositoryFormatRegistry(network_format_registry)
1328
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1330
This can contain either format instances themselves, or classes/factories that
1331
can be called to obtain one.
1335
#####################################################################
1336
# Repository Formats
1338
class RepositoryFormat(controldir.ControlComponentFormat):
1339
"""A repository format.
1341
Formats provide four things:
1342
* An initialization routine to construct repository data on disk.
1343
* a optional format string which is used when the BzrDir supports
1345
* an open routine which returns a Repository instance.
1346
* A network name for referring to the format in smart server RPC
1349
There is one and only one Format subclass for each on-disk format. But
1350
there can be one Repository subclass that is used for several different
1351
formats. The _format attribute on a Repository instance can be used to
1352
determine the disk format.
1354
Formats are placed in a registry by their format string for reference
1355
during opening. These should be subclasses of RepositoryFormat for
1358
Once a format is deprecated, just deprecate the initialize and open
1359
methods on the format class. Do not deprecate the object, as the
1360
object may be created even when a repository instance hasn't been
1363
Common instance attributes:
1364
_matchingbzrdir - the controldir format that the repository format was
1365
originally written to work with. This can be used if manually
1366
constructing a bzrdir and repository, or more commonly for test suite
1370
# Set to True or False in derived classes. True indicates that the format
1371
# supports ghosts gracefully.
1372
supports_ghosts = None
1373
# Can this repository be given external locations to lookup additional
1374
# data. Set to True or False in derived classes.
1375
supports_external_lookups = None
1376
# Does this format support CHK bytestring lookups. Set to True or False in
1378
supports_chks = None
1379
# Should fetch trigger a reconcile after the fetch? Only needed for
1380
# some repository formats that can suffer internal inconsistencies.
1381
_fetch_reconcile = False
1382
# Does this format have < O(tree_size) delta generation. Used to hint what
1383
# code path for commit, amongst other things.
1385
# Does doing a pack operation compress data? Useful for the pack UI command
1386
# (so if there is one pack, the operation can still proceed because it may
1387
# help), and for fetching when data won't have come from the same
1389
pack_compresses = False
1390
# Does the repository storage understand references to trees?
1391
supports_tree_reference = None
1392
# Is the format experimental ?
1393
experimental = False
1394
# Does this repository format escape funky characters, or does it create
1395
# files with similar names as the versioned files in its contents on disk
1397
supports_funky_characters = None
1398
# Does this repository format support leaving locks?
1399
supports_leaving_lock = None
1400
# Does this format support the full VersionedFiles interface?
1401
supports_full_versioned_files = None
1402
# Does this format support signing revision signatures?
1403
supports_revision_signatures = True
1404
# Can the revision graph have incorrect parents?
1405
revision_graph_can_have_wrong_parents = None
1406
# Does this format support rich root data?
1407
rich_root_data = None
1408
# Does this format support explicitly versioned directories?
1409
supports_versioned_directories = None
1410
# Can other repositories be nested into one of this format?
1411
supports_nesting_repositories = None
1412
# Is it possible for revisions to be present without being referenced
1414
supports_unreferenced_revisions = None
1417
return "%s()" % self.__class__.__name__
1419
def __eq__(self, other):
1420
# format objects are generally stateless
1421
return isinstance(other, self.__class__)
1423
def __ne__(self, other):
1424
return not self == other
1427
def find_format(klass, a_bzrdir):
1428
"""Return the format for the repository object in a_bzrdir.
1430
This is used by bzr native formats that have a "format" file in
1431
the repository. Other methods may be used by different types of
1435
transport = a_bzrdir.get_repository_transport(None)
1436
format_string = transport.get_bytes("format")
1437
return format_registry.get(format_string)
1438
except errors.NoSuchFile:
1439
raise errors.NoRepositoryPresent(a_bzrdir)
1441
raise errors.UnknownFormatError(format=format_string,
1445
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1446
def register_format(klass, format):
1447
format_registry.register(format)
1450
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1451
def unregister_format(klass, format):
1452
format_registry.remove(format)
1455
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1456
def get_default_format(klass):
1457
"""Return the current default format."""
1458
return format_registry.get_default()
1460
def get_format_string(self):
1461
"""Return the ASCII format string that identifies this format.
1463
Note that in pre format ?? repositories the format string is
1464
not permitted nor written to disk.
1466
raise NotImplementedError(self.get_format_string)
1468
def get_format_description(self):
1469
"""Return the short description for this format."""
1470
raise NotImplementedError(self.get_format_description)
1472
def initialize(self, controldir, shared=False):
1473
"""Initialize a repository of this format in controldir.
1475
:param controldir: The controldir to put the new repository in it.
1476
:param shared: The repository should be initialized as a sharable one.
1477
:returns: The new repository object.
1479
This may raise UninitializableFormat if shared repository are not
1480
compatible the controldir.
1482
raise NotImplementedError(self.initialize)
1484
def is_supported(self):
1485
"""Is this format supported?
1487
Supported formats must be initializable and openable.
1488
Unsupported formats may not support initialization or committing or
1489
some other features depending on the reason for not being supported.
1493
def is_deprecated(self):
1494
"""Is this format deprecated?
1496
Deprecated formats may trigger a user-visible warning recommending
1497
the user to upgrade. They are still fully supported.
1501
def network_name(self):
1502
"""A simple byte string uniquely identifying this format for RPC calls.
1504
MetaDir repository formats use their disk format string to identify the
1505
repository over the wire. All in one formats such as bzr < 0.8, and
1506
foreign formats like svn/git and hg should use some marker which is
1507
unique and immutable.
1509
raise NotImplementedError(self.network_name)
1511
def check_conversion_target(self, target_format):
1512
if self.rich_root_data and not target_format.rich_root_data:
1513
raise errors.BadConversionTarget(
1514
'Does not support rich root data.', target_format,
1516
if (self.supports_tree_reference and
1517
not getattr(target_format, 'supports_tree_reference', False)):
1518
raise errors.BadConversionTarget(
1519
'Does not support nested trees', target_format,
1522
def open(self, controldir, _found=False):
1523
"""Return an instance of this format for a controldir.
1525
_found is a private parameter, do not use it.
1527
raise NotImplementedError(self.open)
1529
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1530
from bzrlib.controldir import ControlDir, RepoInitHookParams
1531
hooks = ControlDir.hooks['post_repo_init']
1534
params = RepoInitHookParams(repository, self, controldir, shared)
1539
class MetaDirRepositoryFormat(RepositoryFormat):
1540
"""Common base class for the new repositories using the metadir layout."""
1542
rich_root_data = False
1543
supports_tree_reference = False
1544
supports_external_lookups = False
1545
supports_leaving_lock = True
1546
supports_nesting_repositories = True
1549
def _matchingbzrdir(self):
1550
matching = bzrdir.BzrDirMetaFormat1()
1551
matching.repository_format = self
1555
super(MetaDirRepositoryFormat, self).__init__()
1557
def _create_control_files(self, a_bzrdir):
1558
"""Create the required files and the initial control_files object."""
1559
# FIXME: RBC 20060125 don't peek under the covers
1560
# NB: no need to escape relative paths that are url safe.
1561
repository_transport = a_bzrdir.get_repository_transport(self)
1562
control_files = lockable_files.LockableFiles(repository_transport,
1563
'lock', lockdir.LockDir)
1564
control_files.create_lock()
1565
return control_files
1567
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1568
"""Upload the initial blank content."""
1569
control_files = self._create_control_files(a_bzrdir)
1570
control_files.lock_write()
1571
transport = control_files._transport
1573
utf8_files += [('shared-storage', '')]
1575
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1576
for (filename, content_stream) in files:
1577
transport.put_file(filename, content_stream,
1578
mode=a_bzrdir._get_file_mode())
1579
for (filename, content_bytes) in utf8_files:
1580
transport.put_bytes_non_atomic(filename, content_bytes,
1581
mode=a_bzrdir._get_file_mode())
1583
control_files.unlock()
1585
def network_name(self):
1586
"""Metadir formats have matching disk and network format strings."""
1587
return self.get_format_string()
1590
# formats which have no format string are not discoverable or independently
1591
# creatable on disk, so are not registered in format_registry. They're
1592
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1593
# needed, it's constructed directly by the ControlDir. Non-native formats where
1594
# the repository is not separately opened are similar.
1596
format_registry.register_lazy(
1597
'Bazaar-NG Knit Repository Format 1',
1598
'bzrlib.repofmt.knitrepo',
1599
'RepositoryFormatKnit1',
1602
format_registry.register_lazy(
1603
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1604
'bzrlib.repofmt.knitrepo',
1605
'RepositoryFormatKnit3',
1608
format_registry.register_lazy(
1609
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1610
'bzrlib.repofmt.knitrepo',
1611
'RepositoryFormatKnit4',
1614
# Pack-based formats. There is one format for pre-subtrees, and one for
1615
# post-subtrees to allow ease of testing.
1616
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1617
format_registry.register_lazy(
1618
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1619
'bzrlib.repofmt.knitpack_repo',
1620
'RepositoryFormatKnitPack1',
1622
format_registry.register_lazy(
1623
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1624
'bzrlib.repofmt.knitpack_repo',
1625
'RepositoryFormatKnitPack3',
1627
format_registry.register_lazy(
1628
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1629
'bzrlib.repofmt.knitpack_repo',
1630
'RepositoryFormatKnitPack4',
1632
format_registry.register_lazy(
1633
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1634
'bzrlib.repofmt.knitpack_repo',
1635
'RepositoryFormatKnitPack5',
1637
format_registry.register_lazy(
1638
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1639
'bzrlib.repofmt.knitpack_repo',
1640
'RepositoryFormatKnitPack5RichRoot',
1642
format_registry.register_lazy(
1643
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1644
'bzrlib.repofmt.knitpack_repo',
1645
'RepositoryFormatKnitPack5RichRootBroken',
1647
format_registry.register_lazy(
1648
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1649
'bzrlib.repofmt.knitpack_repo',
1650
'RepositoryFormatKnitPack6',
1652
format_registry.register_lazy(
1653
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1654
'bzrlib.repofmt.knitpack_repo',
1655
'RepositoryFormatKnitPack6RichRoot',
1657
format_registry.register_lazy(
1658
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1659
'bzrlib.repofmt.groupcompress_repo',
1660
'RepositoryFormat2a',
1663
# Development formats.
1664
# Check their docstrings to see if/when they are obsolete.
1665
format_registry.register_lazy(
1666
("Bazaar development format 2 with subtree support "
1667
"(needs bzr.dev from before 1.8)\n"),
1668
'bzrlib.repofmt.knitpack_repo',
1669
'RepositoryFormatPackDevelopment2Subtree',
1671
format_registry.register_lazy(
1672
'Bazaar development format 8\n',
1673
'bzrlib.repofmt.groupcompress_repo',
1674
'RepositoryFormat2aSubtree',
1678
class InterRepository(InterObject):
1679
"""This class represents operations taking place between two repositories.
1681
Its instances have methods like copy_content and fetch, and contain
1682
references to the source and target repositories these operations can be
1685
Often we will provide convenience methods on 'repository' which carry out
1686
operations with another repository - they will always forward to
1687
InterRepository.get(other).method_name(parameters).
1691
"""The available optimised InterRepository types."""
1694
def copy_content(self, revision_id=None):
1695
"""Make a complete copy of the content in self into destination.
1697
This is a destructive operation! Do not use it on existing
1700
:param revision_id: Only copy the content needed to construct
1701
revision_id and its parents.
1704
self.target.set_make_working_trees(self.source.make_working_trees())
1705
except NotImplementedError:
1707
self.target.fetch(self.source, revision_id=revision_id)
1710
def fetch(self, revision_id=None, find_ghosts=False,
1712
"""Fetch the content required to construct revision_id.
1714
The content is copied from self.source to self.target.
1716
:param revision_id: if None all content is copied, if NULL_REVISION no
1720
raise NotImplementedError(self.fetch)
1723
def search_missing_revision_ids(self,
1724
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1725
find_ghosts=True, revision_ids=None, if_present_ids=None,
1727
"""Return the revision ids that source has that target does not.
1729
:param revision_id: only return revision ids included by this
1731
:param revision_ids: return revision ids included by these
1732
revision_ids. NoSuchRevision will be raised if any of these
1733
revisions are not present.
1734
:param if_present_ids: like revision_ids, but will not cause
1735
NoSuchRevision if any of these are absent, instead they will simply
1736
not be in the result. This is useful for e.g. finding revisions
1737
to fetch for tags, which may reference absent revisions.
1738
:param find_ghosts: If True find missing revisions in deep history
1739
rather than just finding the surface difference.
1740
:param limit: Maximum number of revisions to return, topologically
1742
:return: A bzrlib.graph.SearchResult.
1744
raise NotImplementedError(self.search_missing_revision_ids)
1747
def _same_model(source, target):
1748
"""True if source and target have the same data representation.
1750
Note: this is always called on the base class; overriding it in a
1751
subclass will have no effect.
1754
InterRepository._assert_same_model(source, target)
1756
except errors.IncompatibleRepositories, e:
1760
def _assert_same_model(source, target):
1761
"""Raise an exception if two repositories do not use the same model.
1763
if source.supports_rich_root() != target.supports_rich_root():
1764
raise errors.IncompatibleRepositories(source, target,
1765
"different rich-root support")
1766
if source._serializer != target._serializer:
1767
raise errors.IncompatibleRepositories(source, target,
1768
"different serializers")
1771
class CopyConverter(object):
1772
"""A repository conversion tool which just performs a copy of the content.
1774
This is slow but quite reliable.
1777
def __init__(self, target_format):
1778
"""Create a CopyConverter.
1780
:param target_format: The format the resulting repository should be.
1782
self.target_format = target_format
1784
def convert(self, repo, pb):
1785
"""Perform the conversion of to_convert, giving feedback via pb.
1787
:param to_convert: The disk object to convert.
1788
:param pb: a progress bar to use for progress information.
1790
pb = ui.ui_factory.nested_progress_bar()
1793
# this is only useful with metadir layouts - separated repo content.
1794
# trigger an assertion if not such
1795
repo._format.get_format_string()
1796
self.repo_dir = repo.bzrdir
1797
pb.update(gettext('Moving repository to repository.backup'))
1798
self.repo_dir.transport.move('repository', 'repository.backup')
1799
backup_transport = self.repo_dir.transport.clone('repository.backup')
1800
repo._format.check_conversion_target(self.target_format)
1801
self.source_repo = repo._format.open(self.repo_dir,
1803
_override_transport=backup_transport)
1804
pb.update(gettext('Creating new repository'))
1805
converted = self.target_format.initialize(self.repo_dir,
1806
self.source_repo.is_shared())
1807
converted.lock_write()
1809
pb.update(gettext('Copying content'))
1810
self.source_repo.copy_content_into(converted)
1813
pb.update(gettext('Deleting old repository content'))
1814
self.repo_dir.transport.delete_tree('repository.backup')
1815
ui.ui_factory.note(gettext('repository converted'))
1819
def _strip_NULL_ghosts(revision_graph):
1820
"""Also don't use this. more compatibility code for unmigrated clients."""
1821
# Filter ghosts, and null:
1822
if _mod_revision.NULL_REVISION in revision_graph:
1823
del revision_graph[_mod_revision.NULL_REVISION]
1824
for key, parents in revision_graph.items():
1825
revision_graph[key] = tuple(parent for parent in parents if parent
1827
return revision_graph
1830
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1831
stop_revision=None):
1832
"""Extend the partial history to include a given index
1834
If a stop_index is supplied, stop when that index has been reached.
1835
If a stop_revision is supplied, stop when that revision is
1836
encountered. Otherwise, stop when the beginning of history is
1839
:param stop_index: The index which should be present. When it is
1840
present, history extension will stop.
1841
:param stop_revision: The revision id which should be present. When
1842
it is encountered, history extension will stop.
1844
start_revision = partial_history_cache[-1]
1845
graph = repo.get_graph()
1846
iterator = graph.iter_lefthand_ancestry(start_revision,
1847
(_mod_revision.NULL_REVISION,))
1849
# skip the last revision in the list
1852
if (stop_index is not None and
1853
len(partial_history_cache) > stop_index):
1855
if partial_history_cache[-1] == stop_revision:
1857
revision_id = iterator.next()
1858
partial_history_cache.append(revision_id)
1859
except StopIteration:
1864
class _LazyListJoin(object):
1865
"""An iterable yielding the contents of many lists as one list.
1867
Each iterator made from this will reflect the current contents of the lists
1868
at the time the iterator is made.
1870
This is used by Repository's _make_parents_provider implementation so that
1873
pp = repo._make_parents_provider() # uses a list of fallback repos
1874
pp.add_fallback_repository(other_repo) # appends to that list
1875
result = pp.get_parent_map(...)
1876
# The result will include revs from other_repo
1879
def __init__(self, *list_parts):
1880
self.list_parts = list_parts
1884
for list_part in self.list_parts:
1885
full_list.extend(list_part)
1886
return iter(full_list)
1889
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
added
removed
bzrlib/repository.py
