← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-08-25 18:45:40 UTC
  • mto: (4634.6.15 2.0)
  • mto: This revision was merged to the branch mainline in revision 4667.
  • Revision ID: john@arbash-meinel.com-20090825184540-6dn3xjq62xhgj2gq
Add support for skipping ghost nodes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
 
19
import cStringIO
21
20
import re
22
21
import time
23
22
 
24
23
from bzrlib import (
25
24
    bzrdir,
26
25
    check,
 
26
    chk_map,
27
27
    debug,
28
 
    deprecated_graph,
29
28
    errors,
 
29
    fifo_cache,
30
30
    generate_ids,
31
31
    gpg,
32
32
    graph,
 
33
    inventory,
 
34
    inventory_delta,
33
35
    lazy_regex,
34
36
    lockable_files,
35
37
    lockdir,
 
38
    lru_cache,
36
39
    osutils,
37
 
    registry,
38
 
    remote,
39
40
    revision as _mod_revision,
40
41
    symbol_versioning,
41
 
    transactions,
 
42
    tsort,
42
43
    ui,
 
44
    versionedfile,
43
45
    )
44
46
from bzrlib.bundle import serializer
45
47
from bzrlib.revisiontree import RevisionTree
46
48
from bzrlib.store.versioned import VersionedFileStore
47
 
from bzrlib.store.text import TextStore
48
49
from bzrlib.testament import Testament
49
50
""")
50
51
 
51
52
from bzrlib.decorators import needs_read_lock, needs_write_lock
52
53
from bzrlib.inter import InterObject
53
 
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
54
 
from bzrlib.symbol_versioning import (
55
 
        deprecated_method,
56
 
        )
57
 
from bzrlib.trace import mutter, mutter_callsite, note, warning
 
54
from bzrlib.inventory import (
 
55
    Inventory,
 
56
    InventoryDirectory,
 
57
    ROOT_ID,
 
58
    entry_factory,
 
59
    )
 
60
from bzrlib import registry
 
61
from bzrlib.trace import (
 
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
58
63
 
59
64
 
60
65
# Old formats display a warning, but only once
61
66
_deprecation_warning_done = False
62
67
 
63
68
 
 
69
class CommitBuilder(object):
 
70
    """Provides an interface to build up a commit.
 
71
 
 
72
    This allows describing a tree to be committed without needing to
 
73
    know the internals of the format of the repository.
 
74
    """
 
75
 
 
76
    # all clients should supply tree roots.
 
77
    record_root_entry = True
 
78
    # the default CommitBuilder does not manage trees whose root is versioned.
 
79
    _versioned_root = False
 
80
 
 
81
    def __init__(self, repository, parents, config, timestamp=None,
 
82
                 timezone=None, committer=None, revprops=None,
 
83
                 revision_id=None):
 
84
        """Initiate a CommitBuilder.
 
85
 
 
86
        :param repository: Repository to commit to.
 
87
        :param parents: Revision ids of the parents of the new revision.
 
88
        :param config: Configuration to use.
 
89
        :param timestamp: Optional timestamp recorded for commit.
 
90
        :param timezone: Optional timezone for timestamp.
 
91
        :param committer: Optional committer to set for commit.
 
92
        :param revprops: Optional dictionary of revision properties.
 
93
        :param revision_id: Optional revision id.
 
94
        """
 
95
        self._config = config
 
96
 
 
97
        if committer is None:
 
98
            self._committer = self._config.username()
 
99
        else:
 
100
            self._committer = committer
 
101
 
 
102
        self.new_inventory = Inventory(None)
 
103
        self._new_revision_id = revision_id
 
104
        self.parents = parents
 
105
        self.repository = repository
 
106
 
 
107
        self._revprops = {}
 
108
        if revprops is not None:
 
109
            self._validate_revprops(revprops)
 
110
            self._revprops.update(revprops)
 
111
 
 
112
        if timestamp is None:
 
113
            timestamp = time.time()
 
114
        # Restrict resolution to 1ms
 
115
        self._timestamp = round(timestamp, 3)
 
116
 
 
117
        if timezone is None:
 
118
            self._timezone = osutils.local_time_offset()
 
119
        else:
 
120
            self._timezone = int(timezone)
 
121
 
 
122
        self._generate_revision_if_needed()
 
123
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
124
        self._basis_delta = []
 
125
        # API compatibility, older code that used CommitBuilder did not call
 
126
        # .record_delete(), which means the delta that is computed would not be
 
127
        # valid. Callers that will call record_delete() should call
 
128
        # .will_record_deletes() to indicate that.
 
129
        self._recording_deletes = False
 
130
        # memo'd check for no-op commits.
 
131
        self._any_changes = False
 
132
 
 
133
    def any_changes(self):
 
134
        """Return True if any entries were changed.
 
135
        
 
136
        This includes merge-only changes. It is the core for the --unchanged
 
137
        detection in commit.
 
138
 
 
139
        :return: True if any changes have occured.
 
140
        """
 
141
        return self._any_changes
 
142
 
 
143
    def _validate_unicode_text(self, text, context):
 
144
        """Verify things like commit messages don't have bogus characters."""
 
145
        if '\r' in text:
 
146
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
147
 
 
148
    def _validate_revprops(self, revprops):
 
149
        for key, value in revprops.iteritems():
 
150
            # We know that the XML serializers do not round trip '\r'
 
151
            # correctly, so refuse to accept them
 
152
            if not isinstance(value, basestring):
 
153
                raise ValueError('revision property (%s) is not a valid'
 
154
                                 ' (unicode) string: %r' % (key, value))
 
155
            self._validate_unicode_text(value,
 
156
                                        'revision property (%s)' % (key,))
 
157
 
 
158
    def commit(self, message):
 
159
        """Make the actual commit.
 
160
 
 
161
        :return: The revision id of the recorded revision.
 
162
        """
 
163
        self._validate_unicode_text(message, 'commit message')
 
164
        rev = _mod_revision.Revision(
 
165
                       timestamp=self._timestamp,
 
166
                       timezone=self._timezone,
 
167
                       committer=self._committer,
 
168
                       message=message,
 
169
                       inventory_sha1=self.inv_sha1,
 
170
                       revision_id=self._new_revision_id,
 
171
                       properties=self._revprops)
 
172
        rev.parent_ids = self.parents
 
173
        self.repository.add_revision(self._new_revision_id, rev,
 
174
            self.new_inventory, self._config)
 
175
        self.repository.commit_write_group()
 
176
        return self._new_revision_id
 
177
 
 
178
    def abort(self):
 
179
        """Abort the commit that is being built.
 
180
        """
 
181
        self.repository.abort_write_group()
 
182
 
 
183
    def revision_tree(self):
 
184
        """Return the tree that was just committed.
 
185
 
 
186
        After calling commit() this can be called to get a RevisionTree
 
187
        representing the newly committed tree. This is preferred to
 
188
        calling Repository.revision_tree() because that may require
 
189
        deserializing the inventory, while we already have a copy in
 
190
        memory.
 
191
        """
 
192
        if self.new_inventory is None:
 
193
            self.new_inventory = self.repository.get_inventory(
 
194
                self._new_revision_id)
 
195
        return RevisionTree(self.repository, self.new_inventory,
 
196
            self._new_revision_id)
 
197
 
 
198
    def finish_inventory(self):
 
199
        """Tell the builder that the inventory is finished.
 
200
 
 
201
        :return: The inventory id in the repository, which can be used with
 
202
            repository.get_inventory.
 
203
        """
 
204
        if self.new_inventory is None:
 
205
            # an inventory delta was accumulated without creating a new
 
206
            # inventory.
 
207
            basis_id = self.basis_delta_revision
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
209
                basis_id, self._basis_delta, self._new_revision_id,
 
210
                self.parents)
 
211
        else:
 
212
            if self.new_inventory.root is None:
 
213
                raise AssertionError('Root entry should be supplied to'
 
214
                    ' record_entry_contents, as of bzr 0.10.')
 
215
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
216
            self.new_inventory.revision_id = self._new_revision_id
 
217
            self.inv_sha1 = self.repository.add_inventory(
 
218
                self._new_revision_id,
 
219
                self.new_inventory,
 
220
                self.parents
 
221
                )
 
222
        return self._new_revision_id
 
223
 
 
224
    def _gen_revision_id(self):
 
225
        """Return new revision-id."""
 
226
        return generate_ids.gen_revision_id(self._config.username(),
 
227
                                            self._timestamp)
 
228
 
 
229
    def _generate_revision_if_needed(self):
 
230
        """Create a revision id if None was supplied.
 
231
 
 
232
        If the repository can not support user-specified revision ids
 
233
        they should override this function and raise CannotSetRevisionId
 
234
        if _new_revision_id is not None.
 
235
 
 
236
        :raises: CannotSetRevisionId
 
237
        """
 
238
        if self._new_revision_id is None:
 
239
            self._new_revision_id = self._gen_revision_id()
 
240
            self.random_revid = True
 
241
        else:
 
242
            self.random_revid = False
 
243
 
 
244
    def _heads(self, file_id, revision_ids):
 
245
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
246
 
 
247
        This can use either a per-file graph or a global revision graph as we
 
248
        have an identity relationship between the two graphs.
 
249
        """
 
250
        return self.__heads(revision_ids)
 
251
 
 
252
    def _check_root(self, ie, parent_invs, tree):
 
253
        """Helper for record_entry_contents.
 
254
 
 
255
        :param ie: An entry being added.
 
256
        :param parent_invs: The inventories of the parent revisions of the
 
257
            commit.
 
258
        :param tree: The tree that is being committed.
 
259
        """
 
260
        # In this revision format, root entries have no knit or weave When
 
261
        # serializing out to disk and back in root.revision is always
 
262
        # _new_revision_id
 
263
        ie.revision = self._new_revision_id
 
264
 
 
265
    def _require_root_change(self, tree):
 
266
        """Enforce an appropriate root object change.
 
267
 
 
268
        This is called once when record_iter_changes is called, if and only if
 
269
        the root was not in the delta calculated by record_iter_changes.
 
270
 
 
271
        :param tree: The tree which is being committed.
 
272
        """
 
273
        # NB: if there are no parents then this method is not called, so no
 
274
        # need to guard on parents having length.
 
275
        entry = entry_factory['directory'](tree.path2id(''), '',
 
276
            None)
 
277
        entry.revision = self._new_revision_id
 
278
        self._basis_delta.append(('', '', entry.file_id, entry))
 
279
 
 
280
    def _get_delta(self, ie, basis_inv, path):
 
281
        """Get a delta against the basis inventory for ie."""
 
282
        if ie.file_id not in basis_inv:
 
283
            # add
 
284
            result = (None, path, ie.file_id, ie)
 
285
            self._basis_delta.append(result)
 
286
            return result
 
287
        elif ie != basis_inv[ie.file_id]:
 
288
            # common but altered
 
289
            # TODO: avoid tis id2path call.
 
290
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
291
            self._basis_delta.append(result)
 
292
            return result
 
293
        else:
 
294
            # common, unaltered
 
295
            return None
 
296
 
 
297
    def get_basis_delta(self):
 
298
        """Return the complete inventory delta versus the basis inventory.
 
299
 
 
300
        This has been built up with the calls to record_delete and
 
301
        record_entry_contents. The client must have already called
 
302
        will_record_deletes() to indicate that they will be generating a
 
303
        complete delta.
 
304
 
 
305
        :return: An inventory delta, suitable for use with apply_delta, or
 
306
            Repository.add_inventory_by_delta, etc.
 
307
        """
 
308
        if not self._recording_deletes:
 
309
            raise AssertionError("recording deletes not activated.")
 
310
        return self._basis_delta
 
311
 
 
312
    def record_delete(self, path, file_id):
 
313
        """Record that a delete occured against a basis tree.
 
314
 
 
315
        This is an optional API - when used it adds items to the basis_delta
 
316
        being accumulated by the commit builder. It cannot be called unless the
 
317
        method will_record_deletes() has been called to inform the builder that
 
318
        a delta is being supplied.
 
319
 
 
320
        :param path: The path of the thing deleted.
 
321
        :param file_id: The file id that was deleted.
 
322
        """
 
323
        if not self._recording_deletes:
 
324
            raise AssertionError("recording deletes not activated.")
 
325
        delta = (path, None, file_id, None)
 
326
        self._basis_delta.append(delta)
 
327
        self._any_changes = True
 
328
        return delta
 
329
 
 
330
    def will_record_deletes(self):
 
331
        """Tell the commit builder that deletes are being notified.
 
332
 
 
333
        This enables the accumulation of an inventory delta; for the resulting
 
334
        commit to be valid, deletes against the basis MUST be recorded via
 
335
        builder.record_delete().
 
336
        """
 
337
        self._recording_deletes = True
 
338
        try:
 
339
            basis_id = self.parents[0]
 
340
        except IndexError:
 
341
            basis_id = _mod_revision.NULL_REVISION
 
342
        self.basis_delta_revision = basis_id
 
343
 
 
344
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
345
        content_summary):
 
346
        """Record the content of ie from tree into the commit if needed.
 
347
 
 
348
        Side effect: sets ie.revision when unchanged
 
349
 
 
350
        :param ie: An inventory entry present in the commit.
 
351
        :param parent_invs: The inventories of the parent revisions of the
 
352
            commit.
 
353
        :param path: The path the entry is at in the tree.
 
354
        :param tree: The tree which contains this entry and should be used to
 
355
            obtain content.
 
356
        :param content_summary: Summary data from the tree about the paths
 
357
            content - stat, length, exec, sha/link target. This is only
 
358
            accessed when the entry has a revision of None - that is when it is
 
359
            a candidate to commit.
 
360
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
361
            change_delta is an inventory_delta change for this entry against
 
362
            the basis tree of the commit, or None if no change occured against
 
363
            the basis tree.
 
364
            version_recorded is True if a new version of the entry has been
 
365
            recorded. For instance, committing a merge where a file was only
 
366
            changed on the other side will return (delta, False).
 
367
            fs_hash is either None, or the hash details for the path (currently
 
368
            a tuple of the contents sha1 and the statvalue returned by
 
369
            tree.get_file_with_stat()).
 
370
        """
 
371
        if self.new_inventory.root is None:
 
372
            if ie.parent_id is not None:
 
373
                raise errors.RootMissing()
 
374
            self._check_root(ie, parent_invs, tree)
 
375
        if ie.revision is None:
 
376
            kind = content_summary[0]
 
377
        else:
 
378
            # ie is carried over from a prior commit
 
379
            kind = ie.kind
 
380
        # XXX: repository specific check for nested tree support goes here - if
 
381
        # the repo doesn't want nested trees we skip it ?
 
382
        if (kind == 'tree-reference' and
 
383
            not self.repository._format.supports_tree_reference):
 
384
            # mismatch between commit builder logic and repository:
 
385
            # this needs the entry creation pushed down into the builder.
 
386
            raise NotImplementedError('Missing repository subtree support.')
 
387
        self.new_inventory.add(ie)
 
388
 
 
389
        # TODO: slow, take it out of the inner loop.
 
390
        try:
 
391
            basis_inv = parent_invs[0]
 
392
        except IndexError:
 
393
            basis_inv = Inventory(root_id=None)
 
394
 
 
395
        # ie.revision is always None if the InventoryEntry is considered
 
396
        # for committing. We may record the previous parents revision if the
 
397
        # content is actually unchanged against a sole head.
 
398
        if ie.revision is not None:
 
399
            if not self._versioned_root and path == '':
 
400
                # repositories that do not version the root set the root's
 
401
                # revision to the new commit even when no change occurs (more
 
402
                # specifically, they do not record a revision on the root; and
 
403
                # the rev id is assigned to the root during deserialisation -
 
404
                # this masks when a change may have occurred against the basis.
 
405
                # To match this we always issue a delta, because the revision
 
406
                # of the root will always be changing.
 
407
                if ie.file_id in basis_inv:
 
408
                    delta = (basis_inv.id2path(ie.file_id), path,
 
409
                        ie.file_id, ie)
 
410
                else:
 
411
                    # add
 
412
                    delta = (None, path, ie.file_id, ie)
 
413
                self._basis_delta.append(delta)
 
414
                return delta, False, None
 
415
            else:
 
416
                # we don't need to commit this, because the caller already
 
417
                # determined that an existing revision of this file is
 
418
                # appropriate. If its not being considered for committing then
 
419
                # it and all its parents to the root must be unaltered so
 
420
                # no-change against the basis.
 
421
                if ie.revision == self._new_revision_id:
 
422
                    raise AssertionError("Impossible situation, a skipped "
 
423
                        "inventory entry (%r) claims to be modified in this "
 
424
                        "commit (%r).", (ie, self._new_revision_id))
 
425
                return None, False, None
 
426
        # XXX: Friction: parent_candidates should return a list not a dict
 
427
        #      so that we don't have to walk the inventories again.
 
428
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
429
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
430
        heads = []
 
431
        for inv in parent_invs:
 
432
            if ie.file_id in inv:
 
433
                old_rev = inv[ie.file_id].revision
 
434
                if old_rev in head_set:
 
435
                    heads.append(inv[ie.file_id].revision)
 
436
                    head_set.remove(inv[ie.file_id].revision)
 
437
 
 
438
        store = False
 
439
        # now we check to see if we need to write a new record to the
 
440
        # file-graph.
 
441
        # We write a new entry unless there is one head to the ancestors, and
 
442
        # the kind-derived content is unchanged.
 
443
 
 
444
        # Cheapest check first: no ancestors, or more the one head in the
 
445
        # ancestors, we write a new node.
 
446
        if len(heads) != 1:
 
447
            store = True
 
448
        if not store:
 
449
            # There is a single head, look it up for comparison
 
450
            parent_entry = parent_candiate_entries[heads[0]]
 
451
            # if the non-content specific data has changed, we'll be writing a
 
452
            # node:
 
453
            if (parent_entry.parent_id != ie.parent_id or
 
454
                parent_entry.name != ie.name):
 
455
                store = True
 
456
        # now we need to do content specific checks:
 
457
        if not store:
 
458
            # if the kind changed the content obviously has
 
459
            if kind != parent_entry.kind:
 
460
                store = True
 
461
        # Stat cache fingerprint feedback for the caller - None as we usually
 
462
        # don't generate one.
 
463
        fingerprint = None
 
464
        if kind == 'file':
 
465
            if content_summary[2] is None:
 
466
                raise ValueError("Files must not have executable = None")
 
467
            if not store:
 
468
                if (# if the file length changed we have to store:
 
469
                    parent_entry.text_size != content_summary[1] or
 
470
                    # if the exec bit has changed we have to store:
 
471
                    parent_entry.executable != content_summary[2]):
 
472
                    store = True
 
473
                elif parent_entry.text_sha1 == content_summary[3]:
 
474
                    # all meta and content is unchanged (using a hash cache
 
475
                    # hit to check the sha)
 
476
                    ie.revision = parent_entry.revision
 
477
                    ie.text_size = parent_entry.text_size
 
478
                    ie.text_sha1 = parent_entry.text_sha1
 
479
                    ie.executable = parent_entry.executable
 
480
                    return self._get_delta(ie, basis_inv, path), False, None
 
481
                else:
 
482
                    # Either there is only a hash change(no hash cache entry,
 
483
                    # or same size content change), or there is no change on
 
484
                    # this file at all.
 
485
                    # Provide the parent's hash to the store layer, so that the
 
486
                    # content is unchanged we will not store a new node.
 
487
                    nostore_sha = parent_entry.text_sha1
 
488
            if store:
 
489
                # We want to record a new node regardless of the presence or
 
490
                # absence of a content change in the file.
 
491
                nostore_sha = None
 
492
            ie.executable = content_summary[2]
 
493
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
494
            try:
 
495
                text = file_obj.read()
 
496
            finally:
 
497
                file_obj.close()
 
498
            try:
 
499
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
500
                    ie.file_id, text, heads, nostore_sha)
 
501
                # Let the caller know we generated a stat fingerprint.
 
502
                fingerprint = (ie.text_sha1, stat_value)
 
503
            except errors.ExistingContent:
 
504
                # Turns out that the file content was unchanged, and we were
 
505
                # only going to store a new node if it was changed. Carry over
 
506
                # the entry.
 
507
                ie.revision = parent_entry.revision
 
508
                ie.text_size = parent_entry.text_size
 
509
                ie.text_sha1 = parent_entry.text_sha1
 
510
                ie.executable = parent_entry.executable
 
511
                return self._get_delta(ie, basis_inv, path), False, None
 
512
        elif kind == 'directory':
 
513
            if not store:
 
514
                # all data is meta here, nothing specific to directory, so
 
515
                # carry over:
 
516
                ie.revision = parent_entry.revision
 
517
                return self._get_delta(ie, basis_inv, path), False, None
 
518
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
519
        elif kind == 'symlink':
 
520
            current_link_target = content_summary[3]
 
521
            if not store:
 
522
                # symlink target is not generic metadata, check if it has
 
523
                # changed.
 
524
                if current_link_target != parent_entry.symlink_target:
 
525
                    store = True
 
526
            if not store:
 
527
                # unchanged, carry over.
 
528
                ie.revision = parent_entry.revision
 
529
                ie.symlink_target = parent_entry.symlink_target
 
530
                return self._get_delta(ie, basis_inv, path), False, None
 
531
            ie.symlink_target = current_link_target
 
532
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
533
        elif kind == 'tree-reference':
 
534
            if not store:
 
535
                if content_summary[3] != parent_entry.reference_revision:
 
536
                    store = True
 
537
            if not store:
 
538
                # unchanged, carry over.
 
539
                ie.reference_revision = parent_entry.reference_revision
 
540
                ie.revision = parent_entry.revision
 
541
                return self._get_delta(ie, basis_inv, path), False, None
 
542
            ie.reference_revision = content_summary[3]
 
543
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
544
        else:
 
545
            raise NotImplementedError('unknown kind')
 
546
        ie.revision = self._new_revision_id
 
547
        self._any_changes = True
 
548
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
549
 
 
550
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
 
551
        _entry_factory=entry_factory):
 
552
        """Record a new tree via iter_changes.
 
553
 
 
554
        :param tree: The tree to obtain text contents from for changed objects.
 
555
        :param basis_revision_id: The revision id of the tree the iter_changes
 
556
            has been generated against. Currently assumed to be the same
 
557
            as self.parents[0] - if it is not, errors may occur.
 
558
        :param iter_changes: An iter_changes iterator with the changes to apply
 
559
            to basis_revision_id. The iterator must not include any items with
 
560
            a current kind of None - missing items must be either filtered out
 
561
            or errored-on beefore record_iter_changes sees the item.
 
562
        :param _entry_factory: Private method to bind entry_factory locally for
 
563
            performance.
 
564
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
 
565
            tree._observed_sha1.
 
566
        """
 
567
        # Create an inventory delta based on deltas between all the parents and
 
568
        # deltas between all the parent inventories. We use inventory delta's 
 
569
        # between the inventory objects because iter_changes masks
 
570
        # last-changed-field only changes.
 
571
        # Working data:
 
572
        # file_id -> change map, change is fileid, paths, changed, versioneds,
 
573
        # parents, names, kinds, executables
 
574
        merged_ids = {}
 
575
        # {file_id -> revision_id -> inventory entry, for entries in parent
 
576
        # trees that are not parents[0]
 
577
        parent_entries = {}
 
578
        ghost_basis = False
 
579
        try:
 
580
            revtrees = list(self.repository.revision_trees(self.parents))
 
581
        except errors.NoSuchRevision:
 
582
            # one or more ghosts, slow path.
 
583
            revtrees = []
 
584
            for revision_id in self.parents:
 
585
                try:
 
586
                    revtrees.append(self.repository.revision_tree(revision_id))
 
587
                except errors.NoSuchRevision:
 
588
                    if not revtrees:
 
589
                        basis_revision_id = _mod_revision.NULL_REVISION
 
590
                        ghost_basis = True
 
591
                    revtrees.append(self.repository.revision_tree(
 
592
                        _mod_revision.NULL_REVISION))
 
593
        # The basis inventory from a repository 
 
594
        if revtrees:
 
595
            basis_inv = revtrees[0].inventory
 
596
        else:
 
597
            basis_inv = self.repository.revision_tree(
 
598
                _mod_revision.NULL_REVISION).inventory
 
599
        if len(self.parents) > 0:
 
600
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
601
                raise Exception(
 
602
                    "arbitrary basis parents not yet supported with merges")
 
603
            for revtree in revtrees[1:]:
 
604
                for change in revtree.inventory._make_delta(basis_inv):
 
605
                    if change[1] is None:
 
606
                        # Not present in this parent.
 
607
                        continue
 
608
                    if change[2] not in merged_ids:
 
609
                        if change[0] is not None:
 
610
                            basis_entry = basis_inv[change[2]]
 
611
                            merged_ids[change[2]] = [
 
612
                                # basis revid
 
613
                                basis_entry.revision,
 
614
                                # new tree revid
 
615
                                change[3].revision]
 
616
                            parent_entries[change[2]] = {
 
617
                                # basis parent
 
618
                                basis_entry.revision:basis_entry,
 
619
                                # this parent 
 
620
                                change[3].revision:change[3],
 
621
                                }
 
622
                        else:
 
623
                            merged_ids[change[2]] = [change[3].revision]
 
624
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
625
                    else:
 
626
                        merged_ids[change[2]].append(change[3].revision)
 
627
                        parent_entries[change[2]][change[3].revision] = change[3]
 
628
        else:
 
629
            merged_ids = {}
 
630
        # Setup the changes from the tree:
 
631
        # changes maps file_id -> (change, [parent revision_ids])
 
632
        changes= {}
 
633
        for change in iter_changes:
 
634
            # This probably looks up in basis_inv way to much.
 
635
            if change[1][0] is not None:
 
636
                head_candidate = [basis_inv[change[0]].revision]
 
637
            else:
 
638
                head_candidate = []
 
639
            changes[change[0]] = change, merged_ids.get(change[0],
 
640
                head_candidate)
 
641
        unchanged_merged = set(merged_ids) - set(changes)
 
642
        # Extend the changes dict with synthetic changes to record merges of
 
643
        # texts.
 
644
        for file_id in unchanged_merged:
 
645
            # Record a merged version of these items that did not change vs the
 
646
            # basis. This can be either identical parallel changes, or a revert
 
647
            # of a specific file after a merge. The recorded content will be
 
648
            # that of the current tree (which is the same as the basis), but
 
649
            # the per-file graph will reflect a merge.
 
650
            # NB:XXX: We are reconstructing path information we had, this
 
651
            # should be preserved instead.
 
652
            # inv delta  change: (file_id, (path_in_source, path_in_target),
 
653
            #   changed_content, versioned, parent, name, kind,
 
654
            #   executable)
 
655
            try:
 
656
                basis_entry = basis_inv[file_id]
 
657
            except errors.NoSuchId:
 
658
                # a change from basis->some_parents but file_id isn't in basis
 
659
                # so was new in the merge, which means it must have changed
 
660
                # from basis -> current, and as it hasn't the add was reverted
 
661
                # by the user. So we discard this change.
 
662
                pass
 
663
            else:
 
664
                change = (file_id,
 
665
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
666
                    False, (True, True),
 
667
                    (basis_entry.parent_id, basis_entry.parent_id),
 
668
                    (basis_entry.name, basis_entry.name),
 
669
                    (basis_entry.kind, basis_entry.kind),
 
670
                    (basis_entry.executable, basis_entry.executable))
 
671
                changes[file_id] = (change, merged_ids[file_id])
 
672
        # changes contains tuples with the change and a set of inventory
 
673
        # candidates for the file.
 
674
        # inv delta is:
 
675
        # old_path, new_path, file_id, new_inventory_entry
 
676
        seen_root = False # Is the root in the basis delta?
 
677
        inv_delta = self._basis_delta
 
678
        modified_rev = self._new_revision_id
 
679
        for change, head_candidates in changes.values():
 
680
            if change[3][1]: # versioned in target.
 
681
                # Several things may be happening here:
 
682
                # We may have a fork in the per-file graph
 
683
                #  - record a change with the content from tree
 
684
                # We may have a change against < all trees  
 
685
                #  - carry over the tree that hasn't changed
 
686
                # We may have a change against all trees
 
687
                #  - record the change with the content from tree
 
688
                kind = change[6][1]
 
689
                file_id = change[0]
 
690
                entry = _entry_factory[kind](file_id, change[5][1],
 
691
                    change[4][1])
 
692
                head_set = self._heads(change[0], set(head_candidates))
 
693
                heads = []
 
694
                # Preserve ordering.
 
695
                for head_candidate in head_candidates:
 
696
                    if head_candidate in head_set:
 
697
                        heads.append(head_candidate)
 
698
                        head_set.remove(head_candidate)
 
699
                carried_over = False
 
700
                if len(heads) == 1:
 
701
                    # Could be a carry-over situation:
 
702
                    parent_entry_revs = parent_entries.get(file_id, None)
 
703
                    if parent_entry_revs:
 
704
                        parent_entry = parent_entry_revs.get(heads[0], None)
 
705
                    else:
 
706
                        parent_entry = None
 
707
                    if parent_entry is None:
 
708
                        # The parent iter_changes was called against is the one
 
709
                        # that is the per-file head, so any change is relevant
 
710
                        # iter_changes is valid.
 
711
                        carry_over_possible = False
 
712
                    else:
 
713
                        # could be a carry over situation
 
714
                        # A change against the basis may just indicate a merge,
 
715
                        # we need to check the content against the source of the
 
716
                        # merge to determine if it was changed after the merge
 
717
                        # or carried over.
 
718
                        if (parent_entry.kind != entry.kind or
 
719
                            parent_entry.parent_id != entry.parent_id or
 
720
                            parent_entry.name != entry.name):
 
721
                            # Metadata common to all entries has changed
 
722
                            # against per-file parent
 
723
                            carry_over_possible = False
 
724
                        else:
 
725
                            carry_over_possible = True
 
726
                        # per-type checks for changes against the parent_entry
 
727
                        # are done below.
 
728
                else:
 
729
                    # Cannot be a carry-over situation
 
730
                    carry_over_possible = False
 
731
                # Populate the entry in the delta
 
732
                if kind == 'file':
 
733
                    # XXX: There is still a small race here: If someone reverts the content of a file
 
734
                    # after iter_changes examines and decides it has changed,
 
735
                    # we will unconditionally record a new version even if some
 
736
                    # other process reverts it while commit is running (with
 
737
                    # the revert happening after iter_changes did it's
 
738
                    # examination).
 
739
                    if change[7][1]:
 
740
                        entry.executable = True
 
741
                    else:
 
742
                        entry.executable = False
 
743
                    if (carry_over_possible and
 
744
                        parent_entry.executable == entry.executable):
 
745
                            # Check the file length, content hash after reading
 
746
                            # the file.
 
747
                            nostore_sha = parent_entry.text_sha1
 
748
                    else:
 
749
                        nostore_sha = None
 
750
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
 
751
                    try:
 
752
                        text = file_obj.read()
 
753
                    finally:
 
754
                        file_obj.close()
 
755
                    try:
 
756
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
 
757
                            file_id, text, heads, nostore_sha)
 
758
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
759
                    except errors.ExistingContent:
 
760
                        # No content change against a carry_over parent
 
761
                        # Perhaps this should also yield a fs hash update?
 
762
                        carried_over = True
 
763
                        entry.text_size = parent_entry.text_size
 
764
                        entry.text_sha1 = parent_entry.text_sha1
 
765
                elif kind == 'symlink':
 
766
                    # Wants a path hint?
 
767
                    entry.symlink_target = tree.get_symlink_target(file_id)
 
768
                    if (carry_over_possible and
 
769
                        parent_entry.symlink_target == entry.symlink_target):
 
770
                        carried_over = True
 
771
                    else:
 
772
                        self._add_text_to_weave(change[0], '', heads, None)
 
773
                elif kind == 'directory':
 
774
                    if carry_over_possible:
 
775
                        carried_over = True
 
776
                    else:
 
777
                        # Nothing to set on the entry.
 
778
                        # XXX: split into the Root and nonRoot versions.
 
779
                        if change[1][1] != '' or self.repository.supports_rich_root():
 
780
                            self._add_text_to_weave(change[0], '', heads, None)
 
781
                elif kind == 'tree-reference':
 
782
                    if not self.repository._format.supports_tree_reference:
 
783
                        # This isn't quite sane as an error, but we shouldn't
 
784
                        # ever see this code path in practice: tree's don't
 
785
                        # permit references when the repo doesn't support tree
 
786
                        # references.
 
787
                        raise errors.UnsupportedOperation(tree.add_reference,
 
788
                            self.repository)
 
789
                    reference_revision = tree.get_reference_revision(change[0])
 
790
                    entry.reference_revision = reference_revision
 
791
                    if (carry_over_possible and
 
792
                        parent_entry.reference_revision == reference_revision):
 
793
                        carried_over = True
 
794
                    else:
 
795
                        self._add_text_to_weave(change[0], '', heads, None)
 
796
                else:
 
797
                    raise AssertionError('unknown kind %r' % kind)
 
798
                if not carried_over:
 
799
                    entry.revision = modified_rev
 
800
                else:
 
801
                    entry.revision = parent_entry.revision
 
802
            else:
 
803
                entry = None
 
804
            new_path = change[1][1]
 
805
            inv_delta.append((change[1][0], new_path, change[0], entry))
 
806
            if new_path == '':
 
807
                seen_root = True
 
808
        self.new_inventory = None
 
809
        if len(inv_delta):
 
810
            self._any_changes = True
 
811
        if not seen_root:
 
812
            # housekeeping root entry changes do not affect no-change commits.
 
813
            self._require_root_change(tree)
 
814
        self.basis_delta_revision = basis_revision_id
 
815
 
 
816
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
 
817
        parent_keys = tuple([(file_id, parent) for parent in parents])
 
818
        return self.repository.texts._add_text(
 
819
            (file_id, self._new_revision_id), parent_keys, new_text,
 
820
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
821
 
 
822
 
 
823
class RootCommitBuilder(CommitBuilder):
 
824
    """This commitbuilder actually records the root id"""
 
825
 
 
826
    # the root entry gets versioned properly by this builder.
 
827
    _versioned_root = True
 
828
 
 
829
    def _check_root(self, ie, parent_invs, tree):
 
830
        """Helper for record_entry_contents.
 
831
 
 
832
        :param ie: An entry being added.
 
833
        :param parent_invs: The inventories of the parent revisions of the
 
834
            commit.
 
835
        :param tree: The tree that is being committed.
 
836
        """
 
837
 
 
838
    def _require_root_change(self, tree):
 
839
        """Enforce an appropriate root object change.
 
840
 
 
841
        This is called once when record_iter_changes is called, if and only if
 
842
        the root was not in the delta calculated by record_iter_changes.
 
843
 
 
844
        :param tree: The tree which is being committed.
 
845
        """
 
846
        # versioned roots do not change unless the tree found a change.
 
847
 
 
848
 
64
849
######################################################################
65
850
# Repositories
66
851
 
 
852
 
67
853
class Repository(object):
68
854
    """Repository holding history for one or more branches.
69
855
 
71
857
    revisions and file history.  It's normally accessed only by the Branch,
72
858
    which views a particular line of development through that history.
73
859
 
74
 
    The Repository builds on top of Stores and a Transport, which respectively 
75
 
    describe the disk data format and the way of accessing the (possibly 
 
860
    The Repository builds on top of some byte storage facilies (the revisions,
 
861
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
 
862
    which respectively provide byte storage and a means to access the (possibly
76
863
    remote) disk.
 
864
 
 
865
    The byte storage facilities are addressed via tuples, which we refer to
 
866
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
867
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
868
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
 
869
    byte string made up of a hash identifier and a hash value.
 
870
    We use this interface because it allows low friction with the underlying
 
871
    code that implements disk indices, network encoding and other parts of
 
872
    bzrlib.
 
873
 
 
874
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
 
875
        the serialised revisions for the repository. This can be used to obtain
 
876
        revision graph information or to access raw serialised revisions.
 
877
        The result of trying to insert data into the repository via this store
 
878
        is undefined: it should be considered read-only except for implementors
 
879
        of repositories.
 
880
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
881
        the serialised signatures for the repository. This can be used to
 
882
        obtain access to raw serialised signatures.  The result of trying to
 
883
        insert data into the repository via this store is undefined: it should
 
884
        be considered read-only except for implementors of repositories.
 
885
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
886
        the serialised inventories for the repository. This can be used to
 
887
        obtain unserialised inventories.  The result of trying to insert data
 
888
        into the repository via this store is undefined: it should be
 
889
        considered read-only except for implementors of repositories.
 
890
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
891
        texts of files and directories for the repository. This can be used to
 
892
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
893
        is usually a better interface for accessing file texts.
 
894
        The result of trying to insert data into the repository via this store
 
895
        is undefined: it should be considered read-only except for implementors
 
896
        of repositories.
 
897
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
 
898
        any data the repository chooses to store or have indexed by its hash.
 
899
        The result of trying to insert data into the repository via this store
 
900
        is undefined: it should be considered read-only except for implementors
 
901
        of repositories.
 
902
    :ivar _transport: Transport for file access to repository, typically
 
903
        pointing to .bzr/repository.
77
904
    """
78
905
 
 
906
    # What class to use for a CommitBuilder. Often its simpler to change this
 
907
    # in a Repository class subclass rather than to override
 
908
    # get_commit_builder.
 
909
    _commit_builder_class = CommitBuilder
 
910
    # The search regex used by xml based repositories to determine what things
 
911
    # where changed in a single commit.
79
912
    _file_ids_altered_regex = lazy_regex.lazy_compile(
80
913
        r'file_id="(?P<file_id>[^"]+)"'
81
 
        r'.*revision="(?P<revision_id>[^"]+)"'
 
914
        r'.* revision="(?P<revision_id>[^"]+)"'
82
915
        )
83
916
 
84
 
    def abort_write_group(self):
 
917
    def abort_write_group(self, suppress_errors=False):
85
918
        """Commit the contents accrued within the current write group.
86
919
 
 
920
        :param suppress_errors: if true, abort_write_group will catch and log
 
921
            unexpected errors that happen during the abort, rather than
 
922
            allowing them to propagate.  Defaults to False.
 
923
 
87
924
        :seealso: start_write_group.
88
925
        """
89
926
        if self._write_group is not self.get_transaction():
90
927
            # has an unlock or relock occured ?
91
 
            raise errors.BzrError('mismatched lock context and write group.')
92
 
        self._abort_write_group()
 
928
            if suppress_errors:
 
929
                mutter(
 
930
                '(suppressed) mismatched lock context and write group. %r, %r',
 
931
                self._write_group, self.get_transaction())
 
932
                return
 
933
            raise errors.BzrError(
 
934
                'mismatched lock context and write group. %r, %r' %
 
935
                (self._write_group, self.get_transaction()))
 
936
        try:
 
937
            self._abort_write_group()
 
938
        except Exception, exc:
 
939
            self._write_group = None
 
940
            if not suppress_errors:
 
941
                raise
 
942
            mutter('abort_write_group failed')
 
943
            log_exception_quietly()
 
944
            note('bzr: ERROR (ignored): %s', exc)
93
945
        self._write_group = None
94
946
 
95
947
    def _abort_write_group(self):
96
948
        """Template method for per-repository write group cleanup.
97
 
        
98
 
        This is called during abort before the write group is considered to be 
 
949
 
 
950
        This is called during abort before the write group is considered to be
99
951
        finished and should cleanup any internal state accrued during the write
100
952
        group. There is no requirement that data handed to the repository be
101
953
        *not* made available - this is not a rollback - but neither should any
105
957
        attempted.
106
958
        """
107
959
 
108
 
    @needs_write_lock
 
960
    def add_fallback_repository(self, repository):
 
961
        """Add a repository to use for looking up data not held locally.
 
962
 
 
963
        :param repository: A repository.
 
964
        """
 
965
        if not self._format.supports_external_lookups:
 
966
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
967
        if self.is_locked():
 
968
            # This repository will call fallback.unlock() when we transition to
 
969
            # the unlocked state, so we make sure to increment the lock count
 
970
            repository.lock_read()
 
971
        self._check_fallback_repository(repository)
 
972
        self._fallback_repositories.append(repository)
 
973
        self.texts.add_fallback_versioned_files(repository.texts)
 
974
        self.inventories.add_fallback_versioned_files(repository.inventories)
 
975
        self.revisions.add_fallback_versioned_files(repository.revisions)
 
976
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
977
        if self.chk_bytes is not None:
 
978
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
 
979
 
 
980
    def _check_fallback_repository(self, repository):
 
981
        """Check that this repository can fallback to repository safely.
 
982
 
 
983
        Raise an error if not.
 
984
 
 
985
        :param repository: A repository to fallback to.
 
986
        """
 
987
        return InterRepository._assert_same_model(self, repository)
 
988
 
109
989
    def add_inventory(self, revision_id, inv, parents):
110
990
        """Add the inventory inv to the repository as revision_id.
111
 
        
 
991
 
112
992
        :param parents: The revision ids of the parents that revision_id
113
993
                        is known to have and are in the repository already.
114
994
 
115
 
        returns the sha1 of the serialized inventory.
 
995
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
996
            repository format specific) of the serialized inventory.
116
997
        """
117
 
        revision_id = osutils.safe_revision_id(revision_id)
 
998
        if not self.is_in_write_group():
 
999
            raise AssertionError("%r not in write group" % (self,))
118
1000
        _mod_revision.check_not_reserved_id(revision_id)
119
 
        assert inv.revision_id is None or inv.revision_id == revision_id, \
120
 
            "Mismatch between inventory revision" \
121
 
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
122
 
        assert inv.root is not None
123
 
        inv_text = self.serialise_inventory(inv)
124
 
        inv_sha1 = osutils.sha_string(inv_text)
125
 
        inv_vf = self.control_weaves.get_weave('inventory',
126
 
                                               self.get_transaction())
127
 
        self._inventory_add_lines(inv_vf, revision_id, parents,
128
 
                                  osutils.split_lines(inv_text))
129
 
        return inv_sha1
130
 
 
131
 
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines):
132
 
        final_parents = []
133
 
        for parent in parents:
134
 
            if parent in inv_vf:
135
 
                final_parents.append(parent)
136
 
 
137
 
        inv_vf.add_lines(revision_id, final_parents, lines)
138
 
 
139
 
    @needs_write_lock
 
1001
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
1002
            raise AssertionError(
 
1003
                "Mismatch between inventory revision"
 
1004
                " id and insertion revid (%r, %r)"
 
1005
                % (inv.revision_id, revision_id))
 
1006
        if inv.root is None:
 
1007
            raise AssertionError()
 
1008
        return self._add_inventory_checked(revision_id, inv, parents)
 
1009
 
 
1010
    def _add_inventory_checked(self, revision_id, inv, parents):
 
1011
        """Add inv to the repository after checking the inputs.
 
1012
 
 
1013
        This function can be overridden to allow different inventory styles.
 
1014
 
 
1015
        :seealso: add_inventory, for the contract.
 
1016
        """
 
1017
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1018
        return self._inventory_add_lines(revision_id, parents,
 
1019
            inv_lines, check_content=False)
 
1020
 
 
1021
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1022
                               parents, basis_inv=None, propagate_caches=False):
 
1023
        """Add a new inventory expressed as a delta against another revision.
 
1024
 
 
1025
        See the inventory developers documentation for the theory behind
 
1026
        inventory deltas.
 
1027
 
 
1028
        :param basis_revision_id: The inventory id the delta was created
 
1029
            against. (This does not have to be a direct parent.)
 
1030
        :param delta: The inventory delta (see Inventory.apply_delta for
 
1031
            details).
 
1032
        :param new_revision_id: The revision id that the inventory is being
 
1033
            added for.
 
1034
        :param parents: The revision ids of the parents that revision_id is
 
1035
            known to have and are in the repository already. These are supplied
 
1036
            for repositories that depend on the inventory graph for revision
 
1037
            graph access, as well as for those that pun ancestry with delta
 
1038
            compression.
 
1039
        :param basis_inv: The basis inventory if it is already known,
 
1040
            otherwise None.
 
1041
        :param propagate_caches: If True, the caches for this inventory are
 
1042
          copied to and updated for the result if possible.
 
1043
 
 
1044
        :returns: (validator, new_inv)
 
1045
            The validator(which is a sha1 digest, though what is sha'd is
 
1046
            repository format specific) of the serialized inventory, and the
 
1047
            resulting inventory.
 
1048
        """
 
1049
        if not self.is_in_write_group():
 
1050
            raise AssertionError("%r not in write group" % (self,))
 
1051
        _mod_revision.check_not_reserved_id(new_revision_id)
 
1052
        basis_tree = self.revision_tree(basis_revision_id)
 
1053
        basis_tree.lock_read()
 
1054
        try:
 
1055
            # Note that this mutates the inventory of basis_tree, which not all
 
1056
            # inventory implementations may support: A better idiom would be to
 
1057
            # return a new inventory, but as there is no revision tree cache in
 
1058
            # repository this is safe for now - RBC 20081013
 
1059
            if basis_inv is None:
 
1060
                basis_inv = basis_tree.inventory
 
1061
            basis_inv.apply_delta(delta)
 
1062
            basis_inv.revision_id = new_revision_id
 
1063
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
1064
                    basis_inv)
 
1065
        finally:
 
1066
            basis_tree.unlock()
 
1067
 
 
1068
    def _inventory_add_lines(self, revision_id, parents, lines,
 
1069
        check_content=True):
 
1070
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
1071
        parents = [(parent,) for parent in parents]
 
1072
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1073
            check_content=check_content)[0]
 
1074
        self.inventories._access.flush()
 
1075
        return result
 
1076
 
140
1077
    def add_revision(self, revision_id, rev, inv=None, config=None):
141
1078
        """Add rev to the revision store as revision_id.
142
1079
 
148
1085
                       If supplied its signature_needed method will be used
149
1086
                       to determine if a signature should be made.
150
1087
        """
151
 
        revision_id = osutils.safe_revision_id(revision_id)
152
1088
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
153
1089
        #       rev.parent_ids?
154
1090
        _mod_revision.check_not_reserved_id(revision_id)
158
1094
            plaintext = Testament(rev, inv).as_short_text()
159
1095
            self.store_revision_signature(
160
1096
                gpg.GPGStrategy(config), plaintext, revision_id)
161
 
        if not revision_id in self.get_inventory_weave():
 
1097
        # check inventory present
 
1098
        if not self.inventories.get_parent_map([(revision_id,)]):
162
1099
            if inv is None:
163
1100
                raise errors.WeaveRevisionNotPresent(revision_id,
164
 
                                                     self.get_inventory_weave())
 
1101
                                                     self.inventories)
165
1102
            else:
166
1103
                # yes, this is not suitable for adding with ghosts.
167
 
                self.add_inventory(revision_id, inv, rev.parent_ids)
168
 
        self._revision_store.add_revision(rev, self.get_transaction())
169
 
 
170
 
    def _add_revision_text(self, revision_id, text):
171
 
        revision = self._revision_store._serializer.read_revision_from_string(
172
 
            text)
173
 
        self._revision_store._add_revision(revision, StringIO(text),
174
 
                                           self.get_transaction())
175
 
 
176
 
    @needs_read_lock
177
 
    def _all_possible_ids(self):
178
 
        """Return all the possible revisions that we could find."""
179
 
        return self.get_inventory_weave().versions()
 
1104
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1105
                                                        rev.parent_ids)
 
1106
        else:
 
1107
            key = (revision_id,)
 
1108
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1109
        self._add_revision(rev)
 
1110
 
 
1111
    def _add_revision(self, revision):
 
1112
        text = self._serializer.write_revision_to_string(revision)
 
1113
        key = (revision.revision_id,)
 
1114
        parents = tuple((parent,) for parent in revision.parent_ids)
 
1115
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
180
1116
 
181
1117
    def all_revision_ids(self):
182
 
        """Returns a list of all the revision ids in the repository. 
 
1118
        """Returns a list of all the revision ids in the repository.
183
1119
 
184
 
        This is deprecated because code should generally work on the graph
185
 
        reachable from a particular revision, and ignore any other revisions
186
 
        that might be present.  There is no direct replacement method.
 
1120
        This is conceptually deprecated because code should generally work on
 
1121
        the graph reachable from a particular revision, and ignore any other
 
1122
        revisions that might be present.  There is no direct replacement
 
1123
        method.
187
1124
        """
 
1125
        if 'evil' in debug.debug_flags:
 
1126
            mutter_callsite(2, "all_revision_ids is linear with history.")
188
1127
        return self._all_revision_ids()
189
1128
 
190
 
    @needs_read_lock
191
1129
    def _all_revision_ids(self):
192
 
        """Returns a list of all the revision ids in the repository. 
 
1130
        """Returns a list of all the revision ids in the repository.
193
1131
 
194
 
        These are in as much topological order as the underlying store can 
195
 
        present: for weaves ghosts may lead to a lack of correctness until
196
 
        the reweave updates the parents list.
 
1132
        These are in as much topological order as the underlying store can
 
1133
        present.
197
1134
        """
198
 
        if self._revision_store.text_store.listable():
199
 
            return self._revision_store.all_revision_ids(self.get_transaction())
200
 
        result = self._all_possible_ids()
201
 
        # TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
202
 
        #       ids. (It should, since _revision_store's API should change to
203
 
        #       return utf8 revision_ids)
204
 
        return self._eliminate_revisions_not_present(result)
 
1135
        raise NotImplementedError(self._all_revision_ids)
205
1136
 
206
1137
    def break_lock(self):
207
1138
        """Break a lock if one is present from another instance.
218
1149
        Returns a set of the present revisions.
219
1150
        """
220
1151
        result = []
221
 
        for id in revision_ids:
222
 
            if self.has_revision(id):
223
 
               result.append(id)
224
 
        return result
 
1152
        graph = self.get_graph()
 
1153
        parent_map = graph.get_parent_map(revision_ids)
 
1154
        # The old API returned a list, should this actually be a set?
 
1155
        return parent_map.keys()
 
1156
 
 
1157
    def _check_inventories(self, checker):
 
1158
        """Check the inventories found from the revision scan.
 
1159
        
 
1160
        This is responsible for verifying the sha1 of inventories and
 
1161
        creating a pending_keys set that covers data referenced by inventories.
 
1162
        """
 
1163
        bar = ui.ui_factory.nested_progress_bar()
 
1164
        try:
 
1165
            self._do_check_inventories(checker, bar)
 
1166
        finally:
 
1167
            bar.finished()
 
1168
 
 
1169
    def _do_check_inventories(self, checker, bar):
 
1170
        """Helper for _check_inventories."""
 
1171
        revno = 0
 
1172
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
 
1173
        kinds = ['chk_bytes', 'texts']
 
1174
        count = len(checker.pending_keys)
 
1175
        bar.update("inventories", 0, 2)
 
1176
        current_keys = checker.pending_keys
 
1177
        checker.pending_keys = {}
 
1178
        # Accumulate current checks.
 
1179
        for key in current_keys:
 
1180
            if key[0] != 'inventories' and key[0] not in kinds:
 
1181
                checker._report_items.append('unknown key type %r' % (key,))
 
1182
            keys[key[0]].add(key[1:])
 
1183
        if keys['inventories']:
 
1184
            # NB: output order *should* be roughly sorted - topo or
 
1185
            # inverse topo depending on repository - either way decent
 
1186
            # to just delta against. However, pre-CHK formats didn't
 
1187
            # try to optimise inventory layout on disk. As such the
 
1188
            # pre-CHK code path does not use inventory deltas.
 
1189
            last_object = None
 
1190
            for record in self.inventories.check(keys=keys['inventories']):
 
1191
                if record.storage_kind == 'absent':
 
1192
                    checker._report_items.append(
 
1193
                        'Missing inventory {%s}' % (record.key,))
 
1194
                else:
 
1195
                    last_object = self._check_record('inventories', record,
 
1196
                        checker, last_object,
 
1197
                        current_keys[('inventories',) + record.key])
 
1198
            del keys['inventories']
 
1199
        else:
 
1200
            return
 
1201
        bar.update("texts", 1)
 
1202
        while (checker.pending_keys or keys['chk_bytes']
 
1203
            or keys['texts']):
 
1204
            # Something to check.
 
1205
            current_keys = checker.pending_keys
 
1206
            checker.pending_keys = {}
 
1207
            # Accumulate current checks.
 
1208
            for key in current_keys:
 
1209
                if key[0] not in kinds:
 
1210
                    checker._report_items.append('unknown key type %r' % (key,))
 
1211
                keys[key[0]].add(key[1:])
 
1212
            # Check the outermost kind only - inventories || chk_bytes || texts
 
1213
            for kind in kinds:
 
1214
                if keys[kind]:
 
1215
                    last_object = None
 
1216
                    for record in getattr(self, kind).check(keys=keys[kind]):
 
1217
                        if record.storage_kind == 'absent':
 
1218
                            checker._report_items.append(
 
1219
                                'Missing inventory {%s}' % (record.key,))
 
1220
                        else:
 
1221
                            last_object = self._check_record(kind, record,
 
1222
                                checker, last_object, current_keys[(kind,) + record.key])
 
1223
                    keys[kind] = set()
 
1224
                    break
 
1225
 
 
1226
    def _check_record(self, kind, record, checker, last_object, item_data):
 
1227
        """Check a single text from this repository."""
 
1228
        if kind == 'inventories':
 
1229
            rev_id = record.key[0]
 
1230
            inv = self.deserialise_inventory(rev_id,
 
1231
                record.get_bytes_as('fulltext'))
 
1232
            if last_object is not None:
 
1233
                delta = inv._make_delta(last_object)
 
1234
                for old_path, path, file_id, ie in delta:
 
1235
                    if ie is None:
 
1236
                        continue
 
1237
                    ie.check(checker, rev_id, inv)
 
1238
            else:
 
1239
                for path, ie in inv.iter_entries():
 
1240
                    ie.check(checker, rev_id, inv)
 
1241
            if self._format.fast_deltas:
 
1242
                return inv
 
1243
        elif kind == 'chk_bytes':
 
1244
            # No code written to check chk_bytes for this repo format.
 
1245
            checker._report_items.append(
 
1246
                'unsupported key type chk_bytes for %s' % (record.key,))
 
1247
        elif kind == 'texts':
 
1248
            self._check_text(record, checker, item_data)
 
1249
        else:
 
1250
            checker._report_items.append(
 
1251
                'unknown key type %s for %s' % (kind, record.key))
 
1252
 
 
1253
    def _check_text(self, record, checker, item_data):
 
1254
        """Check a single text."""
 
1255
        # Check it is extractable.
 
1256
        # TODO: check length.
 
1257
        if record.storage_kind == 'chunked':
 
1258
            chunks = record.get_bytes_as(record.storage_kind)
 
1259
            sha1 = osutils.sha_strings(chunks)
 
1260
            length = sum(map(len, chunks))
 
1261
        else:
 
1262
            content = record.get_bytes_as('fulltext')
 
1263
            sha1 = osutils.sha_string(content)
 
1264
            length = len(content)
 
1265
        if item_data and sha1 != item_data[1]:
 
1266
            checker._report_items.append(
 
1267
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
 
1268
                (record.key, sha1, item_data[1], item_data[2]))
225
1269
 
226
1270
    @staticmethod
227
1271
    def create(a_bzrdir):
228
1272
        """Construct the current default format repository in a_bzrdir."""
229
1273
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
230
1274
 
231
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
1275
    def __init__(self, _format, a_bzrdir, control_files):
232
1276
        """instantiate a Repository.
233
1277
 
234
1278
        :param _format: The format of the repository on disk.
243
1287
        # the following are part of the public API for Repository:
244
1288
        self.bzrdir = a_bzrdir
245
1289
        self.control_files = control_files
246
 
        self._revision_store = _revision_store
247
 
        # backwards compatibility
248
 
        self.weave_store = text_store
 
1290
        self._transport = control_files._transport
 
1291
        self.base = self._transport.base
249
1292
        # for tests
250
1293
        self._reconcile_does_inventory_gc = True
251
 
        # not right yet - should be more semantically clear ? 
252
 
        # 
253
 
        self.control_store = control_store
254
 
        self.control_weaves = control_store
 
1294
        self._reconcile_fixes_text_parents = False
 
1295
        self._reconcile_backsup_inventory = True
 
1296
        # not right yet - should be more semantically clear ?
 
1297
        #
255
1298
        # TODO: make sure to construct the right store classes, etc, depending
256
1299
        # on whether escaping is required.
257
1300
        self._warn_if_deprecated()
258
1301
        self._write_group = None
 
1302
        # Additional places to query for data.
 
1303
        self._fallback_repositories = []
 
1304
        # An InventoryEntry cache, used during deserialization
 
1305
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
259
1306
 
260
1307
    def __repr__(self):
261
 
        return '%s(%r)' % (self.__class__.__name__, 
262
 
                           self.bzrdir.transport.base)
 
1308
        if self._fallback_repositories:
 
1309
            return '%s(%r, fallback_repositories=%r)' % (
 
1310
                self.__class__.__name__,
 
1311
                self.base,
 
1312
                self._fallback_repositories)
 
1313
        else:
 
1314
            return '%s(%r)' % (self.__class__.__name__,
 
1315
                               self.base)
 
1316
 
 
1317
    def _has_same_fallbacks(self, other_repo):
 
1318
        """Returns true if the repositories have the same fallbacks."""
 
1319
        my_fb = self._fallback_repositories
 
1320
        other_fb = other_repo._fallback_repositories
 
1321
        if len(my_fb) != len(other_fb):
 
1322
            return False
 
1323
        for f, g in zip(my_fb, other_fb):
 
1324
            if not f.has_same_location(g):
 
1325
                return False
 
1326
        return True
263
1327
 
264
1328
    def has_same_location(self, other):
265
1329
        """Returns a boolean indicating if this repository is at the same
270
1334
        """
271
1335
        if self.__class__ is not other.__class__:
272
1336
            return False
273
 
        return (self.control_files._transport.base ==
274
 
                other.control_files._transport.base)
 
1337
        return (self._transport.base == other._transport.base)
275
1338
 
276
1339
    def is_in_write_group(self):
277
1340
        """Return True if there is an open write group.
283
1346
    def is_locked(self):
284
1347
        return self.control_files.is_locked()
285
1348
 
 
1349
    def is_write_locked(self):
 
1350
        """Return True if this object is write locked."""
 
1351
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
1352
 
286
1353
    def lock_write(self, token=None):
287
1354
        """Lock this repository for writing.
288
1355
 
289
1356
        This causes caching within the repository obejct to start accumlating
290
1357
        data during reads, and allows a 'write_group' to be obtained. Write
291
1358
        groups must be used for actual data insertion.
292
 
        
 
1359
 
293
1360
        :param token: if this is already locked, then lock_write will fail
294
1361
            unless the token matches the existing lock.
295
1362
        :returns: a token if this instance supports tokens, otherwise None.
305
1372
 
306
1373
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
307
1374
        """
 
1375
        locked = self.is_locked()
308
1376
        result = self.control_files.lock_write(token=token)
309
 
        self._refresh_data()
 
1377
        if not locked:
 
1378
            for repo in self._fallback_repositories:
 
1379
                # Writes don't affect fallback repos
 
1380
                repo.lock_read()
 
1381
            self._refresh_data()
310
1382
        return result
311
1383
 
312
1384
    def lock_read(self):
 
1385
        locked = self.is_locked()
313
1386
        self.control_files.lock_read()
314
 
        self._refresh_data()
 
1387
        if not locked:
 
1388
            for repo in self._fallback_repositories:
 
1389
                repo.lock_read()
 
1390
            self._refresh_data()
315
1391
 
316
1392
    def get_physical_lock_status(self):
317
1393
        return self.control_files.get_physical_lock_status()
319
1395
    def leave_lock_in_place(self):
320
1396
        """Tell this repository not to release the physical lock when this
321
1397
        object is unlocked.
322
 
        
 
1398
 
323
1399
        If lock_write doesn't return a token, then this method is not supported.
324
1400
        """
325
1401
        self.control_files.leave_in_place()
376
1452
                last_revision.timezone)
377
1453
 
378
1454
        # now gather global repository information
 
1455
        # XXX: This is available for many repos regardless of listability.
379
1456
        if self.bzrdir.root_transport.listable():
380
 
            c, t = self._revision_store.total_size(self.get_transaction())
381
 
            result['revisions'] = c
382
 
            result['size'] = t
 
1457
            # XXX: do we want to __define len__() ?
 
1458
            # Maybe the versionedfiles object should provide a different
 
1459
            # method to get the number of keys.
 
1460
            result['revisions'] = len(self.revisions.keys())
 
1461
            # result['size'] = t
383
1462
        return result
384
1463
 
 
1464
    def find_branches(self, using=False):
 
1465
        """Find branches underneath this repository.
 
1466
 
 
1467
        This will include branches inside other branches.
 
1468
 
 
1469
        :param using: If True, list only branches using this repository.
 
1470
        """
 
1471
        if using and not self.is_shared():
 
1472
            try:
 
1473
                return [self.bzrdir.open_branch()]
 
1474
            except errors.NotBranchError:
 
1475
                return []
 
1476
        class Evaluator(object):
 
1477
 
 
1478
            def __init__(self):
 
1479
                self.first_call = True
 
1480
 
 
1481
            def __call__(self, bzrdir):
 
1482
                # On the first call, the parameter is always the bzrdir
 
1483
                # containing the current repo.
 
1484
                if not self.first_call:
 
1485
                    try:
 
1486
                        repository = bzrdir.open_repository()
 
1487
                    except errors.NoRepositoryPresent:
 
1488
                        pass
 
1489
                    else:
 
1490
                        return False, (None, repository)
 
1491
                self.first_call = False
 
1492
                try:
 
1493
                    value = (bzrdir.open_branch(), None)
 
1494
                except errors.NotBranchError:
 
1495
                    value = (None, None)
 
1496
                return True, value
 
1497
 
 
1498
        branches = []
 
1499
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1500
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1501
            if branch is not None:
 
1502
                branches.append(branch)
 
1503
            if not using and repository is not None:
 
1504
                branches.extend(repository.find_branches())
 
1505
        return branches
 
1506
 
385
1507
    @needs_read_lock
386
 
    def missing_revision_ids(self, other, revision_id=None):
 
1508
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
387
1509
        """Return the revision ids that other has that this does not.
388
 
        
 
1510
 
389
1511
        These are returned in topological order.
390
1512
 
391
1513
        revision_id: only return revision ids included by revision_id.
392
1514
        """
393
 
        revision_id = osutils.safe_revision_id(revision_id)
394
 
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
1515
        return InterRepository.get(other, self).search_missing_revision_ids(
 
1516
            revision_id, find_ghosts)
395
1517
 
396
1518
    @staticmethod
397
1519
    def open(base):
405
1527
 
406
1528
    def copy_content_into(self, destination, revision_id=None):
407
1529
        """Make a complete copy of the content in self into destination.
408
 
        
409
 
        This is a destructive operation! Do not use it on existing 
 
1530
 
 
1531
        This is a destructive operation! Do not use it on existing
410
1532
        repositories.
411
1533
        """
412
 
        revision_id = osutils.safe_revision_id(revision_id)
413
1534
        return InterRepository.get(self, destination).copy_content(revision_id)
414
1535
 
415
1536
    def commit_write_group(self):
416
1537
        """Commit the contents accrued within the current write group.
417
1538
 
418
1539
        :seealso: start_write_group.
 
1540
        
 
1541
        :return: it may return an opaque hint that can be passed to 'pack'.
419
1542
        """
420
1543
        if self._write_group is not self.get_transaction():
421
1544
            # has an unlock or relock occured ?
422
 
            raise errors.BzrError('mismatched lock context and write group.')
423
 
        self._commit_write_group()
 
1545
            raise errors.BzrError('mismatched lock context %r and '
 
1546
                'write group %r.' %
 
1547
                (self.get_transaction(), self._write_group))
 
1548
        result = self._commit_write_group()
424
1549
        self._write_group = None
 
1550
        return result
425
1551
 
426
1552
    def _commit_write_group(self):
427
1553
        """Template method for per-repository write group cleanup.
428
 
        
429
 
        This is called before the write group is considered to be 
 
1554
 
 
1555
        This is called before the write group is considered to be
430
1556
        finished and should ensure that all data handed to the repository
431
 
        for writing during the write group is safely committed (to the 
 
1557
        for writing during the write group is safely committed (to the
432
1558
        extent possible considering file system caching etc).
433
1559
        """
434
1560
 
435
 
    def fetch(self, source, revision_id=None, pb=None):
 
1561
    def suspend_write_group(self):
 
1562
        raise errors.UnsuspendableWriteGroup(self)
 
1563
 
 
1564
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1565
        """Return the keys of missing inventory parents for revisions added in
 
1566
        this write group.
 
1567
 
 
1568
        A revision is not complete if the inventory delta for that revision
 
1569
        cannot be calculated.  Therefore if the parent inventories of a
 
1570
        revision are not present, the revision is incomplete, and e.g. cannot
 
1571
        be streamed by a smart server.  This method finds missing inventory
 
1572
        parents for revisions added in this write group.
 
1573
        """
 
1574
        if not self._format.supports_external_lookups:
 
1575
            # This is only an issue for stacked repositories
 
1576
            return set()
 
1577
        if not self.is_in_write_group():
 
1578
            raise AssertionError('not in a write group')
 
1579
 
 
1580
        # XXX: We assume that every added revision already has its
 
1581
        # corresponding inventory, so we only check for parent inventories that
 
1582
        # might be missing, rather than all inventories.
 
1583
        parents = set(self.revisions._index.get_missing_parents())
 
1584
        parents.discard(_mod_revision.NULL_REVISION)
 
1585
        unstacked_inventories = self.inventories._index
 
1586
        present_inventories = unstacked_inventories.get_parent_map(
 
1587
            key[-1:] for key in parents)
 
1588
        parents.difference_update(present_inventories)
 
1589
        if len(parents) == 0:
 
1590
            # No missing parent inventories.
 
1591
            return set()
 
1592
        if not check_for_missing_texts:
 
1593
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1594
        # Ok, now we have a list of missing inventories.  But these only matter
 
1595
        # if the inventories that reference them are missing some texts they
 
1596
        # appear to introduce.
 
1597
        # XXX: Texts referenced by all added inventories need to be present,
 
1598
        # but at the moment we're only checking for texts referenced by
 
1599
        # inventories at the graph's edge.
 
1600
        key_deps = self.revisions._index._key_dependencies
 
1601
        key_deps.add_keys(present_inventories)
 
1602
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1603
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1604
        missing_texts = set()
 
1605
        for file_id, version_ids in file_ids.iteritems():
 
1606
            missing_texts.update(
 
1607
                (file_id, version_id) for version_id in version_ids)
 
1608
        present_texts = self.texts.get_parent_map(missing_texts)
 
1609
        missing_texts.difference_update(present_texts)
 
1610
        if not missing_texts:
 
1611
            # No texts are missing, so all revisions and their deltas are
 
1612
            # reconstructable.
 
1613
            return set()
 
1614
        # Alternatively the text versions could be returned as the missing
 
1615
        # keys, but this is likely to be less data.
 
1616
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1617
        return missing_keys
 
1618
 
 
1619
    def refresh_data(self):
 
1620
        """Re-read any data needed to to synchronise with disk.
 
1621
 
 
1622
        This method is intended to be called after another repository instance
 
1623
        (such as one used by a smart server) has inserted data into the
 
1624
        repository. It may not be called during a write group, but may be
 
1625
        called at any other time.
 
1626
        """
 
1627
        if self.is_in_write_group():
 
1628
            raise errors.InternalBzrError(
 
1629
                "May not refresh_data while in a write group.")
 
1630
        self._refresh_data()
 
1631
 
 
1632
    def resume_write_group(self, tokens):
 
1633
        if not self.is_write_locked():
 
1634
            raise errors.NotWriteLocked(self)
 
1635
        if self._write_group:
 
1636
            raise errors.BzrError('already in a write group')
 
1637
        self._resume_write_group(tokens)
 
1638
        # so we can detect unlock/relock - the write group is now entered.
 
1639
        self._write_group = self.get_transaction()
 
1640
 
 
1641
    def _resume_write_group(self, tokens):
 
1642
        raise errors.UnsuspendableWriteGroup(self)
 
1643
 
 
1644
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1645
            fetch_spec=None):
436
1646
        """Fetch the content required to construct revision_id from source.
437
1647
 
438
 
        If revision_id is None all content is copied.
 
1648
        If revision_id is None and fetch_spec is None, then all content is
 
1649
        copied.
 
1650
 
 
1651
        fetch() may not be used when the repository is in a write group -
 
1652
        either finish the current write group before using fetch, or use
 
1653
        fetch before starting the write group.
 
1654
 
 
1655
        :param find_ghosts: Find and copy revisions in the source that are
 
1656
            ghosts in the target (and not reachable directly by walking out to
 
1657
            the first-present revision in target from revision_id).
 
1658
        :param revision_id: If specified, all the content needed for this
 
1659
            revision ID will be copied to the target.  Fetch will determine for
 
1660
            itself which content needs to be copied.
 
1661
        :param fetch_spec: If specified, a SearchResult or
 
1662
            PendingAncestryResult that describes which revisions to copy.  This
 
1663
            allows copying multiple heads at once.  Mutually exclusive with
 
1664
            revision_id.
439
1665
        """
440
 
        revision_id = osutils.safe_revision_id(revision_id)
 
1666
        if fetch_spec is not None and revision_id is not None:
 
1667
            raise AssertionError(
 
1668
                "fetch_spec and revision_id are mutually exclusive.")
 
1669
        if self.is_in_write_group():
 
1670
            raise errors.InternalBzrError(
 
1671
                "May not fetch while in a write group.")
 
1672
        # fast path same-url fetch operations
 
1673
        # TODO: lift out to somewhere common with RemoteRepository
 
1674
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1675
        if (self.has_same_location(source)
 
1676
            and fetch_spec is None
 
1677
            and self._has_same_fallbacks(source)):
 
1678
            # check that last_revision is in 'from' and then return a
 
1679
            # no-operation.
 
1680
            if (revision_id is not None and
 
1681
                not _mod_revision.is_null(revision_id)):
 
1682
                self.get_revision(revision_id)
 
1683
            return 0, []
 
1684
        # if there is no specific appropriate InterRepository, this will get
 
1685
        # the InterRepository base class, which raises an
 
1686
        # IncompatibleRepositories when asked to fetch.
441
1687
        inter = InterRepository.get(source, self)
442
 
        try:
443
 
            return inter.fetch(revision_id=revision_id, pb=pb)
444
 
        except NotImplementedError:
445
 
            raise errors.IncompatibleRepositories(source, self)
 
1688
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1689
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
446
1690
 
447
1691
    def create_bundle(self, target, base, fileobj, format=None):
448
1692
        return serializer.write_bundle(self, target, base, fileobj, format)
449
1693
 
450
 
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
451
 
                           timezone=None, committer=None, revprops=None, 
 
1694
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
1695
                           timezone=None, committer=None, revprops=None,
452
1696
                           revision_id=None):
453
1697
        """Obtain a CommitBuilder for this repository.
454
 
        
 
1698
 
455
1699
        :param branch: Branch to commit to.
456
1700
        :param parents: Revision ids of the parents of the new revision.
457
1701
        :param config: Configuration to use.
461
1705
        :param revprops: Optional dictionary of revision properties.
462
1706
        :param revision_id: Optional revision id.
463
1707
        """
464
 
        revision_id = osutils.safe_revision_id(revision_id)
465
 
        result =_CommitBuilder(self, parents, config, timestamp, timezone,
466
 
                              committer, revprops, revision_id)
 
1708
        if self._fallback_repositories:
 
1709
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1710
                "to a stacked branch. See "
 
1711
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1712
        result = self._commit_builder_class(self, parents, config,
 
1713
            timestamp, timezone, committer, revprops, revision_id)
467
1714
        self.start_write_group()
468
1715
        return result
469
1716
 
471
1718
        if (self.control_files._lock_count == 1 and
472
1719
            self.control_files._lock_mode == 'w'):
473
1720
            if self._write_group is not None:
 
1721
                self.abort_write_group()
 
1722
                self.control_files.unlock()
474
1723
                raise errors.BzrError(
475
1724
                    'Must end write groups before releasing write locks.')
476
1725
        self.control_files.unlock()
 
1726
        if self.control_files._lock_count == 0:
 
1727
            self._inventory_entry_cache.clear()
 
1728
            for repo in self._fallback_repositories:
 
1729
                repo.unlock()
477
1730
 
478
1731
    @needs_read_lock
479
1732
    def clone(self, a_bzrdir, revision_id=None):
504
1757
 
505
1758
        :return: None.
506
1759
        """
507
 
        if not self.is_locked() or self.control_files._lock_mode != 'w':
 
1760
        if not self.is_write_locked():
508
1761
            raise errors.NotWriteLocked(self)
509
1762
        if self._write_group:
510
1763
            raise errors.BzrError('already in a write group')
514
1767
 
515
1768
    def _start_write_group(self):
516
1769
        """Template method for per-repository write group startup.
517
 
        
518
 
        This is called before the write group is considered to be 
 
1770
 
 
1771
        This is called before the write group is considered to be
519
1772
        entered.
520
1773
        """
521
1774
 
542
1795
                dest_repo = a_bzrdir.open_repository()
543
1796
        return dest_repo
544
1797
 
 
1798
    def _get_sink(self):
 
1799
        """Return a sink for streaming into this repository."""
 
1800
        return StreamSink(self)
 
1801
 
 
1802
    def _get_source(self, to_format):
 
1803
        """Return a source for streaming from this repository."""
 
1804
        return StreamSource(self, to_format)
 
1805
 
545
1806
    @needs_read_lock
546
1807
    def has_revision(self, revision_id):
547
1808
        """True if this repository has a copy of the revision."""
548
 
        if 'evil' in debug.debug_flags:
549
 
            mutter_callsite(2, "has_revision is a LBYL symptom.")
550
 
        revision_id = osutils.safe_revision_id(revision_id)
551
 
        return self._revision_store.has_revision_id(revision_id,
552
 
                                                    self.get_transaction())
 
1809
        return revision_id in self.has_revisions((revision_id,))
 
1810
 
 
1811
    @needs_read_lock
 
1812
    def has_revisions(self, revision_ids):
 
1813
        """Probe to find out the presence of multiple revisions.
 
1814
 
 
1815
        :param revision_ids: An iterable of revision_ids.
 
1816
        :return: A set of the revision_ids that were present.
 
1817
        """
 
1818
        parent_map = self.revisions.get_parent_map(
 
1819
            [(rev_id,) for rev_id in revision_ids])
 
1820
        result = set()
 
1821
        if _mod_revision.NULL_REVISION in revision_ids:
 
1822
            result.add(_mod_revision.NULL_REVISION)
 
1823
        result.update([key[0] for key in parent_map])
 
1824
        return result
 
1825
 
 
1826
    @needs_read_lock
 
1827
    def get_revision(self, revision_id):
 
1828
        """Return the Revision object for a named revision."""
 
1829
        return self.get_revisions([revision_id])[0]
553
1830
 
554
1831
    @needs_read_lock
555
1832
    def get_revision_reconcile(self, revision_id):
556
1833
        """'reconcile' helper routine that allows access to a revision always.
557
 
        
 
1834
 
558
1835
        This variant of get_revision does not cross check the weave graph
559
1836
        against the revision one as get_revision does: but it should only
560
1837
        be used by reconcile, or reconcile-alike commands that are correcting
561
1838
        or testing the revision graph.
562
1839
        """
563
 
        if not revision_id or not isinstance(revision_id, basestring):
564
 
            raise errors.InvalidRevisionId(revision_id=revision_id,
565
 
                                           branch=self)
566
 
        return self.get_revisions([revision_id])[0]
 
1840
        return self._get_revisions([revision_id])[0]
567
1841
 
568
1842
    @needs_read_lock
569
1843
    def get_revisions(self, revision_ids):
570
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
571
 
        revs = self._revision_store.get_revisions(revision_ids,
572
 
                                                  self.get_transaction())
573
 
        for rev in revs:
574
 
            assert not isinstance(rev.revision_id, unicode)
575
 
            for parent_id in rev.parent_ids:
576
 
                assert not isinstance(parent_id, unicode)
577
 
        return revs
 
1844
        """Get many revisions at once.
 
1845
        
 
1846
        Repositories that need to check data on every revision read should 
 
1847
        subclass this method.
 
1848
        """
 
1849
        return self._get_revisions(revision_ids)
 
1850
 
 
1851
    @needs_read_lock
 
1852
    def _get_revisions(self, revision_ids):
 
1853
        """Core work logic to get many revisions without sanity checks."""
 
1854
        revs = {}
 
1855
        for revid, rev in self._iter_revisions(revision_ids):
 
1856
            if rev is None:
 
1857
                raise errors.NoSuchRevision(self, revid)
 
1858
            revs[revid] = rev
 
1859
        return [revs[revid] for revid in revision_ids]
 
1860
 
 
1861
    def _iter_revisions(self, revision_ids):
 
1862
        """Iterate over revision objects.
 
1863
 
 
1864
        :param revision_ids: An iterable of revisions to examine. None may be
 
1865
            passed to request all revisions known to the repository. Note that
 
1866
            not all repositories can find unreferenced revisions; for those
 
1867
            repositories only referenced ones will be returned.
 
1868
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1869
            those asked for but not available) are returned as (revid, None).
 
1870
        """
 
1871
        if revision_ids is None:
 
1872
            revision_ids = self.all_revision_ids()
 
1873
        else:
 
1874
            for rev_id in revision_ids:
 
1875
                if not rev_id or not isinstance(rev_id, basestring):
 
1876
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1877
        keys = [(key,) for key in revision_ids]
 
1878
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
 
1879
        for record in stream:
 
1880
            revid = record.key[0]
 
1881
            if record.storage_kind == 'absent':
 
1882
                yield (revid, None)
 
1883
            else:
 
1884
                text = record.get_bytes_as('fulltext')
 
1885
                rev = self._serializer.read_revision_from_string(text)
 
1886
                yield (revid, rev)
578
1887
 
579
1888
    @needs_read_lock
580
1889
    def get_revision_xml(self, revision_id):
581
1890
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
582
1891
        #       would have already do it.
583
1892
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
584
 
        revision_id = osutils.safe_revision_id(revision_id)
 
1893
        # TODO: this can't just be replaced by:
 
1894
        # return self._serializer.write_revision_to_string(
 
1895
        #     self.get_revision(revision_id))
 
1896
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1897
        # or some other call down the path.
585
1898
        rev = self.get_revision(revision_id)
586
 
        rev_tmp = StringIO()
 
1899
        rev_tmp = cStringIO.StringIO()
587
1900
        # the current serializer..
588
 
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1901
        self._serializer.write_revision(rev, rev_tmp)
589
1902
        rev_tmp.seek(0)
590
1903
        return rev_tmp.getvalue()
591
1904
 
592
 
    @needs_read_lock
593
 
    def get_revision(self, revision_id):
594
 
        """Return the Revision object for a named revision"""
595
 
        # TODO: jam 20070210 get_revision_reconcile should do this for us
596
 
        revision_id = osutils.safe_revision_id(revision_id)
597
 
        r = self.get_revision_reconcile(revision_id)
598
 
        # weave corruption can lead to absent revision markers that should be
599
 
        # present.
600
 
        # the following test is reasonably cheap (it needs a single weave read)
601
 
        # and the weave is cached in read transactions. In write transactions
602
 
        # it is not cached but typically we only read a small number of
603
 
        # revisions. For knits when they are introduced we will probably want
604
 
        # to ensure that caching write transactions are in use.
605
 
        inv = self.get_inventory_weave()
606
 
        self._check_revision_parents(r, inv)
607
 
        return r
608
 
 
609
 
    @needs_read_lock
610
 
    def get_deltas_for_revisions(self, revisions):
 
1905
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
611
1906
        """Produce a generator of revision deltas.
612
 
        
 
1907
 
613
1908
        Note that the input is a sequence of REVISIONS, not revision_ids.
614
1909
        Trees will be held in memory until the generator exits.
615
1910
        Each delta is relative to the revision's lefthand predecessor.
 
1911
 
 
1912
        :param specific_fileids: if not None, the result is filtered
 
1913
          so that only those file-ids, their parents and their
 
1914
          children are included.
616
1915
        """
 
1916
        # Get the revision-ids of interest
617
1917
        required_trees = set()
618
1918
        for revision in revisions:
619
1919
            required_trees.add(revision.revision_id)
620
1920
            required_trees.update(revision.parent_ids[:1])
621
 
        trees = dict((t.get_revision_id(), t) for 
622
 
                     t in self.revision_trees(required_trees))
 
1921
 
 
1922
        # Get the matching filtered trees. Note that it's more
 
1923
        # efficient to pass filtered trees to changes_from() rather
 
1924
        # than doing the filtering afterwards. changes_from() could
 
1925
        # arguably do the filtering itself but it's path-based, not
 
1926
        # file-id based, so filtering before or afterwards is
 
1927
        # currently easier.
 
1928
        if specific_fileids is None:
 
1929
            trees = dict((t.get_revision_id(), t) for
 
1930
                t in self.revision_trees(required_trees))
 
1931
        else:
 
1932
            trees = dict((t.get_revision_id(), t) for
 
1933
                t in self._filtered_revision_trees(required_trees,
 
1934
                specific_fileids))
 
1935
 
 
1936
        # Calculate the deltas
623
1937
        for revision in revisions:
624
1938
            if not revision.parent_ids:
625
 
                old_tree = self.revision_tree(None)
 
1939
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
626
1940
            else:
627
1941
                old_tree = trees[revision.parent_ids[0]]
628
1942
            yield trees[revision.revision_id].changes_from(old_tree)
629
1943
 
630
1944
    @needs_read_lock
631
 
    def get_revision_delta(self, revision_id):
 
1945
    def get_revision_delta(self, revision_id, specific_fileids=None):
632
1946
        """Return the delta for one revision.
633
1947
 
634
1948
        The delta is relative to the left-hand predecessor of the
635
1949
        revision.
 
1950
 
 
1951
        :param specific_fileids: if not None, the result is filtered
 
1952
          so that only those file-ids, their parents and their
 
1953
          children are included.
636
1954
        """
637
1955
        r = self.get_revision(revision_id)
638
 
        return list(self.get_deltas_for_revisions([r]))[0]
639
 
 
640
 
    def _check_revision_parents(self, revision, inventory):
641
 
        """Private to Repository and Fetch.
642
 
        
643
 
        This checks the parentage of revision in an inventory weave for 
644
 
        consistency and is only applicable to inventory-weave-for-ancestry
645
 
        using repository formats & fetchers.
646
 
        """
647
 
        weave_parents = inventory.get_parents(revision.revision_id)
648
 
        weave_names = inventory.versions()
649
 
        for parent_id in revision.parent_ids:
650
 
            if parent_id in weave_names:
651
 
                # this parent must not be a ghost.
652
 
                if not parent_id in weave_parents:
653
 
                    # but it is a ghost
654
 
                    raise errors.CorruptRepository(self)
 
1956
        return list(self.get_deltas_for_revisions([r],
 
1957
            specific_fileids=specific_fileids))[0]
655
1958
 
656
1959
    @needs_write_lock
657
1960
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
658
 
        revision_id = osutils.safe_revision_id(revision_id)
659
1961
        signature = gpg_strategy.sign(plaintext)
660
 
        self._revision_store.add_revision_signature_text(revision_id,
661
 
                                                         signature,
662
 
                                                         self.get_transaction())
663
 
 
664
 
    def fileids_altered_by_revision_ids(self, revision_ids):
665
 
        """Find the file ids and versions affected by revisions.
666
 
 
667
 
        :param revisions: an iterable containing revision ids.
668
 
        :return: a dictionary mapping altered file-ids to an iterable of
669
 
        revision_ids. Each altered file-ids has the exact revision_ids that
670
 
        altered it listed explicitly.
671
 
        """
672
 
        assert self._serializer.support_altered_by_hack, \
673
 
            ("fileids_altered_by_revision_ids only supported for branches " 
674
 
             "which store inventory as unnested xml, not on %r" % self)
675
 
        selected_revision_ids = set(osutils.safe_revision_id(r)
676
 
                                    for r in revision_ids)
677
 
        w = self.get_inventory_weave()
 
1962
        self.add_signature_text(revision_id, signature)
 
1963
 
 
1964
    @needs_write_lock
 
1965
    def add_signature_text(self, revision_id, signature):
 
1966
        self.signatures.add_lines((revision_id,), (),
 
1967
            osutils.split_lines(signature))
 
1968
 
 
1969
    def find_text_key_references(self):
 
1970
        """Find the text key references within the repository.
 
1971
 
 
1972
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1973
            to whether they were referred to by the inventory of the
 
1974
            revision_id that they contain. The inventory texts from all present
 
1975
            revision ids are assessed to generate this report.
 
1976
        """
 
1977
        revision_keys = self.revisions.keys()
 
1978
        w = self.inventories
 
1979
        pb = ui.ui_factory.nested_progress_bar()
 
1980
        try:
 
1981
            return self._find_text_key_references_from_xml_inventory_lines(
 
1982
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1983
        finally:
 
1984
            pb.finished()
 
1985
 
 
1986
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1987
        line_iterator):
 
1988
        """Core routine for extracting references to texts from inventories.
 
1989
 
 
1990
        This performs the translation of xml lines to revision ids.
 
1991
 
 
1992
        :param line_iterator: An iterator of lines, origin_version_id
 
1993
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1994
            to whether they were referred to by the inventory of the
 
1995
            revision_id that they contain. Note that if that revision_id was
 
1996
            not part of the line_iterator's output then False will be given -
 
1997
            even though it may actually refer to that key.
 
1998
        """
 
1999
        if not self._serializer.support_altered_by_hack:
 
2000
            raise AssertionError(
 
2001
                "_find_text_key_references_from_xml_inventory_lines only "
 
2002
                "supported for branches which store inventory as unnested xml"
 
2003
                ", not on %r" % self)
678
2004
        result = {}
679
2005
 
680
2006
        # this code needs to read every new line in every inventory for the
681
2007
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
682
 
        # not present in one of those inventories is unnecessary but not 
 
2008
        # not present in one of those inventories is unnecessary but not
683
2009
        # harmful because we are filtering by the revision id marker in the
684
 
        # inventory lines : we only select file ids altered in one of those  
 
2010
        # inventory lines : we only select file ids altered in one of those
685
2011
        # revisions. We don't need to see all lines in the inventory because
686
2012
        # only those added in an inventory in rev X can contain a revision=X
687
2013
        # line.
696
2022
        search = self._file_ids_altered_regex.search
697
2023
        unescape = _unescape_xml
698
2024
        setdefault = result.setdefault
 
2025
        for line, line_key in line_iterator:
 
2026
            match = search(line)
 
2027
            if match is None:
 
2028
                continue
 
2029
            # One call to match.group() returning multiple items is quite a
 
2030
            # bit faster than 2 calls to match.group() each returning 1
 
2031
            file_id, revision_id = match.group('file_id', 'revision_id')
 
2032
 
 
2033
            # Inlining the cache lookups helps a lot when you make 170,000
 
2034
            # lines and 350k ids, versus 8.4 unique ids.
 
2035
            # Using a cache helps in 2 ways:
 
2036
            #   1) Avoids unnecessary decoding calls
 
2037
            #   2) Re-uses cached strings, which helps in future set and
 
2038
            #      equality checks.
 
2039
            # (2) is enough that removing encoding entirely along with
 
2040
            # the cache (so we are using plain strings) results in no
 
2041
            # performance improvement.
 
2042
            try:
 
2043
                revision_id = unescape_revid_cache[revision_id]
 
2044
            except KeyError:
 
2045
                unescaped = unescape(revision_id)
 
2046
                unescape_revid_cache[revision_id] = unescaped
 
2047
                revision_id = unescaped
 
2048
 
 
2049
            # Note that unconditionally unescaping means that we deserialise
 
2050
            # every fileid, which for general 'pull' is not great, but we don't
 
2051
            # really want to have some many fulltexts that this matters anyway.
 
2052
            # RBC 20071114.
 
2053
            try:
 
2054
                file_id = unescape_fileid_cache[file_id]
 
2055
            except KeyError:
 
2056
                unescaped = unescape(file_id)
 
2057
                unescape_fileid_cache[file_id] = unescaped
 
2058
                file_id = unescaped
 
2059
 
 
2060
            key = (file_id, revision_id)
 
2061
            setdefault(key, False)
 
2062
            if revision_id == line_key[-1]:
 
2063
                result[key] = True
 
2064
        return result
 
2065
 
 
2066
    def _inventory_xml_lines_for_keys(self, keys):
 
2067
        """Get a line iterator of the sort needed for findind references.
 
2068
 
 
2069
        Not relevant for non-xml inventory repositories.
 
2070
 
 
2071
        Ghosts in revision_keys are ignored.
 
2072
 
 
2073
        :param revision_keys: The revision keys for the inventories to inspect.
 
2074
        :return: An iterator over (inventory line, revid) for the fulltexts of
 
2075
            all of the xml inventories specified by revision_keys.
 
2076
        """
 
2077
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2078
        for record in stream:
 
2079
            if record.storage_kind != 'absent':
 
2080
                chunks = record.get_bytes_as('chunked')
 
2081
                revid = record.key[-1]
 
2082
                lines = osutils.chunks_to_lines(chunks)
 
2083
                for line in lines:
 
2084
                    yield line, revid
 
2085
 
 
2086
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
2087
        revision_keys):
 
2088
        """Helper routine for fileids_altered_by_revision_ids.
 
2089
 
 
2090
        This performs the translation of xml lines to revision ids.
 
2091
 
 
2092
        :param line_iterator: An iterator of lines, origin_version_id
 
2093
        :param revision_keys: The revision ids to filter for. This should be a
 
2094
            set or other type which supports efficient __contains__ lookups, as
 
2095
            the revision key from each parsed line will be looked up in the
 
2096
            revision_keys filter.
 
2097
        :return: a dictionary mapping altered file-ids to an iterable of
 
2098
        revision_ids. Each altered file-ids has the exact revision_ids that
 
2099
        altered it listed explicitly.
 
2100
        """
 
2101
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2102
                line_iterator).iterkeys())
 
2103
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
2104
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2105
            self._inventory_xml_lines_for_keys(parent_keys)))
 
2106
        new_keys = seen - parent_seen
 
2107
        result = {}
 
2108
        setdefault = result.setdefault
 
2109
        for key in new_keys:
 
2110
            setdefault(key[0], set()).add(key[-1])
 
2111
        return result
 
2112
 
 
2113
    def _find_parent_ids_of_revisions(self, revision_ids):
 
2114
        """Find all parent ids that are mentioned in the revision graph.
 
2115
 
 
2116
        :return: set of revisions that are parents of revision_ids which are
 
2117
            not part of revision_ids themselves
 
2118
        """
 
2119
        parent_map = self.get_parent_map(revision_ids)
 
2120
        parent_ids = set()
 
2121
        map(parent_ids.update, parent_map.itervalues())
 
2122
        parent_ids.difference_update(revision_ids)
 
2123
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
2124
        return parent_ids
 
2125
 
 
2126
    def _find_parent_keys_of_revisions(self, revision_keys):
 
2127
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
2128
 
 
2129
        :param revision_keys: An iterable of revision_keys.
 
2130
        :return: The parents of all revision_keys that are not already in
 
2131
            revision_keys
 
2132
        """
 
2133
        parent_map = self.revisions.get_parent_map(revision_keys)
 
2134
        parent_keys = set()
 
2135
        map(parent_keys.update, parent_map.itervalues())
 
2136
        parent_keys.difference_update(revision_keys)
 
2137
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
2138
        return parent_keys
 
2139
 
 
2140
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
 
2141
        """Find the file ids and versions affected by revisions.
 
2142
 
 
2143
        :param revisions: an iterable containing revision ids.
 
2144
        :param _inv_weave: The inventory weave from this repository or None.
 
2145
            If None, the inventory weave will be opened automatically.
 
2146
        :return: a dictionary mapping altered file-ids to an iterable of
 
2147
        revision_ids. Each altered file-ids has the exact revision_ids that
 
2148
        altered it listed explicitly.
 
2149
        """
 
2150
        selected_keys = set((revid,) for revid in revision_ids)
 
2151
        w = _inv_weave or self.inventories
699
2152
        pb = ui.ui_factory.nested_progress_bar()
700
2153
        try:
701
 
            for line in w.iter_lines_added_or_present_in_versions(
702
 
                                        selected_revision_ids, pb=pb):
703
 
                match = search(line)
704
 
                if match is None:
705
 
                    continue
706
 
                # One call to match.group() returning multiple items is quite a
707
 
                # bit faster than 2 calls to match.group() each returning 1
708
 
                file_id, revision_id = match.group('file_id', 'revision_id')
709
 
 
710
 
                # Inlining the cache lookups helps a lot when you make 170,000
711
 
                # lines and 350k ids, versus 8.4 unique ids.
712
 
                # Using a cache helps in 2 ways:
713
 
                #   1) Avoids unnecessary decoding calls
714
 
                #   2) Re-uses cached strings, which helps in future set and
715
 
                #      equality checks.
716
 
                # (2) is enough that removing encoding entirely along with
717
 
                # the cache (so we are using plain strings) results in no
718
 
                # performance improvement.
719
 
                try:
720
 
                    revision_id = unescape_revid_cache[revision_id]
721
 
                except KeyError:
722
 
                    unescaped = unescape(revision_id)
723
 
                    unescape_revid_cache[revision_id] = unescaped
724
 
                    revision_id = unescaped
725
 
 
726
 
                if revision_id in selected_revision_ids:
727
 
                    try:
728
 
                        file_id = unescape_fileid_cache[file_id]
729
 
                    except KeyError:
730
 
                        unescaped = unescape(file_id)
731
 
                        unescape_fileid_cache[file_id] = unescaped
732
 
                        file_id = unescaped
733
 
                    setdefault(file_id, set()).add(revision_id)
 
2154
            return self._find_file_ids_from_xml_inventory_lines(
 
2155
                w.iter_lines_added_or_present_in_keys(
 
2156
                    selected_keys, pb=pb),
 
2157
                selected_keys)
734
2158
        finally:
735
2159
            pb.finished()
736
 
        return result
737
2160
 
738
2161
    def iter_files_bytes(self, desired_files):
739
2162
        """Iterate through file versions.
748
2171
 
749
2172
        bytes_iterator is an iterable of bytestrings for the file.  The
750
2173
        kind of iterable and length of the bytestrings are unspecified, but for
751
 
        this implementation, it is a list of lines produced by
752
 
        VersionedFile.get_lines().
 
2174
        this implementation, it is a list of bytes produced by
 
2175
        VersionedFile.get_record_stream().
753
2176
 
754
2177
        :param desired_files: a list of (file_id, revision_id, identifier)
755
2178
            triples
756
2179
        """
757
 
        transaction = self.get_transaction()
 
2180
        text_keys = {}
758
2181
        for file_id, revision_id, callable_data in desired_files:
759
 
            try:
760
 
                weave = self.weave_store.get_weave(file_id, transaction)
761
 
            except errors.NoSuchFile:
762
 
                raise errors.NoSuchIdInRepository(self, file_id)
763
 
            yield callable_data, weave.get_lines(revision_id)
 
2182
            text_keys[(file_id, revision_id)] = callable_data
 
2183
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
 
2184
            if record.storage_kind == 'absent':
 
2185
                raise errors.RevisionNotPresent(record.key, self)
 
2186
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
2187
 
 
2188
    def _generate_text_key_index(self, text_key_references=None,
 
2189
        ancestors=None):
 
2190
        """Generate a new text key index for the repository.
 
2191
 
 
2192
        This is an expensive function that will take considerable time to run.
 
2193
 
 
2194
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
2195
            list of parents, also text keys. When a given key has no parents,
 
2196
            the parents list will be [NULL_REVISION].
 
2197
        """
 
2198
        # All revisions, to find inventory parents.
 
2199
        if ancestors is None:
 
2200
            graph = self.get_graph()
 
2201
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
2202
        if text_key_references is None:
 
2203
            text_key_references = self.find_text_key_references()
 
2204
        pb = ui.ui_factory.nested_progress_bar()
 
2205
        try:
 
2206
            return self._do_generate_text_key_index(ancestors,
 
2207
                text_key_references, pb)
 
2208
        finally:
 
2209
            pb.finished()
 
2210
 
 
2211
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
2212
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
2213
        revision_order = tsort.topo_sort(ancestors)
 
2214
        invalid_keys = set()
 
2215
        revision_keys = {}
 
2216
        for revision_id in revision_order:
 
2217
            revision_keys[revision_id] = set()
 
2218
        text_count = len(text_key_references)
 
2219
        # a cache of the text keys to allow reuse; costs a dict of all the
 
2220
        # keys, but saves a 2-tuple for every child of a given key.
 
2221
        text_key_cache = {}
 
2222
        for text_key, valid in text_key_references.iteritems():
 
2223
            if not valid:
 
2224
                invalid_keys.add(text_key)
 
2225
            else:
 
2226
                revision_keys[text_key[1]].add(text_key)
 
2227
            text_key_cache[text_key] = text_key
 
2228
        del text_key_references
 
2229
        text_index = {}
 
2230
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
2231
        NULL_REVISION = _mod_revision.NULL_REVISION
 
2232
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
2233
        # too small for large or very branchy trees. However, for 55K path
 
2234
        # trees, it would be easy to use too much memory trivially. Ideally we
 
2235
        # could gauge this by looking at available real memory etc, but this is
 
2236
        # always a tricky proposition.
 
2237
        inventory_cache = lru_cache.LRUCache(10)
 
2238
        batch_size = 10 # should be ~150MB on a 55K path tree
 
2239
        batch_count = len(revision_order) / batch_size + 1
 
2240
        processed_texts = 0
 
2241
        pb.update("Calculating text parents", processed_texts, text_count)
 
2242
        for offset in xrange(batch_count):
 
2243
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
2244
                batch_size]
 
2245
            if not to_query:
 
2246
                break
 
2247
            for revision_id in to_query:
 
2248
                parent_ids = ancestors[revision_id]
 
2249
                for text_key in revision_keys[revision_id]:
 
2250
                    pb.update("Calculating text parents", processed_texts)
 
2251
                    processed_texts += 1
 
2252
                    candidate_parents = []
 
2253
                    for parent_id in parent_ids:
 
2254
                        parent_text_key = (text_key[0], parent_id)
 
2255
                        try:
 
2256
                            check_parent = parent_text_key not in \
 
2257
                                revision_keys[parent_id]
 
2258
                        except KeyError:
 
2259
                            # the parent parent_id is a ghost:
 
2260
                            check_parent = False
 
2261
                            # truncate the derived graph against this ghost.
 
2262
                            parent_text_key = None
 
2263
                        if check_parent:
 
2264
                            # look at the parent commit details inventories to
 
2265
                            # determine possible candidates in the per file graph.
 
2266
                            # TODO: cache here.
 
2267
                            try:
 
2268
                                inv = inventory_cache[parent_id]
 
2269
                            except KeyError:
 
2270
                                inv = self.revision_tree(parent_id).inventory
 
2271
                                inventory_cache[parent_id] = inv
 
2272
                            try:
 
2273
                                parent_entry = inv[text_key[0]]
 
2274
                            except (KeyError, errors.NoSuchId):
 
2275
                                parent_entry = None
 
2276
                            if parent_entry is not None:
 
2277
                                parent_text_key = (
 
2278
                                    text_key[0], parent_entry.revision)
 
2279
                            else:
 
2280
                                parent_text_key = None
 
2281
                        if parent_text_key is not None:
 
2282
                            candidate_parents.append(
 
2283
                                text_key_cache[parent_text_key])
 
2284
                    parent_heads = text_graph.heads(candidate_parents)
 
2285
                    new_parents = list(parent_heads)
 
2286
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
2287
                    if new_parents == []:
 
2288
                        new_parents = [NULL_REVISION]
 
2289
                    text_index[text_key] = new_parents
 
2290
 
 
2291
        for text_key in invalid_keys:
 
2292
            text_index[text_key] = [NULL_REVISION]
 
2293
        return text_index
764
2294
 
765
2295
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
766
2296
        """Get an iterable listing the keys of all the data introduced by a set
773
2303
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
774
2304
            'revisions'.  file-id is None unless knit-kind is 'file'.
775
2305
        """
 
2306
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
 
2307
            yield result
 
2308
        del _files_pb
 
2309
        for result in self._find_non_file_keys_to_fetch(revision_ids):
 
2310
            yield result
 
2311
 
 
2312
    def _find_file_keys_to_fetch(self, revision_ids, pb):
776
2313
        # XXX: it's a bit weird to control the inventory weave caching in this
777
2314
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
778
2315
        # maybe this generator should explicitly have the contract that it
779
2316
        # should not be iterated until the previously yielded item has been
780
2317
        # processed?
781
 
        inv_w = self.get_inventory_weave()
782
 
        inv_w.enable_cache()
 
2318
        inv_w = self.inventories
783
2319
 
784
2320
        # file ids that changed
785
 
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
 
2321
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
786
2322
        count = 0
787
2323
        num_file_ids = len(file_ids)
788
2324
        for file_id, altered_versions in file_ids.iteritems():
789
 
            if _files_pb is not None:
790
 
                _files_pb.update("fetch texts", count, num_file_ids)
 
2325
            if pb is not None:
 
2326
                pb.update("fetch texts", count, num_file_ids)
791
2327
            count += 1
792
2328
            yield ("file", file_id, altered_versions)
793
 
        # We're done with the files_pb.  Note that it finished by the caller,
794
 
        # just as it was created by the caller.
795
 
        del _files_pb
796
2329
 
 
2330
    def _find_non_file_keys_to_fetch(self, revision_ids):
797
2331
        # inventory
798
2332
        yield ("inventory", None, revision_ids)
799
 
        inv_w.clear_cache()
800
2333
 
801
2334
        # signatures
802
 
        revisions_with_signatures = set()
803
 
        for rev_id in revision_ids:
804
 
            try:
805
 
                self.get_signature_text(rev_id)
806
 
            except errors.NoSuchRevision:
807
 
                # not signed.
808
 
                pass
809
 
            else:
810
 
                revisions_with_signatures.add(rev_id)
 
2335
        # XXX: Note ATM no callers actually pay attention to this return
 
2336
        #      instead they just use the list of revision ids and ignore
 
2337
        #      missing sigs. Consider removing this work entirely
 
2338
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
2339
            [(r,) for r in revision_ids]))
 
2340
        revisions_with_signatures = set(
 
2341
            [r for (r,) in revisions_with_signatures])
 
2342
        revisions_with_signatures.intersection_update(revision_ids)
811
2343
        yield ("signatures", None, revisions_with_signatures)
812
2344
 
813
2345
        # revisions
814
2346
        yield ("revisions", None, revision_ids)
815
2347
 
816
2348
    @needs_read_lock
817
 
    def get_inventory_weave(self):
818
 
        return self.control_weaves.get_weave('inventory',
819
 
            self.get_transaction())
820
 
 
821
 
    @needs_read_lock
822
2349
    def get_inventory(self, revision_id):
823
 
        """Get Inventory object by hash."""
824
 
        # TODO: jam 20070210 Technically we don't need to sanitize, since all
825
 
        #       called functions must sanitize.
826
 
        revision_id = osutils.safe_revision_id(revision_id)
827
 
        return self.deserialise_inventory(
828
 
            revision_id, self.get_inventory_xml(revision_id))
 
2350
        """Get Inventory object by revision id."""
 
2351
        return self.iter_inventories([revision_id]).next()
 
2352
 
 
2353
    def iter_inventories(self, revision_ids, ordering=None):
 
2354
        """Get many inventories by revision_ids.
 
2355
 
 
2356
        This will buffer some or all of the texts used in constructing the
 
2357
        inventories in memory, but will only parse a single inventory at a
 
2358
        time.
 
2359
 
 
2360
        :param revision_ids: The expected revision ids of the inventories.
 
2361
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2362
            specified, the order of revision_ids will be preserved (by
 
2363
            buffering if necessary).
 
2364
        :return: An iterator of inventories.
 
2365
        """
 
2366
        if ((None in revision_ids)
 
2367
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
2368
            raise ValueError('cannot get null revision inventory')
 
2369
        return self._iter_inventories(revision_ids, ordering)
 
2370
 
 
2371
    def _iter_inventories(self, revision_ids, ordering):
 
2372
        """single-document based inventory iteration."""
 
2373
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2374
        for text, revision_id in inv_xmls:
 
2375
            yield self.deserialise_inventory(revision_id, text)
 
2376
 
 
2377
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2378
        if ordering is None:
 
2379
            order_as_requested = True
 
2380
            ordering = 'unordered'
 
2381
        else:
 
2382
            order_as_requested = False
 
2383
        keys = [(revision_id,) for revision_id in revision_ids]
 
2384
        if not keys:
 
2385
            return
 
2386
        if order_as_requested:
 
2387
            key_iter = iter(keys)
 
2388
            next_key = key_iter.next()
 
2389
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2390
        text_chunks = {}
 
2391
        for record in stream:
 
2392
            if record.storage_kind != 'absent':
 
2393
                chunks = record.get_bytes_as('chunked')
 
2394
                if order_as_requested:
 
2395
                    text_chunks[record.key] = chunks
 
2396
                else:
 
2397
                    yield ''.join(chunks), record.key[-1]
 
2398
            else:
 
2399
                raise errors.NoSuchRevision(self, record.key)
 
2400
            if order_as_requested:
 
2401
                # Yield as many results as we can while preserving order.
 
2402
                while next_key in text_chunks:
 
2403
                    chunks = text_chunks.pop(next_key)
 
2404
                    yield ''.join(chunks), next_key[-1]
 
2405
                    try:
 
2406
                        next_key = key_iter.next()
 
2407
                    except StopIteration:
 
2408
                        # We still want to fully consume the get_record_stream,
 
2409
                        # just in case it is not actually finished at this point
 
2410
                        next_key = None
 
2411
                        break
829
2412
 
830
2413
    def deserialise_inventory(self, revision_id, xml):
831
 
        """Transform the xml into an inventory object. 
 
2414
        """Transform the xml into an inventory object.
832
2415
 
833
2416
        :param revision_id: The expected revision id of the inventory.
834
2417
        :param xml: A serialised inventory.
835
2418
        """
836
 
        revision_id = osutils.safe_revision_id(revision_id)
837
 
        result = self._serializer.read_inventory_from_string(xml)
838
 
        result.root.revision = revision_id
 
2419
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
2420
                    entry_cache=self._inventory_entry_cache)
 
2421
        if result.revision_id != revision_id:
 
2422
            raise AssertionError('revision id mismatch %s != %s' % (
 
2423
                result.revision_id, revision_id))
839
2424
        return result
840
2425
 
841
2426
    def serialise_inventory(self, inv):
842
2427
        return self._serializer.write_inventory_to_string(inv)
843
2428
 
 
2429
    def _serialise_inventory_to_lines(self, inv):
 
2430
        return self._serializer.write_inventory_to_lines(inv)
 
2431
 
844
2432
    def get_serializer_format(self):
845
2433
        return self._serializer.format_num
846
2434
 
847
2435
    @needs_read_lock
848
2436
    def get_inventory_xml(self, revision_id):
849
2437
        """Get inventory XML as a file object."""
850
 
        revision_id = osutils.safe_revision_id(revision_id)
 
2438
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
851
2439
        try:
852
 
            assert isinstance(revision_id, str), type(revision_id)
853
 
            iw = self.get_inventory_weave()
854
 
            return iw.get_text(revision_id)
855
 
        except IndexError:
 
2440
            text, revision_id = texts.next()
 
2441
        except StopIteration:
856
2442
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
2443
        return text
857
2444
 
858
2445
    @needs_read_lock
859
2446
    def get_inventory_sha1(self, revision_id):
860
2447
        """Return the sha1 hash of the inventory entry
861
2448
        """
862
 
        # TODO: jam 20070210 Shouldn't this be deprecated / removed?
863
 
        revision_id = osutils.safe_revision_id(revision_id)
864
2449
        return self.get_revision(revision_id).inventory_sha1
865
2450
 
866
 
    @needs_read_lock
867
 
    def get_revision_graph(self, revision_id=None):
868
 
        """Return a dictionary containing the revision graph.
869
 
        
870
 
        :param revision_id: The revision_id to get a graph from. If None, then
871
 
        the entire revision graph is returned. This is a deprecated mode of
872
 
        operation and will be removed in the future.
873
 
        :return: a dictionary of revision_id->revision_parents_list.
874
 
        """
875
 
        if 'evil' in debug.debug_flags:
876
 
            mutter_callsite(2,
877
 
                "get_revision_graph scales with size of history.")
878
 
        # special case NULL_REVISION
879
 
        if revision_id == _mod_revision.NULL_REVISION:
880
 
            return {}
881
 
        revision_id = osutils.safe_revision_id(revision_id)
882
 
        a_weave = self.get_inventory_weave()
883
 
        all_revisions = self._eliminate_revisions_not_present(
884
 
                                a_weave.versions())
885
 
        entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for 
886
 
                             node in all_revisions])
887
 
        if revision_id is None:
888
 
            return entire_graph
889
 
        elif revision_id not in entire_graph:
890
 
            raise errors.NoSuchRevision(self, revision_id)
891
 
        else:
892
 
            # add what can be reached from revision_id
893
 
            result = {}
894
 
            pending = set([revision_id])
895
 
            while len(pending) > 0:
896
 
                node = pending.pop()
897
 
                result[node] = entire_graph[node]
898
 
                for revision_id in result[node]:
899
 
                    if revision_id not in result:
900
 
                        pending.add(revision_id)
901
 
            return result
902
 
 
903
 
    @needs_read_lock
904
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
905
 
        """Return a graph of the revisions with ghosts marked as applicable.
906
 
 
907
 
        :param revision_ids: an iterable of revisions to graph or None for all.
908
 
        :return: a Graph object with the graph reachable from revision_ids.
909
 
        """
910
 
        if 'evil' in debug.debug_flags:
911
 
            mutter_callsite(2,
912
 
                "get_revision_graph_with_ghosts scales with size of history.")
913
 
        result = deprecated_graph.Graph()
914
 
        if not revision_ids:
915
 
            pending = set(self.all_revision_ids())
916
 
            required = set([])
917
 
        else:
918
 
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
919
 
            # special case NULL_REVISION
920
 
            if _mod_revision.NULL_REVISION in pending:
921
 
                pending.remove(_mod_revision.NULL_REVISION)
922
 
            required = set(pending)
923
 
        done = set([])
924
 
        while len(pending):
925
 
            revision_id = pending.pop()
926
 
            try:
927
 
                rev = self.get_revision(revision_id)
928
 
            except errors.NoSuchRevision:
929
 
                if revision_id in required:
930
 
                    raise
931
 
                # a ghost
932
 
                result.add_ghost(revision_id)
933
 
                continue
934
 
            for parent_id in rev.parent_ids:
935
 
                # is this queued or done ?
936
 
                if (parent_id not in pending and
937
 
                    parent_id not in done):
938
 
                    # no, queue it.
939
 
                    pending.add(parent_id)
940
 
            result.add_node(revision_id, rev.parent_ids)
941
 
            done.add(revision_id)
942
 
        return result
943
 
 
944
 
    def _get_history_vf(self):
945
 
        """Get a versionedfile whose history graph reflects all revisions.
946
 
 
947
 
        For weave repositories, this is the inventory weave.
948
 
        """
949
 
        return self.get_inventory_weave()
 
2451
    def get_rev_id_for_revno(self, revno, known_pair):
 
2452
        """Return the revision id of a revno, given a later (revno, revid)
 
2453
        pair in the same history.
 
2454
 
 
2455
        :return: if found (True, revid).  If the available history ran out
 
2456
            before reaching the revno, then this returns
 
2457
            (False, (closest_revno, closest_revid)).
 
2458
        """
 
2459
        known_revno, known_revid = known_pair
 
2460
        partial_history = [known_revid]
 
2461
        distance_from_known = known_revno - revno
 
2462
        if distance_from_known < 0:
 
2463
            raise ValueError(
 
2464
                'requested revno (%d) is later than given known revno (%d)'
 
2465
                % (revno, known_revno))
 
2466
        try:
 
2467
            _iter_for_revno(
 
2468
                self, partial_history, stop_index=distance_from_known)
 
2469
        except errors.RevisionNotPresent, err:
 
2470
            if err.revision_id == known_revid:
 
2471
                # The start revision (known_revid) wasn't found.
 
2472
                raise
 
2473
            # This is a stacked repository with no fallbacks, or a there's a
 
2474
            # left-hand ghost.  Either way, even though the revision named in
 
2475
            # the error isn't in this repo, we know it's the next step in this
 
2476
            # left-hand history.
 
2477
            partial_history.append(err.revision_id)
 
2478
        if len(partial_history) <= distance_from_known:
 
2479
            # Didn't find enough history to get a revid for the revno.
 
2480
            earliest_revno = known_revno - len(partial_history) + 1
 
2481
            return (False, (earliest_revno, partial_history[-1]))
 
2482
        if len(partial_history) - 1 > distance_from_known:
 
2483
            raise AssertionError('_iter_for_revno returned too much history')
 
2484
        return (True, partial_history[-1])
950
2485
 
951
2486
    def iter_reverse_revision_history(self, revision_id):
952
2487
        """Iterate backwards through revision ids in the lefthand history
954
2489
        :param revision_id: The revision id to start with.  All its lefthand
955
2490
            ancestors will be traversed.
956
2491
        """
957
 
        revision_id = osutils.safe_revision_id(revision_id)
958
 
        if revision_id in (None, _mod_revision.NULL_REVISION):
959
 
            return
 
2492
        graph = self.get_graph()
960
2493
        next_id = revision_id
961
 
        versionedfile = self._get_history_vf()
962
2494
        while True:
 
2495
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2496
                return
 
2497
            try:
 
2498
                parents = graph.get_parent_map([next_id])[next_id]
 
2499
            except KeyError:
 
2500
                raise errors.RevisionNotPresent(next_id, self)
963
2501
            yield next_id
964
 
            parents = versionedfile.get_parents(next_id)
965
2502
            if len(parents) == 0:
966
2503
                return
967
2504
            else:
983
2520
        else:
984
2521
            return self.get_inventory(revision_id)
985
2522
 
986
 
    @needs_read_lock
987
2523
    def is_shared(self):
988
2524
        """Return True if this repository is flagged as a shared repository."""
989
2525
        raise NotImplementedError(self.is_shared)
1003
2539
        for repositories to maintain loaded indices across multiple locks
1004
2540
        by checking inside their implementation of this method to see
1005
2541
        whether their indices are still valid. This depends of course on
1006
 
        the disk format being validatable in this manner.
 
2542
        the disk format being validatable in this manner. This method is
 
2543
        also called by the refresh_data() public interface to cause a refresh
 
2544
        to occur while in a write lock so that data inserted by a smart server
 
2545
        push operation is visible on the client's instance of the physical
 
2546
        repository.
1007
2547
        """
1008
2548
 
1009
2549
    @needs_read_lock
1010
2550
    def revision_tree(self, revision_id):
1011
2551
        """Return Tree for a revision on this branch.
1012
2552
 
1013
 
        `revision_id` may be None for the empty tree revision.
 
2553
        `revision_id` may be NULL_REVISION for the empty tree revision.
1014
2554
        """
 
2555
        revision_id = _mod_revision.ensure_null(revision_id)
1015
2556
        # TODO: refactor this to use an existing revision object
1016
2557
        # so we don't need to read it in twice.
1017
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
1018
 
            return RevisionTree(self, Inventory(root_id=None), 
 
2558
        if revision_id == _mod_revision.NULL_REVISION:
 
2559
            return RevisionTree(self, Inventory(root_id=None),
1019
2560
                                _mod_revision.NULL_REVISION)
1020
2561
        else:
1021
 
            revision_id = osutils.safe_revision_id(revision_id)
1022
2562
            inv = self.get_revision_inventory(revision_id)
1023
2563
            return RevisionTree(self, inv, revision_id)
1024
2564
 
1025
 
    @needs_read_lock
1026
2565
    def revision_trees(self, revision_ids):
1027
 
        """Return Tree for a revision on this branch.
1028
 
 
1029
 
        `revision_id` may not be None or 'null:'"""
1030
 
        assert None not in revision_ids
1031
 
        assert _mod_revision.NULL_REVISION not in revision_ids
1032
 
        texts = self.get_inventory_weave().get_texts(revision_ids)
1033
 
        for text, revision_id in zip(texts, revision_ids):
1034
 
            inv = self.deserialise_inventory(revision_id, text)
1035
 
            yield RevisionTree(self, inv, revision_id)
 
2566
        """Return Trees for revisions in this repository.
 
2567
 
 
2568
        :param revision_ids: a sequence of revision-ids;
 
2569
          a revision-id may not be None or 'null:'
 
2570
        """
 
2571
        inventories = self.iter_inventories(revision_ids)
 
2572
        for inv in inventories:
 
2573
            yield RevisionTree(self, inv, inv.revision_id)
 
2574
 
 
2575
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2576
        """Return Tree for a revision on this branch with only some files.
 
2577
 
 
2578
        :param revision_ids: a sequence of revision-ids;
 
2579
          a revision-id may not be None or 'null:'
 
2580
        :param file_ids: if not None, the result is filtered
 
2581
          so that only those file-ids, their parents and their
 
2582
          children are included.
 
2583
        """
 
2584
        inventories = self.iter_inventories(revision_ids)
 
2585
        for inv in inventories:
 
2586
            # Should we introduce a FilteredRevisionTree class rather
 
2587
            # than pre-filter the inventory here?
 
2588
            filtered_inv = inv.filter(file_ids)
 
2589
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
1036
2590
 
1037
2591
    @needs_read_lock
1038
2592
    def get_ancestry(self, revision_id, topo_sorted=True):
1039
2593
        """Return a list of revision-ids integrated by a revision.
1040
2594
 
1041
 
        The first element of the list is always None, indicating the origin 
1042
 
        revision.  This might change when we have history horizons, or 
 
2595
        The first element of the list is always None, indicating the origin
 
2596
        revision.  This might change when we have history horizons, or
1043
2597
        perhaps we should have a new API.
1044
 
        
 
2598
 
1045
2599
        This is topologically sorted.
1046
2600
        """
1047
2601
        if _mod_revision.is_null(revision_id):
1048
2602
            return [None]
1049
 
        revision_id = osutils.safe_revision_id(revision_id)
1050
2603
        if not self.has_revision(revision_id):
1051
2604
            raise errors.NoSuchRevision(self, revision_id)
1052
 
        w = self.get_inventory_weave()
1053
 
        candidates = w.get_ancestry(revision_id, topo_sorted)
1054
 
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
2605
        graph = self.get_graph()
 
2606
        keys = set()
 
2607
        search = graph._make_breadth_first_searcher([revision_id])
 
2608
        while True:
 
2609
            try:
 
2610
                found, ghosts = search.next_with_ghosts()
 
2611
            except StopIteration:
 
2612
                break
 
2613
            keys.update(found)
 
2614
        if _mod_revision.NULL_REVISION in keys:
 
2615
            keys.remove(_mod_revision.NULL_REVISION)
 
2616
        if topo_sorted:
 
2617
            parent_map = graph.get_parent_map(keys)
 
2618
            keys = tsort.topo_sort(parent_map)
 
2619
        return [None] + list(keys)
1055
2620
 
1056
 
    def pack(self):
 
2621
    def pack(self, hint=None):
1057
2622
        """Compress the data within the repository.
1058
2623
 
1059
2624
        This operation only makes sense for some repository types. For other
1060
2625
        types it should be a no-op that just returns.
1061
2626
 
1062
2627
        This stub method does not require a lock, but subclasses should use
1063
 
        @needs_write_lock as this is a long running call its reasonable to 
 
2628
        @needs_write_lock as this is a long running call its reasonable to
1064
2629
        implicitly lock for the user.
1065
 
        """
1066
2630
 
1067
 
    @needs_read_lock
1068
 
    def print_file(self, file, revision_id):
1069
 
        """Print `file` to stdout.
1070
 
        
1071
 
        FIXME RBC 20060125 as John Meinel points out this is a bad api
1072
 
        - it writes to stdout, it assumes that that is valid etc. Fix
1073
 
        by creating a new more flexible convenience function.
 
2631
        :param hint: If not supplied, the whole repository is packed.
 
2632
            If supplied, the repository may use the hint parameter as a
 
2633
            hint for the parts of the repository to pack. A hint can be
 
2634
            obtained from the result of commit_write_group(). Out of
 
2635
            date hints are simply ignored, because concurrent operations
 
2636
            can obsolete them rapidly.
1074
2637
        """
1075
 
        revision_id = osutils.safe_revision_id(revision_id)
1076
 
        tree = self.revision_tree(revision_id)
1077
 
        # use inventory as it was in that revision
1078
 
        file_id = tree.inventory.path2id(file)
1079
 
        if not file_id:
1080
 
            # TODO: jam 20060427 Write a test for this code path
1081
 
            #       it had a bug in it, and was raising the wrong
1082
 
            #       exception.
1083
 
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
1084
 
        tree.print_file(file_id)
1085
2638
 
1086
2639
    def get_transaction(self):
1087
2640
        return self.control_files.get_transaction()
1088
2641
 
1089
 
    def revision_parents(self, revision_id):
1090
 
        revision_id = osutils.safe_revision_id(revision_id)
1091
 
        return self.get_inventory_weave().parent_names(revision_id)
1092
 
 
1093
 
    def get_parents(self, revision_ids):
1094
 
        """See StackedParentsProvider.get_parents"""
1095
 
        parents_list = []
 
2642
    def get_parent_map(self, revision_ids):
 
2643
        """See graph.StackedParentsProvider.get_parent_map"""
 
2644
        # revisions index works in keys; this just works in revisions
 
2645
        # therefore wrap and unwrap
 
2646
        query_keys = []
 
2647
        result = {}
1096
2648
        for revision_id in revision_ids:
1097
2649
            if revision_id == _mod_revision.NULL_REVISION:
1098
 
                parents = []
1099
 
            else:
1100
 
                try:
1101
 
                    parents = self.get_revision(revision_id).parent_ids
1102
 
                except errors.NoSuchRevision:
1103
 
                    parents = None
1104
 
                else:
1105
 
                    if len(parents) == 0:
1106
 
                        parents = [_mod_revision.NULL_REVISION]
1107
 
            parents_list.append(parents)
1108
 
        return parents_list
 
2650
                result[revision_id] = ()
 
2651
            elif revision_id is None:
 
2652
                raise ValueError('get_parent_map(None) is not valid')
 
2653
            else:
 
2654
                query_keys.append((revision_id ,))
 
2655
        for ((revision_id,), parent_keys) in \
 
2656
                self.revisions.get_parent_map(query_keys).iteritems():
 
2657
            if parent_keys:
 
2658
                result[revision_id] = tuple(parent_revid
 
2659
                    for (parent_revid,) in parent_keys)
 
2660
            else:
 
2661
                result[revision_id] = (_mod_revision.NULL_REVISION,)
 
2662
        return result
1109
2663
 
1110
2664
    def _make_parents_provider(self):
1111
2665
        return self
1114
2668
        """Return the graph walker for this repository format"""
1115
2669
        parents_provider = self._make_parents_provider()
1116
2670
        if (other_repository is not None and
1117
 
            other_repository.bzrdir.transport.base !=
1118
 
            self.bzrdir.transport.base):
1119
 
            parents_provider = graph._StackedParentsProvider(
 
2671
            not self.has_same_location(other_repository)):
 
2672
            parents_provider = graph.StackedParentsProvider(
1120
2673
                [parents_provider, other_repository._make_parents_provider()])
1121
2674
        return graph.Graph(parents_provider)
1122
2675
 
 
2676
    def _get_versioned_file_checker(self, text_key_references=None,
 
2677
        ancestors=None):
 
2678
        """Return an object suitable for checking versioned files.
 
2679
        
 
2680
        :param text_key_references: if non-None, an already built
 
2681
            dictionary mapping text keys ((fileid, revision_id) tuples)
 
2682
            to whether they were referred to by the inventory of the
 
2683
            revision_id that they contain. If None, this will be
 
2684
            calculated.
 
2685
        :param ancestors: Optional result from
 
2686
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2687
            available.
 
2688
        """
 
2689
        return _VersionedFileChecker(self,
 
2690
            text_key_references=text_key_references, ancestors=ancestors)
 
2691
 
 
2692
    def revision_ids_to_search_result(self, result_set):
 
2693
        """Convert a set of revision ids to a graph SearchResult."""
 
2694
        result_parents = set()
 
2695
        for parents in self.get_graph().get_parent_map(
 
2696
            result_set).itervalues():
 
2697
            result_parents.update(parents)
 
2698
        included_keys = result_set.intersection(result_parents)
 
2699
        start_keys = result_set.difference(included_keys)
 
2700
        exclude_keys = result_parents.difference(result_set)
 
2701
        result = graph.SearchResult(start_keys, exclude_keys,
 
2702
            len(result_set), result_set)
 
2703
        return result
 
2704
 
1123
2705
    @needs_write_lock
1124
2706
    def set_make_working_trees(self, new_value):
1125
2707
        """Set the policy flag for making working trees when creating branches.
1131
2713
                          working trees.
1132
2714
        """
1133
2715
        raise NotImplementedError(self.set_make_working_trees)
1134
 
    
 
2716
 
1135
2717
    def make_working_trees(self):
1136
2718
        """Returns the policy for making working trees on new branches."""
1137
2719
        raise NotImplementedError(self.make_working_trees)
1138
2720
 
1139
2721
    @needs_write_lock
1140
2722
    def sign_revision(self, revision_id, gpg_strategy):
1141
 
        revision_id = osutils.safe_revision_id(revision_id)
1142
2723
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1143
2724
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1144
2725
 
1145
2726
    @needs_read_lock
1146
2727
    def has_signature_for_revision_id(self, revision_id):
1147
2728
        """Query for a revision signature for revision_id in the repository."""
1148
 
        revision_id = osutils.safe_revision_id(revision_id)
1149
 
        return self._revision_store.has_signature(revision_id,
1150
 
                                                  self.get_transaction())
 
2729
        if not self.has_revision(revision_id):
 
2730
            raise errors.NoSuchRevision(self, revision_id)
 
2731
        sig_present = (1 == len(
 
2732
            self.signatures.get_parent_map([(revision_id,)])))
 
2733
        return sig_present
1151
2734
 
1152
2735
    @needs_read_lock
1153
2736
    def get_signature_text(self, revision_id):
1154
2737
        """Return the text for a signature."""
1155
 
        revision_id = osutils.safe_revision_id(revision_id)
1156
 
        return self._revision_store.get_signature_text(revision_id,
1157
 
                                                       self.get_transaction())
 
2738
        stream = self.signatures.get_record_stream([(revision_id,)],
 
2739
            'unordered', True)
 
2740
        record = stream.next()
 
2741
        if record.storage_kind == 'absent':
 
2742
            raise errors.NoSuchRevision(self, revision_id)
 
2743
        return record.get_bytes_as('fulltext')
1158
2744
 
1159
2745
    @needs_read_lock
1160
 
    def check(self, revision_ids):
 
2746
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1161
2747
        """Check consistency of all history of given revision_ids.
1162
2748
 
1163
2749
        Different repository implementations should override _check().
1164
2750
 
1165
2751
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1166
2752
             will be checked.  Typically the last revision_id of a branch.
 
2753
        :param callback_refs: A dict of check-refs to resolve and callback
 
2754
            the check/_check method on the items listed as wanting the ref.
 
2755
            see bzrlib.check.
 
2756
        :param check_repo: If False do not check the repository contents, just 
 
2757
            calculate the data callback_refs requires and call them back.
1167
2758
        """
1168
 
        if not revision_ids:
1169
 
            raise ValueError("revision_ids must be non-empty in %s.check" 
1170
 
                    % (self,))
1171
 
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1172
 
        return self._check(revision_ids)
 
2759
        return self._check(revision_ids, callback_refs=callback_refs,
 
2760
            check_repo=check_repo)
1173
2761
 
1174
 
    def _check(self, revision_ids):
1175
 
        result = check.Check(self)
1176
 
        result.check()
 
2762
    def _check(self, revision_ids, callback_refs, check_repo):
 
2763
        result = check.Check(self, check_repo=check_repo)
 
2764
        result.check(callback_refs)
1177
2765
        return result
1178
2766
 
1179
2767
    def _warn_if_deprecated(self):
1203
2791
                except UnicodeDecodeError:
1204
2792
                    raise errors.NonAsciiRevisionId(method, self)
1205
2793
 
 
2794
    def revision_graph_can_have_wrong_parents(self):
 
2795
        """Is it possible for this repository to have a revision graph with
 
2796
        incorrect parents?
 
2797
 
 
2798
        If True, then this repository must also implement
 
2799
        _find_inconsistent_revision_parents so that check and reconcile can
 
2800
        check for inconsistencies before proceeding with other checks that may
 
2801
        depend on the revision index being consistent.
 
2802
        """
 
2803
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
1206
2804
 
1207
2805
 
1208
2806
# remove these delegates a while after bzr 0.15
1241
2839
 
1242
2840
def install_revision(repository, rev, revision_tree):
1243
2841
    """Install all revision data into a repository."""
 
2842
    install_revisions(repository, [(rev, revision_tree, None)])
 
2843
 
 
2844
 
 
2845
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
2846
    """Install all revision data into a repository.
 
2847
 
 
2848
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
2849
    may be None.
 
2850
    """
 
2851
    repository.start_write_group()
 
2852
    try:
 
2853
        inventory_cache = lru_cache.LRUCache(10)
 
2854
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
2855
            _install_revision(repository, revision, revision_tree, signature,
 
2856
                inventory_cache)
 
2857
            if pb is not None:
 
2858
                pb.update('Transferring revisions', n + 1, num_revisions)
 
2859
    except:
 
2860
        repository.abort_write_group()
 
2861
        raise
 
2862
    else:
 
2863
        repository.commit_write_group()
 
2864
 
 
2865
 
 
2866
def _install_revision(repository, rev, revision_tree, signature,
 
2867
    inventory_cache):
 
2868
    """Install all revision data into a repository."""
1244
2869
    present_parents = []
1245
2870
    parent_trees = {}
1246
2871
    for p_id in rev.parent_ids:
1248
2873
            present_parents.append(p_id)
1249
2874
            parent_trees[p_id] = repository.revision_tree(p_id)
1250
2875
        else:
1251
 
            parent_trees[p_id] = repository.revision_tree(None)
 
2876
            parent_trees[p_id] = repository.revision_tree(
 
2877
                                     _mod_revision.NULL_REVISION)
1252
2878
 
1253
2879
    inv = revision_tree.inventory
1254
2880
    entries = inv.iter_entries()
1257
2883
        path, root = entries.next()
1258
2884
        if root.revision != rev.revision_id:
1259
2885
            raise errors.IncompatibleRevision(repr(repository))
 
2886
    text_keys = {}
 
2887
    for path, ie in entries:
 
2888
        text_keys[(ie.file_id, ie.revision)] = ie
 
2889
    text_parent_map = repository.texts.get_parent_map(text_keys)
 
2890
    missing_texts = set(text_keys) - set(text_parent_map)
1260
2891
    # Add the texts that are not already present
1261
 
    for path, ie in entries:
1262
 
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
1263
 
                repository.get_transaction())
1264
 
        if ie.revision not in w:
1265
 
            text_parents = []
1266
 
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
1267
 
            # with InventoryEntry.find_previous_heads(). if it is, then there
1268
 
            # is a latent bug here where the parents may have ancestors of each
1269
 
            # other. RBC, AB
1270
 
            for revision, tree in parent_trees.iteritems():
1271
 
                if ie.file_id not in tree:
1272
 
                    continue
1273
 
                parent_id = tree.inventory[ie.file_id].revision
1274
 
                if parent_id in text_parents:
1275
 
                    continue
1276
 
                text_parents.append(parent_id)
1277
 
                    
1278
 
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
1279
 
                repository.get_transaction())
1280
 
            lines = revision_tree.get_file(ie.file_id).readlines()
1281
 
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
2892
    for text_key in missing_texts:
 
2893
        ie = text_keys[text_key]
 
2894
        text_parents = []
 
2895
        # FIXME: TODO: The following loop overlaps/duplicates that done by
 
2896
        # commit to determine parents. There is a latent/real bug here where
 
2897
        # the parents inserted are not those commit would do - in particular
 
2898
        # they are not filtered by heads(). RBC, AB
 
2899
        for revision, tree in parent_trees.iteritems():
 
2900
            if ie.file_id not in tree:
 
2901
                continue
 
2902
            parent_id = tree.inventory[ie.file_id].revision
 
2903
            if parent_id in text_parents:
 
2904
                continue
 
2905
            text_parents.append((ie.file_id, parent_id))
 
2906
        lines = revision_tree.get_file(ie.file_id).readlines()
 
2907
        repository.texts.add_lines(text_key, text_parents, lines)
1282
2908
    try:
1283
2909
        # install the inventory
1284
 
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
2910
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
 
2911
            # Cache this inventory
 
2912
            inventory_cache[rev.revision_id] = inv
 
2913
            try:
 
2914
                basis_inv = inventory_cache[rev.parent_ids[0]]
 
2915
            except KeyError:
 
2916
                repository.add_inventory(rev.revision_id, inv, present_parents)
 
2917
            else:
 
2918
                delta = inv._make_delta(basis_inv)
 
2919
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
 
2920
                    rev.revision_id, present_parents)
 
2921
        else:
 
2922
            repository.add_inventory(rev.revision_id, inv, present_parents)
1285
2923
    except errors.RevisionAlreadyPresent:
1286
2924
        pass
 
2925
    if signature is not None:
 
2926
        repository.add_signature_text(rev.revision_id, signature)
1287
2927
    repository.add_revision(rev.revision_id, rev, inv)
1288
2928
 
1289
2929
 
1290
2930
class MetaDirRepository(Repository):
1291
 
    """Repositories in the new meta-dir layout."""
1292
 
 
1293
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
1294
 
        super(MetaDirRepository, self).__init__(_format,
1295
 
                                                a_bzrdir,
1296
 
                                                control_files,
1297
 
                                                _revision_store,
1298
 
                                                control_store,
1299
 
                                                text_store)
1300
 
        dir_mode = self.control_files._dir_mode
1301
 
        file_mode = self.control_files._file_mode
1302
 
 
1303
 
    @needs_read_lock
 
2931
    """Repositories in the new meta-dir layout.
 
2932
 
 
2933
    :ivar _transport: Transport for access to repository control files,
 
2934
        typically pointing to .bzr/repository.
 
2935
    """
 
2936
 
 
2937
    def __init__(self, _format, a_bzrdir, control_files):
 
2938
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
 
2939
        self._transport = control_files._transport
 
2940
 
1304
2941
    def is_shared(self):
1305
2942
        """Return True if this repository is flagged as a shared repository."""
1306
 
        return self.control_files._transport.has('shared-storage')
 
2943
        return self._transport.has('shared-storage')
1307
2944
 
1308
2945
    @needs_write_lock
1309
2946
    def set_make_working_trees(self, new_value):
1317
2954
        """
1318
2955
        if new_value:
1319
2956
            try:
1320
 
                self.control_files._transport.delete('no-working-trees')
 
2957
                self._transport.delete('no-working-trees')
1321
2958
            except errors.NoSuchFile:
1322
2959
                pass
1323
2960
        else:
1324
 
            self.control_files.put_utf8('no-working-trees', '')
1325
 
    
 
2961
            self._transport.put_bytes('no-working-trees', '',
 
2962
                mode=self.bzrdir._get_file_mode())
 
2963
 
1326
2964
    def make_working_trees(self):
1327
2965
        """Returns the policy for making working trees on new branches."""
1328
 
        return not self.control_files._transport.has('no-working-trees')
1329
 
 
1330
 
 
1331
 
class RepositoryFormatRegistry(registry.Registry):
1332
 
    """Registry of RepositoryFormats.
1333
 
    """
1334
 
 
1335
 
    def get(self, format_string):
1336
 
        r = registry.Registry.get(self, format_string)
1337
 
        if callable(r):
1338
 
            r = r()
1339
 
        return r
1340
 
    
1341
 
 
1342
 
format_registry = RepositoryFormatRegistry()
1343
 
"""Registry of formats, indexed by their identifying format string.
 
2966
        return not self._transport.has('no-working-trees')
 
2967
 
 
2968
 
 
2969
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2970
    """Repositories in a meta-dir, that work via versioned file objects."""
 
2971
 
 
2972
    def __init__(self, _format, a_bzrdir, control_files):
 
2973
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2974
            control_files)
 
2975
 
 
2976
 
 
2977
network_format_registry = registry.FormatRegistry()
 
2978
"""Registry of formats indexed by their network name.
 
2979
 
 
2980
The network name for a repository format is an identifier that can be used when
 
2981
referring to formats with smart server operations. See
 
2982
RepositoryFormat.network_name() for more detail.
 
2983
"""
 
2984
 
 
2985
 
 
2986
format_registry = registry.FormatRegistry(network_format_registry)
 
2987
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
1344
2988
 
1345
2989
This can contain either format instances themselves, or classes/factories that
1346
2990
can be called to obtain one.
1353
2997
class RepositoryFormat(object):
1354
2998
    """A repository format.
1355
2999
 
1356
 
    Formats provide three things:
 
3000
    Formats provide four things:
1357
3001
     * An initialization routine to construct repository data on disk.
1358
 
     * a format string which is used when the BzrDir supports versioned
1359
 
       children.
 
3002
     * a optional format string which is used when the BzrDir supports
 
3003
       versioned children.
1360
3004
     * an open routine which returns a Repository instance.
1361
 
 
1362
 
    Formats are placed in an dict by their format string for reference 
1363
 
    during opening. These should be subclasses of RepositoryFormat
1364
 
    for consistency.
 
3005
     * A network name for referring to the format in smart server RPC
 
3006
       methods.
 
3007
 
 
3008
    There is one and only one Format subclass for each on-disk format. But
 
3009
    there can be one Repository subclass that is used for several different
 
3010
    formats. The _format attribute on a Repository instance can be used to
 
3011
    determine the disk format.
 
3012
 
 
3013
    Formats are placed in a registry by their format string for reference
 
3014
    during opening. These should be subclasses of RepositoryFormat for
 
3015
    consistency.
1365
3016
 
1366
3017
    Once a format is deprecated, just deprecate the initialize and open
1367
 
    methods on the format class. Do not deprecate the object, as the 
1368
 
    object will be created every system load.
 
3018
    methods on the format class. Do not deprecate the object, as the
 
3019
    object may be created even when a repository instance hasn't been
 
3020
    created.
1369
3021
 
1370
3022
    Common instance attributes:
1371
3023
    _matchingbzrdir - the bzrdir format that the repository format was
1372
3024
    originally written to work with. This can be used if manually
1373
3025
    constructing a bzrdir and repository, or more commonly for test suite
1374
 
    parameterisation.
 
3026
    parameterization.
1375
3027
    """
1376
3028
 
 
3029
    # Set to True or False in derived classes. True indicates that the format
 
3030
    # supports ghosts gracefully.
 
3031
    supports_ghosts = None
 
3032
    # Can this repository be given external locations to lookup additional
 
3033
    # data. Set to True or False in derived classes.
 
3034
    supports_external_lookups = None
 
3035
    # Does this format support CHK bytestring lookups. Set to True or False in
 
3036
    # derived classes.
 
3037
    supports_chks = None
 
3038
    # Should commit add an inventory, or an inventory delta to the repository.
 
3039
    _commit_inv_deltas = True
 
3040
    # What order should fetch operations request streams in?
 
3041
    # The default is unordered as that is the cheapest for an origin to
 
3042
    # provide.
 
3043
    _fetch_order = 'unordered'
 
3044
    # Does this repository format use deltas that can be fetched as-deltas ?
 
3045
    # (E.g. knits, where the knit deltas can be transplanted intact.
 
3046
    # We default to False, which will ensure that enough data to get
 
3047
    # a full text out of any fetch stream will be grabbed.
 
3048
    _fetch_uses_deltas = False
 
3049
    # Should fetch trigger a reconcile after the fetch? Only needed for
 
3050
    # some repository formats that can suffer internal inconsistencies.
 
3051
    _fetch_reconcile = False
 
3052
    # Does this format have < O(tree_size) delta generation. Used to hint what
 
3053
    # code path for commit, amongst other things.
 
3054
    fast_deltas = None
 
3055
    # Does doing a pack operation compress data? Useful for the pack UI command
 
3056
    # (so if there is one pack, the operation can still proceed because it may
 
3057
    # help), and for fetching when data won't have come from the same
 
3058
    # compressor.
 
3059
    pack_compresses = False
 
3060
    # Does the repository inventory storage understand references to trees?
 
3061
    supports_tree_reference = None
 
3062
 
1377
3063
    def __str__(self):
1378
3064
        return "<%s>" % self.__class__.__name__
1379
3065
 
1387
3073
    @classmethod
1388
3074
    def find_format(klass, a_bzrdir):
1389
3075
        """Return the format for the repository object in a_bzrdir.
1390
 
        
 
3076
 
1391
3077
        This is used by bzr native formats that have a "format" file in
1392
 
        the repository.  Other methods may be used by different types of 
 
3078
        the repository.  Other methods may be used by different types of
1393
3079
        control directory.
1394
3080
        """
1395
3081
        try:
1399
3085
        except errors.NoSuchFile:
1400
3086
            raise errors.NoRepositoryPresent(a_bzrdir)
1401
3087
        except KeyError:
1402
 
            raise errors.UnknownFormatError(format=format_string)
 
3088
            raise errors.UnknownFormatError(format=format_string,
 
3089
                                            kind='repository')
1403
3090
 
1404
3091
    @classmethod
1405
3092
    def register_format(klass, format):
1408
3095
    @classmethod
1409
3096
    def unregister_format(klass, format):
1410
3097
        format_registry.remove(format.get_format_string())
1411
 
    
 
3098
 
1412
3099
    @classmethod
1413
3100
    def get_default_format(klass):
1414
3101
        """Return the current default format."""
1415
3102
        from bzrlib import bzrdir
1416
3103
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1417
3104
 
1418
 
    def _get_control_store(self, repo_transport, control_files):
1419
 
        """Return the control store for this repository."""
1420
 
        raise NotImplementedError(self._get_control_store)
1421
 
 
1422
3105
    def get_format_string(self):
1423
3106
        """Return the ASCII format string that identifies this format.
1424
 
        
1425
 
        Note that in pre format ?? repositories the format string is 
 
3107
 
 
3108
        Note that in pre format ?? repositories the format string is
1426
3109
        not permitted nor written to disk.
1427
3110
        """
1428
3111
        raise NotImplementedError(self.get_format_string)
1431
3114
        """Return the short description for this format."""
1432
3115
        raise NotImplementedError(self.get_format_description)
1433
3116
 
1434
 
    def _get_revision_store(self, repo_transport, control_files):
1435
 
        """Return the revision store object for this a_bzrdir."""
1436
 
        raise NotImplementedError(self._get_revision_store)
1437
 
 
1438
 
    def _get_text_rev_store(self,
1439
 
                            transport,
1440
 
                            control_files,
1441
 
                            name,
1442
 
                            compressed=True,
1443
 
                            prefixed=False,
1444
 
                            serializer=None):
1445
 
        """Common logic for getting a revision store for a repository.
1446
 
        
1447
 
        see self._get_revision_store for the subclass-overridable method to 
1448
 
        get the store for a repository.
1449
 
        """
1450
 
        from bzrlib.store.revision.text import TextRevisionStore
1451
 
        dir_mode = control_files._dir_mode
1452
 
        file_mode = control_files._file_mode
1453
 
        text_store = TextStore(transport.clone(name),
1454
 
                              prefixed=prefixed,
1455
 
                              compressed=compressed,
1456
 
                              dir_mode=dir_mode,
1457
 
                              file_mode=file_mode)
1458
 
        _revision_store = TextRevisionStore(text_store, serializer)
1459
 
        return _revision_store
1460
 
 
1461
3117
    # TODO: this shouldn't be in the base class, it's specific to things that
1462
3118
    # use weaves or knits -- mbp 20070207
1463
3119
    def _get_versioned_file_store(self,
1486
3142
        :param a_bzrdir: The bzrdir to put the new repository in it.
1487
3143
        :param shared: The repository should be initialized as a sharable one.
1488
3144
        :returns: The new repository object.
1489
 
        
 
3145
 
1490
3146
        This may raise UninitializableFormat if shared repository are not
1491
3147
        compatible the a_bzrdir.
1492
3148
        """
1496
3152
        """Is this format supported?
1497
3153
 
1498
3154
        Supported formats must be initializable and openable.
1499
 
        Unsupported formats may not support initialization or committing or 
 
3155
        Unsupported formats may not support initialization or committing or
1500
3156
        some other features depending on the reason for not being supported.
1501
3157
        """
1502
3158
        return True
1503
3159
 
 
3160
    def network_name(self):
 
3161
        """A simple byte string uniquely identifying this format for RPC calls.
 
3162
 
 
3163
        MetaDir repository formats use their disk format string to identify the
 
3164
        repository over the wire. All in one formats such as bzr < 0.8, and
 
3165
        foreign formats like svn/git and hg should use some marker which is
 
3166
        unique and immutable.
 
3167
        """
 
3168
        raise NotImplementedError(self.network_name)
 
3169
 
1504
3170
    def check_conversion_target(self, target_format):
1505
 
        raise NotImplementedError(self.check_conversion_target)
 
3171
        if self.rich_root_data and not target_format.rich_root_data:
 
3172
            raise errors.BadConversionTarget(
 
3173
                'Does not support rich root data.', target_format,
 
3174
                from_format=self)
 
3175
        if (self.supports_tree_reference and 
 
3176
            not getattr(target_format, 'supports_tree_reference', False)):
 
3177
            raise errors.BadConversionTarget(
 
3178
                'Does not support nested trees', target_format,
 
3179
                from_format=self)
1506
3180
 
1507
3181
    def open(self, a_bzrdir, _found=False):
1508
3182
        """Return an instance of this format for the bzrdir a_bzrdir.
1509
 
        
 
3183
 
1510
3184
        _found is a private parameter, do not use it.
1511
3185
        """
1512
3186
        raise NotImplementedError(self.open)
1517
3191
 
1518
3192
    rich_root_data = False
1519
3193
    supports_tree_reference = False
1520
 
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
3194
    supports_external_lookups = False
 
3195
 
 
3196
    @property
 
3197
    def _matchingbzrdir(self):
 
3198
        matching = bzrdir.BzrDirMetaFormat1()
 
3199
        matching.repository_format = self
 
3200
        return matching
1521
3201
 
1522
3202
    def __init__(self):
1523
3203
        super(MetaDirRepositoryFormat, self).__init__()
1536
3216
        """Upload the initial blank content."""
1537
3217
        control_files = self._create_control_files(a_bzrdir)
1538
3218
        control_files.lock_write()
 
3219
        transport = control_files._transport
 
3220
        if shared == True:
 
3221
            utf8_files += [('shared-storage', '')]
1539
3222
        try:
1540
 
            control_files._transport.mkdir_multi(dirs,
1541
 
                    mode=control_files._dir_mode)
1542
 
            for file, content in files:
1543
 
                control_files.put(file, content)
1544
 
            for file, content in utf8_files:
1545
 
                control_files.put_utf8(file, content)
1546
 
            if shared == True:
1547
 
                control_files.put_utf8('shared-storage', '')
 
3223
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
 
3224
            for (filename, content_stream) in files:
 
3225
                transport.put_file(filename, content_stream,
 
3226
                    mode=a_bzrdir._get_file_mode())
 
3227
            for (filename, content_bytes) in utf8_files:
 
3228
                transport.put_bytes_non_atomic(filename, content_bytes,
 
3229
                    mode=a_bzrdir._get_file_mode())
1548
3230
        finally:
1549
3231
            control_files.unlock()
1550
3232
 
1551
 
 
1552
 
# formats which have no format string are not discoverable
1553
 
# and not independently creatable, so are not registered.  They're 
 
3233
    def network_name(self):
 
3234
        """Metadir formats have matching disk and network format strings."""
 
3235
        return self.get_format_string()
 
3236
 
 
3237
 
 
3238
# Pre-0.8 formats that don't have a disk format string (because they are
 
3239
# versioned by the matching control directory). We use the control directories
 
3240
# disk format string as a key for the network_name because they meet the
 
3241
# constraints (simple string, unique, immutable).
 
3242
network_format_registry.register_lazy(
 
3243
    "Bazaar-NG branch, format 5\n",
 
3244
    'bzrlib.repofmt.weaverepo',
 
3245
    'RepositoryFormat5',
 
3246
)
 
3247
network_format_registry.register_lazy(
 
3248
    "Bazaar-NG branch, format 6\n",
 
3249
    'bzrlib.repofmt.weaverepo',
 
3250
    'RepositoryFormat6',
 
3251
)
 
3252
 
 
3253
# formats which have no format string are not discoverable or independently
 
3254
# creatable on disk, so are not registered in format_registry.  They're
1554
3255
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
1555
3256
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1556
3257
# the repository is not separately opened are similar.
1560
3261
    'bzrlib.repofmt.weaverepo',
1561
3262
    'RepositoryFormat7'
1562
3263
    )
1563
 
# KEEP in sync with bzrdir.format_registry default, which controls the overall
1564
 
# default control directory format
1565
3264
 
1566
3265
format_registry.register_lazy(
1567
3266
    'Bazaar-NG Knit Repository Format 1',
1568
3267
    'bzrlib.repofmt.knitrepo',
1569
3268
    'RepositoryFormatKnit1',
1570
3269
    )
1571
 
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
1572
3270
 
1573
3271
format_registry.register_lazy(
1574
3272
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1576
3274
    'RepositoryFormatKnit3',
1577
3275
    )
1578
3276
 
 
3277
format_registry.register_lazy(
 
3278
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
3279
    'bzrlib.repofmt.knitrepo',
 
3280
    'RepositoryFormatKnit4',
 
3281
    )
 
3282
 
 
3283
# Pack-based formats. There is one format for pre-subtrees, and one for
 
3284
# post-subtrees to allow ease of testing.
 
3285
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
3286
format_registry.register_lazy(
 
3287
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
3288
    'bzrlib.repofmt.pack_repo',
 
3289
    'RepositoryFormatKnitPack1',
 
3290
    )
 
3291
format_registry.register_lazy(
 
3292
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
3293
    'bzrlib.repofmt.pack_repo',
 
3294
    'RepositoryFormatKnitPack3',
 
3295
    )
 
3296
format_registry.register_lazy(
 
3297
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
3298
    'bzrlib.repofmt.pack_repo',
 
3299
    'RepositoryFormatKnitPack4',
 
3300
    )
 
3301
format_registry.register_lazy(
 
3302
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
 
3303
    'bzrlib.repofmt.pack_repo',
 
3304
    'RepositoryFormatKnitPack5',
 
3305
    )
 
3306
format_registry.register_lazy(
 
3307
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
 
3308
    'bzrlib.repofmt.pack_repo',
 
3309
    'RepositoryFormatKnitPack5RichRoot',
 
3310
    )
 
3311
format_registry.register_lazy(
 
3312
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
 
3313
    'bzrlib.repofmt.pack_repo',
 
3314
    'RepositoryFormatKnitPack5RichRootBroken',
 
3315
    )
 
3316
format_registry.register_lazy(
 
3317
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
3318
    'bzrlib.repofmt.pack_repo',
 
3319
    'RepositoryFormatKnitPack6',
 
3320
    )
 
3321
format_registry.register_lazy(
 
3322
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
3323
    'bzrlib.repofmt.pack_repo',
 
3324
    'RepositoryFormatKnitPack6RichRoot',
 
3325
    )
 
3326
 
 
3327
# Development formats.
 
3328
# Obsolete but kept pending a CHK based subtree format.
 
3329
format_registry.register_lazy(
 
3330
    ("Bazaar development format 2 with subtree support "
 
3331
        "(needs bzr.dev from before 1.8)\n"),
 
3332
    'bzrlib.repofmt.pack_repo',
 
3333
    'RepositoryFormatPackDevelopment2Subtree',
 
3334
    )
 
3335
 
 
3336
# 1.14->1.16 go below here
 
3337
format_registry.register_lazy(
 
3338
    'Bazaar development format - group compression and chk inventory'
 
3339
        ' (needs bzr.dev from 1.14)\n',
 
3340
    'bzrlib.repofmt.groupcompress_repo',
 
3341
    'RepositoryFormatCHK1',
 
3342
    )
 
3343
 
 
3344
format_registry.register_lazy(
 
3345
    'Bazaar development format - chk repository with bencode revision '
 
3346
        'serialization (needs bzr.dev from 1.16)\n',
 
3347
    'bzrlib.repofmt.groupcompress_repo',
 
3348
    'RepositoryFormatCHK2',
 
3349
    )
 
3350
format_registry.register_lazy(
 
3351
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3352
    'bzrlib.repofmt.groupcompress_repo',
 
3353
    'RepositoryFormat2a',
 
3354
    )
 
3355
 
1579
3356
 
1580
3357
class InterRepository(InterObject):
1581
3358
    """This class represents operations taking place between two repositories.
1582
3359
 
1583
3360
    Its instances have methods like copy_content and fetch, and contain
1584
 
    references to the source and target repositories these operations can be 
 
3361
    references to the source and target repositories these operations can be
1585
3362
    carried out on.
1586
3363
 
1587
3364
    Often we will provide convenience methods on 'repository' which carry out
1589
3366
    InterRepository.get(other).method_name(parameters).
1590
3367
    """
1591
3368
 
 
3369
    _walk_to_common_revisions_batch_size = 50
1592
3370
    _optimisers = []
1593
3371
    """The available optimised InterRepository types."""
1594
3372
 
 
3373
    @needs_write_lock
1595
3374
    def copy_content(self, revision_id=None):
1596
 
        raise NotImplementedError(self.copy_content)
1597
 
 
1598
 
    def fetch(self, revision_id=None, pb=None):
 
3375
        """Make a complete copy of the content in self into destination.
 
3376
 
 
3377
        This is a destructive operation! Do not use it on existing
 
3378
        repositories.
 
3379
 
 
3380
        :param revision_id: Only copy the content needed to construct
 
3381
                            revision_id and its parents.
 
3382
        """
 
3383
        try:
 
3384
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3385
        except NotImplementedError:
 
3386
            pass
 
3387
        self.target.fetch(self.source, revision_id=revision_id)
 
3388
 
 
3389
    @needs_write_lock
 
3390
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3391
            fetch_spec=None):
1599
3392
        """Fetch the content required to construct revision_id.
1600
3393
 
1601
3394
        The content is copied from self.source to self.target.
1604
3397
                            content is copied.
1605
3398
        :param pb: optional progress bar to use for progress reports. If not
1606
3399
                   provided a default one will be created.
1607
 
 
1608
 
        Returns the copied revision count and the failed revisions in a tuple:
1609
 
        (copied, failures).
1610
 
        """
1611
 
        raise NotImplementedError(self.fetch)
1612
 
   
 
3400
        :return: None.
 
3401
        """
 
3402
        from bzrlib.fetch import RepoFetcher
 
3403
        f = RepoFetcher(to_repository=self.target,
 
3404
                               from_repository=self.source,
 
3405
                               last_revision=revision_id,
 
3406
                               fetch_spec=fetch_spec,
 
3407
                               pb=pb, find_ghosts=find_ghosts)
 
3408
 
 
3409
    def _walk_to_common_revisions(self, revision_ids):
 
3410
        """Walk out from revision_ids in source to revisions target has.
 
3411
 
 
3412
        :param revision_ids: The start point for the search.
 
3413
        :return: A set of revision ids.
 
3414
        """
 
3415
        target_graph = self.target.get_graph()
 
3416
        revision_ids = frozenset(revision_ids)
 
3417
        missing_revs = set()
 
3418
        source_graph = self.source.get_graph()
 
3419
        # ensure we don't pay silly lookup costs.
 
3420
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
3421
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
3422
        searcher_exhausted = False
 
3423
        while True:
 
3424
            next_revs = set()
 
3425
            ghosts = set()
 
3426
            # Iterate the searcher until we have enough next_revs
 
3427
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
3428
                try:
 
3429
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
3430
                    next_revs.update(next_revs_part)
 
3431
                    ghosts.update(ghosts_part)
 
3432
                except StopIteration:
 
3433
                    searcher_exhausted = True
 
3434
                    break
 
3435
            # If there are ghosts in the source graph, and the caller asked for
 
3436
            # them, make sure that they are present in the target.
 
3437
            # We don't care about other ghosts as we can't fetch them and
 
3438
            # haven't been asked to.
 
3439
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
3440
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
3441
            if revs_to_get:
 
3442
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
3443
                # we always have NULL_REVISION present.
 
3444
                have_revs = have_revs.union(null_set)
 
3445
                # Check if the target is missing any ghosts we need.
 
3446
                ghosts_to_check.difference_update(have_revs)
 
3447
                if ghosts_to_check:
 
3448
                    # One of the caller's revision_ids is a ghost in both the
 
3449
                    # source and the target.
 
3450
                    raise errors.NoSuchRevision(
 
3451
                        self.source, ghosts_to_check.pop())
 
3452
                missing_revs.update(next_revs - have_revs)
 
3453
                # Because we may have walked past the original stop point, make
 
3454
                # sure everything is stopped
 
3455
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
3456
                searcher.stop_searching_any(stop_revs)
 
3457
            if searcher_exhausted:
 
3458
                break
 
3459
        return searcher.get_result()
 
3460
 
1613
3461
    @needs_read_lock
1614
 
    def missing_revision_ids(self, revision_id=None):
 
3462
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1615
3463
        """Return the revision ids that source has that target does not.
1616
 
        
1617
 
        These are returned in topological order.
1618
3464
 
1619
3465
        :param revision_id: only return revision ids included by this
1620
3466
                            revision_id.
 
3467
        :param find_ghosts: If True find missing revisions in deep history
 
3468
            rather than just finding the surface difference.
 
3469
        :return: A bzrlib.graph.SearchResult.
1621
3470
        """
 
3471
        # stop searching at found target revisions.
 
3472
        if not find_ghosts and revision_id is not None:
 
3473
            return self._walk_to_common_revisions([revision_id])
1622
3474
        # generic, possibly worst case, slow code path.
1623
3475
        target_ids = set(self.target.all_revision_ids())
1624
3476
        if revision_id is not None:
1625
 
            # TODO: jam 20070210 InterRepository is internal enough that it
1626
 
            #       should assume revision_ids are already utf-8
1627
 
            revision_id = osutils.safe_revision_id(revision_id)
1628
3477
            source_ids = self.source.get_ancestry(revision_id)
1629
 
            assert source_ids[0] is None
 
3478
            if source_ids[0] is not None:
 
3479
                raise AssertionError()
1630
3480
            source_ids.pop(0)
1631
3481
        else:
1632
3482
            source_ids = self.source.all_revision_ids()
1633
3483
        result_set = set(source_ids).difference(target_ids)
1634
 
        # this may look like a no-op: its not. It preserves the ordering
1635
 
        # other_ids had while only returning the members from other_ids
1636
 
        # that we've decided we need.
1637
 
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
3484
        return self.source.revision_ids_to_search_result(result_set)
 
3485
 
 
3486
    @staticmethod
 
3487
    def _same_model(source, target):
 
3488
        """True if source and target have the same data representation.
 
3489
 
 
3490
        Note: this is always called on the base class; overriding it in a
 
3491
        subclass will have no effect.
 
3492
        """
 
3493
        try:
 
3494
            InterRepository._assert_same_model(source, target)
 
3495
            return True
 
3496
        except errors.IncompatibleRepositories, e:
 
3497
            return False
 
3498
 
 
3499
    @staticmethod
 
3500
    def _assert_same_model(source, target):
 
3501
        """Raise an exception if two repositories do not use the same model.
 
3502
        """
 
3503
        if source.supports_rich_root() != target.supports_rich_root():
 
3504
            raise errors.IncompatibleRepositories(source, target,
 
3505
                "different rich-root support")
 
3506
        if source._serializer != target._serializer:
 
3507
            raise errors.IncompatibleRepositories(source, target,
 
3508
                "different serializers")
1638
3509
 
1639
3510
 
1640
3511
class InterSameDataRepository(InterRepository):
1641
3512
    """Code for converting between repositories that represent the same data.
1642
 
    
 
3513
 
1643
3514
    Data format and model must match for this to work.
1644
3515
    """
1645
3516
 
1646
3517
    @classmethod
1647
3518
    def _get_repo_format_to_test(self):
1648
 
        """Repository format for testing with."""
1649
 
        return RepositoryFormat.get_default_format()
 
3519
        """Repository format for testing with.
 
3520
 
 
3521
        InterSameData can pull from subtree to subtree and from non-subtree to
 
3522
        non-subtree, so we test this with the richest repository format.
 
3523
        """
 
3524
        from bzrlib.repofmt import knitrepo
 
3525
        return knitrepo.RepositoryFormatKnit3()
1650
3526
 
1651
3527
    @staticmethod
1652
3528
    def is_compatible(source, target):
1653
 
        if source.supports_rich_root() != target.supports_rich_root():
1654
 
            return False
1655
 
        if source._serializer != target._serializer:
1656
 
            return False
1657
 
        return True
1658
 
 
1659
 
    @needs_write_lock
1660
 
    def copy_content(self, revision_id=None):
1661
 
        """Make a complete copy of the content in self into destination.
1662
 
 
1663
 
        This copies both the repository's revision data, and configuration information
1664
 
        such as the make_working_trees setting.
1665
 
        
1666
 
        This is a destructive operation! Do not use it on existing 
1667
 
        repositories.
1668
 
 
1669
 
        :param revision_id: Only copy the content needed to construct
1670
 
                            revision_id and its parents.
1671
 
        """
1672
 
        try:
1673
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1674
 
        except NotImplementedError:
1675
 
            pass
1676
 
        # TODO: jam 20070210 This is fairly internal, so we should probably
1677
 
        #       just assert that revision_id is not unicode.
1678
 
        revision_id = osutils.safe_revision_id(revision_id)
1679
 
        # but don't bother fetching if we have the needed data now.
1680
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1681
 
            self.target.has_revision(revision_id)):
1682
 
            return
1683
 
        self.target.fetch(self.source, revision_id=revision_id)
1684
 
 
1685
 
    @needs_write_lock
1686
 
    def fetch(self, revision_id=None, pb=None):
1687
 
        """See InterRepository.fetch()."""
1688
 
        from bzrlib.fetch import GenericRepoFetcher
1689
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1690
 
               self.source, self.source._format, self.target, 
1691
 
               self.target._format)
1692
 
        # TODO: jam 20070210 This should be an assert, not a translate
1693
 
        revision_id = osutils.safe_revision_id(revision_id)
1694
 
        f = GenericRepoFetcher(to_repository=self.target,
1695
 
                               from_repository=self.source,
1696
 
                               last_revision=revision_id,
1697
 
                               pb=pb)
1698
 
        return f.count_copied, f.failed_revisions
 
3529
        return InterRepository._same_model(source, target)
1699
3530
 
1700
3531
 
1701
3532
class InterWeaveRepo(InterSameDataRepository):
1702
 
    """Optimised code paths between Weave based repositories."""
 
3533
    """Optimised code paths between Weave based repositories.
 
3534
 
 
3535
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
3536
    implemented lazy inter-object optimisation.
 
3537
    """
1703
3538
 
1704
3539
    @classmethod
1705
3540
    def _get_repo_format_to_test(self):
1709
3544
    @staticmethod
1710
3545
    def is_compatible(source, target):
1711
3546
        """Be compatible with known Weave formats.
1712
 
        
 
3547
 
1713
3548
        We don't test for the stores being of specific types because that
1714
 
        could lead to confusing results, and there is no need to be 
 
3549
        could lead to confusing results, and there is no need to be
1715
3550
        overly general.
1716
3551
        """
1717
3552
        from bzrlib.repofmt.weaverepo import (
1728
3563
                                                RepositoryFormat7)))
1729
3564
        except AttributeError:
1730
3565
            return False
1731
 
    
 
3566
 
1732
3567
    @needs_write_lock
1733
3568
    def copy_content(self, revision_id=None):
1734
3569
        """See InterRepository.copy_content()."""
1735
3570
        # weave specific optimised path:
1736
 
        # TODO: jam 20070210 Internal, should be an assert, not translate
1737
 
        revision_id = osutils.safe_revision_id(revision_id)
1738
3571
        try:
1739
3572
            self.target.set_make_working_trees(self.source.make_working_trees())
1740
 
        except NotImplementedError:
 
3573
        except (errors.RepositoryUpgradeRequired, NotImplemented):
1741
3574
            pass
1742
3575
        # FIXME do not peek!
1743
 
        if self.source.control_files._transport.listable():
 
3576
        if self.source._transport.listable():
1744
3577
            pb = ui.ui_factory.nested_progress_bar()
1745
3578
            try:
1746
 
                self.target.weave_store.copy_all_ids(
1747
 
                    self.source.weave_store,
1748
 
                    pb=pb,
1749
 
                    from_transaction=self.source.get_transaction(),
1750
 
                    to_transaction=self.target.get_transaction())
 
3579
                self.target.texts.insert_record_stream(
 
3580
                    self.source.texts.get_record_stream(
 
3581
                        self.source.texts.keys(), 'topological', False))
1751
3582
                pb.update('copying inventory', 0, 1)
1752
 
                self.target.control_weaves.copy_multi(
1753
 
                    self.source.control_weaves, ['inventory'],
1754
 
                    from_transaction=self.source.get_transaction(),
1755
 
                    to_transaction=self.target.get_transaction())
1756
 
                self.target._revision_store.text_store.copy_all_ids(
1757
 
                    self.source._revision_store.text_store,
1758
 
                    pb=pb)
 
3583
                self.target.inventories.insert_record_stream(
 
3584
                    self.source.inventories.get_record_stream(
 
3585
                        self.source.inventories.keys(), 'topological', False))
 
3586
                self.target.signatures.insert_record_stream(
 
3587
                    self.source.signatures.get_record_stream(
 
3588
                        self.source.signatures.keys(),
 
3589
                        'unordered', True))
 
3590
                self.target.revisions.insert_record_stream(
 
3591
                    self.source.revisions.get_record_stream(
 
3592
                        self.source.revisions.keys(),
 
3593
                        'topological', True))
1759
3594
            finally:
1760
3595
                pb.finished()
1761
3596
        else:
1762
3597
            self.target.fetch(self.source, revision_id=revision_id)
1763
3598
 
1764
 
    @needs_write_lock
1765
 
    def fetch(self, revision_id=None, pb=None):
1766
 
        """See InterRepository.fetch()."""
1767
 
        from bzrlib.fetch import GenericRepoFetcher
1768
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1769
 
               self.source, self.source._format, self.target, self.target._format)
1770
 
        # TODO: jam 20070210 This should be an assert, not a translate
1771
 
        revision_id = osutils.safe_revision_id(revision_id)
1772
 
        f = GenericRepoFetcher(to_repository=self.target,
1773
 
                               from_repository=self.source,
1774
 
                               last_revision=revision_id,
1775
 
                               pb=pb)
1776
 
        return f.count_copied, f.failed_revisions
1777
 
 
1778
3599
    @needs_read_lock
1779
 
    def missing_revision_ids(self, revision_id=None):
 
3600
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1780
3601
        """See InterRepository.missing_revision_ids()."""
1781
3602
        # we want all revisions to satisfy revision_id in source.
1782
3603
        # but we don't want to stat every file here and there.
1783
 
        # we want then, all revisions other needs to satisfy revision_id 
 
3604
        # we want then, all revisions other needs to satisfy revision_id
1784
3605
        # checked, but not those that we have locally.
1785
 
        # so the first thing is to get a subset of the revisions to 
 
3606
        # so the first thing is to get a subset of the revisions to
1786
3607
        # satisfy revision_id in source, and then eliminate those that
1787
 
        # we do already have. 
1788
 
        # this is slow on high latency connection to self, but as as this
1789
 
        # disk format scales terribly for push anyway due to rewriting 
 
3608
        # we do already have.
 
3609
        # this is slow on high latency connection to self, but as this
 
3610
        # disk format scales terribly for push anyway due to rewriting
1790
3611
        # inventory.weave, this is considered acceptable.
1791
3612
        # - RBC 20060209
1792
3613
        if revision_id is not None:
1793
3614
            source_ids = self.source.get_ancestry(revision_id)
1794
 
            assert source_ids[0] is None
 
3615
            if source_ids[0] is not None:
 
3616
                raise AssertionError()
1795
3617
            source_ids.pop(0)
1796
3618
        else:
1797
3619
            source_ids = self.source._all_possible_ids()
1802
3624
        # we do not have a revision as that would be pointless.
1803
3625
        target_ids = set(self.target._all_possible_ids())
1804
3626
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1805
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3627
        actually_present_revisions = set(
 
3628
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1806
3629
        required_revisions = source_ids_set.difference(actually_present_revisions)
1807
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1808
3630
        if revision_id is not None:
1809
3631
            # we used get_ancestry to determine source_ids then we are assured all
1810
3632
            # revisions referenced are present as they are installed in topological order.
1811
3633
            # and the tip revision was validated by get_ancestry.
1812
 
            return required_topo_revisions
 
3634
            result_set = required_revisions
1813
3635
        else:
1814
 
            # if we just grabbed the possibly available ids, then 
 
3636
            # if we just grabbed the possibly available ids, then
1815
3637
            # we only have an estimate of whats available and need to validate
1816
3638
            # that against the revision records.
1817
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
3639
            result_set = set(
 
3640
                self.source._eliminate_revisions_not_present(required_revisions))
 
3641
        return self.source.revision_ids_to_search_result(result_set)
1818
3642
 
1819
3643
 
1820
3644
class InterKnitRepo(InterSameDataRepository):
1828
3652
    @staticmethod
1829
3653
    def is_compatible(source, target):
1830
3654
        """Be compatible with known Knit formats.
1831
 
        
 
3655
 
1832
3656
        We don't test for the stores being of specific types because that
1833
 
        could lead to confusing results, and there is no need to be 
 
3657
        could lead to confusing results, and there is no need to be
1834
3658
        overly general.
1835
3659
        """
1836
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1
 
3660
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
1837
3661
        try:
1838
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1839
 
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
3662
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
3663
                isinstance(target._format, RepositoryFormatKnit))
1840
3664
        except AttributeError:
1841
3665
            return False
1842
 
 
1843
 
    @needs_write_lock
1844
 
    def fetch(self, revision_id=None, pb=None):
1845
 
        """See InterRepository.fetch()."""
1846
 
        from bzrlib.fetch import KnitRepoFetcher
1847
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1848
 
               self.source, self.source._format, self.target, self.target._format)
1849
 
        # TODO: jam 20070210 This should be an assert, not a translate
1850
 
        revision_id = osutils.safe_revision_id(revision_id)
1851
 
        f = KnitRepoFetcher(to_repository=self.target,
1852
 
                            from_repository=self.source,
1853
 
                            last_revision=revision_id,
1854
 
                            pb=pb)
1855
 
        return f.count_copied, f.failed_revisions
 
3666
        return are_knits and InterRepository._same_model(source, target)
1856
3667
 
1857
3668
    @needs_read_lock
1858
 
    def missing_revision_ids(self, revision_id=None):
 
3669
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1859
3670
        """See InterRepository.missing_revision_ids()."""
1860
3671
        if revision_id is not None:
1861
3672
            source_ids = self.source.get_ancestry(revision_id)
1862
 
            assert source_ids[0] is None
 
3673
            if source_ids[0] is not None:
 
3674
                raise AssertionError()
1863
3675
            source_ids.pop(0)
1864
3676
        else:
1865
 
            source_ids = self.source._all_possible_ids()
 
3677
            source_ids = self.source.all_revision_ids()
1866
3678
        source_ids_set = set(source_ids)
1867
3679
        # source_ids is the worst possible case we may need to pull.
1868
3680
        # now we want to filter source_ids against what we actually
1869
3681
        # have in target, but don't try to check for existence where we know
1870
3682
        # we do not have a revision as that would be pointless.
1871
 
        target_ids = set(self.target._all_possible_ids())
 
3683
        target_ids = set(self.target.all_revision_ids())
1872
3684
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1873
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3685
        actually_present_revisions = set(
 
3686
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1874
3687
        required_revisions = source_ids_set.difference(actually_present_revisions)
1875
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1876
3688
        if revision_id is not None:
1877
3689
            # we used get_ancestry to determine source_ids then we are assured all
1878
3690
            # revisions referenced are present as they are installed in topological order.
1879
3691
            # and the tip revision was validated by get_ancestry.
1880
 
            return required_topo_revisions
 
3692
            result_set = required_revisions
1881
3693
        else:
1882
 
            # if we just grabbed the possibly available ids, then 
 
3694
            # if we just grabbed the possibly available ids, then
1883
3695
            # we only have an estimate of whats available and need to validate
1884
3696
            # that against the revision records.
1885
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1886
 
 
1887
 
 
1888
 
class InterModel1and2(InterRepository):
1889
 
 
1890
 
    @classmethod
1891
 
    def _get_repo_format_to_test(self):
1892
 
        return None
1893
 
 
1894
 
    @staticmethod
1895
 
    def is_compatible(source, target):
1896
 
        if not source.supports_rich_root() and target.supports_rich_root():
1897
 
            return True
1898
 
        else:
1899
 
            return False
1900
 
 
1901
 
    @needs_write_lock
1902
 
    def fetch(self, revision_id=None, pb=None):
1903
 
        """See InterRepository.fetch()."""
1904
 
        from bzrlib.fetch import Model1toKnit2Fetcher
1905
 
        # TODO: jam 20070210 This should be an assert, not a translate
1906
 
        revision_id = osutils.safe_revision_id(revision_id)
1907
 
        f = Model1toKnit2Fetcher(to_repository=self.target,
1908
 
                                 from_repository=self.source,
1909
 
                                 last_revision=revision_id,
1910
 
                                 pb=pb)
1911
 
        return f.count_copied, f.failed_revisions
1912
 
 
1913
 
    @needs_write_lock
1914
 
    def copy_content(self, revision_id=None):
1915
 
        """Make a complete copy of the content in self into destination.
1916
 
        
1917
 
        This is a destructive operation! Do not use it on existing 
1918
 
        repositories.
1919
 
 
1920
 
        :param revision_id: Only copy the content needed to construct
1921
 
                            revision_id and its parents.
1922
 
        """
1923
 
        try:
1924
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1925
 
        except NotImplementedError:
1926
 
            pass
1927
 
        # TODO: jam 20070210 Internal, assert, don't translate
1928
 
        revision_id = osutils.safe_revision_id(revision_id)
1929
 
        # but don't bother fetching if we have the needed data now.
1930
 
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1931
 
            self.target.has_revision(revision_id)):
1932
 
            return
1933
 
        self.target.fetch(self.source, revision_id=revision_id)
1934
 
 
1935
 
 
1936
 
class InterKnit1and2(InterKnitRepo):
1937
 
 
1938
 
    @classmethod
1939
 
    def _get_repo_format_to_test(self):
1940
 
        return None
1941
 
 
1942
 
    @staticmethod
1943
 
    def is_compatible(source, target):
1944
 
        """Be compatible with Knit1 source and Knit3 target"""
1945
 
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
1946
 
        try:
1947
 
            from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
1948
 
                    RepositoryFormatKnit3
1949
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1950
 
                    isinstance(target._format, (RepositoryFormatKnit3)))
1951
 
        except AttributeError:
1952
 
            return False
1953
 
 
1954
 
    @needs_write_lock
1955
 
    def fetch(self, revision_id=None, pb=None):
1956
 
        """See InterRepository.fetch()."""
1957
 
        from bzrlib.fetch import Knit1to2Fetcher
1958
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1959
 
               self.source, self.source._format, self.target, 
1960
 
               self.target._format)
1961
 
        # TODO: jam 20070210 This should be an assert, not a translate
1962
 
        revision_id = osutils.safe_revision_id(revision_id)
1963
 
        f = Knit1to2Fetcher(to_repository=self.target,
1964
 
                            from_repository=self.source,
1965
 
                            last_revision=revision_id,
1966
 
                            pb=pb)
1967
 
        return f.count_copied, f.failed_revisions
1968
 
 
1969
 
 
1970
 
class InterRemoteRepository(InterRepository):
1971
 
    """Code for converting between RemoteRepository objects.
1972
 
 
1973
 
    This just gets an non-remote repository from the RemoteRepository, and calls
1974
 
    InterRepository.get again.
1975
 
    """
1976
 
 
1977
 
    def __init__(self, source, target):
1978
 
        if isinstance(source, remote.RemoteRepository):
1979
 
            source._ensure_real()
1980
 
            real_source = source._real_repository
1981
 
        else:
1982
 
            real_source = source
1983
 
        if isinstance(target, remote.RemoteRepository):
1984
 
            target._ensure_real()
1985
 
            real_target = target._real_repository
1986
 
        else:
1987
 
            real_target = target
1988
 
        self.real_inter = InterRepository.get(real_source, real_target)
1989
 
 
1990
 
    @staticmethod
1991
 
    def is_compatible(source, target):
1992
 
        if isinstance(source, remote.RemoteRepository):
1993
 
            return True
1994
 
        if isinstance(target, remote.RemoteRepository):
1995
 
            return True
1996
 
        return False
1997
 
 
1998
 
    def copy_content(self, revision_id=None):
1999
 
        self.real_inter.copy_content(revision_id=revision_id)
2000
 
 
2001
 
    def fetch(self, revision_id=None, pb=None):
2002
 
        self.real_inter.fetch(revision_id=revision_id, pb=pb)
2003
 
 
2004
 
    @classmethod
2005
 
    def _get_repo_format_to_test(self):
2006
 
        return None
2007
 
 
2008
 
 
 
3697
            result_set = set(
 
3698
                self.source._eliminate_revisions_not_present(required_revisions))
 
3699
        return self.source.revision_ids_to_search_result(result_set)
 
3700
 
 
3701
 
 
3702
class InterDifferingSerializer(InterRepository):
 
3703
 
 
3704
    @classmethod
 
3705
    def _get_repo_format_to_test(self):
 
3706
        return None
 
3707
 
 
3708
    @staticmethod
 
3709
    def is_compatible(source, target):
 
3710
        """Be compatible with Knit2 source and Knit3 target"""
 
3711
        # This is redundant with format.check_conversion_target(), however that
 
3712
        # raises an exception, and we just want to say "False" as in we won't
 
3713
        # support converting between these formats.
 
3714
        if 'IDS_never' in debug.debug_flags:
 
3715
            return False
 
3716
        if source.supports_rich_root() and not target.supports_rich_root():
 
3717
            return False
 
3718
        if (source._format.supports_tree_reference
 
3719
            and not target._format.supports_tree_reference):
 
3720
            return False
 
3721
        if target._fallback_repositories and target._format.supports_chks:
 
3722
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3723
            # adds to stacked repos.
 
3724
            return False
 
3725
        if 'IDS_always' in debug.debug_flags:
 
3726
            return True
 
3727
        # Only use this code path for local source and target.  IDS does far
 
3728
        # too much IO (both bandwidth and roundtrips) over a network.
 
3729
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3730
            return False
 
3731
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3732
            return False
 
3733
        return True
 
3734
 
 
3735
    def _get_trees(self, revision_ids, cache):
 
3736
        possible_trees = []
 
3737
        for rev_id in revision_ids:
 
3738
            if rev_id in cache:
 
3739
                possible_trees.append((rev_id, cache[rev_id]))
 
3740
            else:
 
3741
                # Not cached, but inventory might be present anyway.
 
3742
                try:
 
3743
                    tree = self.source.revision_tree(rev_id)
 
3744
                except errors.NoSuchRevision:
 
3745
                    # Nope, parent is ghost.
 
3746
                    pass
 
3747
                else:
 
3748
                    cache[rev_id] = tree
 
3749
                    possible_trees.append((rev_id, tree))
 
3750
        return possible_trees
 
3751
 
 
3752
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3753
        """Get the best delta and base for this revision.
 
3754
 
 
3755
        :return: (basis_id, delta)
 
3756
        """
 
3757
        deltas = []
 
3758
        # Generate deltas against each tree, to find the shortest.
 
3759
        texts_possibly_new_in_tree = set()
 
3760
        for basis_id, basis_tree in possible_trees:
 
3761
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3762
            for old_path, new_path, file_id, new_entry in delta:
 
3763
                if new_path is None:
 
3764
                    # This file_id isn't present in the new rev, so we don't
 
3765
                    # care about it.
 
3766
                    continue
 
3767
                if not new_path:
 
3768
                    # Rich roots are handled elsewhere...
 
3769
                    continue
 
3770
                kind = new_entry.kind
 
3771
                if kind != 'directory' and kind != 'file':
 
3772
                    # No text record associated with this inventory entry.
 
3773
                    continue
 
3774
                # This is a directory or file that has changed somehow.
 
3775
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
 
3776
            deltas.append((len(delta), basis_id, delta))
 
3777
        deltas.sort()
 
3778
        return deltas[0][1:]
 
3779
 
 
3780
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3781
        """Find all parent revisions that are absent, but for which the
 
3782
        inventory is present, and copy those inventories.
 
3783
 
 
3784
        This is necessary to preserve correctness when the source is stacked
 
3785
        without fallbacks configured.  (Note that in cases like upgrade the
 
3786
        source may be not have _fallback_repositories even though it is
 
3787
        stacked.)
 
3788
        """
 
3789
        parent_revs = set()
 
3790
        for parents in parent_map.values():
 
3791
            parent_revs.update(parents)
 
3792
        present_parents = self.source.get_parent_map(parent_revs)
 
3793
        absent_parents = set(parent_revs).difference(present_parents)
 
3794
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3795
            (rev_id,) for rev_id in absent_parents)
 
3796
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3797
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3798
            current_revision_id = parent_tree.get_revision_id()
 
3799
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3800
                (current_revision_id,)]
 
3801
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3802
            basis_id = _mod_revision.NULL_REVISION
 
3803
            basis_tree = self.source.revision_tree(basis_id)
 
3804
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3805
            self.target.add_inventory_by_delta(
 
3806
                basis_id, delta, current_revision_id, parents_parents)
 
3807
            cache[current_revision_id] = parent_tree
 
3808
 
 
3809
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3810
        """Fetch across a few revisions.
 
3811
 
 
3812
        :param revision_ids: The revisions to copy
 
3813
        :param basis_id: The revision_id of a tree that must be in cache, used
 
3814
            as a basis for delta when no other base is available
 
3815
        :param cache: A cache of RevisionTrees that we can use.
 
3816
        :return: The revision_id of the last converted tree. The RevisionTree
 
3817
            for it will be in cache
 
3818
        """
 
3819
        # Walk though all revisions; get inventory deltas, copy referenced
 
3820
        # texts that delta references, insert the delta, revision and
 
3821
        # signature.
 
3822
        root_keys_to_create = set()
 
3823
        text_keys = set()
 
3824
        pending_deltas = []
 
3825
        pending_revisions = []
 
3826
        parent_map = self.source.get_parent_map(revision_ids)
 
3827
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3828
        for tree in self.source.revision_trees(revision_ids):
 
3829
            # Find a inventory delta for this revision.
 
3830
            # Find text entries that need to be copied, too.
 
3831
            current_revision_id = tree.get_revision_id()
 
3832
            parent_ids = parent_map.get(current_revision_id, ())
 
3833
            parent_trees = self._get_trees(parent_ids, cache)
 
3834
            possible_trees = list(parent_trees)
 
3835
            if len(possible_trees) == 0:
 
3836
                # There either aren't any parents, or the parents are ghosts,
 
3837
                # so just use the last converted tree.
 
3838
                possible_trees.append((basis_id, cache[basis_id]))
 
3839
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
 
3840
                                                           possible_trees)
 
3841
            if self._converting_to_rich_root:
 
3842
                self._revision_id_to_root_id[current_revision_id] = \
 
3843
                    tree.get_root_id()
 
3844
            # Determine which texts are in present in this revision but not in
 
3845
            # any of the available parents.
 
3846
            texts_possibly_new_in_tree = set()
 
3847
            for old_path, new_path, file_id, entry in delta:
 
3848
                if new_path is None:
 
3849
                    # This file_id isn't present in the new rev
 
3850
                    continue
 
3851
                if not new_path:
 
3852
                    # This is the root
 
3853
                    if not self.target.supports_rich_root():
 
3854
                        # The target doesn't support rich root, so we don't
 
3855
                        # copy
 
3856
                        continue
 
3857
                    if self._converting_to_rich_root:
 
3858
                        # This can't be copied normally, we have to insert
 
3859
                        # it specially
 
3860
                        root_keys_to_create.add((file_id, entry.revision))
 
3861
                        continue
 
3862
                kind = entry.kind
 
3863
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3864
            for basis_id, basis_tree in possible_trees:
 
3865
                basis_inv = basis_tree.inventory
 
3866
                for file_key in list(texts_possibly_new_in_tree):
 
3867
                    file_id, file_revision = file_key
 
3868
                    try:
 
3869
                        entry = basis_inv[file_id]
 
3870
                    except errors.NoSuchId:
 
3871
                        continue
 
3872
                    if entry.revision == file_revision:
 
3873
                        texts_possibly_new_in_tree.remove(file_key)
 
3874
            text_keys.update(texts_possibly_new_in_tree)
 
3875
            revision = self.source.get_revision(current_revision_id)
 
3876
            pending_deltas.append((basis_id, delta,
 
3877
                current_revision_id, revision.parent_ids))
 
3878
            pending_revisions.append(revision)
 
3879
            cache[current_revision_id] = tree
 
3880
            basis_id = current_revision_id
 
3881
        # Copy file texts
 
3882
        from_texts = self.source.texts
 
3883
        to_texts = self.target.texts
 
3884
        if root_keys_to_create:
 
3885
            from bzrlib.fetch import _new_root_data_stream
 
3886
            root_stream = _new_root_data_stream(
 
3887
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3888
                self.source)
 
3889
            to_texts.insert_record_stream(root_stream)
 
3890
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3891
            text_keys, self.target._format._fetch_order,
 
3892
            not self.target._format._fetch_uses_deltas))
 
3893
        # insert inventory deltas
 
3894
        for delta in pending_deltas:
 
3895
            self.target.add_inventory_by_delta(*delta)
 
3896
        if self.target._fallback_repositories:
 
3897
            # Make sure this stacked repository has all the parent inventories
 
3898
            # for the new revisions that we are about to insert.  We do this
 
3899
            # before adding the revisions so that no revision is added until
 
3900
            # all the inventories it may depend on are added.
 
3901
            # Note that this is overzealous, as we may have fetched these in an
 
3902
            # earlier batch.
 
3903
            parent_ids = set()
 
3904
            revision_ids = set()
 
3905
            for revision in pending_revisions:
 
3906
                revision_ids.add(revision.revision_id)
 
3907
                parent_ids.update(revision.parent_ids)
 
3908
            parent_ids.difference_update(revision_ids)
 
3909
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3910
            parent_map = self.source.get_parent_map(parent_ids)
 
3911
            # we iterate over parent_map and not parent_ids because we don't
 
3912
            # want to try copying any revision which is a ghost
 
3913
            for parent_tree in self.source.revision_trees(parent_map):
 
3914
                current_revision_id = parent_tree.get_revision_id()
 
3915
                parents_parents = parent_map[current_revision_id]
 
3916
                possible_trees = self._get_trees(parents_parents, cache)
 
3917
                if len(possible_trees) == 0:
 
3918
                    # There either aren't any parents, or the parents are
 
3919
                    # ghosts, so just use the last converted tree.
 
3920
                    possible_trees.append((basis_id, cache[basis_id]))
 
3921
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3922
                    parents_parents, possible_trees)
 
3923
                self.target.add_inventory_by_delta(
 
3924
                    basis_id, delta, current_revision_id, parents_parents)
 
3925
        # insert signatures and revisions
 
3926
        for revision in pending_revisions:
 
3927
            try:
 
3928
                signature = self.source.get_signature_text(
 
3929
                    revision.revision_id)
 
3930
                self.target.add_signature_text(revision.revision_id,
 
3931
                    signature)
 
3932
            except errors.NoSuchRevision:
 
3933
                pass
 
3934
            self.target.add_revision(revision.revision_id, revision)
 
3935
        return basis_id
 
3936
 
 
3937
    def _fetch_all_revisions(self, revision_ids, pb):
 
3938
        """Fetch everything for the list of revisions.
 
3939
 
 
3940
        :param revision_ids: The list of revisions to fetch. Must be in
 
3941
            topological order.
 
3942
        :param pb: A ProgressTask
 
3943
        :return: None
 
3944
        """
 
3945
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3946
        batch_size = 100
 
3947
        cache = lru_cache.LRUCache(100)
 
3948
        cache[basis_id] = basis_tree
 
3949
        del basis_tree # We don't want to hang on to it here
 
3950
        hints = []
 
3951
        for offset in range(0, len(revision_ids), batch_size):
 
3952
            self.target.start_write_group()
 
3953
            try:
 
3954
                pb.update('Transferring revisions', offset,
 
3955
                          len(revision_ids))
 
3956
                batch = revision_ids[offset:offset+batch_size]
 
3957
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
3958
            except:
 
3959
                self.target.abort_write_group()
 
3960
                raise
 
3961
            else:
 
3962
                hint = self.target.commit_write_group()
 
3963
                if hint:
 
3964
                    hints.extend(hint)
 
3965
        if hints and self.target._format.pack_compresses:
 
3966
            self.target.pack(hint=hints)
 
3967
        pb.update('Transferring revisions', len(revision_ids),
 
3968
                  len(revision_ids))
 
3969
 
 
3970
    @needs_write_lock
 
3971
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3972
            fetch_spec=None):
 
3973
        """See InterRepository.fetch()."""
 
3974
        if fetch_spec is not None:
 
3975
            raise AssertionError("Not implemented yet...")
 
3976
        if (not self.source.supports_rich_root()
 
3977
            and self.target.supports_rich_root()):
 
3978
            self._converting_to_rich_root = True
 
3979
            self._revision_id_to_root_id = {}
 
3980
        else:
 
3981
            self._converting_to_rich_root = False
 
3982
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
3983
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3984
        if not revision_ids:
 
3985
            return 0, 0
 
3986
        revision_ids = tsort.topo_sort(
 
3987
            self.source.get_graph().get_parent_map(revision_ids))
 
3988
        if not revision_ids:
 
3989
            return 0, 0
 
3990
        # Walk though all revisions; get inventory deltas, copy referenced
 
3991
        # texts that delta references, insert the delta, revision and
 
3992
        # signature.
 
3993
        if pb is None:
 
3994
            my_pb = ui.ui_factory.nested_progress_bar()
 
3995
            pb = my_pb
 
3996
        else:
 
3997
            symbol_versioning.warn(
 
3998
                symbol_versioning.deprecated_in((1, 14, 0))
 
3999
                % "pb parameter to fetch()")
 
4000
            my_pb = None
 
4001
        try:
 
4002
            self._fetch_all_revisions(revision_ids, pb)
 
4003
        finally:
 
4004
            if my_pb is not None:
 
4005
                my_pb.finished()
 
4006
        return len(revision_ids), 0
 
4007
 
 
4008
    def _get_basis(self, first_revision_id):
 
4009
        """Get a revision and tree which exists in the target.
 
4010
 
 
4011
        This assumes that first_revision_id is selected for transmission
 
4012
        because all other ancestors are already present. If we can't find an
 
4013
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
4014
 
 
4015
        :return: (basis_id, basis_tree)
 
4016
        """
 
4017
        first_rev = self.source.get_revision(first_revision_id)
 
4018
        try:
 
4019
            basis_id = first_rev.parent_ids[0]
 
4020
            # only valid as a basis if the target has it
 
4021
            self.target.get_revision(basis_id)
 
4022
            # Try to get a basis tree - if its a ghost it will hit the
 
4023
            # NoSuchRevision case.
 
4024
            basis_tree = self.source.revision_tree(basis_id)
 
4025
        except (IndexError, errors.NoSuchRevision):
 
4026
            basis_id = _mod_revision.NULL_REVISION
 
4027
            basis_tree = self.source.revision_tree(basis_id)
 
4028
        return basis_id, basis_tree
 
4029
 
 
4030
 
 
4031
InterRepository.register_optimiser(InterDifferingSerializer)
2009
4032
InterRepository.register_optimiser(InterSameDataRepository)
2010
4033
InterRepository.register_optimiser(InterWeaveRepo)
2011
4034
InterRepository.register_optimiser(InterKnitRepo)
2012
 
InterRepository.register_optimiser(InterModel1and2)
2013
 
InterRepository.register_optimiser(InterKnit1and2)
2014
 
InterRepository.register_optimiser(InterRemoteRepository)
2015
4035
 
2016
4036
 
2017
4037
class CopyConverter(object):
2018
4038
    """A repository conversion tool which just performs a copy of the content.
2019
 
    
 
4039
 
2020
4040
    This is slow but quite reliable.
2021
4041
    """
2022
4042
 
2026
4046
        :param target_format: The format the resulting repository should be.
2027
4047
        """
2028
4048
        self.target_format = target_format
2029
 
        
 
4049
 
2030
4050
    def convert(self, repo, pb):
2031
4051
        """Perform the conversion of to_convert, giving feedback via pb.
2032
4052
 
2066
4086
        self.pb.update(message, self.count, self.total)
2067
4087
 
2068
4088
 
2069
 
class CommitBuilder(object):
2070
 
    """Provides an interface to build up a commit.
2071
 
 
2072
 
    This allows describing a tree to be committed without needing to 
2073
 
    know the internals of the format of the repository.
2074
 
    """
2075
 
    
2076
 
    record_root_entry = False
2077
 
    def __init__(self, repository, parents, config, timestamp=None, 
2078
 
                 timezone=None, committer=None, revprops=None, 
2079
 
                 revision_id=None):
2080
 
        """Initiate a CommitBuilder.
2081
 
 
2082
 
        :param repository: Repository to commit to.
2083
 
        :param parents: Revision ids of the parents of the new revision.
2084
 
        :param config: Configuration to use.
2085
 
        :param timestamp: Optional timestamp recorded for commit.
2086
 
        :param timezone: Optional timezone for timestamp.
2087
 
        :param committer: Optional committer to set for commit.
2088
 
        :param revprops: Optional dictionary of revision properties.
2089
 
        :param revision_id: Optional revision id.
2090
 
        """
2091
 
        self._config = config
2092
 
 
2093
 
        if committer is None:
2094
 
            self._committer = self._config.username()
2095
 
        else:
2096
 
            assert isinstance(committer, basestring), type(committer)
2097
 
            self._committer = committer
2098
 
 
2099
 
        self.new_inventory = Inventory(None)
2100
 
        self._new_revision_id = osutils.safe_revision_id(revision_id)
2101
 
        self.parents = parents
2102
 
        self.repository = repository
2103
 
 
2104
 
        self._revprops = {}
2105
 
        if revprops is not None:
2106
 
            self._revprops.update(revprops)
2107
 
 
2108
 
        if timestamp is None:
2109
 
            timestamp = time.time()
2110
 
        # Restrict resolution to 1ms
2111
 
        self._timestamp = round(timestamp, 3)
2112
 
 
2113
 
        if timezone is None:
2114
 
            self._timezone = osutils.local_time_offset()
2115
 
        else:
2116
 
            self._timezone = int(timezone)
2117
 
 
2118
 
        self._generate_revision_if_needed()
2119
 
 
2120
 
    def commit(self, message):
2121
 
        """Make the actual commit.
2122
 
 
2123
 
        :return: The revision id of the recorded revision.
2124
 
        """
2125
 
        rev = _mod_revision.Revision(
2126
 
                       timestamp=self._timestamp,
2127
 
                       timezone=self._timezone,
2128
 
                       committer=self._committer,
2129
 
                       message=message,
2130
 
                       inventory_sha1=self.inv_sha1,
2131
 
                       revision_id=self._new_revision_id,
2132
 
                       properties=self._revprops)
2133
 
        rev.parent_ids = self.parents
2134
 
        self.repository.add_revision(self._new_revision_id, rev,
2135
 
            self.new_inventory, self._config)
2136
 
        self.repository.commit_write_group()
2137
 
        return self._new_revision_id
2138
 
 
2139
 
    def abort(self):
2140
 
        """Abort the commit that is being built.
2141
 
        """
2142
 
        self.repository.abort_write_group()
2143
 
 
2144
 
    def revision_tree(self):
2145
 
        """Return the tree that was just committed.
2146
 
 
2147
 
        After calling commit() this can be called to get a RevisionTree
2148
 
        representing the newly committed tree. This is preferred to
2149
 
        calling Repository.revision_tree() because that may require
2150
 
        deserializing the inventory, while we already have a copy in
2151
 
        memory.
2152
 
        """
2153
 
        return RevisionTree(self.repository, self.new_inventory,
2154
 
                            self._new_revision_id)
2155
 
 
2156
 
    def finish_inventory(self):
2157
 
        """Tell the builder that the inventory is finished."""
2158
 
        if self.new_inventory.root is None:
2159
 
            symbol_versioning.warn('Root entry should be supplied to'
2160
 
                ' record_entry_contents, as of bzr 0.10.',
2161
 
                 DeprecationWarning, stacklevel=2)
2162
 
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
2163
 
        self.new_inventory.revision_id = self._new_revision_id
2164
 
        self.inv_sha1 = self.repository.add_inventory(
2165
 
            self._new_revision_id,
2166
 
            self.new_inventory,
2167
 
            self.parents
2168
 
            )
2169
 
 
2170
 
    def _gen_revision_id(self):
2171
 
        """Return new revision-id."""
2172
 
        return generate_ids.gen_revision_id(self._config.username(),
2173
 
                                            self._timestamp)
2174
 
 
2175
 
    def _generate_revision_if_needed(self):
2176
 
        """Create a revision id if None was supplied.
2177
 
        
2178
 
        If the repository can not support user-specified revision ids
2179
 
        they should override this function and raise CannotSetRevisionId
2180
 
        if _new_revision_id is not None.
2181
 
 
2182
 
        :raises: CannotSetRevisionId
2183
 
        """
2184
 
        if self._new_revision_id is None:
2185
 
            self._new_revision_id = self._gen_revision_id()
2186
 
 
2187
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2188
 
        """Record the content of ie from tree into the commit if needed.
2189
 
 
2190
 
        Side effect: sets ie.revision when unchanged
2191
 
 
2192
 
        :param ie: An inventory entry present in the commit.
2193
 
        :param parent_invs: The inventories of the parent revisions of the
2194
 
            commit.
2195
 
        :param path: The path the entry is at in the tree.
2196
 
        :param tree: The tree which contains this entry and should be used to 
2197
 
        obtain content.
2198
 
        """
2199
 
        if self.new_inventory.root is None and ie.parent_id is not None:
2200
 
            symbol_versioning.warn('Root entry should be supplied to'
2201
 
                ' record_entry_contents, as of bzr 0.10.',
2202
 
                 DeprecationWarning, stacklevel=2)
2203
 
            self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
2204
 
                                       '', tree)
2205
 
        self.new_inventory.add(ie)
2206
 
 
2207
 
        # ie.revision is always None if the InventoryEntry is considered
2208
 
        # for committing. ie.snapshot will record the correct revision 
2209
 
        # which may be the sole parent if it is untouched.
2210
 
        if ie.revision is not None:
2211
 
            return
2212
 
 
2213
 
        # In this revision format, root entries have no knit or weave
2214
 
        if ie is self.new_inventory.root:
2215
 
            # When serializing out to disk and back in
2216
 
            # root.revision is always _new_revision_id
2217
 
            ie.revision = self._new_revision_id
2218
 
            return
2219
 
        previous_entries = ie.find_previous_heads(
2220
 
            parent_invs,
2221
 
            self.repository.weave_store,
2222
 
            self.repository.get_transaction())
2223
 
        # we are creating a new revision for ie in the history store
2224
 
        # and inventory.
2225
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2226
 
 
2227
 
    def modified_directory(self, file_id, file_parents):
2228
 
        """Record the presence of a symbolic link.
2229
 
 
2230
 
        :param file_id: The file_id of the link to record.
2231
 
        :param file_parents: The per-file parent revision ids.
2232
 
        """
2233
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2234
 
 
2235
 
    def modified_reference(self, file_id, file_parents):
2236
 
        """Record the modification of a reference.
2237
 
 
2238
 
        :param file_id: The file_id of the link to record.
2239
 
        :param file_parents: The per-file parent revision ids.
2240
 
        """
2241
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2242
 
    
2243
 
    def modified_file_text(self, file_id, file_parents,
2244
 
                           get_content_byte_lines, text_sha1=None,
2245
 
                           text_size=None):
2246
 
        """Record the text of file file_id
2247
 
 
2248
 
        :param file_id: The file_id of the file to record the text of.
2249
 
        :param file_parents: The per-file parent revision ids.
2250
 
        :param get_content_byte_lines: A callable which will return the byte
2251
 
            lines for the file.
2252
 
        :param text_sha1: Optional SHA1 of the file contents.
2253
 
        :param text_size: Optional size of the file contents.
2254
 
        """
2255
 
        # mutter('storing text of file {%s} in revision {%s} into %r',
2256
 
        #        file_id, self._new_revision_id, self.repository.weave_store)
2257
 
        # special case to avoid diffing on renames or 
2258
 
        # reparenting
2259
 
        if (len(file_parents) == 1
2260
 
            and text_sha1 == file_parents.values()[0].text_sha1
2261
 
            and text_size == file_parents.values()[0].text_size):
2262
 
            previous_ie = file_parents.values()[0]
2263
 
            versionedfile = self.repository.weave_store.get_weave(file_id, 
2264
 
                self.repository.get_transaction())
2265
 
            versionedfile.clone_text(self._new_revision_id, 
2266
 
                previous_ie.revision, file_parents.keys())
2267
 
            return text_sha1, text_size
2268
 
        else:
2269
 
            new_lines = get_content_byte_lines()
2270
 
            # TODO: Rather than invoking sha_strings here, _add_text_to_weave
2271
 
            # should return the SHA1 and size
2272
 
            self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2273
 
            return osutils.sha_strings(new_lines), \
2274
 
                sum(map(len, new_lines))
2275
 
 
2276
 
    def modified_link(self, file_id, file_parents, link_target):
2277
 
        """Record the presence of a symbolic link.
2278
 
 
2279
 
        :param file_id: The file_id of the link to record.
2280
 
        :param file_parents: The per-file parent revision ids.
2281
 
        :param link_target: Target location of this link.
2282
 
        """
2283
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2284
 
 
2285
 
    def _add_text_to_weave(self, file_id, new_lines, parents):
2286
 
        versionedfile = self.repository.weave_store.get_weave_or_empty(
2287
 
            file_id, self.repository.get_transaction())
2288
 
        versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2289
 
        versionedfile.clear_cache()
2290
 
 
2291
 
 
2292
 
class _CommitBuilder(CommitBuilder):
2293
 
    """Temporary class so old CommitBuilders are detected properly
2294
 
    
2295
 
    Note: CommitBuilder works whether or not root entry is recorded.
2296
 
    """
2297
 
 
2298
 
    record_root_entry = True
2299
 
 
2300
 
 
2301
 
class RootCommitBuilder(CommitBuilder):
2302
 
    """This commitbuilder actually records the root id"""
2303
 
    
2304
 
    record_root_entry = True
2305
 
 
2306
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2307
 
        """Record the content of ie from tree into the commit if needed.
2308
 
 
2309
 
        Side effect: sets ie.revision when unchanged
2310
 
 
2311
 
        :param ie: An inventory entry present in the commit.
2312
 
        :param parent_invs: The inventories of the parent revisions of the
2313
 
            commit.
2314
 
        :param path: The path the entry is at in the tree.
2315
 
        :param tree: The tree which contains this entry and should be used to 
2316
 
        obtain content.
2317
 
        """
2318
 
        assert self.new_inventory.root is not None or ie.parent_id is None
2319
 
        self.new_inventory.add(ie)
2320
 
 
2321
 
        # ie.revision is always None if the InventoryEntry is considered
2322
 
        # for committing. ie.snapshot will record the correct revision 
2323
 
        # which may be the sole parent if it is untouched.
2324
 
        if ie.revision is not None:
2325
 
            return
2326
 
 
2327
 
        previous_entries = ie.find_previous_heads(
2328
 
            parent_invs,
2329
 
            self.repository.weave_store,
2330
 
            self.repository.get_transaction())
2331
 
        # we are creating a new revision for ie in the history store
2332
 
        # and inventory.
2333
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2334
 
 
2335
 
 
2336
4089
_unescape_map = {
2337
4090
    'apos':"'",
2338
4091
    'quot':'"',
2361
4114
    if _unescape_re is None:
2362
4115
        _unescape_re = re.compile('\&([^;]*);')
2363
4116
    return _unescape_re.sub(_unescaper, data)
 
4117
 
 
4118
 
 
4119
class _VersionedFileChecker(object):
 
4120
 
 
4121
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
4122
        self.repository = repository
 
4123
        self.text_index = self.repository._generate_text_key_index(
 
4124
            text_key_references=text_key_references, ancestors=ancestors)
 
4125
 
 
4126
    def calculate_file_version_parents(self, text_key):
 
4127
        """Calculate the correct parents for a file version according to
 
4128
        the inventories.
 
4129
        """
 
4130
        parent_keys = self.text_index[text_key]
 
4131
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
4132
            return ()
 
4133
        return tuple(parent_keys)
 
4134
 
 
4135
    def check_file_version_parents(self, texts, progress_bar=None):
 
4136
        """Check the parents stored in a versioned file are correct.
 
4137
 
 
4138
        It also detects file versions that are not referenced by their
 
4139
        corresponding revision's inventory.
 
4140
 
 
4141
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
4142
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
4143
            correct_parents)} for each revision_id where the stored parents
 
4144
            are not correct.  dangling_file_versions is a set of (file_id,
 
4145
            revision_id) tuples for versions that are present in this versioned
 
4146
            file, but not used by the corresponding inventory.
 
4147
        """
 
4148
        local_progress = None
 
4149
        if progress_bar is None:
 
4150
            local_progress = ui.ui_factory.nested_progress_bar()
 
4151
            progress_bar = local_progress
 
4152
        try:
 
4153
            return self._check_file_version_parents(texts, progress_bar)
 
4154
        finally:
 
4155
            if local_progress:
 
4156
                local_progress.finished()
 
4157
 
 
4158
    def _check_file_version_parents(self, texts, progress_bar):
 
4159
        """See check_file_version_parents."""
 
4160
        wrong_parents = {}
 
4161
        self.file_ids = set([file_id for file_id, _ in
 
4162
            self.text_index.iterkeys()])
 
4163
        # text keys is now grouped by file_id
 
4164
        n_versions = len(self.text_index)
 
4165
        progress_bar.update('loading text store', 0, n_versions)
 
4166
        parent_map = self.repository.texts.get_parent_map(self.text_index)
 
4167
        # On unlistable transports this could well be empty/error...
 
4168
        text_keys = self.repository.texts.keys()
 
4169
        unused_keys = frozenset(text_keys) - set(self.text_index)
 
4170
        for num, key in enumerate(self.text_index.iterkeys()):
 
4171
            progress_bar.update('checking text graph', num, n_versions)
 
4172
            correct_parents = self.calculate_file_version_parents(key)
 
4173
            try:
 
4174
                knit_parents = parent_map[key]
 
4175
            except errors.RevisionNotPresent:
 
4176
                # Missing text!
 
4177
                knit_parents = None
 
4178
            if correct_parents != knit_parents:
 
4179
                wrong_parents[key] = (knit_parents, correct_parents)
 
4180
        return wrong_parents, unused_keys
 
4181
 
 
4182
 
 
4183
def _old_get_graph(repository, revision_id):
 
4184
    """DO NOT USE. That is all. I'm serious."""
 
4185
    graph = repository.get_graph()
 
4186
    revision_graph = dict(((key, value) for key, value in
 
4187
        graph.iter_ancestry([revision_id]) if value is not None))
 
4188
    return _strip_NULL_ghosts(revision_graph)
 
4189
 
 
4190
 
 
4191
def _strip_NULL_ghosts(revision_graph):
 
4192
    """Also don't use this. more compatibility code for unmigrated clients."""
 
4193
    # Filter ghosts, and null:
 
4194
    if _mod_revision.NULL_REVISION in revision_graph:
 
4195
        del revision_graph[_mod_revision.NULL_REVISION]
 
4196
    for key, parents in revision_graph.items():
 
4197
        revision_graph[key] = tuple(parent for parent in parents if parent
 
4198
            in revision_graph)
 
4199
    return revision_graph
 
4200
 
 
4201
 
 
4202
class StreamSink(object):
 
4203
    """An object that can insert a stream into a repository.
 
4204
 
 
4205
    This interface handles the complexity of reserialising inventories and
 
4206
    revisions from different formats, and allows unidirectional insertion into
 
4207
    stacked repositories without looking for the missing basis parents
 
4208
    beforehand.
 
4209
    """
 
4210
 
 
4211
    def __init__(self, target_repo):
 
4212
        self.target_repo = target_repo
 
4213
 
 
4214
    def insert_stream(self, stream, src_format, resume_tokens):
 
4215
        """Insert a stream's content into the target repository.
 
4216
 
 
4217
        :param src_format: a bzr repository format.
 
4218
 
 
4219
        :return: a list of resume tokens and an  iterable of keys additional
 
4220
            items required before the insertion can be completed.
 
4221
        """
 
4222
        self.target_repo.lock_write()
 
4223
        try:
 
4224
            if resume_tokens:
 
4225
                self.target_repo.resume_write_group(resume_tokens)
 
4226
                is_resume = True
 
4227
            else:
 
4228
                self.target_repo.start_write_group()
 
4229
                is_resume = False
 
4230
            try:
 
4231
                # locked_insert_stream performs a commit|suspend.
 
4232
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4233
            except:
 
4234
                self.target_repo.abort_write_group(suppress_errors=True)
 
4235
                raise
 
4236
        finally:
 
4237
            self.target_repo.unlock()
 
4238
 
 
4239
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4240
        to_serializer = self.target_repo._format._serializer
 
4241
        src_serializer = src_format._serializer
 
4242
        new_pack = None
 
4243
        if to_serializer == src_serializer:
 
4244
            # If serializers match and the target is a pack repository, set the
 
4245
            # write cache size on the new pack.  This avoids poor performance
 
4246
            # on transports where append is unbuffered (such as
 
4247
            # RemoteTransport).  This is safe to do because nothing should read
 
4248
            # back from the target repository while a stream with matching
 
4249
            # serialization is being inserted.
 
4250
            # The exception is that a delta record from the source that should
 
4251
            # be a fulltext may need to be expanded by the target (see
 
4252
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
 
4253
            # explicitly flush any buffered writes first in that rare case.
 
4254
            try:
 
4255
                new_pack = self.target_repo._pack_collection._new_pack
 
4256
            except AttributeError:
 
4257
                # Not a pack repository
 
4258
                pass
 
4259
            else:
 
4260
                new_pack.set_write_cache_size(1024*1024)
 
4261
        for substream_type, substream in stream:
 
4262
            if 'stream' in debug.debug_flags:
 
4263
                mutter('inserting substream: %s', substream_type)
 
4264
            if substream_type == 'texts':
 
4265
                self.target_repo.texts.insert_record_stream(substream)
 
4266
            elif substream_type == 'inventories':
 
4267
                if src_serializer == to_serializer:
 
4268
                    self.target_repo.inventories.insert_record_stream(
 
4269
                        substream)
 
4270
                else:
 
4271
                    self._extract_and_insert_inventories(
 
4272
                        substream, src_serializer)
 
4273
            elif substream_type == 'inventory-deltas':
 
4274
                self._extract_and_insert_inventory_deltas(
 
4275
                    substream, src_serializer)
 
4276
            elif substream_type == 'chk_bytes':
 
4277
                # XXX: This doesn't support conversions, as it assumes the
 
4278
                #      conversion was done in the fetch code.
 
4279
                self.target_repo.chk_bytes.insert_record_stream(substream)
 
4280
            elif substream_type == 'revisions':
 
4281
                # This may fallback to extract-and-insert more often than
 
4282
                # required if the serializers are different only in terms of
 
4283
                # the inventory.
 
4284
                if src_serializer == to_serializer:
 
4285
                    self.target_repo.revisions.insert_record_stream(
 
4286
                        substream)
 
4287
                else:
 
4288
                    self._extract_and_insert_revisions(substream,
 
4289
                        src_serializer)
 
4290
            elif substream_type == 'signatures':
 
4291
                self.target_repo.signatures.insert_record_stream(substream)
 
4292
            else:
 
4293
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4294
        # Done inserting data, and the missing_keys calculations will try to
 
4295
        # read back from the inserted data, so flush the writes to the new pack
 
4296
        # (if this is pack format).
 
4297
        if new_pack is not None:
 
4298
            new_pack._write_data('', flush=True)
 
4299
        # Find all the new revisions (including ones from resume_tokens)
 
4300
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4301
            check_for_missing_texts=is_resume)
 
4302
        try:
 
4303
            for prefix, versioned_file in (
 
4304
                ('texts', self.target_repo.texts),
 
4305
                ('inventories', self.target_repo.inventories),
 
4306
                ('revisions', self.target_repo.revisions),
 
4307
                ('signatures', self.target_repo.signatures),
 
4308
                ('chk_bytes', self.target_repo.chk_bytes),
 
4309
                ):
 
4310
                if versioned_file is None:
 
4311
                    continue
 
4312
                missing_keys.update((prefix,) + key for key in
 
4313
                    versioned_file.get_missing_compression_parent_keys())
 
4314
        except NotImplementedError:
 
4315
            # cannot even attempt suspending, and missing would have failed
 
4316
            # during stream insertion.
 
4317
            missing_keys = set()
 
4318
        else:
 
4319
            if missing_keys:
 
4320
                # suspend the write group and tell the caller what we is
 
4321
                # missing. We know we can suspend or else we would not have
 
4322
                # entered this code path. (All repositories that can handle
 
4323
                # missing keys can handle suspending a write group).
 
4324
                write_group_tokens = self.target_repo.suspend_write_group()
 
4325
                return write_group_tokens, missing_keys
 
4326
        hint = self.target_repo.commit_write_group()
 
4327
        if (to_serializer != src_serializer and
 
4328
            self.target_repo._format.pack_compresses):
 
4329
            self.target_repo.pack(hint=hint)
 
4330
        return [], set()
 
4331
 
 
4332
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4333
        target_rich_root = self.target_repo._format.rich_root_data
 
4334
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4335
        for record in substream:
 
4336
            # Insert the delta directly
 
4337
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4338
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4339
            try:
 
4340
                parse_result = deserialiser.parse_text_bytes(
 
4341
                    inventory_delta_bytes)
 
4342
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4343
                trace.mutter("Incompatible delta: %s", err.msg)
 
4344
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4345
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4346
            revision_id = new_id
 
4347
            parents = [key[0] for key in record.parents]
 
4348
            self.target_repo.add_inventory_by_delta(
 
4349
                basis_id, inv_delta, revision_id, parents)
 
4350
 
 
4351
    def _extract_and_insert_inventories(self, substream, serializer,
 
4352
            parse_delta=None):
 
4353
        """Generate a new inventory versionedfile in target, converting data.
 
4354
 
 
4355
        The inventory is retrieved from the source, (deserializing it), and
 
4356
        stored in the target (reserializing it in a different format).
 
4357
        """
 
4358
        target_rich_root = self.target_repo._format.rich_root_data
 
4359
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4360
        for record in substream:
 
4361
            # It's not a delta, so it must be a fulltext in the source
 
4362
            # serializer's format.
 
4363
            bytes = record.get_bytes_as('fulltext')
 
4364
            revision_id = record.key[0]
 
4365
            inv = serializer.read_inventory_from_string(bytes, revision_id)
 
4366
            parents = [key[0] for key in record.parents]
 
4367
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4368
            # No need to keep holding this full inv in memory when the rest of
 
4369
            # the substream is likely to be all deltas.
 
4370
            del inv
 
4371
 
 
4372
    def _extract_and_insert_revisions(self, substream, serializer):
 
4373
        for record in substream:
 
4374
            bytes = record.get_bytes_as('fulltext')
 
4375
            revision_id = record.key[0]
 
4376
            rev = serializer.read_revision_from_string(bytes)
 
4377
            if rev.revision_id != revision_id:
 
4378
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
 
4379
            self.target_repo.add_revision(revision_id, rev)
 
4380
 
 
4381
    def finished(self):
 
4382
        if self.target_repo._format._fetch_reconcile:
 
4383
            self.target_repo.reconcile()
 
4384
 
 
4385
 
 
4386
class StreamSource(object):
 
4387
    """A source of a stream for fetching between repositories."""
 
4388
 
 
4389
    def __init__(self, from_repository, to_format):
 
4390
        """Create a StreamSource streaming from from_repository."""
 
4391
        self.from_repository = from_repository
 
4392
        self.to_format = to_format
 
4393
 
 
4394
    def delta_on_metadata(self):
 
4395
        """Return True if delta's are permitted on metadata streams.
 
4396
 
 
4397
        That is on revisions and signatures.
 
4398
        """
 
4399
        src_serializer = self.from_repository._format._serializer
 
4400
        target_serializer = self.to_format._serializer
 
4401
        return (self.to_format._fetch_uses_deltas and
 
4402
            src_serializer == target_serializer)
 
4403
 
 
4404
    def _fetch_revision_texts(self, revs):
 
4405
        # fetch signatures first and then the revision texts
 
4406
        # may need to be a InterRevisionStore call here.
 
4407
        from_sf = self.from_repository.signatures
 
4408
        # A missing signature is just skipped.
 
4409
        keys = [(rev_id,) for rev_id in revs]
 
4410
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
 
4411
            keys,
 
4412
            self.to_format._fetch_order,
 
4413
            not self.to_format._fetch_uses_deltas))
 
4414
        # If a revision has a delta, this is actually expanded inside the
 
4415
        # insert_record_stream code now, which is an alternate fix for
 
4416
        # bug #261339
 
4417
        from_rf = self.from_repository.revisions
 
4418
        revisions = from_rf.get_record_stream(
 
4419
            keys,
 
4420
            self.to_format._fetch_order,
 
4421
            not self.delta_on_metadata())
 
4422
        return [('signatures', signatures), ('revisions', revisions)]
 
4423
 
 
4424
    def _generate_root_texts(self, revs):
 
4425
        """This will be called by get_stream between fetching weave texts and
 
4426
        fetching the inventory weave.
 
4427
        """
 
4428
        if self._rich_root_upgrade():
 
4429
            import bzrlib.fetch
 
4430
            return bzrlib.fetch.Inter1and2Helper(
 
4431
                self.from_repository).generate_root_texts(revs)
 
4432
        else:
 
4433
            return []
 
4434
 
 
4435
    def get_stream(self, search):
 
4436
        phase = 'file'
 
4437
        revs = search.get_keys()
 
4438
        graph = self.from_repository.get_graph()
 
4439
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4440
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
 
4441
        text_keys = []
 
4442
        for knit_kind, file_id, revisions in data_to_fetch:
 
4443
            if knit_kind != phase:
 
4444
                phase = knit_kind
 
4445
                # Make a new progress bar for this phase
 
4446
            if knit_kind == "file":
 
4447
                # Accumulate file texts
 
4448
                text_keys.extend([(file_id, revision) for revision in
 
4449
                    revisions])
 
4450
            elif knit_kind == "inventory":
 
4451
                # Now copy the file texts.
 
4452
                from_texts = self.from_repository.texts
 
4453
                yield ('texts', from_texts.get_record_stream(
 
4454
                    text_keys, self.to_format._fetch_order,
 
4455
                    not self.to_format._fetch_uses_deltas))
 
4456
                # Cause an error if a text occurs after we have done the
 
4457
                # copy.
 
4458
                text_keys = None
 
4459
                # Before we process the inventory we generate the root
 
4460
                # texts (if necessary) so that the inventories references
 
4461
                # will be valid.
 
4462
                for _ in self._generate_root_texts(revs):
 
4463
                    yield _
 
4464
                # we fetch only the referenced inventories because we do not
 
4465
                # know for unselected inventories whether all their required
 
4466
                # texts are present in the other repository - it could be
 
4467
                # corrupt.
 
4468
                for info in self._get_inventory_stream(revs):
 
4469
                    yield info
 
4470
            elif knit_kind == "signatures":
 
4471
                # Nothing to do here; this will be taken care of when
 
4472
                # _fetch_revision_texts happens.
 
4473
                pass
 
4474
            elif knit_kind == "revisions":
 
4475
                for record in self._fetch_revision_texts(revs):
 
4476
                    yield record
 
4477
            else:
 
4478
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
4479
 
 
4480
    def get_stream_for_missing_keys(self, missing_keys):
 
4481
        # missing keys can only occur when we are byte copying and not
 
4482
        # translating (because translation means we don't send
 
4483
        # unreconstructable deltas ever).
 
4484
        keys = {}
 
4485
        keys['texts'] = set()
 
4486
        keys['revisions'] = set()
 
4487
        keys['inventories'] = set()
 
4488
        keys['chk_bytes'] = set()
 
4489
        keys['signatures'] = set()
 
4490
        for key in missing_keys:
 
4491
            keys[key[0]].add(key[1:])
 
4492
        if len(keys['revisions']):
 
4493
            # If we allowed copying revisions at this point, we could end up
 
4494
            # copying a revision without copying its required texts: a
 
4495
            # violation of the requirements for repository integrity.
 
4496
            raise AssertionError(
 
4497
                'cannot copy revisions to fill in missing deltas %s' % (
 
4498
                    keys['revisions'],))
 
4499
        for substream_kind, keys in keys.iteritems():
 
4500
            vf = getattr(self.from_repository, substream_kind)
 
4501
            if vf is None and keys:
 
4502
                    raise AssertionError(
 
4503
                        "cannot fill in keys for a versioned file we don't"
 
4504
                        " have: %s needs %s" % (substream_kind, keys))
 
4505
            if not keys:
 
4506
                # No need to stream something we don't have
 
4507
                continue
 
4508
            if substream_kind == 'inventories':
 
4509
                # Some missing keys are genuinely ghosts, filter those out.
 
4510
                present = self.from_repository.inventories.get_parent_map(keys)
 
4511
                revs = [key[0] for key in present]
 
4512
                # Get the inventory stream more-or-less as we do for the
 
4513
                # original stream; there's no reason to assume that records
 
4514
                # direct from the source will be suitable for the sink.  (Think
 
4515
                # e.g. 2a -> 1.9-rich-root).
 
4516
                for info in self._get_inventory_stream(revs, missing=True):
 
4517
                    yield info
 
4518
                continue
 
4519
 
 
4520
            # Ask for full texts always so that we don't need more round trips
 
4521
            # after this stream.
 
4522
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4523
            # records. The Sink is responsible for doing another check to
 
4524
            # ensure that ghosts don't introduce missing data for future
 
4525
            # fetches.
 
4526
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4527
                self.to_format._fetch_order, True))
 
4528
            yield substream_kind, stream
 
4529
 
 
4530
    def inventory_fetch_order(self):
 
4531
        if self._rich_root_upgrade():
 
4532
            return 'topological'
 
4533
        else:
 
4534
            return self.to_format._fetch_order
 
4535
 
 
4536
    def _rich_root_upgrade(self):
 
4537
        return (not self.from_repository._format.rich_root_data and
 
4538
            self.to_format.rich_root_data)
 
4539
 
 
4540
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4541
        from_format = self.from_repository._format
 
4542
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4543
            from_format.network_name() == self.to_format.network_name()):
 
4544
            raise AssertionError(
 
4545
                "this case should be handled by GroupCHKStreamSource")
 
4546
        elif 'forceinvdeltas' in debug.debug_flags:
 
4547
            return self._get_convertable_inventory_stream(revision_ids,
 
4548
                    delta_versus_null=missing)
 
4549
        elif from_format.network_name() == self.to_format.network_name():
 
4550
            # Same format.
 
4551
            return self._get_simple_inventory_stream(revision_ids,
 
4552
                    missing=missing)
 
4553
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4554
                and from_format._serializer == self.to_format._serializer):
 
4555
            # Essentially the same format.
 
4556
            return self._get_simple_inventory_stream(revision_ids,
 
4557
                    missing=missing)
 
4558
        else:
 
4559
            # Any time we switch serializations, we want to use an
 
4560
            # inventory-delta based approach.
 
4561
            return self._get_convertable_inventory_stream(revision_ids,
 
4562
                    delta_versus_null=missing)
 
4563
 
 
4564
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4565
        # NB: This currently reopens the inventory weave in source;
 
4566
        # using a single stream interface instead would avoid this.
 
4567
        from_weave = self.from_repository.inventories
 
4568
        if missing:
 
4569
            delta_closure = True
 
4570
        else:
 
4571
            delta_closure = not self.delta_on_metadata()
 
4572
        yield ('inventories', from_weave.get_record_stream(
 
4573
            [(rev_id,) for rev_id in revision_ids],
 
4574
            self.inventory_fetch_order(), delta_closure))
 
4575
 
 
4576
    def _get_convertable_inventory_stream(self, revision_ids,
 
4577
                                          delta_versus_null=False):
 
4578
        # The source is using CHKs, but the target either doesn't or it has a
 
4579
        # different serializer.  The StreamSink code expects to be able to
 
4580
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4581
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4582
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4583
        yield ('inventory-deltas',
 
4584
           self._stream_invs_as_deltas(revision_ids,
 
4585
                                       delta_versus_null=delta_versus_null))
 
4586
 
 
4587
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4588
        """Return a stream of inventory-deltas for the given rev ids.
 
4589
 
 
4590
        :param revision_ids: The list of inventories to transmit
 
4591
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4592
            entry, instead compute the delta versus the NULL_REVISION. This
 
4593
            effectively streams a complete inventory. Used for stuff like
 
4594
            filling in missing parents, etc.
 
4595
        """
 
4596
        from_repo = self.from_repository
 
4597
        revision_keys = [(rev_id,) for rev_id in revision_ids]
 
4598
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
 
4599
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4600
        # method...
 
4601
        inventories = self.from_repository.iter_inventories(
 
4602
            revision_ids, 'topological')
 
4603
        format = from_repo._format
 
4604
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4605
        inventory_cache = lru_cache.LRUCache(50)
 
4606
        null_inventory = from_repo.revision_tree(
 
4607
            _mod_revision.NULL_REVISION).inventory
 
4608
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4609
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4610
        # repo back into a non-rich-root repo ought to be allowed)
 
4611
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4612
            versioned_root=format.rich_root_data,
 
4613
            tree_references=format.supports_tree_reference)
 
4614
        for inv in inventories:
 
4615
            key = (inv.revision_id,)
 
4616
            parent_keys = parent_map.get(key, ())
 
4617
            delta = None
 
4618
            if not delta_versus_null and parent_keys:
 
4619
                # The caller did not ask for complete inventories and we have
 
4620
                # some parents that we can delta against.  Make a delta against
 
4621
                # each parent so that we can find the smallest.
 
4622
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4623
                for parent_id in parent_ids:
 
4624
                    if parent_id not in invs_sent_so_far:
 
4625
                        # We don't know that the remote side has this basis, so
 
4626
                        # we can't use it.
 
4627
                        continue
 
4628
                    if parent_id == _mod_revision.NULL_REVISION:
 
4629
                        parent_inv = null_inventory
 
4630
                    else:
 
4631
                        parent_inv = inventory_cache.get(parent_id, None)
 
4632
                        if parent_inv is None:
 
4633
                            parent_inv = from_repo.get_inventory(parent_id)
 
4634
                    candidate_delta = inv._make_delta(parent_inv)
 
4635
                    if (delta is None or
 
4636
                        len(delta) > len(candidate_delta)):
 
4637
                        delta = candidate_delta
 
4638
                        basis_id = parent_id
 
4639
            if delta is None:
 
4640
                # Either none of the parents ended up being suitable, or we
 
4641
                # were asked to delta against NULL
 
4642
                basis_id = _mod_revision.NULL_REVISION
 
4643
                delta = inv._make_delta(null_inventory)
 
4644
            invs_sent_so_far.add(inv.revision_id)
 
4645
            inventory_cache[inv.revision_id] = inv
 
4646
            delta_serialized = ''.join(
 
4647
                serializer.delta_to_lines(basis_id, key[-1], delta))
 
4648
            yield versionedfile.FulltextContentFactory(
 
4649
                key, parent_keys, None, delta_serialized)
 
4650
 
 
4651
 
 
4652
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
4653
                    stop_revision=None):
 
4654
    """Extend the partial history to include a given index
 
4655
 
 
4656
    If a stop_index is supplied, stop when that index has been reached.
 
4657
    If a stop_revision is supplied, stop when that revision is
 
4658
    encountered.  Otherwise, stop when the beginning of history is
 
4659
    reached.
 
4660
 
 
4661
    :param stop_index: The index which should be present.  When it is
 
4662
        present, history extension will stop.
 
4663
    :param stop_revision: The revision id which should be present.  When
 
4664
        it is encountered, history extension will stop.
 
4665
    """
 
4666
    start_revision = partial_history_cache[-1]
 
4667
    iterator = repo.iter_reverse_revision_history(start_revision)
 
4668
    try:
 
4669
        #skip the last revision in the list
 
4670
        iterator.next()
 
4671
        while True:
 
4672
            if (stop_index is not None and
 
4673
                len(partial_history_cache) > stop_index):
 
4674
                break
 
4675
            if partial_history_cache[-1] == stop_revision:
 
4676
                break
 
4677
            revision_id = iterator.next()
 
4678
            partial_history_cache.append(revision_id)
 
4679
    except StopIteration:
 
4680
        # No more history
 
4681
        return
 
4682