1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from bzrlib.lazy_import import lazy_import
18
lazy_import(globals(), """
38
revision as _mod_revision,
44
from bzrlib.bundle import serializer
45
from bzrlib.revisiontree import RevisionTree
46
from bzrlib.store.versioned import VersionedFileStore
47
from bzrlib.testament import Testament
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
from bzrlib.inter import InterObject
52
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
60
from bzrlib.trace import (
61
log_exception_quietly, note, mutter, mutter_callsite, warning)
64
# Old formats display a warning, but only once
65
_deprecation_warning_done = False
68
class CommitBuilder(object):
69
"""Provides an interface to build up a commit.
71
This allows describing a tree to be committed without needing to
72
know the internals of the format of the repository.
75
# all clients should supply tree roots.
76
record_root_entry = True
77
# the default CommitBuilder does not manage trees whose root is versioned.
78
_versioned_root = False
80
def __init__(self, repository, parents, config, timestamp=None,
81
timezone=None, committer=None, revprops=None,
83
"""Initiate a CommitBuilder.
85
:param repository: Repository to commit to.
86
:param parents: Revision ids of the parents of the new revision.
87
:param config: Configuration to use.
88
:param timestamp: Optional timestamp recorded for commit.
89
:param timezone: Optional timezone for timestamp.
90
:param committer: Optional committer to set for commit.
91
:param revprops: Optional dictionary of revision properties.
92
:param revision_id: Optional revision id.
97
self._committer = self._config.username()
99
self._committer = committer
101
self.new_inventory = Inventory(None)
102
self._new_revision_id = revision_id
103
self.parents = parents
104
self.repository = repository
107
if revprops is not None:
108
self._validate_revprops(revprops)
109
self._revprops.update(revprops)
111
if timestamp is None:
112
timestamp = time.time()
113
# Restrict resolution to 1ms
114
self._timestamp = round(timestamp, 3)
117
self._timezone = osutils.local_time_offset()
119
self._timezone = int(timezone)
121
self._generate_revision_if_needed()
122
self.__heads = graph.HeadsCache(repository.get_graph()).heads
123
self._basis_delta = []
124
# API compatibility, older code that used CommitBuilder did not call
125
# .record_delete(), which means the delta that is computed would not be
126
# valid. Callers that will call record_delete() should call
127
# .will_record_deletes() to indicate that.
128
self._recording_deletes = False
130
def _validate_unicode_text(self, text, context):
131
"""Verify things like commit messages don't have bogus characters."""
133
raise ValueError('Invalid value for %s: %r' % (context, text))
135
def _validate_revprops(self, revprops):
136
for key, value in revprops.iteritems():
137
# We know that the XML serializers do not round trip '\r'
138
# correctly, so refuse to accept them
139
if not isinstance(value, basestring):
140
raise ValueError('revision property (%s) is not a valid'
141
' (unicode) string: %r' % (key, value))
142
self._validate_unicode_text(value,
143
'revision property (%s)' % (key,))
145
def commit(self, message):
146
"""Make the actual commit.
148
:return: The revision id of the recorded revision.
150
self._validate_unicode_text(message, 'commit message')
151
rev = _mod_revision.Revision(
152
timestamp=self._timestamp,
153
timezone=self._timezone,
154
committer=self._committer,
156
inventory_sha1=self.inv_sha1,
157
revision_id=self._new_revision_id,
158
properties=self._revprops)
159
rev.parent_ids = self.parents
160
self.repository.add_revision(self._new_revision_id, rev,
161
self.new_inventory, self._config)
162
self.repository.commit_write_group()
163
return self._new_revision_id
166
"""Abort the commit that is being built.
168
self.repository.abort_write_group()
170
def revision_tree(self):
171
"""Return the tree that was just committed.
173
After calling commit() this can be called to get a RevisionTree
174
representing the newly committed tree. This is preferred to
175
calling Repository.revision_tree() because that may require
176
deserializing the inventory, while we already have a copy in
179
return RevisionTree(self.repository, self.new_inventory,
180
self._new_revision_id)
182
def finish_inventory(self):
183
"""Tell the builder that the inventory is finished."""
184
if self.new_inventory.root is None:
185
raise AssertionError('Root entry should be supplied to'
186
' record_entry_contents, as of bzr 0.10.')
187
self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
188
self.new_inventory.revision_id = self._new_revision_id
189
self.inv_sha1 = self.repository.add_inventory(
190
self._new_revision_id,
195
def _gen_revision_id(self):
196
"""Return new revision-id."""
197
return generate_ids.gen_revision_id(self._config.username(),
200
def _generate_revision_if_needed(self):
201
"""Create a revision id if None was supplied.
203
If the repository can not support user-specified revision ids
204
they should override this function and raise CannotSetRevisionId
205
if _new_revision_id is not None.
207
:raises: CannotSetRevisionId
209
if self._new_revision_id is None:
210
self._new_revision_id = self._gen_revision_id()
211
self.random_revid = True
213
self.random_revid = False
215
def _heads(self, file_id, revision_ids):
216
"""Calculate the graph heads for revision_ids in the graph of file_id.
218
This can use either a per-file graph or a global revision graph as we
219
have an identity relationship between the two graphs.
221
return self.__heads(revision_ids)
223
def _check_root(self, ie, parent_invs, tree):
224
"""Helper for record_entry_contents.
226
:param ie: An entry being added.
227
:param parent_invs: The inventories of the parent revisions of the
229
:param tree: The tree that is being committed.
231
# In this revision format, root entries have no knit or weave When
232
# serializing out to disk and back in root.revision is always
234
ie.revision = self._new_revision_id
236
def _get_delta(self, ie, basis_inv, path):
237
"""Get a delta against the basis inventory for ie."""
238
if ie.file_id not in basis_inv:
240
result = (None, path, ie.file_id, ie)
241
self._basis_delta.append(result)
243
elif ie != basis_inv[ie.file_id]:
245
# TODO: avoid tis id2path call.
246
result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
247
self._basis_delta.append(result)
253
def get_basis_delta(self):
254
"""Return the complete inventory delta versus the basis inventory.
256
This has been built up with the calls to record_delete and
257
record_entry_contents. The client must have already called
258
will_record_deletes() to indicate that they will be generating a
261
:return: An inventory delta, suitable for use with apply_delta, or
262
Repository.add_inventory_by_delta, etc.
264
if not self._recording_deletes:
265
raise AssertionError("recording deletes not activated.")
266
return self._basis_delta
268
def record_delete(self, path, file_id):
269
"""Record that a delete occured against a basis tree.
271
This is an optional API - when used it adds items to the basis_delta
272
being accumulated by the commit builder. It cannot be called unless the
273
method will_record_deletes() has been called to inform the builder that
274
a delta is being supplied.
276
:param path: The path of the thing deleted.
277
:param file_id: The file id that was deleted.
279
if not self._recording_deletes:
280
raise AssertionError("recording deletes not activated.")
281
delta = (path, None, file_id, None)
282
self._basis_delta.append(delta)
285
def will_record_deletes(self):
286
"""Tell the commit builder that deletes are being notified.
288
This enables the accumulation of an inventory delta; for the resulting
289
commit to be valid, deletes against the basis MUST be recorded via
290
builder.record_delete().
292
self._recording_deletes = True
294
def record_entry_contents(self, ie, parent_invs, path, tree,
296
"""Record the content of ie from tree into the commit if needed.
298
Side effect: sets ie.revision when unchanged
300
:param ie: An inventory entry present in the commit.
301
:param parent_invs: The inventories of the parent revisions of the
303
:param path: The path the entry is at in the tree.
304
:param tree: The tree which contains this entry and should be used to
306
:param content_summary: Summary data from the tree about the paths
307
content - stat, length, exec, sha/link target. This is only
308
accessed when the entry has a revision of None - that is when it is
309
a candidate to commit.
310
:return: A tuple (change_delta, version_recorded, fs_hash).
311
change_delta is an inventory_delta change for this entry against
312
the basis tree of the commit, or None if no change occured against
314
version_recorded is True if a new version of the entry has been
315
recorded. For instance, committing a merge where a file was only
316
changed on the other side will return (delta, False).
317
fs_hash is either None, or the hash details for the path (currently
318
a tuple of the contents sha1 and the statvalue returned by
319
tree.get_file_with_stat()).
321
if self.new_inventory.root is None:
322
if ie.parent_id is not None:
323
raise errors.RootMissing()
324
self._check_root(ie, parent_invs, tree)
325
if ie.revision is None:
326
kind = content_summary[0]
328
# ie is carried over from a prior commit
330
# XXX: repository specific check for nested tree support goes here - if
331
# the repo doesn't want nested trees we skip it ?
332
if (kind == 'tree-reference' and
333
not self.repository._format.supports_tree_reference):
334
# mismatch between commit builder logic and repository:
335
# this needs the entry creation pushed down into the builder.
336
raise NotImplementedError('Missing repository subtree support.')
337
self.new_inventory.add(ie)
339
# TODO: slow, take it out of the inner loop.
341
basis_inv = parent_invs[0]
343
basis_inv = Inventory(root_id=None)
345
# ie.revision is always None if the InventoryEntry is considered
346
# for committing. We may record the previous parents revision if the
347
# content is actually unchanged against a sole head.
348
if ie.revision is not None:
349
if not self._versioned_root and path == '':
350
# repositories that do not version the root set the root's
351
# revision to the new commit even when no change occurs (more
352
# specifically, they do not record a revision on the root; and
353
# the rev id is assigned to the root during deserialisation -
354
# this masks when a change may have occurred against the basis.
355
# To match this we always issue a delta, because the revision
356
# of the root will always be changing.
357
if ie.file_id in basis_inv:
358
delta = (basis_inv.id2path(ie.file_id), path,
362
delta = (None, path, ie.file_id, ie)
363
self._basis_delta.append(delta)
364
return delta, False, None
366
# we don't need to commit this, because the caller already
367
# determined that an existing revision of this file is
368
# appropriate. If its not being considered for committing then
369
# it and all its parents to the root must be unaltered so
370
# no-change against the basis.
371
if ie.revision == self._new_revision_id:
372
raise AssertionError("Impossible situation, a skipped "
373
"inventory entry (%r) claims to be modified in this "
374
"commit (%r).", (ie, self._new_revision_id))
375
return None, False, None
376
# XXX: Friction: parent_candidates should return a list not a dict
377
# so that we don't have to walk the inventories again.
378
parent_candiate_entries = ie.parent_candidates(parent_invs)
379
head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
381
for inv in parent_invs:
382
if ie.file_id in inv:
383
old_rev = inv[ie.file_id].revision
384
if old_rev in head_set:
385
heads.append(inv[ie.file_id].revision)
386
head_set.remove(inv[ie.file_id].revision)
389
# now we check to see if we need to write a new record to the
391
# We write a new entry unless there is one head to the ancestors, and
392
# the kind-derived content is unchanged.
394
# Cheapest check first: no ancestors, or more the one head in the
395
# ancestors, we write a new node.
399
# There is a single head, look it up for comparison
400
parent_entry = parent_candiate_entries[heads[0]]
401
# if the non-content specific data has changed, we'll be writing a
403
if (parent_entry.parent_id != ie.parent_id or
404
parent_entry.name != ie.name):
406
# now we need to do content specific checks:
408
# if the kind changed the content obviously has
409
if kind != parent_entry.kind:
411
# Stat cache fingerprint feedback for the caller - None as we usually
412
# don't generate one.
415
if content_summary[2] is None:
416
raise ValueError("Files must not have executable = None")
418
if (# if the file length changed we have to store:
419
parent_entry.text_size != content_summary[1] or
420
# if the exec bit has changed we have to store:
421
parent_entry.executable != content_summary[2]):
423
elif parent_entry.text_sha1 == content_summary[3]:
424
# all meta and content is unchanged (using a hash cache
425
# hit to check the sha)
426
ie.revision = parent_entry.revision
427
ie.text_size = parent_entry.text_size
428
ie.text_sha1 = parent_entry.text_sha1
429
ie.executable = parent_entry.executable
430
return self._get_delta(ie, basis_inv, path), False, None
432
# Either there is only a hash change(no hash cache entry,
433
# or same size content change), or there is no change on
435
# Provide the parent's hash to the store layer, so that the
436
# content is unchanged we will not store a new node.
437
nostore_sha = parent_entry.text_sha1
439
# We want to record a new node regardless of the presence or
440
# absence of a content change in the file.
442
ie.executable = content_summary[2]
443
file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
445
lines = file_obj.readlines()
449
ie.text_sha1, ie.text_size = self._add_text_to_weave(
450
ie.file_id, lines, heads, nostore_sha)
451
# Let the caller know we generated a stat fingerprint.
452
fingerprint = (ie.text_sha1, stat_value)
453
except errors.ExistingContent:
454
# Turns out that the file content was unchanged, and we were
455
# only going to store a new node if it was changed. Carry over
457
ie.revision = parent_entry.revision
458
ie.text_size = parent_entry.text_size
459
ie.text_sha1 = parent_entry.text_sha1
460
ie.executable = parent_entry.executable
461
return self._get_delta(ie, basis_inv, path), False, None
462
elif kind == 'directory':
464
# all data is meta here, nothing specific to directory, so
466
ie.revision = parent_entry.revision
467
return self._get_delta(ie, basis_inv, path), False, None
469
self._add_text_to_weave(ie.file_id, lines, heads, None)
470
elif kind == 'symlink':
471
current_link_target = content_summary[3]
473
# symlink target is not generic metadata, check if it has
475
if current_link_target != parent_entry.symlink_target:
478
# unchanged, carry over.
479
ie.revision = parent_entry.revision
480
ie.symlink_target = parent_entry.symlink_target
481
return self._get_delta(ie, basis_inv, path), False, None
482
ie.symlink_target = current_link_target
484
self._add_text_to_weave(ie.file_id, lines, heads, None)
485
elif kind == 'tree-reference':
487
if content_summary[3] != parent_entry.reference_revision:
490
# unchanged, carry over.
491
ie.reference_revision = parent_entry.reference_revision
492
ie.revision = parent_entry.revision
493
return self._get_delta(ie, basis_inv, path), False, None
494
ie.reference_revision = content_summary[3]
496
self._add_text_to_weave(ie.file_id, lines, heads, None)
498
raise NotImplementedError('unknown kind')
499
ie.revision = self._new_revision_id
500
return self._get_delta(ie, basis_inv, path), True, fingerprint
502
def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
503
# Note: as we read the content directly from the tree, we know its not
504
# been turned into unicode or badly split - but a broken tree
505
# implementation could give us bad output from readlines() so this is
506
# not a guarantee of safety. What would be better is always checking
507
# the content during test suite execution. RBC 20070912
508
parent_keys = tuple((file_id, parent) for parent in parents)
509
return self.repository.texts.add_lines(
510
(file_id, self._new_revision_id), parent_keys, new_lines,
511
nostore_sha=nostore_sha, random_id=self.random_revid,
512
check_content=False)[0:2]
515
class RootCommitBuilder(CommitBuilder):
516
"""This commitbuilder actually records the root id"""
518
# the root entry gets versioned properly by this builder.
519
_versioned_root = True
521
def _check_root(self, ie, parent_invs, tree):
522
"""Helper for record_entry_contents.
524
:param ie: An entry being added.
525
:param parent_invs: The inventories of the parent revisions of the
527
:param tree: The tree that is being committed.
531
######################################################################
534
class Repository(object):
535
"""Repository holding history for one or more branches.
537
The repository holds and retrieves historical information including
538
revisions and file history. It's normally accessed only by the Branch,
539
which views a particular line of development through that history.
541
The Repository builds on top of some byte storage facilies (the revisions,
542
signatures, inventories and texts attributes) and a Transport, which
543
respectively provide byte storage and a means to access the (possibly
546
The byte storage facilities are addressed via tuples, which we refer to
547
as 'keys' throughout the code base. Revision_keys, inventory_keys and
548
signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
549
(file_id, revision_id). We use this interface because it allows low
550
friction with the underlying code that implements disk indices, network
551
encoding and other parts of bzrlib.
553
:ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
554
the serialised revisions for the repository. This can be used to obtain
555
revision graph information or to access raw serialised revisions.
556
The result of trying to insert data into the repository via this store
557
is undefined: it should be considered read-only except for implementors
559
:ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
560
the serialised signatures for the repository. This can be used to
561
obtain access to raw serialised signatures. The result of trying to
562
insert data into the repository via this store is undefined: it should
563
be considered read-only except for implementors of repositories.
564
:ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
565
the serialised inventories for the repository. This can be used to
566
obtain unserialised inventories. The result of trying to insert data
567
into the repository via this store is undefined: it should be
568
considered read-only except for implementors of repositories.
569
:ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
570
texts of files and directories for the repository. This can be used to
571
obtain file texts or file graphs. Note that Repository.iter_file_bytes
572
is usually a better interface for accessing file texts.
573
The result of trying to insert data into the repository via this store
574
is undefined: it should be considered read-only except for implementors
576
:ivar _transport: Transport for file access to repository, typically
577
pointing to .bzr/repository.
580
# What class to use for a CommitBuilder. Often its simpler to change this
581
# in a Repository class subclass rather than to override
582
# get_commit_builder.
583
_commit_builder_class = CommitBuilder
584
# The search regex used by xml based repositories to determine what things
585
# where changed in a single commit.
586
_file_ids_altered_regex = lazy_regex.lazy_compile(
587
r'file_id="(?P<file_id>[^"]+)"'
588
r'.* revision="(?P<revision_id>[^"]+)"'
591
def abort_write_group(self, suppress_errors=False):
592
"""Commit the contents accrued within the current write group.
594
:param suppress_errors: if true, abort_write_group will catch and log
595
unexpected errors that happen during the abort, rather than
596
allowing them to propagate. Defaults to False.
598
:seealso: start_write_group.
600
if self._write_group is not self.get_transaction():
601
# has an unlock or relock occured ?
602
raise errors.BzrError('mismatched lock context and write group.')
604
self._abort_write_group()
605
except Exception, exc:
606
self._write_group = None
607
if not suppress_errors:
609
mutter('abort_write_group failed')
610
log_exception_quietly()
611
note('bzr: ERROR (ignored): %s', exc)
612
self._write_group = None
614
def _abort_write_group(self):
615
"""Template method for per-repository write group cleanup.
617
This is called during abort before the write group is considered to be
618
finished and should cleanup any internal state accrued during the write
619
group. There is no requirement that data handed to the repository be
620
*not* made available - this is not a rollback - but neither should any
621
attempt be made to ensure that data added is fully commited. Abort is
622
invoked when an error has occured so futher disk or network operations
623
may not be possible or may error and if possible should not be
627
def add_fallback_repository(self, repository):
628
"""Add a repository to use for looking up data not held locally.
630
:param repository: A repository.
632
if not self._format.supports_external_lookups:
633
raise errors.UnstackableRepositoryFormat(self._format, self.base)
634
self._check_fallback_repository(repository)
635
self._fallback_repositories.append(repository)
636
self.texts.add_fallback_versioned_files(repository.texts)
637
self.inventories.add_fallback_versioned_files(repository.inventories)
638
self.revisions.add_fallback_versioned_files(repository.revisions)
639
self.signatures.add_fallback_versioned_files(repository.signatures)
641
def _check_fallback_repository(self, repository):
642
"""Check that this repository can fallback to repository safely.
644
Raise an error if not.
646
:param repository: A repository to fallback to.
648
return InterRepository._assert_same_model(self, repository)
650
def add_inventory(self, revision_id, inv, parents):
651
"""Add the inventory inv to the repository as revision_id.
653
:param parents: The revision ids of the parents that revision_id
654
is known to have and are in the repository already.
656
:returns: The validator(which is a sha1 digest, though what is sha'd is
657
repository format specific) of the serialized inventory.
659
if not self.is_in_write_group():
660
raise AssertionError("%r not in write group" % (self,))
661
_mod_revision.check_not_reserved_id(revision_id)
662
if not (inv.revision_id is None or inv.revision_id == revision_id):
663
raise AssertionError(
664
"Mismatch between inventory revision"
665
" id and insertion revid (%r, %r)"
666
% (inv.revision_id, revision_id))
668
raise AssertionError()
669
inv_lines = self._serialise_inventory_to_lines(inv)
670
return self._inventory_add_lines(revision_id, parents,
671
inv_lines, check_content=False)
673
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
675
"""Add a new inventory expressed as a delta against another revision.
677
:param basis_revision_id: The inventory id the delta was created
678
against. (This does not have to be a direct parent.)
679
:param delta: The inventory delta (see Inventory.apply_delta for
681
:param new_revision_id: The revision id that the inventory is being
683
:param parents: The revision ids of the parents that revision_id is
684
known to have and are in the repository already. These are supplied
685
for repositories that depend on the inventory graph for revision
686
graph access, as well as for those that pun ancestry with delta
689
:returns: (validator, new_inv)
690
The validator(which is a sha1 digest, though what is sha'd is
691
repository format specific) of the serialized inventory, and the
694
if not self.is_in_write_group():
695
raise AssertionError("%r not in write group" % (self,))
696
_mod_revision.check_not_reserved_id(new_revision_id)
697
basis_tree = self.revision_tree(basis_revision_id)
698
basis_tree.lock_read()
700
# Note that this mutates the inventory of basis_tree, which not all
701
# inventory implementations may support: A better idiom would be to
702
# return a new inventory, but as there is no revision tree cache in
703
# repository this is safe for now - RBC 20081013
704
basis_inv = basis_tree.inventory
705
basis_inv.apply_delta(delta)
706
basis_inv.revision_id = new_revision_id
707
return (self.add_inventory(new_revision_id, basis_inv, parents),
712
def _inventory_add_lines(self, revision_id, parents, lines,
714
"""Store lines in inv_vf and return the sha1 of the inventory."""
715
parents = [(parent,) for parent in parents]
716
return self.inventories.add_lines((revision_id,), parents, lines,
717
check_content=check_content)[0]
719
def add_revision(self, revision_id, rev, inv=None, config=None):
720
"""Add rev to the revision store as revision_id.
722
:param revision_id: the revision id to use.
723
:param rev: The revision object.
724
:param inv: The inventory for the revision. if None, it will be looked
725
up in the inventory storer
726
:param config: If None no digital signature will be created.
727
If supplied its signature_needed method will be used
728
to determine if a signature should be made.
730
# TODO: jam 20070210 Shouldn't we check rev.revision_id and
732
_mod_revision.check_not_reserved_id(revision_id)
733
if config is not None and config.signature_needed():
735
inv = self.get_inventory(revision_id)
736
plaintext = Testament(rev, inv).as_short_text()
737
self.store_revision_signature(
738
gpg.GPGStrategy(config), plaintext, revision_id)
739
# check inventory present
740
if not self.inventories.get_parent_map([(revision_id,)]):
742
raise errors.WeaveRevisionNotPresent(revision_id,
745
# yes, this is not suitable for adding with ghosts.
746
rev.inventory_sha1 = self.add_inventory(revision_id, inv,
750
rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
751
self._add_revision(rev)
753
def _add_revision(self, revision):
754
text = self._serializer.write_revision_to_string(revision)
755
key = (revision.revision_id,)
756
parents = tuple((parent,) for parent in revision.parent_ids)
757
self.revisions.add_lines(key, parents, osutils.split_lines(text))
759
def all_revision_ids(self):
760
"""Returns a list of all the revision ids in the repository.
762
This is conceptually deprecated because code should generally work on
763
the graph reachable from a particular revision, and ignore any other
764
revisions that might be present. There is no direct replacement
767
if 'evil' in debug.debug_flags:
768
mutter_callsite(2, "all_revision_ids is linear with history.")
769
return self._all_revision_ids()
771
def _all_revision_ids(self):
772
"""Returns a list of all the revision ids in the repository.
774
These are in as much topological order as the underlying store can
777
raise NotImplementedError(self._all_revision_ids)
779
def break_lock(self):
780
"""Break a lock if one is present from another instance.
782
Uses the ui factory to ask for confirmation if the lock may be from
785
self.control_files.break_lock()
788
def _eliminate_revisions_not_present(self, revision_ids):
789
"""Check every revision id in revision_ids to see if we have it.
791
Returns a set of the present revisions.
794
graph = self.get_graph()
795
parent_map = graph.get_parent_map(revision_ids)
796
# The old API returned a list, should this actually be a set?
797
return parent_map.keys()
800
def create(a_bzrdir):
801
"""Construct the current default format repository in a_bzrdir."""
802
return RepositoryFormat.get_default_format().initialize(a_bzrdir)
804
def __init__(self, _format, a_bzrdir, control_files):
805
"""instantiate a Repository.
807
:param _format: The format of the repository on disk.
808
:param a_bzrdir: The BzrDir of the repository.
810
In the future we will have a single api for all stores for
811
getting file texts, inventories and revisions, then
812
this construct will accept instances of those things.
814
super(Repository, self).__init__()
815
self._format = _format
816
# the following are part of the public API for Repository:
817
self.bzrdir = a_bzrdir
818
self.control_files = control_files
819
self._transport = control_files._transport
820
self.base = self._transport.base
822
self._reconcile_does_inventory_gc = True
823
self._reconcile_fixes_text_parents = False
824
self._reconcile_backsup_inventory = True
825
# not right yet - should be more semantically clear ?
827
# TODO: make sure to construct the right store classes, etc, depending
828
# on whether escaping is required.
829
self._warn_if_deprecated()
830
self._write_group = None
831
# Additional places to query for data.
832
self._fallback_repositories = []
833
# An InventoryEntry cache, used during deserialization
834
self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
837
return '%s(%r)' % (self.__class__.__name__,
840
def has_same_location(self, other):
841
"""Returns a boolean indicating if this repository is at the same
842
location as another repository.
844
This might return False even when two repository objects are accessing
845
the same physical repository via different URLs.
847
if self.__class__ is not other.__class__:
849
return (self._transport.base == other._transport.base)
851
def is_in_write_group(self):
852
"""Return True if there is an open write group.
854
:seealso: start_write_group.
856
return self._write_group is not None
859
return self.control_files.is_locked()
861
def is_write_locked(self):
862
"""Return True if this object is write locked."""
863
return self.is_locked() and self.control_files._lock_mode == 'w'
865
def lock_write(self, token=None):
866
"""Lock this repository for writing.
868
This causes caching within the repository obejct to start accumlating
869
data during reads, and allows a 'write_group' to be obtained. Write
870
groups must be used for actual data insertion.
872
:param token: if this is already locked, then lock_write will fail
873
unless the token matches the existing lock.
874
:returns: a token if this instance supports tokens, otherwise None.
875
:raises TokenLockingNotSupported: when a token is given but this
876
instance doesn't support using token locks.
877
:raises MismatchedToken: if the specified token doesn't match the token
878
of the existing lock.
879
:seealso: start_write_group.
881
A token should be passed in if you know that you have locked the object
882
some other way, and need to synchronise this object's state with that
885
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
887
locked = self.is_locked()
888
result = self.control_files.lock_write(token=token)
889
for repo in self._fallback_repositories:
890
# Writes don't affect fallback repos
897
locked = self.is_locked()
898
self.control_files.lock_read()
899
for repo in self._fallback_repositories:
904
def get_physical_lock_status(self):
905
return self.control_files.get_physical_lock_status()
907
def leave_lock_in_place(self):
908
"""Tell this repository not to release the physical lock when this
911
If lock_write doesn't return a token, then this method is not supported.
913
self.control_files.leave_in_place()
915
def dont_leave_lock_in_place(self):
916
"""Tell this repository to release the physical lock when this
917
object is unlocked, even if it didn't originally acquire it.
919
If lock_write doesn't return a token, then this method is not supported.
921
self.control_files.dont_leave_in_place()
924
def gather_stats(self, revid=None, committers=None):
925
"""Gather statistics from a revision id.
927
:param revid: The revision id to gather statistics from, if None, then
928
no revision specific statistics are gathered.
929
:param committers: Optional parameter controlling whether to grab
930
a count of committers from the revision specific statistics.
931
:return: A dictionary of statistics. Currently this contains:
932
committers: The number of committers if requested.
933
firstrev: A tuple with timestamp, timezone for the penultimate left
934
most ancestor of revid, if revid is not the NULL_REVISION.
935
latestrev: A tuple with timestamp, timezone for revid, if revid is
936
not the NULL_REVISION.
937
revisions: The total revision count in the repository.
938
size: An estimate disk size of the repository in bytes.
941
if revid and committers:
942
result['committers'] = 0
943
if revid and revid != _mod_revision.NULL_REVISION:
945
all_committers = set()
946
revisions = self.get_ancestry(revid)
947
# pop the leading None
949
first_revision = None
951
# ignore the revisions in the middle - just grab first and last
952
revisions = revisions[0], revisions[-1]
953
for revision in self.get_revisions(revisions):
954
if not first_revision:
955
first_revision = revision
957
all_committers.add(revision.committer)
958
last_revision = revision
960
result['committers'] = len(all_committers)
961
result['firstrev'] = (first_revision.timestamp,
962
first_revision.timezone)
963
result['latestrev'] = (last_revision.timestamp,
964
last_revision.timezone)
966
# now gather global repository information
967
# XXX: This is available for many repos regardless of listability.
968
if self.bzrdir.root_transport.listable():
969
# XXX: do we want to __define len__() ?
970
# Maybe the versionedfiles object should provide a different
971
# method to get the number of keys.
972
result['revisions'] = len(self.revisions.keys())
976
def find_branches(self, using=False):
977
"""Find branches underneath this repository.
979
This will include branches inside other branches.
981
:param using: If True, list only branches using this repository.
983
if using and not self.is_shared():
985
return [self.bzrdir.open_branch()]
986
except errors.NotBranchError:
988
class Evaluator(object):
991
self.first_call = True
993
def __call__(self, bzrdir):
994
# On the first call, the parameter is always the bzrdir
995
# containing the current repo.
996
if not self.first_call:
998
repository = bzrdir.open_repository()
999
except errors.NoRepositoryPresent:
1002
return False, (None, repository)
1003
self.first_call = False
1005
value = (bzrdir.open_branch(), None)
1006
except errors.NotBranchError:
1007
value = (None, None)
1011
for branch, repository in bzrdir.BzrDir.find_bzrdirs(
1012
self.bzrdir.root_transport, evaluate=Evaluator()):
1013
if branch is not None:
1014
branches.append(branch)
1015
if not using and repository is not None:
1016
branches.extend(repository.find_branches())
1020
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1021
"""Return the revision ids that other has that this does not.
1023
These are returned in topological order.
1025
revision_id: only return revision ids included by revision_id.
1027
return InterRepository.get(other, self).search_missing_revision_ids(
1028
revision_id, find_ghosts)
1030
@deprecated_method(one_two)
1032
def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1033
"""Return the revision ids that other has that this does not.
1035
These are returned in topological order.
1037
revision_id: only return revision ids included by revision_id.
1039
keys = self.search_missing_revision_ids(
1040
other, revision_id, find_ghosts).get_keys()
1043
parents = other.get_graph().get_parent_map(keys)
1046
return tsort.topo_sort(parents)
1050
"""Open the repository rooted at base.
1052
For instance, if the repository is at URL/.bzr/repository,
1053
Repository.open(URL) -> a Repository instance.
1055
control = bzrdir.BzrDir.open(base)
1056
return control.open_repository()
1058
def copy_content_into(self, destination, revision_id=None):
1059
"""Make a complete copy of the content in self into destination.
1061
This is a destructive operation! Do not use it on existing
1064
return InterRepository.get(self, destination).copy_content(revision_id)
1066
def commit_write_group(self):
1067
"""Commit the contents accrued within the current write group.
1069
:seealso: start_write_group.
1071
if self._write_group is not self.get_transaction():
1072
# has an unlock or relock occured ?
1073
raise errors.BzrError('mismatched lock context %r and '
1075
(self.get_transaction(), self._write_group))
1076
self._commit_write_group()
1077
self._write_group = None
1079
def _commit_write_group(self):
1080
"""Template method for per-repository write group cleanup.
1082
This is called before the write group is considered to be
1083
finished and should ensure that all data handed to the repository
1084
for writing during the write group is safely committed (to the
1085
extent possible considering file system caching etc).
1088
def suspend_write_group(self):
1089
raise errors.UnsuspendableWriteGroup(self)
1091
def refresh_data(self):
1092
"""Re-read any data needed to to synchronise with disk.
1094
This method is intended to be called after another repository instance
1095
(such as one used by a smart server) has inserted data into the
1096
repository. It may not be called during a write group, but may be
1097
called at any other time.
1099
if self.is_in_write_group():
1100
raise errors.InternalBzrError(
1101
"May not refresh_data while in a write group.")
1102
self._refresh_data()
1104
def resume_write_group(self, tokens):
1105
if not self.is_write_locked():
1106
raise errors.NotWriteLocked(self)
1107
if self._write_group:
1108
raise errors.BzrError('already in a write group')
1109
self._resume_write_group(tokens)
1110
# so we can detect unlock/relock - the write group is now entered.
1111
self._write_group = self.get_transaction()
1113
def _resume_write_group(self, tokens):
1114
raise errors.UnsuspendableWriteGroup(self)
1116
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1118
"""Fetch the content required to construct revision_id from source.
1120
If revision_id is None and fetch_spec is None, then all content is
1123
fetch() may not be used when the repository is in a write group -
1124
either finish the current write group before using fetch, or use
1125
fetch before starting the write group.
1127
:param find_ghosts: Find and copy revisions in the source that are
1128
ghosts in the target (and not reachable directly by walking out to
1129
the first-present revision in target from revision_id).
1130
:param revision_id: If specified, all the content needed for this
1131
revision ID will be copied to the target. Fetch will determine for
1132
itself which content needs to be copied.
1133
:param fetch_spec: If specified, a SearchResult or
1134
PendingAncestryResult that describes which revisions to copy. This
1135
allows copying multiple heads at once. Mutually exclusive with
1138
if fetch_spec is not None and revision_id is not None:
1139
raise AssertionError(
1140
"fetch_spec and revision_id are mutually exclusive.")
1141
if self.is_in_write_group():
1142
raise errors.InternalBzrError(
1143
"May not fetch while in a write group.")
1144
# fast path same-url fetch operations
1145
if self.has_same_location(source) and fetch_spec is None:
1146
# check that last_revision is in 'from' and then return a
1148
if (revision_id is not None and
1149
not _mod_revision.is_null(revision_id)):
1150
self.get_revision(revision_id)
1152
# if there is no specific appropriate InterRepository, this will get
1153
# the InterRepository base class, which raises an
1154
# IncompatibleRepositories when asked to fetch.
1155
inter = InterRepository.get(source, self)
1156
return inter.fetch(revision_id=revision_id, pb=pb,
1157
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1159
def create_bundle(self, target, base, fileobj, format=None):
1160
return serializer.write_bundle(self, target, base, fileobj, format)
1162
def get_commit_builder(self, branch, parents, config, timestamp=None,
1163
timezone=None, committer=None, revprops=None,
1165
"""Obtain a CommitBuilder for this repository.
1167
:param branch: Branch to commit to.
1168
:param parents: Revision ids of the parents of the new revision.
1169
:param config: Configuration to use.
1170
:param timestamp: Optional timestamp recorded for commit.
1171
:param timezone: Optional timezone for timestamp.
1172
:param committer: Optional committer to set for commit.
1173
:param revprops: Optional dictionary of revision properties.
1174
:param revision_id: Optional revision id.
1176
result = self._commit_builder_class(self, parents, config,
1177
timestamp, timezone, committer, revprops, revision_id)
1178
self.start_write_group()
1182
if (self.control_files._lock_count == 1 and
1183
self.control_files._lock_mode == 'w'):
1184
if self._write_group is not None:
1185
self.abort_write_group()
1186
self.control_files.unlock()
1187
raise errors.BzrError(
1188
'Must end write groups before releasing write locks.')
1189
self.control_files.unlock()
1190
if self.control_files._lock_count == 0:
1191
self._inventory_entry_cache.clear()
1192
for repo in self._fallback_repositories:
1196
def clone(self, a_bzrdir, revision_id=None):
1197
"""Clone this repository into a_bzrdir using the current format.
1199
Currently no check is made that the format of this repository and
1200
the bzrdir format are compatible. FIXME RBC 20060201.
1202
:return: The newly created destination repository.
1204
# TODO: deprecate after 0.16; cloning this with all its settings is
1205
# probably not very useful -- mbp 20070423
1206
dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
1207
self.copy_content_into(dest_repo, revision_id)
1210
def start_write_group(self):
1211
"""Start a write group in the repository.
1213
Write groups are used by repositories which do not have a 1:1 mapping
1214
between file ids and backend store to manage the insertion of data from
1215
both fetch and commit operations.
1217
A write lock is required around the start_write_group/commit_write_group
1218
for the support of lock-requiring repository formats.
1220
One can only insert data into a repository inside a write group.
1224
if not self.is_write_locked():
1225
raise errors.NotWriteLocked(self)
1226
if self._write_group:
1227
raise errors.BzrError('already in a write group')
1228
self._start_write_group()
1229
# so we can detect unlock/relock - the write group is now entered.
1230
self._write_group = self.get_transaction()
1232
def _start_write_group(self):
1233
"""Template method for per-repository write group startup.
1235
This is called before the write group is considered to be
1240
def sprout(self, to_bzrdir, revision_id=None):
1241
"""Create a descendent repository for new development.
1243
Unlike clone, this does not copy the settings of the repository.
1245
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1246
dest_repo.fetch(self, revision_id=revision_id)
1249
def _create_sprouting_repo(self, a_bzrdir, shared):
1250
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
1251
# use target default format.
1252
dest_repo = a_bzrdir.create_repository()
1254
# Most control formats need the repository to be specifically
1255
# created, but on some old all-in-one formats it's not needed
1257
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
1258
except errors.UninitializableFormat:
1259
dest_repo = a_bzrdir.open_repository()
1262
def _get_sink(self):
1263
"""Return a sink for streaming into this repository."""
1264
return StreamSink(self)
1266
def _get_source(self, to_format):
1267
"""Return a source for streaming from this repository."""
1268
return StreamSource(self, to_format)
1271
def has_revision(self, revision_id):
1272
"""True if this repository has a copy of the revision."""
1273
return revision_id in self.has_revisions((revision_id,))
1276
def has_revisions(self, revision_ids):
1277
"""Probe to find out the presence of multiple revisions.
1279
:param revision_ids: An iterable of revision_ids.
1280
:return: A set of the revision_ids that were present.
1282
parent_map = self.revisions.get_parent_map(
1283
[(rev_id,) for rev_id in revision_ids])
1285
if _mod_revision.NULL_REVISION in revision_ids:
1286
result.add(_mod_revision.NULL_REVISION)
1287
result.update([key[0] for key in parent_map])
1291
def get_revision(self, revision_id):
1292
"""Return the Revision object for a named revision."""
1293
return self.get_revisions([revision_id])[0]
1296
def get_revision_reconcile(self, revision_id):
1297
"""'reconcile' helper routine that allows access to a revision always.
1299
This variant of get_revision does not cross check the weave graph
1300
against the revision one as get_revision does: but it should only
1301
be used by reconcile, or reconcile-alike commands that are correcting
1302
or testing the revision graph.
1304
return self._get_revisions([revision_id])[0]
1307
def get_revisions(self, revision_ids):
1308
"""Get many revisions at once."""
1309
return self._get_revisions(revision_ids)
1312
def _get_revisions(self, revision_ids):
1313
"""Core work logic to get many revisions without sanity checks."""
1314
for rev_id in revision_ids:
1315
if not rev_id or not isinstance(rev_id, basestring):
1316
raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1317
keys = [(key,) for key in revision_ids]
1318
stream = self.revisions.get_record_stream(keys, 'unordered', True)
1320
for record in stream:
1321
if record.storage_kind == 'absent':
1322
raise errors.NoSuchRevision(self, record.key[0])
1323
text = record.get_bytes_as('fulltext')
1324
rev = self._serializer.read_revision_from_string(text)
1325
revs[record.key[0]] = rev
1326
return [revs[revid] for revid in revision_ids]
1329
def get_revision_xml(self, revision_id):
1330
# TODO: jam 20070210 This shouldn't be necessary since get_revision
1331
# would have already do it.
1332
# TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1333
rev = self.get_revision(revision_id)
1334
rev_tmp = cStringIO.StringIO()
1335
# the current serializer..
1336
self._serializer.write_revision(rev, rev_tmp)
1338
return rev_tmp.getvalue()
1340
def get_deltas_for_revisions(self, revisions):
1341
"""Produce a generator of revision deltas.
1343
Note that the input is a sequence of REVISIONS, not revision_ids.
1344
Trees will be held in memory until the generator exits.
1345
Each delta is relative to the revision's lefthand predecessor.
1347
required_trees = set()
1348
for revision in revisions:
1349
required_trees.add(revision.revision_id)
1350
required_trees.update(revision.parent_ids[:1])
1351
trees = dict((t.get_revision_id(), t) for
1352
t in self.revision_trees(required_trees))
1353
for revision in revisions:
1354
if not revision.parent_ids:
1355
old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
1357
old_tree = trees[revision.parent_ids[0]]
1358
yield trees[revision.revision_id].changes_from(old_tree)
1361
def get_revision_delta(self, revision_id):
1362
"""Return the delta for one revision.
1364
The delta is relative to the left-hand predecessor of the
1367
r = self.get_revision(revision_id)
1368
return list(self.get_deltas_for_revisions([r]))[0]
1371
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1372
signature = gpg_strategy.sign(plaintext)
1373
self.add_signature_text(revision_id, signature)
1376
def add_signature_text(self, revision_id, signature):
1377
self.signatures.add_lines((revision_id,), (),
1378
osutils.split_lines(signature))
1380
def find_text_key_references(self):
1381
"""Find the text key references within the repository.
1383
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
1384
revision_ids. Each altered file-ids has the exact revision_ids that
1385
altered it listed explicitly.
1386
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1387
to whether they were referred to by the inventory of the
1388
revision_id that they contain. The inventory texts from all present
1389
revision ids are assessed to generate this report.
1391
revision_keys = self.revisions.keys()
1392
w = self.inventories
1393
pb = ui.ui_factory.nested_progress_bar()
1395
return self._find_text_key_references_from_xml_inventory_lines(
1396
w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
1400
def _find_text_key_references_from_xml_inventory_lines(self,
1402
"""Core routine for extracting references to texts from inventories.
1404
This performs the translation of xml lines to revision ids.
1406
:param line_iterator: An iterator of lines, origin_version_id
1407
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1408
to whether they were referred to by the inventory of the
1409
revision_id that they contain. Note that if that revision_id was
1410
not part of the line_iterator's output then False will be given -
1411
even though it may actually refer to that key.
1413
if not self._serializer.support_altered_by_hack:
1414
raise AssertionError(
1415
"_find_text_key_references_from_xml_inventory_lines only "
1416
"supported for branches which store inventory as unnested xml"
1417
", not on %r" % self)
1420
# this code needs to read every new line in every inventory for the
1421
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
1422
# not present in one of those inventories is unnecessary but not
1423
# harmful because we are filtering by the revision id marker in the
1424
# inventory lines : we only select file ids altered in one of those
1425
# revisions. We don't need to see all lines in the inventory because
1426
# only those added in an inventory in rev X can contain a revision=X
1428
unescape_revid_cache = {}
1429
unescape_fileid_cache = {}
1431
# jam 20061218 In a big fetch, this handles hundreds of thousands
1432
# of lines, so it has had a lot of inlining and optimizing done.
1433
# Sorry that it is a little bit messy.
1434
# Move several functions to be local variables, since this is a long
1436
search = self._file_ids_altered_regex.search
1437
unescape = _unescape_xml
1438
setdefault = result.setdefault
1439
for line, line_key in line_iterator:
1440
match = search(line)
1443
# One call to match.group() returning multiple items is quite a
1444
# bit faster than 2 calls to match.group() each returning 1
1445
file_id, revision_id = match.group('file_id', 'revision_id')
1447
# Inlining the cache lookups helps a lot when you make 170,000
1448
# lines and 350k ids, versus 8.4 unique ids.
1449
# Using a cache helps in 2 ways:
1450
# 1) Avoids unnecessary decoding calls
1451
# 2) Re-uses cached strings, which helps in future set and
1453
# (2) is enough that removing encoding entirely along with
1454
# the cache (so we are using plain strings) results in no
1455
# performance improvement.
1457
revision_id = unescape_revid_cache[revision_id]
1459
unescaped = unescape(revision_id)
1460
unescape_revid_cache[revision_id] = unescaped
1461
revision_id = unescaped
1463
# Note that unconditionally unescaping means that we deserialise
1464
# every fileid, which for general 'pull' is not great, but we don't
1465
# really want to have some many fulltexts that this matters anyway.
1468
file_id = unescape_fileid_cache[file_id]
1470
unescaped = unescape(file_id)
1471
unescape_fileid_cache[file_id] = unescaped
1474
key = (file_id, revision_id)
1475
setdefault(key, False)
1476
if revision_id == line_key[-1]:
1480
def _inventory_xml_lines_for_keys(self, keys):
1481
"""Get a line iterator of the sort needed for findind references.
1483
Not relevant for non-xml inventory repositories.
1485
Ghosts in revision_keys are ignored.
1487
:param revision_keys: The revision keys for the inventories to inspect.
1488
:return: An iterator over (inventory line, revid) for the fulltexts of
1489
all of the xml inventories specified by revision_keys.
1491
stream = self.inventories.get_record_stream(keys, 'unordered', True)
1492
for record in stream:
1493
if record.storage_kind != 'absent':
1494
chunks = record.get_bytes_as('chunked')
1495
revid = record.key[-1]
1496
lines = osutils.chunks_to_lines(chunks)
1500
def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
1502
"""Helper routine for fileids_altered_by_revision_ids.
1504
This performs the translation of xml lines to revision ids.
1506
:param line_iterator: An iterator of lines, origin_version_id
1507
:param revision_ids: The revision ids to filter for. This should be a
1508
set or other type which supports efficient __contains__ lookups, as
1509
the revision id from each parsed line will be looked up in the
1510
revision_ids filter.
1511
:return: a dictionary mapping altered file-ids to an iterable of
1512
revision_ids. Each altered file-ids has the exact revision_ids that
1513
altered it listed explicitly.
1515
seen = set(self._find_text_key_references_from_xml_inventory_lines(
1516
line_iterator).iterkeys())
1517
# Note that revision_ids are revision keys.
1518
parent_maps = self.revisions.get_parent_map(revision_ids)
1520
map(parents.update, parent_maps.itervalues())
1521
parents.difference_update(revision_ids)
1522
parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
1523
self._inventory_xml_lines_for_keys(parents)))
1524
new_keys = seen - parent_seen
1526
setdefault = result.setdefault
1527
for key in new_keys:
1528
setdefault(key[0], set()).add(key[-1])
1531
def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
1532
"""Find the file ids and versions affected by revisions.
1534
:param revisions: an iterable containing revision ids.
1535
:param _inv_weave: The inventory weave from this repository or None.
1536
If None, the inventory weave will be opened automatically.
1537
:return: a dictionary mapping altered file-ids to an iterable of
1538
revision_ids. Each altered file-ids has the exact revision_ids that
1539
altered it listed explicitly.
1541
selected_keys = set((revid,) for revid in revision_ids)
1542
w = _inv_weave or self.inventories
1543
pb = ui.ui_factory.nested_progress_bar()
1545
return self._find_file_ids_from_xml_inventory_lines(
1546
w.iter_lines_added_or_present_in_keys(
1547
selected_keys, pb=pb),
1552
def iter_files_bytes(self, desired_files):
1553
"""Iterate through file versions.
1555
Files will not necessarily be returned in the order they occur in
1556
desired_files. No specific order is guaranteed.
1558
Yields pairs of identifier, bytes_iterator. identifier is an opaque
1559
value supplied by the caller as part of desired_files. It should
1560
uniquely identify the file version in the caller's context. (Examples:
1561
an index number or a TreeTransform trans_id.)
1563
bytes_iterator is an iterable of bytestrings for the file. The
1564
kind of iterable and length of the bytestrings are unspecified, but for
1565
this implementation, it is a list of bytes produced by
1566
VersionedFile.get_record_stream().
1568
:param desired_files: a list of (file_id, revision_id, identifier)
1572
for file_id, revision_id, callable_data in desired_files:
1573
text_keys[(file_id, revision_id)] = callable_data
1574
for record in self.texts.get_record_stream(text_keys, 'unordered', True):
1575
if record.storage_kind == 'absent':
1576
raise errors.RevisionNotPresent(record.key, self)
1577
yield text_keys[record.key], record.get_bytes_as('fulltext')
1579
def _generate_text_key_index(self, text_key_references=None,
1581
"""Generate a new text key index for the repository.
1583
This is an expensive function that will take considerable time to run.
1585
:return: A dict mapping text keys ((file_id, revision_id) tuples) to a
1586
list of parents, also text keys. When a given key has no parents,
1587
the parents list will be [NULL_REVISION].
1589
# All revisions, to find inventory parents.
1590
if ancestors is None:
1591
graph = self.get_graph()
1592
ancestors = graph.get_parent_map(self.all_revision_ids())
1593
if text_key_references is None:
1594
text_key_references = self.find_text_key_references()
1595
pb = ui.ui_factory.nested_progress_bar()
1597
return self._do_generate_text_key_index(ancestors,
1598
text_key_references, pb)
1602
def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
1603
"""Helper for _generate_text_key_index to avoid deep nesting."""
1604
revision_order = tsort.topo_sort(ancestors)
1605
invalid_keys = set()
1607
for revision_id in revision_order:
1608
revision_keys[revision_id] = set()
1609
text_count = len(text_key_references)
1610
# a cache of the text keys to allow reuse; costs a dict of all the
1611
# keys, but saves a 2-tuple for every child of a given key.
1613
for text_key, valid in text_key_references.iteritems():
1615
invalid_keys.add(text_key)
1617
revision_keys[text_key[1]].add(text_key)
1618
text_key_cache[text_key] = text_key
1619
del text_key_references
1621
text_graph = graph.Graph(graph.DictParentsProvider(text_index))
1622
NULL_REVISION = _mod_revision.NULL_REVISION
1623
# Set a cache with a size of 10 - this suffices for bzr.dev but may be
1624
# too small for large or very branchy trees. However, for 55K path
1625
# trees, it would be easy to use too much memory trivially. Ideally we
1626
# could gauge this by looking at available real memory etc, but this is
1627
# always a tricky proposition.
1628
inventory_cache = lru_cache.LRUCache(10)
1629
batch_size = 10 # should be ~150MB on a 55K path tree
1630
batch_count = len(revision_order) / batch_size + 1
1632
pb.update("Calculating text parents", processed_texts, text_count)
1633
for offset in xrange(batch_count):
1634
to_query = revision_order[offset * batch_size:(offset + 1) *
1638
for rev_tree in self.revision_trees(to_query):
1639
revision_id = rev_tree.get_revision_id()
1640
parent_ids = ancestors[revision_id]
1641
for text_key in revision_keys[revision_id]:
1642
pb.update("Calculating text parents", processed_texts)
1643
processed_texts += 1
1644
candidate_parents = []
1645
for parent_id in parent_ids:
1646
parent_text_key = (text_key[0], parent_id)
1648
check_parent = parent_text_key not in \
1649
revision_keys[parent_id]
1651
# the parent parent_id is a ghost:
1652
check_parent = False
1653
# truncate the derived graph against this ghost.
1654
parent_text_key = None
1656
# look at the parent commit details inventories to
1657
# determine possible candidates in the per file graph.
1660
inv = inventory_cache[parent_id]
1662
inv = self.revision_tree(parent_id).inventory
1663
inventory_cache[parent_id] = inv
1664
parent_entry = inv._byid.get(text_key[0], None)
1665
if parent_entry is not None:
1667
text_key[0], parent_entry.revision)
1669
parent_text_key = None
1670
if parent_text_key is not None:
1671
candidate_parents.append(
1672
text_key_cache[parent_text_key])
1673
parent_heads = text_graph.heads(candidate_parents)
1674
new_parents = list(parent_heads)
1675
new_parents.sort(key=lambda x:candidate_parents.index(x))
1676
if new_parents == []:
1677
new_parents = [NULL_REVISION]
1678
text_index[text_key] = new_parents
1680
for text_key in invalid_keys:
1681
text_index[text_key] = [NULL_REVISION]
1684
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1685
"""Get an iterable listing the keys of all the data introduced by a set
1688
The keys will be ordered so that the corresponding items can be safely
1689
fetched and inserted in that order.
1691
:returns: An iterable producing tuples of (knit-kind, file-id,
1692
versions). knit-kind is one of 'file', 'inventory', 'signatures',
1693
'revisions'. file-id is None unless knit-kind is 'file'.
1695
# XXX: it's a bit weird to control the inventory weave caching in this
1696
# generator. Ideally the caching would be done in fetch.py I think. Or
1697
# maybe this generator should explicitly have the contract that it
1698
# should not be iterated until the previously yielded item has been
1700
inv_w = self.inventories
1702
# file ids that changed
1703
file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
1705
num_file_ids = len(file_ids)
1706
for file_id, altered_versions in file_ids.iteritems():
1707
if _files_pb is not None:
1708
_files_pb.update("fetch texts", count, num_file_ids)
1710
yield ("file", file_id, altered_versions)
1711
# We're done with the files_pb. Note that it finished by the caller,
1712
# just as it was created by the caller.
1716
yield ("inventory", None, revision_ids)
1719
# XXX: Note ATM no callers actually pay attention to this return
1720
# instead they just use the list of revision ids and ignore
1721
# missing sigs. Consider removing this work entirely
1722
revisions_with_signatures = set(self.signatures.get_parent_map(
1723
[(r,) for r in revision_ids]))
1724
revisions_with_signatures = set(
1725
[r for (r,) in revisions_with_signatures])
1726
revisions_with_signatures.intersection_update(revision_ids)
1727
yield ("signatures", None, revisions_with_signatures)
1730
yield ("revisions", None, revision_ids)
1733
def get_inventory(self, revision_id):
1734
"""Get Inventory object by revision id."""
1735
return self.iter_inventories([revision_id]).next()
1737
def iter_inventories(self, revision_ids):
1738
"""Get many inventories by revision_ids.
1740
This will buffer some or all of the texts used in constructing the
1741
inventories in memory, but will only parse a single inventory at a
1744
:return: An iterator of inventories.
1746
if ((None in revision_ids)
1747
or (_mod_revision.NULL_REVISION in revision_ids)):
1748
raise ValueError('cannot get null revision inventory')
1749
return self._iter_inventories(revision_ids)
1751
def _iter_inventories(self, revision_ids):
1752
"""single-document based inventory iteration."""
1753
for text, revision_id in self._iter_inventory_xmls(revision_ids):
1754
yield self.deserialise_inventory(revision_id, text)
1756
def _iter_inventory_xmls(self, revision_ids):
1757
keys = [(revision_id,) for revision_id in revision_ids]
1758
stream = self.inventories.get_record_stream(keys, 'unordered', True)
1760
for record in stream:
1761
if record.storage_kind != 'absent':
1762
text_chunks[record.key] = record.get_bytes_as('chunked')
1764
raise errors.NoSuchRevision(self, record.key)
1766
chunks = text_chunks.pop(key)
1767
yield ''.join(chunks), key[-1]
1769
def deserialise_inventory(self, revision_id, xml):
1770
"""Transform the xml into an inventory object.
1772
:param revision_id: The expected revision id of the inventory.
1773
:param xml: A serialised inventory.
1775
result = self._serializer.read_inventory_from_string(xml, revision_id,
1776
entry_cache=self._inventory_entry_cache)
1777
if result.revision_id != revision_id:
1778
raise AssertionError('revision id mismatch %s != %s' % (
1779
result.revision_id, revision_id))
1782
def serialise_inventory(self, inv):
1783
return self._serializer.write_inventory_to_string(inv)
1785
def _serialise_inventory_to_lines(self, inv):
1786
return self._serializer.write_inventory_to_lines(inv)
1788
def get_serializer_format(self):
1789
return self._serializer.format_num
1792
def get_inventory_xml(self, revision_id):
1793
"""Get inventory XML as a file object."""
1794
texts = self._iter_inventory_xmls([revision_id])
1796
text, revision_id = texts.next()
1797
except StopIteration:
1798
raise errors.HistoryMissing(self, 'inventory', revision_id)
1802
def get_inventory_sha1(self, revision_id):
1803
"""Return the sha1 hash of the inventory entry
1805
return self.get_revision(revision_id).inventory_sha1
1807
def iter_reverse_revision_history(self, revision_id):
1808
"""Iterate backwards through revision ids in the lefthand history
1810
:param revision_id: The revision id to start with. All its lefthand
1811
ancestors will be traversed.
1813
graph = self.get_graph()
1814
next_id = revision_id
1816
if next_id in (None, _mod_revision.NULL_REVISION):
1819
# Note: The following line may raise KeyError in the event of
1820
# truncated history. We decided not to have a try:except:raise
1821
# RevisionNotPresent here until we see a use for it, because of the
1822
# cost in an inner loop that is by its very nature O(history).
1823
# Robert Collins 20080326
1824
parents = graph.get_parent_map([next_id])[next_id]
1825
if len(parents) == 0:
1828
next_id = parents[0]
1831
def get_revision_inventory(self, revision_id):
1832
"""Return inventory of a past revision."""
1833
# TODO: Unify this with get_inventory()
1834
# bzr 0.0.6 and later imposes the constraint that the inventory_id
1835
# must be the same as its revision, so this is trivial.
1836
if revision_id is None:
1837
# This does not make sense: if there is no revision,
1838
# then it is the current tree inventory surely ?!
1839
# and thus get_root_id() is something that looks at the last
1840
# commit on the branch, and the get_root_id is an inventory check.
1841
raise NotImplementedError
1842
# return Inventory(self.get_root_id())
1844
return self.get_inventory(revision_id)
1846
def is_shared(self):
1847
"""Return True if this repository is flagged as a shared repository."""
1848
raise NotImplementedError(self.is_shared)
1851
def reconcile(self, other=None, thorough=False):
1852
"""Reconcile this repository."""
1853
from bzrlib.reconcile import RepoReconciler
1854
reconciler = RepoReconciler(self, thorough=thorough)
1855
reconciler.reconcile()
1858
def _refresh_data(self):
1859
"""Helper called from lock_* to ensure coherency with disk.
1861
The default implementation does nothing; it is however possible
1862
for repositories to maintain loaded indices across multiple locks
1863
by checking inside their implementation of this method to see
1864
whether their indices are still valid. This depends of course on
1865
the disk format being validatable in this manner. This method is
1866
also called by the refresh_data() public interface to cause a refresh
1867
to occur while in a write lock so that data inserted by a smart server
1868
push operation is visible on the client's instance of the physical
1873
def revision_tree(self, revision_id):
1874
"""Return Tree for a revision on this branch.
1876
`revision_id` may be NULL_REVISION for the empty tree revision.
1878
revision_id = _mod_revision.ensure_null(revision_id)
1879
# TODO: refactor this to use an existing revision object
1880
# so we don't need to read it in twice.
1881
if revision_id == _mod_revision.NULL_REVISION:
1882
return RevisionTree(self, Inventory(root_id=None),
1883
_mod_revision.NULL_REVISION)
1885
inv = self.get_revision_inventory(revision_id)
1886
return RevisionTree(self, inv, revision_id)
1888
def revision_trees(self, revision_ids):
1889
"""Return Tree for a revision on this branch.
1891
`revision_id` may not be None or 'null:'"""
1892
inventories = self.iter_inventories(revision_ids)
1893
for inv in inventories:
1894
yield RevisionTree(self, inv, inv.revision_id)
1897
def get_ancestry(self, revision_id, topo_sorted=True):
1898
"""Return a list of revision-ids integrated by a revision.
1900
The first element of the list is always None, indicating the origin
1901
revision. This might change when we have history horizons, or
1902
perhaps we should have a new API.
1904
This is topologically sorted.
1906
if _mod_revision.is_null(revision_id):
1908
if not self.has_revision(revision_id):
1909
raise errors.NoSuchRevision(self, revision_id)
1910
graph = self.get_graph()
1912
search = graph._make_breadth_first_searcher([revision_id])
1915
found, ghosts = search.next_with_ghosts()
1916
except StopIteration:
1919
if _mod_revision.NULL_REVISION in keys:
1920
keys.remove(_mod_revision.NULL_REVISION)
1922
parent_map = graph.get_parent_map(keys)
1923
keys = tsort.topo_sort(parent_map)
1924
return [None] + list(keys)
1927
"""Compress the data within the repository.
1929
This operation only makes sense for some repository types. For other
1930
types it should be a no-op that just returns.
1932
This stub method does not require a lock, but subclasses should use
1933
@needs_write_lock as this is a long running call its reasonable to
1934
implicitly lock for the user.
1938
@deprecated_method(one_six)
1939
def print_file(self, file, revision_id):
1940
"""Print `file` to stdout.
1942
FIXME RBC 20060125 as John Meinel points out this is a bad api
1943
- it writes to stdout, it assumes that that is valid etc. Fix
1944
by creating a new more flexible convenience function.
1946
tree = self.revision_tree(revision_id)
1947
# use inventory as it was in that revision
1948
file_id = tree.inventory.path2id(file)
1950
# TODO: jam 20060427 Write a test for this code path
1951
# it had a bug in it, and was raising the wrong
1953
raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
1954
tree.print_file(file_id)
1956
def get_transaction(self):
1957
return self.control_files.get_transaction()
1959
@deprecated_method(one_one)
1960
def get_parents(self, revision_ids):
1961
"""See StackedParentsProvider.get_parents"""
1962
parent_map = self.get_parent_map(revision_ids)
1963
return [parent_map.get(r, None) for r in revision_ids]
1965
def get_parent_map(self, revision_ids):
1966
"""See graph._StackedParentsProvider.get_parent_map"""
1967
# revisions index works in keys; this just works in revisions
1968
# therefore wrap and unwrap
1971
for revision_id in revision_ids:
1972
if revision_id == _mod_revision.NULL_REVISION:
1973
result[revision_id] = ()
1974
elif revision_id is None:
1975
raise ValueError('get_parent_map(None) is not valid')
1977
query_keys.append((revision_id ,))
1978
for ((revision_id,), parent_keys) in \
1979
self.revisions.get_parent_map(query_keys).iteritems():
1981
result[revision_id] = tuple(parent_revid
1982
for (parent_revid,) in parent_keys)
1984
result[revision_id] = (_mod_revision.NULL_REVISION,)
1987
def _make_parents_provider(self):
1990
def get_graph(self, other_repository=None):
1991
"""Return the graph walker for this repository format"""
1992
parents_provider = self._make_parents_provider()
1993
if (other_repository is not None and
1994
not self.has_same_location(other_repository)):
1995
parents_provider = graph._StackedParentsProvider(
1996
[parents_provider, other_repository._make_parents_provider()])
1997
return graph.Graph(parents_provider)
1999
def _get_versioned_file_checker(self):
2000
"""Return an object suitable for checking versioned files."""
2001
return _VersionedFileChecker(self)
2003
def revision_ids_to_search_result(self, result_set):
2004
"""Convert a set of revision ids to a graph SearchResult."""
2005
result_parents = set()
2006
for parents in self.get_graph().get_parent_map(
2007
result_set).itervalues():
2008
result_parents.update(parents)
2009
included_keys = result_set.intersection(result_parents)
2010
start_keys = result_set.difference(included_keys)
2011
exclude_keys = result_parents.difference(result_set)
2012
result = graph.SearchResult(start_keys, exclude_keys,
2013
len(result_set), result_set)
2017
def set_make_working_trees(self, new_value):
2018
"""Set the policy flag for making working trees when creating branches.
2020
This only applies to branches that use this repository.
2022
The default is 'True'.
2023
:param new_value: True to restore the default, False to disable making
2026
raise NotImplementedError(self.set_make_working_trees)
2028
def make_working_trees(self):
2029
"""Returns the policy for making working trees on new branches."""
2030
raise NotImplementedError(self.make_working_trees)
2033
def sign_revision(self, revision_id, gpg_strategy):
2034
plaintext = Testament.from_revision(self, revision_id).as_short_text()
2035
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
2038
def has_signature_for_revision_id(self, revision_id):
2039
"""Query for a revision signature for revision_id in the repository."""
2040
if not self.has_revision(revision_id):
2041
raise errors.NoSuchRevision(self, revision_id)
2042
sig_present = (1 == len(
2043
self.signatures.get_parent_map([(revision_id,)])))
2047
def get_signature_text(self, revision_id):
2048
"""Return the text for a signature."""
2049
stream = self.signatures.get_record_stream([(revision_id,)],
2051
record = stream.next()
2052
if record.storage_kind == 'absent':
2053
raise errors.NoSuchRevision(self, revision_id)
2054
return record.get_bytes_as('fulltext')
2057
def check(self, revision_ids=None):
2058
"""Check consistency of all history of given revision_ids.
2060
Different repository implementations should override _check().
2062
:param revision_ids: A non-empty list of revision_ids whose ancestry
2063
will be checked. Typically the last revision_id of a branch.
2065
return self._check(revision_ids)
2067
def _check(self, revision_ids):
2068
result = check.Check(self)
2072
def _warn_if_deprecated(self):
2073
global _deprecation_warning_done
2074
if _deprecation_warning_done:
2076
_deprecation_warning_done = True
2077
warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
2078
% (self._format, self.bzrdir.transport.base))
2080
def supports_rich_root(self):
2081
return self._format.rich_root_data
2083
def _check_ascii_revisionid(self, revision_id, method):
2084
"""Private helper for ascii-only repositories."""
2085
# weave repositories refuse to store revisionids that are non-ascii.
2086
if revision_id is not None:
2087
# weaves require ascii revision ids.
2088
if isinstance(revision_id, unicode):
2090
revision_id.encode('ascii')
2091
except UnicodeEncodeError:
2092
raise errors.NonAsciiRevisionId(method, self)
2095
revision_id.decode('ascii')
2096
except UnicodeDecodeError:
2097
raise errors.NonAsciiRevisionId(method, self)
2099
def revision_graph_can_have_wrong_parents(self):
2100
"""Is it possible for this repository to have a revision graph with
2103
If True, then this repository must also implement
2104
_find_inconsistent_revision_parents so that check and reconcile can
2105
check for inconsistencies before proceeding with other checks that may
2106
depend on the revision index being consistent.
2108
raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
2111
# remove these delegates a while after bzr 0.15
2112
def __make_delegated(name, from_module):
2113
def _deprecated_repository_forwarder():
2114
symbol_versioning.warn('%s moved to %s in bzr 0.15'
2115
% (name, from_module),
2118
m = __import__(from_module, globals(), locals(), [name])
2120
return getattr(m, name)
2121
except AttributeError:
2122
raise AttributeError('module %s has no name %s'
2124
globals()[name] = _deprecated_repository_forwarder
2127
'AllInOneRepository',
2128
'WeaveMetaDirRepository',
2129
'PreSplitOutRepositoryFormat',
2130
'RepositoryFormat4',
2131
'RepositoryFormat5',
2132
'RepositoryFormat6',
2133
'RepositoryFormat7',
2135
__make_delegated(_name, 'bzrlib.repofmt.weaverepo')
2139
'RepositoryFormatKnit',
2140
'RepositoryFormatKnit1',
2142
__make_delegated(_name, 'bzrlib.repofmt.knitrepo')
2145
def install_revision(repository, rev, revision_tree):
2146
"""Install all revision data into a repository."""
2147
install_revisions(repository, [(rev, revision_tree, None)])
2150
def install_revisions(repository, iterable, num_revisions=None, pb=None):
2151
"""Install all revision data into a repository.
2153
Accepts an iterable of revision, tree, signature tuples. The signature
2156
repository.start_write_group()
2158
for n, (revision, revision_tree, signature) in enumerate(iterable):
2159
_install_revision(repository, revision, revision_tree, signature)
2161
pb.update('Transferring revisions', n + 1, num_revisions)
2163
repository.abort_write_group()
2166
repository.commit_write_group()
2169
def _install_revision(repository, rev, revision_tree, signature):
2170
"""Install all revision data into a repository."""
2171
present_parents = []
2173
for p_id in rev.parent_ids:
2174
if repository.has_revision(p_id):
2175
present_parents.append(p_id)
2176
parent_trees[p_id] = repository.revision_tree(p_id)
2178
parent_trees[p_id] = repository.revision_tree(
2179
_mod_revision.NULL_REVISION)
2181
inv = revision_tree.inventory
2182
entries = inv.iter_entries()
2183
# backwards compatibility hack: skip the root id.
2184
if not repository.supports_rich_root():
2185
path, root = entries.next()
2186
if root.revision != rev.revision_id:
2187
raise errors.IncompatibleRevision(repr(repository))
2189
for path, ie in entries:
2190
text_keys[(ie.file_id, ie.revision)] = ie
2191
text_parent_map = repository.texts.get_parent_map(text_keys)
2192
missing_texts = set(text_keys) - set(text_parent_map)
2193
# Add the texts that are not already present
2194
for text_key in missing_texts:
2195
ie = text_keys[text_key]
2197
# FIXME: TODO: The following loop overlaps/duplicates that done by
2198
# commit to determine parents. There is a latent/real bug here where
2199
# the parents inserted are not those commit would do - in particular
2200
# they are not filtered by heads(). RBC, AB
2201
for revision, tree in parent_trees.iteritems():
2202
if ie.file_id not in tree:
2204
parent_id = tree.inventory[ie.file_id].revision
2205
if parent_id in text_parents:
2207
text_parents.append((ie.file_id, parent_id))
2208
lines = revision_tree.get_file(ie.file_id).readlines()
2209
repository.texts.add_lines(text_key, text_parents, lines)
2211
# install the inventory
2212
repository.add_inventory(rev.revision_id, inv, present_parents)
2213
except errors.RevisionAlreadyPresent:
2215
if signature is not None:
2216
repository.add_signature_text(rev.revision_id, signature)
2217
repository.add_revision(rev.revision_id, rev, inv)
2220
class MetaDirRepository(Repository):
2221
"""Repositories in the new meta-dir layout.
2223
:ivar _transport: Transport for access to repository control files,
2224
typically pointing to .bzr/repository.
2227
def __init__(self, _format, a_bzrdir, control_files):
2228
super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
2229
self._transport = control_files._transport
2231
def is_shared(self):
2232
"""Return True if this repository is flagged as a shared repository."""
2233
return self._transport.has('shared-storage')
2236
def set_make_working_trees(self, new_value):
2237
"""Set the policy flag for making working trees when creating branches.
2239
This only applies to branches that use this repository.
2241
The default is 'True'.
2242
:param new_value: True to restore the default, False to disable making
2247
self._transport.delete('no-working-trees')
2248
except errors.NoSuchFile:
2251
self._transport.put_bytes('no-working-trees', '',
2252
mode=self.bzrdir._get_file_mode())
2254
def make_working_trees(self):
2255
"""Returns the policy for making working trees on new branches."""
2256
return not self._transport.has('no-working-trees')
2259
class MetaDirVersionedFileRepository(MetaDirRepository):
2260
"""Repositories in a meta-dir, that work via versioned file objects."""
2262
def __init__(self, _format, a_bzrdir, control_files):
2263
super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
2267
network_format_registry = registry.FormatRegistry()
2268
"""Registry of formats indexed by their network name.
2270
The network name for a repository format is an identifier that can be used when
2271
referring to formats with smart server operations. See
2272
RepositoryFormat.network_name() for more detail.
2276
format_registry = registry.FormatRegistry(network_format_registry)
2277
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
2279
This can contain either format instances themselves, or classes/factories that
2280
can be called to obtain one.
2284
#####################################################################
2285
# Repository Formats
2287
class RepositoryFormat(object):
2288
"""A repository format.
2290
Formats provide four things:
2291
* An initialization routine to construct repository data on disk.
2292
* a optional format string which is used when the BzrDir supports
2294
* an open routine which returns a Repository instance.
2295
* A network name for referring to the format in smart server RPC
2298
There is one and only one Format subclass for each on-disk format. But
2299
there can be one Repository subclass that is used for several different
2300
formats. The _format attribute on a Repository instance can be used to
2301
determine the disk format.
2303
Formats are placed in a registry by their format string for reference
2304
during opening. These should be subclasses of RepositoryFormat for
2307
Once a format is deprecated, just deprecate the initialize and open
2308
methods on the format class. Do not deprecate the object, as the
2309
object may be created even when a repository instnace hasn't been
2312
Common instance attributes:
2313
_matchingbzrdir - the bzrdir format that the repository format was
2314
originally written to work with. This can be used if manually
2315
constructing a bzrdir and repository, or more commonly for test suite
2319
# Set to True or False in derived classes. True indicates that the format
2320
# supports ghosts gracefully.
2321
supports_ghosts = None
2322
# Can this repository be given external locations to lookup additional
2323
# data. Set to True or False in derived classes.
2324
supports_external_lookups = None
2325
# What order should fetch operations request streams in?
2326
# The default is unordered as that is the cheapest for an origin to
2328
_fetch_order = 'unordered'
2329
# Does this repository format use deltas that can be fetched as-deltas ?
2330
# (E.g. knits, where the knit deltas can be transplanted intact.
2331
# We default to False, which will ensure that enough data to get
2332
# a full text out of any fetch stream will be grabbed.
2333
_fetch_uses_deltas = False
2334
# Should fetch trigger a reconcile after the fetch? Only needed for
2335
# some repository formats that can suffer internal inconsistencies.
2336
_fetch_reconcile = False
2339
return "<%s>" % self.__class__.__name__
2341
def __eq__(self, other):
2342
# format objects are generally stateless
2343
return isinstance(other, self.__class__)
2345
def __ne__(self, other):
2346
return not self == other
2349
def find_format(klass, a_bzrdir):
2350
"""Return the format for the repository object in a_bzrdir.
2352
This is used by bzr native formats that have a "format" file in
2353
the repository. Other methods may be used by different types of
2357
transport = a_bzrdir.get_repository_transport(None)
2358
format_string = transport.get("format").read()
2359
return format_registry.get(format_string)
2360
except errors.NoSuchFile:
2361
raise errors.NoRepositoryPresent(a_bzrdir)
2363
raise errors.UnknownFormatError(format=format_string,
2367
def register_format(klass, format):
2368
format_registry.register(format.get_format_string(), format)
2371
def unregister_format(klass, format):
2372
format_registry.remove(format.get_format_string())
2375
def get_default_format(klass):
2376
"""Return the current default format."""
2377
from bzrlib import bzrdir
2378
return bzrdir.format_registry.make_bzrdir('default').repository_format
2380
def get_format_string(self):
2381
"""Return the ASCII format string that identifies this format.
2383
Note that in pre format ?? repositories the format string is
2384
not permitted nor written to disk.
2386
raise NotImplementedError(self.get_format_string)
2388
def get_format_description(self):
2389
"""Return the short description for this format."""
2390
raise NotImplementedError(self.get_format_description)
2392
# TODO: this shouldn't be in the base class, it's specific to things that
2393
# use weaves or knits -- mbp 20070207
2394
def _get_versioned_file_store(self,
2399
versionedfile_class=None,
2400
versionedfile_kwargs={},
2402
if versionedfile_class is None:
2403
versionedfile_class = self._versionedfile_class
2404
weave_transport = control_files._transport.clone(name)
2405
dir_mode = control_files._dir_mode
2406
file_mode = control_files._file_mode
2407
return VersionedFileStore(weave_transport, prefixed=prefixed,
2409
file_mode=file_mode,
2410
versionedfile_class=versionedfile_class,
2411
versionedfile_kwargs=versionedfile_kwargs,
2414
def initialize(self, a_bzrdir, shared=False):
2415
"""Initialize a repository of this format in a_bzrdir.
2417
:param a_bzrdir: The bzrdir to put the new repository in it.
2418
:param shared: The repository should be initialized as a sharable one.
2419
:returns: The new repository object.
2421
This may raise UninitializableFormat if shared repository are not
2422
compatible the a_bzrdir.
2424
raise NotImplementedError(self.initialize)
2426
def is_supported(self):
2427
"""Is this format supported?
2429
Supported formats must be initializable and openable.
2430
Unsupported formats may not support initialization or committing or
2431
some other features depending on the reason for not being supported.
2435
def network_name(self):
2436
"""A simple byte string uniquely identifying this format for RPC calls.
2438
MetaDir repository formats use their disk format string to identify the
2439
repository over the wire. All in one formats such as bzr < 0.8, and
2440
foreign formats like svn/git and hg should use some marker which is
2441
unique and immutable.
2443
raise NotImplementedError(self.network_name)
2445
def check_conversion_target(self, target_format):
2446
raise NotImplementedError(self.check_conversion_target)
2448
def open(self, a_bzrdir, _found=False):
2449
"""Return an instance of this format for the bzrdir a_bzrdir.
2451
_found is a private parameter, do not use it.
2453
raise NotImplementedError(self.open)
2456
class MetaDirRepositoryFormat(RepositoryFormat):
2457
"""Common base class for the new repositories using the metadir layout."""
2459
rich_root_data = False
2460
supports_tree_reference = False
2461
supports_external_lookups = False
2464
def _matchingbzrdir(self):
2465
matching = bzrdir.BzrDirMetaFormat1()
2466
matching.repository_format = self
2470
super(MetaDirRepositoryFormat, self).__init__()
2472
def _create_control_files(self, a_bzrdir):
2473
"""Create the required files and the initial control_files object."""
2474
# FIXME: RBC 20060125 don't peek under the covers
2475
# NB: no need to escape relative paths that are url safe.
2476
repository_transport = a_bzrdir.get_repository_transport(self)
2477
control_files = lockable_files.LockableFiles(repository_transport,
2478
'lock', lockdir.LockDir)
2479
control_files.create_lock()
2480
return control_files
2482
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
2483
"""Upload the initial blank content."""
2484
control_files = self._create_control_files(a_bzrdir)
2485
control_files.lock_write()
2486
transport = control_files._transport
2488
utf8_files += [('shared-storage', '')]
2490
transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
2491
for (filename, content_stream) in files:
2492
transport.put_file(filename, content_stream,
2493
mode=a_bzrdir._get_file_mode())
2494
for (filename, content_bytes) in utf8_files:
2495
transport.put_bytes_non_atomic(filename, content_bytes,
2496
mode=a_bzrdir._get_file_mode())
2498
control_files.unlock()
2500
def network_name(self):
2501
"""Metadir formats have matching disk and network format strings."""
2502
return self.get_format_string()
2505
# Pre-0.8 formats that don't have a disk format string (because they are
2506
# versioned by the matching control directory). We use the control directories
2507
# disk format string as a key for the network_name because they meet the
2508
# constraints (simple string, unique, immmutable).
2509
network_format_registry.register_lazy(
2510
"Bazaar-NG branch, format 5\n",
2511
'bzrlib.repofmt.weaverepo',
2512
'RepositoryFormat5',
2514
network_format_registry.register_lazy(
2515
"Bazaar-NG branch, format 6\n",
2516
'bzrlib.repofmt.weaverepo',
2517
'RepositoryFormat6',
2520
# formats which have no format string are not discoverable or independently
2521
# creatable on disk, so are not registered in format_registry. They're
2522
# all in bzrlib.repofmt.weaverepo now. When an instance of one of these is
2523
# needed, it's constructed directly by the BzrDir. Non-native formats where
2524
# the repository is not separately opened are similar.
2526
format_registry.register_lazy(
2527
'Bazaar-NG Repository format 7',
2528
'bzrlib.repofmt.weaverepo',
2532
format_registry.register_lazy(
2533
'Bazaar-NG Knit Repository Format 1',
2534
'bzrlib.repofmt.knitrepo',
2535
'RepositoryFormatKnit1',
2538
format_registry.register_lazy(
2539
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
2540
'bzrlib.repofmt.knitrepo',
2541
'RepositoryFormatKnit3',
2544
format_registry.register_lazy(
2545
'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
2546
'bzrlib.repofmt.knitrepo',
2547
'RepositoryFormatKnit4',
2550
# Pack-based formats. There is one format for pre-subtrees, and one for
2551
# post-subtrees to allow ease of testing.
2552
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
2553
format_registry.register_lazy(
2554
'Bazaar pack repository format 1 (needs bzr 0.92)\n',
2555
'bzrlib.repofmt.pack_repo',
2556
'RepositoryFormatKnitPack1',
2558
format_registry.register_lazy(
2559
'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
2560
'bzrlib.repofmt.pack_repo',
2561
'RepositoryFormatKnitPack3',
2563
format_registry.register_lazy(
2564
'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
2565
'bzrlib.repofmt.pack_repo',
2566
'RepositoryFormatKnitPack4',
2568
format_registry.register_lazy(
2569
'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
2570
'bzrlib.repofmt.pack_repo',
2571
'RepositoryFormatKnitPack5',
2573
format_registry.register_lazy(
2574
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
2575
'bzrlib.repofmt.pack_repo',
2576
'RepositoryFormatKnitPack5RichRoot',
2578
format_registry.register_lazy(
2579
'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
2580
'bzrlib.repofmt.pack_repo',
2581
'RepositoryFormatKnitPack5RichRootBroken',
2583
format_registry.register_lazy(
2584
'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
2585
'bzrlib.repofmt.pack_repo',
2586
'RepositoryFormatKnitPack6',
2588
format_registry.register_lazy(
2589
'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
2590
'bzrlib.repofmt.pack_repo',
2591
'RepositoryFormatKnitPack6RichRoot',
2594
# Development formats.
2595
# 1.7->1.8 go below here
2596
format_registry.register_lazy(
2597
"Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
2598
'bzrlib.repofmt.pack_repo',
2599
'RepositoryFormatPackDevelopment2',
2601
format_registry.register_lazy(
2602
("Bazaar development format 2 with subtree support "
2603
"(needs bzr.dev from before 1.8)\n"),
2604
'bzrlib.repofmt.pack_repo',
2605
'RepositoryFormatPackDevelopment2Subtree',
2609
class InterRepository(InterObject):
2610
"""This class represents operations taking place between two repositories.
2612
Its instances have methods like copy_content and fetch, and contain
2613
references to the source and target repositories these operations can be
2616
Often we will provide convenience methods on 'repository' which carry out
2617
operations with another repository - they will always forward to
2618
InterRepository.get(other).method_name(parameters).
2621
_walk_to_common_revisions_batch_size = 50
2623
"""The available optimised InterRepository types."""
2625
def __init__(self, source, target):
2626
InterObject.__init__(self, source, target)
2627
# These two attributes may be overridden by e.g. InterOtherToRemote to
2628
# provide a faster implementation.
2629
self.target_get_graph = self.target.get_graph
2630
self.target_get_parent_map = self.target.get_parent_map
2633
def copy_content(self, revision_id=None):
2634
"""Make a complete copy of the content in self into destination.
2636
This is a destructive operation! Do not use it on existing
2639
:param revision_id: Only copy the content needed to construct
2640
revision_id and its parents.
2643
self.target.set_make_working_trees(self.source.make_working_trees())
2644
except NotImplementedError:
2646
self.target.fetch(self.source, revision_id=revision_id)
2649
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
2651
"""Fetch the content required to construct revision_id.
2653
The content is copied from self.source to self.target.
2655
:param revision_id: if None all content is copied, if NULL_REVISION no
2657
:param pb: optional progress bar to use for progress reports. If not
2658
provided a default one will be created.
2661
from bzrlib.fetch import RepoFetcher
2662
f = RepoFetcher(to_repository=self.target,
2663
from_repository=self.source,
2664
last_revision=revision_id,
2665
fetch_spec=fetch_spec,
2666
pb=pb, find_ghosts=find_ghosts)
2668
def _walk_to_common_revisions(self, revision_ids):
2669
"""Walk out from revision_ids in source to revisions target has.
2671
:param revision_ids: The start point for the search.
2672
:return: A set of revision ids.
2674
target_graph = self.target_get_graph()
2675
revision_ids = frozenset(revision_ids)
2676
# Fast path for the case where all the revisions are already in the
2678
# (Although this does incur an extra round trip for the
2679
# fairly common case where the target doesn't already have the revision
2681
if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
2682
return graph.SearchResult(revision_ids, set(), 0, set())
2683
missing_revs = set()
2684
source_graph = self.source.get_graph()
2685
# ensure we don't pay silly lookup costs.
2686
searcher = source_graph._make_breadth_first_searcher(revision_ids)
2687
null_set = frozenset([_mod_revision.NULL_REVISION])
2688
searcher_exhausted = False
2692
# Iterate the searcher until we have enough next_revs
2693
while len(next_revs) < self._walk_to_common_revisions_batch_size:
2695
next_revs_part, ghosts_part = searcher.next_with_ghosts()
2696
next_revs.update(next_revs_part)
2697
ghosts.update(ghosts_part)
2698
except StopIteration:
2699
searcher_exhausted = True
2701
# If there are ghosts in the source graph, and the caller asked for
2702
# them, make sure that they are present in the target.
2703
# We don't care about other ghosts as we can't fetch them and
2704
# haven't been asked to.
2705
ghosts_to_check = set(revision_ids.intersection(ghosts))
2706
revs_to_get = set(next_revs).union(ghosts_to_check)
2708
have_revs = set(target_graph.get_parent_map(revs_to_get))
2709
# we always have NULL_REVISION present.
2710
have_revs = have_revs.union(null_set)
2711
# Check if the target is missing any ghosts we need.
2712
ghosts_to_check.difference_update(have_revs)
2714
# One of the caller's revision_ids is a ghost in both the
2715
# source and the target.
2716
raise errors.NoSuchRevision(
2717
self.source, ghosts_to_check.pop())
2718
missing_revs.update(next_revs - have_revs)
2719
# Because we may have walked past the original stop point, make
2720
# sure everything is stopped
2721
stop_revs = searcher.find_seen_ancestors(have_revs)
2722
searcher.stop_searching_any(stop_revs)
2723
if searcher_exhausted:
2725
return searcher.get_result()
2727
@deprecated_method(one_two)
2729
def missing_revision_ids(self, revision_id=None, find_ghosts=True):
2730
"""Return the revision ids that source has that target does not.
2732
These are returned in topological order.
2734
:param revision_id: only return revision ids included by this
2736
:param find_ghosts: If True find missing revisions in deep history
2737
rather than just finding the surface difference.
2739
return list(self.search_missing_revision_ids(
2740
revision_id, find_ghosts).get_keys())
2743
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2744
"""Return the revision ids that source has that target does not.
2746
:param revision_id: only return revision ids included by this
2748
:param find_ghosts: If True find missing revisions in deep history
2749
rather than just finding the surface difference.
2750
:return: A bzrlib.graph.SearchResult.
2752
# stop searching at found target revisions.
2753
if not find_ghosts and revision_id is not None:
2754
return self._walk_to_common_revisions([revision_id])
2755
# generic, possibly worst case, slow code path.
2756
target_ids = set(self.target.all_revision_ids())
2757
if revision_id is not None:
2758
source_ids = self.source.get_ancestry(revision_id)
2759
if source_ids[0] is not None:
2760
raise AssertionError()
2763
source_ids = self.source.all_revision_ids()
2764
result_set = set(source_ids).difference(target_ids)
2765
return self.source.revision_ids_to_search_result(result_set)
2768
def _same_model(source, target):
2769
"""True if source and target have the same data representation.
2771
Note: this is always called on the base class; overriding it in a
2772
subclass will have no effect.
2775
InterRepository._assert_same_model(source, target)
2777
except errors.IncompatibleRepositories, e:
2781
def _assert_same_model(source, target):
2782
"""Raise an exception if two repositories do not use the same model.
2784
if source.supports_rich_root() != target.supports_rich_root():
2785
raise errors.IncompatibleRepositories(source, target,
2786
"different rich-root support")
2787
if source._serializer != target._serializer:
2788
raise errors.IncompatibleRepositories(source, target,
2789
"different serializers")
2792
class InterSameDataRepository(InterRepository):
2793
"""Code for converting between repositories that represent the same data.
2795
Data format and model must match for this to work.
2799
def _get_repo_format_to_test(self):
2800
"""Repository format for testing with.
2802
InterSameData can pull from subtree to subtree and from non-subtree to
2803
non-subtree, so we test this with the richest repository format.
2805
from bzrlib.repofmt import knitrepo
2806
return knitrepo.RepositoryFormatKnit3()
2809
def is_compatible(source, target):
2810
return InterRepository._same_model(source, target)
2813
class InterWeaveRepo(InterSameDataRepository):
2814
"""Optimised code paths between Weave based repositories.
2816
This should be in bzrlib/repofmt/weaverepo.py but we have not yet
2817
implemented lazy inter-object optimisation.
2821
def _get_repo_format_to_test(self):
2822
from bzrlib.repofmt import weaverepo
2823
return weaverepo.RepositoryFormat7()
2826
def is_compatible(source, target):
2827
"""Be compatible with known Weave formats.
2829
We don't test for the stores being of specific types because that
2830
could lead to confusing results, and there is no need to be
2833
from bzrlib.repofmt.weaverepo import (
2839
return (isinstance(source._format, (RepositoryFormat5,
2841
RepositoryFormat7)) and
2842
isinstance(target._format, (RepositoryFormat5,
2844
RepositoryFormat7)))
2845
except AttributeError:
2849
def copy_content(self, revision_id=None):
2850
"""See InterRepository.copy_content()."""
2851
# weave specific optimised path:
2853
self.target.set_make_working_trees(self.source.make_working_trees())
2854
except (errors.RepositoryUpgradeRequired, NotImplemented):
2856
# FIXME do not peek!
2857
if self.source._transport.listable():
2858
pb = ui.ui_factory.nested_progress_bar()
2860
self.target.texts.insert_record_stream(
2861
self.source.texts.get_record_stream(
2862
self.source.texts.keys(), 'topological', False))
2863
pb.update('copying inventory', 0, 1)
2864
self.target.inventories.insert_record_stream(
2865
self.source.inventories.get_record_stream(
2866
self.source.inventories.keys(), 'topological', False))
2867
self.target.signatures.insert_record_stream(
2868
self.source.signatures.get_record_stream(
2869
self.source.signatures.keys(),
2871
self.target.revisions.insert_record_stream(
2872
self.source.revisions.get_record_stream(
2873
self.source.revisions.keys(),
2874
'topological', True))
2878
self.target.fetch(self.source, revision_id=revision_id)
2881
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2882
"""See InterRepository.missing_revision_ids()."""
2883
# we want all revisions to satisfy revision_id in source.
2884
# but we don't want to stat every file here and there.
2885
# we want then, all revisions other needs to satisfy revision_id
2886
# checked, but not those that we have locally.
2887
# so the first thing is to get a subset of the revisions to
2888
# satisfy revision_id in source, and then eliminate those that
2889
# we do already have.
2890
# this is slow on high latency connection to self, but as as this
2891
# disk format scales terribly for push anyway due to rewriting
2892
# inventory.weave, this is considered acceptable.
2894
if revision_id is not None:
2895
source_ids = self.source.get_ancestry(revision_id)
2896
if source_ids[0] is not None:
2897
raise AssertionError()
2900
source_ids = self.source._all_possible_ids()
2901
source_ids_set = set(source_ids)
2902
# source_ids is the worst possible case we may need to pull.
2903
# now we want to filter source_ids against what we actually
2904
# have in target, but don't try to check for existence where we know
2905
# we do not have a revision as that would be pointless.
2906
target_ids = set(self.target._all_possible_ids())
2907
possibly_present_revisions = target_ids.intersection(source_ids_set)
2908
actually_present_revisions = set(
2909
self.target._eliminate_revisions_not_present(possibly_present_revisions))
2910
required_revisions = source_ids_set.difference(actually_present_revisions)
2911
if revision_id is not None:
2912
# we used get_ancestry to determine source_ids then we are assured all
2913
# revisions referenced are present as they are installed in topological order.
2914
# and the tip revision was validated by get_ancestry.
2915
result_set = required_revisions
2917
# if we just grabbed the possibly available ids, then
2918
# we only have an estimate of whats available and need to validate
2919
# that against the revision records.
2921
self.source._eliminate_revisions_not_present(required_revisions))
2922
return self.source.revision_ids_to_search_result(result_set)
2925
class InterKnitRepo(InterSameDataRepository):
2926
"""Optimised code paths between Knit based repositories."""
2929
def _get_repo_format_to_test(self):
2930
from bzrlib.repofmt import knitrepo
2931
return knitrepo.RepositoryFormatKnit1()
2934
def is_compatible(source, target):
2935
"""Be compatible with known Knit formats.
2937
We don't test for the stores being of specific types because that
2938
could lead to confusing results, and there is no need to be
2941
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
2943
are_knits = (isinstance(source._format, RepositoryFormatKnit) and
2944
isinstance(target._format, RepositoryFormatKnit))
2945
except AttributeError:
2947
return are_knits and InterRepository._same_model(source, target)
2950
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2951
"""See InterRepository.missing_revision_ids()."""
2952
if revision_id is not None:
2953
source_ids = self.source.get_ancestry(revision_id)
2954
if source_ids[0] is not None:
2955
raise AssertionError()
2958
source_ids = self.source.all_revision_ids()
2959
source_ids_set = set(source_ids)
2960
# source_ids is the worst possible case we may need to pull.
2961
# now we want to filter source_ids against what we actually
2962
# have in target, but don't try to check for existence where we know
2963
# we do not have a revision as that would be pointless.
2964
target_ids = set(self.target.all_revision_ids())
2965
possibly_present_revisions = target_ids.intersection(source_ids_set)
2966
actually_present_revisions = set(
2967
self.target._eliminate_revisions_not_present(possibly_present_revisions))
2968
required_revisions = source_ids_set.difference(actually_present_revisions)
2969
if revision_id is not None:
2970
# we used get_ancestry to determine source_ids then we are assured all
2971
# revisions referenced are present as they are installed in topological order.
2972
# and the tip revision was validated by get_ancestry.
2973
result_set = required_revisions
2975
# if we just grabbed the possibly available ids, then
2976
# we only have an estimate of whats available and need to validate
2977
# that against the revision records.
2979
self.source._eliminate_revisions_not_present(required_revisions))
2980
return self.source.revision_ids_to_search_result(result_set)
2983
class InterPackRepo(InterSameDataRepository):
2984
"""Optimised code paths between Pack based repositories."""
2987
def _get_repo_format_to_test(self):
2988
from bzrlib.repofmt import pack_repo
2989
return pack_repo.RepositoryFormatKnitPack1()
2992
def is_compatible(source, target):
2993
"""Be compatible with known Pack formats.
2995
We don't test for the stores being of specific types because that
2996
could lead to confusing results, and there is no need to be
2999
from bzrlib.repofmt.pack_repo import RepositoryFormatPack
3001
are_packs = (isinstance(source._format, RepositoryFormatPack) and
3002
isinstance(target._format, RepositoryFormatPack))
3003
except AttributeError:
3005
return are_packs and InterRepository._same_model(source, target)
3008
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3010
"""See InterRepository.fetch()."""
3011
if (len(self.source._fallback_repositories) > 0 or
3012
len(self.target._fallback_repositories) > 0):
3013
# The pack layer is not aware of fallback repositories, so when
3014
# fetching from a stacked repository or into a stacked repository
3015
# we use the generic fetch logic which uses the VersionedFiles
3016
# attributes on repository.
3017
from bzrlib.fetch import RepoFetcher
3018
fetcher = RepoFetcher(self.target, self.source, revision_id,
3019
pb, find_ghosts, fetch_spec=fetch_spec)
3020
if fetch_spec is not None:
3021
if len(list(fetch_spec.heads)) != 1:
3022
raise AssertionError(
3023
"InterPackRepo.fetch doesn't support "
3024
"fetching multiple heads yet.")
3025
revision_id = fetch_spec.heads[0]
3027
if revision_id is None:
3029
# everything to do - use pack logic
3030
# to fetch from all packs to one without
3031
# inventory parsing etc, IFF nothing to be copied is in the target.
3033
source_revision_ids = frozenset(self.source.all_revision_ids())
3034
revision_ids = source_revision_ids - \
3035
frozenset(self.target_get_parent_map(source_revision_ids))
3036
revision_keys = [(revid,) for revid in revision_ids]
3037
target_pack_collection = self._get_target_pack_collection()
3038
index = target_pack_collection.revision_index.combined_index
3039
present_revision_ids = set(item[1][0] for item in
3040
index.iter_entries(revision_keys))
3041
revision_ids = set(revision_ids) - present_revision_ids
3042
# implementing the TODO will involve:
3043
# - detecting when all of a pack is selected
3044
# - avoiding as much as possible pre-selection, so the
3045
# more-core routines such as create_pack_from_packs can filter in
3046
# a just-in-time fashion. (though having a HEADS list on a
3047
# repository might make this a lot easier, because we could
3048
# sensibly detect 'new revisions' without doing a full index scan.
3049
elif _mod_revision.is_null(revision_id):
3054
revision_ids = self.search_missing_revision_ids(revision_id,
3055
find_ghosts=find_ghosts).get_keys()
3056
except errors.NoSuchRevision:
3057
raise errors.InstallFailed([revision_id])
3058
if len(revision_ids) == 0:
3060
return self._pack(self.source, self.target, revision_ids)
3062
def _pack(self, source, target, revision_ids):
3063
from bzrlib.repofmt.pack_repo import Packer
3064
target_pack_collection = self._get_target_pack_collection()
3065
packs = source._pack_collection.all_packs()
3066
pack = Packer(target_pack_collection, packs, '.fetch',
3067
revision_ids).pack()
3068
if pack is not None:
3069
target_pack_collection._save_pack_names()
3070
copied_revs = pack.get_revision_count()
3071
# Trigger an autopack. This may duplicate effort as we've just done
3072
# a pack creation, but for now it is simpler to think about as
3073
# 'upload data, then repack if needed'.
3075
return (copied_revs, [])
3079
def _autopack(self):
3080
self.target._pack_collection.autopack()
3082
def _get_target_pack_collection(self):
3083
return self.target._pack_collection
3086
def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3087
"""See InterRepository.missing_revision_ids().
3089
:param find_ghosts: Find ghosts throughout the ancestry of
3092
if not find_ghosts and revision_id is not None:
3093
return self._walk_to_common_revisions([revision_id])
3094
elif revision_id is not None:
3095
# Find ghosts: search for revisions pointing from one repository to
3096
# the other, and vice versa, anywhere in the history of revision_id.
3097
graph = self.target_get_graph(other_repository=self.source)
3098
searcher = graph._make_breadth_first_searcher([revision_id])
3102
next_revs, ghosts = searcher.next_with_ghosts()
3103
except StopIteration:
3105
if revision_id in ghosts:
3106
raise errors.NoSuchRevision(self.source, revision_id)
3107
found_ids.update(next_revs)
3108
found_ids.update(ghosts)
3109
found_ids = frozenset(found_ids)
3110
# Double query here: should be able to avoid this by changing the
3111
# graph api further.
3112
result_set = found_ids - frozenset(
3113
self.target_get_parent_map(found_ids))
3115
source_ids = self.source.all_revision_ids()
3116
# source_ids is the worst possible case we may need to pull.
3117
# now we want to filter source_ids against what we actually
3118
# have in target, but don't try to check for existence where we know
3119
# we do not have a revision as that would be pointless.
3120
target_ids = set(self.target.all_revision_ids())
3121
result_set = set(source_ids).difference(target_ids)
3122
return self.source.revision_ids_to_search_result(result_set)
3125
class InterDifferingSerializer(InterKnitRepo):
3128
def _get_repo_format_to_test(self):
3132
def is_compatible(source, target):
3133
"""Be compatible with Knit2 source and Knit3 target"""
3134
if source.supports_rich_root() != target.supports_rich_root():
3136
# Ideally, we'd support fetching if the source had no tree references
3137
# even if it supported them...
3138
if (getattr(source, '_format.supports_tree_reference', False) and
3139
not getattr(target, '_format.supports_tree_reference', False)):
3143
def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3144
"""Get the best delta and base for this revision.
3146
:return: (basis_id, delta)
3148
possible_trees = [(parent_id, cache[parent_id])
3149
for parent_id in parent_ids
3150
if parent_id in cache]
3151
if len(possible_trees) == 0:
3152
# There either aren't any parents, or the parents aren't in the
3153
# cache, so just use the last converted tree
3154
possible_trees.append((basis_id, cache[basis_id]))
3156
for basis_id, basis_tree in possible_trees:
3157
delta = tree.inventory._make_delta(basis_tree.inventory)
3158
deltas.append((len(delta), basis_id, delta))
3160
return deltas[0][1:]
3162
def _fetch_batch(self, revision_ids, basis_id, cache):
3163
"""Fetch across a few revisions.
3165
:param revision_ids: The revisions to copy
3166
:param basis_id: The revision_id of a tree that must be in cache, used
3167
as a basis for delta when no other base is available
3168
:param cache: A cache of RevisionTrees that we can use.
3169
:return: The revision_id of the last converted tree. The RevisionTree
3170
for it will be in cache
3172
# Walk though all revisions; get inventory deltas, copy referenced
3173
# texts that delta references, insert the delta, revision and
3177
pending_revisions = []
3178
parent_map = self.source.get_parent_map(revision_ids)
3179
for tree in self.source.revision_trees(revision_ids):
3180
current_revision_id = tree.get_revision_id()
3181
parent_ids = parent_map.get(current_revision_id, ())
3182
basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3184
# Find text entries that need to be copied
3185
for old_path, new_path, file_id, entry in delta:
3186
if new_path is not None:
3187
if not (new_path or self.target.supports_rich_root()):
3188
# We don't copy the text for the root node unless the
3189
# target supports_rich_root.
3191
text_keys.add((file_id, entry.revision))
3192
revision = self.source.get_revision(current_revision_id)
3193
pending_deltas.append((basis_id, delta,
3194
current_revision_id, revision.parent_ids))
3195
pending_revisions.append(revision)
3196
cache[current_revision_id] = tree
3197
basis_id = current_revision_id
3199
from_texts = self.source.texts
3200
to_texts = self.target.texts
3201
to_texts.insert_record_stream(from_texts.get_record_stream(
3202
text_keys, self.target._format._fetch_order,
3203
not self.target._format._fetch_uses_deltas))
3205
for delta in pending_deltas:
3206
self.target.add_inventory_by_delta(*delta)
3207
# insert signatures and revisions
3208
for revision in pending_revisions:
3210
signature = self.source.get_signature_text(
3211
revision.revision_id)
3212
self.target.add_signature_text(revision.revision_id,
3214
except errors.NoSuchRevision:
3216
self.target.add_revision(revision.revision_id, revision)
3219
def _fetch_all_revisions(self, revision_ids, pb):
3220
"""Fetch everything for the list of revisions.
3222
:param revision_ids: The list of revisions to fetch. Must be in
3224
:param pb: A ProgressBar
3227
basis_id, basis_tree = self._get_basis(revision_ids[0])
3229
cache = lru_cache.LRUCache(100)
3230
cache[basis_id] = basis_tree
3231
del basis_tree # We don't want to hang on to it here
3232
for offset in range(0, len(revision_ids), batch_size):
3233
self.target.start_write_group()
3235
pb.update('Transferring revisions', offset,
3237
batch = revision_ids[offset:offset+batch_size]
3238
basis_id = self._fetch_batch(batch, basis_id, cache)
3240
self.target.abort_write_group()
3243
self.target.commit_write_group()
3244
pb.update('Transferring revisions', len(revision_ids),
3248
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3250
"""See InterRepository.fetch()."""
3251
if fetch_spec is not None:
3252
raise AssertionError("Not implemented yet...")
3253
revision_ids = self.target.search_missing_revision_ids(self.source,
3254
revision_id, find_ghosts=find_ghosts).get_keys()
3255
if not revision_ids:
3257
revision_ids = tsort.topo_sort(
3258
self.source.get_graph().get_parent_map(revision_ids))
3260
my_pb = ui.ui_factory.nested_progress_bar()
3263
symbol_versioning.warn(
3264
symbol_versioning.deprecated_in((1, 14, 0))
3265
% "pb parameter to fetch()")
3268
self._fetch_all_revisions(revision_ids, pb)
3270
if my_pb is not None:
3272
return len(revision_ids), 0
3274
def _get_basis(self, first_revision_id):
3275
"""Get a revision and tree which exists in the target.
3277
This assumes that first_revision_id is selected for transmission
3278
because all other ancestors are already present. If we can't find an
3279
ancestor we fall back to NULL_REVISION since we know that is safe.
3281
:return: (basis_id, basis_tree)
3283
first_rev = self.source.get_revision(first_revision_id)
3285
basis_id = first_rev.parent_ids[0]
3286
# only valid as a basis if the target has it
3287
self.target.get_revision(basis_id)
3288
# Try to get a basis tree - if its a ghost it will hit the
3289
# NoSuchRevision case.
3290
basis_tree = self.source.revision_tree(basis_id)
3291
except (IndexError, errors.NoSuchRevision):
3292
basis_id = _mod_revision.NULL_REVISION
3293
basis_tree = self.source.revision_tree(basis_id)
3294
return basis_id, basis_tree
3297
class InterOtherToRemote(InterRepository):
3298
"""An InterRepository that simply delegates to the 'real' InterRepository
3299
calculated for (source, target._real_repository).
3302
def __init__(self, source, target):
3303
InterRepository.__init__(self, source, target)
3304
self._real_inter = None
3307
def is_compatible(source, target):
3308
if isinstance(target, remote.RemoteRepository):
3312
def _ensure_real_inter(self):
3313
if self._real_inter is None:
3314
self.target._ensure_real()
3315
real_target = self.target._real_repository
3316
self._real_inter = InterRepository.get(self.source, real_target)
3317
# Make _real_inter use the RemoteRepository for get_parent_map
3318
self._real_inter.target_get_graph = self.target.get_graph
3319
self._real_inter.target_get_parent_map = self.target.get_parent_map
3321
def copy_content(self, revision_id=None):
3322
self._ensure_real_inter()
3323
self._real_inter.copy_content(revision_id=revision_id)
3325
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3327
self._ensure_real_inter()
3328
return self._real_inter.fetch(revision_id=revision_id, pb=pb,
3329
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
3332
def _get_repo_format_to_test(self):
3336
class InterRemoteToOther(InterRepository):
3338
def __init__(self, source, target):
3339
InterRepository.__init__(self, source, target)
3340
self._real_inter = None
3343
def is_compatible(source, target):
3344
if not isinstance(source, remote.RemoteRepository):
3346
return InterRepository._same_model(source, target)
3348
def _ensure_real_inter(self):
3349
if self._real_inter is None:
3350
self.source._ensure_real()
3351
real_source = self.source._real_repository
3352
self._real_inter = InterRepository.get(real_source, self.target)
3354
def copy_content(self, revision_id=None):
3355
self._ensure_real_inter()
3356
self._real_inter.copy_content(revision_id=revision_id)
3359
def _get_repo_format_to_test(self):
3364
class InterPackToRemotePack(InterPackRepo):
3365
"""A specialisation of InterPackRepo for a target that is a
3368
This will use the get_parent_map RPC rather than plain readvs, and also
3369
uses an RPC for autopacking.
3373
def is_compatible(source, target):
3374
from bzrlib.repofmt.pack_repo import RepositoryFormatPack
3375
if isinstance(source._format, RepositoryFormatPack):
3376
if isinstance(target, remote.RemoteRepository):
3377
target._format._ensure_real()
3378
if isinstance(target._format._custom_format,
3379
RepositoryFormatPack):
3380
if InterRepository._same_model(source, target):
3384
def _autopack(self):
3385
self.target.autopack()
3388
def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3390
"""See InterRepository.fetch()."""
3391
if self.target._client._medium._is_remote_before((1, 13)):
3392
# The server won't support the insert_stream RPC, so just use
3393
# regular InterPackRepo logic. This avoids a bug that causes many
3394
# round-trips for small append calls.
3395
return InterPackRepo.fetch(self, revision_id=revision_id, pb=pb,
3396
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
3397
# Always fetch using the generic streaming fetch code, to allow
3398
# streaming fetching into remote servers.
3399
from bzrlib.fetch import RepoFetcher
3400
fetcher = RepoFetcher(self.target, self.source, revision_id,
3401
pb, find_ghosts, fetch_spec=fetch_spec)
3403
def _get_target_pack_collection(self):
3404
return self.target._real_repository._pack_collection
3407
def _get_repo_format_to_test(self):
3411
InterRepository.register_optimiser(InterDifferingSerializer)
3412
InterRepository.register_optimiser(InterSameDataRepository)
3413
InterRepository.register_optimiser(InterWeaveRepo)
3414
InterRepository.register_optimiser(InterKnitRepo)
3415
InterRepository.register_optimiser(InterPackRepo)
3416
InterRepository.register_optimiser(InterOtherToRemote)
3417
InterRepository.register_optimiser(InterRemoteToOther)
3418
InterRepository.register_optimiser(InterPackToRemotePack)
3421
class CopyConverter(object):
3422
"""A repository conversion tool which just performs a copy of the content.
3424
This is slow but quite reliable.
3427
def __init__(self, target_format):
3428
"""Create a CopyConverter.
3430
:param target_format: The format the resulting repository should be.
3432
self.target_format = target_format
3434
def convert(self, repo, pb):
3435
"""Perform the conversion of to_convert, giving feedback via pb.
3437
:param to_convert: The disk object to convert.
3438
:param pb: a progress bar to use for progress information.
3443
# this is only useful with metadir layouts - separated repo content.
3444
# trigger an assertion if not such
3445
repo._format.get_format_string()
3446
self.repo_dir = repo.bzrdir
3447
self.step('Moving repository to repository.backup')
3448
self.repo_dir.transport.move('repository', 'repository.backup')
3449
backup_transport = self.repo_dir.transport.clone('repository.backup')
3450
repo._format.check_conversion_target(self.target_format)
3451
self.source_repo = repo._format.open(self.repo_dir,
3453
_override_transport=backup_transport)
3454
self.step('Creating new repository')
3455
converted = self.target_format.initialize(self.repo_dir,
3456
self.source_repo.is_shared())
3457
converted.lock_write()
3459
self.step('Copying content into repository.')
3460
self.source_repo.copy_content_into(converted)
3463
self.step('Deleting old repository content.')
3464
self.repo_dir.transport.delete_tree('repository.backup')
3465
self.pb.note('repository converted')
3467
def step(self, message):
3468
"""Update the pb by a step."""
3470
self.pb.update(message, self.count, self.total)
3482
def _unescaper(match, _map=_unescape_map):
3483
code = match.group(1)
3487
if not code.startswith('#'):
3489
return unichr(int(code[1:])).encode('utf8')
3495
def _unescape_xml(data):
3496
"""Unescape predefined XML entities in a string of data."""
3498
if _unescape_re is None:
3499
_unescape_re = re.compile('\&([^;]*);')
3500
return _unescape_re.sub(_unescaper, data)
3503
class _VersionedFileChecker(object):
3505
def __init__(self, repository):
3506
self.repository = repository
3507
self.text_index = self.repository._generate_text_key_index()
3509
def calculate_file_version_parents(self, text_key):
3510
"""Calculate the correct parents for a file version according to
3513
parent_keys = self.text_index[text_key]
3514
if parent_keys == [_mod_revision.NULL_REVISION]:
3516
return tuple(parent_keys)
3518
def check_file_version_parents(self, texts, progress_bar=None):
3519
"""Check the parents stored in a versioned file are correct.
3521
It also detects file versions that are not referenced by their
3522
corresponding revision's inventory.
3524
:returns: A tuple of (wrong_parents, dangling_file_versions).
3525
wrong_parents is a dict mapping {revision_id: (stored_parents,
3526
correct_parents)} for each revision_id where the stored parents
3527
are not correct. dangling_file_versions is a set of (file_id,
3528
revision_id) tuples for versions that are present in this versioned
3529
file, but not used by the corresponding inventory.
3532
self.file_ids = set([file_id for file_id, _ in
3533
self.text_index.iterkeys()])
3534
# text keys is now grouped by file_id
3535
n_weaves = len(self.file_ids)
3536
files_in_revisions = {}
3537
revisions_of_files = {}
3538
n_versions = len(self.text_index)
3539
progress_bar.update('loading text store', 0, n_versions)
3540
parent_map = self.repository.texts.get_parent_map(self.text_index)
3541
# On unlistable transports this could well be empty/error...
3542
text_keys = self.repository.texts.keys()
3543
unused_keys = frozenset(text_keys) - set(self.text_index)
3544
for num, key in enumerate(self.text_index.iterkeys()):
3545
if progress_bar is not None:
3546
progress_bar.update('checking text graph', num, n_versions)
3547
correct_parents = self.calculate_file_version_parents(key)
3549
knit_parents = parent_map[key]
3550
except errors.RevisionNotPresent:
3553
if correct_parents != knit_parents:
3554
wrong_parents[key] = (knit_parents, correct_parents)
3555
return wrong_parents, unused_keys
3558
def _old_get_graph(repository, revision_id):
3559
"""DO NOT USE. That is all. I'm serious."""
3560
graph = repository.get_graph()
3561
revision_graph = dict(((key, value) for key, value in
3562
graph.iter_ancestry([revision_id]) if value is not None))
3563
return _strip_NULL_ghosts(revision_graph)
3566
def _strip_NULL_ghosts(revision_graph):
3567
"""Also don't use this. more compatibility code for unmigrated clients."""
3568
# Filter ghosts, and null:
3569
if _mod_revision.NULL_REVISION in revision_graph:
3570
del revision_graph[_mod_revision.NULL_REVISION]
3571
for key, parents in revision_graph.items():
3572
revision_graph[key] = tuple(parent for parent in parents if parent
3574
return revision_graph
3577
class StreamSink(object):
3578
"""An object that can insert a stream into a repository.
3580
This interface handles the complexity of reserialising inventories and
3581
revisions from different formats, and allows unidirectional insertion into
3582
stacked repositories without looking for the missing basis parents
3586
def __init__(self, target_repo):
3587
self.target_repo = target_repo
3589
def insert_stream(self, stream, src_format, resume_tokens):
3590
"""Insert a stream's content into the target repository.
3592
:param src_format: a bzr repository format.
3594
:return: a list of resume tokens and an iterable of keys additional
3595
items required before the insertion can be completed.
3597
self.target_repo.lock_write()
3600
self.target_repo.resume_write_group(resume_tokens)
3602
self.target_repo.start_write_group()
3604
# locked_insert_stream performs a commit|suspend.
3605
return self._locked_insert_stream(stream, src_format)
3607
self.target_repo.abort_write_group(suppress_errors=True)
3610
self.target_repo.unlock()
3612
def _locked_insert_stream(self, stream, src_format):
3613
to_serializer = self.target_repo._format._serializer
3614
src_serializer = src_format._serializer
3615
for substream_type, substream in stream:
3616
if substream_type == 'texts':
3617
self.target_repo.texts.insert_record_stream(substream)
3618
elif substream_type == 'inventories':
3619
if src_serializer == to_serializer:
3620
self.target_repo.inventories.insert_record_stream(
3623
self._extract_and_insert_inventories(
3624
substream, src_serializer)
3625
elif substream_type == 'revisions':
3626
# This may fallback to extract-and-insert more often than
3627
# required if the serializers are different only in terms of
3629
if src_serializer == to_serializer:
3630
self.target_repo.revisions.insert_record_stream(
3633
self._extract_and_insert_revisions(substream,
3635
elif substream_type == 'signatures':
3636
self.target_repo.signatures.insert_record_stream(substream)
3638
raise AssertionError('kaboom! %s' % (substream_type,))
3640
missing_keys = set()
3641
for prefix, versioned_file in (
3642
('texts', self.target_repo.texts),
3643
('inventories', self.target_repo.inventories),
3644
('revisions', self.target_repo.revisions),
3645
('signatures', self.target_repo.signatures),
3647
missing_keys.update((prefix,) + key for key in
3648
versioned_file.get_missing_compression_parent_keys())
3649
except NotImplementedError:
3650
# cannot even attempt suspending, and missing would have failed
3651
# during stream insertion.
3652
missing_keys = set()
3655
# suspend the write group and tell the caller what we is
3656
# missing. We know we can suspend or else we would not have
3657
# entered this code path. (All repositories that can handle
3658
# missing keys can handle suspending a write group).
3659
write_group_tokens = self.target_repo.suspend_write_group()
3660
return write_group_tokens, missing_keys
3661
self.target_repo.commit_write_group()
3664
def _extract_and_insert_inventories(self, substream, serializer):
3665
"""Generate a new inventory versionedfile in target, converting data.
3667
The inventory is retrieved from the source, (deserializing it), and
3668
stored in the target (reserializing it in a different format).
3670
for record in substream:
3671
bytes = record.get_bytes_as('fulltext')
3672
revision_id = record.key[0]
3673
inv = serializer.read_inventory_from_string(bytes, revision_id)
3674
parents = [key[0] for key in record.parents]
3675
self.target_repo.add_inventory(revision_id, inv, parents)
3677
def _extract_and_insert_revisions(self, substream, serializer):
3678
for record in substream:
3679
bytes = record.get_bytes_as('fulltext')
3680
revision_id = record.key[0]
3681
rev = serializer.read_revision_from_string(bytes)
3682
if rev.revision_id != revision_id:
3683
raise AssertionError('wtf: %s != %s' % (rev, revision_id))
3684
self.target_repo.add_revision(revision_id, rev)
3687
if self.target_repo._format._fetch_reconcile:
3688
self.target_repo.reconcile()
3691
class StreamSource(object):
3692
"""A source of a stream for fetching between repositories."""
3694
def __init__(self, from_repository, to_format):
3695
"""Create a StreamSource streaming from from_repository."""
3696
self.from_repository = from_repository
3697
self.to_format = to_format
3699
def delta_on_metadata(self):
3700
"""Return True if delta's are permitted on metadata streams.
3702
That is on revisions and signatures.
3704
src_serializer = self.from_repository._format._serializer
3705
target_serializer = self.to_format._serializer
3706
return (self.to_format._fetch_uses_deltas and
3707
src_serializer == target_serializer)
3709
def _fetch_revision_texts(self, revs):
3710
# fetch signatures first and then the revision texts
3711
# may need to be a InterRevisionStore call here.
3712
from_sf = self.from_repository.signatures
3713
# A missing signature is just skipped.
3714
keys = [(rev_id,) for rev_id in revs]
3715
signatures = versionedfile.filter_absent(from_sf.get_record_stream(
3717
self.to_format._fetch_order,
3718
not self.to_format._fetch_uses_deltas))
3719
# If a revision has a delta, this is actually expanded inside the
3720
# insert_record_stream code now, which is an alternate fix for
3722
from_rf = self.from_repository.revisions
3723
revisions = from_rf.get_record_stream(
3725
self.to_format._fetch_order,
3726
not self.delta_on_metadata())
3727
return [('signatures', signatures), ('revisions', revisions)]
3729
def _generate_root_texts(self, revs):
3730
"""This will be called by __fetch between fetching weave texts and
3731
fetching the inventory weave.
3733
Subclasses should override this if they need to generate root texts
3734
after fetching weave texts.
3736
if self._rich_root_upgrade():
3738
return bzrlib.fetch.Inter1and2Helper(
3739
self.from_repository).generate_root_texts(revs)
3743
def get_stream(self, search):
3745
revs = search.get_keys()
3746
graph = self.from_repository.get_graph()
3747
revs = list(graph.iter_topo_order(revs))
3748
data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
3750
for knit_kind, file_id, revisions in data_to_fetch:
3751
if knit_kind != phase:
3753
# Make a new progress bar for this phase
3754
if knit_kind == "file":
3755
# Accumulate file texts
3756
text_keys.extend([(file_id, revision) for revision in
3758
elif knit_kind == "inventory":
3759
# Now copy the file texts.
3760
from_texts = self.from_repository.texts
3761
yield ('texts', from_texts.get_record_stream(
3762
text_keys, self.to_format._fetch_order,
3763
not self.to_format._fetch_uses_deltas))
3764
# Cause an error if a text occurs after we have done the
3767
# Before we process the inventory we generate the root
3768
# texts (if necessary) so that the inventories references
3770
for _ in self._generate_root_texts(revs):
3772
# NB: This currently reopens the inventory weave in source;
3773
# using a single stream interface instead would avoid this.
3774
from_weave = self.from_repository.inventories
3775
# we fetch only the referenced inventories because we do not
3776
# know for unselected inventories whether all their required
3777
# texts are present in the other repository - it could be
3779
yield ('inventories', from_weave.get_record_stream(
3780
[(rev_id,) for rev_id in revs],
3781
self.inventory_fetch_order(),
3782
not self.delta_on_metadata()))
3783
elif knit_kind == "signatures":
3784
# Nothing to do here; this will be taken care of when
3785
# _fetch_revision_texts happens.
3787
elif knit_kind == "revisions":
3788
for record in self._fetch_revision_texts(revs):
3791
raise AssertionError("Unknown knit kind %r" % knit_kind)
3793
def get_stream_for_missing_keys(self, missing_keys):
3794
# missing keys can only occur when we are byte copying and not
3795
# translating (because translation means we don't send
3796
# unreconstructable deltas ever).
3798
keys['texts'] = set()
3799
keys['revisions'] = set()
3800
keys['inventories'] = set()
3801
keys['signatures'] = set()
3802
for key in missing_keys:
3803
keys[key[0]].add(key[1:])
3804
if len(keys['revisions']):
3805
# If we allowed copying revisions at this point, we could end up
3806
# copying a revision without copying its required texts: a
3807
# violation of the requirements for repository integrity.
3808
raise AssertionError(
3809
'cannot copy revisions to fill in missing deltas %s' % (
3810
keys['revisions'],))
3811
for substream_kind, keys in keys.iteritems():
3812
vf = getattr(self.from_repository, substream_kind)
3813
# Ask for full texts always so that we don't need more round trips
3814
# after this stream.
3815
stream = vf.get_record_stream(keys,
3816
self.to_format._fetch_order, True)
3817
yield substream_kind, stream
3819
def inventory_fetch_order(self):
3820
if self._rich_root_upgrade():
3821
return 'topological'
3823
return self.to_format._fetch_order
3825
def _rich_root_upgrade(self):
3826
return (not self.from_repository._format.rich_root_data and
3827
self.to_format.rich_root_data)
added
removed
bzrlib/repository.py
