← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-01 00:40:31 UTC
  • mfrom: (4081.2.5 bug513322-first)
  • Revision ID: pqm@pqm.ubuntu.com-20100401004031-pc7s84z6ahqunmy2
(mbp, for gagern) show first apparent author in gnu changelog

Show diffs side-by-side

added added

removed removed

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