/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-10 05:17:09 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070810051709-0rnxlur94samh192
move most existing topics into the User Guide dir for English

Show diffs side-by-side

added added

removed removed

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