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(a_bzrdir):
346
"""Construct the current default format repository in a_bzrdir."""
347
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
349
def __init__(self, _format, a_bzrdir, control_files):
350
"""instantiate a Repository.
352
:param _format: The format of the repository on disk.
353
:param a_bzrdir: The BzrDir 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 = a_bzrdir
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, bzrdir):
551
# On the first call, the parameter is always the bzrdir
552
# containing the current repo.
553
if not self.first_call:
555
repository = bzrdir.open_repository()
556
except errors.NoRepositoryPresent:
559
return False, ([], repository)
560
self.first_call = False
561
value = (bzrdir.list_branches(), None)
565
for branches, repository in bzrdir.BzrDir.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 = bzrdir.BzrDir.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, a_bzrdir, revision_id=None):
750
"""Clone this repository into a_bzrdir 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(a_bzrdir, shared=self.is_shared())
760
self.copy_content_into(dest_repo, revision_id)
763
def start_write_group(self):
764
"""Start a write group in the repository.
766
Write groups are used by repositories which do not have a 1:1 mapping
767
between file ids and backend store to manage the insertion of data from
768
both fetch and commit operations.
770
A write lock is required around the start_write_group/commit_write_group
771
for the support of lock-requiring repository formats.
773
One can only insert data into a repository inside a write group.
777
if not self.is_write_locked():
778
raise errors.NotWriteLocked(self)
779
if self._write_group:
780
raise errors.BzrError('already in a write group')
781
self._start_write_group()
782
# so we can detect unlock/relock - the write group is now entered.
783
self._write_group = self.get_transaction()
785
def _start_write_group(self):
786
"""Template method for per-repository write group startup.
788
This is called before the write group is considered to be
793
def sprout(self, to_bzrdir, revision_id=None):
794
"""Create a descendent repository for new development.
796
Unlike clone, this does not copy the settings of the repository.
798
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
799
dest_repo.fetch(self, revision_id=revision_id)
802
def _create_sprouting_repo(self, a_bzrdir, shared):
803
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
804
# use target default format.
805
dest_repo = a_bzrdir.create_repository()
807
# Most control formats need the repository to be specifically
808
# created, but on some old all-in-one formats it's not needed
810
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
811
except errors.UninitializableFormat:
812
dest_repo = a_bzrdir.open_repository()
816
def has_revision(self, revision_id):
817
"""True if this repository has a copy of the revision."""
818
return revision_id in self.has_revisions((revision_id,))
821
def has_revisions(self, revision_ids):
822
"""Probe to find out the presence of multiple revisions.
824
:param revision_ids: An iterable of revision_ids.
825
:return: A set of the revision_ids that were present.
827
raise NotImplementedError(self.has_revisions)
830
def get_revision(self, revision_id):
831
"""Return the Revision object for a named revision."""
832
return self.get_revisions([revision_id])[0]
834
def get_revision_reconcile(self, revision_id):
835
"""'reconcile' helper routine that allows access to a revision always.
837
This variant of get_revision does not cross check the weave graph
838
against the revision one as get_revision does: but it should only
839
be used by reconcile, or reconcile-alike commands that are correcting
840
or testing the revision graph.
842
raise NotImplementedError(self.get_revision_reconcile)
844
def get_revisions(self, revision_ids):
845
"""Get many revisions at once.
847
Repositories that need to check data on every revision read should
848
subclass this method.
850
raise NotImplementedError(self.get_revisions)
852
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
853
"""Produce a generator of revision deltas.
855
Note that the input is a sequence of REVISIONS, not revision_ids.
856
Trees will be held in memory until the generator exits.
857
Each delta is relative to the revision's lefthand predecessor.
859
:param specific_fileids: if not None, the result is filtered
860
so that only those file-ids, their parents and their
861
children are included.
863
# Get the revision-ids of interest
864
required_trees = set()
865
for revision in revisions:
866
required_trees.add(revision.revision_id)
867
required_trees.update(revision.parent_ids[:1])
869
# Get the matching filtered trees. Note that it's more
870
# efficient to pass filtered trees to changes_from() rather
871
# than doing the filtering afterwards. changes_from() could
872
# arguably do the filtering itself but it's path-based, not
873
# file-id based, so filtering before or afterwards is
875
if specific_fileids is None:
876
trees = dict((t.get_revision_id(), t) for
877
t in self.revision_trees(required_trees))
879
trees = dict((t.get_revision_id(), t) for
880
t in self._filtered_revision_trees(required_trees,
883
# Calculate the deltas
884
for revision in revisions:
885
if not revision.parent_ids:
886
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
888
old_tree = trees[revision.parent_ids[0]]
889
yield trees[revision.revision_id].changes_from(old_tree)
892
def get_revision_delta(self, revision_id, specific_fileids=None):
893
"""Return the delta for one revision.
895
The delta is relative to the left-hand predecessor of the
898
:param specific_fileids: if not None, the result is filtered
899
so that only those file-ids, their parents and their
900
children are included.
902
r = self.get_revision(revision_id)
903
return list(self.get_deltas_for_revisions([r],
904
specific_fileids=specific_fileids))[0]
907
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
908
signature = gpg_strategy.sign(plaintext)
909
self.add_signature_text(revision_id, signature)
911
def add_signature_text(self, revision_id, signature):
912
"""Store a signature text for a revision.
914
:param revision_id: Revision id of the revision
915
:param signature: Signature text.
917
raise NotImplementedError(self.add_signature_text)
919
def _find_parent_ids_of_revisions(self, revision_ids):
920
"""Find all parent ids that are mentioned in the revision graph.
922
:return: set of revisions that are parents of revision_ids which are
923
not part of revision_ids themselves
925
parent_map = self.get_parent_map(revision_ids)
927
map(parent_ids.update, parent_map.itervalues())
928
parent_ids.difference_update(revision_ids)
929
parent_ids.discard(_mod_revision.NULL_REVISION)
932
def fileids_altered_by_revision_ids(self, revision_ids):
933
"""Find the file ids and versions affected by revisions.
935
:param revisions: an iterable containing revision ids.
936
:return: a dictionary mapping altered file-ids to an iterable of
937
revision_ids. Each altered file-ids has the exact revision_ids
938
that altered it listed explicitly.
940
raise NotImplementedError(self.fileids_altered_by_revision_ids)
942
def iter_files_bytes(self, desired_files):
943
"""Iterate through file versions.
945
Files will not necessarily be returned in the order they occur in
946
desired_files. No specific order is guaranteed.
948
Yields pairs of identifier, bytes_iterator. identifier is an opaque
949
value supplied by the caller as part of desired_files. It should
950
uniquely identify the file version in the caller's context. (Examples:
951
an index number or a TreeTransform trans_id.)
953
:param desired_files: a list of (file_id, revision_id, identifier)
956
raise NotImplementedError(self.iter_files_bytes)
958
def get_rev_id_for_revno(self, revno, known_pair):
959
"""Return the revision id of a revno, given a later (revno, revid)
960
pair in the same history.
962
:return: if found (True, revid). If the available history ran out
963
before reaching the revno, then this returns
964
(False, (closest_revno, closest_revid)).
966
known_revno, known_revid = known_pair
967
partial_history = [known_revid]
968
distance_from_known = known_revno - revno
969
if distance_from_known < 0:
971
'requested revno (%d) is later than given known revno (%d)'
972
% (revno, known_revno))
975
self, partial_history, stop_index=distance_from_known)
976
except errors.RevisionNotPresent, err:
977
if err.revision_id == known_revid:
978
# The start revision (known_revid) wasn't found.
980
# This is a stacked repository with no fallbacks, or a there's a
981
# left-hand ghost. Either way, even though the revision named in
982
# the error isn't in this repo, we know it's the next step in this
984
partial_history.append(err.revision_id)
985
if len(partial_history) <= distance_from_known:
986
# Didn't find enough history to get a revid for the revno.
987
earliest_revno = known_revno - len(partial_history) + 1
988
return (False, (earliest_revno, partial_history[-1]))
989
if len(partial_history) - 1 > distance_from_known:
990
raise AssertionError('_iter_for_revno returned too much history')
991
return (True, partial_history[-1])
993
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
994
def iter_reverse_revision_history(self, revision_id):
995
"""Iterate backwards through revision ids in the lefthand history
997
:param revision_id: The revision id to start with. All its lefthand
998
ancestors will be traversed.
1000
graph = self.get_graph()
1001
stop_revisions = (None, _mod_revision.NULL_REVISION)
1002
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
1004
def is_shared(self):
1005
"""Return True if this repository is flagged as a shared repository."""
1006
raise NotImplementedError(self.is_shared)
1009
def reconcile(self, other=None, thorough=False):
1010
"""Reconcile this repository."""
1011
from bzrlib.reconcile import RepoReconciler
1012
reconciler = RepoReconciler(self, thorough=thorough)
1013
reconciler.reconcile()
1016
def _refresh_data(self):
1017
"""Helper called from lock_* to ensure coherency with disk.
1019
The default implementation does nothing; it is however possible
1020
for repositories to maintain loaded indices across multiple locks
1021
by checking inside their implementation of this method to see
1022
whether their indices are still valid. This depends of course on
1023
the disk format being validatable in this manner. This method is
1024
also called by the refresh_data() public interface to cause a refresh
1025
to occur while in a write lock so that data inserted by a smart server
1026
push operation is visible on the client's instance of the physical
1031
def revision_tree(self, revision_id):
1032
"""Return Tree for a revision on this branch.
1034
`revision_id` may be NULL_REVISION for the empty tree revision.
1036
raise NotImplementedError(self.revision_tree)
1038
def revision_trees(self, revision_ids):
1039
"""Return Trees for revisions in this repository.
1041
:param revision_ids: a sequence of revision-ids;
1042
a revision-id may not be None or 'null:'
1044
raise NotImplementedError(self.revision_trees)
1047
@symbol_versioning.deprecated_method(
1048
symbol_versioning.deprecated_in((2, 4, 0)))
1049
def get_ancestry(self, revision_id, topo_sorted=True):
1050
"""Return a list of revision-ids integrated by a revision.
1052
The first element of the list is always None, indicating the origin
1053
revision. This might change when we have history horizons, or
1054
perhaps we should have a new API.
1056
This is topologically sorted.
1058
if 'evil' in debug.debug_flags:
1059
mutter_callsite(2, "get_ancestry is linear with history.")
1060
if _mod_revision.is_null(revision_id):
1062
if not self.has_revision(revision_id):
1063
raise errors.NoSuchRevision(self, revision_id)
1064
graph = self.get_graph()
1066
search = graph._make_breadth_first_searcher([revision_id])
1069
found, ghosts = search.next_with_ghosts()
1070
except StopIteration:
1073
if _mod_revision.NULL_REVISION in keys:
1074
keys.remove(_mod_revision.NULL_REVISION)
1076
parent_map = graph.get_parent_map(keys)
1077
keys = tsort.topo_sort(parent_map)
1078
return [None] + list(keys)
1080
def pack(self, hint=None, clean_obsolete_packs=False):
1081
"""Compress the data within the repository.
1083
This operation only makes sense for some repository types. For other
1084
types it should be a no-op that just returns.
1086
This stub method does not require a lock, but subclasses should use
1087
@needs_write_lock as this is a long running call it's reasonable to
1088
implicitly lock for the user.
1090
:param hint: If not supplied, the whole repository is packed.
1091
If supplied, the repository may use the hint parameter as a
1092
hint for the parts of the repository to pack. A hint can be
1093
obtained from the result of commit_write_group(). Out of
1094
date hints are simply ignored, because concurrent operations
1095
can obsolete them rapidly.
1097
:param clean_obsolete_packs: Clean obsolete packs immediately after
1101
def get_transaction(self):
1102
return self.control_files.get_transaction()
1104
def get_parent_map(self, revision_ids):
1105
"""See graph.StackedParentsProvider.get_parent_map"""
1106
raise NotImplementedError(self.get_parent_map)
1108
def _get_parent_map_no_fallbacks(self, revision_ids):
1109
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1110
# revisions index works in keys; this just works in revisions
1111
# therefore wrap and unwrap
1114
for revision_id in revision_ids:
1115
if revision_id == _mod_revision.NULL_REVISION:
1116
result[revision_id] = ()
1117
elif revision_id is None:
1118
raise ValueError('get_parent_map(None) is not valid')
1120
query_keys.append((revision_id ,))
1121
vf = self.revisions.without_fallbacks()
1122
for ((revision_id,), parent_keys) in \
1123
vf.get_parent_map(query_keys).iteritems():
1125
result[revision_id] = tuple([parent_revid
1126
for (parent_revid,) in parent_keys])
1128
result[revision_id] = (_mod_revision.NULL_REVISION,)
1131
def _make_parents_provider(self):
1132
if not self._format.supports_external_lookups:
1134
return graph.StackedParentsProvider(_LazyListJoin(
1135
[self._make_parents_provider_unstacked()],
1136
self._fallback_repositories))
1138
def _make_parents_provider_unstacked(self):
1139
return graph.CallableToParentsProviderAdapter(
1140
self._get_parent_map_no_fallbacks)
1143
def get_known_graph_ancestry(self, revision_ids):
1144
"""Return the known graph for a set of revision ids and their ancestors.
1146
raise NotImplementedError(self.get_known_graph_ancestry)
1148
def get_file_graph(self):
1149
"""Return the graph walker for files."""
1150
raise NotImplementedError(self.get_file_graph)
1152
def get_graph(self, other_repository=None):
1153
"""Return the graph walker for this repository format"""
1154
parents_provider = self._make_parents_provider()
1155
if (other_repository is not None and
1156
not self.has_same_location(other_repository)):
1157
parents_provider = graph.StackedParentsProvider(
1158
[parents_provider, other_repository._make_parents_provider()])
1159
return graph.Graph(parents_provider)
1161
def revision_ids_to_search_result(self, result_set):
1162
"""Convert a set of revision ids to a graph SearchResult."""
1163
result_parents = set()
1164
for parents in self.get_graph().get_parent_map(
1165
result_set).itervalues():
1166
result_parents.update(parents)
1167
included_keys = result_set.intersection(result_parents)
1168
start_keys = result_set.difference(included_keys)
1169
exclude_keys = result_parents.difference(result_set)
1170
result = graph.SearchResult(start_keys, exclude_keys,
1171
len(result_set), result_set)
1175
def set_make_working_trees(self, new_value):
1176
"""Set the policy flag for making working trees when creating branches.
1178
This only applies to branches that use this repository.
1180
The default is 'True'.
1181
:param new_value: True to restore the default, False to disable making
1184
raise NotImplementedError(self.set_make_working_trees)
1186
def make_working_trees(self):
1187
"""Returns the policy for making working trees on new branches."""
1188
raise NotImplementedError(self.make_working_trees)
1191
def sign_revision(self, revision_id, gpg_strategy):
1192
testament = _mod_testament.Testament.from_revision(self, revision_id)
1193
plaintext = testament.as_short_text()
1194
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1197
def verify_revision(self, revision_id, gpg_strategy):
1198
"""Verify the signature on a revision.
1200
:param revision_id: the revision to verify
1201
:gpg_strategy: the GPGStrategy object to used
1203
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1205
if not self.has_signature_for_revision_id(revision_id):
1206
return gpg.SIGNATURE_NOT_SIGNED, None
1207
signature = self.get_signature_text(revision_id)
1209
testament = _mod_testament.Testament.from_revision(self, revision_id)
1210
plaintext = testament.as_short_text()
1212
return gpg_strategy.verify(signature, plaintext)
1214
def has_signature_for_revision_id(self, revision_id):
1215
"""Query for a revision signature for revision_id in the repository."""
1216
raise NotImplementedError(self.has_signature_for_revision_id)
1218
def get_signature_text(self, revision_id):
1219
"""Return the text for a signature."""
1220
raise NotImplementedError(self.get_signature_text)
1222
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1223
"""Check consistency of all history of given revision_ids.
1225
Different repository implementations should override _check().
1227
:param revision_ids: A non-empty list of revision_ids whose ancestry
1228
will be checked. Typically the last revision_id of a branch.
1229
:param callback_refs: A dict of check-refs to resolve and callback
1230
the check/_check method on the items listed as wanting the ref.
1232
:param check_repo: If False do not check the repository contents, just
1233
calculate the data callback_refs requires and call them back.
1235
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1236
check_repo=check_repo)
1238
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1239
raise NotImplementedError(self.check)
1241
def _warn_if_deprecated(self, branch=None):
1242
if not self._format.is_deprecated():
1244
global _deprecation_warning_done
1245
if _deprecation_warning_done:
1249
conf = config.GlobalConfig()
1251
conf = branch.get_config()
1252
if conf.suppress_warning('format_deprecation'):
1254
warning("Format %s for %s is deprecated -"
1255
" please use 'bzr upgrade' to get better performance"
1256
% (self._format, self.bzrdir.transport.base))
1258
_deprecation_warning_done = True
1260
def supports_rich_root(self):
1261
return self._format.rich_root_data
1263
def _check_ascii_revisionid(self, revision_id, method):
1264
"""Private helper for ascii-only repositories."""
1265
# weave repositories refuse to store revisionids that are non-ascii.
1266
if revision_id is not None:
1267
# weaves require ascii revision ids.
1268
if isinstance(revision_id, unicode):
1270
revision_id.encode('ascii')
1271
except UnicodeEncodeError:
1272
raise errors.NonAsciiRevisionId(method, self)
1275
revision_id.decode('ascii')
1276
except UnicodeDecodeError:
1277
raise errors.NonAsciiRevisionId(method, self)
1280
class MetaDirRepository(Repository):
1281
"""Repositories in the new meta-dir layout.
1283
:ivar _transport: Transport for access to repository control files,
1284
typically pointing to .bzr/repository.
1287
def __init__(self, _format, a_bzrdir, control_files):
1288
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1289
self._transport = control_files._transport
1291
def is_shared(self):
1292
"""Return True if this repository is flagged as a shared repository."""
1293
return self._transport.has('shared-storage')
1296
def set_make_working_trees(self, new_value):
1297
"""Set the policy flag for making working trees when creating branches.
1299
This only applies to branches that use this repository.
1301
The default is 'True'.
1302
:param new_value: True to restore the default, False to disable making
1307
self._transport.delete('no-working-trees')
1308
except errors.NoSuchFile:
1311
self._transport.put_bytes('no-working-trees', '',
1312
mode=self.bzrdir._get_file_mode())
1314
def make_working_trees(self):
1315
"""Returns the policy for making working trees on new branches."""
1316
return not self._transport.has('no-working-trees')
1319
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1320
"""Repository format registry."""
1322
def get_default(self):
1323
"""Return the current default format."""
1324
from bzrlib import bzrdir
1325
return bzrdir.format_registry.make_bzrdir('default').repository_format
1328
network_format_registry = registry.FormatRegistry()
1329
"""Registry of formats indexed by their network name.
1331
The network name for a repository format is an identifier that can be used when
1332
referring to formats with smart server operations. See
1333
RepositoryFormat.network_name() for more detail.
1337
format_registry = RepositoryFormatRegistry(network_format_registry)
1338
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1340
This can contain either format instances themselves, or classes/factories that
1341
can be called to obtain one.
1345
#####################################################################
1346
# Repository Formats
1348
class RepositoryFormat(controldir.ControlComponentFormat):
1349
"""A repository format.
1351
Formats provide four things:
1352
* An initialization routine to construct repository data on disk.
1353
* a optional format string which is used when the BzrDir supports
1355
* an open routine which returns a Repository instance.
1356
* A network name for referring to the format in smart server RPC
1359
There is one and only one Format subclass for each on-disk format. But
1360
there can be one Repository subclass that is used for several different
1361
formats. The _format attribute on a Repository instance can be used to
1362
determine the disk format.
1364
Formats are placed in a registry by their format string for reference
1365
during opening. These should be subclasses of RepositoryFormat for
1368
Once a format is deprecated, just deprecate the initialize and open
1369
methods on the format class. Do not deprecate the object, as the
1370
object may be created even when a repository instance hasn't been
1373
Common instance attributes:
1374
_matchingbzrdir - the bzrdir format that the repository format was
1375
originally written to work with. This can be used if manually
1376
constructing a bzrdir and repository, or more commonly for test suite
1380
# Set to True or False in derived classes. True indicates that the format
1381
# supports ghosts gracefully.
1382
supports_ghosts = None
1383
# Can this repository be given external locations to lookup additional
1384
# data. Set to True or False in derived classes.
1385
supports_external_lookups = None
1386
# Does this format support CHK bytestring lookups. Set to True or False in
1388
supports_chks = None
1389
# Should fetch trigger a reconcile after the fetch? Only needed for
1390
# some repository formats that can suffer internal inconsistencies.
1391
_fetch_reconcile = False
1392
# Does this format have < O(tree_size) delta generation. Used to hint what
1393
# code path for commit, amongst other things.
1395
# Does doing a pack operation compress data? Useful for the pack UI command
1396
# (so if there is one pack, the operation can still proceed because it may
1397
# help), and for fetching when data won't have come from the same
1399
pack_compresses = False
1400
# Does the repository storage understand references to trees?
1401
supports_tree_reference = None
1402
# Is the format experimental ?
1403
experimental = False
1404
# Does this repository format escape funky characters, or does it create
1405
# files with similar names as the versioned files in its contents on disk
1407
supports_funky_characters = None
1408
# Does this repository format support leaving locks?
1409
supports_leaving_lock = None
1410
# Does this format support the full VersionedFiles interface?
1411
supports_full_versioned_files = None
1412
# Does this format support signing revision signatures?
1413
supports_revision_signatures = True
1414
# Can the revision graph have incorrect parents?
1415
revision_graph_can_have_wrong_parents = None
1416
# Does this format support rich root data?
1417
rich_root_data = None
1418
# Does this format support explicitly versioned directories?
1419
supports_versioned_directories = None
1420
# Can other repositories be nested into one of this format?
1421
supports_nesting_repositories = None
1424
return "%s()" % self.__class__.__name__
1426
def __eq__(self, other):
1427
# format objects are generally stateless
1428
return isinstance(other, self.__class__)
1430
def __ne__(self, other):
1431
return not self == other
1434
def find_format(klass, a_bzrdir):
1435
"""Return the format for the repository object in a_bzrdir.
1437
This is used by bzr native formats that have a "format" file in
1438
the repository. Other methods may be used by different types of
1442
transport = a_bzrdir.get_repository_transport(None)
1443
format_string = transport.get_bytes("format")
1444
return format_registry.get(format_string)
1445
except errors.NoSuchFile:
1446
raise errors.NoRepositoryPresent(a_bzrdir)
1448
raise errors.UnknownFormatError(format=format_string,
1452
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1453
def register_format(klass, format):
1454
format_registry.register(format)
1457
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1458
def unregister_format(klass, format):
1459
format_registry.remove(format)
1462
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1463
def get_default_format(klass):
1464
"""Return the current default format."""
1465
return format_registry.get_default()
1467
def get_format_string(self):
1468
"""Return the ASCII format string that identifies this format.
1470
Note that in pre format ?? repositories the format string is
1471
not permitted nor written to disk.
1473
raise NotImplementedError(self.get_format_string)
1475
def get_format_description(self):
1476
"""Return the short description for this format."""
1477
raise NotImplementedError(self.get_format_description)
1479
def initialize(self, a_bzrdir, shared=False):
1480
"""Initialize a repository of this format in a_bzrdir.
1482
:param a_bzrdir: The bzrdir to put the new repository in it.
1483
:param shared: The repository should be initialized as a sharable one.
1484
:returns: The new repository object.
1486
This may raise UninitializableFormat if shared repository are not
1487
compatible the a_bzrdir.
1489
raise NotImplementedError(self.initialize)
1491
def is_supported(self):
1492
"""Is this format supported?
1494
Supported formats must be initializable and openable.
1495
Unsupported formats may not support initialization or committing or
1496
some other features depending on the reason for not being supported.
1500
def is_deprecated(self):
1501
"""Is this format deprecated?
1503
Deprecated formats may trigger a user-visible warning recommending
1504
the user to upgrade. They are still fully supported.
1508
def network_name(self):
1509
"""A simple byte string uniquely identifying this format for RPC calls.
1511
MetaDir repository formats use their disk format string to identify the
1512
repository over the wire. All in one formats such as bzr < 0.8, and
1513
foreign formats like svn/git and hg should use some marker which is
1514
unique and immutable.
1516
raise NotImplementedError(self.network_name)
1518
def check_conversion_target(self, target_format):
1519
if self.rich_root_data and not target_format.rich_root_data:
1520
raise errors.BadConversionTarget(
1521
'Does not support rich root data.', target_format,
1523
if (self.supports_tree_reference and
1524
not getattr(target_format, 'supports_tree_reference', False)):
1525
raise errors.BadConversionTarget(
1526
'Does not support nested trees', target_format,
1529
def open(self, a_bzrdir, _found=False):
1530
"""Return an instance of this format for the bzrdir a_bzrdir.
1532
_found is a private parameter, do not use it.
1534
raise NotImplementedError(self.open)
1536
def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
1537
from bzrlib.bzrdir import BzrDir, RepoInitHookParams
1538
hooks = BzrDir.hooks['post_repo_init']
1541
params = RepoInitHookParams(repository, self, a_bzrdir, shared)
1546
class MetaDirRepositoryFormat(RepositoryFormat):
1547
"""Common base class for the new repositories using the metadir layout."""
1549
rich_root_data = False
1550
supports_tree_reference = False
1551
supports_external_lookups = False
1552
supports_leaving_lock = True
1553
supports_nesting_repositories = True
1556
def _matchingbzrdir(self):
1557
matching = bzrdir.BzrDirMetaFormat1()
1558
matching.repository_format = self
1562
super(MetaDirRepositoryFormat, self).__init__()
1564
def _create_control_files(self, a_bzrdir):
1565
"""Create the required files and the initial control_files object."""
1566
# FIXME: RBC 20060125 don't peek under the covers
1567
# NB: no need to escape relative paths that are url safe.
1568
repository_transport = a_bzrdir.get_repository_transport(self)
1569
control_files = lockable_files.LockableFiles(repository_transport,
1570
'lock', lockdir.LockDir)
1571
control_files.create_lock()
1572
return control_files
1574
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1575
"""Upload the initial blank content."""
1576
control_files = self._create_control_files(a_bzrdir)
1577
control_files.lock_write()
1578
transport = control_files._transport
1580
utf8_files += [('shared-storage', '')]
1582
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1583
for (filename, content_stream) in files:
1584
transport.put_file(filename, content_stream,
1585
mode=a_bzrdir._get_file_mode())
1586
for (filename, content_bytes) in utf8_files:
1587
transport.put_bytes_non_atomic(filename, content_bytes,
1588
mode=a_bzrdir._get_file_mode())
1590
control_files.unlock()
1592
def network_name(self):
1593
"""Metadir formats have matching disk and network format strings."""
1594
return self.get_format_string()
1597
# formats which have no format string are not discoverable or independently
1598
# creatable on disk, so are not registered in format_registry. They're
1599
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1600
# needed, it's constructed directly by the BzrDir. Non-native formats where
1601
# the repository is not separately opened are similar.
1603
format_registry.register_lazy(
1604
'Bazaar-NG Knit Repository Format 1',
1605
'bzrlib.repofmt.knitrepo',
1606
'RepositoryFormatKnit1',
1609
format_registry.register_lazy(
1610
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1611
'bzrlib.repofmt.knitrepo',
1612
'RepositoryFormatKnit3',
1615
format_registry.register_lazy(
1616
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1617
'bzrlib.repofmt.knitrepo',
1618
'RepositoryFormatKnit4',
1621
# Pack-based formats. There is one format for pre-subtrees, and one for
1622
# post-subtrees to allow ease of testing.
1623
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1624
format_registry.register_lazy(
1625
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1626
'bzrlib.repofmt.knitpack_repo',
1627
'RepositoryFormatKnitPack1',
1629
format_registry.register_lazy(
1630
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1631
'bzrlib.repofmt.knitpack_repo',
1632
'RepositoryFormatKnitPack3',
1634
format_registry.register_lazy(
1635
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1636
'bzrlib.repofmt.knitpack_repo',
1637
'RepositoryFormatKnitPack4',
1639
format_registry.register_lazy(
1640
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1641
'bzrlib.repofmt.knitpack_repo',
1642
'RepositoryFormatKnitPack5',
1644
format_registry.register_lazy(
1645
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1646
'bzrlib.repofmt.knitpack_repo',
1647
'RepositoryFormatKnitPack5RichRoot',
1649
format_registry.register_lazy(
1650
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1651
'bzrlib.repofmt.knitpack_repo',
1652
'RepositoryFormatKnitPack5RichRootBroken',
1654
format_registry.register_lazy(
1655
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1656
'bzrlib.repofmt.knitpack_repo',
1657
'RepositoryFormatKnitPack6',
1659
format_registry.register_lazy(
1660
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1661
'bzrlib.repofmt.knitpack_repo',
1662
'RepositoryFormatKnitPack6RichRoot',
1664
format_registry.register_lazy(
1665
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1666
'bzrlib.repofmt.groupcompress_repo',
1667
'RepositoryFormat2a',
1670
# Development formats.
1671
# Check their docstrings to see if/when they are obsolete.
1672
format_registry.register_lazy(
1673
("Bazaar development format 2 with subtree support "
1674
"(needs bzr.dev from before 1.8)\n"),
1675
'bzrlib.repofmt.knitpack_repo',
1676
'RepositoryFormatPackDevelopment2Subtree',
1678
format_registry.register_lazy(
1679
'Bazaar development format 8\n',
1680
'bzrlib.repofmt.groupcompress_repo',
1681
'RepositoryFormat2aSubtree',
1685
class InterRepository(InterObject):
1686
"""This class represents operations taking place between two repositories.
1688
Its instances have methods like copy_content and fetch, and contain
1689
references to the source and target repositories these operations can be
1692
Often we will provide convenience methods on 'repository' which carry out
1693
operations with another repository - they will always forward to
1694
InterRepository.get(other).method_name(parameters).
1698
"""The available optimised InterRepository types."""
1701
def copy_content(self, revision_id=None):
1702
"""Make a complete copy of the content in self into destination.
1704
This is a destructive operation! Do not use it on existing
1707
:param revision_id: Only copy the content needed to construct
1708
revision_id and its parents.
1711
self.target.set_make_working_trees(self.source.make_working_trees())
1712
except NotImplementedError:
1714
self.target.fetch(self.source, revision_id=revision_id)
1717
def fetch(self, revision_id=None, find_ghosts=False,
1719
"""Fetch the content required to construct revision_id.
1721
The content is copied from self.source to self.target.
1723
:param revision_id: if None all content is copied, if NULL_REVISION no
1727
raise NotImplementedError(self.fetch)
1730
def search_missing_revision_ids(self,
1731
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1732
find_ghosts=True, revision_ids=None, if_present_ids=None,
1734
"""Return the revision ids that source has that target does not.
1736
:param revision_id: only return revision ids included by this
1738
:param revision_ids: return revision ids included by these
1739
revision_ids. NoSuchRevision will be raised if any of these
1740
revisions are not present.
1741
:param if_present_ids: like revision_ids, but will not cause
1742
NoSuchRevision if any of these are absent, instead they will simply
1743
not be in the result. This is useful for e.g. finding revisions
1744
to fetch for tags, which may reference absent revisions.
1745
:param find_ghosts: If True find missing revisions in deep history
1746
rather than just finding the surface difference.
1747
:param limit: Maximum number of revisions to return, topologically
1749
:return: A bzrlib.graph.SearchResult.
1751
raise NotImplementedError(self.search_missing_revision_ids)
1754
def _same_model(source, target):
1755
"""True if source and target have the same data representation.
1757
Note: this is always called on the base class; overriding it in a
1758
subclass will have no effect.
1761
InterRepository._assert_same_model(source, target)
1763
except errors.IncompatibleRepositories, e:
1767
def _assert_same_model(source, target):
1768
"""Raise an exception if two repositories do not use the same model.
1770
if source.supports_rich_root() != target.supports_rich_root():
1771
raise errors.IncompatibleRepositories(source, target,
1772
"different rich-root support")
1773
if source._serializer != target._serializer:
1774
raise errors.IncompatibleRepositories(source, target,
1775
"different serializers")
1778
class CopyConverter(object):
1779
"""A repository conversion tool which just performs a copy of the content.
1781
This is slow but quite reliable.
1784
def __init__(self, target_format):
1785
"""Create a CopyConverter.
1787
:param target_format: The format the resulting repository should be.
1789
self.target_format = target_format
1791
def convert(self, repo, pb):
1792
"""Perform the conversion of to_convert, giving feedback via pb.
1794
:param to_convert: The disk object to convert.
1795
:param pb: a progress bar to use for progress information.
1797
pb = ui.ui_factory.nested_progress_bar()
1800
# this is only useful with metadir layouts - separated repo content.
1801
# trigger an assertion if not such
1802
repo._format.get_format_string()
1803
self.repo_dir = repo.bzrdir
1804
pb.update(gettext('Moving repository to repository.backup'))
1805
self.repo_dir.transport.move('repository', 'repository.backup')
1806
backup_transport = self.repo_dir.transport.clone('repository.backup')
1807
repo._format.check_conversion_target(self.target_format)
1808
self.source_repo = repo._format.open(self.repo_dir,
1810
_override_transport=backup_transport)
1811
pb.update(gettext('Creating new repository'))
1812
converted = self.target_format.initialize(self.repo_dir,
1813
self.source_repo.is_shared())
1814
converted.lock_write()
1816
pb.update(gettext('Copying content'))
1817
self.source_repo.copy_content_into(converted)
1820
pb.update(gettext('Deleting old repository content'))
1821
self.repo_dir.transport.delete_tree('repository.backup')
1822
ui.ui_factory.note(gettext('repository converted'))
1826
def _strip_NULL_ghosts(revision_graph):
1827
"""Also don't use this. more compatibility code for unmigrated clients."""
1828
# Filter ghosts, and null:
1829
if _mod_revision.NULL_REVISION in revision_graph:
1830
del revision_graph[_mod_revision.NULL_REVISION]
1831
for key, parents in revision_graph.items():
1832
revision_graph[key] = tuple(parent for parent in parents if parent
1834
return revision_graph
1837
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1838
stop_revision=None):
1839
"""Extend the partial history to include a given index
1841
If a stop_index is supplied, stop when that index has been reached.
1842
If a stop_revision is supplied, stop when that revision is
1843
encountered. Otherwise, stop when the beginning of history is
1846
:param stop_index: The index which should be present. When it is
1847
present, history extension will stop.
1848
:param stop_revision: The revision id which should be present. When
1849
it is encountered, history extension will stop.
1851
start_revision = partial_history_cache[-1]
1852
graph = repo.get_graph()
1853
iterator = graph.iter_lefthand_ancestry(start_revision,
1854
(_mod_revision.NULL_REVISION,))
1856
# skip the last revision in the list
1859
if (stop_index is not None and
1860
len(partial_history_cache) > stop_index):
1862
if partial_history_cache[-1] == stop_revision:
1864
revision_id = iterator.next()
1865
partial_history_cache.append(revision_id)
1866
except StopIteration:
1871
class _LazyListJoin(object):
1872
"""An iterable yielding the contents of many lists as one list.
1874
Each iterator made from this will reflect the current contents of the lists
1875
at the time the iterator is made.
1877
This is used by Repository's _make_parents_provider implementation so that
1880
pp = repo._make_parents_provider() # uses a list of fallback repos
1881
pp.add_fallback_repository(other_repo) # appends to that list
1882
result = pp.get_parent_map(...)
1883
# The result will include revs from other_repo
1886
def __init__(self, *list_parts):
1887
self.list_parts = list_parts
1891
for list_part in self.list_parts:
1892
full_list.extend(list_part)
1893
return iter(full_list)
1896
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
added
removed
bzrlib/repository.py
