1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
19
from bzrlib.lockable_files import LockableFiles
20
from bzrlib.tree import EmptyTree
21
from bzrlib.revision import NULL_REVISION
22
from bzrlib.store import copy_all
23
from bzrlib.store.weave import WeaveStore
24
from bzrlib.store.text import TextStore
26
from bzrlib.tree import RevisionTree
27
from bzrlib.errors import InvalidRevisionId
28
from bzrlib.testament import Testament
31
def needs_read_lock(unbound):
32
"""Decorate unbound to take out and release a read lock."""
33
def decorated(self, *args, **kwargs):
34
self.control_files.lock_read()
36
return unbound(self, *args, **kwargs)
38
self.control_files.unlock()
42
def needs_write_lock(unbound):
43
"""Decorate unbound to take out and release a write lock."""
44
def decorated(self, *args, **kwargs):
45
self.control_files.lock_write()
47
return unbound(self, *args, **kwargs)
49
self.control_files.unlock()
53
class Repository(object):
55
def __init__(self, transport, branch_format):
57
self.control_files = LockableFiles(transport.clone(bzrlib.BZRDIR), 'README')
59
dir_mode = self.control_files._dir_mode
60
file_mode = self.control_files._file_mode
62
def get_weave(name, prefixed=False):
64
name = bzrlib.BZRDIR + '/' + unicode(name)
67
relpath = self.control_files._escape(name)
68
weave_transport = transport.clone(relpath)
69
ws = WeaveStore(weave_transport, prefixed=prefixed,
72
if self.control_files._transport.should_cache():
73
ws.enable_cache = True
76
def get_store(name, compressed=True, prefixed=False):
77
# FIXME: This approach of assuming stores are all entirely compressed
78
# or entirely uncompressed is tidy, but breaks upgrade from
79
# some existing branches where there's a mixture; we probably
80
# still want the option to look for both.
82
name = bzrlib.BZRDIR + '/' + unicode(name)
85
relpath = self.control_files._escape(name)
86
store = TextStore(transport.clone(relpath),
87
prefixed=prefixed, compressed=compressed,
90
#if self._transport.should_cache():
91
# cache_path = os.path.join(self.cache_root, name)
92
# os.mkdir(cache_path)
93
# store = bzrlib.store.CachedStore(store, cache_path)
96
if branch_format == 4:
97
self.inventory_store = get_store('inventory-store')
98
self.text_store = get_store('text-store')
99
self.revision_store = get_store('revision-store')
100
elif branch_format == 5:
101
self.control_weaves = get_weave('')
102
self.weave_store = get_weave('weaves')
103
self.revision_store = get_store('revision-store', compressed=False)
104
elif branch_format == 6:
105
self.control_weaves = get_weave('')
106
self.weave_store = get_weave('weaves', prefixed=True)
107
self.revision_store = get_store('revision-store', compressed=False,
109
self.revision_store.register_suffix('sig')
111
def lock_write(self):
112
self.control_files.lock_write()
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
from bzrlib.lazy_import import lazy_import
20
lazy_import(globals(), """
33
revision as _mod_revision,
34
testament as _mod_testament,
38
from bzrlib.bundle import serializer
39
from bzrlib.i18n import gettext
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.inter import InterObject
51
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
from bzrlib.trace import (
53
log_exception_quietly, note, mutter, mutter_callsite, warning)
56
# Old formats display a warning, but only once
57
_deprecation_warning_done = False
60
class IsInWriteGroupError(errors.InternalBzrError):
62
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
64
def __init__(self, repo):
65
errors.InternalBzrError.__init__(self, repo=repo)
68
class CommitBuilder(object):
69
"""Provides an interface to build up a commit.
71
This allows describing a tree to be committed without needing to
72
know the internals of the format of the repository.
75
# all clients should supply tree roots.
76
record_root_entry = True
77
# whether this commit builder supports the record_entry_contents interface
78
supports_record_entry_contents = False
79
# whether this commit builder will automatically update the branch that is
81
updates_branch = False
83
def __init__(self, repository, parents, config_stack, timestamp=None,
84
timezone=None, committer=None, revprops=None,
85
revision_id=None, lossy=False):
86
"""Initiate a CommitBuilder.
88
:param repository: Repository to commit to.
89
:param parents: Revision ids of the parents of the new revision.
90
:param timestamp: Optional timestamp recorded for commit.
91
:param timezone: Optional timezone for timestamp.
92
:param committer: Optional committer to set for commit.
93
:param revprops: Optional dictionary of revision properties.
94
:param revision_id: Optional revision id.
95
:param lossy: Whether to discard data that can not be natively
96
represented, when pushing to a foreign VCS
98
self._config_stack = config_stack
101
if committer is None:
102
self._committer = self._config_stack.get('email')
103
elif not isinstance(committer, unicode):
104
self._committer = committer.decode() # throw if non-ascii
106
self._committer = committer
108
self._new_revision_id = revision_id
109
self.parents = parents
110
self.repository = repository
113
if revprops is not None:
114
self._validate_revprops(revprops)
115
self._revprops.update(revprops)
117
if timestamp is None:
118
timestamp = time.time()
119
# Restrict resolution to 1ms
120
self._timestamp = round(timestamp, 3)
123
self._timezone = osutils.local_time_offset()
125
self._timezone = int(timezone)
127
self._generate_revision_if_needed()
129
def any_changes(self):
130
"""Return True if any entries were changed.
132
This includes merge-only changes. It is the core for the --unchanged
135
:return: True if any changes have occured.
137
raise NotImplementedError(self.any_changes)
139
def _validate_unicode_text(self, text, context):
140
"""Verify things like commit messages don't have bogus characters."""
142
raise ValueError('Invalid value for %s: %r' % (context, text))
144
def _validate_revprops(self, revprops):
145
for key, value in revprops.iteritems():
146
# We know that the XML serializers do not round trip '\r'
147
# correctly, so refuse to accept them
148
if not isinstance(value, basestring):
149
raise ValueError('revision property (%s) is not a valid'
150
' (unicode) string: %r' % (key, value))
151
self._validate_unicode_text(value,
152
'revision property (%s)' % (key,))
154
def commit(self, message):
155
"""Make the actual commit.
157
:return: The revision id of the recorded revision.
159
raise NotImplementedError(self.commit)
162
"""Abort the commit that is being built.
164
raise NotImplementedError(self.abort)
166
def revision_tree(self):
167
"""Return the tree that was just committed.
169
After calling commit() this can be called to get a
170
RevisionTree representing the newly committed tree. This is
171
preferred to calling Repository.revision_tree() because that may
172
require deserializing the inventory, while we already have a copy in
175
raise NotImplementedError(self.revision_tree)
177
def finish_inventory(self):
178
"""Tell the builder that the inventory is finished.
180
:return: The inventory id in the repository, which can be used with
181
repository.get_inventory.
183
raise NotImplementedError(self.finish_inventory)
185
def _gen_revision_id(self):
186
"""Return new revision-id."""
187
return generate_ids.gen_revision_id(self._committer, self._timestamp)
189
def _generate_revision_if_needed(self):
190
"""Create a revision id if None was supplied.
192
If the repository can not support user-specified revision ids
193
they should override this function and raise CannotSetRevisionId
194
if _new_revision_id is not None.
196
:raises: CannotSetRevisionId
198
if self._new_revision_id is None:
199
self._new_revision_id = self._gen_revision_id()
200
self.random_revid = True
202
self.random_revid = False
204
def will_record_deletes(self):
205
"""Tell the commit builder that deletes are being notified.
207
This enables the accumulation of an inventory delta; for the resulting
208
commit to be valid, deletes against the basis MUST be recorded via
209
builder.record_delete().
211
raise NotImplementedError(self.will_record_deletes)
213
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
214
"""Record a new tree via iter_changes.
216
:param tree: The tree to obtain text contents from for changed objects.
217
:param basis_revision_id: The revision id of the tree the iter_changes
218
has been generated against. Currently assumed to be the same
219
as self.parents[0] - if it is not, errors may occur.
220
:param iter_changes: An iter_changes iterator with the changes to apply
221
to basis_revision_id. The iterator must not include any items with
222
a current kind of None - missing items must be either filtered out
223
or errored-on beefore record_iter_changes sees the item.
224
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
227
raise NotImplementedError(self.record_iter_changes)
230
class RepositoryWriteLockResult(LogicalLockResult):
231
"""The result of write locking a repository.
233
:ivar repository_token: The token obtained from the underlying lock, or
235
:ivar unlock: A callable which will unlock the lock.
238
def __init__(self, unlock, repository_token):
239
LogicalLockResult.__init__(self, unlock)
240
self.repository_token = repository_token
243
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
247
######################################################################
251
class Repository(_RelockDebugMixin, controldir.ControlComponent):
252
"""Repository holding history for one or more branches.
254
The repository holds and retrieves historical information including
255
revisions and file history. It's normally accessed only by the Branch,
256
which views a particular line of development through that history.
258
See VersionedFileRepository in bzrlib.vf_repository for the
259
base class for most Bazaar repositories.
262
def abort_write_group(self, suppress_errors=False):
263
"""Commit the contents accrued within the current write group.
265
:param suppress_errors: if true, abort_write_group will catch and log
266
unexpected errors that happen during the abort, rather than
267
allowing them to propagate. Defaults to False.
269
:seealso: start_write_group.
271
if self._write_group is not self.get_transaction():
272
# has an unlock or relock occured ?
275
'(suppressed) mismatched lock context and write group. %r, %r',
276
self._write_group, self.get_transaction())
278
raise errors.BzrError(
279
'mismatched lock context and write group. %r, %r' %
280
(self._write_group, self.get_transaction()))
282
self._abort_write_group()
283
except Exception, exc:
284
self._write_group = None
285
if not suppress_errors:
287
mutter('abort_write_group failed')
288
log_exception_quietly()
289
note(gettext('bzr: ERROR (ignored): %s'), exc)
290
self._write_group = None
292
def _abort_write_group(self):
293
"""Template method for per-repository write group cleanup.
295
This is called during abort before the write group is considered to be
296
finished and should cleanup any internal state accrued during the write
297
group. There is no requirement that data handed to the repository be
298
*not* made available - this is not a rollback - but neither should any
299
attempt be made to ensure that data added is fully commited. Abort is
300
invoked when an error has occured so futher disk or network operations
301
may not be possible or may error and if possible should not be
305
def add_fallback_repository(self, repository):
306
"""Add a repository to use for looking up data not held locally.
308
:param repository: A repository.
310
raise NotImplementedError(self.add_fallback_repository)
312
def _check_fallback_repository(self, repository):
313
"""Check that this repository can fallback to repository safely.
315
Raise an error if not.
317
:param repository: A repository to fallback to.
319
return InterRepository._assert_same_model(self, repository)
321
def all_revision_ids(self):
322
"""Returns a list of all the revision ids in the repository.
324
This is conceptually deprecated because code should generally work on
325
the graph reachable from a particular revision, and ignore any other
326
revisions that might be present. There is no direct replacement
329
if 'evil' in debug.debug_flags:
330
mutter_callsite(2, "all_revision_ids is linear with history.")
331
return self._all_revision_ids()
333
def _all_revision_ids(self):
334
"""Returns a list of all the revision ids in the repository.
336
These are in as much topological order as the underlying store can
339
raise NotImplementedError(self._all_revision_ids)
341
def break_lock(self):
342
"""Break a lock if one is present from another instance.
344
Uses the ui factory to ask for confirmation if the lock may be from
347
self.control_files.break_lock()
350
def create(controldir):
351
"""Construct the current default format repository in controldir."""
352
return RepositoryFormat.get_default_format().initialize(controldir)
354
def __init__(self, _format, controldir, control_files):
355
"""instantiate a Repository.
357
:param _format: The format of the repository on disk.
358
:param controldir: The ControlDir of the repository.
359
:param control_files: Control files to use for locking, etc.
361
# In the future we will have a single api for all stores for
362
# getting file texts, inventories and revisions, then
363
# this construct will accept instances of those things.
364
super(Repository, self).__init__()
365
self._format = _format
366
# the following are part of the public API for Repository:
367
self.bzrdir = controldir
368
self.control_files = control_files
370
self._write_group = None
371
# Additional places to query for data.
372
self._fallback_repositories = []
375
def user_transport(self):
376
return self.bzrdir.user_transport
379
def control_transport(self):
380
return self._transport
383
if self._fallback_repositories:
384
return '%s(%r, fallback_repositories=%r)' % (
385
self.__class__.__name__,
387
self._fallback_repositories)
389
return '%s(%r)' % (self.__class__.__name__,
392
def _has_same_fallbacks(self, other_repo):
393
"""Returns true if the repositories have the same fallbacks."""
394
my_fb = self._fallback_repositories
395
other_fb = other_repo._fallback_repositories
396
if len(my_fb) != len(other_fb):
398
for f, g in zip(my_fb, other_fb):
399
if not f.has_same_location(g):
403
def has_same_location(self, other):
404
"""Returns a boolean indicating if this repository is at the same
405
location as another repository.
407
This might return False even when two repository objects are accessing
408
the same physical repository via different URLs.
410
if self.__class__ is not other.__class__:
412
return (self.control_url == other.control_url)
414
def is_in_write_group(self):
415
"""Return True if there is an open write group.
417
:seealso: start_write_group.
419
return self._write_group is not None
422
return self.control_files.is_locked()
424
def is_write_locked(self):
425
"""Return True if this object is write locked."""
426
return self.is_locked() and self.control_files._lock_mode == 'w'
428
def lock_write(self, token=None):
429
"""Lock this repository for writing.
431
This causes caching within the repository obejct to start accumlating
432
data during reads, and allows a 'write_group' to be obtained. Write
433
groups must be used for actual data insertion.
435
A token should be passed in if you know that you have locked the object
436
some other way, and need to synchronise this object's state with that
439
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
441
:param token: if this is already locked, then lock_write will fail
442
unless the token matches the existing lock.
443
:returns: a token if this instance supports tokens, otherwise None.
444
:raises TokenLockingNotSupported: when a token is given but this
445
instance doesn't support using token locks.
446
:raises MismatchedToken: if the specified token doesn't match the token
447
of the existing lock.
448
:seealso: start_write_group.
449
:return: A RepositoryWriteLockResult.
451
locked = self.is_locked()
452
token = self.control_files.lock_write(token=token)
454
self._warn_if_deprecated()
456
for repo in self._fallback_repositories:
457
# Writes don't affect fallback repos
460
return RepositoryWriteLockResult(self.unlock, token)
114
462
def lock_read(self):
463
"""Lock the repository for read operations.
465
:return: An object with an unlock method which will release the lock
468
locked = self.is_locked()
115
469
self.control_files.lock_read()
471
self._warn_if_deprecated()
473
for repo in self._fallback_repositories:
476
return LogicalLockResult(self.unlock)
478
def get_physical_lock_status(self):
479
return self.control_files.get_physical_lock_status()
481
def leave_lock_in_place(self):
482
"""Tell this repository not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this repository to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
498
def gather_stats(self, revid=None, committers=None):
499
"""Gather statistics from a revision id.
501
:param revid: The revision id to gather statistics from, if None, then
502
no revision specific statistics are gathered.
503
:param committers: Optional parameter controlling whether to grab
504
a count of committers from the revision specific statistics.
505
:return: A dictionary of statistics. Currently this contains:
506
committers: The number of committers if requested.
507
firstrev: A tuple with timestamp, timezone for the penultimate left
508
most ancestor of revid, if revid is not the NULL_REVISION.
509
latestrev: A tuple with timestamp, timezone for revid, if revid is
510
not the NULL_REVISION.
511
revisions: The total revision count in the repository.
512
size: An estimate disk size of the repository in bytes.
515
if revid and committers:
516
result['committers'] = 0
517
if revid and revid != _mod_revision.NULL_REVISION:
518
graph = self.get_graph()
520
all_committers = set()
521
revisions = [r for (r, p) in graph.iter_ancestry([revid])
522
if r != _mod_revision.NULL_REVISION]
525
# ignore the revisions in the middle - just grab first and last
526
revisions = revisions[0], revisions[-1]
527
for revision in self.get_revisions(revisions):
528
if not last_revision:
529
last_revision = revision
531
all_committers.add(revision.committer)
532
first_revision = revision
534
result['committers'] = len(all_committers)
535
result['firstrev'] = (first_revision.timestamp,
536
first_revision.timezone)
537
result['latestrev'] = (last_revision.timestamp,
538
last_revision.timezone)
541
def find_branches(self, using=False):
542
"""Find branches underneath this repository.
544
This will include branches inside other branches.
546
:param using: If True, list only branches using this repository.
548
if using and not self.is_shared():
549
return self.bzrdir.list_branches()
550
class Evaluator(object):
553
self.first_call = True
555
def __call__(self, controldir):
556
# On the first call, the parameter is always the controldir
557
# containing the current repo.
558
if not self.first_call:
560
repository = controldir.open_repository()
561
except errors.NoRepositoryPresent:
564
return False, ([], repository)
565
self.first_call = False
566
value = (controldir.list_branches(), None)
570
for branches, repository in controldir.ControlDir.find_bzrdirs(
571
self.user_transport, evaluate=Evaluator()):
572
if branches is not None:
574
if not using and repository is not None:
575
ret.extend(repository.find_branches())
579
def search_missing_revision_ids(self, other,
580
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
581
find_ghosts=True, revision_ids=None, if_present_ids=None,
583
"""Return the revision ids that other has that this does not.
585
These are returned in topological order.
587
revision_id: only return revision ids included by revision_id.
589
if symbol_versioning.deprecated_passed(revision_id):
590
symbol_versioning.warn(
591
'search_missing_revision_ids(revision_id=...) was '
592
'deprecated in 2.4. Use revision_ids=[...] instead.',
593
DeprecationWarning, stacklevel=3)
594
if revision_ids is not None:
595
raise AssertionError(
596
'revision_ids is mutually exclusive with revision_id')
597
if revision_id is not None:
598
revision_ids = [revision_id]
599
return InterRepository.get(other, self).search_missing_revision_ids(
600
find_ghosts=find_ghosts, revision_ids=revision_ids,
601
if_present_ids=if_present_ids, limit=limit)
605
"""Open the repository rooted at base.
607
For instance, if the repository is at URL/.bzr/repository,
608
Repository.open(URL) -> a Repository instance.
610
control = controldir.ControlDir.open(base)
611
return control.open_repository()
613
def copy_content_into(self, destination, revision_id=None):
614
"""Make a complete copy of the content in self into destination.
616
This is a destructive operation! Do not use it on existing
619
return InterRepository.get(self, destination).copy_content(revision_id)
621
def commit_write_group(self):
622
"""Commit the contents accrued within the current write group.
624
:seealso: start_write_group.
626
:return: it may return an opaque hint that can be passed to 'pack'.
628
if self._write_group is not self.get_transaction():
629
# has an unlock or relock occured ?
630
raise errors.BzrError('mismatched lock context %r and '
632
(self.get_transaction(), self._write_group))
633
result = self._commit_write_group()
634
self._write_group = None
637
def _commit_write_group(self):
638
"""Template method for per-repository write group cleanup.
640
This is called before the write group is considered to be
641
finished and should ensure that all data handed to the repository
642
for writing during the write group is safely committed (to the
643
extent possible considering file system caching etc).
646
def suspend_write_group(self):
647
"""Suspend a write group.
649
:raise UnsuspendableWriteGroup: If the write group can not be
651
:return: List of tokens
653
raise errors.UnsuspendableWriteGroup(self)
655
def refresh_data(self):
656
"""Re-read any data needed to synchronise with disk.
658
This method is intended to be called after another repository instance
659
(such as one used by a smart server) has inserted data into the
660
repository. On all repositories this will work outside of write groups.
661
Some repository formats (pack and newer for bzrlib native formats)
662
support refresh_data inside write groups. If called inside a write
663
group on a repository that does not support refreshing in a write group
664
IsInWriteGroupError will be raised.
668
def resume_write_group(self, tokens):
669
if not self.is_write_locked():
670
raise errors.NotWriteLocked(self)
671
if self._write_group:
672
raise errors.BzrError('already in a write group')
673
self._resume_write_group(tokens)
674
# so we can detect unlock/relock - the write group is now entered.
675
self._write_group = self.get_transaction()
677
def _resume_write_group(self, tokens):
678
raise errors.UnsuspendableWriteGroup(self)
680
def fetch(self, source, revision_id=None, find_ghosts=False):
681
"""Fetch the content required to construct revision_id from source.
683
If revision_id is None, then all content is copied.
685
fetch() may not be used when the repository is in a write group -
686
either finish the current write group before using fetch, or use
687
fetch before starting the write group.
689
:param find_ghosts: Find and copy revisions in the source that are
690
ghosts in the target (and not reachable directly by walking out to
691
the first-present revision in target from revision_id).
692
:param revision_id: If specified, all the content needed for this
693
revision ID will be copied to the target. Fetch will determine for
694
itself which content needs to be copied.
696
if self.is_in_write_group():
697
raise errors.InternalBzrError(
698
"May not fetch while in a write group.")
699
# fast path same-url fetch operations
700
# TODO: lift out to somewhere common with RemoteRepository
701
# <https://bugs.launchpad.net/bzr/+bug/401646>
702
if (self.has_same_location(source)
703
and self._has_same_fallbacks(source)):
704
# check that last_revision is in 'from' and then return a
706
if (revision_id is not None and
707
not _mod_revision.is_null(revision_id)):
708
self.get_revision(revision_id)
710
inter = InterRepository.get(source, self)
711
return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
713
def create_bundle(self, target, base, fileobj, format=None):
714
return serializer.write_bundle(self, target, base, fileobj, format)
716
def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
717
timezone=None, committer=None, revprops=None,
718
revision_id=None, lossy=False):
719
"""Obtain a CommitBuilder for this repository.
721
:param branch: Branch to commit to.
722
:param parents: Revision ids of the parents of the new revision.
723
:param config_stack: Configuration stack to use.
724
:param timestamp: Optional timestamp recorded for commit.
725
:param timezone: Optional timezone for timestamp.
726
:param committer: Optional committer to set for commit.
727
:param revprops: Optional dictionary of revision properties.
728
:param revision_id: Optional revision id.
729
:param lossy: Whether to discard data that can not be natively
730
represented, when pushing to a foreign VCS
732
raise NotImplementedError(self.get_commit_builder)
734
@only_raises(errors.LockNotHeld, errors.LockBroken)
117
735
def unlock(self):
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.')
118
743
self.control_files.unlock()
120
def copy(self, destination):
121
destination.control_weaves.copy_multi(self.control_weaves,
123
copy_all(self.weave_store, destination.weave_store)
124
copy_all(self.revision_store, destination.revision_store)
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()
126
817
def has_revision(self, revision_id):
127
"""True if this branch has a copy of the revision.
129
This does not necessarily imply the revision is merge
130
or on the mainline."""
131
return (revision_id is None
132
or self.revision_store.has_id(revision_id))
135
def get_revision_xml_file(self, revision_id):
136
"""Return XML file object for revision object."""
137
if not revision_id or not isinstance(revision_id, basestring):
138
raise InvalidRevisionId(revision_id=revision_id, branch=self)
140
return self.revision_store.get(revision_id)
141
except (IndexError, KeyError):
142
raise bzrlib.errors.NoSuchRevision(self, revision_id)
144
def get_revision_xml(self, revision_id):
145
return self.get_revision_xml_file(revision_id).read()
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)
147
831
def get_revision(self, revision_id):
148
"""Return the Revision object for a named revision"""
149
xml_file = self.get_revision_xml_file(revision_id)
152
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
153
except SyntaxError, e:
154
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
158
assert r.revision_id == revision_id
161
def get_revision_sha1(self, revision_id):
162
"""Hash the stored value of a revision, and return it."""
163
# In the future, revision entries will be signed. At that
164
# point, it is probably best *not* to include the signature
165
# in the revision hash. Because that lets you re-sign
166
# the revision, (add signatures/remove signatures) and still
167
# have all hash pointers stay consistent.
168
# But for now, just hash the contents.
169
return bzrlib.osutils.sha_file(self.get_revision_xml_file(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]
171
907
@needs_write_lock
172
908
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
173
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
176
def get_inventory_weave(self):
177
return self.control_weaves.get_weave('inventory',
178
self.get_transaction())
180
def get_inventory(self, revision_id):
181
"""Get Inventory object by hash."""
182
xml = self.get_inventory_xml(revision_id)
183
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
185
def get_inventory_xml(self, revision_id):
186
"""Get inventory XML as a file object."""
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))
188
assert isinstance(revision_id, basestring), type(revision_id)
189
iw = self.get_inventory_weave()
190
return iw.get_text(iw.lookup(revision_id))
192
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
194
def get_inventory_sha1(self, revision_id):
195
"""Return the sha1 hash of the inventory entry
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])
985
"""Return True if this repository is flagged as a shared repository."""
986
raise NotImplementedError(self.is_shared)
989
def reconcile(self, other=None, thorough=False):
990
"""Reconcile this repository."""
991
from bzrlib.reconcile import RepoReconciler
992
reconciler = RepoReconciler(self, thorough=thorough)
993
reconciler.reconcile()
996
def _refresh_data(self):
997
"""Helper called from lock_* to ensure coherency with disk.
999
The default implementation does nothing; it is however possible
1000
for repositories to maintain loaded indices across multiple locks
1001
by checking inside their implementation of this method to see
1002
whether their indices are still valid. This depends of course on
1003
the disk format being validatable in this manner. This method is
1004
also called by the refresh_data() public interface to cause a refresh
1005
to occur while in a write lock so that data inserted by a smart server
1006
push operation is visible on the client's instance of the physical
197
return self.get_revision(revision_id).inventory_sha1
199
def get_revision_inventory(self, revision_id):
200
"""Return inventory of a past revision."""
201
# TODO: Unify this with get_inventory()
202
# bzr 0.0.6 and later imposes the constraint that the inventory_id
203
# must be the same as its revision, so this is trivial.
204
if revision_id == None:
205
# This does not make sense: if there is no revision,
206
# then it is the current tree inventory surely ?!
207
# and thus get_root_id() is something that looks at the last
208
# commit on the branch, and the get_root_id is an inventory check.
209
raise NotImplementedError
210
# return Inventory(self.get_root_id())
212
return self.get_inventory(revision_id)
214
1011
def revision_tree(self, revision_id):
215
1012
"""Return Tree for a revision on this branch.
217
`revision_id` may be None for the null revision, in which case
218
an `EmptyTree` is returned."""
219
# TODO: refactor this to use an existing revision object
220
# so we don't need to read it in twice.
221
if revision_id == None or revision_id == NULL_REVISION:
224
inv = self.get_revision_inventory(revision_id)
225
return RevisionTree(self, inv, revision_id)
227
def get_ancestry(self, revision_id):
228
"""Return a list of revision-ids integrated by a revision.
230
This is topologically sorted.
232
if revision_id is None:
234
w = self.get_inventory_weave()
235
return [None] + map(w.idx_to_name,
236
w.inclusions([w.lookup(revision_id)]))
239
def print_file(self, file, revision_id):
240
"""Print `file` to stdout."""
241
tree = self.revision_tree(revision_id)
242
# use inventory as it was in that revision
243
file_id = tree.inventory.path2id(file)
245
raise BzrError("%r is not present in revision %s" % (file, revno))
247
revno = self.revision_id_to_revno(revision_id)
248
except errors.NoSuchRevision:
249
# TODO: This should not be BzrError,
250
# but NoSuchFile doesn't fit either
251
raise BzrError('%r is not present in revision %s'
252
% (file, revision_id))
254
raise BzrError('%r is not present in revision %s'
256
tree.print_file(file_id)
1014
`revision_id` may be NULL_REVISION for the empty tree revision.
1016
raise NotImplementedError(self.revision_tree)
1018
def revision_trees(self, revision_ids):
1019
"""Return Trees for revisions in this repository.
1021
:param revision_ids: a sequence of revision-ids;
1022
a revision-id may not be None or 'null:'
1024
raise NotImplementedError(self.revision_trees)
1026
def pack(self, hint=None, clean_obsolete_packs=False):
1027
"""Compress the data within the repository.
1029
This operation only makes sense for some repository types. For other
1030
types it should be a no-op that just returns.
1032
This stub method does not require a lock, but subclasses should use
1033
@needs_write_lock as this is a long running call it's reasonable to
1034
implicitly lock for the user.
1036
:param hint: If not supplied, the whole repository is packed.
1037
If supplied, the repository may use the hint parameter as a
1038
hint for the parts of the repository to pack. A hint can be
1039
obtained from the result of commit_write_group(). Out of
1040
date hints are simply ignored, because concurrent operations
1041
can obsolete them rapidly.
1043
:param clean_obsolete_packs: Clean obsolete packs immediately after
258
1047
def get_transaction(self):
259
1048
return self.control_files.get_transaction()
1050
def get_parent_map(self, revision_ids):
1051
"""See graph.StackedParentsProvider.get_parent_map"""
1052
raise NotImplementedError(self.get_parent_map)
1054
def _get_parent_map_no_fallbacks(self, revision_ids):
1055
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1056
# revisions index works in keys; this just works in revisions
1057
# therefore wrap and unwrap
1060
for revision_id in revision_ids:
1061
if revision_id == _mod_revision.NULL_REVISION:
1062
result[revision_id] = ()
1063
elif revision_id is None:
1064
raise ValueError('get_parent_map(None) is not valid')
1066
query_keys.append((revision_id ,))
1067
vf = self.revisions.without_fallbacks()
1068
for ((revision_id,), parent_keys) in \
1069
vf.get_parent_map(query_keys).iteritems():
1071
result[revision_id] = tuple([parent_revid
1072
for (parent_revid,) in parent_keys])
1074
result[revision_id] = (_mod_revision.NULL_REVISION,)
1077
def _make_parents_provider(self):
1078
if not self._format.supports_external_lookups:
1080
return graph.StackedParentsProvider(_LazyListJoin(
1081
[self._make_parents_provider_unstacked()],
1082
self._fallback_repositories))
1084
def _make_parents_provider_unstacked(self):
1085
return graph.CallableToParentsProviderAdapter(
1086
self._get_parent_map_no_fallbacks)
1089
def get_known_graph_ancestry(self, revision_ids):
1090
"""Return the known graph for a set of revision ids and their ancestors.
1092
raise NotImplementedError(self.get_known_graph_ancestry)
1094
def get_file_graph(self):
1095
"""Return the graph walker for files."""
1096
raise NotImplementedError(self.get_file_graph)
1098
def get_graph(self, other_repository=None):
1099
"""Return the graph walker for this repository format"""
1100
parents_provider = self._make_parents_provider()
1101
if (other_repository is not None and
1102
not self.has_same_location(other_repository)):
1103
parents_provider = graph.StackedParentsProvider(
1104
[parents_provider, other_repository._make_parents_provider()])
1105
return graph.Graph(parents_provider)
1108
def set_make_working_trees(self, new_value):
1109
"""Set the policy flag for making working trees when creating branches.
1111
This only applies to branches that use this repository.
1113
The default is 'True'.
1114
:param new_value: True to restore the default, False to disable making
1117
raise NotImplementedError(self.set_make_working_trees)
1119
def make_working_trees(self):
1120
"""Returns the policy for making working trees on new branches."""
1121
raise NotImplementedError(self.make_working_trees)
261
1124
def sign_revision(self, revision_id, gpg_strategy):
262
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1125
testament = _mod_testament.Testament.from_revision(self, revision_id)
1126
plaintext = testament.as_short_text()
263
1127
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1130
def verify_revision_signature(self, revision_id, gpg_strategy):
1131
"""Verify the signature on a revision.
1133
:param revision_id: the revision to verify
1134
:gpg_strategy: the GPGStrategy object to used
1136
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1138
if not self.has_signature_for_revision_id(revision_id):
1139
return gpg.SIGNATURE_NOT_SIGNED, None
1140
signature = self.get_signature_text(revision_id)
1142
testament = _mod_testament.Testament.from_revision(self, revision_id)
1143
plaintext = testament.as_short_text()
1145
return gpg_strategy.verify(signature, plaintext)
1148
def verify_revision_signatures(self, revision_ids, gpg_strategy):
1149
"""Verify revision signatures for a number of revisions.
1151
:param revision_id: the revision to verify
1152
:gpg_strategy: the GPGStrategy object to used
1153
:return: Iterator over tuples with revision id, result and keys
1155
for revid in revision_ids:
1156
(result, key) = self.verify_revision_signature(revid, gpg_strategy)
1157
yield revid, result, key
1159
def has_signature_for_revision_id(self, revision_id):
1160
"""Query for a revision signature for revision_id in the repository."""
1161
raise NotImplementedError(self.has_signature_for_revision_id)
1163
def get_signature_text(self, revision_id):
1164
"""Return the text for a signature."""
1165
raise NotImplementedError(self.get_signature_text)
1167
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1168
"""Check consistency of all history of given revision_ids.
1170
Different repository implementations should override _check().
1172
:param revision_ids: A non-empty list of revision_ids whose ancestry
1173
will be checked. Typically the last revision_id of a branch.
1174
:param callback_refs: A dict of check-refs to resolve and callback
1175
the check/_check method on the items listed as wanting the ref.
1177
:param check_repo: If False do not check the repository contents, just
1178
calculate the data callback_refs requires and call them back.
1180
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1181
check_repo=check_repo)
1183
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1184
raise NotImplementedError(self.check)
1186
def _warn_if_deprecated(self, branch=None):
1187
if not self._format.is_deprecated():
1189
global _deprecation_warning_done
1190
if _deprecation_warning_done:
1194
conf = config.GlobalStack()
1196
conf = branch.get_config_stack()
1197
if 'format_deprecation' in conf.get('suppress_warnings'):
1199
warning("Format %s for %s is deprecated -"
1200
" please use 'bzr upgrade' to get better performance"
1201
% (self._format, self.bzrdir.transport.base))
1203
_deprecation_warning_done = True
1205
def supports_rich_root(self):
1206
return self._format.rich_root_data
1208
def _check_ascii_revisionid(self, revision_id, method):
1209
"""Private helper for ascii-only repositories."""
1210
# weave repositories refuse to store revisionids that are non-ascii.
1211
if revision_id is not None:
1212
# weaves require ascii revision ids.
1213
if isinstance(revision_id, unicode):
1215
revision_id.encode('ascii')
1216
except UnicodeEncodeError:
1217
raise errors.NonAsciiRevisionId(method, self)
1220
revision_id.decode('ascii')
1221
except UnicodeDecodeError:
1222
raise errors.NonAsciiRevisionId(method, self)
1225
class MetaDirRepository(Repository):
1226
"""Repositories in the new meta-dir layout.
1228
:ivar _transport: Transport for access to repository control files,
1229
typically pointing to .bzr/repository.
1232
def __init__(self, _format, a_bzrdir, control_files):
1233
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1234
self._transport = control_files._transport
1236
def is_shared(self):
1237
"""Return True if this repository is flagged as a shared repository."""
1238
return self._transport.has('shared-storage')
1241
def set_make_working_trees(self, new_value):
1242
"""Set the policy flag for making working trees when creating branches.
1244
This only applies to branches that use this repository.
1246
The default is 'True'.
1247
:param new_value: True to restore the default, False to disable making
1252
self._transport.delete('no-working-trees')
1253
except errors.NoSuchFile:
1256
self._transport.put_bytes('no-working-trees', '',
1257
mode=self.bzrdir._get_file_mode())
1259
def make_working_trees(self):
1260
"""Returns the policy for making working trees on new branches."""
1261
return not self._transport.has('no-working-trees')
1264
def update_feature_flags(self, updated_flags):
1265
"""Update the feature flags for this branch.
1267
:param updated_flags: Dictionary mapping feature names to necessities
1268
A necessity can be None to indicate the feature should be removed
1270
self._format._update_feature_flags(updated_flags)
1271
self.control_transport.put_bytes('format', self._format.as_string())
1274
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1275
"""Repository format registry."""
1277
def get_default(self):
1278
"""Return the current default format."""
1279
return controldir.format_registry.make_bzrdir('default').repository_format
1282
network_format_registry = registry.FormatRegistry()
1283
"""Registry of formats indexed by their network name.
1285
The network name for a repository format is an identifier that can be used when
1286
referring to formats with smart server operations. See
1287
RepositoryFormat.network_name() for more detail.
1291
format_registry = RepositoryFormatRegistry(network_format_registry)
1292
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1294
This can contain either format instances themselves, or classes/factories that
1295
can be called to obtain one.
1299
#####################################################################
1300
# Repository Formats
1302
class RepositoryFormat(controldir.ControlComponentFormat):
1303
"""A repository format.
1305
Formats provide four things:
1306
* An initialization routine to construct repository data on disk.
1307
* a optional format string which is used when the BzrDir supports
1309
* an open routine which returns a Repository instance.
1310
* A network name for referring to the format in smart server RPC
1313
There is one and only one Format subclass for each on-disk format. But
1314
there can be one Repository subclass that is used for several different
1315
formats. The _format attribute on a Repository instance can be used to
1316
determine the disk format.
1318
Formats are placed in a registry by their format string for reference
1319
during opening. These should be subclasses of RepositoryFormat for
1322
Once a format is deprecated, just deprecate the initialize and open
1323
methods on the format class. Do not deprecate the object, as the
1324
object may be created even when a repository instance hasn't been
1327
Common instance attributes:
1328
_matchingbzrdir - the controldir format that the repository format was
1329
originally written to work with. This can be used if manually
1330
constructing a bzrdir and repository, or more commonly for test suite
1334
# Set to True or False in derived classes. True indicates that the format
1335
# supports ghosts gracefully.
1336
supports_ghosts = None
1337
# Can this repository be given external locations to lookup additional
1338
# data. Set to True or False in derived classes.
1339
supports_external_lookups = None
1340
# Does this format support CHK bytestring lookups. Set to True or False in
1342
supports_chks = None
1343
# Should fetch trigger a reconcile after the fetch? Only needed for
1344
# some repository formats that can suffer internal inconsistencies.
1345
_fetch_reconcile = False
1346
# Does this format have < O(tree_size) delta generation. Used to hint what
1347
# code path for commit, amongst other things.
1349
# Does doing a pack operation compress data? Useful for the pack UI command
1350
# (so if there is one pack, the operation can still proceed because it may
1351
# help), and for fetching when data won't have come from the same
1353
pack_compresses = False
1354
# Does the repository storage understand references to trees?
1355
supports_tree_reference = None
1356
# Is the format experimental ?
1357
experimental = False
1358
# Does this repository format escape funky characters, or does it create
1359
# files with similar names as the versioned files in its contents on disk
1361
supports_funky_characters = None
1362
# Does this repository format support leaving locks?
1363
supports_leaving_lock = None
1364
# Does this format support the full VersionedFiles interface?
1365
supports_full_versioned_files = None
1366
# Does this format support signing revision signatures?
1367
supports_revision_signatures = True
1368
# Can the revision graph have incorrect parents?
1369
revision_graph_can_have_wrong_parents = None
1370
# Does this format support rich root data?
1371
rich_root_data = None
1372
# Does this format support explicitly versioned directories?
1373
supports_versioned_directories = None
1374
# Can other repositories be nested into one of this format?
1375
supports_nesting_repositories = None
1376
# Is it possible for revisions to be present without being referenced
1378
supports_unreferenced_revisions = None
1381
return "%s()" % self.__class__.__name__
1383
def __eq__(self, other):
1384
# format objects are generally stateless
1385
return isinstance(other, self.__class__)
1387
def __ne__(self, other):
1388
return not self == other
1390
def get_format_description(self):
1391
"""Return the short description for this format."""
1392
raise NotImplementedError(self.get_format_description)
1394
def initialize(self, controldir, shared=False):
1395
"""Initialize a repository of this format in controldir.
1397
:param controldir: The controldir to put the new repository in it.
1398
:param shared: The repository should be initialized as a sharable one.
1399
:returns: The new repository object.
1401
This may raise UninitializableFormat if shared repository are not
1402
compatible the controldir.
1404
raise NotImplementedError(self.initialize)
1406
def is_supported(self):
1407
"""Is this format supported?
1409
Supported formats must be initializable and openable.
1410
Unsupported formats may not support initialization or committing or
1411
some other features depending on the reason for not being supported.
1415
def is_deprecated(self):
1416
"""Is this format deprecated?
1418
Deprecated formats may trigger a user-visible warning recommending
1419
the user to upgrade. They are still fully supported.
1423
def network_name(self):
1424
"""A simple byte string uniquely identifying this format for RPC calls.
1426
MetaDir repository formats use their disk format string to identify the
1427
repository over the wire. All in one formats such as bzr < 0.8, and
1428
foreign formats like svn/git and hg should use some marker which is
1429
unique and immutable.
1431
raise NotImplementedError(self.network_name)
1433
def check_conversion_target(self, target_format):
1434
if self.rich_root_data and not target_format.rich_root_data:
1435
raise errors.BadConversionTarget(
1436
'Does not support rich root data.', target_format,
1438
if (self.supports_tree_reference and
1439
not getattr(target_format, 'supports_tree_reference', False)):
1440
raise errors.BadConversionTarget(
1441
'Does not support nested trees', target_format,
1444
def open(self, controldir, _found=False):
1445
"""Return an instance of this format for a controldir.
1447
_found is a private parameter, do not use it.
1449
raise NotImplementedError(self.open)
1451
def _run_post_repo_init_hooks(self, repository, controldir, shared):
1452
from bzrlib.controldir import ControlDir, RepoInitHookParams
1453
hooks = ControlDir.hooks['post_repo_init']
1456
params = RepoInitHookParams(repository, self, controldir, shared)
1461
class RepositoryFormatMetaDir(bzrdir.BzrFormat, RepositoryFormat):
1462
"""Common base class for the new repositories using the metadir layout."""
1464
rich_root_data = False
1465
supports_tree_reference = False
1466
supports_external_lookups = False
1467
supports_leaving_lock = True
1468
supports_nesting_repositories = True
1471
def _matchingbzrdir(self):
1472
matching = bzrdir.BzrDirMetaFormat1()
1473
matching.repository_format = self
1477
RepositoryFormat.__init__(self)
1478
bzrdir.BzrFormat.__init__(self)
1480
def _create_control_files(self, a_bzrdir):
1481
"""Create the required files and the initial control_files object."""
1482
# FIXME: RBC 20060125 don't peek under the covers
1483
# NB: no need to escape relative paths that are url safe.
1484
repository_transport = a_bzrdir.get_repository_transport(self)
1485
control_files = lockable_files.LockableFiles(repository_transport,
1486
'lock', lockdir.LockDir)
1487
control_files.create_lock()
1488
return control_files
1490
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
1491
"""Upload the initial blank content."""
1492
control_files = self._create_control_files(a_bzrdir)
1493
control_files.lock_write()
1494
transport = control_files._transport
1496
utf8_files += [('shared-storage', '')]
1498
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1499
for (filename, content_stream) in files:
1500
transport.put_file(filename, content_stream,
1501
mode=a_bzrdir._get_file_mode())
1502
for (filename, content_bytes) in utf8_files:
1503
transport.put_bytes_non_atomic(filename, content_bytes,
1504
mode=a_bzrdir._get_file_mode())
1506
control_files.unlock()
1509
def find_format(klass, a_bzrdir):
1510
"""Return the format for the repository object in a_bzrdir.
1512
This is used by bzr native formats that have a "format" file in
1513
the repository. Other methods may be used by different types of
1517
transport = a_bzrdir.get_repository_transport(None)
1518
format_string = transport.get_bytes("format")
1519
except errors.NoSuchFile:
1520
raise errors.NoRepositoryPresent(a_bzrdir)
1521
return klass._find_format(format_registry, 'repository', format_string)
1523
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1525
RepositoryFormat.check_support_status(self,
1526
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1528
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1529
recommend_upgrade=recommend_upgrade, basedir=basedir)
1532
# formats which have no format string are not discoverable or independently
1533
# creatable on disk, so are not registered in format_registry. They're
1534
# all in bzrlib.repofmt.knitreponow. When an instance of one of these is
1535
# needed, it's constructed directly by the ControlDir. Non-native formats where
1536
# the repository is not separately opened are similar.
1538
format_registry.register_lazy(
1539
'Bazaar-NG Knit Repository Format 1',
1540
'bzrlib.repofmt.knitrepo',
1541
'RepositoryFormatKnit1',
1544
format_registry.register_lazy(
1545
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1546
'bzrlib.repofmt.knitrepo',
1547
'RepositoryFormatKnit3',
1550
format_registry.register_lazy(
1551
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1552
'bzrlib.repofmt.knitrepo',
1553
'RepositoryFormatKnit4',
1556
# Pack-based formats. There is one format for pre-subtrees, and one for
1557
# post-subtrees to allow ease of testing.
1558
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1559
format_registry.register_lazy(
1560
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1561
'bzrlib.repofmt.knitpack_repo',
1562
'RepositoryFormatKnitPack1',
1564
format_registry.register_lazy(
1565
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1566
'bzrlib.repofmt.knitpack_repo',
1567
'RepositoryFormatKnitPack3',
1569
format_registry.register_lazy(
1570
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1571
'bzrlib.repofmt.knitpack_repo',
1572
'RepositoryFormatKnitPack4',
1574
format_registry.register_lazy(
1575
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1576
'bzrlib.repofmt.knitpack_repo',
1577
'RepositoryFormatKnitPack5',
1579
format_registry.register_lazy(
1580
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1581
'bzrlib.repofmt.knitpack_repo',
1582
'RepositoryFormatKnitPack5RichRoot',
1584
format_registry.register_lazy(
1585
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1586
'bzrlib.repofmt.knitpack_repo',
1587
'RepositoryFormatKnitPack5RichRootBroken',
1589
format_registry.register_lazy(
1590
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1591
'bzrlib.repofmt.knitpack_repo',
1592
'RepositoryFormatKnitPack6',
1594
format_registry.register_lazy(
1595
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1596
'bzrlib.repofmt.knitpack_repo',
1597
'RepositoryFormatKnitPack6RichRoot',
1599
format_registry.register_lazy(
1600
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1601
'bzrlib.repofmt.groupcompress_repo',
1602
'RepositoryFormat2a',
1605
# Development formats.
1606
# Check their docstrings to see if/when they are obsolete.
1607
format_registry.register_lazy(
1608
("Bazaar development format 2 with subtree support "
1609
"(needs bzr.dev from before 1.8)\n"),
1610
'bzrlib.repofmt.knitpack_repo',
1611
'RepositoryFormatPackDevelopment2Subtree',
1613
format_registry.register_lazy(
1614
'Bazaar development format 8\n',
1615
'bzrlib.repofmt.groupcompress_repo',
1616
'RepositoryFormat2aSubtree',
1620
class InterRepository(InterObject):
1621
"""This class represents operations taking place between two repositories.
1623
Its instances have methods like copy_content and fetch, and contain
1624
references to the source and target repositories these operations can be
1627
Often we will provide convenience methods on 'repository' which carry out
1628
operations with another repository - they will always forward to
1629
InterRepository.get(other).method_name(parameters).
1633
"""The available optimised InterRepository types."""
1636
def copy_content(self, revision_id=None):
1637
"""Make a complete copy of the content in self into destination.
1639
This is a destructive operation! Do not use it on existing
1642
:param revision_id: Only copy the content needed to construct
1643
revision_id and its parents.
1646
self.target.set_make_working_trees(self.source.make_working_trees())
1647
except NotImplementedError:
1649
self.target.fetch(self.source, revision_id=revision_id)
1652
def fetch(self, revision_id=None, find_ghosts=False):
1653
"""Fetch the content required to construct revision_id.
1655
The content is copied from self.source to self.target.
1657
:param revision_id: if None all content is copied, if NULL_REVISION no
1661
raise NotImplementedError(self.fetch)
1664
def search_missing_revision_ids(self,
1665
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1666
find_ghosts=True, revision_ids=None, if_present_ids=None,
1668
"""Return the revision ids that source has that target does not.
1670
:param revision_id: only return revision ids included by this
1672
:param revision_ids: return revision ids included by these
1673
revision_ids. NoSuchRevision will be raised if any of these
1674
revisions are not present.
1675
:param if_present_ids: like revision_ids, but will not cause
1676
NoSuchRevision if any of these are absent, instead they will simply
1677
not be in the result. This is useful for e.g. finding revisions
1678
to fetch for tags, which may reference absent revisions.
1679
:param find_ghosts: If True find missing revisions in deep history
1680
rather than just finding the surface difference.
1681
:param limit: Maximum number of revisions to return, topologically
1683
:return: A bzrlib.graph.SearchResult.
1685
raise NotImplementedError(self.search_missing_revision_ids)
1688
def _same_model(source, target):
1689
"""True if source and target have the same data representation.
1691
Note: this is always called on the base class; overriding it in a
1692
subclass will have no effect.
1695
InterRepository._assert_same_model(source, target)
1697
except errors.IncompatibleRepositories, e:
1701
def _assert_same_model(source, target):
1702
"""Raise an exception if two repositories do not use the same model.
1704
if source.supports_rich_root() != target.supports_rich_root():
1705
raise errors.IncompatibleRepositories(source, target,
1706
"different rich-root support")
1707
if source._serializer != target._serializer:
1708
raise errors.IncompatibleRepositories(source, target,
1709
"different serializers")
1712
class CopyConverter(object):
1713
"""A repository conversion tool which just performs a copy of the content.
1715
This is slow but quite reliable.
1718
def __init__(self, target_format):
1719
"""Create a CopyConverter.
1721
:param target_format: The format the resulting repository should be.
1723
self.target_format = target_format
1725
def convert(self, repo, pb):
1726
"""Perform the conversion of to_convert, giving feedback via pb.
1728
:param to_convert: The disk object to convert.
1729
:param pb: a progress bar to use for progress information.
1731
pb = ui.ui_factory.nested_progress_bar()
1734
# this is only useful with metadir layouts - separated repo content.
1735
# trigger an assertion if not such
1736
repo._format.get_format_string()
1737
self.repo_dir = repo.bzrdir
1738
pb.update(gettext('Moving repository to repository.backup'))
1739
self.repo_dir.transport.move('repository', 'repository.backup')
1740
backup_transport = self.repo_dir.transport.clone('repository.backup')
1741
repo._format.check_conversion_target(self.target_format)
1742
self.source_repo = repo._format.open(self.repo_dir,
1744
_override_transport=backup_transport)
1745
pb.update(gettext('Creating new repository'))
1746
converted = self.target_format.initialize(self.repo_dir,
1747
self.source_repo.is_shared())
1748
converted.lock_write()
1750
pb.update(gettext('Copying content'))
1751
self.source_repo.copy_content_into(converted)
1754
pb.update(gettext('Deleting old repository content'))
1755
self.repo_dir.transport.delete_tree('repository.backup')
1756
ui.ui_factory.note(gettext('repository converted'))
1760
def _strip_NULL_ghosts(revision_graph):
1761
"""Also don't use this. more compatibility code for unmigrated clients."""
1762
# Filter ghosts, and null:
1763
if _mod_revision.NULL_REVISION in revision_graph:
1764
del revision_graph[_mod_revision.NULL_REVISION]
1765
for key, parents in revision_graph.items():
1766
revision_graph[key] = tuple(parent for parent in parents if parent
1768
return revision_graph
1771
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1772
stop_revision=None):
1773
"""Extend the partial history to include a given index
1775
If a stop_index is supplied, stop when that index has been reached.
1776
If a stop_revision is supplied, stop when that revision is
1777
encountered. Otherwise, stop when the beginning of history is
1780
:param stop_index: The index which should be present. When it is
1781
present, history extension will stop.
1782
:param stop_revision: The revision id which should be present. When
1783
it is encountered, history extension will stop.
1785
start_revision = partial_history_cache[-1]
1786
graph = repo.get_graph()
1787
iterator = graph.iter_lefthand_ancestry(start_revision,
1788
(_mod_revision.NULL_REVISION,))
1790
# skip the last revision in the list
1793
if (stop_index is not None and
1794
len(partial_history_cache) > stop_index):
1796
if partial_history_cache[-1] == stop_revision:
1798
revision_id = iterator.next()
1799
partial_history_cache.append(revision_id)
1800
except StopIteration:
1805
class _LazyListJoin(object):
1806
"""An iterable yielding the contents of many lists as one list.
1808
Each iterator made from this will reflect the current contents of the lists
1809
at the time the iterator is made.
1811
This is used by Repository's _make_parents_provider implementation so that
1814
pp = repo._make_parents_provider() # uses a list of fallback repos
1815
pp.add_fallback_repository(other_repo) # appends to that list
1816
result = pp.get_parent_map(...)
1817
# The result will include revs from other_repo
1820
def __init__(self, *list_parts):
1821
self.list_parts = list_parts
1825
for list_part in self.list_parts:
1826
full_list.extend(list_part)
1827
return iter(full_list)
1830
return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
added
removed
bzrlib/repository.py
