/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: Andrew Bennetts
  • Date: 2007-04-11 10:46:19 UTC
  • mto: This revision was merged to the branch mainline in revision 2410.
  • Revision ID: andrew.bennetts@canonical.com-20070411104619-f9hdzo9s4p63je91
Add a brief section on portability to HACKING.

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