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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
17
19
from bzrlib.lazy_import import lazy_import
18
20
lazy_import(globals(), """
22
24
from bzrlib import (
32
38
revision as _mod_revision,
33
testament as _mod_testament,
37
43
from bzrlib.bundle import serializer
44
from bzrlib.revisiontree import RevisionTree
45
from bzrlib.store.versioned import VersionedFileStore
46
from bzrlib.store.text import TextStore
47
from bzrlib.testament import Testament
46
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
52
from bzrlib.inter import InterObject
48
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
49
from bzrlib.trace import (
50
log_exception_quietly, note, mutter, mutter_callsite, warning)
53
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, note, warning
53
61
# Old formats display a warning, but only once
54
62
_deprecation_warning_done = False
57
class IsInWriteGroupError(errors.InternalBzrError):
59
_fmt = "May not refresh_data of repo %(repo)s while in a write group."
61
def __init__(self, repo):
62
errors.InternalBzrError.__init__(self, repo=repo)
65
class CommitBuilder(object):
66
"""Provides an interface to build up a commit.
68
This allows describing a tree to be committed without needing to
69
know the internals of the format of the repository.
72
# all clients should supply tree roots.
73
record_root_entry = True
74
# whether this commit builder supports the record_entry_contents interface
75
supports_record_entry_contents = False
77
def __init__(self, repository, parents, config, timestamp=None,
78
timezone=None, committer=None, revprops=None,
79
revision_id=None, lossy=False):
80
"""Initiate a CommitBuilder.
82
:param repository: Repository to commit to.
83
:param parents: Revision ids of the parents of the new revision.
84
:param timestamp: Optional timestamp recorded for commit.
85
:param timezone: Optional timezone for timestamp.
86
:param committer: Optional committer to set for commit.
87
:param revprops: Optional dictionary of revision properties.
88
:param revision_id: Optional revision id.
89
:param lossy: Whether to discard data that can not be natively
90
represented, when pushing to a foreign VCS
96
self._committer = self._config.username()
97
elif not isinstance(committer, unicode):
98
self._committer = committer.decode() # throw if non-ascii
100
self._committer = committer
102
self._new_revision_id = revision_id
103
self.parents = parents
104
self.repository = repository
107
if revprops is not None:
108
self._validate_revprops(revprops)
109
self._revprops.update(revprops)
111
if timestamp is None:
112
timestamp = time.time()
113
# Restrict resolution to 1ms
114
self._timestamp = round(timestamp, 3)
117
self._timezone = osutils.local_time_offset()
119
self._timezone = int(timezone)
121
self._generate_revision_if_needed()
123
def any_changes(self):
124
"""Return True if any entries were changed.
126
This includes merge-only changes. It is the core for the --unchanged
129
:return: True if any changes have occured.
131
raise NotImplementedError(self.any_changes)
133
def _validate_unicode_text(self, text, context):
134
"""Verify things like commit messages don't have bogus characters."""
136
raise ValueError('Invalid value for %s: %r' % (context, text))
138
def _validate_revprops(self, revprops):
139
for key, value in revprops.iteritems():
140
# We know that the XML serializers do not round trip '\r'
141
# correctly, so refuse to accept them
142
if not isinstance(value, basestring):
143
raise ValueError('revision property (%s) is not a valid'
144
' (unicode) string: %r' % (key, value))
145
self._validate_unicode_text(value,
146
'revision property (%s)' % (key,))
148
def commit(self, message):
149
"""Make the actual commit.
151
:return: The revision id of the recorded revision.
153
raise NotImplementedError(self.commit)
156
"""Abort the commit that is being built.
158
raise NotImplementedError(self.abort)
160
def revision_tree(self):
161
"""Return the tree that was just committed.
163
After calling commit() this can be called to get a
164
RevisionTree representing the newly committed tree. This is
165
preferred to calling Repository.revision_tree() because that may
166
require deserializing the inventory, while we already have a copy in
169
raise NotImplementedError(self.revision_tree)
171
def finish_inventory(self):
172
"""Tell the builder that the inventory is finished.
174
:return: The inventory id in the repository, which can be used with
175
repository.get_inventory.
177
raise NotImplementedError(self.finish_inventory)
179
def _gen_revision_id(self):
180
"""Return new revision-id."""
181
return generate_ids.gen_revision_id(self._committer, self._timestamp)
183
def _generate_revision_if_needed(self):
184
"""Create a revision id if None was supplied.
186
If the repository can not support user-specified revision ids
187
they should override this function and raise CannotSetRevisionId
188
if _new_revision_id is not None.
190
:raises: CannotSetRevisionId
192
if self._new_revision_id is None:
193
self._new_revision_id = self._gen_revision_id()
194
self.random_revid = True
196
self.random_revid = False
198
def will_record_deletes(self):
199
"""Tell the commit builder that deletes are being notified.
201
This enables the accumulation of an inventory delta; for the resulting
202
commit to be valid, deletes against the basis MUST be recorded via
203
builder.record_delete().
205
raise NotImplementedError(self.will_record_deletes)
207
def record_iter_changes(self, tree, basis_revision_id, iter_changes):
208
"""Record a new tree via iter_changes.
210
:param tree: The tree to obtain text contents from for changed objects.
211
:param basis_revision_id: The revision id of the tree the iter_changes
212
has been generated against. Currently assumed to be the same
213
as self.parents[0] - if it is not, errors may occur.
214
:param iter_changes: An iter_changes iterator with the changes to apply
215
to basis_revision_id. The iterator must not include any items with
216
a current kind of None - missing items must be either filtered out
217
or errored-on beefore record_iter_changes sees the item.
218
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
221
raise NotImplementedError(self.record_iter_changes)
224
class RepositoryWriteLockResult(LogicalLockResult):
225
"""The result of write locking a repository.
227
:ivar repository_token: The token obtained from the underlying lock, or
229
:ivar unlock: A callable which will unlock the lock.
232
def __init__(self, unlock, repository_token):
233
LogicalLockResult.__init__(self, unlock)
234
self.repository_token = repository_token
237
return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
241
65
######################################################################
245
class Repository(_RelockDebugMixin, controldir.ControlComponent):
68
class Repository(object):
246
69
"""Repository holding history for one or more branches.
248
71
The repository holds and retrieves historical information including
249
72
revisions and file history. It's normally accessed only by the Branch,
250
73
which views a particular line of development through that history.
252
See VersionedFileRepository in bzrlib.vf_repository for the
253
base class for most Bazaar repositories.
75
The Repository builds on top of Stores and a Transport, which respectively
76
describe the disk data format and the way of accessing the (possibly
256
def abort_write_group(self, suppress_errors=False):
80
_file_ids_altered_regex = lazy_regex.lazy_compile(
81
r'file_id="(?P<file_id>[^"]+)"'
82
r'.*revision="(?P<revision_id>[^"]+)"'
85
def abort_write_group(self):
257
86
"""Commit the contents accrued within the current write group.
259
:param suppress_errors: if true, abort_write_group will catch and log
260
unexpected errors that happen during the abort, rather than
261
allowing them to propagate. Defaults to False.
263
88
:seealso: start_write_group.
265
90
if self._write_group is not self.get_transaction():
266
91
# has an unlock or relock occured ?
269
'(suppressed) mismatched lock context and write group. %r, %r',
270
self._write_group, self.get_transaction())
272
raise errors.BzrError(
273
'mismatched lock context and write group. %r, %r' %
274
(self._write_group, self.get_transaction()))
276
self._abort_write_group()
277
except Exception, exc:
278
self._write_group = None
279
if not suppress_errors:
281
mutter('abort_write_group failed')
282
log_exception_quietly()
283
note('bzr: ERROR (ignored): %s', exc)
92
raise errors.BzrError('mismatched lock context and write group.')
93
self._abort_write_group()
284
94
self._write_group = None
286
96
def _abort_write_group(self):
287
97
"""Template method for per-repository write group cleanup.
289
This is called during abort before the write group is considered to be
99
This is called during abort before the write group is considered to be
290
100
finished and should cleanup any internal state accrued during the write
291
101
group. There is no requirement that data handed to the repository be
292
102
*not* made available - this is not a rollback - but neither should any
299
def add_fallback_repository(self, repository):
300
"""Add a repository to use for looking up data not held locally.
302
:param repository: A repository.
304
raise NotImplementedError(self.add_fallback_repository)
306
def _check_fallback_repository(self, repository):
307
"""Check that this repository can fallback to repository safely.
309
Raise an error if not.
311
:param repository: A repository to fallback to.
313
return InterRepository._assert_same_model(self, repository)
110
def add_inventory(self, revision_id, inv, parents):
111
"""Add the inventory inv to the repository as revision_id.
113
:param parents: The revision ids of the parents that revision_id
114
is known to have and are in the repository already.
116
returns the sha1 of the serialized inventory.
118
revision_id = osutils.safe_revision_id(revision_id)
119
_mod_revision.check_not_reserved_id(revision_id)
120
assert inv.revision_id is None or inv.revision_id == revision_id, \
121
"Mismatch between inventory revision" \
122
" id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
123
assert inv.root is not None
124
inv_text = self.serialise_inventory(inv)
125
inv_sha1 = osutils.sha_string(inv_text)
126
inv_vf = self.control_weaves.get_weave('inventory',
127
self.get_transaction())
128
self._inventory_add_lines(inv_vf, revision_id, parents,
129
osutils.split_lines(inv_text))
132
def _inventory_add_lines(self, inv_vf, revision_id, parents, lines):
134
for parent in parents:
136
final_parents.append(parent)
138
inv_vf.add_lines(revision_id, final_parents, lines)
141
def add_revision(self, revision_id, rev, inv=None, config=None):
142
"""Add rev to the revision store as revision_id.
144
:param revision_id: the revision id to use.
145
:param rev: The revision object.
146
:param inv: The inventory for the revision. if None, it will be looked
147
up in the inventory storer
148
:param config: If None no digital signature will be created.
149
If supplied its signature_needed method will be used
150
to determine if a signature should be made.
152
revision_id = osutils.safe_revision_id(revision_id)
153
# TODO: jam 20070210 Shouldn't we check rev.revision_id and
155
_mod_revision.check_not_reserved_id(revision_id)
156
if config is not None and config.signature_needed():
158
inv = self.get_inventory(revision_id)
159
plaintext = Testament(rev, inv).as_short_text()
160
self.store_revision_signature(
161
gpg.GPGStrategy(config), plaintext, revision_id)
162
if not revision_id in self.get_inventory_weave():
164
raise errors.WeaveRevisionNotPresent(revision_id,
165
self.get_inventory_weave())
167
# yes, this is not suitable for adding with ghosts.
168
self.add_inventory(revision_id, inv, rev.parent_ids)
169
self._revision_store.add_revision(rev, self.get_transaction())
171
def _add_revision_text(self, revision_id, text):
172
revision = self._revision_store._serializer.read_revision_from_string(
174
self._revision_store._add_revision(revision, StringIO(text),
175
self.get_transaction())
178
def _all_possible_ids(self):
179
"""Return all the possible revisions that we could find."""
180
return self.get_inventory_weave().versions()
315
182
def all_revision_ids(self):
316
"""Returns a list of all the revision ids in the repository.
183
"""Returns a list of all the revision ids in the repository.
318
This is conceptually deprecated because code should generally work on
319
the graph reachable from a particular revision, and ignore any other
320
revisions that might be present. There is no direct replacement
185
This is deprecated because code should generally work on the graph
186
reachable from a particular revision, and ignore any other revisions
187
that might be present. There is no direct replacement method.
323
if 'evil' in debug.debug_flags:
324
mutter_callsite(2, "all_revision_ids is linear with history.")
325
189
return self._all_revision_ids()
327
192
def _all_revision_ids(self):
328
"""Returns a list of all the revision ids in the repository.
193
"""Returns a list of all the revision ids in the repository.
330
These are in as much topological order as the underlying store can
195
These are in as much topological order as the underlying store can
196
present: for weaves ghosts may lead to a lack of correctness until
197
the reweave updates the parents list.
333
raise NotImplementedError(self._all_revision_ids)
199
if self._revision_store.text_store.listable():
200
return self._revision_store.all_revision_ids(self.get_transaction())
201
result = self._all_possible_ids()
202
# TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
203
# ids. (It should, since _revision_store's API should change to
204
# return utf8 revision_ids)
205
return self._eliminate_revisions_not_present(result)
335
207
def break_lock(self):
336
208
"""Break a lock if one is present from another instance.
621
405
def copy_content_into(self, destination, revision_id=None):
622
406
"""Make a complete copy of the content in self into destination.
624
This is a destructive operation! Do not use it on existing
408
This is a destructive operation! Do not use it on existing
411
revision_id = osutils.safe_revision_id(revision_id)
627
412
return InterRepository.get(self, destination).copy_content(revision_id)
629
414
def commit_write_group(self):
630
415
"""Commit the contents accrued within the current write group.
632
417
:seealso: start_write_group.
634
:return: it may return an opaque hint that can be passed to 'pack'.
636
419
if self._write_group is not self.get_transaction():
637
420
# has an unlock or relock occured ?
638
raise errors.BzrError('mismatched lock context %r and '
640
(self.get_transaction(), self._write_group))
641
result = self._commit_write_group()
421
raise errors.BzrError('mismatched lock context and write group.')
422
self._commit_write_group()
642
423
self._write_group = None
645
425
def _commit_write_group(self):
646
426
"""Template method for per-repository write group cleanup.
648
This is called before the write group is considered to be
428
This is called before the write group is considered to be
649
429
finished and should ensure that all data handed to the repository
650
for writing during the write group is safely committed (to the
430
for writing during the write group is safely committed (to the
651
431
extent possible considering file system caching etc).
654
def suspend_write_group(self):
655
raise errors.UnsuspendableWriteGroup(self)
657
def refresh_data(self):
658
"""Re-read any data needed to synchronise with disk.
660
This method is intended to be called after another repository instance
661
(such as one used by a smart server) has inserted data into the
662
repository. On all repositories this will work outside of write groups.
663
Some repository formats (pack and newer for bzrlib native formats)
664
support refresh_data inside write groups. If called inside a write
665
group on a repository that does not support refreshing in a write group
666
IsInWriteGroupError will be raised.
670
def resume_write_group(self, tokens):
671
if not self.is_write_locked():
672
raise errors.NotWriteLocked(self)
673
if self._write_group:
674
raise errors.BzrError('already in a write group')
675
self._resume_write_group(tokens)
676
# so we can detect unlock/relock - the write group is now entered.
677
self._write_group = self.get_transaction()
679
def _resume_write_group(self, tokens):
680
raise errors.UnsuspendableWriteGroup(self)
682
def fetch(self, source, revision_id=None, find_ghosts=False,
434
def fetch(self, source, revision_id=None, pb=None):
684
435
"""Fetch the content required to construct revision_id from source.
686
If revision_id is None and fetch_spec is None, then all content is
689
fetch() may not be used when the repository is in a write group -
690
either finish the current write group before using fetch, or use
691
fetch before starting the write group.
693
:param find_ghosts: Find and copy revisions in the source that are
694
ghosts in the target (and not reachable directly by walking out to
695
the first-present revision in target from revision_id).
696
:param revision_id: If specified, all the content needed for this
697
revision ID will be copied to the target. Fetch will determine for
698
itself which content needs to be copied.
699
:param fetch_spec: If specified, a SearchResult or
700
PendingAncestryResult that describes which revisions to copy. This
701
allows copying multiple heads at once. Mutually exclusive with
437
If revision_id is None all content is copied.
704
if fetch_spec is not None and revision_id is not None:
705
raise AssertionError(
706
"fetch_spec and revision_id are mutually exclusive.")
707
if self.is_in_write_group():
708
raise errors.InternalBzrError(
709
"May not fetch while in a write group.")
710
# fast path same-url fetch operations
711
# TODO: lift out to somewhere common with RemoteRepository
712
# <https://bugs.launchpad.net/bzr/+bug/401646>
713
if (self.has_same_location(source)
714
and fetch_spec is None
715
and self._has_same_fallbacks(source)):
716
# check that last_revision is in 'from' and then return a
718
if (revision_id is not None and
719
not _mod_revision.is_null(revision_id)):
720
self.get_revision(revision_id)
439
revision_id = osutils.safe_revision_id(revision_id)
722
440
inter = InterRepository.get(source, self)
723
return inter.fetch(revision_id=revision_id,
724
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
442
return inter.fetch(revision_id=revision_id, pb=pb)
443
except NotImplementedError:
444
raise errors.IncompatibleRepositories(source, self)
726
446
def create_bundle(self, target, base, fileobj, format=None):
727
447
return serializer.write_bundle(self, target, base, fileobj, format)
729
def get_commit_builder(self, branch, parents, config, timestamp=None,
730
timezone=None, committer=None, revprops=None,
731
revision_id=None, lossy=False):
449
def get_commit_builder(self, branch, parents, config, timestamp=None,
450
timezone=None, committer=None, revprops=None,
732
452
"""Obtain a CommitBuilder for this repository.
734
454
:param branch: Branch to commit to.
735
455
:param parents: Revision ids of the parents of the new revision.
736
456
:param config: Configuration to use.
829
545
def has_revision(self, revision_id):
830
546
"""True if this repository has a copy of the revision."""
831
return revision_id in self.has_revisions((revision_id,))
834
def has_revisions(self, revision_ids):
835
"""Probe to find out the presence of multiple revisions.
837
:param revision_ids: An iterable of revision_ids.
838
:return: A set of the revision_ids that were present.
840
raise NotImplementedError(self.has_revisions)
843
def get_revision(self, revision_id):
844
"""Return the Revision object for a named revision."""
845
return self.get_revisions([revision_id])[0]
547
revision_id = osutils.safe_revision_id(revision_id)
548
return self._revision_store.has_revision_id(revision_id,
549
self.get_transaction())
847
552
def get_revision_reconcile(self, revision_id):
848
553
"""'reconcile' helper routine that allows access to a revision always.
850
555
This variant of get_revision does not cross check the weave graph
851
556
against the revision one as get_revision does: but it should only
852
557
be used by reconcile, or reconcile-alike commands that are correcting
853
558
or testing the revision graph.
855
raise NotImplementedError(self.get_revision_reconcile)
560
if not revision_id or not isinstance(revision_id, basestring):
561
raise errors.InvalidRevisionId(revision_id=revision_id,
563
return self.get_revisions([revision_id])[0]
857
566
def get_revisions(self, revision_ids):
858
"""Get many revisions at once.
860
Repositories that need to check data on every revision read should
861
subclass this method.
863
raise NotImplementedError(self.get_revisions)
865
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
567
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
568
revs = self._revision_store.get_revisions(revision_ids,
569
self.get_transaction())
571
assert not isinstance(rev.revision_id, unicode)
572
for parent_id in rev.parent_ids:
573
assert not isinstance(parent_id, unicode)
577
def get_revision_xml(self, revision_id):
578
# TODO: jam 20070210 This shouldn't be necessary since get_revision
579
# would have already do it.
580
# TODO: jam 20070210 Just use _serializer.write_revision_to_string()
581
revision_id = osutils.safe_revision_id(revision_id)
582
rev = self.get_revision(revision_id)
584
# the current serializer..
585
self._revision_store._serializer.write_revision(rev, rev_tmp)
587
return rev_tmp.getvalue()
590
def get_revision(self, revision_id):
591
"""Return the Revision object for a named revision"""
592
# TODO: jam 20070210 get_revision_reconcile should do this for us
593
revision_id = osutils.safe_revision_id(revision_id)
594
r = self.get_revision_reconcile(revision_id)
595
# weave corruption can lead to absent revision markers that should be
597
# the following test is reasonably cheap (it needs a single weave read)
598
# and the weave is cached in read transactions. In write transactions
599
# it is not cached but typically we only read a small number of
600
# revisions. For knits when they are introduced we will probably want
601
# to ensure that caching write transactions are in use.
602
inv = self.get_inventory_weave()
603
self._check_revision_parents(r, inv)
607
def get_deltas_for_revisions(self, revisions):
866
608
"""Produce a generator of revision deltas.
868
610
Note that the input is a sequence of REVISIONS, not revision_ids.
869
611
Trees will be held in memory until the generator exits.
870
612
Each delta is relative to the revision's lefthand predecessor.
872
:param specific_fileids: if not None, the result is filtered
873
so that only those file-ids, their parents and their
874
children are included.
876
# Get the revision-ids of interest
877
614
required_trees = set()
878
615
for revision in revisions:
879
616
required_trees.add(revision.revision_id)
880
617
required_trees.update(revision.parent_ids[:1])
882
# Get the matching filtered trees. Note that it's more
883
# efficient to pass filtered trees to changes_from() rather
884
# than doing the filtering afterwards. changes_from() could
885
# arguably do the filtering itself but it's path-based, not
886
# file-id based, so filtering before or afterwards is
888
if specific_fileids is None:
889
trees = dict((t.get_revision_id(), t) for
890
t in self.revision_trees(required_trees))
892
trees = dict((t.get_revision_id(), t) for
893
t in self._filtered_revision_trees(required_trees,
896
# Calculate the deltas
618
trees = dict((t.get_revision_id(), t) for
619
t in self.revision_trees(required_trees))
897
620
for revision in revisions:
898
621
if not revision.parent_ids:
899
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
622
old_tree = self.revision_tree(None)
901
624
old_tree = trees[revision.parent_ids[0]]
902
625
yield trees[revision.revision_id].changes_from(old_tree)
905
def get_revision_delta(self, revision_id, specific_fileids=None):
628
def get_revision_delta(self, revision_id):
906
629
"""Return the delta for one revision.
908
631
The delta is relative to the left-hand predecessor of the
911
:param specific_fileids: if not None, the result is filtered
912
so that only those file-ids, their parents and their
913
children are included.
915
634
r = self.get_revision(revision_id)
916
return list(self.get_deltas_for_revisions([r],
917
specific_fileids=specific_fileids))[0]
635
return list(self.get_deltas_for_revisions([r]))[0]
637
def _check_revision_parents(self, revision, inventory):
638
"""Private to Repository and Fetch.
640
This checks the parentage of revision in an inventory weave for
641
consistency and is only applicable to inventory-weave-for-ancestry
642
using repository formats & fetchers.
644
weave_parents = inventory.get_parents(revision.revision_id)
645
weave_names = inventory.versions()
646
for parent_id in revision.parent_ids:
647
if parent_id in weave_names:
648
# this parent must not be a ghost.
649
if not parent_id in weave_parents:
651
raise errors.CorruptRepository(self)
919
653
@needs_write_lock
920
654
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
655
revision_id = osutils.safe_revision_id(revision_id)
921
656
signature = gpg_strategy.sign(plaintext)
922
self.add_signature_text(revision_id, signature)
924
def add_signature_text(self, revision_id, signature):
925
"""Store a signature text for a revision.
927
:param revision_id: Revision id of the revision
928
:param signature: Signature text.
930
raise NotImplementedError(self.add_signature_text)
932
def _find_parent_ids_of_revisions(self, revision_ids):
933
"""Find all parent ids that are mentioned in the revision graph.
935
:return: set of revisions that are parents of revision_ids which are
936
not part of revision_ids themselves
938
parent_map = self.get_parent_map(revision_ids)
940
map(parent_ids.update, parent_map.itervalues())
941
parent_ids.difference_update(revision_ids)
942
parent_ids.discard(_mod_revision.NULL_REVISION)
657
self._revision_store.add_revision_signature_text(revision_id,
659
self.get_transaction())
945
661
def fileids_altered_by_revision_ids(self, revision_ids):
946
662
"""Find the file ids and versions affected by revisions.
948
664
:param revisions: an iterable containing revision ids.
949
665
:return: a dictionary mapping altered file-ids to an iterable of
950
revision_ids. Each altered file-ids has the exact revision_ids
951
that altered it listed explicitly.
953
raise NotImplementedError(self.fileids_altered_by_revision_ids)
955
def iter_files_bytes(self, desired_files):
956
"""Iterate through file versions.
958
Files will not necessarily be returned in the order they occur in
959
desired_files. No specific order is guaranteed.
961
Yields pairs of identifier, bytes_iterator. identifier is an opaque
962
value supplied by the caller as part of desired_files. It should
963
uniquely identify the file version in the caller's context. (Examples:
964
an index number or a TreeTransform trans_id.)
966
:param desired_files: a list of (file_id, revision_id, identifier)
969
raise NotImplementedError(self.iter_files_bytes)
971
def get_rev_id_for_revno(self, revno, known_pair):
972
"""Return the revision id of a revno, given a later (revno, revid)
973
pair in the same history.
975
:return: if found (True, revid). If the available history ran out
976
before reaching the revno, then this returns
977
(False, (closest_revno, closest_revid)).
979
known_revno, known_revid = known_pair
980
partial_history = [known_revid]
981
distance_from_known = known_revno - revno
982
if distance_from_known < 0:
984
'requested revno (%d) is later than given known revno (%d)'
985
% (revno, known_revno))
988
self, partial_history, stop_index=distance_from_known)
989
except errors.RevisionNotPresent, err:
990
if err.revision_id == known_revid:
991
# The start revision (known_revid) wasn't found.
993
# This is a stacked repository with no fallbacks, or a there's a
994
# left-hand ghost. Either way, even though the revision named in
995
# the error isn't in this repo, we know it's the next step in this
997
partial_history.append(err.revision_id)
998
if len(partial_history) <= distance_from_known:
999
# Didn't find enough history to get a revid for the revno.
1000
earliest_revno = known_revno - len(partial_history) + 1
1001
return (False, (earliest_revno, partial_history[-1]))
1002
if len(partial_history) - 1 > distance_from_known:
1003
raise AssertionError('_iter_for_revno returned too much history')
1004
return (True, partial_history[-1])
1006
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
666
revision_ids. Each altered file-ids has the exact revision_ids that
667
altered it listed explicitly.
669
assert self._serializer.support_altered_by_hack, \
670
("fileids_altered_by_revision_ids only supported for branches "
671
"which store inventory as unnested xml, not on %r" % self)
672
selected_revision_ids = set(osutils.safe_revision_id(r)
673
for r in revision_ids)
674
w = self.get_inventory_weave()
677
# this code needs to read every new line in every inventory for the
678
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
679
# not present in one of those inventories is unnecessary but not
680
# harmful because we are filtering by the revision id marker in the
681
# inventory lines : we only select file ids altered in one of those
682
# revisions. We don't need to see all lines in the inventory because
683
# only those added in an inventory in rev X can contain a revision=X
685
unescape_revid_cache = {}
686
unescape_fileid_cache = {}
688
# jam 20061218 In a big fetch, this handles hundreds of thousands
689
# of lines, so it has had a lot of inlining and optimizing done.
690
# Sorry that it is a little bit messy.
691
# Move several functions to be local variables, since this is a long
693
search = self._file_ids_altered_regex.search
694
unescape = _unescape_xml
695
setdefault = result.setdefault
696
pb = ui.ui_factory.nested_progress_bar()
698
for line in w.iter_lines_added_or_present_in_versions(
699
selected_revision_ids, pb=pb):
703
# One call to match.group() returning multiple items is quite a
704
# bit faster than 2 calls to match.group() each returning 1
705
file_id, revision_id = match.group('file_id', 'revision_id')
707
# Inlining the cache lookups helps a lot when you make 170,000
708
# lines and 350k ids, versus 8.4 unique ids.
709
# Using a cache helps in 2 ways:
710
# 1) Avoids unnecessary decoding calls
711
# 2) Re-uses cached strings, which helps in future set and
713
# (2) is enough that removing encoding entirely along with
714
# the cache (so we are using plain strings) results in no
715
# performance improvement.
717
revision_id = unescape_revid_cache[revision_id]
719
unescaped = unescape(revision_id)
720
unescape_revid_cache[revision_id] = unescaped
721
revision_id = unescaped
723
if revision_id in selected_revision_ids:
725
file_id = unescape_fileid_cache[file_id]
727
unescaped = unescape(file_id)
728
unescape_fileid_cache[file_id] = unescaped
730
setdefault(file_id, set()).add(revision_id)
736
def get_inventory_weave(self):
737
return self.control_weaves.get_weave('inventory',
738
self.get_transaction())
741
def get_inventory(self, revision_id):
742
"""Get Inventory object by hash."""
743
# TODO: jam 20070210 Technically we don't need to sanitize, since all
744
# called functions must sanitize.
745
revision_id = osutils.safe_revision_id(revision_id)
746
return self.deserialise_inventory(
747
revision_id, self.get_inventory_xml(revision_id))
749
def deserialise_inventory(self, revision_id, xml):
750
"""Transform the xml into an inventory object.
752
:param revision_id: The expected revision id of the inventory.
753
:param xml: A serialised inventory.
755
revision_id = osutils.safe_revision_id(revision_id)
756
result = self._serializer.read_inventory_from_string(xml)
757
result.root.revision = revision_id
760
def serialise_inventory(self, inv):
761
return self._serializer.write_inventory_to_string(inv)
763
def get_serializer_format(self):
764
return self._serializer.format_num
767
def get_inventory_xml(self, revision_id):
768
"""Get inventory XML as a file object."""
769
revision_id = osutils.safe_revision_id(revision_id)
771
assert isinstance(revision_id, str), type(revision_id)
772
iw = self.get_inventory_weave()
773
return iw.get_text(revision_id)
775
raise errors.HistoryMissing(self, 'inventory', revision_id)
778
def get_inventory_sha1(self, revision_id):
779
"""Return the sha1 hash of the inventory entry
781
# TODO: jam 20070210 Shouldn't this be deprecated / removed?
782
revision_id = osutils.safe_revision_id(revision_id)
783
return self.get_revision(revision_id).inventory_sha1
786
def get_revision_graph(self, revision_id=None):
787
"""Return a dictionary containing the revision graph.
789
:param revision_id: The revision_id to get a graph from. If None, then
790
the entire revision graph is returned. This is a deprecated mode of
791
operation and will be removed in the future.
792
:return: a dictionary of revision_id->revision_parents_list.
794
# special case NULL_REVISION
795
if revision_id == _mod_revision.NULL_REVISION:
797
revision_id = osutils.safe_revision_id(revision_id)
798
a_weave = self.get_inventory_weave()
799
all_revisions = self._eliminate_revisions_not_present(
801
entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for
802
node in all_revisions])
803
if revision_id is None:
805
elif revision_id not in entire_graph:
806
raise errors.NoSuchRevision(self, revision_id)
808
# add what can be reached from revision_id
810
pending = set([revision_id])
811
while len(pending) > 0:
813
result[node] = entire_graph[node]
814
for revision_id in result[node]:
815
if revision_id not in result:
816
pending.add(revision_id)
820
def get_revision_graph_with_ghosts(self, revision_ids=None):
821
"""Return a graph of the revisions with ghosts marked as applicable.
823
:param revision_ids: an iterable of revisions to graph or None for all.
824
:return: a Graph object with the graph reachable from revision_ids.
826
result = deprecated_graph.Graph()
828
pending = set(self.all_revision_ids())
831
pending = set(osutils.safe_revision_id(r) for r in revision_ids)
832
# special case NULL_REVISION
833
if _mod_revision.NULL_REVISION in pending:
834
pending.remove(_mod_revision.NULL_REVISION)
835
required = set(pending)
838
revision_id = pending.pop()
840
rev = self.get_revision(revision_id)
841
except errors.NoSuchRevision:
842
if revision_id in required:
845
result.add_ghost(revision_id)
847
for parent_id in rev.parent_ids:
848
# is this queued or done ?
849
if (parent_id not in pending and
850
parent_id not in done):
852
pending.add(parent_id)
853
result.add_node(revision_id, rev.parent_ids)
854
done.add(revision_id)
857
def _get_history_vf(self):
858
"""Get a versionedfile whose history graph reflects all revisions.
860
For weave repositories, this is the inventory weave.
862
return self.get_inventory_weave()
1007
864
def iter_reverse_revision_history(self, revision_id):
1008
865
"""Iterate backwards through revision ids in the lefthand history
1010
867
:param revision_id: The revision id to start with. All its lefthand
1011
868
ancestors will be traversed.
1013
graph = self.get_graph()
1014
stop_revisions = (None, _mod_revision.NULL_REVISION)
1015
return graph.iter_lefthand_ancestry(revision_id, stop_revisions)
870
revision_id = osutils.safe_revision_id(revision_id)
871
if revision_id in (None, _mod_revision.NULL_REVISION):
873
next_id = revision_id
874
versionedfile = self._get_history_vf()
877
parents = versionedfile.get_parents(next_id)
878
if len(parents) == 0:
884
def get_revision_inventory(self, revision_id):
885
"""Return inventory of a past revision."""
886
# TODO: Unify this with get_inventory()
887
# bzr 0.0.6 and later imposes the constraint that the inventory_id
888
# must be the same as its revision, so this is trivial.
889
if revision_id is None:
890
# This does not make sense: if there is no revision,
891
# then it is the current tree inventory surely ?!
892
# and thus get_root_id() is something that looks at the last
893
# commit on the branch, and the get_root_id is an inventory check.
894
raise NotImplementedError
895
# return Inventory(self.get_root_id())
897
return self.get_inventory(revision_id)
1017
900
def is_shared(self):
1018
901
"""Return True if this repository is flagged as a shared repository."""
1019
902
raise NotImplementedError(self.is_shared)
1033
916
for repositories to maintain loaded indices across multiple locks
1034
917
by checking inside their implementation of this method to see
1035
918
whether their indices are still valid. This depends of course on
1036
the disk format being validatable in this manner. This method is
1037
also called by the refresh_data() public interface to cause a refresh
1038
to occur while in a write lock so that data inserted by a smart server
1039
push operation is visible on the client's instance of the physical
919
the disk format being validatable in this manner.
1043
922
@needs_read_lock
1044
923
def revision_tree(self, revision_id):
1045
924
"""Return Tree for a revision on this branch.
1047
`revision_id` may be NULL_REVISION for the empty tree revision.
926
`revision_id` may be None for the empty tree revision.
1049
raise NotImplementedError(self.revision_tree)
928
# TODO: refactor this to use an existing revision object
929
# so we don't need to read it in twice.
930
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
931
return RevisionTree(self, Inventory(root_id=None),
932
_mod_revision.NULL_REVISION)
934
revision_id = osutils.safe_revision_id(revision_id)
935
inv = self.get_revision_inventory(revision_id)
936
return RevisionTree(self, inv, revision_id)
1051
939
def revision_trees(self, revision_ids):
1052
"""Return Trees for revisions in this repository.
940
"""Return Tree for a revision on this branch.
1054
:param revision_ids: a sequence of revision-ids;
1055
a revision-id may not be None or 'null:'
1057
raise NotImplementedError(self.revision_trees)
942
`revision_id` may not be None or 'null:'"""
943
assert None not in revision_ids
944
assert _mod_revision.NULL_REVISION not in revision_ids
945
texts = self.get_inventory_weave().get_texts(revision_ids)
946
for text, revision_id in zip(texts, revision_ids):
947
inv = self.deserialise_inventory(revision_id, text)
948
yield RevisionTree(self, inv, revision_id)
1059
950
@needs_read_lock
1060
@symbol_versioning.deprecated_method(
1061
symbol_versioning.deprecated_in((2, 4, 0)))
1062
951
def get_ancestry(self, revision_id, topo_sorted=True):
1063
952
"""Return a list of revision-ids integrated by a revision.
1065
The first element of the list is always None, indicating the origin
1066
revision. This might change when we have history horizons, or
954
The first element of the list is always None, indicating the origin
955
revision. This might change when we have history horizons, or
1067
956
perhaps we should have a new API.
1069
958
This is topologically sorted.
1071
if 'evil' in debug.debug_flags:
1072
mutter_callsite(2, "get_ancestry is linear with history.")
1073
960
if _mod_revision.is_null(revision_id):
962
revision_id = osutils.safe_revision_id(revision_id)
1075
963
if not self.has_revision(revision_id):
1076
964
raise errors.NoSuchRevision(self, revision_id)
1077
graph = self.get_graph()
1079
search = graph._make_breadth_first_searcher([revision_id])
1082
found, ghosts = search.next_with_ghosts()
1083
except StopIteration:
1086
if _mod_revision.NULL_REVISION in keys:
1087
keys.remove(_mod_revision.NULL_REVISION)
1089
parent_map = graph.get_parent_map(keys)
1090
keys = tsort.topo_sort(parent_map)
1091
return [None] + list(keys)
965
w = self.get_inventory_weave()
966
candidates = w.get_ancestry(revision_id, topo_sorted)
967
return [None] + candidates # self._eliminate_revisions_not_present(candidates)
1093
def pack(self, hint=None, clean_obsolete_packs=False):
1094
970
"""Compress the data within the repository.
1096
972
This operation only makes sense for some repository types. For other
1097
973
types it should be a no-op that just returns.
1099
975
This stub method does not require a lock, but subclasses should use
1100
@needs_write_lock as this is a long running call it's reasonable to
976
@needs_write_lock as this is a long running call its reasonable to
1101
977
implicitly lock for the user.
1103
:param hint: If not supplied, the whole repository is packed.
1104
If supplied, the repository may use the hint parameter as a
1105
hint for the parts of the repository to pack. A hint can be
1106
obtained from the result of commit_write_group(). Out of
1107
date hints are simply ignored, because concurrent operations
1108
can obsolete them rapidly.
1110
:param clean_obsolete_packs: Clean obsolete packs immediately after
981
def print_file(self, file, revision_id):
982
"""Print `file` to stdout.
984
FIXME RBC 20060125 as John Meinel points out this is a bad api
985
- it writes to stdout, it assumes that that is valid etc. Fix
986
by creating a new more flexible convenience function.
988
revision_id = osutils.safe_revision_id(revision_id)
989
tree = self.revision_tree(revision_id)
990
# use inventory as it was in that revision
991
file_id = tree.inventory.path2id(file)
993
# TODO: jam 20060427 Write a test for this code path
994
# it had a bug in it, and was raising the wrong
996
raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
997
tree.print_file(file_id)
1114
999
def get_transaction(self):
1115
1000
return self.control_files.get_transaction()
1117
def get_parent_map(self, revision_ids):
1118
"""See graph.StackedParentsProvider.get_parent_map"""
1119
raise NotImplementedError(self.get_parent_map)
1002
def revision_parents(self, revision_id):
1003
revision_id = osutils.safe_revision_id(revision_id)
1004
return self.get_inventory_weave().parent_names(revision_id)
1121
def _get_parent_map_no_fallbacks(self, revision_ids):
1122
"""Same as Repository.get_parent_map except doesn't query fallbacks."""
1123
# revisions index works in keys; this just works in revisions
1124
# therefore wrap and unwrap
1006
def get_parents(self, revision_ids):
1007
"""See StackedParentsProvider.get_parents"""
1127
1009
for revision_id in revision_ids:
1128
1010
if revision_id == _mod_revision.NULL_REVISION:
1129
result[revision_id] = ()
1130
elif revision_id is None:
1131
raise ValueError('get_parent_map(None) is not valid')
1133
query_keys.append((revision_id ,))
1134
vf = self.revisions.without_fallbacks()
1135
for ((revision_id,), parent_keys) in \
1136
vf.get_parent_map(query_keys).iteritems():
1138
result[revision_id] = tuple([parent_revid
1139
for (parent_revid,) in parent_keys])
1141
result[revision_id] = (_mod_revision.NULL_REVISION,)
1014
parents = self.get_revision(revision_id).parent_ids
1015
except errors.NoSuchRevision:
1018
if len(parents) == 0:
1019
parents = [_mod_revision.NULL_REVISION]
1020
parents_list.append(parents)
1144
1023
def _make_parents_provider(self):
1145
if not self._format.supports_external_lookups:
1147
return graph.StackedParentsProvider(_LazyListJoin(
1148
[self._make_parents_provider_unstacked()],
1149
self._fallback_repositories))
1151
def _make_parents_provider_unstacked(self):
1152
return graph.CallableToParentsProviderAdapter(
1153
self._get_parent_map_no_fallbacks)
1156
def get_known_graph_ancestry(self, revision_ids):
1157
"""Return the known graph for a set of revision ids and their ancestors.
1159
raise NotImplementedError(self.get_known_graph_ancestry)
1161
def get_file_graph(self):
1162
"""Return the graph walker for files."""
1163
raise NotImplementedError(self.get_file_graph)
1165
1026
def get_graph(self, other_repository=None):
1166
1027
"""Return the graph walker for this repository format"""
1167
1028
parents_provider = self._make_parents_provider()
1168
1029
if (other_repository is not None and
1169
not self.has_same_location(other_repository)):
1170
parents_provider = graph.StackedParentsProvider(
1030
other_repository.bzrdir.transport.base !=
1031
self.bzrdir.transport.base):
1032
parents_provider = graph._StackedParentsProvider(
1171
1033
[parents_provider, other_repository._make_parents_provider()])
1172
1034
return graph.Graph(parents_provider)
1174
def revision_ids_to_search_result(self, result_set):
1175
"""Convert a set of revision ids to a graph SearchResult."""
1176
result_parents = set()
1177
for parents in self.get_graph().get_parent_map(
1178
result_set).itervalues():
1179
result_parents.update(parents)
1180
included_keys = result_set.intersection(result_parents)
1181
start_keys = result_set.difference(included_keys)
1182
exclude_keys = result_parents.difference(result_set)
1183
result = graph.SearchResult(start_keys, exclude_keys,
1184
len(result_set), result_set)
1187
1036
@needs_write_lock
1188
1037
def set_make_working_trees(self, new_value):
1189
1038
"""Set the policy flag for making working trees when creating branches.
1197
1046
raise NotImplementedError(self.set_make_working_trees)
1199
1048
def make_working_trees(self):
1200
1049
"""Returns the policy for making working trees on new branches."""
1201
1050
raise NotImplementedError(self.make_working_trees)
1203
1052
@needs_write_lock
1204
1053
def sign_revision(self, revision_id, gpg_strategy):
1205
testament = _mod_testament.Testament.from_revision(self, revision_id)
1206
plaintext = testament.as_short_text()
1054
revision_id = osutils.safe_revision_id(revision_id)
1055
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1207
1056
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1209
1058
@needs_read_lock
1210
def verify_revision(self, revision_id, gpg_strategy):
1211
"""Verify the signature on a revision.
1213
:param revision_id: the revision to verify
1214
:gpg_strategy: the GPGStrategy object to used
1216
:return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1218
if not self.has_signature_for_revision_id(revision_id):
1219
return gpg.SIGNATURE_NOT_SIGNED, None
1220
signature = self.get_signature_text(revision_id)
1222
testament = _mod_testament.Testament.from_revision(self, revision_id)
1223
plaintext = testament.as_short_text()
1225
return gpg_strategy.verify(signature, plaintext)
1227
1059
def has_signature_for_revision_id(self, revision_id):
1228
1060
"""Query for a revision signature for revision_id in the repository."""
1229
raise NotImplementedError(self.has_signature_for_revision_id)
1061
revision_id = osutils.safe_revision_id(revision_id)
1062
return self._revision_store.has_signature(revision_id,
1063
self.get_transaction())
1231
1066
def get_signature_text(self, revision_id):
1232
1067
"""Return the text for a signature."""
1233
raise NotImplementedError(self.get_signature_text)
1068
revision_id = osutils.safe_revision_id(revision_id)
1069
return self._revision_store.get_signature_text(revision_id,
1070
self.get_transaction())
1235
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1073
def check(self, revision_ids):
1236
1074
"""Check consistency of all history of given revision_ids.
1238
1076
Different repository implementations should override _check().
1240
1078
:param revision_ids: A non-empty list of revision_ids whose ancestry
1241
1079
will be checked. Typically the last revision_id of a branch.
1242
:param callback_refs: A dict of check-refs to resolve and callback
1243
the check/_check method on the items listed as wanting the ref.
1245
:param check_repo: If False do not check the repository contents, just
1246
calculate the data callback_refs requires and call them back.
1248
return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1249
check_repo=check_repo)
1251
def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1252
raise NotImplementedError(self.check)
1254
def _warn_if_deprecated(self, branch=None):
1255
if not self._format.is_deprecated():
1081
if not revision_ids:
1082
raise ValueError("revision_ids must be non-empty in %s.check"
1084
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1085
return self._check(revision_ids)
1087
def _check(self, revision_ids):
1088
result = check.Check(self)
1092
def _warn_if_deprecated(self):
1257
1093
global _deprecation_warning_done
1258
1094
if _deprecation_warning_done:
1262
conf = config.GlobalConfig()
1264
conf = branch.get_config()
1265
if conf.suppress_warning('format_deprecation'):
1267
warning("Format %s for %s is deprecated -"
1268
" please use 'bzr upgrade' to get better performance"
1269
% (self._format, self.bzrdir.transport.base))
1271
_deprecation_warning_done = True
1096
_deprecation_warning_done = True
1097
warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
1098
% (self._format, self.bzrdir.transport.base))
1273
1100
def supports_rich_root(self):
1274
1101
return self._format.rich_root_data
1290
1117
raise errors.NonAsciiRevisionId(method, self)
1121
# remove these delegates a while after bzr 0.15
1122
def __make_delegated(name, from_module):
1123
def _deprecated_repository_forwarder():
1124
symbol_versioning.warn('%s moved to %s in bzr 0.15'
1125
% (name, from_module),
1128
m = __import__(from_module, globals(), locals(), [name])
1130
return getattr(m, name)
1131
except AttributeError:
1132
raise AttributeError('module %s has no name %s'
1134
globals()[name] = _deprecated_repository_forwarder
1137
'AllInOneRepository',
1138
'WeaveMetaDirRepository',
1139
'PreSplitOutRepositoryFormat',
1140
'RepositoryFormat4',
1141
'RepositoryFormat5',
1142
'RepositoryFormat6',
1143
'RepositoryFormat7',
1145
__make_delegated(_name, 'bzrlib.repofmt.weaverepo')
1149
'RepositoryFormatKnit',
1150
'RepositoryFormatKnit1',
1152
__make_delegated(_name, 'bzrlib.repofmt.knitrepo')
1155
def install_revision(repository, rev, revision_tree):
1156
"""Install all revision data into a repository."""
1157
present_parents = []
1159
for p_id in rev.parent_ids:
1160
if repository.has_revision(p_id):
1161
present_parents.append(p_id)
1162
parent_trees[p_id] = repository.revision_tree(p_id)
1164
parent_trees[p_id] = repository.revision_tree(None)
1166
inv = revision_tree.inventory
1167
entries = inv.iter_entries()
1168
# backwards compatibility hack: skip the root id.
1169
if not repository.supports_rich_root():
1170
path, root = entries.next()
1171
if root.revision != rev.revision_id:
1172
raise errors.IncompatibleRevision(repr(repository))
1173
# Add the texts that are not already present
1174
for path, ie in entries:
1175
w = repository.weave_store.get_weave_or_empty(ie.file_id,
1176
repository.get_transaction())
1177
if ie.revision not in w:
1179
# FIXME: TODO: The following loop *may* be overlapping/duplicate
1180
# with InventoryEntry.find_previous_heads(). if it is, then there
1181
# is a latent bug here where the parents may have ancestors of each
1183
for revision, tree in parent_trees.iteritems():
1184
if ie.file_id not in tree:
1186
parent_id = tree.inventory[ie.file_id].revision
1187
if parent_id in text_parents:
1189
text_parents.append(parent_id)
1191
vfile = repository.weave_store.get_weave_or_empty(ie.file_id,
1192
repository.get_transaction())
1193
lines = revision_tree.get_file(ie.file_id).readlines()
1194
vfile.add_lines(rev.revision_id, text_parents, lines)
1196
# install the inventory
1197
repository.add_inventory(rev.revision_id, inv, present_parents)
1198
except errors.RevisionAlreadyPresent:
1200
repository.add_revision(rev.revision_id, rev, inv)
1293
1203
class MetaDirRepository(Repository):
1294
"""Repositories in the new meta-dir layout.
1296
:ivar _transport: Transport for access to repository control files,
1297
typically pointing to .bzr/repository.
1300
def __init__(self, _format, a_bzrdir, control_files):
1301
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1302
self._transport = control_files._transport
1204
"""Repositories in the new meta-dir layout."""
1206
def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
1207
super(MetaDirRepository, self).__init__(_format,
1213
dir_mode = self.control_files._dir_mode
1214
file_mode = self.control_files._file_mode
1304
1217
def is_shared(self):
1305
1218
"""Return True if this repository is flagged as a shared repository."""
1306
return self._transport.has('shared-storage')
1219
return self.control_files._transport.has('shared-storage')
1308
1221
@needs_write_lock
1309
1222
def set_make_working_trees(self, new_value):
1622
1489
'RepositoryFormatKnit3',
1625
format_registry.register_lazy(
1626
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
1627
'bzrlib.repofmt.knitrepo',
1628
'RepositoryFormatKnit4',
1631
# Pack-based formats. There is one format for pre-subtrees, and one for
1632
# post-subtrees to allow ease of testing.
1633
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1634
format_registry.register_lazy(
1635
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1636
'bzrlib.repofmt.knitpack_repo',
1637
'RepositoryFormatKnitPack1',
1639
format_registry.register_lazy(
1640
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1641
'bzrlib.repofmt.knitpack_repo',
1642
'RepositoryFormatKnitPack3',
1644
format_registry.register_lazy(
1645
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1646
'bzrlib.repofmt.knitpack_repo',
1647
'RepositoryFormatKnitPack4',
1649
format_registry.register_lazy(
1650
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1651
'bzrlib.repofmt.knitpack_repo',
1652
'RepositoryFormatKnitPack5',
1654
format_registry.register_lazy(
1655
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1656
'bzrlib.repofmt.knitpack_repo',
1657
'RepositoryFormatKnitPack5RichRoot',
1659
format_registry.register_lazy(
1660
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1661
'bzrlib.repofmt.knitpack_repo',
1662
'RepositoryFormatKnitPack5RichRootBroken',
1664
format_registry.register_lazy(
1665
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1666
'bzrlib.repofmt.knitpack_repo',
1667
'RepositoryFormatKnitPack6',
1669
format_registry.register_lazy(
1670
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1671
'bzrlib.repofmt.knitpack_repo',
1672
'RepositoryFormatKnitPack6RichRoot',
1674
format_registry.register_lazy(
1675
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1676
'bzrlib.repofmt.groupcompress_repo',
1677
'RepositoryFormat2a',
1680
# Development formats.
1681
# Check their docstrings to see if/when they are obsolete.
1682
format_registry.register_lazy(
1683
("Bazaar development format 2 with subtree support "
1684
"(needs bzr.dev from before 1.8)\n"),
1685
'bzrlib.repofmt.knitpack_repo',
1686
'RepositoryFormatPackDevelopment2Subtree',
1688
format_registry.register_lazy(
1689
'Bazaar development format 8\n',
1690
'bzrlib.repofmt.groupcompress_repo',
1691
'RepositoryFormat2aSubtree',
1695
1493
class InterRepository(InterObject):
1696
1494
"""This class represents operations taking place between two repositories.
1698
1496
Its instances have methods like copy_content and fetch, and contain
1699
references to the source and target repositories these operations can be
1497
references to the source and target repositories these operations can be
1700
1498
carried out on.
1702
1500
Often we will provide convenience methods on 'repository' which carry out
1707
1505
_optimisers = []
1708
1506
"""The available optimised InterRepository types."""
1711
1508
def copy_content(self, revision_id=None):
1712
"""Make a complete copy of the content in self into destination.
1714
This is a destructive operation! Do not use it on existing
1717
:param revision_id: Only copy the content needed to construct
1718
revision_id and its parents.
1721
self.target.set_make_working_trees(self.source.make_working_trees())
1722
except NotImplementedError:
1724
self.target.fetch(self.source, revision_id=revision_id)
1727
def fetch(self, revision_id=None, find_ghosts=False,
1509
raise NotImplementedError(self.copy_content)
1511
def fetch(self, revision_id=None, pb=None):
1729
1512
"""Fetch the content required to construct revision_id.
1731
1514
The content is copied from self.source to self.target.
1733
1516
:param revision_id: if None all content is copied, if NULL_REVISION no
1734
1517
content is copied.
1518
:param pb: optional progress bar to use for progress reports. If not
1519
provided a default one will be created.
1521
Returns the copied revision count and the failed revisions in a tuple:
1737
1524
raise NotImplementedError(self.fetch)
1739
1526
@needs_read_lock
1740
def search_missing_revision_ids(self,
1741
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1742
find_ghosts=True, revision_ids=None, if_present_ids=None,
1527
def missing_revision_ids(self, revision_id=None):
1744
1528
"""Return the revision ids that source has that target does not.
1530
These are returned in topological order.
1746
1532
:param revision_id: only return revision ids included by this
1748
:param revision_ids: return revision ids included by these
1749
revision_ids. NoSuchRevision will be raised if any of these
1750
revisions are not present.
1751
:param if_present_ids: like revision_ids, but will not cause
1752
NoSuchRevision if any of these are absent, instead they will simply
1753
not be in the result. This is useful for e.g. finding revisions
1754
to fetch for tags, which may reference absent revisions.
1755
:param find_ghosts: If True find missing revisions in deep history
1756
rather than just finding the surface difference.
1757
:param limit: Maximum number of revisions to return, topologically
1759
:return: A bzrlib.graph.SearchResult.
1761
raise NotImplementedError(self.search_missing_revision_ids)
1764
def _same_model(source, target):
1765
"""True if source and target have the same data representation.
1767
Note: this is always called on the base class; overriding it in a
1768
subclass will have no effect.
1771
InterRepository._assert_same_model(source, target)
1773
except errors.IncompatibleRepositories, e:
1777
def _assert_same_model(source, target):
1778
"""Raise an exception if two repositories do not use the same model.
1535
# generic, possibly worst case, slow code path.
1536
target_ids = set(self.target.all_revision_ids())
1537
if revision_id is not None:
1538
# TODO: jam 20070210 InterRepository is internal enough that it
1539
# should assume revision_ids are already utf-8
1540
revision_id = osutils.safe_revision_id(revision_id)
1541
source_ids = self.source.get_ancestry(revision_id)
1542
assert source_ids[0] is None
1545
source_ids = self.source.all_revision_ids()
1546
result_set = set(source_ids).difference(target_ids)
1547
# this may look like a no-op: its not. It preserves the ordering
1548
# other_ids had while only returning the members from other_ids
1549
# that we've decided we need.
1550
return [rev_id for rev_id in source_ids if rev_id in result_set]
1553
class InterSameDataRepository(InterRepository):
1554
"""Code for converting between repositories that represent the same data.
1556
Data format and model must match for this to work.
1560
def _get_repo_format_to_test(self):
1561
"""Repository format for testing with."""
1562
return RepositoryFormat.get_default_format()
1565
def is_compatible(source, target):
1780
1566
if source.supports_rich_root() != target.supports_rich_root():
1781
raise errors.IncompatibleRepositories(source, target,
1782
"different rich-root support")
1783
1568
if source._serializer != target._serializer:
1784
raise errors.IncompatibleRepositories(source, target,
1785
"different serializers")
1573
def copy_content(self, revision_id=None):
1574
"""Make a complete copy of the content in self into destination.
1576
This copies both the repository's revision data, and configuration information
1577
such as the make_working_trees setting.
1579
This is a destructive operation! Do not use it on existing
1582
:param revision_id: Only copy the content needed to construct
1583
revision_id and its parents.
1586
self.target.set_make_working_trees(self.source.make_working_trees())
1587
except NotImplementedError:
1589
# TODO: jam 20070210 This is fairly internal, so we should probably
1590
# just assert that revision_id is not unicode.
1591
revision_id = osutils.safe_revision_id(revision_id)
1592
# but don't bother fetching if we have the needed data now.
1593
if (revision_id not in (None, _mod_revision.NULL_REVISION) and
1594
self.target.has_revision(revision_id)):
1596
self.target.fetch(self.source, revision_id=revision_id)
1599
def fetch(self, revision_id=None, pb=None):
1600
"""See InterRepository.fetch()."""
1601
from bzrlib.fetch import GenericRepoFetcher
1602
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1603
self.source, self.source._format, self.target,
1604
self.target._format)
1605
# TODO: jam 20070210 This should be an assert, not a translate
1606
revision_id = osutils.safe_revision_id(revision_id)
1607
f = GenericRepoFetcher(to_repository=self.target,
1608
from_repository=self.source,
1609
last_revision=revision_id,
1611
return f.count_copied, f.failed_revisions
1614
class InterWeaveRepo(InterSameDataRepository):
1615
"""Optimised code paths between Weave based repositories."""
1618
def _get_repo_format_to_test(self):
1619
from bzrlib.repofmt import weaverepo
1620
return weaverepo.RepositoryFormat7()
1623
def is_compatible(source, target):
1624
"""Be compatible with known Weave formats.
1626
We don't test for the stores being of specific types because that
1627
could lead to confusing results, and there is no need to be
1630
from bzrlib.repofmt.weaverepo import (
1636
return (isinstance(source._format, (RepositoryFormat5,
1638
RepositoryFormat7)) and
1639
isinstance(target._format, (RepositoryFormat5,
1641
RepositoryFormat7)))
1642
except AttributeError:
1646
def copy_content(self, revision_id=None):
1647
"""See InterRepository.copy_content()."""
1648
# weave specific optimised path:
1649
# TODO: jam 20070210 Internal, should be an assert, not translate
1650
revision_id = osutils.safe_revision_id(revision_id)
1652
self.target.set_make_working_trees(self.source.make_working_trees())
1653
except NotImplementedError:
1655
# FIXME do not peek!
1656
if self.source.control_files._transport.listable():
1657
pb = ui.ui_factory.nested_progress_bar()
1659
self.target.weave_store.copy_all_ids(
1660
self.source.weave_store,
1662
from_transaction=self.source.get_transaction(),
1663
to_transaction=self.target.get_transaction())
1664
pb.update('copying inventory', 0, 1)
1665
self.target.control_weaves.copy_multi(
1666
self.source.control_weaves, ['inventory'],
1667
from_transaction=self.source.get_transaction(),
1668
to_transaction=self.target.get_transaction())
1669
self.target._revision_store.text_store.copy_all_ids(
1670
self.source._revision_store.text_store,
1675
self.target.fetch(self.source, revision_id=revision_id)
1678
def fetch(self, revision_id=None, pb=None):
1679
"""See InterRepository.fetch()."""
1680
from bzrlib.fetch import GenericRepoFetcher
1681
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1682
self.source, self.source._format, self.target, self.target._format)
1683
# TODO: jam 20070210 This should be an assert, not a translate
1684
revision_id = osutils.safe_revision_id(revision_id)
1685
f = GenericRepoFetcher(to_repository=self.target,
1686
from_repository=self.source,
1687
last_revision=revision_id,
1689
return f.count_copied, f.failed_revisions
1692
def missing_revision_ids(self, revision_id=None):
1693
"""See InterRepository.missing_revision_ids()."""
1694
# we want all revisions to satisfy revision_id in source.
1695
# but we don't want to stat every file here and there.
1696
# we want then, all revisions other needs to satisfy revision_id
1697
# checked, but not those that we have locally.
1698
# so the first thing is to get a subset of the revisions to
1699
# satisfy revision_id in source, and then eliminate those that
1700
# we do already have.
1701
# this is slow on high latency connection to self, but as as this
1702
# disk format scales terribly for push anyway due to rewriting
1703
# inventory.weave, this is considered acceptable.
1705
if revision_id is not None:
1706
source_ids = self.source.get_ancestry(revision_id)
1707
assert source_ids[0] is None
1710
source_ids = self.source._all_possible_ids()
1711
source_ids_set = set(source_ids)
1712
# source_ids is the worst possible case we may need to pull.
1713
# now we want to filter source_ids against what we actually
1714
# have in target, but don't try to check for existence where we know
1715
# we do not have a revision as that would be pointless.
1716
target_ids = set(self.target._all_possible_ids())
1717
possibly_present_revisions = target_ids.intersection(source_ids_set)
1718
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1719
required_revisions = source_ids_set.difference(actually_present_revisions)
1720
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1721
if revision_id is not None:
1722
# we used get_ancestry to determine source_ids then we are assured all
1723
# revisions referenced are present as they are installed in topological order.
1724
# and the tip revision was validated by get_ancestry.
1725
return required_topo_revisions
1727
# if we just grabbed the possibly available ids, then
1728
# we only have an estimate of whats available and need to validate
1729
# that against the revision records.
1730
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1733
class InterKnitRepo(InterSameDataRepository):
1734
"""Optimised code paths between Knit based repositories."""
1737
def _get_repo_format_to_test(self):
1738
from bzrlib.repofmt import knitrepo
1739
return knitrepo.RepositoryFormatKnit1()
1742
def is_compatible(source, target):
1743
"""Be compatible with known Knit formats.
1745
We don't test for the stores being of specific types because that
1746
could lead to confusing results, and there is no need to be
1749
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1
1751
return (isinstance(source._format, (RepositoryFormatKnit1)) and
1752
isinstance(target._format, (RepositoryFormatKnit1)))
1753
except AttributeError:
1757
def fetch(self, revision_id=None, pb=None):
1758
"""See InterRepository.fetch()."""
1759
from bzrlib.fetch import KnitRepoFetcher
1760
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1761
self.source, self.source._format, self.target, self.target._format)
1762
# TODO: jam 20070210 This should be an assert, not a translate
1763
revision_id = osutils.safe_revision_id(revision_id)
1764
f = KnitRepoFetcher(to_repository=self.target,
1765
from_repository=self.source,
1766
last_revision=revision_id,
1768
return f.count_copied, f.failed_revisions
1771
def missing_revision_ids(self, revision_id=None):
1772
"""See InterRepository.missing_revision_ids()."""
1773
if revision_id is not None:
1774
source_ids = self.source.get_ancestry(revision_id)
1775
assert source_ids[0] is None
1778
source_ids = self.source._all_possible_ids()
1779
source_ids_set = set(source_ids)
1780
# source_ids is the worst possible case we may need to pull.
1781
# now we want to filter source_ids against what we actually
1782
# have in target, but don't try to check for existence where we know
1783
# we do not have a revision as that would be pointless.
1784
target_ids = set(self.target._all_possible_ids())
1785
possibly_present_revisions = target_ids.intersection(source_ids_set)
1786
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1787
required_revisions = source_ids_set.difference(actually_present_revisions)
1788
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1789
if revision_id is not None:
1790
# we used get_ancestry to determine source_ids then we are assured all
1791
# revisions referenced are present as they are installed in topological order.
1792
# and the tip revision was validated by get_ancestry.
1793
return required_topo_revisions
1795
# if we just grabbed the possibly available ids, then
1796
# we only have an estimate of whats available and need to validate
1797
# that against the revision records.
1798
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1801
class InterModel1and2(InterRepository):
1804
def _get_repo_format_to_test(self):
1808
def is_compatible(source, target):
1809
if not source.supports_rich_root() and target.supports_rich_root():
1815
def fetch(self, revision_id=None, pb=None):
1816
"""See InterRepository.fetch()."""
1817
from bzrlib.fetch import Model1toKnit2Fetcher
1818
# TODO: jam 20070210 This should be an assert, not a translate
1819
revision_id = osutils.safe_revision_id(revision_id)
1820
f = Model1toKnit2Fetcher(to_repository=self.target,
1821
from_repository=self.source,
1822
last_revision=revision_id,
1824
return f.count_copied, f.failed_revisions
1827
def copy_content(self, revision_id=None):
1828
"""Make a complete copy of the content in self into destination.
1830
This is a destructive operation! Do not use it on existing
1833
:param revision_id: Only copy the content needed to construct
1834
revision_id and its parents.
1837
self.target.set_make_working_trees(self.source.make_working_trees())
1838
except NotImplementedError:
1840
# TODO: jam 20070210 Internal, assert, don't translate
1841
revision_id = osutils.safe_revision_id(revision_id)
1842
# but don't bother fetching if we have the needed data now.
1843
if (revision_id not in (None, _mod_revision.NULL_REVISION) and
1844
self.target.has_revision(revision_id)):
1846
self.target.fetch(self.source, revision_id=revision_id)
1849
class InterKnit1and2(InterKnitRepo):
1852
def _get_repo_format_to_test(self):
1856
def is_compatible(source, target):
1857
"""Be compatible with Knit1 source and Knit3 target"""
1858
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
1860
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
1861
RepositoryFormatKnit3
1862
return (isinstance(source._format, (RepositoryFormatKnit1)) and
1863
isinstance(target._format, (RepositoryFormatKnit3)))
1864
except AttributeError:
1868
def fetch(self, revision_id=None, pb=None):
1869
"""See InterRepository.fetch()."""
1870
from bzrlib.fetch import Knit1to2Fetcher
1871
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1872
self.source, self.source._format, self.target,
1873
self.target._format)
1874
# TODO: jam 20070210 This should be an assert, not a translate
1875
revision_id = osutils.safe_revision_id(revision_id)
1876
f = Knit1to2Fetcher(to_repository=self.target,
1877
from_repository=self.source,
1878
last_revision=revision_id,
1880
return f.count_copied, f.failed_revisions
1883
class InterRemoteRepository(InterRepository):
1884
"""Code for converting between RemoteRepository objects.
1886
This just gets an non-remote repository from the RemoteRepository, and calls
1887
InterRepository.get again.
1890
def __init__(self, source, target):
1891
if isinstance(source, remote.RemoteRepository):
1892
source._ensure_real()
1893
real_source = source._real_repository
1895
real_source = source
1896
if isinstance(target, remote.RemoteRepository):
1897
target._ensure_real()
1898
real_target = target._real_repository
1900
real_target = target
1901
self.real_inter = InterRepository.get(real_source, real_target)
1904
def is_compatible(source, target):
1905
if isinstance(source, remote.RemoteRepository):
1907
if isinstance(target, remote.RemoteRepository):
1911
def copy_content(self, revision_id=None):
1912
self.real_inter.copy_content(revision_id=revision_id)
1914
def fetch(self, revision_id=None, pb=None):
1915
self.real_inter.fetch(revision_id=revision_id, pb=pb)
1918
def _get_repo_format_to_test(self):
1922
InterRepository.register_optimiser(InterSameDataRepository)
1923
InterRepository.register_optimiser(InterWeaveRepo)
1924
InterRepository.register_optimiser(InterKnitRepo)
1925
InterRepository.register_optimiser(InterModel1and2)
1926
InterRepository.register_optimiser(InterKnit1and2)
1927
InterRepository.register_optimiser(InterRemoteRepository)
1788
1930
class CopyConverter(object):
1789
1931
"""A repository conversion tool which just performs a copy of the content.
1791
1933
This is slow but quite reliable.
1797
1939
:param target_format: The format the resulting repository should be.
1799
1941
self.target_format = target_format
1801
1943
def convert(self, repo, pb):
1802
1944
"""Perform the conversion of to_convert, giving feedback via pb.
1804
1946
:param to_convert: The disk object to convert.
1805
1947
:param pb: a progress bar to use for progress information.
1807
pb = ui.ui_factory.nested_progress_bar()
1810
1952
# this is only useful with metadir layouts - separated repo content.
1811
1953
# trigger an assertion if not such
1812
1954
repo._format.get_format_string()
1813
1955
self.repo_dir = repo.bzrdir
1814
pb.update('Moving repository to repository.backup')
1956
self.step('Moving repository to repository.backup')
1815
1957
self.repo_dir.transport.move('repository', 'repository.backup')
1816
1958
backup_transport = self.repo_dir.transport.clone('repository.backup')
1817
1959
repo._format.check_conversion_target(self.target_format)
1818
1960
self.source_repo = repo._format.open(self.repo_dir,
1820
1962
_override_transport=backup_transport)
1821
pb.update('Creating new repository')
1963
self.step('Creating new repository')
1822
1964
converted = self.target_format.initialize(self.repo_dir,
1823
1965
self.source_repo.is_shared())
1824
1966
converted.lock_write()
1826
pb.update('Copying content')
1968
self.step('Copying content into repository.')
1827
1969
self.source_repo.copy_content_into(converted)
1829
1971
converted.unlock()
1830
pb.update('Deleting old repository content')
1972
self.step('Deleting old repository content.')
1831
1973
self.repo_dir.transport.delete_tree('repository.backup')
1832
ui.ui_factory.note('repository converted')
1836
def _strip_NULL_ghosts(revision_graph):
1837
"""Also don't use this. more compatibility code for unmigrated clients."""
1838
# Filter ghosts, and null:
1839
if _mod_revision.NULL_REVISION in revision_graph:
1840
del revision_graph[_mod_revision.NULL_REVISION]
1841
for key, parents in revision_graph.items():
1842
revision_graph[key] = tuple(parent for parent in parents if parent
1844
return revision_graph
1847
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1848
stop_revision=None):
1849
"""Extend the partial history to include a given index
1851
If a stop_index is supplied, stop when that index has been reached.
1852
If a stop_revision is supplied, stop when that revision is
1853
encountered. Otherwise, stop when the beginning of history is
1856
:param stop_index: The index which should be present. When it is
1857
present, history extension will stop.
1858
:param stop_revision: The revision id which should be present. When
1859
it is encountered, history extension will stop.
1861
start_revision = partial_history_cache[-1]
1862
graph = repo.get_graph()
1863
iterator = graph.iter_lefthand_ancestry(start_revision,
1864
(_mod_revision.NULL_REVISION,))
1974
self.pb.note('repository converted')
1976
def step(self, message):
1977
"""Update the pb by a step."""
1979
self.pb.update(message, self.count, self.total)
1982
class CommitBuilder(object):
1983
"""Provides an interface to build up a commit.
1985
This allows describing a tree to be committed without needing to
1986
know the internals of the format of the repository.
1989
record_root_entry = False
1990
def __init__(self, repository, parents, config, timestamp=None,
1991
timezone=None, committer=None, revprops=None,
1993
"""Initiate a CommitBuilder.
1995
:param repository: Repository to commit to.
1996
:param parents: Revision ids of the parents of the new revision.
1997
:param config: Configuration to use.
1998
:param timestamp: Optional timestamp recorded for commit.
1999
:param timezone: Optional timezone for timestamp.
2000
:param committer: Optional committer to set for commit.
2001
:param revprops: Optional dictionary of revision properties.
2002
:param revision_id: Optional revision id.
2004
self._config = config
2006
if committer is None:
2007
self._committer = self._config.username()
2009
assert isinstance(committer, basestring), type(committer)
2010
self._committer = committer
2012
self.new_inventory = Inventory(None)
2013
self._new_revision_id = osutils.safe_revision_id(revision_id)
2014
self.parents = parents
2015
self.repository = repository
2018
if revprops is not None:
2019
self._revprops.update(revprops)
2021
if timestamp is None:
2022
timestamp = time.time()
2023
# Restrict resolution to 1ms
2024
self._timestamp = round(timestamp, 3)
2026
if timezone is None:
2027
self._timezone = osutils.local_time_offset()
2029
self._timezone = int(timezone)
2031
self._generate_revision_if_needed()
2033
def commit(self, message):
2034
"""Make the actual commit.
2036
:return: The revision id of the recorded revision.
2038
rev = _mod_revision.Revision(
2039
timestamp=self._timestamp,
2040
timezone=self._timezone,
2041
committer=self._committer,
2043
inventory_sha1=self.inv_sha1,
2044
revision_id=self._new_revision_id,
2045
properties=self._revprops)
2046
rev.parent_ids = self.parents
2047
self.repository.add_revision(self._new_revision_id, rev,
2048
self.new_inventory, self._config)
2049
self.repository.commit_write_group()
2050
return self._new_revision_id
2052
def revision_tree(self):
2053
"""Return the tree that was just committed.
2055
After calling commit() this can be called to get a RevisionTree
2056
representing the newly committed tree. This is preferred to
2057
calling Repository.revision_tree() because that may require
2058
deserializing the inventory, while we already have a copy in
2061
return RevisionTree(self.repository, self.new_inventory,
2062
self._new_revision_id)
2064
def finish_inventory(self):
2065
"""Tell the builder that the inventory is finished."""
2066
if self.new_inventory.root is None:
2067
symbol_versioning.warn('Root entry should be supplied to'
2068
' record_entry_contents, as of bzr 0.10.',
2069
DeprecationWarning, stacklevel=2)
2070
self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
2071
self.new_inventory.revision_id = self._new_revision_id
2072
self.inv_sha1 = self.repository.add_inventory(
2073
self._new_revision_id,
2078
def _gen_revision_id(self):
2079
"""Return new revision-id."""
2080
return generate_ids.gen_revision_id(self._config.username(),
2083
def _generate_revision_if_needed(self):
2084
"""Create a revision id if None was supplied.
2086
If the repository can not support user-specified revision ids
2087
they should override this function and raise CannotSetRevisionId
2088
if _new_revision_id is not None.
2090
:raises: CannotSetRevisionId
2092
if self._new_revision_id is None:
2093
self._new_revision_id = self._gen_revision_id()
2095
def record_entry_contents(self, ie, parent_invs, path, tree):
2096
"""Record the content of ie from tree into the commit if needed.
2098
Side effect: sets ie.revision when unchanged
2100
:param ie: An inventory entry present in the commit.
2101
:param parent_invs: The inventories of the parent revisions of the
2103
:param path: The path the entry is at in the tree.
2104
:param tree: The tree which contains this entry and should be used to
2107
if self.new_inventory.root is None and ie.parent_id is not None:
2108
symbol_versioning.warn('Root entry should be supplied to'
2109
' record_entry_contents, as of bzr 0.10.',
2110
DeprecationWarning, stacklevel=2)
2111
self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
2113
self.new_inventory.add(ie)
2115
# ie.revision is always None if the InventoryEntry is considered
2116
# for committing. ie.snapshot will record the correct revision
2117
# which may be the sole parent if it is untouched.
2118
if ie.revision is not None:
2121
# In this revision format, root entries have no knit or weave
2122
if ie is self.new_inventory.root:
2123
# When serializing out to disk and back in
2124
# root.revision is always _new_revision_id
2125
ie.revision = self._new_revision_id
2127
previous_entries = ie.find_previous_heads(
2129
self.repository.weave_store,
2130
self.repository.get_transaction())
2131
# we are creating a new revision for ie in the history store
2133
ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2135
def modified_directory(self, file_id, file_parents):
2136
"""Record the presence of a symbolic link.
2138
:param file_id: The file_id of the link to record.
2139
:param file_parents: The per-file parent revision ids.
2141
self._add_text_to_weave(file_id, [], file_parents.keys())
2143
def modified_reference(self, file_id, file_parents):
2144
"""Record the modification of a reference.
2146
:param file_id: The file_id of the link to record.
2147
:param file_parents: The per-file parent revision ids.
2149
self._add_text_to_weave(file_id, [], file_parents.keys())
2151
def modified_file_text(self, file_id, file_parents,
2152
get_content_byte_lines, text_sha1=None,
2154
"""Record the text of file file_id
2156
:param file_id: The file_id of the file to record the text of.
2157
:param file_parents: The per-file parent revision ids.
2158
:param get_content_byte_lines: A callable which will return the byte
2160
:param text_sha1: Optional SHA1 of the file contents.
2161
:param text_size: Optional size of the file contents.
2163
# mutter('storing text of file {%s} in revision {%s} into %r',
2164
# file_id, self._new_revision_id, self.repository.weave_store)
2165
# special case to avoid diffing on renames or
2167
if (len(file_parents) == 1
2168
and text_sha1 == file_parents.values()[0].text_sha1
2169
and text_size == file_parents.values()[0].text_size):
2170
previous_ie = file_parents.values()[0]
2171
versionedfile = self.repository.weave_store.get_weave(file_id,
2172
self.repository.get_transaction())
2173
versionedfile.clone_text(self._new_revision_id,
2174
previous_ie.revision, file_parents.keys())
2175
return text_sha1, text_size
2177
new_lines = get_content_byte_lines()
2178
# TODO: Rather than invoking sha_strings here, _add_text_to_weave
2179
# should return the SHA1 and size
2180
self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2181
return osutils.sha_strings(new_lines), \
2182
sum(map(len, new_lines))
2184
def modified_link(self, file_id, file_parents, link_target):
2185
"""Record the presence of a symbolic link.
2187
:param file_id: The file_id of the link to record.
2188
:param file_parents: The per-file parent revision ids.
2189
:param link_target: Target location of this link.
2191
self._add_text_to_weave(file_id, [], file_parents.keys())
2193
def _add_text_to_weave(self, file_id, new_lines, parents):
2194
versionedfile = self.repository.weave_store.get_weave_or_empty(
2195
file_id, self.repository.get_transaction())
2196
versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2197
versionedfile.clear_cache()
2200
class _CommitBuilder(CommitBuilder):
2201
"""Temporary class so old CommitBuilders are detected properly
2203
Note: CommitBuilder works whether or not root entry is recorded.
2206
record_root_entry = True
2209
class RootCommitBuilder(CommitBuilder):
2210
"""This commitbuilder actually records the root id"""
2212
record_root_entry = True
2214
def record_entry_contents(self, ie, parent_invs, path, tree):
2215
"""Record the content of ie from tree into the commit if needed.
2217
Side effect: sets ie.revision when unchanged
2219
:param ie: An inventory entry present in the commit.
2220
:param parent_invs: The inventories of the parent revisions of the
2222
:param path: The path the entry is at in the tree.
2223
:param tree: The tree which contains this entry and should be used to
2226
assert self.new_inventory.root is not None or ie.parent_id is None
2227
self.new_inventory.add(ie)
2229
# ie.revision is always None if the InventoryEntry is considered
2230
# for committing. ie.snapshot will record the correct revision
2231
# which may be the sole parent if it is untouched.
2232
if ie.revision is not None:
2235
previous_entries = ie.find_previous_heads(
2237
self.repository.weave_store,
2238
self.repository.get_transaction())
2239
# we are creating a new revision for ie in the history store
2241
ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2253
def _unescaper(match, _map=_unescape_map):
2254
code = match.group(1)
1866
# skip the last revision in the list
1869
if (stop_index is not None and
1870
len(partial_history_cache) > stop_index):
1872
if partial_history_cache[-1] == stop_revision:
1874
revision_id = iterator.next()
1875
partial_history_cache.append(revision_id)
1876
except StopIteration:
1881
class _LazyListJoin(object):
1882
"""An iterable yielding the contents of many lists as one list.
1884
Each iterator made from this will reflect the current contents of the lists
1885
at the time the iterator is made.
1887
This is used by Repository's _make_parents_provider implementation so that
1890
pp = repo._make_parents_provider() # uses a list of fallback repos
1891
pp.add_fallback_repository(other_repo) # appends to that list
1892
result = pp.get_parent_map(...)
1893
# The result will include revs from other_repo
1896
def __init__(self, *list_parts):
1897
self.list_parts = list_parts
1901
for list_part in self.list_parts:
1902
full_list.extend(list_part)
1903
return iter(full_list)
2258
if not code.startswith('#'):
2260
return unichr(int(code[1:])).encode('utf8')
2266
def _unescape_xml(data):
2267
"""Unescape predefined XML entities in a string of data."""
2269
if _unescape_re is None:
2270
_unescape_re = re.compile('\&([^;]*);')
2271
return _unescape_re.sub(_unescaper, data)
added
removed
bzrlib/repository.py
