1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
42
revision as _mod_revision,
50
from bzrlib.bundle import serializer
51
from bzrlib.revisiontree import RevisionTree
52
from bzrlib.store.versioned import VersionedFileStore
53
from bzrlib.testament import Testament
56
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
57
from bzrlib.inter import InterObject
58
from bzrlib.inventory import (
64
from bzrlib.lock import _RelockDebugMixin
65
from bzrlib import registry
66
from bzrlib.trace import (
67
log_exception_quietly, note, mutter, mutter_callsite, warning)
70
# Old formats display a warning, but only once
71
_deprecation_warning_done = False
74
class CommitBuilder(object):
75
"""Provides an interface to build up a commit.
77
This allows describing a tree to be committed without needing to
78
know the internals of the format of the repository.
81
# all clients should supply tree roots.
82
record_root_entry = True
83
# the default CommitBuilder does not manage trees whose root is versioned.
84
_versioned_root = False
86
def __init__(self, repository, parents, config, timestamp=None,
87
timezone=None, committer=None, revprops=None,
89
"""Initiate a CommitBuilder.
91
:param repository: Repository to commit to.
92
:param parents: Revision ids of the parents of the new revision.
93
:param config: Configuration to use.
94
:param timestamp: Optional timestamp recorded for commit.
95
:param timezone: Optional timezone for timestamp.
96
:param committer: Optional committer to set for commit.
97
:param revprops: Optional dictionary of revision properties.
98
:param revision_id: Optional revision id.
100
self._config = config
102
if committer is None:
103
self._committer = self._config.username()
105
self._committer = committer
107
self.new_inventory = Inventory(None)
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()
128
self.__heads = graph.HeadsCache(repository.get_graph()).heads
129
self._basis_delta = []
130
# API compatibility, older code that used CommitBuilder did not call
131
# .record_delete(), which means the delta that is computed would not be
132
# valid. Callers that will call record_delete() should call
133
# .will_record_deletes() to indicate that.
134
self._recording_deletes = False
135
# memo'd check for no-op commits.
136
self._any_changes = False
138
def any_changes(self):
139
"""Return True if any entries were changed.
141
This includes merge-only changes. It is the core for the --unchanged
144
:return: True if any changes have occured.
146
return self._any_changes
148
def _validate_unicode_text(self, text, context):
149
"""Verify things like commit messages don't have bogus characters."""
151
raise ValueError('Invalid value for %s: %r' % (context, text))
153
def _validate_revprops(self, revprops):
154
for key, value in revprops.iteritems():
155
# We know that the XML serializers do not round trip '\r'
156
# correctly, so refuse to accept them
157
if not isinstance(value, basestring):
158
raise ValueError('revision property (%s) is not a valid'
159
' (unicode) string: %r' % (key, value))
160
self._validate_unicode_text(value,
161
'revision property (%s)' % (key,))
163
def commit(self, message):
164
"""Make the actual commit.
166
:return: The revision id of the recorded revision.
168
self._validate_unicode_text(message, 'commit message')
169
rev = _mod_revision.Revision(
170
timestamp=self._timestamp,
171
timezone=self._timezone,
172
committer=self._committer,
174
inventory_sha1=self.inv_sha1,
175
revision_id=self._new_revision_id,
176
properties=self._revprops)
177
rev.parent_ids = self.parents
178
self.repository.add_revision(self._new_revision_id, rev,
179
self.new_inventory, self._config)
180
self.repository.commit_write_group()
181
return self._new_revision_id
184
"""Abort the commit that is being built.
186
self.repository.abort_write_group()
188
def revision_tree(self):
189
"""Return the tree that was just committed.
191
After calling commit() this can be called to get a RevisionTree
192
representing the newly committed tree. This is preferred to
193
calling Repository.revision_tree() because that may require
194
deserializing the inventory, while we already have a copy in
197
if self.new_inventory is None:
198
self.new_inventory = self.repository.get_inventory(
199
self._new_revision_id)
200
return RevisionTree(self.repository, self.new_inventory,
201
self._new_revision_id)
203
def finish_inventory(self):
204
"""Tell the builder that the inventory is finished.
206
:return: The inventory id in the repository, which can be used with
207
repository.get_inventory.
209
if self.new_inventory is None:
210
# an inventory delta was accumulated without creating a new
212
basis_id = self.basis_delta_revision
213
# We ignore the 'inventory' returned by add_inventory_by_delta
214
# because self.new_inventory is used to hint to the rest of the
215
# system what code path was taken
216
self.inv_sha1, _ = self.repository.add_inventory_by_delta(
217
basis_id, self._basis_delta, self._new_revision_id,
220
if self.new_inventory.root is None:
221
raise AssertionError('Root entry should be supplied to'
222
' record_entry_contents, as of bzr 0.10.')
223
self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
224
self.new_inventory.revision_id = self._new_revision_id
225
self.inv_sha1 = self.repository.add_inventory(
226
self._new_revision_id,
230
return self._new_revision_id
232
def _gen_revision_id(self):
233
"""Return new revision-id."""
234
return generate_ids.gen_revision_id(self._config.username(),
237
def _generate_revision_if_needed(self):
238
"""Create a revision id if None was supplied.
240
If the repository can not support user-specified revision ids
241
they should override this function and raise CannotSetRevisionId
242
if _new_revision_id is not None.
244
:raises: CannotSetRevisionId
246
if self._new_revision_id is None:
247
self._new_revision_id = self._gen_revision_id()
248
self.random_revid = True
250
self.random_revid = False
252
def _heads(self, file_id, revision_ids):
253
"""Calculate the graph heads for revision_ids in the graph of file_id.
255
This can use either a per-file graph or a global revision graph as we
256
have an identity relationship between the two graphs.
258
return self.__heads(revision_ids)
260
def _check_root(self, ie, parent_invs, tree):
261
"""Helper for record_entry_contents.
263
:param ie: An entry being added.
264
:param parent_invs: The inventories of the parent revisions of the
266
:param tree: The tree that is being committed.
268
# In this revision format, root entries have no knit or weave When
269
# serializing out to disk and back in root.revision is always
271
ie.revision = self._new_revision_id
273
def _require_root_change(self, tree):
274
"""Enforce an appropriate root object change.
276
This is called once when record_iter_changes is called, if and only if
277
the root was not in the delta calculated by record_iter_changes.
279
:param tree: The tree which is being committed.
281
# NB: if there are no parents then this method is not called, so no
282
# need to guard on parents having length.
283
entry = entry_factory['directory'](tree.path2id(''), '',
285
entry.revision = self._new_revision_id
286
self._basis_delta.append(('', '', entry.file_id, entry))
288
def _get_delta(self, ie, basis_inv, path):
289
"""Get a delta against the basis inventory for ie."""
290
if ie.file_id not in basis_inv:
292
result = (None, path, ie.file_id, ie)
293
self._basis_delta.append(result)
295
elif ie != basis_inv[ie.file_id]:
297
# TODO: avoid tis id2path call.
298
result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
299
self._basis_delta.append(result)
305
def get_basis_delta(self):
306
"""Return the complete inventory delta versus the basis inventory.
308
This has been built up with the calls to record_delete and
309
record_entry_contents. The client must have already called
310
will_record_deletes() to indicate that they will be generating a
313
:return: An inventory delta, suitable for use with apply_delta, or
314
Repository.add_inventory_by_delta, etc.
316
if not self._recording_deletes:
317
raise AssertionError("recording deletes not activated.")
318
return self._basis_delta
320
def record_delete(self, path, file_id):
321
"""Record that a delete occured against a basis tree.
323
This is an optional API - when used it adds items to the basis_delta
324
being accumulated by the commit builder. It cannot be called unless the
325
method will_record_deletes() has been called to inform the builder that
326
a delta is being supplied.
328
:param path: The path of the thing deleted.
329
:param file_id: The file id that was deleted.
331
if not self._recording_deletes:
332
raise AssertionError("recording deletes not activated.")
333
delta = (path, None, file_id, None)
334
self._basis_delta.append(delta)
335
self._any_changes = True
338
def will_record_deletes(self):
339
"""Tell the commit builder that deletes are being notified.
341
This enables the accumulation of an inventory delta; for the resulting
342
commit to be valid, deletes against the basis MUST be recorded via
343
builder.record_delete().
345
self._recording_deletes = True
347
basis_id = self.parents[0]
349
basis_id = _mod_revision.NULL_REVISION
350
self.basis_delta_revision = basis_id
352
def record_entry_contents(self, ie, parent_invs, path, tree,
354
"""Record the content of ie from tree into the commit if needed.
356
Side effect: sets ie.revision when unchanged
358
:param ie: An inventory entry present in the commit.
359
:param parent_invs: The inventories of the parent revisions of the
361
:param path: The path the entry is at in the tree.
362
:param tree: The tree which contains this entry and should be used to
364
:param content_summary: Summary data from the tree about the paths
365
content - stat, length, exec, sha/link target. This is only
366
accessed when the entry has a revision of None - that is when it is
367
a candidate to commit.
368
:return: A tuple (change_delta, version_recorded, fs_hash).
369
change_delta is an inventory_delta change for this entry against
370
the basis tree of the commit, or None if no change occured against
372
version_recorded is True if a new version of the entry has been
373
recorded. For instance, committing a merge where a file was only
374
changed on the other side will return (delta, False).
375
fs_hash is either None, or the hash details for the path (currently
376
a tuple of the contents sha1 and the statvalue returned by
377
tree.get_file_with_stat()).
379
if self.new_inventory.root is None:
380
if ie.parent_id is not None:
381
raise errors.RootMissing()
382
self._check_root(ie, parent_invs, tree)
383
if ie.revision is None:
384
kind = content_summary[0]
386
# ie is carried over from a prior commit
388
# XXX: repository specific check for nested tree support goes here - if
389
# the repo doesn't want nested trees we skip it ?
390
if (kind == 'tree-reference' and
391
not self.repository._format.supports_tree_reference):
392
# mismatch between commit builder logic and repository:
393
# this needs the entry creation pushed down into the builder.
394
raise NotImplementedError('Missing repository subtree support.')
395
self.new_inventory.add(ie)
397
# TODO: slow, take it out of the inner loop.
399
basis_inv = parent_invs[0]
401
basis_inv = Inventory(root_id=None)
403
# ie.revision is always None if the InventoryEntry is considered
404
# for committing. We may record the previous parents revision if the
405
# content is actually unchanged against a sole head.
406
if ie.revision is not None:
407
if not self._versioned_root and path == '':
408
# repositories that do not version the root set the root's
409
# revision to the new commit even when no change occurs (more
410
# specifically, they do not record a revision on the root; and
411
# the rev id is assigned to the root during deserialisation -
412
# this masks when a change may have occurred against the basis.
413
# To match this we always issue a delta, because the revision
414
# of the root will always be changing.
415
if ie.file_id in basis_inv:
416
delta = (basis_inv.id2path(ie.file_id), path,
420
delta = (None, path, ie.file_id, ie)
421
self._basis_delta.append(delta)
422
return delta, False, None
424
# we don't need to commit this, because the caller already
425
# determined that an existing revision of this file is
426
# appropriate. If its not being considered for committing then
427
# it and all its parents to the root must be unaltered so
428
# no-change against the basis.
429
if ie.revision == self._new_revision_id:
430
raise AssertionError("Impossible situation, a skipped "
431
"inventory entry (%r) claims to be modified in this "
432
"commit (%r).", (ie, self._new_revision_id))
433
return None, False, None
434
# XXX: Friction: parent_candidates should return a list not a dict
435
# so that we don't have to walk the inventories again.
436
parent_candiate_entries = ie.parent_candidates(parent_invs)
437
head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
439
for inv in parent_invs:
440
if ie.file_id in inv:
441
old_rev = inv[ie.file_id].revision
442
if old_rev in head_set:
443
heads.append(inv[ie.file_id].revision)
444
head_set.remove(inv[ie.file_id].revision)
447
# now we check to see if we need to write a new record to the
449
# We write a new entry unless there is one head to the ancestors, and
450
# the kind-derived content is unchanged.
452
# Cheapest check first: no ancestors, or more the one head in the
453
# ancestors, we write a new node.
457
# There is a single head, look it up for comparison
458
parent_entry = parent_candiate_entries[heads[0]]
459
# if the non-content specific data has changed, we'll be writing a
461
if (parent_entry.parent_id != ie.parent_id or
462
parent_entry.name != ie.name):
464
# now we need to do content specific checks:
466
# if the kind changed the content obviously has
467
if kind != parent_entry.kind:
469
# Stat cache fingerprint feedback for the caller - None as we usually
470
# don't generate one.
473
if content_summary[2] is None:
474
raise ValueError("Files must not have executable = None")
476
# We can't trust a check of the file length because of content
478
if (# if the exec bit has changed we have to store:
479
parent_entry.executable != content_summary[2]):
481
elif parent_entry.text_sha1 == content_summary[3]:
482
# all meta and content is unchanged (using a hash cache
483
# hit to check the sha)
484
ie.revision = parent_entry.revision
485
ie.text_size = parent_entry.text_size
486
ie.text_sha1 = parent_entry.text_sha1
487
ie.executable = parent_entry.executable
488
return self._get_delta(ie, basis_inv, path), False, None
490
# Either there is only a hash change(no hash cache entry,
491
# or same size content change), or there is no change on
493
# Provide the parent's hash to the store layer, so that the
494
# content is unchanged we will not store a new node.
495
nostore_sha = parent_entry.text_sha1
497
# We want to record a new node regardless of the presence or
498
# absence of a content change in the file.
500
ie.executable = content_summary[2]
501
file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
503
text = file_obj.read()
507
ie.text_sha1, ie.text_size = self._add_text_to_weave(
508
ie.file_id, text, heads, nostore_sha)
509
# Let the caller know we generated a stat fingerprint.
510
fingerprint = (ie.text_sha1, stat_value)
511
except errors.ExistingContent:
512
# Turns out that the file content was unchanged, and we were
513
# only going to store a new node if it was changed. Carry over
515
ie.revision = parent_entry.revision
516
ie.text_size = parent_entry.text_size
517
ie.text_sha1 = parent_entry.text_sha1
518
ie.executable = parent_entry.executable
519
return self._get_delta(ie, basis_inv, path), False, None
520
elif kind == 'directory':
522
# all data is meta here, nothing specific to directory, so
524
ie.revision = parent_entry.revision
525
return self._get_delta(ie, basis_inv, path), False, None
526
self._add_text_to_weave(ie.file_id, '', heads, None)
527
elif kind == 'symlink':
528
current_link_target = content_summary[3]
530
# symlink target is not generic metadata, check if it has
532
if current_link_target != parent_entry.symlink_target:
535
# unchanged, carry over.
536
ie.revision = parent_entry.revision
537
ie.symlink_target = parent_entry.symlink_target
538
return self._get_delta(ie, basis_inv, path), False, None
539
ie.symlink_target = current_link_target
540
self._add_text_to_weave(ie.file_id, '', heads, None)
541
elif kind == 'tree-reference':
543
if content_summary[3] != parent_entry.reference_revision:
546
# unchanged, carry over.
547
ie.reference_revision = parent_entry.reference_revision
548
ie.revision = parent_entry.revision
549
return self._get_delta(ie, basis_inv, path), False, None
550
ie.reference_revision = content_summary[3]
551
if ie.reference_revision is None:
552
raise AssertionError("invalid content_summary for nested tree: %r"
553
% (content_summary,))
554
self._add_text_to_weave(ie.file_id, '', heads, None)
556
raise NotImplementedError('unknown kind')
557
ie.revision = self._new_revision_id
558
self._any_changes = True
559
return self._get_delta(ie, basis_inv, path), True, fingerprint
561
def record_iter_changes(self, tree, basis_revision_id, iter_changes,
562
_entry_factory=entry_factory):
563
"""Record a new tree via iter_changes.
565
:param tree: The tree to obtain text contents from for changed objects.
566
:param basis_revision_id: The revision id of the tree the iter_changes
567
has been generated against. Currently assumed to be the same
568
as self.parents[0] - if it is not, errors may occur.
569
:param iter_changes: An iter_changes iterator with the changes to apply
570
to basis_revision_id. The iterator must not include any items with
571
a current kind of None - missing items must be either filtered out
572
or errored-on beefore record_iter_changes sees the item.
573
:param _entry_factory: Private method to bind entry_factory locally for
575
:return: A generator of (file_id, relpath, fs_hash) tuples for use with
578
# Create an inventory delta based on deltas between all the parents and
579
# deltas between all the parent inventories. We use inventory delta's
580
# between the inventory objects because iter_changes masks
581
# last-changed-field only changes.
583
# file_id -> change map, change is fileid, paths, changed, versioneds,
584
# parents, names, kinds, executables
586
# {file_id -> revision_id -> inventory entry, for entries in parent
587
# trees that are not parents[0]
591
revtrees = list(self.repository.revision_trees(self.parents))
592
except errors.NoSuchRevision:
593
# one or more ghosts, slow path.
595
for revision_id in self.parents:
597
revtrees.append(self.repository.revision_tree(revision_id))
598
except errors.NoSuchRevision:
600
basis_revision_id = _mod_revision.NULL_REVISION
602
revtrees.append(self.repository.revision_tree(
603
_mod_revision.NULL_REVISION))
604
# The basis inventory from a repository
606
basis_inv = revtrees[0].inventory
608
basis_inv = self.repository.revision_tree(
609
_mod_revision.NULL_REVISION).inventory
610
if len(self.parents) > 0:
611
if basis_revision_id != self.parents[0] and not ghost_basis:
613
"arbitrary basis parents not yet supported with merges")
614
for revtree in revtrees[1:]:
615
for change in revtree.inventory._make_delta(basis_inv):
616
if change[1] is None:
617
# Not present in this parent.
619
if change[2] not in merged_ids:
620
if change[0] is not None:
621
basis_entry = basis_inv[change[2]]
622
merged_ids[change[2]] = [
624
basis_entry.revision,
627
parent_entries[change[2]] = {
629
basis_entry.revision:basis_entry,
631
change[3].revision:change[3],
634
merged_ids[change[2]] = [change[3].revision]
635
parent_entries[change[2]] = {change[3].revision:change[3]}
637
merged_ids[change[2]].append(change[3].revision)
638
parent_entries[change[2]][change[3].revision] = change[3]
641
# Setup the changes from the tree:
642
# changes maps file_id -> (change, [parent revision_ids])
644
for change in iter_changes:
645
# This probably looks up in basis_inv way to much.
646
if change[1][0] is not None:
647
head_candidate = [basis_inv[change[0]].revision]
650
changes[change[0]] = change, merged_ids.get(change[0],
652
unchanged_merged = set(merged_ids) - set(changes)
653
# Extend the changes dict with synthetic changes to record merges of
655
for file_id in unchanged_merged:
656
# Record a merged version of these items that did not change vs the
657
# basis. This can be either identical parallel changes, or a revert
658
# of a specific file after a merge. The recorded content will be
659
# that of the current tree (which is the same as the basis), but
660
# the per-file graph will reflect a merge.
661
# NB:XXX: We are reconstructing path information we had, this
662
# should be preserved instead.
663
# inv delta change: (file_id, (path_in_source, path_in_target),
664
# changed_content, versioned, parent, name, kind,
667
basis_entry = basis_inv[file_id]
668
except errors.NoSuchId:
669
# a change from basis->some_parents but file_id isn't in basis
670
# so was new in the merge, which means it must have changed
671
# from basis -> current, and as it hasn't the add was reverted
672
# by the user. So we discard this change.
676
(basis_inv.id2path(file_id), tree.id2path(file_id)),
678
(basis_entry.parent_id, basis_entry.parent_id),
679
(basis_entry.name, basis_entry.name),
680
(basis_entry.kind, basis_entry.kind),
681
(basis_entry.executable, basis_entry.executable))
682
changes[file_id] = (change, merged_ids[file_id])
683
# changes contains tuples with the change and a set of inventory
684
# candidates for the file.
686
# old_path, new_path, file_id, new_inventory_entry
687
seen_root = False # Is the root in the basis delta?
688
inv_delta = self._basis_delta
689
modified_rev = self._new_revision_id
690
for change, head_candidates in changes.values():
691
if change[3][1]: # versioned in target.
692
# Several things may be happening here:
693
# We may have a fork in the per-file graph
694
# - record a change with the content from tree
695
# We may have a change against < all trees
696
# - carry over the tree that hasn't changed
697
# We may have a change against all trees
698
# - record the change with the content from tree
701
entry = _entry_factory[kind](file_id, change[5][1],
703
head_set = self._heads(change[0], set(head_candidates))
706
for head_candidate in head_candidates:
707
if head_candidate in head_set:
708
heads.append(head_candidate)
709
head_set.remove(head_candidate)
712
# Could be a carry-over situation:
713
parent_entry_revs = parent_entries.get(file_id, None)
714
if parent_entry_revs:
715
parent_entry = parent_entry_revs.get(heads[0], None)
718
if parent_entry is None:
719
# The parent iter_changes was called against is the one
720
# that is the per-file head, so any change is relevant
721
# iter_changes is valid.
722
carry_over_possible = False
724
# could be a carry over situation
725
# A change against the basis may just indicate a merge,
726
# we need to check the content against the source of the
727
# merge to determine if it was changed after the merge
729
if (parent_entry.kind != entry.kind or
730
parent_entry.parent_id != entry.parent_id or
731
parent_entry.name != entry.name):
732
# Metadata common to all entries has changed
733
# against per-file parent
734
carry_over_possible = False
736
carry_over_possible = True
737
# per-type checks for changes against the parent_entry
740
# Cannot be a carry-over situation
741
carry_over_possible = False
742
# Populate the entry in the delta
744
# XXX: There is still a small race here: If someone reverts the content of a file
745
# after iter_changes examines and decides it has changed,
746
# we will unconditionally record a new version even if some
747
# other process reverts it while commit is running (with
748
# the revert happening after iter_changes did it's
751
entry.executable = True
753
entry.executable = False
754
if (carry_over_possible and
755
parent_entry.executable == entry.executable):
756
# Check the file length, content hash after reading
758
nostore_sha = parent_entry.text_sha1
761
file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
763
text = file_obj.read()
767
entry.text_sha1, entry.text_size = self._add_text_to_weave(
768
file_id, text, heads, nostore_sha)
769
yield file_id, change[1][1], (entry.text_sha1, stat_value)
770
except errors.ExistingContent:
771
# No content change against a carry_over parent
772
# Perhaps this should also yield a fs hash update?
774
entry.text_size = parent_entry.text_size
775
entry.text_sha1 = parent_entry.text_sha1
776
elif kind == 'symlink':
778
entry.symlink_target = tree.get_symlink_target(file_id)
779
if (carry_over_possible and
780
parent_entry.symlink_target == entry.symlink_target):
783
self._add_text_to_weave(change[0], '', heads, None)
784
elif kind == 'directory':
785
if carry_over_possible:
788
# Nothing to set on the entry.
789
# XXX: split into the Root and nonRoot versions.
790
if change[1][1] != '' or self.repository.supports_rich_root():
791
self._add_text_to_weave(change[0], '', heads, None)
792
elif kind == 'tree-reference':
793
if not self.repository._format.supports_tree_reference:
794
# This isn't quite sane as an error, but we shouldn't
795
# ever see this code path in practice: tree's don't
796
# permit references when the repo doesn't support tree
798
raise errors.UnsupportedOperation(tree.add_reference,
800
reference_revision = tree.get_reference_revision(change[0])
801
entry.reference_revision = reference_revision
802
if (carry_over_possible and
803
parent_entry.reference_revision == reference_revision):
806
self._add_text_to_weave(change[0], '', heads, None)
808
raise AssertionError('unknown kind %r' % kind)
810
entry.revision = modified_rev
812
entry.revision = parent_entry.revision
815
new_path = change[1][1]
816
inv_delta.append((change[1][0], new_path, change[0], entry))
819
self.new_inventory = None
821
# This should perhaps be guarded by a check that the basis we
822
# commit against is the basis for the commit and if not do a delta
824
self._any_changes = True
826
# housekeeping root entry changes do not affect no-change commits.
827
self._require_root_change(tree)
828
self.basis_delta_revision = basis_revision_id
830
def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
831
parent_keys = tuple([(file_id, parent) for parent in parents])
832
return self.repository.texts._add_text(
833
(file_id, self._new_revision_id), parent_keys, new_text,
834
nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
837
class RootCommitBuilder(CommitBuilder):
838
"""This commitbuilder actually records the root id"""
840
# the root entry gets versioned properly by this builder.
841
_versioned_root = True
843
def _check_root(self, ie, parent_invs, tree):
844
"""Helper for record_entry_contents.
846
:param ie: An entry being added.
847
:param parent_invs: The inventories of the parent revisions of the
849
:param tree: The tree that is being committed.
852
def _require_root_change(self, tree):
853
"""Enforce an appropriate root object change.
855
This is called once when record_iter_changes is called, if and only if
856
the root was not in the delta calculated by record_iter_changes.
858
:param tree: The tree which is being committed.
860
# versioned roots do not change unless the tree found a change.
863
######################################################################
867
class Repository(_RelockDebugMixin):
868
"""Repository holding history for one or more branches.
870
The repository holds and retrieves historical information including
871
revisions and file history. It's normally accessed only by the Branch,
872
which views a particular line of development through that history.
874
The Repository builds on top of some byte storage facilies (the revisions,
875
signatures, inventories, texts and chk_bytes attributes) and a Transport,
876
which respectively provide byte storage and a means to access the (possibly
879
The byte storage facilities are addressed via tuples, which we refer to
880
as 'keys' throughout the code base. Revision_keys, inventory_keys and
881
signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
882
(file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
883
byte string made up of a hash identifier and a hash value.
884
We use this interface because it allows low friction with the underlying
885
code that implements disk indices, network encoding and other parts of
888
:ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
889
the serialised revisions for the repository. This can be used to obtain
890
revision graph information or to access raw serialised revisions.
891
The result of trying to insert data into the repository via this store
892
is undefined: it should be considered read-only except for implementors
894
:ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
895
the serialised signatures for the repository. This can be used to
896
obtain access to raw serialised signatures. The result of trying to
897
insert data into the repository via this store is undefined: it should
898
be considered read-only except for implementors of repositories.
899
:ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
900
the serialised inventories for the repository. This can be used to
901
obtain unserialised inventories. The result of trying to insert data
902
into the repository via this store is undefined: it should be
903
considered read-only except for implementors of repositories.
904
:ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
905
texts of files and directories for the repository. This can be used to
906
obtain file texts or file graphs. Note that Repository.iter_file_bytes
907
is usually a better interface for accessing file texts.
908
The result of trying to insert data into the repository via this store
909
is undefined: it should be considered read-only except for implementors
911
:ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
912
any data the repository chooses to store or have indexed by its hash.
913
The result of trying to insert data into the repository via this store
914
is undefined: it should be considered read-only except for implementors
916
:ivar _transport: Transport for file access to repository, typically
917
pointing to .bzr/repository.
920
# What class to use for a CommitBuilder. Often its simpler to change this
921
# in a Repository class subclass rather than to override
922
# get_commit_builder.
923
_commit_builder_class = CommitBuilder
924
# The search regex used by xml based repositories to determine what things
925
# where changed in a single commit.
926
_file_ids_altered_regex = lazy_regex.lazy_compile(
927
r'file_id="(?P<file_id>[^"]+)"'
928
r'.* revision="(?P<revision_id>[^"]+)"'
931
def abort_write_group(self, suppress_errors=False):
932
"""Commit the contents accrued within the current write group.
934
:param suppress_errors: if true, abort_write_group will catch and log
935
unexpected errors that happen during the abort, rather than
936
allowing them to propagate. Defaults to False.
938
:seealso: start_write_group.
940
if self._write_group is not self.get_transaction():
941
# has an unlock or relock occured ?
944
'(suppressed) mismatched lock context and write group. %r, %r',
945
self._write_group, self.get_transaction())
947
raise errors.BzrError(
948
'mismatched lock context and write group. %r, %r' %
949
(self._write_group, self.get_transaction()))
951
self._abort_write_group()
952
except Exception, exc:
953
self._write_group = None
954
if not suppress_errors:
956
mutter('abort_write_group failed')
957
log_exception_quietly()
958
note('bzr: ERROR (ignored): %s', exc)
959
self._write_group = None
961
def _abort_write_group(self):
962
"""Template method for per-repository write group cleanup.
964
This is called during abort before the write group is considered to be
965
finished and should cleanup any internal state accrued during the write
966
group. There is no requirement that data handed to the repository be
967
*not* made available - this is not a rollback - but neither should any
968
attempt be made to ensure that data added is fully commited. Abort is
969
invoked when an error has occured so futher disk or network operations
970
may not be possible or may error and if possible should not be
974
def add_fallback_repository(self, repository):
975
"""Add a repository to use for looking up data not held locally.
977
:param repository: A repository.
979
if not self._format.supports_external_lookups:
980
raise errors.UnstackableRepositoryFormat(self._format, self.base)
982
# This repository will call fallback.unlock() when we transition to
983
# the unlocked state, so we make sure to increment the lock count
984
repository.lock_read()
985
self._check_fallback_repository(repository)
986
self._fallback_repositories.append(repository)
987
self.texts.add_fallback_versioned_files(repository.texts)
988
self.inventories.add_fallback_versioned_files(repository.inventories)
989
self.revisions.add_fallback_versioned_files(repository.revisions)
990
self.signatures.add_fallback_versioned_files(repository.signatures)
991
if self.chk_bytes is not None:
992
self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
994
def _check_fallback_repository(self, repository):
995
"""Check that this repository can fallback to repository safely.
997
Raise an error if not.
999
:param repository: A repository to fallback to.
1001
return InterRepository._assert_same_model(self, repository)
1003
def add_inventory(self, revision_id, inv, parents):
1004
"""Add the inventory inv to the repository as revision_id.
1006
:param parents: The revision ids of the parents that revision_id
1007
is known to have and are in the repository already.
1009
:returns: The validator(which is a sha1 digest, though what is sha'd is
1010
repository format specific) of the serialized inventory.
1012
if not self.is_in_write_group():
1013
raise AssertionError("%r not in write group" % (self,))
1014
_mod_revision.check_not_reserved_id(revision_id)
1015
if not (inv.revision_id is None or inv.revision_id == revision_id):
1016
raise AssertionError(
1017
"Mismatch between inventory revision"
1018
" id and insertion revid (%r, %r)"
1019
% (inv.revision_id, revision_id))
1020
if inv.root is None:
1021
raise AssertionError()
1022
return self._add_inventory_checked(revision_id, inv, parents)
1024
def _add_inventory_checked(self, revision_id, inv, parents):
1025
"""Add inv to the repository after checking the inputs.
1027
This function can be overridden to allow different inventory styles.
1029
:seealso: add_inventory, for the contract.
1031
inv_lines = self._serializer.write_inventory_to_lines(inv)
1032
return self._inventory_add_lines(revision_id, parents,
1033
inv_lines, check_content=False)
1035
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1036
parents, basis_inv=None, propagate_caches=False):
1037
"""Add a new inventory expressed as a delta against another revision.
1039
See the inventory developers documentation for the theory behind
1042
:param basis_revision_id: The inventory id the delta was created
1043
against. (This does not have to be a direct parent.)
1044
:param delta: The inventory delta (see Inventory.apply_delta for
1046
:param new_revision_id: The revision id that the inventory is being
1048
:param parents: The revision ids of the parents that revision_id is
1049
known to have and are in the repository already. These are supplied
1050
for repositories that depend on the inventory graph for revision
1051
graph access, as well as for those that pun ancestry with delta
1053
:param basis_inv: The basis inventory if it is already known,
1055
:param propagate_caches: If True, the caches for this inventory are
1056
copied to and updated for the result if possible.
1058
:returns: (validator, new_inv)
1059
The validator(which is a sha1 digest, though what is sha'd is
1060
repository format specific) of the serialized inventory, and the
1061
resulting inventory.
1063
if not self.is_in_write_group():
1064
raise AssertionError("%r not in write group" % (self,))
1065
_mod_revision.check_not_reserved_id(new_revision_id)
1066
basis_tree = self.revision_tree(basis_revision_id)
1067
basis_tree.lock_read()
1069
# Note that this mutates the inventory of basis_tree, which not all
1070
# inventory implementations may support: A better idiom would be to
1071
# return a new inventory, but as there is no revision tree cache in
1072
# repository this is safe for now - RBC 20081013
1073
if basis_inv is None:
1074
basis_inv = basis_tree.inventory
1075
basis_inv.apply_delta(delta)
1076
basis_inv.revision_id = new_revision_id
1077
return (self.add_inventory(new_revision_id, basis_inv, parents),
1082
def _inventory_add_lines(self, revision_id, parents, lines,
1083
check_content=True):
1084
"""Store lines in inv_vf and return the sha1 of the inventory."""
1085
parents = [(parent,) for parent in parents]
1086
result = self.inventories.add_lines((revision_id,), parents, lines,
1087
check_content=check_content)[0]
1088
self.inventories._access.flush()
1091
def add_revision(self, revision_id, rev, inv=None, config=None):
1092
"""Add rev to the revision store as revision_id.
1094
:param revision_id: the revision id to use.
1095
:param rev: The revision object.
1096
:param inv: The inventory for the revision. if None, it will be looked
1097
up in the inventory storer
1098
:param config: If None no digital signature will be created.
1099
If supplied its signature_needed method will be used
1100
to determine if a signature should be made.
1102
# TODO: jam 20070210 Shouldn't we check rev.revision_id and
1104
_mod_revision.check_not_reserved_id(revision_id)
1105
if config is not None and config.signature_needed():
1107
inv = self.get_inventory(revision_id)
1108
plaintext = Testament(rev, inv).as_short_text()
1109
self.store_revision_signature(
1110
gpg.GPGStrategy(config), plaintext, revision_id)
1111
# check inventory present
1112
if not self.inventories.get_parent_map([(revision_id,)]):
1114
raise errors.WeaveRevisionNotPresent(revision_id,
1117
# yes, this is not suitable for adding with ghosts.
1118
rev.inventory_sha1 = self.add_inventory(revision_id, inv,
1121
key = (revision_id,)
1122
rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
1123
self._add_revision(rev)
1125
def _add_revision(self, revision):
1126
text = self._serializer.write_revision_to_string(revision)
1127
key = (revision.revision_id,)
1128
parents = tuple((parent,) for parent in revision.parent_ids)
1129
self.revisions.add_lines(key, parents, osutils.split_lines(text))
1131
def all_revision_ids(self):
1132
"""Returns a list of all the revision ids in the repository.
1134
This is conceptually deprecated because code should generally work on
1135
the graph reachable from a particular revision, and ignore any other
1136
revisions that might be present. There is no direct replacement
1139
if 'evil' in debug.debug_flags:
1140
mutter_callsite(2, "all_revision_ids is linear with history.")
1141
return self._all_revision_ids()
1143
def _all_revision_ids(self):
1144
"""Returns a list of all the revision ids in the repository.
1146
These are in as much topological order as the underlying store can
1149
raise NotImplementedError(self._all_revision_ids)
1151
def break_lock(self):
1152
"""Break a lock if one is present from another instance.
1154
Uses the ui factory to ask for confirmation if the lock may be from
1157
self.control_files.break_lock()
1160
def _eliminate_revisions_not_present(self, revision_ids):
1161
"""Check every revision id in revision_ids to see if we have it.
1163
Returns a set of the present revisions.
1166
graph = self.get_graph()
1167
parent_map = graph.get_parent_map(revision_ids)
1168
# The old API returned a list, should this actually be a set?
1169
return parent_map.keys()
1171
def _check_inventories(self, checker):
1172
"""Check the inventories found from the revision scan.
1174
This is responsible for verifying the sha1 of inventories and
1175
creating a pending_keys set that covers data referenced by inventories.
1177
bar = ui.ui_factory.nested_progress_bar()
1179
self._do_check_inventories(checker, bar)
1183
def _do_check_inventories(self, checker, bar):
1184
"""Helper for _check_inventories."""
1186
keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
1187
kinds = ['chk_bytes', 'texts']
1188
count = len(checker.pending_keys)
1189
bar.update("inventories", 0, 2)
1190
current_keys = checker.pending_keys
1191
checker.pending_keys = {}
1192
# Accumulate current checks.
1193
for key in current_keys:
1194
if key[0] != 'inventories' and key[0] not in kinds:
1195
checker._report_items.append('unknown key type %r' % (key,))
1196
keys[key[0]].add(key[1:])
1197
if keys['inventories']:
1198
# NB: output order *should* be roughly sorted - topo or
1199
# inverse topo depending on repository - either way decent
1200
# to just delta against. However, pre-CHK formats didn't
1201
# try to optimise inventory layout on disk. As such the
1202
# pre-CHK code path does not use inventory deltas.
1204
for record in self.inventories.check(keys=keys['inventories']):
1205
if record.storage_kind == 'absent':
1206
checker._report_items.append(
1207
'Missing inventory {%s}' % (record.key,))
1209
last_object = self._check_record('inventories', record,
1210
checker, last_object,
1211
current_keys[('inventories',) + record.key])
1212
del keys['inventories']
1215
bar.update("texts", 1)
1216
while (checker.pending_keys or keys['chk_bytes']
1218
# Something to check.
1219
current_keys = checker.pending_keys
1220
checker.pending_keys = {}
1221
# Accumulate current checks.
1222
for key in current_keys:
1223
if key[0] not in kinds:
1224
checker._report_items.append('unknown key type %r' % (key,))
1225
keys[key[0]].add(key[1:])
1226
# Check the outermost kind only - inventories || chk_bytes || texts
1230
for record in getattr(self, kind).check(keys=keys[kind]):
1231
if record.storage_kind == 'absent':
1232
checker._report_items.append(
1233
'Missing %s {%s}' % (kind, record.key,))
1235
last_object = self._check_record(kind, record,
1236
checker, last_object, current_keys[(kind,) + record.key])
1240
def _check_record(self, kind, record, checker, last_object, item_data):
1241
"""Check a single text from this repository."""
1242
if kind == 'inventories':
1243
rev_id = record.key[0]
1244
inv = self._deserialise_inventory(rev_id,
1245
record.get_bytes_as('fulltext'))
1246
if last_object is not None:
1247
delta = inv._make_delta(last_object)
1248
for old_path, path, file_id, ie in delta:
1251
ie.check(checker, rev_id, inv)
1253
for path, ie in inv.iter_entries():
1254
ie.check(checker, rev_id, inv)
1255
if self._format.fast_deltas:
1257
elif kind == 'chk_bytes':
1258
# No code written to check chk_bytes for this repo format.
1259
checker._report_items.append(
1260
'unsupported key type chk_bytes for %s' % (record.key,))
1261
elif kind == 'texts':
1262
self._check_text(record, checker, item_data)
1264
checker._report_items.append(
1265
'unknown key type %s for %s' % (kind, record.key))
1267
def _check_text(self, record, checker, item_data):
1268
"""Check a single text."""
1269
# Check it is extractable.
1270
# TODO: check length.
1271
if record.storage_kind == 'chunked':
1272
chunks = record.get_bytes_as(record.storage_kind)
1273
sha1 = osutils.sha_strings(chunks)
1274
length = sum(map(len, chunks))
1276
content = record.get_bytes_as('fulltext')
1277
sha1 = osutils.sha_string(content)
1278
length = len(content)
1279
if item_data and sha1 != item_data[1]:
1280
checker._report_items.append(
1281
'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
1282
(record.key, sha1, item_data[1], item_data[2]))
1285
def create(a_bzrdir):
1286
"""Construct the current default format repository in a_bzrdir."""
1287
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
1289
def __init__(self, _format, a_bzrdir, control_files):
1290
"""instantiate a Repository.
1292
:param _format: The format of the repository on disk.
1293
:param a_bzrdir: The BzrDir of the repository.
1295
In the future we will have a single api for all stores for
1296
getting file texts, inventories and revisions, then
1297
this construct will accept instances of those things.
1299
super(Repository, self).__init__()
1300
self._format = _format
1301
# the following are part of the public API for Repository:
1302
self.bzrdir = a_bzrdir
1303
self.control_files = control_files
1304
self._transport = control_files._transport
1305
self.base = self._transport.base
1307
self._reconcile_does_inventory_gc = True
1308
self._reconcile_fixes_text_parents = False
1309
self._reconcile_backsup_inventory = True
1310
self._write_group = None
1311
# Additional places to query for data.
1312
self._fallback_repositories = []
1313
# An InventoryEntry cache, used during deserialization
1314
self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
1315
# Is it safe to return inventory entries directly from the entry cache,
1316
# rather copying them?
1317
self._safe_to_return_from_cache = False
1320
if self._fallback_repositories:
1321
return '%s(%r, fallback_repositories=%r)' % (
1322
self.__class__.__name__,
1324
self._fallback_repositories)
1326
return '%s(%r)' % (self.__class__.__name__,
1329
def _has_same_fallbacks(self, other_repo):
1330
"""Returns true if the repositories have the same fallbacks."""
1331
my_fb = self._fallback_repositories
1332
other_fb = other_repo._fallback_repositories
1333
if len(my_fb) != len(other_fb):
1335
for f, g in zip(my_fb, other_fb):
1336
if not f.has_same_location(g):
1340
def has_same_location(self, other):
1341
"""Returns a boolean indicating if this repository is at the same
1342
location as another repository.
1344
This might return False even when two repository objects are accessing
1345
the same physical repository via different URLs.
1347
if self.__class__ is not other.__class__:
1349
return (self._transport.base == other._transport.base)
1351
def is_in_write_group(self):
1352
"""Return True if there is an open write group.
1354
:seealso: start_write_group.
1356
return self._write_group is not None
1358
def is_locked(self):
1359
return self.control_files.is_locked()
1361
def is_write_locked(self):
1362
"""Return True if this object is write locked."""
1363
return self.is_locked() and self.control_files._lock_mode == 'w'
1365
def lock_write(self, token=None):
1366
"""Lock this repository for writing.
1368
This causes caching within the repository obejct to start accumlating
1369
data during reads, and allows a 'write_group' to be obtained. Write
1370
groups must be used for actual data insertion.
1372
:param token: if this is already locked, then lock_write will fail
1373
unless the token matches the existing lock.
1374
:returns: a token if this instance supports tokens, otherwise None.
1375
:raises TokenLockingNotSupported: when a token is given but this
1376
instance doesn't support using token locks.
1377
:raises MismatchedToken: if the specified token doesn't match the token
1378
of the existing lock.
1379
:seealso: start_write_group.
1381
A token should be passed in if you know that you have locked the object
1382
some other way, and need to synchronise this object's state with that
1385
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1387
locked = self.is_locked()
1388
result = self.control_files.lock_write(token=token)
1390
self._warn_if_deprecated()
1391
self._note_lock('w')
1392
for repo in self._fallback_repositories:
1393
# Writes don't affect fallback repos
1395
self._refresh_data()
1398
def lock_read(self):
1399
locked = self.is_locked()
1400
self.control_files.lock_read()
1402
self._warn_if_deprecated()
1403
self._note_lock('r')
1404
for repo in self._fallback_repositories:
1406
self._refresh_data()
1408
def get_physical_lock_status(self):
1409
return self.control_files.get_physical_lock_status()
1411
def leave_lock_in_place(self):
1412
"""Tell this repository not to release the physical lock when this
1415
If lock_write doesn't return a token, then this method is not supported.
1417
self.control_files.leave_in_place()
1419
def dont_leave_lock_in_place(self):
1420
"""Tell this repository to release the physical lock when this
1421
object is unlocked, even if it didn't originally acquire it.
1423
If lock_write doesn't return a token, then this method is not supported.
1425
self.control_files.dont_leave_in_place()
1428
def gather_stats(self, revid=None, committers=None):
1429
"""Gather statistics from a revision id.
1431
:param revid: The revision id to gather statistics from, if None, then
1432
no revision specific statistics are gathered.
1433
:param committers: Optional parameter controlling whether to grab
1434
a count of committers from the revision specific statistics.
1435
:return: A dictionary of statistics. Currently this contains:
1436
committers: The number of committers if requested.
1437
firstrev: A tuple with timestamp, timezone for the penultimate left
1438
most ancestor of revid, if revid is not the NULL_REVISION.
1439
latestrev: A tuple with timestamp, timezone for revid, if revid is
1440
not the NULL_REVISION.
1441
revisions: The total revision count in the repository.
1442
size: An estimate disk size of the repository in bytes.
1445
if revid and committers:
1446
result['committers'] = 0
1447
if revid and revid != _mod_revision.NULL_REVISION:
1449
all_committers = set()
1450
revisions = self.get_ancestry(revid)
1451
# pop the leading None
1453
first_revision = None
1455
# ignore the revisions in the middle - just grab first and last
1456
revisions = revisions[0], revisions[-1]
1457
for revision in self.get_revisions(revisions):
1458
if not first_revision:
1459
first_revision = revision
1461
all_committers.add(revision.committer)
1462
last_revision = revision
1464
result['committers'] = len(all_committers)
1465
result['firstrev'] = (first_revision.timestamp,
1466
first_revision.timezone)
1467
result['latestrev'] = (last_revision.timestamp,
1468
last_revision.timezone)
1470
# now gather global repository information
1471
# XXX: This is available for many repos regardless of listability.
1472
if self.bzrdir.root_transport.listable():
1473
# XXX: do we want to __define len__() ?
1474
# Maybe the versionedfiles object should provide a different
1475
# method to get the number of keys.
1476
result['revisions'] = len(self.revisions.keys())
1477
# result['size'] = t
1480
def find_branches(self, using=False):
1481
"""Find branches underneath this repository.
1483
This will include branches inside other branches.
1485
:param using: If True, list only branches using this repository.
1487
if using and not self.is_shared():
1488
return self.bzrdir.list_branches()
1489
class Evaluator(object):
1492
self.first_call = True
1494
def __call__(self, bzrdir):
1495
# On the first call, the parameter is always the bzrdir
1496
# containing the current repo.
1497
if not self.first_call:
1499
repository = bzrdir.open_repository()
1500
except errors.NoRepositoryPresent:
1503
return False, ([], repository)
1504
self.first_call = False
1505
value = (bzrdir.list_branches(), None)
1509
for branches, repository in bzrdir.BzrDir.find_bzrdirs(
1510
self.bzrdir.root_transport, evaluate=Evaluator()):
1511
if branches is not None:
1512
ret.extend(branches)
1513
if not using and repository is not None:
1514
ret.extend(repository.find_branches())
1518
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1519
"""Return the revision ids that other has that this does not.
1521
These are returned in topological order.
1523
revision_id: only return revision ids included by revision_id.
1525
return InterRepository.get(other, self).search_missing_revision_ids(
1526
revision_id, find_ghosts)
1530
"""Open the repository rooted at base.
1532
For instance, if the repository is at URL/.bzr/repository,
1533
Repository.open(URL) -> a Repository instance.
1535
control = bzrdir.BzrDir.open(base)
1536
return control.open_repository()
1538
def copy_content_into(self, destination, revision_id=None):
1539
"""Make a complete copy of the content in self into destination.
1541
This is a destructive operation! Do not use it on existing
1544
return InterRepository.get(self, destination).copy_content(revision_id)
1546
def commit_write_group(self):
1547
"""Commit the contents accrued within the current write group.
1549
:seealso: start_write_group.
1551
:return: it may return an opaque hint that can be passed to 'pack'.
1553
if self._write_group is not self.get_transaction():
1554
# has an unlock or relock occured ?
1555
raise errors.BzrError('mismatched lock context %r and '
1557
(self.get_transaction(), self._write_group))
1558
result = self._commit_write_group()
1559
self._write_group = None
1562
def _commit_write_group(self):
1563
"""Template method for per-repository write group cleanup.
1565
This is called before the write group is considered to be
1566
finished and should ensure that all data handed to the repository
1567
for writing during the write group is safely committed (to the
1568
extent possible considering file system caching etc).
1571
def suspend_write_group(self):
1572
raise errors.UnsuspendableWriteGroup(self)
1574
def get_missing_parent_inventories(self, check_for_missing_texts=True):
1575
"""Return the keys of missing inventory parents for revisions added in
1578
A revision is not complete if the inventory delta for that revision
1579
cannot be calculated. Therefore if the parent inventories of a
1580
revision are not present, the revision is incomplete, and e.g. cannot
1581
be streamed by a smart server. This method finds missing inventory
1582
parents for revisions added in this write group.
1584
if not self._format.supports_external_lookups:
1585
# This is only an issue for stacked repositories
1587
if not self.is_in_write_group():
1588
raise AssertionError('not in a write group')
1590
# XXX: We assume that every added revision already has its
1591
# corresponding inventory, so we only check for parent inventories that
1592
# might be missing, rather than all inventories.
1593
parents = set(self.revisions._index.get_missing_parents())
1594
parents.discard(_mod_revision.NULL_REVISION)
1595
unstacked_inventories = self.inventories._index
1596
present_inventories = unstacked_inventories.get_parent_map(
1597
key[-1:] for key in parents)
1598
parents.difference_update(present_inventories)
1599
if len(parents) == 0:
1600
# No missing parent inventories.
1602
if not check_for_missing_texts:
1603
return set(('inventories', rev_id) for (rev_id,) in parents)
1604
# Ok, now we have a list of missing inventories. But these only matter
1605
# if the inventories that reference them are missing some texts they
1606
# appear to introduce.
1607
# XXX: Texts referenced by all added inventories need to be present,
1608
# but at the moment we're only checking for texts referenced by
1609
# inventories at the graph's edge.
1610
key_deps = self.revisions._index._key_dependencies
1611
key_deps.satisfy_refs_for_keys(present_inventories)
1612
referrers = frozenset(r[0] for r in key_deps.get_referrers())
1613
file_ids = self.fileids_altered_by_revision_ids(referrers)
1614
missing_texts = set()
1615
for file_id, version_ids in file_ids.iteritems():
1616
missing_texts.update(
1617
(file_id, version_id) for version_id in version_ids)
1618
present_texts = self.texts.get_parent_map(missing_texts)
1619
missing_texts.difference_update(present_texts)
1620
if not missing_texts:
1621
# No texts are missing, so all revisions and their deltas are
1624
# Alternatively the text versions could be returned as the missing
1625
# keys, but this is likely to be less data.
1626
missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
1629
def refresh_data(self):
1630
"""Re-read any data needed to to synchronise with disk.
1632
This method is intended to be called after another repository instance
1633
(such as one used by a smart server) has inserted data into the
1634
repository. It may not be called during a write group, but may be
1635
called at any other time.
1637
if self.is_in_write_group():
1638
raise errors.InternalBzrError(
1639
"May not refresh_data while in a write group.")
1640
self._refresh_data()
1642
def resume_write_group(self, tokens):
1643
if not self.is_write_locked():
1644
raise errors.NotWriteLocked(self)
1645
if self._write_group:
1646
raise errors.BzrError('already in a write group')
1647
self._resume_write_group(tokens)
1648
# so we can detect unlock/relock - the write group is now entered.
1649
self._write_group = self.get_transaction()
1651
def _resume_write_group(self, tokens):
1652
raise errors.UnsuspendableWriteGroup(self)
1654
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1656
"""Fetch the content required to construct revision_id from source.
1658
If revision_id is None and fetch_spec is None, then all content is
1661
fetch() may not be used when the repository is in a write group -
1662
either finish the current write group before using fetch, or use
1663
fetch before starting the write group.
1665
:param find_ghosts: Find and copy revisions in the source that are
1666
ghosts in the target (and not reachable directly by walking out to
1667
the first-present revision in target from revision_id).
1668
:param revision_id: If specified, all the content needed for this
1669
revision ID will be copied to the target. Fetch will determine for
1670
itself which content needs to be copied.
1671
:param fetch_spec: If specified, a SearchResult or
1672
PendingAncestryResult that describes which revisions to copy. This
1673
allows copying multiple heads at once. Mutually exclusive with
1676
if fetch_spec is not None and revision_id is not None:
1677
raise AssertionError(
1678
"fetch_spec and revision_id are mutually exclusive.")
1679
if self.is_in_write_group():
1680
raise errors.InternalBzrError(
1681
"May not fetch while in a write group.")
1682
# fast path same-url fetch operations
1683
# TODO: lift out to somewhere common with RemoteRepository
1684
# <https://bugs.edge.launchpad.net/bzr/+bug/401646>
1685
if (self.has_same_location(source)
1686
and fetch_spec is None
1687
and self._has_same_fallbacks(source)):
1688
# check that last_revision is in 'from' and then return a
1690
if (revision_id is not None and
1691
not _mod_revision.is_null(revision_id)):
1692
self.get_revision(revision_id)
1694
# if there is no specific appropriate InterRepository, this will get
1695
# the InterRepository base class, which raises an
1696
# IncompatibleRepositories when asked to fetch.
1697
inter = InterRepository.get(source, self)
1698
return inter.fetch(revision_id=revision_id, pb=pb,
1699
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1701
def create_bundle(self, target, base, fileobj, format=None):
1702
return serializer.write_bundle(self, target, base, fileobj, format)
1704
def get_commit_builder(self, branch, parents, config, timestamp=None,
1705
timezone=None, committer=None, revprops=None,
1707
"""Obtain a CommitBuilder for this repository.
1709
:param branch: Branch to commit to.
1710
:param parents: Revision ids of the parents of the new revision.
1711
:param config: Configuration to use.
1712
:param timestamp: Optional timestamp recorded for commit.
1713
:param timezone: Optional timezone for timestamp.
1714
:param committer: Optional committer to set for commit.
1715
:param revprops: Optional dictionary of revision properties.
1716
:param revision_id: Optional revision id.
1718
if self._fallback_repositories:
1719
raise errors.BzrError("Cannot commit from a lightweight checkout "
1720
"to a stacked branch. See "
1721
"https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1722
result = self._commit_builder_class(self, parents, config,
1723
timestamp, timezone, committer, revprops, revision_id)
1724
self.start_write_group()
1727
@only_raises(errors.LockNotHeld, errors.LockBroken)
1729
if (self.control_files._lock_count == 1 and
1730
self.control_files._lock_mode == 'w'):
1731
if self._write_group is not None:
1732
self.abort_write_group()
1733
self.control_files.unlock()
1734
raise errors.BzrError(
1735
'Must end write groups before releasing write locks.')
1736
self.control_files.unlock()
1737
if self.control_files._lock_count == 0:
1738
self._inventory_entry_cache.clear()
1739
for repo in self._fallback_repositories:
1743
def clone(self, a_bzrdir, revision_id=None):
1744
"""Clone this repository into a_bzrdir using the current format.
1746
Currently no check is made that the format of this repository and
1747
the bzrdir format are compatible. FIXME RBC 20060201.
1749
:return: The newly created destination repository.
1751
# TODO: deprecate after 0.16; cloning this with all its settings is
1752
# probably not very useful -- mbp 20070423
1753
dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
1754
self.copy_content_into(dest_repo, revision_id)
1757
def start_write_group(self):
1758
"""Start a write group in the repository.
1760
Write groups are used by repositories which do not have a 1:1 mapping
1761
between file ids and backend store to manage the insertion of data from
1762
both fetch and commit operations.
1764
A write lock is required around the start_write_group/commit_write_group
1765
for the support of lock-requiring repository formats.
1767
One can only insert data into a repository inside a write group.
1771
if not self.is_write_locked():
1772
raise errors.NotWriteLocked(self)
1773
if self._write_group:
1774
raise errors.BzrError('already in a write group')
1775
self._start_write_group()
1776
# so we can detect unlock/relock - the write group is now entered.
1777
self._write_group = self.get_transaction()
1779
def _start_write_group(self):
1780
"""Template method for per-repository write group startup.
1782
This is called before the write group is considered to be
1787
def sprout(self, to_bzrdir, revision_id=None):
1788
"""Create a descendent repository for new development.
1790
Unlike clone, this does not copy the settings of the repository.
1792
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1793
dest_repo.fetch(self, revision_id=revision_id)
1796
def _create_sprouting_repo(self, a_bzrdir, shared):
1797
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1798
# use target default format.
1799
dest_repo = a_bzrdir.create_repository()
1801
# Most control formats need the repository to be specifically
1802
# created, but on some old all-in-one formats it's not needed
1804
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1805
except errors.UninitializableFormat:
1806
dest_repo = a_bzrdir.open_repository()
1809
def _get_sink(self):
1810
"""Return a sink for streaming into this repository."""
1811
return StreamSink(self)
1813
def _get_source(self, to_format):
1814
"""Return a source for streaming from this repository."""
1815
return StreamSource(self, to_format)
1818
def has_revision(self, revision_id):
1819
"""True if this repository has a copy of the revision."""
1820
return revision_id in self.has_revisions((revision_id,))
1823
def has_revisions(self, revision_ids):
1824
"""Probe to find out the presence of multiple revisions.
1826
:param revision_ids: An iterable of revision_ids.
1827
:return: A set of the revision_ids that were present.
1829
parent_map = self.revisions.get_parent_map(
1830
[(rev_id,) for rev_id in revision_ids])
1832
if _mod_revision.NULL_REVISION in revision_ids:
1833
result.add(_mod_revision.NULL_REVISION)
1834
result.update([key[0] for key in parent_map])
1838
def get_revision(self, revision_id):
1839
"""Return the Revision object for a named revision."""
1840
return self.get_revisions([revision_id])[0]
1843
def get_revision_reconcile(self, revision_id):
1844
"""'reconcile' helper routine that allows access to a revision always.
1846
This variant of get_revision does not cross check the weave graph
1847
against the revision one as get_revision does: but it should only
1848
be used by reconcile, or reconcile-alike commands that are correcting
1849
or testing the revision graph.
1851
return self._get_revisions([revision_id])[0]
1854
def get_revisions(self, revision_ids):
1855
"""Get many revisions at once.
1857
Repositories that need to check data on every revision read should
1858
subclass this method.
1860
return self._get_revisions(revision_ids)
1863
def _get_revisions(self, revision_ids):
1864
"""Core work logic to get many revisions without sanity checks."""
1866
for revid, rev in self._iter_revisions(revision_ids):
1868
raise errors.NoSuchRevision(self, revid)
1870
return [revs[revid] for revid in revision_ids]
1872
def _iter_revisions(self, revision_ids):
1873
"""Iterate over revision objects.
1875
:param revision_ids: An iterable of revisions to examine. None may be
1876
passed to request all revisions known to the repository. Note that
1877
not all repositories can find unreferenced revisions; for those
1878
repositories only referenced ones will be returned.
1879
:return: An iterator of (revid, revision) tuples. Absent revisions (
1880
those asked for but not available) are returned as (revid, None).
1882
if revision_ids is None:
1883
revision_ids = self.all_revision_ids()
1885
for rev_id in revision_ids:
1886
if not rev_id or not isinstance(rev_id, basestring):
1887
raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1888
keys = [(key,) for key in revision_ids]
1889
stream = self.revisions.get_record_stream(keys, 'unordered', True)
1890
for record in stream:
1891
revid = record.key[0]
1892
if record.storage_kind == 'absent':
1895
text = record.get_bytes_as('fulltext')
1896
rev = self._serializer.read_revision_from_string(text)
1899
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1900
"""Produce a generator of revision deltas.
1902
Note that the input is a sequence of REVISIONS, not revision_ids.
1903
Trees will be held in memory until the generator exits.
1904
Each delta is relative to the revision's lefthand predecessor.
1906
:param specific_fileids: if not None, the result is filtered
1907
so that only those file-ids, their parents and their
1908
children are included.
1910
# Get the revision-ids of interest
1911
required_trees = set()
1912
for revision in revisions:
1913
required_trees.add(revision.revision_id)
1914
required_trees.update(revision.parent_ids[:1])
1916
# Get the matching filtered trees. Note that it's more
1917
# efficient to pass filtered trees to changes_from() rather
1918
# than doing the filtering afterwards. changes_from() could
1919
# arguably do the filtering itself but it's path-based, not
1920
# file-id based, so filtering before or afterwards is
1922
if specific_fileids is None:
1923
trees = dict((t.get_revision_id(), t) for
1924
t in self.revision_trees(required_trees))
1926
trees = dict((t.get_revision_id(), t) for
1927
t in self._filtered_revision_trees(required_trees,
1930
# Calculate the deltas
1931
for revision in revisions:
1932
if not revision.parent_ids:
1933
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1935
old_tree = trees[revision.parent_ids[0]]
1936
yield trees[revision.revision_id].changes_from(old_tree)
1939
def get_revision_delta(self, revision_id, specific_fileids=None):
1940
"""Return the delta for one revision.
1942
The delta is relative to the left-hand predecessor of the
1945
:param specific_fileids: if not None, the result is filtered
1946
so that only those file-ids, their parents and their
1947
children are included.
1949
r = self.get_revision(revision_id)
1950
return list(self.get_deltas_for_revisions([r],
1951
specific_fileids=specific_fileids))[0]
1954
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1955
signature = gpg_strategy.sign(plaintext)
1956
self.add_signature_text(revision_id, signature)
1959
def add_signature_text(self, revision_id, signature):
1960
self.signatures.add_lines((revision_id,), (),
1961
osutils.split_lines(signature))
1963
def find_text_key_references(self):
1964
"""Find the text key references within the repository.
1966
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1967
to whether they were referred to by the inventory of the
1968
revision_id that they contain. The inventory texts from all present
1969
revision ids are assessed to generate this report.
1971
revision_keys = self.revisions.keys()
1972
w = self.inventories
1973
pb = ui.ui_factory.nested_progress_bar()
1975
return self._find_text_key_references_from_xml_inventory_lines(
1976
w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
1980
def _find_text_key_references_from_xml_inventory_lines(self,
1982
"""Core routine for extracting references to texts from inventories.
1984
This performs the translation of xml lines to revision ids.
1986
:param line_iterator: An iterator of lines, origin_version_id
1987
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1988
to whether they were referred to by the inventory of the
1989
revision_id that they contain. Note that if that revision_id was
1990
not part of the line_iterator's output then False will be given -
1991
even though it may actually refer to that key.
1993
if not self._serializer.support_altered_by_hack:
1994
raise AssertionError(
1995
"_find_text_key_references_from_xml_inventory_lines only "
1996
"supported for branches which store inventory as unnested xml"
1997
", not on %r" % self)
2000
# this code needs to read every new line in every inventory for the
2001
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
2002
# not present in one of those inventories is unnecessary but not
2003
# harmful because we are filtering by the revision id marker in the
2004
# inventory lines : we only select file ids altered in one of those
2005
# revisions. We don't need to see all lines in the inventory because
2006
# only those added in an inventory in rev X can contain a revision=X
2008
unescape_revid_cache = {}
2009
unescape_fileid_cache = {}
2011
# jam 20061218 In a big fetch, this handles hundreds of thousands
2012
# of lines, so it has had a lot of inlining and optimizing done.
2013
# Sorry that it is a little bit messy.
2014
# Move several functions to be local variables, since this is a long
2016
search = self._file_ids_altered_regex.search
2017
unescape = _unescape_xml
2018
setdefault = result.setdefault
2019
for line, line_key in line_iterator:
2020
match = search(line)
2023
# One call to match.group() returning multiple items is quite a
2024
# bit faster than 2 calls to match.group() each returning 1
2025
file_id, revision_id = match.group('file_id', 'revision_id')
2027
# Inlining the cache lookups helps a lot when you make 170,000
2028
# lines and 350k ids, versus 8.4 unique ids.
2029
# Using a cache helps in 2 ways:
2030
# 1) Avoids unnecessary decoding calls
2031
# 2) Re-uses cached strings, which helps in future set and
2033
# (2) is enough that removing encoding entirely along with
2034
# the cache (so we are using plain strings) results in no
2035
# performance improvement.
2037
revision_id = unescape_revid_cache[revision_id]
2039
unescaped = unescape(revision_id)
2040
unescape_revid_cache[revision_id] = unescaped
2041
revision_id = unescaped
2043
# Note that unconditionally unescaping means that we deserialise
2044
# every fileid, which for general 'pull' is not great, but we don't
2045
# really want to have some many fulltexts that this matters anyway.
2048
file_id = unescape_fileid_cache[file_id]
2050
unescaped = unescape(file_id)
2051
unescape_fileid_cache[file_id] = unescaped
2054
key = (file_id, revision_id)
2055
setdefault(key, False)
2056
if revision_id == line_key[-1]:
2060
def _inventory_xml_lines_for_keys(self, keys):
2061
"""Get a line iterator of the sort needed for findind references.
2063
Not relevant for non-xml inventory repositories.
2065
Ghosts in revision_keys are ignored.
2067
:param revision_keys: The revision keys for the inventories to inspect.
2068
:return: An iterator over (inventory line, revid) for the fulltexts of
2069
all of the xml inventories specified by revision_keys.
2071
stream = self.inventories.get_record_stream(keys, 'unordered', True)
2072
for record in stream:
2073
if record.storage_kind != 'absent':
2074
chunks = record.get_bytes_as('chunked')
2075
revid = record.key[-1]
2076
lines = osutils.chunks_to_lines(chunks)
2080
def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2082
"""Helper routine for fileids_altered_by_revision_ids.
2084
This performs the translation of xml lines to revision ids.
2086
:param line_iterator: An iterator of lines, origin_version_id
2087
:param revision_keys: The revision ids to filter for. This should be a
2088
set or other type which supports efficient __contains__ lookups, as
2089
the revision key from each parsed line will be looked up in the
2090
revision_keys filter.
2091
:return: a dictionary mapping altered file-ids to an iterable of
2092
revision_ids. Each altered file-ids has the exact revision_ids that
2093
altered it listed explicitly.
2095
seen = set(self._find_text_key_references_from_xml_inventory_lines(
2096
line_iterator).iterkeys())
2097
parent_keys = self._find_parent_keys_of_revisions(revision_keys)
2098
parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2099
self._inventory_xml_lines_for_keys(parent_keys)))
2100
new_keys = seen - parent_seen
2102
setdefault = result.setdefault
2103
for key in new_keys:
2104
setdefault(key[0], set()).add(key[-1])
2107
def _find_parent_ids_of_revisions(self, revision_ids):
2108
"""Find all parent ids that are mentioned in the revision graph.
2110
:return: set of revisions that are parents of revision_ids which are
2111
not part of revision_ids themselves
2113
parent_map = self.get_parent_map(revision_ids)
2115
map(parent_ids.update, parent_map.itervalues())
2116
parent_ids.difference_update(revision_ids)
2117
parent_ids.discard(_mod_revision.NULL_REVISION)
2120
def _find_parent_keys_of_revisions(self, revision_keys):
2121
"""Similar to _find_parent_ids_of_revisions, but used with keys.
2123
:param revision_keys: An iterable of revision_keys.
2124
:return: The parents of all revision_keys that are not already in
2127
parent_map = self.revisions.get_parent_map(revision_keys)
2129
map(parent_keys.update, parent_map.itervalues())
2130
parent_keys.difference_update(revision_keys)
2131
parent_keys.discard(_mod_revision.NULL_REVISION)
2134
def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2135
"""Find the file ids and versions affected by revisions.
2137
:param revisions: an iterable containing revision ids.
2138
:param _inv_weave: The inventory weave from this repository or None.
2139
If None, the inventory weave will be opened automatically.
2140
:return: a dictionary mapping altered file-ids to an iterable of
2141
revision_ids. Each altered file-ids has the exact revision_ids that
2142
altered it listed explicitly.
2144
selected_keys = set((revid,) for revid in revision_ids)
2145
w = _inv_weave or self.inventories
2146
return self._find_file_ids_from_xml_inventory_lines(
2147
w.iter_lines_added_or_present_in_keys(
2148
selected_keys, pb=None),
2151
def iter_files_bytes(self, desired_files):
2152
"""Iterate through file versions.
2154
Files will not necessarily be returned in the order they occur in
2155
desired_files. No specific order is guaranteed.
2157
Yields pairs of identifier, bytes_iterator. identifier is an opaque
2158
value supplied by the caller as part of desired_files. It should
2159
uniquely identify the file version in the caller's context. (Examples:
2160
an index number or a TreeTransform trans_id.)
2162
bytes_iterator is an iterable of bytestrings for the file. The
2163
kind of iterable and length of the bytestrings are unspecified, but for
2164
this implementation, it is a list of bytes produced by
2165
VersionedFile.get_record_stream().
2167
:param desired_files: a list of (file_id, revision_id, identifier)
2171
for file_id, revision_id, callable_data in desired_files:
2172
text_keys[(file_id, revision_id)] = callable_data
2173
for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2174
if record.storage_kind == 'absent':
2175
raise errors.RevisionNotPresent(record.key, self)
2176
yield text_keys[record.key], record.get_bytes_as('chunked')
2178
def _generate_text_key_index(self, text_key_references=None,
2180
"""Generate a new text key index for the repository.
2182
This is an expensive function that will take considerable time to run.
2184
:return: A dict mapping text keys ((file_id, revision_id) tuples) to a
2185
list of parents, also text keys. When a given key has no parents,
2186
the parents list will be [NULL_REVISION].
2188
# All revisions, to find inventory parents.
2189
if ancestors is None:
2190
graph = self.get_graph()
2191
ancestors = graph.get_parent_map(self.all_revision_ids())
2192
if text_key_references is None:
2193
text_key_references = self.find_text_key_references()
2194
pb = ui.ui_factory.nested_progress_bar()
2196
return self._do_generate_text_key_index(ancestors,
2197
text_key_references, pb)
2201
def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
2202
"""Helper for _generate_text_key_index to avoid deep nesting."""
2203
revision_order = tsort.topo_sort(ancestors)
2204
invalid_keys = set()
2206
for revision_id in revision_order:
2207
revision_keys[revision_id] = set()
2208
text_count = len(text_key_references)
2209
# a cache of the text keys to allow reuse; costs a dict of all the
2210
# keys, but saves a 2-tuple for every child of a given key.
2212
for text_key, valid in text_key_references.iteritems():
2214
invalid_keys.add(text_key)
2216
revision_keys[text_key[1]].add(text_key)
2217
text_key_cache[text_key] = text_key
2218
del text_key_references
2220
text_graph = graph.Graph(graph.DictParentsProvider(text_index))
2221
NULL_REVISION = _mod_revision.NULL_REVISION
2222
# Set a cache with a size of 10 - this suffices for bzr.dev but may be
2223
# too small for large or very branchy trees. However, for 55K path
2224
# trees, it would be easy to use too much memory trivially. Ideally we
2225
# could gauge this by looking at available real memory etc, but this is
2226
# always a tricky proposition.
2227
inventory_cache = lru_cache.LRUCache(10)
2228
batch_size = 10 # should be ~150MB on a 55K path tree
2229
batch_count = len(revision_order) / batch_size + 1
2231
pb.update("Calculating text parents", processed_texts, text_count)
2232
for offset in xrange(batch_count):
2233
to_query = revision_order[offset * batch_size:(offset + 1) *
2237
for revision_id in to_query:
2238
parent_ids = ancestors[revision_id]
2239
for text_key in revision_keys[revision_id]:
2240
pb.update("Calculating text parents", processed_texts)
2241
processed_texts += 1
2242
candidate_parents = []
2243
for parent_id in parent_ids:
2244
parent_text_key = (text_key[0], parent_id)
2246
check_parent = parent_text_key not in \
2247
revision_keys[parent_id]
2249
# the parent parent_id is a ghost:
2250
check_parent = False
2251
# truncate the derived graph against this ghost.
2252
parent_text_key = None
2254
# look at the parent commit details inventories to
2255
# determine possible candidates in the per file graph.
2258
inv = inventory_cache[parent_id]
2260
inv = self.revision_tree(parent_id).inventory
2261
inventory_cache[parent_id] = inv
2263
parent_entry = inv[text_key[0]]
2264
except (KeyError, errors.NoSuchId):
2266
if parent_entry is not None:
2268
text_key[0], parent_entry.revision)
2270
parent_text_key = None
2271
if parent_text_key is not None:
2272
candidate_parents.append(
2273
text_key_cache[parent_text_key])
2274
parent_heads = text_graph.heads(candidate_parents)
2275
new_parents = list(parent_heads)
2276
new_parents.sort(key=lambda x:candidate_parents.index(x))
2277
if new_parents == []:
2278
new_parents = [NULL_REVISION]
2279
text_index[text_key] = new_parents
2281
for text_key in invalid_keys:
2282
text_index[text_key] = [NULL_REVISION]
2285
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2286
"""Get an iterable listing the keys of all the data introduced by a set
2289
The keys will be ordered so that the corresponding items can be safely
2290
fetched and inserted in that order.
2292
:returns: An iterable producing tuples of (knit-kind, file-id,
2293
versions). knit-kind is one of 'file', 'inventory', 'signatures',
2294
'revisions'. file-id is None unless knit-kind is 'file'.
2296
for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2299
for result in self._find_non_file_keys_to_fetch(revision_ids):
2302
def _find_file_keys_to_fetch(self, revision_ids, pb):
2303
# XXX: it's a bit weird to control the inventory weave caching in this
2304
# generator. Ideally the caching would be done in fetch.py I think. Or
2305
# maybe this generator should explicitly have the contract that it
2306
# should not be iterated until the previously yielded item has been
2308
inv_w = self.inventories
2310
# file ids that changed
2311
file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
2313
num_file_ids = len(file_ids)
2314
for file_id, altered_versions in file_ids.iteritems():
2316
pb.update("Fetch texts", count, num_file_ids)
2318
yield ("file", file_id, altered_versions)
2320
def _find_non_file_keys_to_fetch(self, revision_ids):
2322
yield ("inventory", None, revision_ids)
2325
# XXX: Note ATM no callers actually pay attention to this return
2326
# instead they just use the list of revision ids and ignore
2327
# missing sigs. Consider removing this work entirely
2328
revisions_with_signatures = set(self.signatures.get_parent_map(
2329
[(r,) for r in revision_ids]))
2330
revisions_with_signatures = set(
2331
[r for (r,) in revisions_with_signatures])
2332
revisions_with_signatures.intersection_update(revision_ids)
2333
yield ("signatures", None, revisions_with_signatures)
2336
yield ("revisions", None, revision_ids)
2339
def get_inventory(self, revision_id):
2340
"""Get Inventory object by revision id."""
2341
return self.iter_inventories([revision_id]).next()
2343
def iter_inventories(self, revision_ids, ordering=None):
2344
"""Get many inventories by revision_ids.
2346
This will buffer some or all of the texts used in constructing the
2347
inventories in memory, but will only parse a single inventory at a
2350
:param revision_ids: The expected revision ids of the inventories.
2351
:param ordering: optional ordering, e.g. 'topological'. If not
2352
specified, the order of revision_ids will be preserved (by
2353
buffering if necessary).
2354
:return: An iterator of inventories.
2356
if ((None in revision_ids)
2357
or (_mod_revision.NULL_REVISION in revision_ids)):
2358
raise ValueError('cannot get null revision inventory')
2359
return self._iter_inventories(revision_ids, ordering)
2361
def _iter_inventories(self, revision_ids, ordering):
2362
"""single-document based inventory iteration."""
2363
inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
2364
for text, revision_id in inv_xmls:
2365
yield self._deserialise_inventory(revision_id, text)
2367
def _iter_inventory_xmls(self, revision_ids, ordering):
2368
if ordering is None:
2369
order_as_requested = True
2370
ordering = 'unordered'
2372
order_as_requested = False
2373
keys = [(revision_id,) for revision_id in revision_ids]
2376
if order_as_requested:
2377
key_iter = iter(keys)
2378
next_key = key_iter.next()
2379
stream = self.inventories.get_record_stream(keys, ordering, True)
2381
for record in stream:
2382
if record.storage_kind != 'absent':
2383
chunks = record.get_bytes_as('chunked')
2384
if order_as_requested:
2385
text_chunks[record.key] = chunks
2387
yield ''.join(chunks), record.key[-1]
2389
raise errors.NoSuchRevision(self, record.key)
2390
if order_as_requested:
2391
# Yield as many results as we can while preserving order.
2392
while next_key in text_chunks:
2393
chunks = text_chunks.pop(next_key)
2394
yield ''.join(chunks), next_key[-1]
2396
next_key = key_iter.next()
2397
except StopIteration:
2398
# We still want to fully consume the get_record_stream,
2399
# just in case it is not actually finished at this point
2403
def _deserialise_inventory(self, revision_id, xml):
2404
"""Transform the xml into an inventory object.
2406
:param revision_id: The expected revision id of the inventory.
2407
:param xml: A serialised inventory.
2409
result = self._serializer.read_inventory_from_string(xml, revision_id,
2410
entry_cache=self._inventory_entry_cache,
2411
return_from_cache=self._safe_to_return_from_cache)
2412
if result.revision_id != revision_id:
2413
raise AssertionError('revision id mismatch %s != %s' % (
2414
result.revision_id, revision_id))
2417
def get_serializer_format(self):
2418
return self._serializer.format_num
2421
def _get_inventory_xml(self, revision_id):
2422
"""Get serialized inventory as a string."""
2423
texts = self._iter_inventory_xmls([revision_id], 'unordered')
2425
text, revision_id = texts.next()
2426
except StopIteration:
2427
raise errors.HistoryMissing(self, 'inventory', revision_id)
2430
def get_rev_id_for_revno(self, revno, known_pair):
2431
"""Return the revision id of a revno, given a later (revno, revid)
2432
pair in the same history.
2434
:return: if found (True, revid). If the available history ran out
2435
before reaching the revno, then this returns
2436
(False, (closest_revno, closest_revid)).
2438
known_revno, known_revid = known_pair
2439
partial_history = [known_revid]
2440
distance_from_known = known_revno - revno
2441
if distance_from_known < 0:
2443
'requested revno (%d) is later than given known revno (%d)'
2444
% (revno, known_revno))
2447
self, partial_history, stop_index=distance_from_known)
2448
except errors.RevisionNotPresent, err:
2449
if err.revision_id == known_revid:
2450
# The start revision (known_revid) wasn't found.
2452
# This is a stacked repository with no fallbacks, or a there's a
2453
# left-hand ghost. Either way, even though the revision named in
2454
# the error isn't in this repo, we know it's the next step in this
2455
# left-hand history.
2456
partial_history.append(err.revision_id)
2457
if len(partial_history) <= distance_from_known:
2458
# Didn't find enough history to get a revid for the revno.
2459
earliest_revno = known_revno - len(partial_history) + 1
2460
return (False, (earliest_revno, partial_history[-1]))
2461
if len(partial_history) - 1 > distance_from_known:
2462
raise AssertionError('_iter_for_revno returned too much history')
2463
return (True, partial_history[-1])
2465
def iter_reverse_revision_history(self, revision_id):
2466
"""Iterate backwards through revision ids in the lefthand history
2468
:param revision_id: The revision id to start with. All its lefthand
2469
ancestors will be traversed.
2471
graph = self.get_graph()
2472
next_id = revision_id
2474
if next_id in (None, _mod_revision.NULL_REVISION):
2477
parents = graph.get_parent_map([next_id])[next_id]
2479
raise errors.RevisionNotPresent(next_id, self)
2481
if len(parents) == 0:
2484
next_id = parents[0]
2486
def is_shared(self):
2487
"""Return True if this repository is flagged as a shared repository."""
2488
raise NotImplementedError(self.is_shared)
2491
def reconcile(self, other=None, thorough=False):
2492
"""Reconcile this repository."""
2493
from bzrlib.reconcile import RepoReconciler
2494
reconciler = RepoReconciler(self, thorough=thorough)
2495
reconciler.reconcile()
2498
def _refresh_data(self):
2499
"""Helper called from lock_* to ensure coherency with disk.
2501
The default implementation does nothing; it is however possible
2502
for repositories to maintain loaded indices across multiple locks
2503
by checking inside their implementation of this method to see
2504
whether their indices are still valid. This depends of course on
2505
the disk format being validatable in this manner. This method is
2506
also called by the refresh_data() public interface to cause a refresh
2507
to occur while in a write lock so that data inserted by a smart server
2508
push operation is visible on the client's instance of the physical
2513
def revision_tree(self, revision_id):
2514
"""Return Tree for a revision on this branch.
2516
`revision_id` may be NULL_REVISION for the empty tree revision.
2518
revision_id = _mod_revision.ensure_null(revision_id)
2519
# TODO: refactor this to use an existing revision object
2520
# so we don't need to read it in twice.
2521
if revision_id == _mod_revision.NULL_REVISION:
2522
return RevisionTree(self, Inventory(root_id=None),
2523
_mod_revision.NULL_REVISION)
2525
inv = self.get_inventory(revision_id)
2526
return RevisionTree(self, inv, revision_id)
2528
def revision_trees(self, revision_ids):
2529
"""Return Trees for revisions in this repository.
2531
:param revision_ids: a sequence of revision-ids;
2532
a revision-id may not be None or 'null:'
2534
inventories = self.iter_inventories(revision_ids)
2535
for inv in inventories:
2536
yield RevisionTree(self, inv, inv.revision_id)
2538
def _filtered_revision_trees(self, revision_ids, file_ids):
2539
"""Return Tree for a revision on this branch with only some files.
2541
:param revision_ids: a sequence of revision-ids;
2542
a revision-id may not be None or 'null:'
2543
:param file_ids: if not None, the result is filtered
2544
so that only those file-ids, their parents and their
2545
children are included.
2547
inventories = self.iter_inventories(revision_ids)
2548
for inv in inventories:
2549
# Should we introduce a FilteredRevisionTree class rather
2550
# than pre-filter the inventory here?
2551
filtered_inv = inv.filter(file_ids)
2552
yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
2555
def get_ancestry(self, revision_id, topo_sorted=True):
2556
"""Return a list of revision-ids integrated by a revision.
2558
The first element of the list is always None, indicating the origin
2559
revision. This might change when we have history horizons, or
2560
perhaps we should have a new API.
2562
This is topologically sorted.
2564
if _mod_revision.is_null(revision_id):
2566
if not self.has_revision(revision_id):
2567
raise errors.NoSuchRevision(self, revision_id)
2568
graph = self.get_graph()
2570
search = graph._make_breadth_first_searcher([revision_id])
2573
found, ghosts = search.next_with_ghosts()
2574
except StopIteration:
2577
if _mod_revision.NULL_REVISION in keys:
2578
keys.remove(_mod_revision.NULL_REVISION)
2580
parent_map = graph.get_parent_map(keys)
2581
keys = tsort.topo_sort(parent_map)
2582
return [None] + list(keys)
2584
def pack(self, hint=None, clean_obsolete_packs=False):
2585
"""Compress the data within the repository.
2587
This operation only makes sense for some repository types. For other
2588
types it should be a no-op that just returns.
2590
This stub method does not require a lock, but subclasses should use
2591
@needs_write_lock as this is a long running call its reasonable to
2592
implicitly lock for the user.
2594
:param hint: If not supplied, the whole repository is packed.
2595
If supplied, the repository may use the hint parameter as a
2596
hint for the parts of the repository to pack. A hint can be
2597
obtained from the result of commit_write_group(). Out of
2598
date hints are simply ignored, because concurrent operations
2599
can obsolete them rapidly.
2601
:param clean_obsolete_packs: Clean obsolete packs immediately after
2605
def get_transaction(self):
2606
return self.control_files.get_transaction()
2608
def get_parent_map(self, revision_ids):
2609
"""See graph.StackedParentsProvider.get_parent_map"""
2610
# revisions index works in keys; this just works in revisions
2611
# therefore wrap and unwrap
2614
for revision_id in revision_ids:
2615
if revision_id == _mod_revision.NULL_REVISION:
2616
result[revision_id] = ()
2617
elif revision_id is None:
2618
raise ValueError('get_parent_map(None) is not valid')
2620
query_keys.append((revision_id ,))
2621
for ((revision_id,), parent_keys) in \
2622
self.revisions.get_parent_map(query_keys).iteritems():
2624
result[revision_id] = tuple([parent_revid
2625
for (parent_revid,) in parent_keys])
2627
result[revision_id] = (_mod_revision.NULL_REVISION,)
2630
def _make_parents_provider(self):
2634
def get_known_graph_ancestry(self, revision_ids):
2635
"""Return the known graph for a set of revision ids and their ancestors.
2637
st = static_tuple.StaticTuple
2638
revision_keys = [st(r_id).intern() for r_id in revision_ids]
2639
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
2640
return graph.GraphThunkIdsToKeys(known_graph)
2642
def get_graph(self, other_repository=None):
2643
"""Return the graph walker for this repository format"""
2644
parents_provider = self._make_parents_provider()
2645
if (other_repository is not None and
2646
not self.has_same_location(other_repository)):
2647
parents_provider = graph.StackedParentsProvider(
2648
[parents_provider, other_repository._make_parents_provider()])
2649
return graph.Graph(parents_provider)
2651
def _get_versioned_file_checker(self, text_key_references=None,
2653
"""Return an object suitable for checking versioned files.
2655
:param text_key_references: if non-None, an already built
2656
dictionary mapping text keys ((fileid, revision_id) tuples)
2657
to whether they were referred to by the inventory of the
2658
revision_id that they contain. If None, this will be
2660
:param ancestors: Optional result from
2661
self.get_graph().get_parent_map(self.all_revision_ids()) if already
2664
return _VersionedFileChecker(self,
2665
text_key_references=text_key_references, ancestors=ancestors)
2667
def revision_ids_to_search_result(self, result_set):
2668
"""Convert a set of revision ids to a graph SearchResult."""
2669
result_parents = set()
2670
for parents in self.get_graph().get_parent_map(
2671
result_set).itervalues():
2672
result_parents.update(parents)
2673
included_keys = result_set.intersection(result_parents)
2674
start_keys = result_set.difference(included_keys)
2675
exclude_keys = result_parents.difference(result_set)
2676
result = graph.SearchResult(start_keys, exclude_keys,
2677
len(result_set), result_set)
2681
def set_make_working_trees(self, new_value):
2682
"""Set the policy flag for making working trees when creating branches.
2684
This only applies to branches that use this repository.
2686
The default is 'True'.
2687
:param new_value: True to restore the default, False to disable making
2690
raise NotImplementedError(self.set_make_working_trees)
2692
def make_working_trees(self):
2693
"""Returns the policy for making working trees on new branches."""
2694
raise NotImplementedError(self.make_working_trees)
2697
def sign_revision(self, revision_id, gpg_strategy):
2698
plaintext = Testament.from_revision(self, revision_id).as_short_text()
2699
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
2702
def has_signature_for_revision_id(self, revision_id):
2703
"""Query for a revision signature for revision_id in the repository."""
2704
if not self.has_revision(revision_id):
2705
raise errors.NoSuchRevision(self, revision_id)
2706
sig_present = (1 == len(
2707
self.signatures.get_parent_map([(revision_id,)])))
2711
def get_signature_text(self, revision_id):
2712
"""Return the text for a signature."""
2713
stream = self.signatures.get_record_stream([(revision_id,)],
2715
record = stream.next()
2716
if record.storage_kind == 'absent':
2717
raise errors.NoSuchRevision(self, revision_id)
2718
return record.get_bytes_as('fulltext')
2721
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
2722
"""Check consistency of all history of given revision_ids.
2724
Different repository implementations should override _check().
2726
:param revision_ids: A non-empty list of revision_ids whose ancestry
2727
will be checked. Typically the last revision_id of a branch.
2728
:param callback_refs: A dict of check-refs to resolve and callback
2729
the check/_check method on the items listed as wanting the ref.
2731
:param check_repo: If False do not check the repository contents, just
2732
calculate the data callback_refs requires and call them back.
2734
return self._check(revision_ids, callback_refs=callback_refs,
2735
check_repo=check_repo)
2737
def _check(self, revision_ids, callback_refs, check_repo):
2738
result = check.Check(self, check_repo=check_repo)
2739
result.check(callback_refs)
2742
def _warn_if_deprecated(self, branch=None):
2743
global _deprecation_warning_done
2744
if _deprecation_warning_done:
2748
conf = config.GlobalConfig()
2750
conf = branch.get_config()
2751
if conf.suppress_warning('format_deprecation'):
2753
warning("Format %s for %s is deprecated -"
2754
" please use 'bzr upgrade' to get better performance"
2755
% (self._format, self.bzrdir.transport.base))
2757
_deprecation_warning_done = True
2759
def supports_rich_root(self):
2760
return self._format.rich_root_data
2762
def _check_ascii_revisionid(self, revision_id, method):
2763
"""Private helper for ascii-only repositories."""
2764
# weave repositories refuse to store revisionids that are non-ascii.
2765
if revision_id is not None:
2766
# weaves require ascii revision ids.
2767
if isinstance(revision_id, unicode):
2769
revision_id.encode('ascii')
2770
except UnicodeEncodeError:
2771
raise errors.NonAsciiRevisionId(method, self)
2774
revision_id.decode('ascii')
2775
except UnicodeDecodeError:
2776
raise errors.NonAsciiRevisionId(method, self)
2778
def revision_graph_can_have_wrong_parents(self):
2779
"""Is it possible for this repository to have a revision graph with
2782
If True, then this repository must also implement
2783
_find_inconsistent_revision_parents so that check and reconcile can
2784
check for inconsistencies before proceeding with other checks that may
2785
depend on the revision index being consistent.
2787
raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2790
# remove these delegates a while after bzr 0.15
2791
def __make_delegated(name, from_module):
2792
def _deprecated_repository_forwarder():
2793
symbol_versioning.warn('%s moved to %s in bzr 0.15'
2794
% (name, from_module),
2797
m = __import__(from_module, globals(), locals(), [name])
2799
return getattr(m, name)
2800
except AttributeError:
2801
raise AttributeError('module %s has no name %s'
2803
globals()[name] = _deprecated_repository_forwarder
2806
'AllInOneRepository',
2807
'WeaveMetaDirRepository',
2808
'PreSplitOutRepositoryFormat',
2809
'RepositoryFormat4',
2810
'RepositoryFormat5',
2811
'RepositoryFormat6',
2812
'RepositoryFormat7',
2814
__make_delegated(_name, 'bzrlib.repofmt.weaverepo')
2818
'RepositoryFormatKnit',
2819
'RepositoryFormatKnit1',
2821
__make_delegated(_name, 'bzrlib.repofmt.knitrepo')
2824
def install_revision(repository, rev, revision_tree):
2825
"""Install all revision data into a repository."""
2826
install_revisions(repository, [(rev, revision_tree, None)])
2829
def install_revisions(repository, iterable, num_revisions=None, pb=None):
2830
"""Install all revision data into a repository.
2832
Accepts an iterable of revision, tree, signature tuples. The signature
2835
repository.start_write_group()
2837
inventory_cache = lru_cache.LRUCache(10)
2838
for n, (revision, revision_tree, signature) in enumerate(iterable):
2839
_install_revision(repository, revision, revision_tree, signature,
2842
pb.update('Transferring revisions', n + 1, num_revisions)
2844
repository.abort_write_group()
2847
repository.commit_write_group()
2850
def _install_revision(repository, rev, revision_tree, signature,
2852
"""Install all revision data into a repository."""
2853
present_parents = []
2855
for p_id in rev.parent_ids:
2856
if repository.has_revision(p_id):
2857
present_parents.append(p_id)
2858
parent_trees[p_id] = repository.revision_tree(p_id)
2860
parent_trees[p_id] = repository.revision_tree(
2861
_mod_revision.NULL_REVISION)
2863
inv = revision_tree.inventory
2864
entries = inv.iter_entries()
2865
# backwards compatibility hack: skip the root id.
2866
if not repository.supports_rich_root():
2867
path, root = entries.next()
2868
if root.revision != rev.revision_id:
2869
raise errors.IncompatibleRevision(repr(repository))
2871
for path, ie in entries:
2872
text_keys[(ie.file_id, ie.revision)] = ie
2873
text_parent_map = repository.texts.get_parent_map(text_keys)
2874
missing_texts = set(text_keys) - set(text_parent_map)
2875
# Add the texts that are not already present
2876
for text_key in missing_texts:
2877
ie = text_keys[text_key]
2879
# FIXME: TODO: The following loop overlaps/duplicates that done by
2880
# commit to determine parents. There is a latent/real bug here where
2881
# the parents inserted are not those commit would do - in particular
2882
# they are not filtered by heads(). RBC, AB
2883
for revision, tree in parent_trees.iteritems():
2884
if ie.file_id not in tree:
2886
parent_id = tree.inventory[ie.file_id].revision
2887
if parent_id in text_parents:
2889
text_parents.append((ie.file_id, parent_id))
2890
lines = revision_tree.get_file(ie.file_id).readlines()
2891
repository.texts.add_lines(text_key, text_parents, lines)
2893
# install the inventory
2894
if repository._format._commit_inv_deltas and len(rev.parent_ids):
2895
# Cache this inventory
2896
inventory_cache[rev.revision_id] = inv
2898
basis_inv = inventory_cache[rev.parent_ids[0]]
2900
repository.add_inventory(rev.revision_id, inv, present_parents)
2902
delta = inv._make_delta(basis_inv)
2903
repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2904
rev.revision_id, present_parents)
2906
repository.add_inventory(rev.revision_id, inv, present_parents)
2907
except errors.RevisionAlreadyPresent:
2909
if signature is not None:
2910
repository.add_signature_text(rev.revision_id, signature)
2911
repository.add_revision(rev.revision_id, rev, inv)
2914
class MetaDirRepository(Repository):
2915
"""Repositories in the new meta-dir layout.
2917
:ivar _transport: Transport for access to repository control files,
2918
typically pointing to .bzr/repository.
2921
def __init__(self, _format, a_bzrdir, control_files):
2922
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
2923
self._transport = control_files._transport
2925
def is_shared(self):
2926
"""Return True if this repository is flagged as a shared repository."""
2927
return self._transport.has('shared-storage')
2930
def set_make_working_trees(self, new_value):
2931
"""Set the policy flag for making working trees when creating branches.
2933
This only applies to branches that use this repository.
2935
The default is 'True'.
2936
:param new_value: True to restore the default, False to disable making
2941
self._transport.delete('no-working-trees')
2942
except errors.NoSuchFile:
2945
self._transport.put_bytes('no-working-trees', '',
2946
mode=self.bzrdir._get_file_mode())
2948
def make_working_trees(self):
2949
"""Returns the policy for making working trees on new branches."""
2950
return not self._transport.has('no-working-trees')
2953
class MetaDirVersionedFileRepository(MetaDirRepository):
2954
"""Repositories in a meta-dir, that work via versioned file objects."""
2956
def __init__(self, _format, a_bzrdir, control_files):
2957
super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
2961
network_format_registry = registry.FormatRegistry()
2962
"""Registry of formats indexed by their network name.
2964
The network name for a repository format is an identifier that can be used when
2965
referring to formats with smart server operations. See
2966
RepositoryFormat.network_name() for more detail.
2970
format_registry = registry.FormatRegistry(network_format_registry)
2971
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2973
This can contain either format instances themselves, or classes/factories that
2974
can be called to obtain one.
2978
#####################################################################
2979
# Repository Formats
2981
class RepositoryFormat(object):
2982
"""A repository format.
2984
Formats provide four things:
2985
* An initialization routine to construct repository data on disk.
2986
* a optional format string which is used when the BzrDir supports
2988
* an open routine which returns a Repository instance.
2989
* A network name for referring to the format in smart server RPC
2992
There is one and only one Format subclass for each on-disk format. But
2993
there can be one Repository subclass that is used for several different
2994
formats. The _format attribute on a Repository instance can be used to
2995
determine the disk format.
2997
Formats are placed in a registry by their format string for reference
2998
during opening. These should be subclasses of RepositoryFormat for
3001
Once a format is deprecated, just deprecate the initialize and open
3002
methods on the format class. Do not deprecate the object, as the
3003
object may be created even when a repository instance hasn't been
3006
Common instance attributes:
3007
_matchingbzrdir - the bzrdir format that the repository format was
3008
originally written to work with. This can be used if manually
3009
constructing a bzrdir and repository, or more commonly for test suite
3013
# Set to True or False in derived classes. True indicates that the format
3014
# supports ghosts gracefully.
3015
supports_ghosts = None
3016
# Can this repository be given external locations to lookup additional
3017
# data. Set to True or False in derived classes.
3018
supports_external_lookups = None
3019
# Does this format support CHK bytestring lookups. Set to True or False in
3021
supports_chks = None
3022
# Should commit add an inventory, or an inventory delta to the repository.
3023
_commit_inv_deltas = True
3024
# What order should fetch operations request streams in?
3025
# The default is unordered as that is the cheapest for an origin to
3027
_fetch_order = 'unordered'
3028
# Does this repository format use deltas that can be fetched as-deltas ?
3029
# (E.g. knits, where the knit deltas can be transplanted intact.
3030
# We default to False, which will ensure that enough data to get
3031
# a full text out of any fetch stream will be grabbed.
3032
_fetch_uses_deltas = False
3033
# Should fetch trigger a reconcile after the fetch? Only needed for
3034
# some repository formats that can suffer internal inconsistencies.
3035
_fetch_reconcile = False
3036
# Does this format have < O(tree_size) delta generation. Used to hint what
3037
# code path for commit, amongst other things.
3039
# Does doing a pack operation compress data? Useful for the pack UI command
3040
# (so if there is one pack, the operation can still proceed because it may
3041
# help), and for fetching when data won't have come from the same
3043
pack_compresses = False
3044
# Does the repository inventory storage understand references to trees?
3045
supports_tree_reference = None
3046
# Is the format experimental ?
3047
experimental = False
3050
return "%s()" % self.__class__.__name__
3052
def __eq__(self, other):
3053
# format objects are generally stateless
3054
return isinstance(other, self.__class__)
3056
def __ne__(self, other):
3057
return not self == other
3060
def find_format(klass, a_bzrdir):
3061
"""Return the format for the repository object in a_bzrdir.
3063
This is used by bzr native formats that have a "format" file in
3064
the repository. Other methods may be used by different types of
3068
transport = a_bzrdir.get_repository_transport(None)
3069
format_string = transport.get_bytes("format")
3070
return format_registry.get(format_string)
3071
except errors.NoSuchFile:
3072
raise errors.NoRepositoryPresent(a_bzrdir)
3074
raise errors.UnknownFormatError(format=format_string,
3078
def register_format(klass, format):
3079
format_registry.register(format.get_format_string(), format)
3082
def unregister_format(klass, format):
3083
format_registry.remove(format.get_format_string())
3086
def get_default_format(klass):
3087
"""Return the current default format."""
3088
from bzrlib import bzrdir
3089
return bzrdir.format_registry.make_bzrdir('default').repository_format
3091
def get_format_string(self):
3092
"""Return the ASCII format string that identifies this format.
3094
Note that in pre format ?? repositories the format string is
3095
not permitted nor written to disk.
3097
raise NotImplementedError(self.get_format_string)
3099
def get_format_description(self):
3100
"""Return the short description for this format."""
3101
raise NotImplementedError(self.get_format_description)
3103
# TODO: this shouldn't be in the base class, it's specific to things that
3104
# use weaves or knits -- mbp 20070207
3105
def _get_versioned_file_store(self,
3110
versionedfile_class=None,
3111
versionedfile_kwargs={},
3113
if versionedfile_class is None:
3114
versionedfile_class = self._versionedfile_class
3115
weave_transport = control_files._transport.clone(name)
3116
dir_mode = control_files._dir_mode
3117
file_mode = control_files._file_mode
3118
return VersionedFileStore(weave_transport, prefixed=prefixed,
3120
file_mode=file_mode,
3121
versionedfile_class=versionedfile_class,
3122
versionedfile_kwargs=versionedfile_kwargs,
3125
def initialize(self, a_bzrdir, shared=False):
3126
"""Initialize a repository of this format in a_bzrdir.
3128
:param a_bzrdir: The bzrdir to put the new repository in it.
3129
:param shared: The repository should be initialized as a sharable one.
3130
:returns: The new repository object.
3132
This may raise UninitializableFormat if shared repository are not
3133
compatible the a_bzrdir.
3135
raise NotImplementedError(self.initialize)
3137
def is_supported(self):
3138
"""Is this format supported?
3140
Supported formats must be initializable and openable.
3141
Unsupported formats may not support initialization or committing or
3142
some other features depending on the reason for not being supported.
3146
def network_name(self):
3147
"""A simple byte string uniquely identifying this format for RPC calls.
3149
MetaDir repository formats use their disk format string to identify the
3150
repository over the wire. All in one formats such as bzr < 0.8, and
3151
foreign formats like svn/git and hg should use some marker which is
3152
unique and immutable.
3154
raise NotImplementedError(self.network_name)
3156
def check_conversion_target(self, target_format):
3157
if self.rich_root_data and not target_format.rich_root_data:
3158
raise errors.BadConversionTarget(
3159
'Does not support rich root data.', target_format,
3161
if (self.supports_tree_reference and
3162
not getattr(target_format, 'supports_tree_reference', False)):
3163
raise errors.BadConversionTarget(
3164
'Does not support nested trees', target_format,
3167
def open(self, a_bzrdir, _found=False):
3168
"""Return an instance of this format for the bzrdir a_bzrdir.
3170
_found is a private parameter, do not use it.
3172
raise NotImplementedError(self.open)
3174
def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
3175
from bzrlib.bzrdir import BzrDir, RepoInitHookParams
3176
hooks = BzrDir.hooks['post_repo_init']
3179
params = RepoInitHookParams(repository, self, a_bzrdir, shared)
3184
class MetaDirRepositoryFormat(RepositoryFormat):
3185
"""Common base class for the new repositories using the metadir layout."""
3187
rich_root_data = False
3188
supports_tree_reference = False
3189
supports_external_lookups = False
3192
def _matchingbzrdir(self):
3193
matching = bzrdir.BzrDirMetaFormat1()
3194
matching.repository_format = self
3198
super(MetaDirRepositoryFormat, self).__init__()
3200
def _create_control_files(self, a_bzrdir):
3201
"""Create the required files and the initial control_files object."""
3202
# FIXME: RBC 20060125 don't peek under the covers
3203
# NB: no need to escape relative paths that are url safe.
3204
repository_transport = a_bzrdir.get_repository_transport(self)
3205
control_files = lockable_files.LockableFiles(repository_transport,
3206
'lock', lockdir.LockDir)
3207
control_files.create_lock()
3208
return control_files
3210
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
3211
"""Upload the initial blank content."""
3212
control_files = self._create_control_files(a_bzrdir)
3213
control_files.lock_write()
3214
transport = control_files._transport
3216
utf8_files += [('shared-storage', '')]
3218
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
3219
for (filename, content_stream) in files:
3220
transport.put_file(filename, content_stream,
3221
mode=a_bzrdir._get_file_mode())
3222
for (filename, content_bytes) in utf8_files:
3223
transport.put_bytes_non_atomic(filename, content_bytes,
3224
mode=a_bzrdir._get_file_mode())
3226
control_files.unlock()
3228
def network_name(self):
3229
"""Metadir formats have matching disk and network format strings."""
3230
return self.get_format_string()
3233
# Pre-0.8 formats that don't have a disk format string (because they are
3234
# versioned by the matching control directory). We use the control directories
3235
# disk format string as a key for the network_name because they meet the
3236
# constraints (simple string, unique, immutable).
3237
network_format_registry.register_lazy(
3238
"Bazaar-NG branch, format 5\n",
3239
'bzrlib.repofmt.weaverepo',
3240
'RepositoryFormat5',
3242
network_format_registry.register_lazy(
3243
"Bazaar-NG branch, format 6\n",
3244
'bzrlib.repofmt.weaverepo',
3245
'RepositoryFormat6',
3248
# formats which have no format string are not discoverable or independently
3249
# creatable on disk, so are not registered in format_registry. They're
3250
# all in bzrlib.repofmt.weaverepo now. When an instance of one of these is
3251
# needed, it's constructed directly by the BzrDir. Non-native formats where
3252
# the repository is not separately opened are similar.
3254
format_registry.register_lazy(
3255
'Bazaar-NG Repository format 7',
3256
'bzrlib.repofmt.weaverepo',
3260
format_registry.register_lazy(
3261
'Bazaar-NG Knit Repository Format 1',
3262
'bzrlib.repofmt.knitrepo',
3263
'RepositoryFormatKnit1',
3266
format_registry.register_lazy(
3267
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
3268
'bzrlib.repofmt.knitrepo',
3269
'RepositoryFormatKnit3',
3272
format_registry.register_lazy(
3273
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
3274
'bzrlib.repofmt.knitrepo',
3275
'RepositoryFormatKnit4',
3278
# Pack-based formats. There is one format for pre-subtrees, and one for
3279
# post-subtrees to allow ease of testing.
3280
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
3281
format_registry.register_lazy(
3282
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
3283
'bzrlib.repofmt.pack_repo',
3284
'RepositoryFormatKnitPack1',
3286
format_registry.register_lazy(
3287
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
3288
'bzrlib.repofmt.pack_repo',
3289
'RepositoryFormatKnitPack3',
3291
format_registry.register_lazy(
3292
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
3293
'bzrlib.repofmt.pack_repo',
3294
'RepositoryFormatKnitPack4',
3296
format_registry.register_lazy(
3297
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
3298
'bzrlib.repofmt.pack_repo',
3299
'RepositoryFormatKnitPack5',
3301
format_registry.register_lazy(
3302
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
3303
'bzrlib.repofmt.pack_repo',
3304
'RepositoryFormatKnitPack5RichRoot',
3306
format_registry.register_lazy(
3307
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
3308
'bzrlib.repofmt.pack_repo',
3309
'RepositoryFormatKnitPack5RichRootBroken',
3311
format_registry.register_lazy(
3312
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
3313
'bzrlib.repofmt.pack_repo',
3314
'RepositoryFormatKnitPack6',
3316
format_registry.register_lazy(
3317
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
3318
'bzrlib.repofmt.pack_repo',
3319
'RepositoryFormatKnitPack6RichRoot',
3322
# Development formats.
3323
# Obsolete but kept pending a CHK based subtree format.
3324
format_registry.register_lazy(
3325
("Bazaar development format 2 with subtree support "
3326
"(needs bzr.dev from before 1.8)\n"),
3327
'bzrlib.repofmt.pack_repo',
3328
'RepositoryFormatPackDevelopment2Subtree',
3331
# 1.14->1.16 go below here
3332
format_registry.register_lazy(
3333
'Bazaar development format - group compression and chk inventory'
3334
' (needs bzr.dev from 1.14)\n',
3335
'bzrlib.repofmt.groupcompress_repo',
3336
'RepositoryFormatCHK1',
3339
format_registry.register_lazy(
3340
'Bazaar development format - chk repository with bencode revision '
3341
'serialization (needs bzr.dev from 1.16)\n',
3342
'bzrlib.repofmt.groupcompress_repo',
3343
'RepositoryFormatCHK2',
3345
format_registry.register_lazy(
3346
'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
3347
'bzrlib.repofmt.groupcompress_repo',
3348
'RepositoryFormat2a',
3352
class InterRepository(InterObject):
3353
"""This class represents operations taking place between two repositories.
3355
Its instances have methods like copy_content and fetch, and contain
3356
references to the source and target repositories these operations can be
3359
Often we will provide convenience methods on 'repository' which carry out
3360
operations with another repository - they will always forward to
3361
InterRepository.get(other).method_name(parameters).
3364
_walk_to_common_revisions_batch_size = 50
3366
"""The available optimised InterRepository types."""
3369
def copy_content(self, revision_id=None):
3370
"""Make a complete copy of the content in self into destination.
3372
This is a destructive operation! Do not use it on existing
3375
:param revision_id: Only copy the content needed to construct
3376
revision_id and its parents.
3379
self.target.set_make_working_trees(self.source.make_working_trees())
3380
except NotImplementedError:
3382
self.target.fetch(self.source, revision_id=revision_id)
3385
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3387
"""Fetch the content required to construct revision_id.
3389
The content is copied from self.source to self.target.
3391
:param revision_id: if None all content is copied, if NULL_REVISION no
3396
ui.ui_factory.warn_experimental_format_fetch(self)
3397
from bzrlib.fetch import RepoFetcher
3398
# See <https://launchpad.net/bugs/456077> asking for a warning here
3399
if self.source._format.network_name() != self.target._format.network_name():
3400
ui.ui_factory.show_user_warning('cross_format_fetch',
3401
from_format=self.source._format,
3402
to_format=self.target._format)
3403
f = RepoFetcher(to_repository=self.target,
3404
from_repository=self.source,
3405
last_revision=revision_id,
3406
fetch_spec=fetch_spec,
3407
find_ghosts=find_ghosts)
3409
def _walk_to_common_revisions(self, revision_ids):
3410
"""Walk out from revision_ids in source to revisions target has.
3412
:param revision_ids: The start point for the search.
3413
:return: A set of revision ids.
3415
target_graph = self.target.get_graph()
3416
revision_ids = frozenset(revision_ids)
3417
missing_revs = set()
3418
source_graph = self.source.get_graph()
3419
# ensure we don't pay silly lookup costs.
3420
searcher = source_graph._make_breadth_first_searcher(revision_ids)
3421
null_set = frozenset([_mod_revision.NULL_REVISION])
3422
searcher_exhausted = False
3426
# Iterate the searcher until we have enough next_revs
3427
while len(next_revs) < self._walk_to_common_revisions_batch_size:
3429
next_revs_part, ghosts_part = searcher.next_with_ghosts()
3430
next_revs.update(next_revs_part)
3431
ghosts.update(ghosts_part)
3432
except StopIteration:
3433
searcher_exhausted = True
3435
# If there are ghosts in the source graph, and the caller asked for
3436
# them, make sure that they are present in the target.
3437
# We don't care about other ghosts as we can't fetch them and
3438
# haven't been asked to.
3439
ghosts_to_check = set(revision_ids.intersection(ghosts))
3440
revs_to_get = set(next_revs).union(ghosts_to_check)
3442
have_revs = set(target_graph.get_parent_map(revs_to_get))
3443
# we always have NULL_REVISION present.
3444
have_revs = have_revs.union(null_set)
3445
# Check if the target is missing any ghosts we need.
3446
ghosts_to_check.difference_update(have_revs)
3448
# One of the caller's revision_ids is a ghost in both the
3449
# source and the target.
3450
raise errors.NoSuchRevision(
3451
self.source, ghosts_to_check.pop())
3452
missing_revs.update(next_revs - have_revs)
3453
# Because we may have walked past the original stop point, make
3454
# sure everything is stopped
3455
stop_revs = searcher.find_seen_ancestors(have_revs)
3456
searcher.stop_searching_any(stop_revs)
3457
if searcher_exhausted:
3459
return searcher.get_result()
3462
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3463
"""Return the revision ids that source has that target does not.
3465
:param revision_id: only return revision ids included by this
3467
:param find_ghosts: If True find missing revisions in deep history
3468
rather than just finding the surface difference.
3469
:return: A bzrlib.graph.SearchResult.
3471
# stop searching at found target revisions.
3472
if not find_ghosts and revision_id is not None:
3473
return self._walk_to_common_revisions([revision_id])
3474
# generic, possibly worst case, slow code path.
3475
target_ids = set(self.target.all_revision_ids())
3476
if revision_id is not None:
3477
source_ids = self.source.get_ancestry(revision_id)
3478
if source_ids[0] is not None:
3479
raise AssertionError()
3482
source_ids = self.source.all_revision_ids()
3483
result_set = set(source_ids).difference(target_ids)
3484
return self.source.revision_ids_to_search_result(result_set)
3487
def _same_model(source, target):
3488
"""True if source and target have the same data representation.
3490
Note: this is always called on the base class; overriding it in a
3491
subclass will have no effect.
3494
InterRepository._assert_same_model(source, target)
3496
except errors.IncompatibleRepositories, e:
3500
def _assert_same_model(source, target):
3501
"""Raise an exception if two repositories do not use the same model.
3503
if source.supports_rich_root() != target.supports_rich_root():
3504
raise errors.IncompatibleRepositories(source, target,
3505
"different rich-root support")
3506
if source._serializer != target._serializer:
3507
raise errors.IncompatibleRepositories(source, target,
3508
"different serializers")
3511
class InterSameDataRepository(InterRepository):
3512
"""Code for converting between repositories that represent the same data.
3514
Data format and model must match for this to work.
3518
def _get_repo_format_to_test(self):
3519
"""Repository format for testing with.
3521
InterSameData can pull from subtree to subtree and from non-subtree to
3522
non-subtree, so we test this with the richest repository format.
3524
from bzrlib.repofmt import knitrepo
3525
return knitrepo.RepositoryFormatKnit3()
3528
def is_compatible(source, target):
3529
return InterRepository._same_model(source, target)
3532
class InterWeaveRepo(InterSameDataRepository):
3533
"""Optimised code paths between Weave based repositories.
3535
This should be in bzrlib/repofmt/weaverepo.py but we have not yet
3536
implemented lazy inter-object optimisation.
3540
def _get_repo_format_to_test(self):
3541
from bzrlib.repofmt import weaverepo
3542
return weaverepo.RepositoryFormat7()
3545
def is_compatible(source, target):
3546
"""Be compatible with known Weave formats.
3548
We don't test for the stores being of specific types because that
3549
could lead to confusing results, and there is no need to be
3552
from bzrlib.repofmt.weaverepo import (
3558
return (isinstance(source._format, (RepositoryFormat5,
3560
RepositoryFormat7)) and
3561
isinstance(target._format, (RepositoryFormat5,
3563
RepositoryFormat7)))
3564
except AttributeError:
3568
def copy_content(self, revision_id=None):
3569
"""See InterRepository.copy_content()."""
3570
# weave specific optimised path:
3572
self.target.set_make_working_trees(self.source.make_working_trees())
3573
except (errors.RepositoryUpgradeRequired, NotImplemented):
3575
# FIXME do not peek!
3576
if self.source._transport.listable():
3577
pb = ui.ui_factory.nested_progress_bar()
3579
self.target.texts.insert_record_stream(
3580
self.source.texts.get_record_stream(
3581
self.source.texts.keys(), 'topological', False))
3582
pb.update('Copying inventory', 0, 1)
3583
self.target.inventories.insert_record_stream(
3584
self.source.inventories.get_record_stream(
3585
self.source.inventories.keys(), 'topological', False))
3586
self.target.signatures.insert_record_stream(
3587
self.source.signatures.get_record_stream(
3588
self.source.signatures.keys(),
3590
self.target.revisions.insert_record_stream(
3591
self.source.revisions.get_record_stream(
3592
self.source.revisions.keys(),
3593
'topological', True))
3597
self.target.fetch(self.source, revision_id=revision_id)
3600
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3601
"""See InterRepository.missing_revision_ids()."""
3602
# we want all revisions to satisfy revision_id in source.
3603
# but we don't want to stat every file here and there.
3604
# we want then, all revisions other needs to satisfy revision_id
3605
# checked, but not those that we have locally.
3606
# so the first thing is to get a subset of the revisions to
3607
# satisfy revision_id in source, and then eliminate those that
3608
# we do already have.
3609
# this is slow on high latency connection to self, but as this
3610
# disk format scales terribly for push anyway due to rewriting
3611
# inventory.weave, this is considered acceptable.
3613
if revision_id is not None:
3614
source_ids = self.source.get_ancestry(revision_id)
3615
if source_ids[0] is not None:
3616
raise AssertionError()
3619
source_ids = self.source._all_possible_ids()
3620
source_ids_set = set(source_ids)
3621
# source_ids is the worst possible case we may need to pull.
3622
# now we want to filter source_ids against what we actually
3623
# have in target, but don't try to check for existence where we know
3624
# we do not have a revision as that would be pointless.
3625
target_ids = set(self.target._all_possible_ids())
3626
possibly_present_revisions = target_ids.intersection(source_ids_set)
3627
actually_present_revisions = set(
3628
self.target._eliminate_revisions_not_present(possibly_present_revisions))
3629
required_revisions = source_ids_set.difference(actually_present_revisions)
3630
if revision_id is not None:
3631
# we used get_ancestry to determine source_ids then we are assured all
3632
# revisions referenced are present as they are installed in topological order.
3633
# and the tip revision was validated by get_ancestry.
3634
result_set = required_revisions
3636
# if we just grabbed the possibly available ids, then
3637
# we only have an estimate of whats available and need to validate
3638
# that against the revision records.
3640
self.source._eliminate_revisions_not_present(required_revisions))
3641
return self.source.revision_ids_to_search_result(result_set)
3644
class InterKnitRepo(InterSameDataRepository):
3645
"""Optimised code paths between Knit based repositories."""
3648
def _get_repo_format_to_test(self):
3649
from bzrlib.repofmt import knitrepo
3650
return knitrepo.RepositoryFormatKnit1()
3653
def is_compatible(source, target):
3654
"""Be compatible with known Knit formats.
3656
We don't test for the stores being of specific types because that
3657
could lead to confusing results, and there is no need to be
3660
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
3662
are_knits = (isinstance(source._format, RepositoryFormatKnit) and
3663
isinstance(target._format, RepositoryFormatKnit))
3664
except AttributeError:
3666
return are_knits and InterRepository._same_model(source, target)
3669
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3670
"""See InterRepository.missing_revision_ids()."""
3671
if revision_id is not None:
3672
source_ids = self.source.get_ancestry(revision_id)
3673
if source_ids[0] is not None:
3674
raise AssertionError()
3677
source_ids = self.source.all_revision_ids()
3678
source_ids_set = set(source_ids)
3679
# source_ids is the worst possible case we may need to pull.
3680
# now we want to filter source_ids against what we actually
3681
# have in target, but don't try to check for existence where we know
3682
# we do not have a revision as that would be pointless.
3683
target_ids = set(self.target.all_revision_ids())
3684
possibly_present_revisions = target_ids.intersection(source_ids_set)
3685
actually_present_revisions = set(
3686
self.target._eliminate_revisions_not_present(possibly_present_revisions))
3687
required_revisions = source_ids_set.difference(actually_present_revisions)
3688
if revision_id is not None:
3689
# we used get_ancestry to determine source_ids then we are assured all
3690
# revisions referenced are present as they are installed in topological order.
3691
# and the tip revision was validated by get_ancestry.
3692
result_set = required_revisions
3694
# if we just grabbed the possibly available ids, then
3695
# we only have an estimate of whats available and need to validate
3696
# that against the revision records.
3698
self.source._eliminate_revisions_not_present(required_revisions))
3699
return self.source.revision_ids_to_search_result(result_set)
3702
class InterDifferingSerializer(InterRepository):
3705
def _get_repo_format_to_test(self):
3709
def is_compatible(source, target):
3710
"""Be compatible with Knit2 source and Knit3 target"""
3711
# This is redundant with format.check_conversion_target(), however that
3712
# raises an exception, and we just want to say "False" as in we won't
3713
# support converting between these formats.
3714
if 'IDS_never' in debug.debug_flags:
3716
if source.supports_rich_root() and not target.supports_rich_root():
3718
if (source._format.supports_tree_reference
3719
and not target._format.supports_tree_reference):
3721
if target._fallback_repositories and target._format.supports_chks:
3722
# IDS doesn't know how to copy CHKs for the parent inventories it
3723
# adds to stacked repos.
3725
if 'IDS_always' in debug.debug_flags:
3727
# Only use this code path for local source and target. IDS does far
3728
# too much IO (both bandwidth and roundtrips) over a network.
3729
if not source.bzrdir.transport.base.startswith('file:///'):
3731
if not target.bzrdir.transport.base.startswith('file:///'):
3735
def _get_trees(self, revision_ids, cache):
3737
for rev_id in revision_ids:
3739
possible_trees.append((rev_id, cache[rev_id]))
3741
# Not cached, but inventory might be present anyway.
3743
tree = self.source.revision_tree(rev_id)
3744
except errors.NoSuchRevision:
3745
# Nope, parent is ghost.
3748
cache[rev_id] = tree
3749
possible_trees.append((rev_id, tree))
3750
return possible_trees
3752
def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3753
"""Get the best delta and base for this revision.
3755
:return: (basis_id, delta)
3758
# Generate deltas against each tree, to find the shortest.
3759
texts_possibly_new_in_tree = set()
3760
for basis_id, basis_tree in possible_trees:
3761
delta = tree.inventory._make_delta(basis_tree.inventory)
3762
for old_path, new_path, file_id, new_entry in delta:
3763
if new_path is None:
3764
# This file_id isn't present in the new rev, so we don't
3768
# Rich roots are handled elsewhere...
3770
kind = new_entry.kind
3771
if kind != 'directory' and kind != 'file':
3772
# No text record associated with this inventory entry.
3774
# This is a directory or file that has changed somehow.
3775
texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3776
deltas.append((len(delta), basis_id, delta))
3778
return deltas[0][1:]
3780
def _fetch_parent_invs_for_stacking(self, parent_map, cache):
3781
"""Find all parent revisions that are absent, but for which the
3782
inventory is present, and copy those inventories.
3784
This is necessary to preserve correctness when the source is stacked
3785
without fallbacks configured. (Note that in cases like upgrade the
3786
source may be not have _fallback_repositories even though it is
3790
for parents in parent_map.values():
3791
parent_revs.update(parents)
3792
present_parents = self.source.get_parent_map(parent_revs)
3793
absent_parents = set(parent_revs).difference(present_parents)
3794
parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
3795
(rev_id,) for rev_id in absent_parents)
3796
parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
3797
for parent_tree in self.source.revision_trees(parent_inv_ids):
3798
current_revision_id = parent_tree.get_revision_id()
3799
parents_parents_keys = parent_invs_keys_for_stacking[
3800
(current_revision_id,)]
3801
parents_parents = [key[-1] for key in parents_parents_keys]
3802
basis_id = _mod_revision.NULL_REVISION
3803
basis_tree = self.source.revision_tree(basis_id)
3804
delta = parent_tree.inventory._make_delta(basis_tree.inventory)
3805
self.target.add_inventory_by_delta(
3806
basis_id, delta, current_revision_id, parents_parents)
3807
cache[current_revision_id] = parent_tree
3809
def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3810
"""Fetch across a few revisions.
3812
:param revision_ids: The revisions to copy
3813
:param basis_id: The revision_id of a tree that must be in cache, used
3814
as a basis for delta when no other base is available
3815
:param cache: A cache of RevisionTrees that we can use.
3816
:param a_graph: A Graph object to determine the heads() of the
3817
rich-root data stream.
3818
:return: The revision_id of the last converted tree. The RevisionTree
3819
for it will be in cache
3821
# Walk though all revisions; get inventory deltas, copy referenced
3822
# texts that delta references, insert the delta, revision and
3824
root_keys_to_create = set()
3827
pending_revisions = []
3828
parent_map = self.source.get_parent_map(revision_ids)
3829
self._fetch_parent_invs_for_stacking(parent_map, cache)
3830
self.source._safe_to_return_from_cache = True
3831
for tree in self.source.revision_trees(revision_ids):
3832
# Find a inventory delta for this revision.
3833
# Find text entries that need to be copied, too.
3834
current_revision_id = tree.get_revision_id()
3835
parent_ids = parent_map.get(current_revision_id, ())
3836
parent_trees = self._get_trees(parent_ids, cache)
3837
possible_trees = list(parent_trees)
3838
if len(possible_trees) == 0:
3839
# There either aren't any parents, or the parents are ghosts,
3840
# so just use the last converted tree.
3841
possible_trees.append((basis_id, cache[basis_id]))
3842
basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3844
revision = self.source.get_revision(current_revision_id)
3845
pending_deltas.append((basis_id, delta,
3846
current_revision_id, revision.parent_ids))
3847
if self._converting_to_rich_root:
3848
self._revision_id_to_root_id[current_revision_id] = \
3850
# Determine which texts are in present in this revision but not in
3851
# any of the available parents.
3852
texts_possibly_new_in_tree = set()
3853
for old_path, new_path, file_id, entry in delta:
3854
if new_path is None:
3855
# This file_id isn't present in the new rev
3859
if not self.target.supports_rich_root():
3860
# The target doesn't support rich root, so we don't
3863
if self._converting_to_rich_root:
3864
# This can't be copied normally, we have to insert
3866
root_keys_to_create.add((file_id, entry.revision))
3869
texts_possibly_new_in_tree.add((file_id, entry.revision))
3870
for basis_id, basis_tree in possible_trees:
3871
basis_inv = basis_tree.inventory
3872
for file_key in list(texts_possibly_new_in_tree):
3873
file_id, file_revision = file_key
3875
entry = basis_inv[file_id]
3876
except errors.NoSuchId:
3878
if entry.revision == file_revision:
3879
texts_possibly_new_in_tree.remove(file_key)
3880
text_keys.update(texts_possibly_new_in_tree)
3881
pending_revisions.append(revision)
3882
cache[current_revision_id] = tree
3883
basis_id = current_revision_id
3884
self.source._safe_to_return_from_cache = False
3886
from_texts = self.source.texts
3887
to_texts = self.target.texts
3888
if root_keys_to_create:
3889
root_stream = _mod_fetch._new_root_data_stream(
3890
root_keys_to_create, self._revision_id_to_root_id, parent_map,
3891
self.source, graph=a_graph)
3892
to_texts.insert_record_stream(root_stream)
3893
to_texts.insert_record_stream(from_texts.get_record_stream(
3894
text_keys, self.target._format._fetch_order,
3895
not self.target._format._fetch_uses_deltas))
3896
# insert inventory deltas
3897
for delta in pending_deltas:
3898
self.target.add_inventory_by_delta(*delta)
3899
if self.target._fallback_repositories:
3900
# Make sure this stacked repository has all the parent inventories
3901
# for the new revisions that we are about to insert. We do this
3902
# before adding the revisions so that no revision is added until
3903
# all the inventories it may depend on are added.
3904
# Note that this is overzealous, as we may have fetched these in an
3907
revision_ids = set()
3908
for revision in pending_revisions:
3909
revision_ids.add(revision.revision_id)
3910
parent_ids.update(revision.parent_ids)
3911
parent_ids.difference_update(revision_ids)
3912
parent_ids.discard(_mod_revision.NULL_REVISION)
3913
parent_map = self.source.get_parent_map(parent_ids)
3914
# we iterate over parent_map and not parent_ids because we don't
3915
# want to try copying any revision which is a ghost
3916
for parent_tree in self.source.revision_trees(parent_map):
3917
current_revision_id = parent_tree.get_revision_id()
3918
parents_parents = parent_map[current_revision_id]
3919
possible_trees = self._get_trees(parents_parents, cache)
3920
if len(possible_trees) == 0:
3921
# There either aren't any parents, or the parents are
3922
# ghosts, so just use the last converted tree.
3923
possible_trees.append((basis_id, cache[basis_id]))
3924
basis_id, delta = self._get_delta_for_revision(parent_tree,
3925
parents_parents, possible_trees)
3926
self.target.add_inventory_by_delta(
3927
basis_id, delta, current_revision_id, parents_parents)
3928
# insert signatures and revisions
3929
for revision in pending_revisions:
3931
signature = self.source.get_signature_text(
3932
revision.revision_id)
3933
self.target.add_signature_text(revision.revision_id,
3935
except errors.NoSuchRevision:
3937
self.target.add_revision(revision.revision_id, revision)
3940
def _fetch_all_revisions(self, revision_ids, pb):
3941
"""Fetch everything for the list of revisions.
3943
:param revision_ids: The list of revisions to fetch. Must be in
3945
:param pb: A ProgressTask
3948
basis_id, basis_tree = self._get_basis(revision_ids[0])
3950
cache = lru_cache.LRUCache(100)
3951
cache[basis_id] = basis_tree
3952
del basis_tree # We don't want to hang on to it here
3954
if self._converting_to_rich_root and len(revision_ids) > 100:
3955
a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
3960
for offset in range(0, len(revision_ids), batch_size):
3961
self.target.start_write_group()
3963
pb.update('Transferring revisions', offset,
3965
batch = revision_ids[offset:offset+batch_size]
3966
basis_id = self._fetch_batch(batch, basis_id, cache,
3969
self.source._safe_to_return_from_cache = False
3970
self.target.abort_write_group()
3973
hint = self.target.commit_write_group()
3976
if hints and self.target._format.pack_compresses:
3977
self.target.pack(hint=hints)
3978
pb.update('Transferring revisions', len(revision_ids),
3982
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3984
"""See InterRepository.fetch()."""
3985
if fetch_spec is not None:
3986
raise AssertionError("Not implemented yet...")
3987
ui.ui_factory.warn_experimental_format_fetch(self)
3988
if (not self.source.supports_rich_root()
3989
and self.target.supports_rich_root()):
3990
self._converting_to_rich_root = True
3991
self._revision_id_to_root_id = {}
3993
self._converting_to_rich_root = False
3994
# See <https://launchpad.net/bugs/456077> asking for a warning here
3995
if self.source._format.network_name() != self.target._format.network_name():
3996
ui.ui_factory.show_user_warning('cross_format_fetch',
3997
from_format=self.source._format,
3998
to_format=self.target._format)
3999
revision_ids = self.target.search_missing_revision_ids(self.source,
4000
revision_id, find_ghosts=find_ghosts).get_keys()
4001
if not revision_ids:
4003
revision_ids = tsort.topo_sort(
4004
self.source.get_graph().get_parent_map(revision_ids))
4005
if not revision_ids:
4007
# Walk though all revisions; get inventory deltas, copy referenced
4008
# texts that delta references, insert the delta, revision and
4011
my_pb = ui.ui_factory.nested_progress_bar()
4014
symbol_versioning.warn(
4015
symbol_versioning.deprecated_in((1, 14, 0))
4016
% "pb parameter to fetch()")
4019
self._fetch_all_revisions(revision_ids, pb)
4021
if my_pb is not None:
4023
return len(revision_ids), 0
4025
def _get_basis(self, first_revision_id):
4026
"""Get a revision and tree which exists in the target.
4028
This assumes that first_revision_id is selected for transmission
4029
because all other ancestors are already present. If we can't find an
4030
ancestor we fall back to NULL_REVISION since we know that is safe.
4032
:return: (basis_id, basis_tree)
4034
first_rev = self.source.get_revision(first_revision_id)
4036
basis_id = first_rev.parent_ids[0]
4037
# only valid as a basis if the target has it
4038
self.target.get_revision(basis_id)
4039
# Try to get a basis tree - if its a ghost it will hit the
4040
# NoSuchRevision case.
4041
basis_tree = self.source.revision_tree(basis_id)
4042
except (IndexError, errors.NoSuchRevision):
4043
basis_id = _mod_revision.NULL_REVISION
4044
basis_tree = self.source.revision_tree(basis_id)
4045
return basis_id, basis_tree
4048
InterRepository.register_optimiser(InterDifferingSerializer)
4049
InterRepository.register_optimiser(InterSameDataRepository)
4050
InterRepository.register_optimiser(InterWeaveRepo)
4051
InterRepository.register_optimiser(InterKnitRepo)
4054
class CopyConverter(object):
4055
"""A repository conversion tool which just performs a copy of the content.
4057
This is slow but quite reliable.
4060
def __init__(self, target_format):
4061
"""Create a CopyConverter.
4063
:param target_format: The format the resulting repository should be.
4065
self.target_format = target_format
4067
def convert(self, repo, pb):
4068
"""Perform the conversion of to_convert, giving feedback via pb.
4070
:param to_convert: The disk object to convert.
4071
:param pb: a progress bar to use for progress information.
4073
pb = ui.ui_factory.nested_progress_bar()
4076
# this is only useful with metadir layouts - separated repo content.
4077
# trigger an assertion if not such
4078
repo._format.get_format_string()
4079
self.repo_dir = repo.bzrdir
4080
pb.update('Moving repository to repository.backup')
4081
self.repo_dir.transport.move('repository', 'repository.backup')
4082
backup_transport = self.repo_dir.transport.clone('repository.backup')
4083
repo._format.check_conversion_target(self.target_format)
4084
self.source_repo = repo._format.open(self.repo_dir,
4086
_override_transport=backup_transport)
4087
pb.update('Creating new repository')
4088
converted = self.target_format.initialize(self.repo_dir,
4089
self.source_repo.is_shared())
4090
converted.lock_write()
4092
pb.update('Copying content')
4093
self.source_repo.copy_content_into(converted)
4096
pb.update('Deleting old repository content')
4097
self.repo_dir.transport.delete_tree('repository.backup')
4098
ui.ui_factory.note('repository converted')
4111
def _unescaper(match, _map=_unescape_map):
4112
code = match.group(1)
4116
if not code.startswith('#'):
4118
return unichr(int(code[1:])).encode('utf8')
4124
def _unescape_xml(data):
4125
"""Unescape predefined XML entities in a string of data."""
4127
if _unescape_re is None:
4128
_unescape_re = re.compile('\&([^;]*);')
4129
return _unescape_re.sub(_unescaper, data)
4132
class _VersionedFileChecker(object):
4134
def __init__(self, repository, text_key_references=None, ancestors=None):
4135
self.repository = repository
4136
self.text_index = self.repository._generate_text_key_index(
4137
text_key_references=text_key_references, ancestors=ancestors)
4139
def calculate_file_version_parents(self, text_key):
4140
"""Calculate the correct parents for a file version according to
4143
parent_keys = self.text_index[text_key]
4144
if parent_keys == [_mod_revision.NULL_REVISION]:
4146
return tuple(parent_keys)
4148
def check_file_version_parents(self, texts, progress_bar=None):
4149
"""Check the parents stored in a versioned file are correct.
4151
It also detects file versions that are not referenced by their
4152
corresponding revision's inventory.
4154
:returns: A tuple of (wrong_parents, dangling_file_versions).
4155
wrong_parents is a dict mapping {revision_id: (stored_parents,
4156
correct_parents)} for each revision_id where the stored parents
4157
are not correct. dangling_file_versions is a set of (file_id,
4158
revision_id) tuples for versions that are present in this versioned
4159
file, but not used by the corresponding inventory.
4161
local_progress = None
4162
if progress_bar is None:
4163
local_progress = ui.ui_factory.nested_progress_bar()
4164
progress_bar = local_progress
4166
return self._check_file_version_parents(texts, progress_bar)
4169
local_progress.finished()
4171
def _check_file_version_parents(self, texts, progress_bar):
4172
"""See check_file_version_parents."""
4174
self.file_ids = set([file_id for file_id, _ in
4175
self.text_index.iterkeys()])
4176
# text keys is now grouped by file_id
4177
n_versions = len(self.text_index)
4178
progress_bar.update('loading text store', 0, n_versions)
4179
parent_map = self.repository.texts.get_parent_map(self.text_index)
4180
# On unlistable transports this could well be empty/error...
4181
text_keys = self.repository.texts.keys()
4182
unused_keys = frozenset(text_keys) - set(self.text_index)
4183
for num, key in enumerate(self.text_index.iterkeys()):
4184
progress_bar.update('checking text graph', num, n_versions)
4185
correct_parents = self.calculate_file_version_parents(key)
4187
knit_parents = parent_map[key]
4188
except errors.RevisionNotPresent:
4191
if correct_parents != knit_parents:
4192
wrong_parents[key] = (knit_parents, correct_parents)
4193
return wrong_parents, unused_keys
4196
def _old_get_graph(repository, revision_id):
4197
"""DO NOT USE. That is all. I'm serious."""
4198
graph = repository.get_graph()
4199
revision_graph = dict(((key, value) for key, value in
4200
graph.iter_ancestry([revision_id]) if value is not None))
4201
return _strip_NULL_ghosts(revision_graph)
4204
def _strip_NULL_ghosts(revision_graph):
4205
"""Also don't use this. more compatibility code for unmigrated clients."""
4206
# Filter ghosts, and null:
4207
if _mod_revision.NULL_REVISION in revision_graph:
4208
del revision_graph[_mod_revision.NULL_REVISION]
4209
for key, parents in revision_graph.items():
4210
revision_graph[key] = tuple(parent for parent in parents if parent
4212
return revision_graph
4215
class StreamSink(object):
4216
"""An object that can insert a stream into a repository.
4218
This interface handles the complexity of reserialising inventories and
4219
revisions from different formats, and allows unidirectional insertion into
4220
stacked repositories without looking for the missing basis parents
4224
def __init__(self, target_repo):
4225
self.target_repo = target_repo
4227
def insert_stream(self, stream, src_format, resume_tokens):
4228
"""Insert a stream's content into the target repository.
4230
:param src_format: a bzr repository format.
4232
:return: a list of resume tokens and an iterable of keys additional
4233
items required before the insertion can be completed.
4235
self.target_repo.lock_write()
4238
self.target_repo.resume_write_group(resume_tokens)
4241
self.target_repo.start_write_group()
4244
# locked_insert_stream performs a commit|suspend.
4245
return self._locked_insert_stream(stream, src_format, is_resume)
4247
self.target_repo.abort_write_group(suppress_errors=True)
4250
self.target_repo.unlock()
4252
def _locked_insert_stream(self, stream, src_format, is_resume):
4253
to_serializer = self.target_repo._format._serializer
4254
src_serializer = src_format._serializer
4256
if to_serializer == src_serializer:
4257
# If serializers match and the target is a pack repository, set the
4258
# write cache size on the new pack. This avoids poor performance
4259
# on transports where append is unbuffered (such as
4260
# RemoteTransport). This is safe to do because nothing should read
4261
# back from the target repository while a stream with matching
4262
# serialization is being inserted.
4263
# The exception is that a delta record from the source that should
4264
# be a fulltext may need to be expanded by the target (see
4265
# test_fetch_revisions_with_deltas_into_pack); but we take care to
4266
# explicitly flush any buffered writes first in that rare case.
4268
new_pack = self.target_repo._pack_collection._new_pack
4269
except AttributeError:
4270
# Not a pack repository
4273
new_pack.set_write_cache_size(1024*1024)
4274
for substream_type, substream in stream:
4275
if 'stream' in debug.debug_flags:
4276
mutter('inserting substream: %s', substream_type)
4277
if substream_type == 'texts':
4278
self.target_repo.texts.insert_record_stream(substream)
4279
elif substream_type == 'inventories':
4280
if src_serializer == to_serializer:
4281
self.target_repo.inventories.insert_record_stream(
4284
self._extract_and_insert_inventories(
4285
substream, src_serializer)
4286
elif substream_type == 'inventory-deltas':
4287
self._extract_and_insert_inventory_deltas(
4288
substream, src_serializer)
4289
elif substream_type == 'chk_bytes':
4290
# XXX: This doesn't support conversions, as it assumes the
4291
# conversion was done in the fetch code.
4292
self.target_repo.chk_bytes.insert_record_stream(substream)
4293
elif substream_type == 'revisions':
4294
# This may fallback to extract-and-insert more often than
4295
# required if the serializers are different only in terms of
4297
if src_serializer == to_serializer:
4298
self.target_repo.revisions.insert_record_stream(
4301
self._extract_and_insert_revisions(substream,
4303
elif substream_type == 'signatures':
4304
self.target_repo.signatures.insert_record_stream(substream)
4306
raise AssertionError('kaboom! %s' % (substream_type,))
4307
# Done inserting data, and the missing_keys calculations will try to
4308
# read back from the inserted data, so flush the writes to the new pack
4309
# (if this is pack format).
4310
if new_pack is not None:
4311
new_pack._write_data('', flush=True)
4312
# Find all the new revisions (including ones from resume_tokens)
4313
missing_keys = self.target_repo.get_missing_parent_inventories(
4314
check_for_missing_texts=is_resume)
4316
for prefix, versioned_file in (
4317
('texts', self.target_repo.texts),
4318
('inventories', self.target_repo.inventories),
4319
('revisions', self.target_repo.revisions),
4320
('signatures', self.target_repo.signatures),
4321
('chk_bytes', self.target_repo.chk_bytes),
4323
if versioned_file is None:
4325
# TODO: key is often going to be a StaticTuple object
4326
# I don't believe we can define a method by which
4327
# (prefix,) + StaticTuple will work, though we could
4328
# define a StaticTuple.sq_concat that would allow you to
4329
# pass in either a tuple or a StaticTuple as the second
4330
# object, so instead we could have:
4331
# StaticTuple(prefix) + key here...
4332
missing_keys.update((prefix,) + key for key in
4333
versioned_file.get_missing_compression_parent_keys())
4334
except NotImplementedError:
4335
# cannot even attempt suspending, and missing would have failed
4336
# during stream insertion.
4337
missing_keys = set()
4340
# suspend the write group and tell the caller what we is
4341
# missing. We know we can suspend or else we would not have
4342
# entered this code path. (All repositories that can handle
4343
# missing keys can handle suspending a write group).
4344
write_group_tokens = self.target_repo.suspend_write_group()
4345
return write_group_tokens, missing_keys
4346
hint = self.target_repo.commit_write_group()
4347
if (to_serializer != src_serializer and
4348
self.target_repo._format.pack_compresses):
4349
self.target_repo.pack(hint=hint)
4352
def _extract_and_insert_inventory_deltas(self, substream, serializer):
4353
target_rich_root = self.target_repo._format.rich_root_data
4354
target_tree_refs = self.target_repo._format.supports_tree_reference
4355
for record in substream:
4356
# Insert the delta directly
4357
inventory_delta_bytes = record.get_bytes_as('fulltext')
4358
deserialiser = inventory_delta.InventoryDeltaDeserializer()
4360
parse_result = deserialiser.parse_text_bytes(
4361
inventory_delta_bytes)
4362
except inventory_delta.IncompatibleInventoryDelta, err:
4363
trace.mutter("Incompatible delta: %s", err.msg)
4364
raise errors.IncompatibleRevision(self.target_repo._format)
4365
basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
4366
revision_id = new_id
4367
parents = [key[0] for key in record.parents]
4368
self.target_repo.add_inventory_by_delta(
4369
basis_id, inv_delta, revision_id, parents)
4371
def _extract_and_insert_inventories(self, substream, serializer,
4373
"""Generate a new inventory versionedfile in target, converting data.
4375
The inventory is retrieved from the source, (deserializing it), and
4376
stored in the target (reserializing it in a different format).
4378
target_rich_root = self.target_repo._format.rich_root_data
4379
target_tree_refs = self.target_repo._format.supports_tree_reference
4380
for record in substream:
4381
# It's not a delta, so it must be a fulltext in the source
4382
# serializer's format.
4383
bytes = record.get_bytes_as('fulltext')
4384
revision_id = record.key[0]
4385
inv = serializer.read_inventory_from_string(bytes, revision_id)
4386
parents = [key[0] for key in record.parents]
4387
self.target_repo.add_inventory(revision_id, inv, parents)
4388
# No need to keep holding this full inv in memory when the rest of
4389
# the substream is likely to be all deltas.
4392
def _extract_and_insert_revisions(self, substream, serializer):
4393
for record in substream:
4394
bytes = record.get_bytes_as('fulltext')
4395
revision_id = record.key[0]
4396
rev = serializer.read_revision_from_string(bytes)
4397
if rev.revision_id != revision_id:
4398
raise AssertionError('wtf: %s != %s' % (rev, revision_id))
4399
self.target_repo.add_revision(revision_id, rev)
4402
if self.target_repo._format._fetch_reconcile:
4403
self.target_repo.reconcile()
4406
class StreamSource(object):
4407
"""A source of a stream for fetching between repositories."""
4409
def __init__(self, from_repository, to_format):
4410
"""Create a StreamSource streaming from from_repository."""
4411
self.from_repository = from_repository
4412
self.to_format = to_format
4414
def delta_on_metadata(self):
4415
"""Return True if delta's are permitted on metadata streams.
4417
That is on revisions and signatures.
4419
src_serializer = self.from_repository._format._serializer
4420
target_serializer = self.to_format._serializer
4421
return (self.to_format._fetch_uses_deltas and
4422
src_serializer == target_serializer)
4424
def _fetch_revision_texts(self, revs):
4425
# fetch signatures first and then the revision texts
4426
# may need to be a InterRevisionStore call here.
4427
from_sf = self.from_repository.signatures
4428
# A missing signature is just skipped.
4429
keys = [(rev_id,) for rev_id in revs]
4430
signatures = versionedfile.filter_absent(from_sf.get_record_stream(
4432
self.to_format._fetch_order,
4433
not self.to_format._fetch_uses_deltas))
4434
# If a revision has a delta, this is actually expanded inside the
4435
# insert_record_stream code now, which is an alternate fix for
4437
from_rf = self.from_repository.revisions
4438
revisions = from_rf.get_record_stream(
4440
self.to_format._fetch_order,
4441
not self.delta_on_metadata())
4442
return [('signatures', signatures), ('revisions', revisions)]
4444
def _generate_root_texts(self, revs):
4445
"""This will be called by get_stream between fetching weave texts and
4446
fetching the inventory weave.
4448
if self._rich_root_upgrade():
4449
return _mod_fetch.Inter1and2Helper(
4450
self.from_repository).generate_root_texts(revs)
4454
def get_stream(self, search):
4456
revs = search.get_keys()
4457
graph = self.from_repository.get_graph()
4458
revs = tsort.topo_sort(graph.get_parent_map(revs))
4459
data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4461
for knit_kind, file_id, revisions in data_to_fetch:
4462
if knit_kind != phase:
4464
# Make a new progress bar for this phase
4465
if knit_kind == "file":
4466
# Accumulate file texts
4467
text_keys.extend([(file_id, revision) for revision in
4469
elif knit_kind == "inventory":
4470
# Now copy the file texts.
4471
from_texts = self.from_repository.texts
4472
yield ('texts', from_texts.get_record_stream(
4473
text_keys, self.to_format._fetch_order,
4474
not self.to_format._fetch_uses_deltas))
4475
# Cause an error if a text occurs after we have done the
4478
# Before we process the inventory we generate the root
4479
# texts (if necessary) so that the inventories references
4481
for _ in self._generate_root_texts(revs):
4483
# we fetch only the referenced inventories because we do not
4484
# know for unselected inventories whether all their required
4485
# texts are present in the other repository - it could be
4487
for info in self._get_inventory_stream(revs):
4489
elif knit_kind == "signatures":
4490
# Nothing to do here; this will be taken care of when
4491
# _fetch_revision_texts happens.
4493
elif knit_kind == "revisions":
4494
for record in self._fetch_revision_texts(revs):
4497
raise AssertionError("Unknown knit kind %r" % knit_kind)
4499
def get_stream_for_missing_keys(self, missing_keys):
4500
# missing keys can only occur when we are byte copying and not
4501
# translating (because translation means we don't send
4502
# unreconstructable deltas ever).
4504
keys['texts'] = set()
4505
keys['revisions'] = set()
4506
keys['inventories'] = set()
4507
keys['chk_bytes'] = set()
4508
keys['signatures'] = set()
4509
for key in missing_keys:
4510
keys[key[0]].add(key[1:])
4511
if len(keys['revisions']):
4512
# If we allowed copying revisions at this point, we could end up
4513
# copying a revision without copying its required texts: a
4514
# violation of the requirements for repository integrity.
4515
raise AssertionError(
4516
'cannot copy revisions to fill in missing deltas %s' % (
4517
keys['revisions'],))
4518
for substream_kind, keys in keys.iteritems():
4519
vf = getattr(self.from_repository, substream_kind)
4520
if vf is None and keys:
4521
raise AssertionError(
4522
"cannot fill in keys for a versioned file we don't"
4523
" have: %s needs %s" % (substream_kind, keys))
4525
# No need to stream something we don't have
4527
if substream_kind == 'inventories':
4528
# Some missing keys are genuinely ghosts, filter those out.
4529
present = self.from_repository.inventories.get_parent_map(keys)
4530
revs = [key[0] for key in present]
4531
# Get the inventory stream more-or-less as we do for the
4532
# original stream; there's no reason to assume that records
4533
# direct from the source will be suitable for the sink. (Think
4534
# e.g. 2a -> 1.9-rich-root).
4535
for info in self._get_inventory_stream(revs, missing=True):
4539
# Ask for full texts always so that we don't need more round trips
4540
# after this stream.
4541
# Some of the missing keys are genuinely ghosts, so filter absent
4542
# records. The Sink is responsible for doing another check to
4543
# ensure that ghosts don't introduce missing data for future
4545
stream = versionedfile.filter_absent(vf.get_record_stream(keys,
4546
self.to_format._fetch_order, True))
4547
yield substream_kind, stream
4549
def inventory_fetch_order(self):
4550
if self._rich_root_upgrade():
4551
return 'topological'
4553
return self.to_format._fetch_order
4555
def _rich_root_upgrade(self):
4556
return (not self.from_repository._format.rich_root_data and
4557
self.to_format.rich_root_data)
4559
def _get_inventory_stream(self, revision_ids, missing=False):
4560
from_format = self.from_repository._format
4561
if (from_format.supports_chks and self.to_format.supports_chks and
4562
from_format.network_name() == self.to_format.network_name()):
4563
raise AssertionError(
4564
"this case should be handled by GroupCHKStreamSource")
4565
elif 'forceinvdeltas' in debug.debug_flags:
4566
return self._get_convertable_inventory_stream(revision_ids,
4567
delta_versus_null=missing)
4568
elif from_format.network_name() == self.to_format.network_name():
4570
return self._get_simple_inventory_stream(revision_ids,
4572
elif (not from_format.supports_chks and not self.to_format.supports_chks
4573
and from_format._serializer == self.to_format._serializer):
4574
# Essentially the same format.
4575
return self._get_simple_inventory_stream(revision_ids,
4578
# Any time we switch serializations, we want to use an
4579
# inventory-delta based approach.
4580
return self._get_convertable_inventory_stream(revision_ids,
4581
delta_versus_null=missing)
4583
def _get_simple_inventory_stream(self, revision_ids, missing=False):
4584
# NB: This currently reopens the inventory weave in source;
4585
# using a single stream interface instead would avoid this.
4586
from_weave = self.from_repository.inventories
4588
delta_closure = True
4590
delta_closure = not self.delta_on_metadata()
4591
yield ('inventories', from_weave.get_record_stream(
4592
[(rev_id,) for rev_id in revision_ids],
4593
self.inventory_fetch_order(), delta_closure))
4595
def _get_convertable_inventory_stream(self, revision_ids,
4596
delta_versus_null=False):
4597
# The two formats are sufficiently different that there is no fast
4598
# path, so we need to send just inventorydeltas, which any
4599
# sufficiently modern client can insert into any repository.
4600
# The StreamSink code expects to be able to
4601
# convert on the target, so we need to put bytes-on-the-wire that can
4602
# be converted. That means inventory deltas (if the remote is <1.19,
4603
# RemoteStreamSink will fallback to VFS to insert the deltas).
4604
yield ('inventory-deltas',
4605
self._stream_invs_as_deltas(revision_ids,
4606
delta_versus_null=delta_versus_null))
4608
def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
4609
"""Return a stream of inventory-deltas for the given rev ids.
4611
:param revision_ids: The list of inventories to transmit
4612
:param delta_versus_null: Don't try to find a minimal delta for this
4613
entry, instead compute the delta versus the NULL_REVISION. This
4614
effectively streams a complete inventory. Used for stuff like
4615
filling in missing parents, etc.
4617
from_repo = self.from_repository
4618
revision_keys = [(rev_id,) for rev_id in revision_ids]
4619
parent_map = from_repo.inventories.get_parent_map(revision_keys)
4620
# XXX: possibly repos could implement a more efficient iter_inv_deltas
4622
inventories = self.from_repository.iter_inventories(
4623
revision_ids, 'topological')
4624
format = from_repo._format
4625
invs_sent_so_far = set([_mod_revision.NULL_REVISION])
4626
inventory_cache = lru_cache.LRUCache(50)
4627
null_inventory = from_repo.revision_tree(
4628
_mod_revision.NULL_REVISION).inventory
4629
# XXX: ideally the rich-root/tree-refs flags would be per-revision, not
4630
# per-repo (e.g. streaming a non-rich-root revision out of a rich-root
4631
# repo back into a non-rich-root repo ought to be allowed)
4632
serializer = inventory_delta.InventoryDeltaSerializer(
4633
versioned_root=format.rich_root_data,
4634
tree_references=format.supports_tree_reference)
4635
for inv in inventories:
4636
key = (inv.revision_id,)
4637
parent_keys = parent_map.get(key, ())
4639
if not delta_versus_null and parent_keys:
4640
# The caller did not ask for complete inventories and we have
4641
# some parents that we can delta against. Make a delta against
4642
# each parent so that we can find the smallest.
4643
parent_ids = [parent_key[0] for parent_key in parent_keys]
4644
for parent_id in parent_ids:
4645
if parent_id not in invs_sent_so_far:
4646
# We don't know that the remote side has this basis, so
4649
if parent_id == _mod_revision.NULL_REVISION:
4650
parent_inv = null_inventory
4652
parent_inv = inventory_cache.get(parent_id, None)
4653
if parent_inv is None:
4654
parent_inv = from_repo.get_inventory(parent_id)
4655
candidate_delta = inv._make_delta(parent_inv)
4656
if (delta is None or
4657
len(delta) > len(candidate_delta)):
4658
delta = candidate_delta
4659
basis_id = parent_id
4661
# Either none of the parents ended up being suitable, or we
4662
# were asked to delta against NULL
4663
basis_id = _mod_revision.NULL_REVISION
4664
delta = inv._make_delta(null_inventory)
4665
invs_sent_so_far.add(inv.revision_id)
4666
inventory_cache[inv.revision_id] = inv
4667
delta_serialized = ''.join(
4668
serializer.delta_to_lines(basis_id, key[-1], delta))
4669
yield versionedfile.FulltextContentFactory(
4670
key, parent_keys, None, delta_serialized)
4673
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
4674
stop_revision=None):
4675
"""Extend the partial history to include a given index
4677
If a stop_index is supplied, stop when that index has been reached.
4678
If a stop_revision is supplied, stop when that revision is
4679
encountered. Otherwise, stop when the beginning of history is
4682
:param stop_index: The index which should be present. When it is
4683
present, history extension will stop.
4684
:param stop_revision: The revision id which should be present. When
4685
it is encountered, history extension will stop.
4687
start_revision = partial_history_cache[-1]
4688
iterator = repo.iter_reverse_revision_history(start_revision)
4690
#skip the last revision in the list
4693
if (stop_index is not None and
4694
len(partial_history_cache) > stop_index):
4696
if partial_history_cache[-1] == stop_revision:
4698
revision_id = iterator.next()
4699
partial_history_cache.append(revision_id)
4700
except StopIteration:
added
removed
bzrlib/repository.py
