← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Martin Pool
  • Date: 2008-05-01 02:42:46 UTC
  • mto: (3360.3.4 1.4)
  • mto: This revision was merged to the branch mainline in revision 3401.
  • Revision ID: mbp@sourcefrog.net-20080501024246-x13lcwcda0h7j49f
merge fix and test for #214894

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from __future__ import absolute_import
 
17
from cStringIO import StringIO
18
18
 
19
19
from bzrlib.lazy_import import lazy_import
20
20
lazy_import(globals(), """
21
 
import itertools
 
21
import re
22
22
import time
23
23
 
24
24
from bzrlib import (
25
 
    config,
26
 
    controldir,
 
25
    bzrdir,
 
26
    check,
27
27
    debug,
 
28
    deprecated_graph,
 
29
    errors,
28
30
    generate_ids,
 
31
    gpg,
29
32
    graph,
 
33
    lazy_regex,
30
34
    lockable_files,
31
35
    lockdir,
 
36
    lru_cache,
32
37
    osutils,
 
38
    registry,
 
39
    remote,
33
40
    revision as _mod_revision,
34
 
    testament as _mod_testament,
 
41
    symbol_versioning,
 
42
    transactions,
35
43
    tsort,
36
 
    gpg,
 
44
    ui,
37
45
    )
38
46
from bzrlib.bundle import serializer
39
 
from bzrlib.i18n import gettext
 
47
from bzrlib.revisiontree import RevisionTree
 
48
from bzrlib.store.versioned import VersionedFileStore
 
49
from bzrlib.store.text import TextStore
 
50
from bzrlib.testament import Testament
 
51
from bzrlib.util import bencode
40
52
""")
41
53
 
42
 
from bzrlib import (
43
 
    bzrdir,
44
 
    errors,
45
 
    registry,
46
 
    symbol_versioning,
47
 
    ui,
48
 
    )
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
54
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
55
from bzrlib.inter import InterObject
51
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
52
 
from bzrlib.trace import (
53
 
    log_exception_quietly, note, mutter, mutter_callsite, warning)
 
56
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
57
from bzrlib.symbol_versioning import (
 
58
        deprecated_method,
 
59
        )
 
60
from bzrlib.trace import mutter, mutter_callsite, note, warning
54
61
 
55
62
 
56
63
# Old formats display a warning, but only once
57
64
_deprecation_warning_done = False
58
65
 
59
66
 
60
 
class IsInWriteGroupError(errors.InternalBzrError):
61
 
 
62
 
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
63
 
 
64
 
    def __init__(self, repo):
65
 
        errors.InternalBzrError.__init__(self, repo=repo)
66
 
 
67
 
 
68
67
class CommitBuilder(object):
69
68
    """Provides an interface to build up a commit.
70
69
 
71
 
    This allows describing a tree to be committed without needing to
 
70
    This allows describing a tree to be committed without needing to 
72
71
    know the internals of the format of the repository.
73
72
    """
74
 
 
 
73
    
75
74
    # all clients should supply tree roots.
76
75
    record_root_entry = True
77
 
    # whether this commit builder supports the record_entry_contents interface
78
 
    supports_record_entry_contents = False
79
 
    # whether this commit builder will automatically update the branch that is
80
 
    # being committed to
81
 
    updates_branch = False
 
76
    # the default CommitBuilder does not manage trees whose root is versioned.
 
77
    _versioned_root = False
82
78
 
83
 
    def __init__(self, repository, parents, config_stack, timestamp=None,
 
79
    def __init__(self, repository, parents, config, timestamp=None,
84
80
                 timezone=None, committer=None, revprops=None,
85
 
                 revision_id=None, lossy=False):
 
81
                 revision_id=None):
86
82
        """Initiate a CommitBuilder.
87
83
 
88
84
        :param repository: Repository to commit to.
89
85
        :param parents: Revision ids of the parents of the new revision.
 
86
        :param config: Configuration to use.
90
87
        :param timestamp: Optional timestamp recorded for commit.
91
88
        :param timezone: Optional timezone for timestamp.
92
89
        :param committer: Optional committer to set for commit.
93
90
        :param revprops: Optional dictionary of revision properties.
94
91
        :param revision_id: Optional revision id.
95
 
        :param lossy: Whether to discard data that can not be natively
96
 
            represented, when pushing to a foreign VCS 
97
92
        """
98
 
        self._config_stack = config_stack
99
 
        self._lossy = lossy
 
93
        self._config = config
100
94
 
101
95
        if committer is None:
102
 
            self._committer = self._config_stack.get('email')
103
 
        elif not isinstance(committer, unicode):
104
 
            self._committer = committer.decode() # throw if non-ascii
 
96
            self._committer = self._config.username()
105
97
        else:
 
98
            assert isinstance(committer, basestring), type(committer)
106
99
            self._committer = committer
107
100
 
 
101
        self.new_inventory = Inventory(None)
108
102
        self._new_revision_id = revision_id
109
103
        self.parents = parents
110
104
        self.repository = repository
111
105
 
112
106
        self._revprops = {}
113
107
        if revprops is not None:
114
 
            self._validate_revprops(revprops)
115
108
            self._revprops.update(revprops)
116
109
 
117
110
        if timestamp is None:
125
118
            self._timezone = int(timezone)
126
119
 
127
120
        self._generate_revision_if_needed()
128
 
 
129
 
    def any_changes(self):
130
 
        """Return True if any entries were changed.
131
 
 
132
 
        This includes merge-only changes. It is the core for the --unchanged
133
 
        detection in commit.
134
 
 
135
 
        :return: True if any changes have occured.
136
 
        """
137
 
        raise NotImplementedError(self.any_changes)
138
 
 
139
 
    def _validate_unicode_text(self, text, context):
140
 
        """Verify things like commit messages don't have bogus characters."""
141
 
        if '\r' in text:
142
 
            raise ValueError('Invalid value for %s: %r' % (context, text))
143
 
 
144
 
    def _validate_revprops(self, revprops):
145
 
        for key, value in revprops.iteritems():
146
 
            # We know that the XML serializers do not round trip '\r'
147
 
            # correctly, so refuse to accept them
148
 
            if not isinstance(value, basestring):
149
 
                raise ValueError('revision property (%s) is not a valid'
150
 
                                 ' (unicode) string: %r' % (key, value))
151
 
            self._validate_unicode_text(value,
152
 
                                        'revision property (%s)' % (key,))
 
121
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
153
122
 
154
123
    def commit(self, message):
155
124
        """Make the actual commit.
156
125
 
157
126
        :return: The revision id of the recorded revision.
158
127
        """
159
 
        raise NotImplementedError(self.commit)
 
128
        rev = _mod_revision.Revision(
 
129
                       timestamp=self._timestamp,
 
130
                       timezone=self._timezone,
 
131
                       committer=self._committer,
 
132
                       message=message,
 
133
                       inventory_sha1=self.inv_sha1,
 
134
                       revision_id=self._new_revision_id,
 
135
                       properties=self._revprops)
 
136
        rev.parent_ids = self.parents
 
137
        self.repository.add_revision(self._new_revision_id, rev,
 
138
            self.new_inventory, self._config)
 
139
        self.repository.commit_write_group()
 
140
        return self._new_revision_id
160
141
 
161
142
    def abort(self):
162
143
        """Abort the commit that is being built.
163
144
        """
164
 
        raise NotImplementedError(self.abort)
 
145
        self.repository.abort_write_group()
165
146
 
166
147
    def revision_tree(self):
167
148
        """Return the tree that was just committed.
168
149
 
169
 
        After calling commit() this can be called to get a
170
 
        RevisionTree representing the newly committed tree. This is
171
 
        preferred to calling Repository.revision_tree() because that may
172
 
        require deserializing the inventory, while we already have a copy in
 
150
        After calling commit() this can be called to get a RevisionTree
 
151
        representing the newly committed tree. This is preferred to
 
152
        calling Repository.revision_tree() because that may require
 
153
        deserializing the inventory, while we already have a copy in
173
154
        memory.
174
155
        """
175
 
        raise NotImplementedError(self.revision_tree)
 
156
        return RevisionTree(self.repository, self.new_inventory,
 
157
                            self._new_revision_id)
176
158
 
177
159
    def finish_inventory(self):
178
 
        """Tell the builder that the inventory is finished.
179
 
 
180
 
        :return: The inventory id in the repository, which can be used with
181
 
            repository.get_inventory.
182
 
        """
183
 
        raise NotImplementedError(self.finish_inventory)
 
160
        """Tell the builder that the inventory is finished."""
 
161
        if self.new_inventory.root is None:
 
162
            raise AssertionError('Root entry should be supplied to'
 
163
                ' record_entry_contents, as of bzr 0.10.',
 
164
                 DeprecationWarning, stacklevel=2)
 
165
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
166
        self.new_inventory.revision_id = self._new_revision_id
 
167
        self.inv_sha1 = self.repository.add_inventory(
 
168
            self._new_revision_id,
 
169
            self.new_inventory,
 
170
            self.parents
 
171
            )
184
172
 
185
173
    def _gen_revision_id(self):
186
174
        """Return new revision-id."""
187
 
        return generate_ids.gen_revision_id(self._committer, self._timestamp)
 
175
        return generate_ids.gen_revision_id(self._config.username(),
 
176
                                            self._timestamp)
188
177
 
189
178
    def _generate_revision_if_needed(self):
190
179
        """Create a revision id if None was supplied.
191
 
 
 
180
        
192
181
        If the repository can not support user-specified revision ids
193
182
        they should override this function and raise CannotSetRevisionId
194
183
        if _new_revision_id is not None.
201
190
        else:
202
191
            self.random_revid = False
203
192
 
204
 
    def will_record_deletes(self):
205
 
        """Tell the commit builder that deletes are being notified.
206
 
 
207
 
        This enables the accumulation of an inventory delta; for the resulting
208
 
        commit to be valid, deletes against the basis MUST be recorded via
209
 
        builder.record_delete().
210
 
        """
211
 
        raise NotImplementedError(self.will_record_deletes)
212
 
 
213
 
    def record_iter_changes(self, tree, basis_revision_id, iter_changes):
214
 
        """Record a new tree via iter_changes.
215
 
 
216
 
        :param tree: The tree to obtain text contents from for changed objects.
217
 
        :param basis_revision_id: The revision id of the tree the iter_changes
218
 
            has been generated against. Currently assumed to be the same
219
 
            as self.parents[0] - if it is not, errors may occur.
220
 
        :param iter_changes: An iter_changes iterator with the changes to apply
221
 
            to basis_revision_id. The iterator must not include any items with
222
 
            a current kind of None - missing items must be either filtered out
223
 
            or errored-on beefore record_iter_changes sees the item.
224
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
225
 
            tree._observed_sha1.
226
 
        """
227
 
        raise NotImplementedError(self.record_iter_changes)
228
 
 
229
 
 
230
 
class RepositoryWriteLockResult(LogicalLockResult):
231
 
    """The result of write locking a repository.
232
 
 
233
 
    :ivar repository_token: The token obtained from the underlying lock, or
234
 
        None.
235
 
    :ivar unlock: A callable which will unlock the lock.
236
 
    """
237
 
 
238
 
    def __init__(self, unlock, repository_token):
239
 
        LogicalLockResult.__init__(self, unlock)
240
 
        self.repository_token = repository_token
241
 
 
242
 
    def __repr__(self):
243
 
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
244
 
            self.unlock)
 
193
    def _heads(self, file_id, revision_ids):
 
194
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
195
 
 
196
        This can use either a per-file graph or a global revision graph as we
 
197
        have an identity relationship between the two graphs.
 
198
        """
 
199
        return self.__heads(revision_ids)
 
200
 
 
201
    def _check_root(self, ie, parent_invs, tree):
 
202
        """Helper for record_entry_contents.
 
203
 
 
204
        :param ie: An entry being added.
 
205
        :param parent_invs: The inventories of the parent revisions of the
 
206
            commit.
 
207
        :param tree: The tree that is being committed.
 
208
        """
 
209
        # In this revision format, root entries have no knit or weave When
 
210
        # serializing out to disk and back in root.revision is always
 
211
        # _new_revision_id
 
212
        ie.revision = self._new_revision_id
 
213
 
 
214
    def _get_delta(self, ie, basis_inv, path):
 
215
        """Get a delta against the basis inventory for ie."""
 
216
        if ie.file_id not in basis_inv:
 
217
            # add
 
218
            return (None, path, ie.file_id, ie)
 
219
        elif ie != basis_inv[ie.file_id]:
 
220
            # common but altered
 
221
            # TODO: avoid tis id2path call.
 
222
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
223
        else:
 
224
            # common, unaltered
 
225
            return None
 
226
 
 
227
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
228
        content_summary):
 
229
        """Record the content of ie from tree into the commit if needed.
 
230
 
 
231
        Side effect: sets ie.revision when unchanged
 
232
 
 
233
        :param ie: An inventory entry present in the commit.
 
234
        :param parent_invs: The inventories of the parent revisions of the
 
235
            commit.
 
236
        :param path: The path the entry is at in the tree.
 
237
        :param tree: The tree which contains this entry and should be used to 
 
238
            obtain content.
 
239
        :param content_summary: Summary data from the tree about the paths
 
240
            content - stat, length, exec, sha/link target. This is only
 
241
            accessed when the entry has a revision of None - that is when it is
 
242
            a candidate to commit.
 
243
        :return: A tuple (change_delta, version_recorded). change_delta is 
 
244
            an inventory_delta change for this entry against the basis tree of
 
245
            the commit, or None if no change occured against the basis tree.
 
246
            version_recorded is True if a new version of the entry has been
 
247
            recorded. For instance, committing a merge where a file was only
 
248
            changed on the other side will return (delta, False).
 
249
        """
 
250
        if self.new_inventory.root is None:
 
251
            if ie.parent_id is not None:
 
252
                raise errors.RootMissing()
 
253
            self._check_root(ie, parent_invs, tree)
 
254
        if ie.revision is None:
 
255
            kind = content_summary[0]
 
256
        else:
 
257
            # ie is carried over from a prior commit
 
258
            kind = ie.kind
 
259
        # XXX: repository specific check for nested tree support goes here - if
 
260
        # the repo doesn't want nested trees we skip it ?
 
261
        if (kind == 'tree-reference' and
 
262
            not self.repository._format.supports_tree_reference):
 
263
            # mismatch between commit builder logic and repository:
 
264
            # this needs the entry creation pushed down into the builder.
 
265
            raise NotImplementedError('Missing repository subtree support.')
 
266
        self.new_inventory.add(ie)
 
267
 
 
268
        # TODO: slow, take it out of the inner loop.
 
269
        try:
 
270
            basis_inv = parent_invs[0]
 
271
        except IndexError:
 
272
            basis_inv = Inventory(root_id=None)
 
273
 
 
274
        # ie.revision is always None if the InventoryEntry is considered
 
275
        # for committing. We may record the previous parents revision if the
 
276
        # content is actually unchanged against a sole head.
 
277
        if ie.revision is not None:
 
278
            if not self._versioned_root and path == '':
 
279
                # repositories that do not version the root set the root's
 
280
                # revision to the new commit even when no change occurs, and
 
281
                # this masks when a change may have occurred against the basis,
 
282
                # so calculate if one happened.
 
283
                if ie.file_id in basis_inv:
 
284
                    delta = (basis_inv.id2path(ie.file_id), path,
 
285
                        ie.file_id, ie)
 
286
                else:
 
287
                    # add
 
288
                    delta = (None, path, ie.file_id, ie)
 
289
                return delta, False
 
290
            else:
 
291
                # we don't need to commit this, because the caller already
 
292
                # determined that an existing revision of this file is
 
293
                # appropriate.
 
294
                return None, (ie.revision == self._new_revision_id)
 
295
        # XXX: Friction: parent_candidates should return a list not a dict
 
296
        #      so that we don't have to walk the inventories again.
 
297
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
298
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
299
        heads = []
 
300
        for inv in parent_invs:
 
301
            if ie.file_id in inv:
 
302
                old_rev = inv[ie.file_id].revision
 
303
                if old_rev in head_set:
 
304
                    heads.append(inv[ie.file_id].revision)
 
305
                    head_set.remove(inv[ie.file_id].revision)
 
306
 
 
307
        store = False
 
308
        # now we check to see if we need to write a new record to the
 
309
        # file-graph.
 
310
        # We write a new entry unless there is one head to the ancestors, and
 
311
        # the kind-derived content is unchanged.
 
312
 
 
313
        # Cheapest check first: no ancestors, or more the one head in the
 
314
        # ancestors, we write a new node.
 
315
        if len(heads) != 1:
 
316
            store = True
 
317
        if not store:
 
318
            # There is a single head, look it up for comparison
 
319
            parent_entry = parent_candiate_entries[heads[0]]
 
320
            # if the non-content specific data has changed, we'll be writing a
 
321
            # node:
 
322
            if (parent_entry.parent_id != ie.parent_id or
 
323
                parent_entry.name != ie.name):
 
324
                store = True
 
325
        # now we need to do content specific checks:
 
326
        if not store:
 
327
            # if the kind changed the content obviously has
 
328
            if kind != parent_entry.kind:
 
329
                store = True
 
330
        if kind == 'file':
 
331
            assert content_summary[2] is not None, \
 
332
                "Files must not have executable = None"
 
333
            if not store:
 
334
                if (# if the file length changed we have to store:
 
335
                    parent_entry.text_size != content_summary[1] or
 
336
                    # if the exec bit has changed we have to store:
 
337
                    parent_entry.executable != content_summary[2]):
 
338
                    store = True
 
339
                elif parent_entry.text_sha1 == content_summary[3]:
 
340
                    # all meta and content is unchanged (using a hash cache
 
341
                    # hit to check the sha)
 
342
                    ie.revision = parent_entry.revision
 
343
                    ie.text_size = parent_entry.text_size
 
344
                    ie.text_sha1 = parent_entry.text_sha1
 
345
                    ie.executable = parent_entry.executable
 
346
                    return self._get_delta(ie, basis_inv, path), False
 
347
                else:
 
348
                    # Either there is only a hash change(no hash cache entry,
 
349
                    # or same size content change), or there is no change on
 
350
                    # this file at all.
 
351
                    # Provide the parent's hash to the store layer, so that the
 
352
                    # content is unchanged we will not store a new node.
 
353
                    nostore_sha = parent_entry.text_sha1
 
354
            if store:
 
355
                # We want to record a new node regardless of the presence or
 
356
                # absence of a content change in the file.
 
357
                nostore_sha = None
 
358
            ie.executable = content_summary[2]
 
359
            lines = tree.get_file(ie.file_id, path).readlines()
 
360
            try:
 
361
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
362
                    ie.file_id, lines, heads, nostore_sha)
 
363
            except errors.ExistingContent:
 
364
                # Turns out that the file content was unchanged, and we were
 
365
                # only going to store a new node if it was changed. Carry over
 
366
                # the entry.
 
367
                ie.revision = parent_entry.revision
 
368
                ie.text_size = parent_entry.text_size
 
369
                ie.text_sha1 = parent_entry.text_sha1
 
370
                ie.executable = parent_entry.executable
 
371
                return self._get_delta(ie, basis_inv, path), False
 
372
        elif kind == 'directory':
 
373
            if not store:
 
374
                # all data is meta here, nothing specific to directory, so
 
375
                # carry over:
 
376
                ie.revision = parent_entry.revision
 
377
                return self._get_delta(ie, basis_inv, path), False
 
378
            lines = []
 
379
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
380
        elif kind == 'symlink':
 
381
            current_link_target = content_summary[3]
 
382
            if not store:
 
383
                # symlink target is not generic metadata, check if it has
 
384
                # changed.
 
385
                if current_link_target != parent_entry.symlink_target:
 
386
                    store = True
 
387
            if not store:
 
388
                # unchanged, carry over.
 
389
                ie.revision = parent_entry.revision
 
390
                ie.symlink_target = parent_entry.symlink_target
 
391
                return self._get_delta(ie, basis_inv, path), False
 
392
            ie.symlink_target = current_link_target
 
393
            lines = []
 
394
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
395
        elif kind == 'tree-reference':
 
396
            if not store:
 
397
                if content_summary[3] != parent_entry.reference_revision:
 
398
                    store = True
 
399
            if not store:
 
400
                # unchanged, carry over.
 
401
                ie.reference_revision = parent_entry.reference_revision
 
402
                ie.revision = parent_entry.revision
 
403
                return self._get_delta(ie, basis_inv, path), False
 
404
            ie.reference_revision = content_summary[3]
 
405
            lines = []
 
406
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
407
        else:
 
408
            raise NotImplementedError('unknown kind')
 
409
        ie.revision = self._new_revision_id
 
410
        return self._get_delta(ie, basis_inv, path), True
 
411
 
 
412
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
413
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
414
            file_id, self.repository.get_transaction())
 
415
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
416
        # than add_lines, and allows committing when a parent is ghosted for
 
417
        # some reason.
 
418
        # Note: as we read the content directly from the tree, we know its not
 
419
        # been turned into unicode or badly split - but a broken tree
 
420
        # implementation could give us bad output from readlines() so this is
 
421
        # not a guarantee of safety. What would be better is always checking
 
422
        # the content during test suite execution. RBC 20070912
 
423
        return versionedfile.add_lines_with_ghosts(
 
424
            self._new_revision_id, parents, new_lines,
 
425
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
426
            check_content=False)[0:2]
 
427
 
 
428
 
 
429
class RootCommitBuilder(CommitBuilder):
 
430
    """This commitbuilder actually records the root id"""
 
431
    
 
432
    # the root entry gets versioned properly by this builder.
 
433
    _versioned_root = True
 
434
 
 
435
    def _check_root(self, ie, parent_invs, tree):
 
436
        """Helper for record_entry_contents.
 
437
 
 
438
        :param ie: An entry being added.
 
439
        :param parent_invs: The inventories of the parent revisions of the
 
440
            commit.
 
441
        :param tree: The tree that is being committed.
 
442
        """
245
443
 
246
444
 
247
445
######################################################################
248
446
# Repositories
249
447
 
250
 
 
251
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
448
class Repository(object):
252
449
    """Repository holding history for one or more branches.
253
450
 
254
451
    The repository holds and retrieves historical information including
255
452
    revisions and file history.  It's normally accessed only by the Branch,
256
453
    which views a particular line of development through that history.
257
454
 
258
 
    See VersionedFileRepository in bzrlib.vf_repository for the
259
 
    base class for most Bazaar repositories.
 
455
    The Repository builds on top of Stores and a Transport, which respectively 
 
456
    describe the disk data format and the way of accessing the (possibly 
 
457
    remote) disk.
260
458
    """
261
459
 
262
 
    def abort_write_group(self, suppress_errors=False):
 
460
    # What class to use for a CommitBuilder. Often its simpler to change this
 
461
    # in a Repository class subclass rather than to override
 
462
    # get_commit_builder.
 
463
    _commit_builder_class = CommitBuilder
 
464
    # The search regex used by xml based repositories to determine what things
 
465
    # where changed in a single commit.
 
466
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
467
        r'file_id="(?P<file_id>[^"]+)"'
 
468
        r'.* revision="(?P<revision_id>[^"]+)"'
 
469
        )
 
470
 
 
471
    def abort_write_group(self):
263
472
        """Commit the contents accrued within the current write group.
264
473
 
265
 
        :param suppress_errors: if true, abort_write_group will catch and log
266
 
            unexpected errors that happen during the abort, rather than
267
 
            allowing them to propagate.  Defaults to False.
268
 
 
269
474
        :seealso: start_write_group.
270
475
        """
271
476
        if self._write_group is not self.get_transaction():
272
477
            # has an unlock or relock occured ?
273
 
            if suppress_errors:
274
 
                mutter(
275
 
                '(suppressed) mismatched lock context and write group. %r, %r',
276
 
                self._write_group, self.get_transaction())
277
 
                return
278
 
            raise errors.BzrError(
279
 
                'mismatched lock context and write group. %r, %r' %
280
 
                (self._write_group, self.get_transaction()))
281
 
        try:
282
 
            self._abort_write_group()
283
 
        except Exception, exc:
284
 
            self._write_group = None
285
 
            if not suppress_errors:
286
 
                raise
287
 
            mutter('abort_write_group failed')
288
 
            log_exception_quietly()
289
 
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
478
            raise errors.BzrError('mismatched lock context and write group.')
 
479
        self._abort_write_group()
290
480
        self._write_group = None
291
481
 
292
482
    def _abort_write_group(self):
293
483
        """Template method for per-repository write group cleanup.
294
 
 
295
 
        This is called during abort before the write group is considered to be
 
484
        
 
485
        This is called during abort before the write group is considered to be 
296
486
        finished and should cleanup any internal state accrued during the write
297
487
        group. There is no requirement that data handed to the repository be
298
488
        *not* made available - this is not a rollback - but neither should any
302
492
        attempted.
303
493
        """
304
494
 
305
 
    def add_fallback_repository(self, repository):
306
 
        """Add a repository to use for looking up data not held locally.
307
 
 
308
 
        :param repository: A repository.
309
 
        """
310
 
        raise NotImplementedError(self.add_fallback_repository)
311
 
 
312
 
    def _check_fallback_repository(self, repository):
313
 
        """Check that this repository can fallback to repository safely.
314
 
 
315
 
        Raise an error if not.
316
 
 
317
 
        :param repository: A repository to fallback to.
318
 
        """
319
 
        return InterRepository._assert_same_model(self, repository)
 
495
    def add_inventory(self, revision_id, inv, parents):
 
496
        """Add the inventory inv to the repository as revision_id.
 
497
        
 
498
        :param parents: The revision ids of the parents that revision_id
 
499
                        is known to have and are in the repository already.
 
500
 
 
501
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
502
            repository format specific) of the serialized inventory.
 
503
        """
 
504
        assert self.is_in_write_group()
 
505
        _mod_revision.check_not_reserved_id(revision_id)
 
506
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
507
            "Mismatch between inventory revision" \
 
508
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
509
        assert inv.root is not None
 
510
        inv_lines = self._serialise_inventory_to_lines(inv)
 
511
        inv_vf = self.get_inventory_weave()
 
512
        return self._inventory_add_lines(inv_vf, revision_id, parents,
 
513
            inv_lines, check_content=False)
 
514
 
 
515
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
 
516
        check_content=True):
 
517
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
518
        final_parents = []
 
519
        for parent in parents:
 
520
            if parent in inv_vf:
 
521
                final_parents.append(parent)
 
522
        return inv_vf.add_lines(revision_id, final_parents, lines,
 
523
            check_content=check_content)[0]
 
524
 
 
525
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
526
        """Add rev to the revision store as revision_id.
 
527
 
 
528
        :param revision_id: the revision id to use.
 
529
        :param rev: The revision object.
 
530
        :param inv: The inventory for the revision. if None, it will be looked
 
531
                    up in the inventory storer
 
532
        :param config: If None no digital signature will be created.
 
533
                       If supplied its signature_needed method will be used
 
534
                       to determine if a signature should be made.
 
535
        """
 
536
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
537
        #       rev.parent_ids?
 
538
        _mod_revision.check_not_reserved_id(revision_id)
 
539
        if config is not None and config.signature_needed():
 
540
            if inv is None:
 
541
                inv = self.get_inventory(revision_id)
 
542
            plaintext = Testament(rev, inv).as_short_text()
 
543
            self.store_revision_signature(
 
544
                gpg.GPGStrategy(config), plaintext, revision_id)
 
545
        if not revision_id in self.get_inventory_weave():
 
546
            if inv is None:
 
547
                raise errors.WeaveRevisionNotPresent(revision_id,
 
548
                                                     self.get_inventory_weave())
 
549
            else:
 
550
                # yes, this is not suitable for adding with ghosts.
 
551
                rev.inventory_sha1 = self.add_inventory(revision_id, inv, 
 
552
                                                        rev.parent_ids)
 
553
        self._revision_store.add_revision(rev, self.get_transaction())
 
554
 
 
555
    def _add_revision_text(self, revision_id, text):
 
556
        revision = self._revision_store._serializer.read_revision_from_string(
 
557
            text)
 
558
        self._revision_store._add_revision(revision, StringIO(text),
 
559
                                           self.get_transaction())
320
560
 
321
561
    def all_revision_ids(self):
322
 
        """Returns a list of all the revision ids in the repository.
 
562
        """Returns a list of all the revision ids in the repository. 
323
563
 
324
 
        This is conceptually deprecated because code should generally work on
325
 
        the graph reachable from a particular revision, and ignore any other
326
 
        revisions that might be present.  There is no direct replacement
327
 
        method.
 
564
        This is deprecated because code should generally work on the graph
 
565
        reachable from a particular revision, and ignore any other revisions
 
566
        that might be present.  There is no direct replacement method.
328
567
        """
329
568
        if 'evil' in debug.debug_flags:
330
569
            mutter_callsite(2, "all_revision_ids is linear with history.")
331
570
        return self._all_revision_ids()
332
571
 
333
572
    def _all_revision_ids(self):
334
 
        """Returns a list of all the revision ids in the repository.
 
573
        """Returns a list of all the revision ids in the repository. 
335
574
 
336
 
        These are in as much topological order as the underlying store can
 
575
        These are in as much topological order as the underlying store can 
337
576
        present.
338
577
        """
339
578
        raise NotImplementedError(self._all_revision_ids)
346
585
        """
347
586
        self.control_files.break_lock()
348
587
 
 
588
    @needs_read_lock
 
589
    def _eliminate_revisions_not_present(self, revision_ids):
 
590
        """Check every revision id in revision_ids to see if we have it.
 
591
 
 
592
        Returns a set of the present revisions.
 
593
        """
 
594
        result = []
 
595
        graph = self.get_graph()
 
596
        parent_map = graph.get_parent_map(revision_ids)
 
597
        # The old API returned a list, should this actually be a set?
 
598
        return parent_map.keys()
 
599
 
349
600
    @staticmethod
350
 
    def create(controldir):
351
 
        """Construct the current default format repository in controldir."""
352
 
        return RepositoryFormat.get_default_format().initialize(controldir)
 
601
    def create(a_bzrdir):
 
602
        """Construct the current default format repository in a_bzrdir."""
 
603
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
353
604
 
354
 
    def __init__(self, _format, controldir, control_files):
 
605
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
355
606
        """instantiate a Repository.
356
607
 
357
608
        :param _format: The format of the repository on disk.
358
 
        :param controldir: The ControlDir of the repository.
359
 
        :param control_files: Control files to use for locking, etc.
 
609
        :param a_bzrdir: The BzrDir of the repository.
 
610
 
 
611
        In the future we will have a single api for all stores for
 
612
        getting file texts, inventories and revisions, then
 
613
        this construct will accept instances of those things.
360
614
        """
361
 
        # In the future we will have a single api for all stores for
362
 
        # getting file texts, inventories and revisions, then
363
 
        # this construct will accept instances of those things.
364
615
        super(Repository, self).__init__()
365
616
        self._format = _format
366
617
        # the following are part of the public API for Repository:
367
 
        self.bzrdir = controldir
 
618
        self.bzrdir = a_bzrdir
368
619
        self.control_files = control_files
 
620
        self._revision_store = _revision_store
 
621
        # backwards compatibility
 
622
        self.weave_store = text_store
369
623
        # for tests
 
624
        self._reconcile_does_inventory_gc = True
 
625
        self._reconcile_fixes_text_parents = False
 
626
        self._reconcile_backsup_inventory = True
 
627
        # not right yet - should be more semantically clear ? 
 
628
        # 
 
629
        self.control_store = control_store
 
630
        self.control_weaves = control_store
 
631
        # TODO: make sure to construct the right store classes, etc, depending
 
632
        # on whether escaping is required.
 
633
        self._warn_if_deprecated()
370
634
        self._write_group = None
371
 
        # Additional places to query for data.
372
 
        self._fallback_repositories = []
373
 
 
374
 
    @property
375
 
    def user_transport(self):
376
 
        return self.bzrdir.user_transport
377
 
 
378
 
    @property
379
 
    def control_transport(self):
380
 
        return self._transport
 
635
        self.base = control_files._transport.base
381
636
 
382
637
    def __repr__(self):
383
 
        if self._fallback_repositories:
384
 
            return '%s(%r, fallback_repositories=%r)' % (
385
 
                self.__class__.__name__,
386
 
                self.base,
387
 
                self._fallback_repositories)
388
 
        else:
389
 
            return '%s(%r)' % (self.__class__.__name__,
390
 
                               self.base)
391
 
 
392
 
    def _has_same_fallbacks(self, other_repo):
393
 
        """Returns true if the repositories have the same fallbacks."""
394
 
        my_fb = self._fallback_repositories
395
 
        other_fb = other_repo._fallback_repositories
396
 
        if len(my_fb) != len(other_fb):
397
 
            return False
398
 
        for f, g in zip(my_fb, other_fb):
399
 
            if not f.has_same_location(g):
400
 
                return False
401
 
        return True
 
638
        return '%s(%r)' % (self.__class__.__name__,
 
639
                           self.base)
402
640
 
403
641
    def has_same_location(self, other):
404
642
        """Returns a boolean indicating if this repository is at the same
409
647
        """
410
648
        if self.__class__ is not other.__class__:
411
649
            return False
412
 
        return (self.control_url == other.control_url)
 
650
        return (self.control_files._transport.base ==
 
651
                other.control_files._transport.base)
413
652
 
414
653
    def is_in_write_group(self):
415
654
        """Return True if there is an open write group.
431
670
        This causes caching within the repository obejct to start accumlating
432
671
        data during reads, and allows a 'write_group' to be obtained. Write
433
672
        groups must be used for actual data insertion.
434
 
 
435
 
        A token should be passed in if you know that you have locked the object
436
 
        some other way, and need to synchronise this object's state with that
437
 
        fact.
438
 
 
439
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
440
 
 
 
673
        
441
674
        :param token: if this is already locked, then lock_write will fail
442
675
            unless the token matches the existing lock.
443
676
        :returns: a token if this instance supports tokens, otherwise None.
446
679
        :raises MismatchedToken: if the specified token doesn't match the token
447
680
            of the existing lock.
448
681
        :seealso: start_write_group.
449
 
        :return: A RepositoryWriteLockResult.
 
682
 
 
683
        A token should be passed in if you know that you have locked the object
 
684
        some other way, and need to synchronise this object's state with that
 
685
        fact.
 
686
 
 
687
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
450
688
        """
451
 
        locked = self.is_locked()
452
 
        token = self.control_files.lock_write(token=token)
453
 
        if not locked:
454
 
            self._warn_if_deprecated()
455
 
            self._note_lock('w')
456
 
            for repo in self._fallback_repositories:
457
 
                # Writes don't affect fallback repos
458
 
                repo.lock_read()
459
 
            self._refresh_data()
460
 
        return RepositoryWriteLockResult(self.unlock, token)
 
689
        result = self.control_files.lock_write(token=token)
 
690
        self._refresh_data()
 
691
        return result
461
692
 
462
693
    def lock_read(self):
463
 
        """Lock the repository for read operations.
464
 
 
465
 
        :return: An object with an unlock method which will release the lock
466
 
            obtained.
467
 
        """
468
 
        locked = self.is_locked()
469
694
        self.control_files.lock_read()
470
 
        if not locked:
471
 
            self._warn_if_deprecated()
472
 
            self._note_lock('r')
473
 
            for repo in self._fallback_repositories:
474
 
                repo.lock_read()
475
 
            self._refresh_data()
476
 
        return LogicalLockResult(self.unlock)
 
695
        self._refresh_data()
477
696
 
478
697
    def get_physical_lock_status(self):
479
698
        return self.control_files.get_physical_lock_status()
481
700
    def leave_lock_in_place(self):
482
701
        """Tell this repository not to release the physical lock when this
483
702
        object is unlocked.
484
 
 
 
703
        
485
704
        If lock_write doesn't return a token, then this method is not supported.
486
705
        """
487
706
        self.control_files.leave_in_place()
515
734
        if revid and committers:
516
735
            result['committers'] = 0
517
736
        if revid and revid != _mod_revision.NULL_REVISION:
518
 
            graph = self.get_graph()
519
737
            if committers:
520
738
                all_committers = set()
521
 
            revisions = [r for (r, p) in graph.iter_ancestry([revid])
522
 
                        if r != _mod_revision.NULL_REVISION]
523
 
            last_revision = None
 
739
            revisions = self.get_ancestry(revid)
 
740
            # pop the leading None
 
741
            revisions.pop(0)
 
742
            first_revision = None
524
743
            if not committers:
525
744
                # ignore the revisions in the middle - just grab first and last
526
745
                revisions = revisions[0], revisions[-1]
527
746
            for revision in self.get_revisions(revisions):
528
 
                if not last_revision:
529
 
                    last_revision = revision
 
747
                if not first_revision:
 
748
                    first_revision = revision
530
749
                if committers:
531
750
                    all_committers.add(revision.committer)
532
 
            first_revision = revision
 
751
            last_revision = revision
533
752
            if committers:
534
753
                result['committers'] = len(all_committers)
535
754
            result['firstrev'] = (first_revision.timestamp,
536
755
                first_revision.timezone)
537
756
            result['latestrev'] = (last_revision.timestamp,
538
757
                last_revision.timezone)
 
758
 
 
759
        # now gather global repository information
 
760
        if self.bzrdir.root_transport.listable():
 
761
            c, t = self._revision_store.total_size(self.get_transaction())
 
762
            result['revisions'] = c
 
763
            result['size'] = t
539
764
        return result
540
765
 
541
766
    def find_branches(self, using=False):
546
771
        :param using: If True, list only branches using this repository.
547
772
        """
548
773
        if using and not self.is_shared():
549
 
            return self.bzrdir.list_branches()
 
774
            try:
 
775
                return [self.bzrdir.open_branch()]
 
776
            except errors.NotBranchError:
 
777
                return []
550
778
        class Evaluator(object):
551
779
 
552
780
            def __init__(self):
553
781
                self.first_call = True
554
782
 
555
 
            def __call__(self, controldir):
556
 
                # On the first call, the parameter is always the controldir
 
783
            def __call__(self, bzrdir):
 
784
                # On the first call, the parameter is always the bzrdir
557
785
                # containing the current repo.
558
786
                if not self.first_call:
559
787
                    try:
560
 
                        repository = controldir.open_repository()
 
788
                        repository = bzrdir.open_repository()
561
789
                    except errors.NoRepositoryPresent:
562
790
                        pass
563
791
                    else:
564
 
                        return False, ([], repository)
 
792
                        return False, (None, repository)
565
793
                self.first_call = False
566
 
                value = (controldir.list_branches(), None)
 
794
                try:
 
795
                    value = (bzrdir.open_branch(), None)
 
796
                except errors.NotBranchError:
 
797
                    value = (None, None)
567
798
                return True, value
568
799
 
569
 
        ret = []
570
 
        for branches, repository in controldir.ControlDir.find_bzrdirs(
571
 
                self.user_transport, evaluate=Evaluator()):
572
 
            if branches is not None:
573
 
                ret.extend(branches)
 
800
        branches = []
 
801
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
802
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
803
            if branch is not None:
 
804
                branches.append(branch)
574
805
            if not using and repository is not None:
575
 
                ret.extend(repository.find_branches())
576
 
        return ret
 
806
                branches.extend(repository.find_branches())
 
807
        return branches
 
808
 
 
809
    def get_data_stream(self, revision_ids):
 
810
        raise NotImplementedError(self.get_data_stream)
 
811
 
 
812
    def get_data_stream_for_search(self, search_result):
 
813
        """Get a data stream that can be inserted to a repository.
 
814
 
 
815
        :param search_result: A bzrlib.graph.SearchResult selecting the
 
816
            revisions to get.
 
817
        :return: A data stream that can be inserted into a repository using
 
818
            insert_data_stream.
 
819
        """
 
820
        raise NotImplementedError(self.get_data_stream_for_search)
 
821
 
 
822
    def insert_data_stream(self, stream):
 
823
        """XXX What does this really do? 
 
824
        
 
825
        Is it a substitute for fetch? 
 
826
        Should it manage its own write group ?
 
827
        """
 
828
        for item_key, bytes in stream:
 
829
            if item_key[0] == 'file':
 
830
                (file_id,) = item_key[1:]
 
831
                knit = self.weave_store.get_weave_or_empty(
 
832
                    file_id, self.get_transaction())
 
833
            elif item_key == ('inventory',):
 
834
                knit = self.get_inventory_weave()
 
835
            elif item_key == ('revisions',):
 
836
                knit = self._revision_store.get_revision_file(
 
837
                    self.get_transaction())
 
838
            elif item_key == ('signatures',):
 
839
                knit = self._revision_store.get_signature_file(
 
840
                    self.get_transaction())
 
841
            else:
 
842
                raise errors.RepositoryDataStreamError(
 
843
                    "Unrecognised data stream key '%s'" % (item_key,))
 
844
            decoded_list = bencode.bdecode(bytes)
 
845
            format = decoded_list.pop(0)
 
846
            data_list = []
 
847
            knit_bytes = ''
 
848
            for version, options, parents, some_bytes in decoded_list:
 
849
                data_list.append((version, options, len(some_bytes), parents))
 
850
                knit_bytes += some_bytes
 
851
            buffer = StringIO(knit_bytes)
 
852
            def reader_func(count):
 
853
                if count is None:
 
854
                    return buffer.read()
 
855
                else:
 
856
                    return buffer.read(count)
 
857
            knit.insert_data_stream(
 
858
                (format, data_list, reader_func))
577
859
 
578
860
    @needs_read_lock
579
 
    def search_missing_revision_ids(self, other,
580
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
581
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
582
 
            limit=None):
 
861
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
583
862
        """Return the revision ids that other has that this does not.
584
 
 
 
863
        
585
864
        These are returned in topological order.
586
865
 
587
866
        revision_id: only return revision ids included by revision_id.
588
867
        """
589
 
        if symbol_versioning.deprecated_passed(revision_id):
590
 
            symbol_versioning.warn(
591
 
                'search_missing_revision_ids(revision_id=...) was '
592
 
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
593
 
                DeprecationWarning, stacklevel=3)
594
 
            if revision_ids is not None:
595
 
                raise AssertionError(
596
 
                    'revision_ids is mutually exclusive with revision_id')
597
 
            if revision_id is not None:
598
 
                revision_ids = [revision_id]
599
868
        return InterRepository.get(other, self).search_missing_revision_ids(
600
 
            find_ghosts=find_ghosts, revision_ids=revision_ids,
601
 
            if_present_ids=if_present_ids, limit=limit)
 
869
            revision_id, find_ghosts)
 
870
 
 
871
    @deprecated_method(symbol_versioning.one_two)
 
872
    @needs_read_lock
 
873
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
874
        """Return the revision ids that other has that this does not.
 
875
        
 
876
        These are returned in topological order.
 
877
 
 
878
        revision_id: only return revision ids included by revision_id.
 
879
        """
 
880
        keys =  self.search_missing_revision_ids(
 
881
            other, revision_id, find_ghosts).get_keys()
 
882
        other.lock_read()
 
883
        try:
 
884
            parents = other.get_graph().get_parent_map(keys)
 
885
        finally:
 
886
            other.unlock()
 
887
        return tsort.topo_sort(parents)
602
888
 
603
889
    @staticmethod
604
890
    def open(base):
607
893
        For instance, if the repository is at URL/.bzr/repository,
608
894
        Repository.open(URL) -> a Repository instance.
609
895
        """
610
 
        control = controldir.ControlDir.open(base)
 
896
        control = bzrdir.BzrDir.open(base)
611
897
        return control.open_repository()
612
898
 
613
899
    def copy_content_into(self, destination, revision_id=None):
614
900
        """Make a complete copy of the content in self into destination.
615
 
 
616
 
        This is a destructive operation! Do not use it on existing
 
901
        
 
902
        This is a destructive operation! Do not use it on existing 
617
903
        repositories.
618
904
        """
619
905
        return InterRepository.get(self, destination).copy_content(revision_id)
622
908
        """Commit the contents accrued within the current write group.
623
909
 
624
910
        :seealso: start_write_group.
625
 
        
626
 
        :return: it may return an opaque hint that can be passed to 'pack'.
627
911
        """
628
912
        if self._write_group is not self.get_transaction():
629
913
            # has an unlock or relock occured ?
630
914
            raise errors.BzrError('mismatched lock context %r and '
631
915
                'write group %r.' %
632
916
                (self.get_transaction(), self._write_group))
633
 
        result = self._commit_write_group()
 
917
        self._commit_write_group()
634
918
        self._write_group = None
635
 
        return result
636
919
 
637
920
    def _commit_write_group(self):
638
921
        """Template method for per-repository write group cleanup.
639
 
 
640
 
        This is called before the write group is considered to be
 
922
        
 
923
        This is called before the write group is considered to be 
641
924
        finished and should ensure that all data handed to the repository
642
 
        for writing during the write group is safely committed (to the
 
925
        for writing during the write group is safely committed (to the 
643
926
        extent possible considering file system caching etc).
644
927
        """
645
928
 
646
 
    def suspend_write_group(self):
647
 
        """Suspend a write group.
648
 
 
649
 
        :raise UnsuspendableWriteGroup: If the write group can not be
650
 
            suspended.
651
 
        :return: List of tokens
652
 
        """
653
 
        raise errors.UnsuspendableWriteGroup(self)
654
 
 
655
 
    def refresh_data(self):
656
 
        """Re-read any data needed to synchronise with disk.
657
 
 
658
 
        This method is intended to be called after another repository instance
659
 
        (such as one used by a smart server) has inserted data into the
660
 
        repository. On all repositories this will work outside of write groups.
661
 
        Some repository formats (pack and newer for bzrlib native formats)
662
 
        support refresh_data inside write groups. If called inside a write
663
 
        group on a repository that does not support refreshing in a write group
664
 
        IsInWriteGroupError will be raised.
665
 
        """
666
 
        self._refresh_data()
667
 
 
668
 
    def resume_write_group(self, tokens):
669
 
        if not self.is_write_locked():
670
 
            raise errors.NotWriteLocked(self)
671
 
        if self._write_group:
672
 
            raise errors.BzrError('already in a write group')
673
 
        self._resume_write_group(tokens)
674
 
        # so we can detect unlock/relock - the write group is now entered.
675
 
        self._write_group = self.get_transaction()
676
 
 
677
 
    def _resume_write_group(self, tokens):
678
 
        raise errors.UnsuspendableWriteGroup(self)
679
 
 
680
 
    def fetch(self, source, revision_id=None, find_ghosts=False):
 
929
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
681
930
        """Fetch the content required to construct revision_id from source.
682
931
 
683
 
        If revision_id is None, then all content is copied.
684
 
 
685
 
        fetch() may not be used when the repository is in a write group -
686
 
        either finish the current write group before using fetch, or use
687
 
        fetch before starting the write group.
688
 
 
 
932
        If revision_id is None all content is copied.
689
933
        :param find_ghosts: Find and copy revisions in the source that are
690
934
            ghosts in the target (and not reachable directly by walking out to
691
935
            the first-present revision in target from revision_id).
692
 
        :param revision_id: If specified, all the content needed for this
693
 
            revision ID will be copied to the target.  Fetch will determine for
694
 
            itself which content needs to be copied.
695
936
        """
696
 
        if self.is_in_write_group():
697
 
            raise errors.InternalBzrError(
698
 
                "May not fetch while in a write group.")
699
937
        # fast path same-url fetch operations
700
 
        # TODO: lift out to somewhere common with RemoteRepository
701
 
        # <https://bugs.launchpad.net/bzr/+bug/401646>
702
 
        if (self.has_same_location(source)
703
 
            and self._has_same_fallbacks(source)):
 
938
        if self.has_same_location(source):
704
939
            # check that last_revision is in 'from' and then return a
705
940
            # no-operation.
706
941
            if (revision_id is not None and
708
943
                self.get_revision(revision_id)
709
944
            return 0, []
710
945
        inter = InterRepository.get(source, self)
711
 
        return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
 
946
        try:
 
947
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
948
        except NotImplementedError:
 
949
            raise errors.IncompatibleRepositories(source, self)
712
950
 
713
951
    def create_bundle(self, target, base, fileobj, format=None):
714
952
        return serializer.write_bundle(self, target, base, fileobj, format)
715
953
 
716
 
    def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
 
954
    def get_commit_builder(self, branch, parents, config, timestamp=None,
717
955
                           timezone=None, committer=None, revprops=None,
718
 
                           revision_id=None, lossy=False):
 
956
                           revision_id=None):
719
957
        """Obtain a CommitBuilder for this repository.
720
 
 
 
958
        
721
959
        :param branch: Branch to commit to.
722
960
        :param parents: Revision ids of the parents of the new revision.
723
 
        :param config_stack: Configuration stack to use.
 
961
        :param config: Configuration to use.
724
962
        :param timestamp: Optional timestamp recorded for commit.
725
963
        :param timezone: Optional timezone for timestamp.
726
964
        :param committer: Optional committer to set for commit.
727
965
        :param revprops: Optional dictionary of revision properties.
728
966
        :param revision_id: Optional revision id.
729
 
        :param lossy: Whether to discard data that can not be natively
730
 
            represented, when pushing to a foreign VCS
731
967
        """
732
 
        raise NotImplementedError(self.get_commit_builder)
 
968
        result = self._commit_builder_class(self, parents, config,
 
969
            timestamp, timezone, committer, revprops, revision_id)
 
970
        self.start_write_group()
 
971
        return result
733
972
 
734
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
735
973
    def unlock(self):
736
974
        if (self.control_files._lock_count == 1 and
737
975
            self.control_files._lock_mode == 'w'):
741
979
                raise errors.BzrError(
742
980
                    'Must end write groups before releasing write locks.')
743
981
        self.control_files.unlock()
744
 
        if self.control_files._lock_count == 0:
745
 
            for repo in self._fallback_repositories:
746
 
                repo.unlock()
747
982
 
748
983
    @needs_read_lock
749
 
    def clone(self, controldir, revision_id=None):
750
 
        """Clone this repository into controldir using the current format.
 
984
    def clone(self, a_bzrdir, revision_id=None):
 
985
        """Clone this repository into a_bzrdir using the current format.
751
986
 
752
987
        Currently no check is made that the format of this repository and
753
988
        the bzrdir format are compatible. FIXME RBC 20060201.
756
991
        """
757
992
        # TODO: deprecate after 0.16; cloning this with all its settings is
758
993
        # probably not very useful -- mbp 20070423
759
 
        dest_repo = self._create_sprouting_repo(
760
 
            controldir, shared=self.is_shared())
 
994
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
761
995
        self.copy_content_into(dest_repo, revision_id)
762
996
        return dest_repo
763
997
 
785
1019
 
786
1020
    def _start_write_group(self):
787
1021
        """Template method for per-repository write group startup.
788
 
 
789
 
        This is called before the write group is considered to be
 
1022
        
 
1023
        This is called before the write group is considered to be 
790
1024
        entered.
791
1025
        """
792
1026
 
818
1052
        """True if this repository has a copy of the revision."""
819
1053
        return revision_id in self.has_revisions((revision_id,))
820
1054
 
821
 
    @needs_read_lock
822
1055
    def has_revisions(self, revision_ids):
823
1056
        """Probe to find out the presence of multiple revisions.
824
1057
 
827
1060
        """
828
1061
        raise NotImplementedError(self.has_revisions)
829
1062
 
 
1063
        return self._revision_store.has_revision_id(revision_id,
 
1064
                                                    self.get_transaction())
 
1065
 
830
1066
    @needs_read_lock
831
1067
    def get_revision(self, revision_id):
832
1068
        """Return the Revision object for a named revision."""
833
1069
        return self.get_revisions([revision_id])[0]
834
1070
 
 
1071
    @needs_read_lock
835
1072
    def get_revision_reconcile(self, revision_id):
836
1073
        """'reconcile' helper routine that allows access to a revision always.
837
 
 
 
1074
        
838
1075
        This variant of get_revision does not cross check the weave graph
839
1076
        against the revision one as get_revision does: but it should only
840
1077
        be used by reconcile, or reconcile-alike commands that are correcting
841
1078
        or testing the revision graph.
842
1079
        """
843
 
        raise NotImplementedError(self.get_revision_reconcile)
 
1080
        return self._get_revisions([revision_id])[0]
844
1081
 
 
1082
    @needs_read_lock
845
1083
    def get_revisions(self, revision_ids):
846
 
        """Get many revisions at once.
847
 
        
848
 
        Repositories that need to check data on every revision read should 
849
 
        subclass this method.
850
 
        """
851
 
        raise NotImplementedError(self.get_revisions)
852
 
 
853
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1084
        """Get many revisions at once."""
 
1085
        return self._get_revisions(revision_ids)
 
1086
 
 
1087
    @needs_read_lock
 
1088
    def _get_revisions(self, revision_ids):
 
1089
        """Core work logic to get many revisions without sanity checks."""
 
1090
        for rev_id in revision_ids:
 
1091
            if not rev_id or not isinstance(rev_id, basestring):
 
1092
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1093
        revs = self._revision_store.get_revisions(revision_ids,
 
1094
                                                  self.get_transaction())
 
1095
        for rev in revs:
 
1096
            assert not isinstance(rev.revision_id, unicode)
 
1097
            for parent_id in rev.parent_ids:
 
1098
                assert not isinstance(parent_id, unicode)
 
1099
        return revs
 
1100
 
 
1101
    @needs_read_lock
 
1102
    def get_revision_xml(self, revision_id):
 
1103
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1104
        #       would have already do it.
 
1105
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1106
        rev = self.get_revision(revision_id)
 
1107
        rev_tmp = StringIO()
 
1108
        # the current serializer..
 
1109
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1110
        rev_tmp.seek(0)
 
1111
        return rev_tmp.getvalue()
 
1112
 
 
1113
    @needs_read_lock
 
1114
    def get_deltas_for_revisions(self, revisions):
854
1115
        """Produce a generator of revision deltas.
855
 
 
 
1116
        
856
1117
        Note that the input is a sequence of REVISIONS, not revision_ids.
857
1118
        Trees will be held in memory until the generator exits.
858
1119
        Each delta is relative to the revision's lefthand predecessor.
859
 
 
860
 
        :param specific_fileids: if not None, the result is filtered
861
 
          so that only those file-ids, their parents and their
862
 
          children are included.
863
1120
        """
864
 
        # Get the revision-ids of interest
865
1121
        required_trees = set()
866
1122
        for revision in revisions:
867
1123
            required_trees.add(revision.revision_id)
868
1124
            required_trees.update(revision.parent_ids[:1])
869
 
 
870
 
        # Get the matching filtered trees. Note that it's more
871
 
        # efficient to pass filtered trees to changes_from() rather
872
 
        # than doing the filtering afterwards. changes_from() could
873
 
        # arguably do the filtering itself but it's path-based, not
874
 
        # file-id based, so filtering before or afterwards is
875
 
        # currently easier.
876
 
        if specific_fileids is None:
877
 
            trees = dict((t.get_revision_id(), t) for
878
 
                t in self.revision_trees(required_trees))
879
 
        else:
880
 
            trees = dict((t.get_revision_id(), t) for
881
 
                t in self._filtered_revision_trees(required_trees,
882
 
                specific_fileids))
883
 
 
884
 
        # Calculate the deltas
 
1125
        trees = dict((t.get_revision_id(), t) for 
 
1126
                     t in self.revision_trees(required_trees))
885
1127
        for revision in revisions:
886
1128
            if not revision.parent_ids:
887
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
1129
                old_tree = self.revision_tree(None)
888
1130
            else:
889
1131
                old_tree = trees[revision.parent_ids[0]]
890
1132
            yield trees[revision.revision_id].changes_from(old_tree)
891
1133
 
892
1134
    @needs_read_lock
893
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1135
    def get_revision_delta(self, revision_id):
894
1136
        """Return the delta for one revision.
895
1137
 
896
1138
        The delta is relative to the left-hand predecessor of the
897
1139
        revision.
898
 
 
899
 
        :param specific_fileids: if not None, the result is filtered
900
 
          so that only those file-ids, their parents and their
901
 
          children are included.
902
1140
        """
903
1141
        r = self.get_revision(revision_id)
904
 
        return list(self.get_deltas_for_revisions([r],
905
 
            specific_fileids=specific_fileids))[0]
 
1142
        return list(self.get_deltas_for_revisions([r]))[0]
906
1143
 
907
1144
    @needs_write_lock
908
1145
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
909
1146
        signature = gpg_strategy.sign(plaintext)
910
1147
        self.add_signature_text(revision_id, signature)
911
1148
 
 
1149
    @needs_write_lock
912
1150
    def add_signature_text(self, revision_id, signature):
913
 
        """Store a signature text for a revision.
914
 
 
915
 
        :param revision_id: Revision id of the revision
916
 
        :param signature: Signature text.
917
 
        """
918
 
        raise NotImplementedError(self.add_signature_text)
919
 
 
920
 
    def _find_parent_ids_of_revisions(self, revision_ids):
921
 
        """Find all parent ids that are mentioned in the revision graph.
922
 
 
923
 
        :return: set of revisions that are parents of revision_ids which are
924
 
            not part of revision_ids themselves
925
 
        """
926
 
        parent_map = self.get_parent_map(revision_ids)
927
 
        parent_ids = set()
928
 
        map(parent_ids.update, parent_map.itervalues())
929
 
        parent_ids.difference_update(revision_ids)
930
 
        parent_ids.discard(_mod_revision.NULL_REVISION)
931
 
        return parent_ids
 
1151
        self._revision_store.add_revision_signature_text(revision_id,
 
1152
                                                         signature,
 
1153
                                                         self.get_transaction())
 
1154
 
 
1155
    def find_text_key_references(self):
 
1156
        """Find the text key references within the repository.
 
1157
 
 
1158
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1159
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1160
        altered it listed explicitly.
 
1161
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1162
            to whether they were referred to by the inventory of the
 
1163
            revision_id that they contain. The inventory texts from all present
 
1164
            revision ids are assessed to generate this report.
 
1165
        """
 
1166
        revision_ids = self.all_revision_ids()
 
1167
        w = self.get_inventory_weave()
 
1168
        pb = ui.ui_factory.nested_progress_bar()
 
1169
        try:
 
1170
            return self._find_text_key_references_from_xml_inventory_lines(
 
1171
                w.iter_lines_added_or_present_in_versions(revision_ids, pb=pb))
 
1172
        finally:
 
1173
            pb.finished()
 
1174
 
 
1175
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1176
        line_iterator):
 
1177
        """Core routine for extracting references to texts from inventories.
 
1178
 
 
1179
        This performs the translation of xml lines to revision ids.
 
1180
 
 
1181
        :param line_iterator: An iterator of lines, origin_version_id
 
1182
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1183
            to whether they were referred to by the inventory of the
 
1184
            revision_id that they contain. Note that if that revision_id was
 
1185
            not part of the line_iterator's output then False will be given -
 
1186
            even though it may actually refer to that key.
 
1187
        """
 
1188
        if not self._serializer.support_altered_by_hack:
 
1189
            raise AssertionError(
 
1190
                "_find_text_key_references_from_xml_inventory_lines only "
 
1191
                "supported for branches which store inventory as unnested xml"
 
1192
                ", not on %r" % self)
 
1193
        result = {}
 
1194
 
 
1195
        # this code needs to read every new line in every inventory for the
 
1196
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
1197
        # not present in one of those inventories is unnecessary but not 
 
1198
        # harmful because we are filtering by the revision id marker in the
 
1199
        # inventory lines : we only select file ids altered in one of those  
 
1200
        # revisions. We don't need to see all lines in the inventory because
 
1201
        # only those added in an inventory in rev X can contain a revision=X
 
1202
        # line.
 
1203
        unescape_revid_cache = {}
 
1204
        unescape_fileid_cache = {}
 
1205
 
 
1206
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1207
        # of lines, so it has had a lot of inlining and optimizing done.
 
1208
        # Sorry that it is a little bit messy.
 
1209
        # Move several functions to be local variables, since this is a long
 
1210
        # running loop.
 
1211
        search = self._file_ids_altered_regex.search
 
1212
        unescape = _unescape_xml
 
1213
        setdefault = result.setdefault
 
1214
        for line, version_id in line_iterator:
 
1215
            match = search(line)
 
1216
            if match is None:
 
1217
                continue
 
1218
            # One call to match.group() returning multiple items is quite a
 
1219
            # bit faster than 2 calls to match.group() each returning 1
 
1220
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1221
 
 
1222
            # Inlining the cache lookups helps a lot when you make 170,000
 
1223
            # lines and 350k ids, versus 8.4 unique ids.
 
1224
            # Using a cache helps in 2 ways:
 
1225
            #   1) Avoids unnecessary decoding calls
 
1226
            #   2) Re-uses cached strings, which helps in future set and
 
1227
            #      equality checks.
 
1228
            # (2) is enough that removing encoding entirely along with
 
1229
            # the cache (so we are using plain strings) results in no
 
1230
            # performance improvement.
 
1231
            try:
 
1232
                revision_id = unescape_revid_cache[revision_id]
 
1233
            except KeyError:
 
1234
                unescaped = unescape(revision_id)
 
1235
                unescape_revid_cache[revision_id] = unescaped
 
1236
                revision_id = unescaped
 
1237
 
 
1238
            # Note that unconditionally unescaping means that we deserialise
 
1239
            # every fileid, which for general 'pull' is not great, but we don't
 
1240
            # really want to have some many fulltexts that this matters anyway.
 
1241
            # RBC 20071114.
 
1242
            try:
 
1243
                file_id = unescape_fileid_cache[file_id]
 
1244
            except KeyError:
 
1245
                unescaped = unescape(file_id)
 
1246
                unescape_fileid_cache[file_id] = unescaped
 
1247
                file_id = unescaped
 
1248
 
 
1249
            key = (file_id, revision_id)
 
1250
            setdefault(key, False)
 
1251
            if revision_id == version_id:
 
1252
                result[key] = True
 
1253
        return result
 
1254
 
 
1255
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1256
        revision_ids):
 
1257
        """Helper routine for fileids_altered_by_revision_ids.
 
1258
 
 
1259
        This performs the translation of xml lines to revision ids.
 
1260
 
 
1261
        :param line_iterator: An iterator of lines, origin_version_id
 
1262
        :param revision_ids: The revision ids to filter for. This should be a
 
1263
            set or other type which supports efficient __contains__ lookups, as
 
1264
            the revision id from each parsed line will be looked up in the
 
1265
            revision_ids filter.
 
1266
        :return: a dictionary mapping altered file-ids to an iterable of
 
1267
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1268
        altered it listed explicitly.
 
1269
        """
 
1270
        result = {}
 
1271
        setdefault = result.setdefault
 
1272
        for file_id, revision_id in \
 
1273
            self._find_text_key_references_from_xml_inventory_lines(
 
1274
                line_iterator).iterkeys():
 
1275
            # once data is all ensured-consistent; then this is
 
1276
            # if revision_id == version_id
 
1277
            if revision_id in revision_ids:
 
1278
                setdefault(file_id, set()).add(revision_id)
 
1279
        return result
 
1280
 
 
1281
    def fileids_altered_by_revision_ids(self, revision_ids):
 
1282
        """Find the file ids and versions affected by revisions.
 
1283
 
 
1284
        :param revisions: an iterable containing revision ids.
 
1285
        :return: a dictionary mapping altered file-ids to an iterable of
 
1286
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1287
        altered it listed explicitly.
 
1288
        """
 
1289
        selected_revision_ids = set(revision_ids)
 
1290
        w = self.get_inventory_weave()
 
1291
        pb = ui.ui_factory.nested_progress_bar()
 
1292
        try:
 
1293
            return self._find_file_ids_from_xml_inventory_lines(
 
1294
                w.iter_lines_added_or_present_in_versions(
 
1295
                    selected_revision_ids, pb=pb),
 
1296
                selected_revision_ids)
 
1297
        finally:
 
1298
            pb.finished()
932
1299
 
933
1300
    def iter_files_bytes(self, desired_files):
934
1301
        """Iterate through file versions.
941
1308
        uniquely identify the file version in the caller's context.  (Examples:
942
1309
        an index number or a TreeTransform trans_id.)
943
1310
 
 
1311
        bytes_iterator is an iterable of bytestrings for the file.  The
 
1312
        kind of iterable and length of the bytestrings are unspecified, but for
 
1313
        this implementation, it is a list of lines produced by
 
1314
        VersionedFile.get_lines().
 
1315
 
944
1316
        :param desired_files: a list of (file_id, revision_id, identifier)
945
1317
            triples
946
1318
        """
947
 
        raise NotImplementedError(self.iter_files_bytes)
948
 
 
949
 
    def get_rev_id_for_revno(self, revno, known_pair):
950
 
        """Return the revision id of a revno, given a later (revno, revid)
951
 
        pair in the same history.
952
 
 
953
 
        :return: if found (True, revid).  If the available history ran out
954
 
            before reaching the revno, then this returns
955
 
            (False, (closest_revno, closest_revid)).
956
 
        """
957
 
        known_revno, known_revid = known_pair
958
 
        partial_history = [known_revid]
959
 
        distance_from_known = known_revno - revno
960
 
        if distance_from_known < 0:
961
 
            raise ValueError(
962
 
                'requested revno (%d) is later than given known revno (%d)'
963
 
                % (revno, known_revno))
964
 
        try:
965
 
            _iter_for_revno(
966
 
                self, partial_history, stop_index=distance_from_known)
967
 
        except errors.RevisionNotPresent, err:
968
 
            if err.revision_id == known_revid:
969
 
                # The start revision (known_revid) wasn't found.
970
 
                raise
971
 
            # This is a stacked repository with no fallbacks, or a there's a
972
 
            # left-hand ghost.  Either way, even though the revision named in
973
 
            # the error isn't in this repo, we know it's the next step in this
974
 
            # left-hand history.
975
 
            partial_history.append(err.revision_id)
976
 
        if len(partial_history) <= distance_from_known:
977
 
            # Didn't find enough history to get a revid for the revno.
978
 
            earliest_revno = known_revno - len(partial_history) + 1
979
 
            return (False, (earliest_revno, partial_history[-1]))
980
 
        if len(partial_history) - 1 > distance_from_known:
981
 
            raise AssertionError('_iter_for_revno returned too much history')
982
 
        return (True, partial_history[-1])
983
 
 
 
1319
        transaction = self.get_transaction()
 
1320
        for file_id, revision_id, callable_data in desired_files:
 
1321
            try:
 
1322
                weave = self.weave_store.get_weave(file_id, transaction)
 
1323
            except errors.NoSuchFile:
 
1324
                raise errors.NoSuchIdInRepository(self, file_id)
 
1325
            yield callable_data, weave.get_lines(revision_id)
 
1326
 
 
1327
    def _generate_text_key_index(self, text_key_references=None,
 
1328
        ancestors=None):
 
1329
        """Generate a new text key index for the repository.
 
1330
 
 
1331
        This is an expensive function that will take considerable time to run.
 
1332
 
 
1333
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
1334
            list of parents, also text keys. When a given key has no parents,
 
1335
            the parents list will be [NULL_REVISION].
 
1336
        """
 
1337
        # All revisions, to find inventory parents.
 
1338
        if ancestors is None:
 
1339
            graph = self.get_graph()
 
1340
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
1341
        if text_key_references is None:
 
1342
            text_key_references = self.find_text_key_references()
 
1343
        pb = ui.ui_factory.nested_progress_bar()
 
1344
        try:
 
1345
            return self._do_generate_text_key_index(ancestors,
 
1346
                text_key_references, pb)
 
1347
        finally:
 
1348
            pb.finished()
 
1349
 
 
1350
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
1351
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
1352
        revision_order = tsort.topo_sort(ancestors)
 
1353
        invalid_keys = set()
 
1354
        revision_keys = {}
 
1355
        for revision_id in revision_order:
 
1356
            revision_keys[revision_id] = set()
 
1357
        text_count = len(text_key_references)
 
1358
        # a cache of the text keys to allow reuse; costs a dict of all the
 
1359
        # keys, but saves a 2-tuple for every child of a given key.
 
1360
        text_key_cache = {}
 
1361
        for text_key, valid in text_key_references.iteritems():
 
1362
            if not valid:
 
1363
                invalid_keys.add(text_key)
 
1364
            else:
 
1365
                revision_keys[text_key[1]].add(text_key)
 
1366
            text_key_cache[text_key] = text_key
 
1367
        del text_key_references
 
1368
        text_index = {}
 
1369
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
1370
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1371
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
1372
        # too small for large or very branchy trees. However, for 55K path
 
1373
        # trees, it would be easy to use too much memory trivially. Ideally we
 
1374
        # could gauge this by looking at available real memory etc, but this is
 
1375
        # always a tricky proposition.
 
1376
        inventory_cache = lru_cache.LRUCache(10)
 
1377
        batch_size = 10 # should be ~150MB on a 55K path tree
 
1378
        batch_count = len(revision_order) / batch_size + 1
 
1379
        processed_texts = 0
 
1380
        pb.update("Calculating text parents.", processed_texts, text_count)
 
1381
        for offset in xrange(batch_count):
 
1382
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
1383
                batch_size]
 
1384
            if not to_query:
 
1385
                break
 
1386
            for rev_tree in self.revision_trees(to_query):
 
1387
                revision_id = rev_tree.get_revision_id()
 
1388
                parent_ids = ancestors[revision_id]
 
1389
                for text_key in revision_keys[revision_id]:
 
1390
                    pb.update("Calculating text parents.", processed_texts)
 
1391
                    processed_texts += 1
 
1392
                    candidate_parents = []
 
1393
                    for parent_id in parent_ids:
 
1394
                        parent_text_key = (text_key[0], parent_id)
 
1395
                        try:
 
1396
                            check_parent = parent_text_key not in \
 
1397
                                revision_keys[parent_id]
 
1398
                        except KeyError:
 
1399
                            # the parent parent_id is a ghost:
 
1400
                            check_parent = False
 
1401
                            # truncate the derived graph against this ghost.
 
1402
                            parent_text_key = None
 
1403
                        if check_parent:
 
1404
                            # look at the parent commit details inventories to
 
1405
                            # determine possible candidates in the per file graph.
 
1406
                            # TODO: cache here.
 
1407
                            try:
 
1408
                                inv = inventory_cache[parent_id]
 
1409
                            except KeyError:
 
1410
                                inv = self.revision_tree(parent_id).inventory
 
1411
                                inventory_cache[parent_id] = inv
 
1412
                            parent_entry = inv._byid.get(text_key[0], None)
 
1413
                            if parent_entry is not None:
 
1414
                                parent_text_key = (
 
1415
                                    text_key[0], parent_entry.revision)
 
1416
                            else:
 
1417
                                parent_text_key = None
 
1418
                        if parent_text_key is not None:
 
1419
                            candidate_parents.append(
 
1420
                                text_key_cache[parent_text_key])
 
1421
                    parent_heads = text_graph.heads(candidate_parents)
 
1422
                    new_parents = list(parent_heads)
 
1423
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
1424
                    if new_parents == []:
 
1425
                        new_parents = [NULL_REVISION]
 
1426
                    text_index[text_key] = new_parents
 
1427
 
 
1428
        for text_key in invalid_keys:
 
1429
            text_index[text_key] = [NULL_REVISION]
 
1430
        return text_index
 
1431
 
 
1432
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1433
        """Get an iterable listing the keys of all the data introduced by a set
 
1434
        of revision IDs.
 
1435
 
 
1436
        The keys will be ordered so that the corresponding items can be safely
 
1437
        fetched and inserted in that order.
 
1438
 
 
1439
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
1440
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
1441
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
1442
        """
 
1443
        # XXX: it's a bit weird to control the inventory weave caching in this
 
1444
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
1445
        # maybe this generator should explicitly have the contract that it
 
1446
        # should not be iterated until the previously yielded item has been
 
1447
        # processed?
 
1448
        self.lock_read()
 
1449
        inv_w = self.get_inventory_weave()
 
1450
 
 
1451
        # file ids that changed
 
1452
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
 
1453
        count = 0
 
1454
        num_file_ids = len(file_ids)
 
1455
        for file_id, altered_versions in file_ids.iteritems():
 
1456
            if _files_pb is not None:
 
1457
                _files_pb.update("fetch texts", count, num_file_ids)
 
1458
            count += 1
 
1459
            yield ("file", file_id, altered_versions)
 
1460
        # We're done with the files_pb.  Note that it finished by the caller,
 
1461
        # just as it was created by the caller.
 
1462
        del _files_pb
 
1463
 
 
1464
        # inventory
 
1465
        yield ("inventory", None, revision_ids)
 
1466
 
 
1467
        # signatures
 
1468
        revisions_with_signatures = set()
 
1469
        for rev_id in revision_ids:
 
1470
            try:
 
1471
                self.get_signature_text(rev_id)
 
1472
            except errors.NoSuchRevision:
 
1473
                # not signed.
 
1474
                pass
 
1475
            else:
 
1476
                revisions_with_signatures.add(rev_id)
 
1477
        self.unlock()
 
1478
        yield ("signatures", None, revisions_with_signatures)
 
1479
 
 
1480
        # revisions
 
1481
        yield ("revisions", None, revision_ids)
 
1482
 
 
1483
    @needs_read_lock
 
1484
    def get_inventory_weave(self):
 
1485
        return self.control_weaves.get_weave('inventory',
 
1486
            self.get_transaction())
 
1487
 
 
1488
    @needs_read_lock
 
1489
    def get_inventory(self, revision_id):
 
1490
        """Get Inventory object by revision id."""
 
1491
        return self.iter_inventories([revision_id]).next()
 
1492
 
 
1493
    def iter_inventories(self, revision_ids):
 
1494
        """Get many inventories by revision_ids.
 
1495
 
 
1496
        This will buffer some or all of the texts used in constructing the
 
1497
        inventories in memory, but will only parse a single inventory at a
 
1498
        time.
 
1499
 
 
1500
        :return: An iterator of inventories.
 
1501
        """
 
1502
        assert None not in revision_ids
 
1503
        assert _mod_revision.NULL_REVISION not in revision_ids
 
1504
        return self._iter_inventories(revision_ids)
 
1505
 
 
1506
    def _iter_inventories(self, revision_ids):
 
1507
        """single-document based inventory iteration."""
 
1508
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
1509
        for text, revision_id in zip(texts, revision_ids):
 
1510
            yield self.deserialise_inventory(revision_id, text)
 
1511
 
 
1512
    def deserialise_inventory(self, revision_id, xml):
 
1513
        """Transform the xml into an inventory object. 
 
1514
 
 
1515
        :param revision_id: The expected revision id of the inventory.
 
1516
        :param xml: A serialised inventory.
 
1517
        """
 
1518
        result = self._serializer.read_inventory_from_string(xml, revision_id)
 
1519
        if result.revision_id != revision_id:
 
1520
            raise AssertionError('revision id mismatch %s != %s' % (
 
1521
                result.revision_id, revision_id))
 
1522
        return result
 
1523
 
 
1524
    def serialise_inventory(self, inv):
 
1525
        return self._serializer.write_inventory_to_string(inv)
 
1526
 
 
1527
    def _serialise_inventory_to_lines(self, inv):
 
1528
        return self._serializer.write_inventory_to_lines(inv)
 
1529
 
 
1530
    def get_serializer_format(self):
 
1531
        return self._serializer.format_num
 
1532
 
 
1533
    @needs_read_lock
 
1534
    def get_inventory_xml(self, revision_id):
 
1535
        """Get inventory XML as a file object."""
 
1536
        try:
 
1537
            assert isinstance(revision_id, str), type(revision_id)
 
1538
            iw = self.get_inventory_weave()
 
1539
            return iw.get_text(revision_id)
 
1540
        except IndexError:
 
1541
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
1542
 
 
1543
    @needs_read_lock
 
1544
    def get_inventory_sha1(self, revision_id):
 
1545
        """Return the sha1 hash of the inventory entry
 
1546
        """
 
1547
        return self.get_revision(revision_id).inventory_sha1
 
1548
 
 
1549
    @needs_read_lock
 
1550
    @deprecated_method(symbol_versioning.one_four)
 
1551
    def get_revision_graph(self, revision_id=None):
 
1552
        """Return a dictionary containing the revision graph.
 
1553
 
 
1554
        NB: This method should not be used as it accesses the entire graph all
 
1555
        at once, which is much more data than most operations should require.
 
1556
 
 
1557
        :param revision_id: The revision_id to get a graph from. If None, then
 
1558
        the entire revision graph is returned. This is a deprecated mode of
 
1559
        operation and will be removed in the future.
 
1560
        :return: a dictionary of revision_id->revision_parents_list.
 
1561
        """
 
1562
        raise NotImplementedError(self.get_revision_graph)
 
1563
 
 
1564
    @needs_read_lock
 
1565
    @deprecated_method(symbol_versioning.one_three)
 
1566
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1567
        """Return a graph of the revisions with ghosts marked as applicable.
 
1568
 
 
1569
        :param revision_ids: an iterable of revisions to graph or None for all.
 
1570
        :return: a Graph object with the graph reachable from revision_ids.
 
1571
        """
 
1572
        if 'evil' in debug.debug_flags:
 
1573
            mutter_callsite(3,
 
1574
                "get_revision_graph_with_ghosts scales with size of history.")
 
1575
        result = deprecated_graph.Graph()
 
1576
        if not revision_ids:
 
1577
            pending = set(self.all_revision_ids())
 
1578
            required = set([])
 
1579
        else:
 
1580
            pending = set(revision_ids)
 
1581
            # special case NULL_REVISION
 
1582
            if _mod_revision.NULL_REVISION in pending:
 
1583
                pending.remove(_mod_revision.NULL_REVISION)
 
1584
            required = set(pending)
 
1585
        done = set([])
 
1586
        while len(pending):
 
1587
            revision_id = pending.pop()
 
1588
            try:
 
1589
                rev = self.get_revision(revision_id)
 
1590
            except errors.NoSuchRevision:
 
1591
                if revision_id in required:
 
1592
                    raise
 
1593
                # a ghost
 
1594
                result.add_ghost(revision_id)
 
1595
                continue
 
1596
            for parent_id in rev.parent_ids:
 
1597
                # is this queued or done ?
 
1598
                if (parent_id not in pending and
 
1599
                    parent_id not in done):
 
1600
                    # no, queue it.
 
1601
                    pending.add(parent_id)
 
1602
            result.add_node(revision_id, rev.parent_ids)
 
1603
            done.add(revision_id)
 
1604
        return result
 
1605
 
 
1606
    def iter_reverse_revision_history(self, revision_id):
 
1607
        """Iterate backwards through revision ids in the lefthand history
 
1608
 
 
1609
        :param revision_id: The revision id to start with.  All its lefthand
 
1610
            ancestors will be traversed.
 
1611
        """
 
1612
        graph = self.get_graph()
 
1613
        next_id = revision_id
 
1614
        while True:
 
1615
            if next_id in (None, _mod_revision.NULL_REVISION):
 
1616
                return
 
1617
            yield next_id
 
1618
            # Note: The following line may raise KeyError in the event of
 
1619
            # truncated history. We decided not to have a try:except:raise
 
1620
            # RevisionNotPresent here until we see a use for it, because of the
 
1621
            # cost in an inner loop that is by its very nature O(history).
 
1622
            # Robert Collins 20080326
 
1623
            parents = graph.get_parent_map([next_id])[next_id]
 
1624
            if len(parents) == 0:
 
1625
                return
 
1626
            else:
 
1627
                next_id = parents[0]
 
1628
 
 
1629
    @needs_read_lock
 
1630
    def get_revision_inventory(self, revision_id):
 
1631
        """Return inventory of a past revision."""
 
1632
        # TODO: Unify this with get_inventory()
 
1633
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1634
        # must be the same as its revision, so this is trivial.
 
1635
        if revision_id is None:
 
1636
            # This does not make sense: if there is no revision,
 
1637
            # then it is the current tree inventory surely ?!
 
1638
            # and thus get_root_id() is something that looks at the last
 
1639
            # commit on the branch, and the get_root_id is an inventory check.
 
1640
            raise NotImplementedError
 
1641
            # return Inventory(self.get_root_id())
 
1642
        else:
 
1643
            return self.get_inventory(revision_id)
 
1644
 
 
1645
    @needs_read_lock
984
1646
    def is_shared(self):
985
1647
        """Return True if this repository is flagged as a shared repository."""
986
1648
        raise NotImplementedError(self.is_shared)
1000
1662
        for repositories to maintain loaded indices across multiple locks
1001
1663
        by checking inside their implementation of this method to see
1002
1664
        whether their indices are still valid. This depends of course on
1003
 
        the disk format being validatable in this manner. This method is
1004
 
        also called by the refresh_data() public interface to cause a refresh
1005
 
        to occur while in a write lock so that data inserted by a smart server
1006
 
        push operation is visible on the client's instance of the physical
1007
 
        repository.
 
1665
        the disk format being validatable in this manner.
1008
1666
        """
1009
1667
 
1010
1668
    @needs_read_lock
1011
1669
    def revision_tree(self, revision_id):
1012
1670
        """Return Tree for a revision on this branch.
1013
1671
 
1014
 
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
1672
        `revision_id` may be None for the empty tree revision.
1015
1673
        """
1016
 
        raise NotImplementedError(self.revision_tree)
 
1674
        # TODO: refactor this to use an existing revision object
 
1675
        # so we don't need to read it in twice.
 
1676
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1677
            return RevisionTree(self, Inventory(root_id=None), 
 
1678
                                _mod_revision.NULL_REVISION)
 
1679
        else:
 
1680
            inv = self.get_revision_inventory(revision_id)
 
1681
            return RevisionTree(self, inv, revision_id)
1017
1682
 
 
1683
    @needs_read_lock
1018
1684
    def revision_trees(self, revision_ids):
1019
 
        """Return Trees for revisions in this repository.
1020
 
 
1021
 
        :param revision_ids: a sequence of revision-ids;
1022
 
          a revision-id may not be None or 'null:'
 
1685
        """Return Tree for a revision on this branch.
 
1686
 
 
1687
        `revision_id` may not be None or 'null:'"""
 
1688
        inventories = self.iter_inventories(revision_ids)
 
1689
        for inv in inventories:
 
1690
            yield RevisionTree(self, inv, inv.revision_id)
 
1691
 
 
1692
    @needs_read_lock
 
1693
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1694
        """Return a list of revision-ids integrated by a revision.
 
1695
 
 
1696
        The first element of the list is always None, indicating the origin 
 
1697
        revision.  This might change when we have history horizons, or 
 
1698
        perhaps we should have a new API.
 
1699
        
 
1700
        This is topologically sorted.
1023
1701
        """
1024
 
        raise NotImplementedError(self.revision_trees)
 
1702
        if _mod_revision.is_null(revision_id):
 
1703
            return [None]
 
1704
        if not self.has_revision(revision_id):
 
1705
            raise errors.NoSuchRevision(self, revision_id)
 
1706
        w = self.get_inventory_weave()
 
1707
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
1708
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
1025
1709
 
1026
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1710
    def pack(self):
1027
1711
        """Compress the data within the repository.
1028
1712
 
1029
1713
        This operation only makes sense for some repository types. For other
1030
1714
        types it should be a no-op that just returns.
1031
1715
 
1032
1716
        This stub method does not require a lock, but subclasses should use
1033
 
        @needs_write_lock as this is a long running call it's reasonable to
 
1717
        @needs_write_lock as this is a long running call its reasonable to 
1034
1718
        implicitly lock for the user.
1035
 
 
1036
 
        :param hint: If not supplied, the whole repository is packed.
1037
 
            If supplied, the repository may use the hint parameter as a
1038
 
            hint for the parts of the repository to pack. A hint can be
1039
 
            obtained from the result of commit_write_group(). Out of
1040
 
            date hints are simply ignored, because concurrent operations
1041
 
            can obsolete them rapidly.
1042
 
 
1043
 
        :param clean_obsolete_packs: Clean obsolete packs immediately after
1044
 
            the pack operation.
1045
 
        """
 
1719
        """
 
1720
 
 
1721
    @needs_read_lock
 
1722
    def print_file(self, file, revision_id):
 
1723
        """Print `file` to stdout.
 
1724
        
 
1725
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1726
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1727
        by creating a new more flexible convenience function.
 
1728
        """
 
1729
        tree = self.revision_tree(revision_id)
 
1730
        # use inventory as it was in that revision
 
1731
        file_id = tree.inventory.path2id(file)
 
1732
        if not file_id:
 
1733
            # TODO: jam 20060427 Write a test for this code path
 
1734
            #       it had a bug in it, and was raising the wrong
 
1735
            #       exception.
 
1736
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1737
        tree.print_file(file_id)
1046
1738
 
1047
1739
    def get_transaction(self):
1048
1740
        return self.control_files.get_transaction()
1049
1741
 
1050
 
    def get_parent_map(self, revision_ids):
1051
 
        """See graph.StackedParentsProvider.get_parent_map"""
1052
 
        raise NotImplementedError(self.get_parent_map)
1053
 
 
1054
 
    def _get_parent_map_no_fallbacks(self, revision_ids):
1055
 
        """Same as Repository.get_parent_map except doesn't query fallbacks."""
1056
 
        # revisions index works in keys; this just works in revisions
1057
 
        # therefore wrap and unwrap
1058
 
        query_keys = []
1059
 
        result = {}
1060
 
        for revision_id in revision_ids:
 
1742
    def revision_parents(self, revision_id):
 
1743
        return self.get_inventory_weave().parent_names(revision_id)
 
1744
 
 
1745
    @deprecated_method(symbol_versioning.one_one)
 
1746
    def get_parents(self, revision_ids):
 
1747
        """See StackedParentsProvider.get_parents"""
 
1748
        parent_map = self.get_parent_map(revision_ids)
 
1749
        return [parent_map.get(r, None) for r in revision_ids]
 
1750
 
 
1751
    def get_parent_map(self, keys):
 
1752
        """See graph._StackedParentsProvider.get_parent_map"""
 
1753
        parent_map = {}
 
1754
        for revision_id in keys:
1061
1755
            if revision_id == _mod_revision.NULL_REVISION:
1062
 
                result[revision_id] = ()
1063
 
            elif revision_id is None:
1064
 
                raise ValueError('get_parent_map(None) is not valid')
1065
 
            else:
1066
 
                query_keys.append((revision_id ,))
1067
 
        vf = self.revisions.without_fallbacks()
1068
 
        for ((revision_id,), parent_keys) in \
1069
 
                vf.get_parent_map(query_keys).iteritems():
1070
 
            if parent_keys:
1071
 
                result[revision_id] = tuple([parent_revid
1072
 
                    for (parent_revid,) in parent_keys])
1073
 
            else:
1074
 
                result[revision_id] = (_mod_revision.NULL_REVISION,)
1075
 
        return result
 
1756
                parent_map[revision_id] = ()
 
1757
            else:
 
1758
                try:
 
1759
                    parent_id_list = self.get_revision(revision_id).parent_ids
 
1760
                except errors.NoSuchRevision:
 
1761
                    pass
 
1762
                else:
 
1763
                    if len(parent_id_list) == 0:
 
1764
                        parent_ids = (_mod_revision.NULL_REVISION,)
 
1765
                    else:
 
1766
                        parent_ids = tuple(parent_id_list)
 
1767
                    parent_map[revision_id] = parent_ids
 
1768
        return parent_map
1076
1769
 
1077
1770
    def _make_parents_provider(self):
1078
 
        if not self._format.supports_external_lookups:
1079
 
            return self
1080
 
        return graph.StackedParentsProvider(_LazyListJoin(
1081
 
            [self._make_parents_provider_unstacked()],
1082
 
            self._fallback_repositories))
1083
 
 
1084
 
    def _make_parents_provider_unstacked(self):
1085
 
        return graph.CallableToParentsProviderAdapter(
1086
 
            self._get_parent_map_no_fallbacks)
1087
 
 
1088
 
    @needs_read_lock
1089
 
    def get_known_graph_ancestry(self, revision_ids):
1090
 
        """Return the known graph for a set of revision ids and their ancestors.
1091
 
        """
1092
 
        raise NotImplementedError(self.get_known_graph_ancestry)
1093
 
 
1094
 
    def get_file_graph(self):
1095
 
        """Return the graph walker for files."""
1096
 
        raise NotImplementedError(self.get_file_graph)
 
1771
        return self
1097
1772
 
1098
1773
    def get_graph(self, other_repository=None):
1099
1774
        """Return the graph walker for this repository format"""
1100
1775
        parents_provider = self._make_parents_provider()
1101
1776
        if (other_repository is not None and
1102
1777
            not self.has_same_location(other_repository)):
1103
 
            parents_provider = graph.StackedParentsProvider(
 
1778
            parents_provider = graph._StackedParentsProvider(
1104
1779
                [parents_provider, other_repository._make_parents_provider()])
1105
1780
        return graph.Graph(parents_provider)
1106
1781
 
 
1782
    def _get_versioned_file_checker(self):
 
1783
        """Return an object suitable for checking versioned files."""
 
1784
        return _VersionedFileChecker(self)
 
1785
 
 
1786
    def revision_ids_to_search_result(self, result_set):
 
1787
        """Convert a set of revision ids to a graph SearchResult."""
 
1788
        result_parents = set()
 
1789
        for parents in self.get_graph().get_parent_map(
 
1790
            result_set).itervalues():
 
1791
            result_parents.update(parents)
 
1792
        included_keys = result_set.intersection(result_parents)
 
1793
        start_keys = result_set.difference(included_keys)
 
1794
        exclude_keys = result_parents.difference(result_set)
 
1795
        result = graph.SearchResult(start_keys, exclude_keys,
 
1796
            len(result_set), result_set)
 
1797
        return result
 
1798
 
1107
1799
    @needs_write_lock
1108
1800
    def set_make_working_trees(self, new_value):
1109
1801
        """Set the policy flag for making working trees when creating branches.
1115
1807
                          working trees.
1116
1808
        """
1117
1809
        raise NotImplementedError(self.set_make_working_trees)
1118
 
 
 
1810
    
1119
1811
    def make_working_trees(self):
1120
1812
        """Returns the policy for making working trees on new branches."""
1121
1813
        raise NotImplementedError(self.make_working_trees)
1122
1814
 
1123
1815
    @needs_write_lock
1124
1816
    def sign_revision(self, revision_id, gpg_strategy):
1125
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1126
 
        plaintext = testament.as_short_text()
 
1817
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1127
1818
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1128
1819
 
1129
1820
    @needs_read_lock
1130
 
    def verify_revision_signature(self, revision_id, gpg_strategy):
1131
 
        """Verify the signature on a revision.
1132
 
 
1133
 
        :param revision_id: the revision to verify
1134
 
        :gpg_strategy: the GPGStrategy object to used
1135
 
 
1136
 
        :return: gpg.SIGNATURE_VALID or a failed SIGNATURE_ value
1137
 
        """
1138
 
        if not self.has_signature_for_revision_id(revision_id):
1139
 
            return gpg.SIGNATURE_NOT_SIGNED, None
1140
 
        signature = self.get_signature_text(revision_id)
1141
 
 
1142
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1143
 
        plaintext = testament.as_short_text()
1144
 
 
1145
 
        return gpg_strategy.verify(signature, plaintext)
1146
 
 
1147
 
    @needs_read_lock
1148
 
    def verify_revision_signatures(self, revision_ids, gpg_strategy):
1149
 
        """Verify revision signatures for a number of revisions.
1150
 
 
1151
 
        :param revision_id: the revision to verify
1152
 
        :gpg_strategy: the GPGStrategy object to used
1153
 
        :return: Iterator over tuples with revision id, result and keys
1154
 
        """
1155
 
        for revid in revision_ids:
1156
 
            (result, key) = self.verify_revision_signature(revid, gpg_strategy)
1157
 
            yield revid, result, key
1158
 
 
1159
1821
    def has_signature_for_revision_id(self, revision_id):
1160
1822
        """Query for a revision signature for revision_id in the repository."""
1161
 
        raise NotImplementedError(self.has_signature_for_revision_id)
 
1823
        return self._revision_store.has_signature(revision_id,
 
1824
                                                  self.get_transaction())
1162
1825
 
 
1826
    @needs_read_lock
1163
1827
    def get_signature_text(self, revision_id):
1164
1828
        """Return the text for a signature."""
1165
 
        raise NotImplementedError(self.get_signature_text)
 
1829
        return self._revision_store.get_signature_text(revision_id,
 
1830
                                                       self.get_transaction())
1166
1831
 
1167
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1832
    @needs_read_lock
 
1833
    def check(self, revision_ids=None):
1168
1834
        """Check consistency of all history of given revision_ids.
1169
1835
 
1170
1836
        Different repository implementations should override _check().
1171
1837
 
1172
1838
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1173
1839
             will be checked.  Typically the last revision_id of a branch.
1174
 
        :param callback_refs: A dict of check-refs to resolve and callback
1175
 
            the check/_check method on the items listed as wanting the ref.
1176
 
            see bzrlib.check.
1177
 
        :param check_repo: If False do not check the repository contents, just 
1178
 
            calculate the data callback_refs requires and call them back.
1179
1840
        """
1180
 
        return self._check(revision_ids=revision_ids, callback_refs=callback_refs,
1181
 
            check_repo=check_repo)
1182
 
 
1183
 
    def _check(self, revision_ids=None, callback_refs=None, check_repo=True):
1184
 
        raise NotImplementedError(self.check)
1185
 
 
1186
 
    def _warn_if_deprecated(self, branch=None):
1187
 
        if not self._format.is_deprecated():
1188
 
            return
 
1841
        return self._check(revision_ids)
 
1842
 
 
1843
    def _check(self, revision_ids):
 
1844
        result = check.Check(self)
 
1845
        result.check()
 
1846
        return result
 
1847
 
 
1848
    def _warn_if_deprecated(self):
1189
1849
        global _deprecation_warning_done
1190
1850
        if _deprecation_warning_done:
1191
1851
            return
1192
 
        try:
1193
 
            if branch is None:
1194
 
                conf = config.GlobalStack()
1195
 
            else:
1196
 
                conf = branch.get_config_stack()
1197
 
            if 'format_deprecation' in conf.get('suppress_warnings'):
1198
 
                return
1199
 
            warning("Format %s for %s is deprecated -"
1200
 
                    " please use 'bzr upgrade' to get better performance"
1201
 
                    % (self._format, self.bzrdir.transport.base))
1202
 
        finally:
1203
 
            _deprecation_warning_done = True
 
1852
        _deprecation_warning_done = True
 
1853
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
1854
                % (self._format, self.bzrdir.transport.base))
1204
1855
 
1205
1856
    def supports_rich_root(self):
1206
1857
        return self._format.rich_root_data
1220
1871
                    revision_id.decode('ascii')
1221
1872
                except UnicodeDecodeError:
1222
1873
                    raise errors.NonAsciiRevisionId(method, self)
 
1874
    
 
1875
    def revision_graph_can_have_wrong_parents(self):
 
1876
        """Is it possible for this repository to have a revision graph with
 
1877
        incorrect parents?
 
1878
 
 
1879
        If True, then this repository must also implement
 
1880
        _find_inconsistent_revision_parents so that check and reconcile can
 
1881
        check for inconsistencies before proceeding with other checks that may
 
1882
        depend on the revision index being consistent.
 
1883
        """
 
1884
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
1885
 
 
1886
 
 
1887
# remove these delegates a while after bzr 0.15
 
1888
def __make_delegated(name, from_module):
 
1889
    def _deprecated_repository_forwarder():
 
1890
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
1891
            % (name, from_module),
 
1892
            DeprecationWarning,
 
1893
            stacklevel=2)
 
1894
        m = __import__(from_module, globals(), locals(), [name])
 
1895
        try:
 
1896
            return getattr(m, name)
 
1897
        except AttributeError:
 
1898
            raise AttributeError('module %s has no name %s'
 
1899
                    % (m, name))
 
1900
    globals()[name] = _deprecated_repository_forwarder
 
1901
 
 
1902
for _name in [
 
1903
        'AllInOneRepository',
 
1904
        'WeaveMetaDirRepository',
 
1905
        'PreSplitOutRepositoryFormat',
 
1906
        'RepositoryFormat4',
 
1907
        'RepositoryFormat5',
 
1908
        'RepositoryFormat6',
 
1909
        'RepositoryFormat7',
 
1910
        ]:
 
1911
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
1912
 
 
1913
for _name in [
 
1914
        'KnitRepository',
 
1915
        'RepositoryFormatKnit',
 
1916
        'RepositoryFormatKnit1',
 
1917
        ]:
 
1918
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
1919
 
 
1920
 
 
1921
def install_revision(repository, rev, revision_tree):
 
1922
    """Install all revision data into a repository."""
 
1923
    install_revisions(repository, [(rev, revision_tree, None)])
 
1924
 
 
1925
 
 
1926
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
1927
    """Install all revision data into a repository.
 
1928
 
 
1929
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
1930
    may be None.
 
1931
    """
 
1932
    repository.start_write_group()
 
1933
    try:
 
1934
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
1935
            _install_revision(repository, revision, revision_tree, signature)
 
1936
            if pb is not None:
 
1937
                pb.update('Transferring revisions', n + 1, num_revisions)
 
1938
    except:
 
1939
        repository.abort_write_group()
 
1940
        raise
 
1941
    else:
 
1942
        repository.commit_write_group()
 
1943
 
 
1944
 
 
1945
def _install_revision(repository, rev, revision_tree, signature):
 
1946
    """Install all revision data into a repository."""
 
1947
    present_parents = []
 
1948
    parent_trees = {}
 
1949
    for p_id in rev.parent_ids:
 
1950
        if repository.has_revision(p_id):
 
1951
            present_parents.append(p_id)
 
1952
            parent_trees[p_id] = repository.revision_tree(p_id)
 
1953
        else:
 
1954
            parent_trees[p_id] = repository.revision_tree(None)
 
1955
 
 
1956
    inv = revision_tree.inventory
 
1957
    entries = inv.iter_entries()
 
1958
    # backwards compatibility hack: skip the root id.
 
1959
    if not repository.supports_rich_root():
 
1960
        path, root = entries.next()
 
1961
        if root.revision != rev.revision_id:
 
1962
            raise errors.IncompatibleRevision(repr(repository))
 
1963
    # Add the texts that are not already present
 
1964
    for path, ie in entries:
 
1965
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
1966
                repository.get_transaction())
 
1967
        if ie.revision not in w:
 
1968
            text_parents = []
 
1969
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
1970
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
1971
            # is a latent bug here where the parents may have ancestors of each
 
1972
            # other. RBC, AB
 
1973
            for revision, tree in parent_trees.iteritems():
 
1974
                if ie.file_id not in tree:
 
1975
                    continue
 
1976
                parent_id = tree.inventory[ie.file_id].revision
 
1977
                if parent_id in text_parents:
 
1978
                    continue
 
1979
                text_parents.append(parent_id)
 
1980
                    
 
1981
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
1982
                repository.get_transaction())
 
1983
            lines = revision_tree.get_file(ie.file_id).readlines()
 
1984
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
1985
    try:
 
1986
        # install the inventory
 
1987
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
1988
    except errors.RevisionAlreadyPresent:
 
1989
        pass
 
1990
    if signature is not None:
 
1991
        repository.add_signature_text(rev.revision_id, signature)
 
1992
    repository.add_revision(rev.revision_id, rev, inv)
1223
1993
 
1224
1994
 
1225
1995
class MetaDirRepository(Repository):
1226
 
    """Repositories in the new meta-dir layout.
1227
 
 
1228
 
    :ivar _transport: Transport for access to repository control files,
1229
 
        typically pointing to .bzr/repository.
1230
 
    """
1231
 
 
1232
 
    def __init__(self, _format, a_bzrdir, control_files):
1233
 
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
1234
 
        self._transport = control_files._transport
1235
 
 
 
1996
    """Repositories in the new meta-dir layout."""
 
1997
 
 
1998
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
1999
        super(MetaDirRepository, self).__init__(_format,
 
2000
                                                a_bzrdir,
 
2001
                                                control_files,
 
2002
                                                _revision_store,
 
2003
                                                control_store,
 
2004
                                                text_store)
 
2005
        dir_mode = self.control_files._dir_mode
 
2006
        file_mode = self.control_files._file_mode
 
2007
 
 
2008
    @needs_read_lock
1236
2009
    def is_shared(self):
1237
2010
        """Return True if this repository is flagged as a shared repository."""
1238
 
        return self._transport.has('shared-storage')
 
2011
        return self.control_files._transport.has('shared-storage')
1239
2012
 
1240
2013
    @needs_write_lock
1241
2014
    def set_make_working_trees(self, new_value):
1249
2022
        """
1250
2023
        if new_value:
1251
2024
            try:
1252
 
                self._transport.delete('no-working-trees')
 
2025
                self.control_files._transport.delete('no-working-trees')
1253
2026
            except errors.NoSuchFile:
1254
2027
                pass
1255
2028
        else:
1256
 
            self._transport.put_bytes('no-working-trees', '',
1257
 
                mode=self.bzrdir._get_file_mode())
1258
 
 
 
2029
            self.control_files.put_utf8('no-working-trees', '')
 
2030
    
1259
2031
    def make_working_trees(self):
1260
2032
        """Returns the policy for making working trees on new branches."""
1261
 
        return not self._transport.has('no-working-trees')
1262
 
 
1263
 
    @needs_write_lock
1264
 
    def update_feature_flags(self, updated_flags):
1265
 
        """Update the feature flags for this branch.
1266
 
 
1267
 
        :param updated_flags: Dictionary mapping feature names to necessities
1268
 
            A necessity can be None to indicate the feature should be removed
1269
 
        """
1270
 
        self._format._update_feature_flags(updated_flags)
1271
 
        self.control_transport.put_bytes('format', self._format.as_string())
1272
 
 
1273
 
 
1274
 
class RepositoryFormatRegistry(controldir.ControlComponentFormatRegistry):
1275
 
    """Repository format registry."""
1276
 
 
1277
 
    def get_default(self):
1278
 
        """Return the current default format."""
1279
 
        return controldir.format_registry.make_bzrdir('default').repository_format
1280
 
 
1281
 
 
1282
 
network_format_registry = registry.FormatRegistry()
1283
 
"""Registry of formats indexed by their network name.
1284
 
 
1285
 
The network name for a repository format is an identifier that can be used when
1286
 
referring to formats with smart server operations. See
1287
 
RepositoryFormat.network_name() for more detail.
1288
 
"""
1289
 
 
1290
 
 
1291
 
format_registry = RepositoryFormatRegistry(network_format_registry)
1292
 
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
 
2033
        return not self.control_files._transport.has('no-working-trees')
 
2034
 
 
2035
 
 
2036
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2037
    """Repositories in a meta-dir, that work via versioned file objects."""
 
2038
 
 
2039
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
2040
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2041
            control_files, _revision_store, control_store, text_store)
 
2042
        _revision_store.get_scope = self.get_transaction
 
2043
        control_store.get_scope = self.get_transaction
 
2044
        text_store.get_scope = self.get_transaction
 
2045
 
 
2046
 
 
2047
class RepositoryFormatRegistry(registry.Registry):
 
2048
    """Registry of RepositoryFormats."""
 
2049
 
 
2050
    def get(self, format_string):
 
2051
        r = registry.Registry.get(self, format_string)
 
2052
        if callable(r):
 
2053
            r = r()
 
2054
        return r
 
2055
    
 
2056
 
 
2057
format_registry = RepositoryFormatRegistry()
 
2058
"""Registry of formats, indexed by their identifying format string.
1293
2059
 
1294
2060
This can contain either format instances themselves, or classes/factories that
1295
2061
can be called to obtain one.
1299
2065
#####################################################################
1300
2066
# Repository Formats
1301
2067
 
1302
 
class RepositoryFormat(controldir.ControlComponentFormat):
 
2068
class RepositoryFormat(object):
1303
2069
    """A repository format.
1304
2070
 
1305
 
    Formats provide four things:
 
2071
    Formats provide three things:
1306
2072
     * An initialization routine to construct repository data on disk.
1307
 
     * a optional format string which is used when the BzrDir supports
1308
 
       versioned children.
 
2073
     * a format string which is used when the BzrDir supports versioned
 
2074
       children.
1309
2075
     * an open routine which returns a Repository instance.
1310
 
     * A network name for referring to the format in smart server RPC
1311
 
       methods.
1312
2076
 
1313
2077
    There is one and only one Format subclass for each on-disk format. But
1314
2078
    there can be one Repository subclass that is used for several different
1315
2079
    formats. The _format attribute on a Repository instance can be used to
1316
2080
    determine the disk format.
1317
2081
 
1318
 
    Formats are placed in a registry by their format string for reference
1319
 
    during opening. These should be subclasses of RepositoryFormat for
1320
 
    consistency.
 
2082
    Formats are placed in an dict by their format string for reference 
 
2083
    during opening. These should be subclasses of RepositoryFormat
 
2084
    for consistency.
1321
2085
 
1322
2086
    Once a format is deprecated, just deprecate the initialize and open
1323
 
    methods on the format class. Do not deprecate the object, as the
1324
 
    object may be created even when a repository instance hasn't been
1325
 
    created.
 
2087
    methods on the format class. Do not deprecate the object, as the 
 
2088
    object will be created every system load.
1326
2089
 
1327
2090
    Common instance attributes:
1328
 
    _matchingbzrdir - the controldir format that the repository format was
 
2091
    _matchingbzrdir - the bzrdir format that the repository format was
1329
2092
    originally written to work with. This can be used if manually
1330
2093
    constructing a bzrdir and repository, or more commonly for test suite
1331
2094
    parameterization.
1337
2100
    # Can this repository be given external locations to lookup additional
1338
2101
    # data. Set to True or False in derived classes.
1339
2102
    supports_external_lookups = None
1340
 
    # Does this format support CHK bytestring lookups. Set to True or False in
1341
 
    # derived classes.
1342
 
    supports_chks = None
1343
 
    # Should fetch trigger a reconcile after the fetch? Only needed for
1344
 
    # some repository formats that can suffer internal inconsistencies.
1345
 
    _fetch_reconcile = False
1346
 
    # Does this format have < O(tree_size) delta generation. Used to hint what
1347
 
    # code path for commit, amongst other things.
1348
 
    fast_deltas = None
1349
 
    # Does doing a pack operation compress data? Useful for the pack UI command
1350
 
    # (so if there is one pack, the operation can still proceed because it may
1351
 
    # help), and for fetching when data won't have come from the same
1352
 
    # compressor.
1353
 
    pack_compresses = False
1354
 
    # Does the repository storage understand references to trees?
1355
 
    supports_tree_reference = None
1356
 
    # Is the format experimental ?
1357
 
    experimental = False
1358
 
    # Does this repository format escape funky characters, or does it create
1359
 
    # files with similar names as the versioned files in its contents on disk
1360
 
    # ?
1361
 
    supports_funky_characters = None
1362
 
    # Does this repository format support leaving locks?
1363
 
    supports_leaving_lock = None
1364
 
    # Does this format support the full VersionedFiles interface?
1365
 
    supports_full_versioned_files = None
1366
 
    # Does this format support signing revision signatures?
1367
 
    supports_revision_signatures = True
1368
 
    # Can the revision graph have incorrect parents?
1369
 
    revision_graph_can_have_wrong_parents = None
1370
 
    # Does this format support rich root data?
1371
 
    rich_root_data = None
1372
 
    # Does this format support explicitly versioned directories?
1373
 
    supports_versioned_directories = None
1374
 
    # Can other repositories be nested into one of this format?
1375
 
    supports_nesting_repositories = None
1376
 
    # Is it possible for revisions to be present without being referenced
1377
 
    # somewhere ?
1378
 
    supports_unreferenced_revisions = None
1379
2103
 
1380
 
    def __repr__(self):
1381
 
        return "%s()" % self.__class__.__name__
 
2104
    def __str__(self):
 
2105
        return "<%s>" % self.__class__.__name__
1382
2106
 
1383
2107
    def __eq__(self, other):
1384
2108
        # format objects are generally stateless
1387
2111
    def __ne__(self, other):
1388
2112
        return not self == other
1389
2113
 
 
2114
    @classmethod
 
2115
    def find_format(klass, a_bzrdir):
 
2116
        """Return the format for the repository object in a_bzrdir.
 
2117
        
 
2118
        This is used by bzr native formats that have a "format" file in
 
2119
        the repository.  Other methods may be used by different types of 
 
2120
        control directory.
 
2121
        """
 
2122
        try:
 
2123
            transport = a_bzrdir.get_repository_transport(None)
 
2124
            format_string = transport.get("format").read()
 
2125
            return format_registry.get(format_string)
 
2126
        except errors.NoSuchFile:
 
2127
            raise errors.NoRepositoryPresent(a_bzrdir)
 
2128
        except KeyError:
 
2129
            raise errors.UnknownFormatError(format=format_string,
 
2130
                                            kind='repository')
 
2131
 
 
2132
    @classmethod
 
2133
    def register_format(klass, format):
 
2134
        format_registry.register(format.get_format_string(), format)
 
2135
 
 
2136
    @classmethod
 
2137
    def unregister_format(klass, format):
 
2138
        format_registry.remove(format.get_format_string())
 
2139
    
 
2140
    @classmethod
 
2141
    def get_default_format(klass):
 
2142
        """Return the current default format."""
 
2143
        from bzrlib import bzrdir
 
2144
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
2145
 
 
2146
    def _get_control_store(self, repo_transport, control_files):
 
2147
        """Return the control store for this repository."""
 
2148
        raise NotImplementedError(self._get_control_store)
 
2149
 
 
2150
    def get_format_string(self):
 
2151
        """Return the ASCII format string that identifies this format.
 
2152
        
 
2153
        Note that in pre format ?? repositories the format string is 
 
2154
        not permitted nor written to disk.
 
2155
        """
 
2156
        raise NotImplementedError(self.get_format_string)
 
2157
 
1390
2158
    def get_format_description(self):
1391
2159
        """Return the short description for this format."""
1392
2160
        raise NotImplementedError(self.get_format_description)
1393
2161
 
1394
 
    def initialize(self, controldir, shared=False):
1395
 
        """Initialize a repository of this format in controldir.
1396
 
 
1397
 
        :param controldir: The controldir to put the new repository in it.
 
2162
    def _get_revision_store(self, repo_transport, control_files):
 
2163
        """Return the revision store object for this a_bzrdir."""
 
2164
        raise NotImplementedError(self._get_revision_store)
 
2165
 
 
2166
    def _get_text_rev_store(self,
 
2167
                            transport,
 
2168
                            control_files,
 
2169
                            name,
 
2170
                            compressed=True,
 
2171
                            prefixed=False,
 
2172
                            serializer=None):
 
2173
        """Common logic for getting a revision store for a repository.
 
2174
        
 
2175
        see self._get_revision_store for the subclass-overridable method to 
 
2176
        get the store for a repository.
 
2177
        """
 
2178
        from bzrlib.store.revision.text import TextRevisionStore
 
2179
        dir_mode = control_files._dir_mode
 
2180
        file_mode = control_files._file_mode
 
2181
        text_store = TextStore(transport.clone(name),
 
2182
                              prefixed=prefixed,
 
2183
                              compressed=compressed,
 
2184
                              dir_mode=dir_mode,
 
2185
                              file_mode=file_mode)
 
2186
        _revision_store = TextRevisionStore(text_store, serializer)
 
2187
        return _revision_store
 
2188
 
 
2189
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2190
    # use weaves or knits -- mbp 20070207
 
2191
    def _get_versioned_file_store(self,
 
2192
                                  name,
 
2193
                                  transport,
 
2194
                                  control_files,
 
2195
                                  prefixed=True,
 
2196
                                  versionedfile_class=None,
 
2197
                                  versionedfile_kwargs={},
 
2198
                                  escaped=False):
 
2199
        if versionedfile_class is None:
 
2200
            versionedfile_class = self._versionedfile_class
 
2201
        weave_transport = control_files._transport.clone(name)
 
2202
        dir_mode = control_files._dir_mode
 
2203
        file_mode = control_files._file_mode
 
2204
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
2205
                                  dir_mode=dir_mode,
 
2206
                                  file_mode=file_mode,
 
2207
                                  versionedfile_class=versionedfile_class,
 
2208
                                  versionedfile_kwargs=versionedfile_kwargs,
 
2209
                                  escaped=escaped)
 
2210
 
 
2211
    def initialize(self, a_bzrdir, shared=False):
 
2212
        """Initialize a repository of this format in a_bzrdir.
 
2213
 
 
2214
        :param a_bzrdir: The bzrdir to put the new repository in it.
1398
2215
        :param shared: The repository should be initialized as a sharable one.
1399
2216
        :returns: The new repository object.
1400
 
 
 
2217
        
1401
2218
        This may raise UninitializableFormat if shared repository are not
1402
 
        compatible the controldir.
 
2219
        compatible the a_bzrdir.
1403
2220
        """
1404
2221
        raise NotImplementedError(self.initialize)
1405
2222
 
1407
2224
        """Is this format supported?
1408
2225
 
1409
2226
        Supported formats must be initializable and openable.
1410
 
        Unsupported formats may not support initialization or committing or
 
2227
        Unsupported formats may not support initialization or committing or 
1411
2228
        some other features depending on the reason for not being supported.
1412
2229
        """
1413
2230
        return True
1414
2231
 
1415
 
    def is_deprecated(self):
1416
 
        """Is this format deprecated?
1417
 
 
1418
 
        Deprecated formats may trigger a user-visible warning recommending
1419
 
        the user to upgrade. They are still fully supported.
1420
 
        """
1421
 
        return False
1422
 
 
1423
 
    def network_name(self):
1424
 
        """A simple byte string uniquely identifying this format for RPC calls.
1425
 
 
1426
 
        MetaDir repository formats use their disk format string to identify the
1427
 
        repository over the wire. All in one formats such as bzr < 0.8, and
1428
 
        foreign formats like svn/git and hg should use some marker which is
1429
 
        unique and immutable.
1430
 
        """
1431
 
        raise NotImplementedError(self.network_name)
1432
 
 
1433
2232
    def check_conversion_target(self, target_format):
1434
 
        if self.rich_root_data and not target_format.rich_root_data:
1435
 
            raise errors.BadConversionTarget(
1436
 
                'Does not support rich root data.', target_format,
1437
 
                from_format=self)
1438
 
        if (self.supports_tree_reference and 
1439
 
            not getattr(target_format, 'supports_tree_reference', False)):
1440
 
            raise errors.BadConversionTarget(
1441
 
                'Does not support nested trees', target_format,
1442
 
                from_format=self)
1443
 
 
1444
 
    def open(self, controldir, _found=False):
1445
 
        """Return an instance of this format for a controldir.
1446
 
 
 
2233
        raise NotImplementedError(self.check_conversion_target)
 
2234
 
 
2235
    def open(self, a_bzrdir, _found=False):
 
2236
        """Return an instance of this format for the bzrdir a_bzrdir.
 
2237
        
1447
2238
        _found is a private parameter, do not use it.
1448
2239
        """
1449
2240
        raise NotImplementedError(self.open)
1450
2241
 
1451
 
    def _run_post_repo_init_hooks(self, repository, controldir, shared):
1452
 
        from bzrlib.controldir import ControlDir, RepoInitHookParams
1453
 
        hooks = ControlDir.hooks['post_repo_init']
1454
 
        if not hooks:
1455
 
            return
1456
 
        params = RepoInitHookParams(repository, self, controldir, shared)
1457
 
        for hook in hooks:
1458
 
            hook(params)
1459
 
 
1460
 
 
1461
 
class RepositoryFormatMetaDir(bzrdir.BzrFormat, RepositoryFormat):
 
2242
 
 
2243
class MetaDirRepositoryFormat(RepositoryFormat):
1462
2244
    """Common base class for the new repositories using the metadir layout."""
1463
2245
 
1464
2246
    rich_root_data = False
1465
2247
    supports_tree_reference = False
1466
2248
    supports_external_lookups = False
1467
 
    supports_leaving_lock = True
1468
 
    supports_nesting_repositories = True
1469
 
 
1470
 
    @property
1471
 
    def _matchingbzrdir(self):
1472
 
        matching = bzrdir.BzrDirMetaFormat1()
1473
 
        matching.repository_format = self
1474
 
        return matching
 
2249
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1475
2250
 
1476
2251
    def __init__(self):
1477
 
        RepositoryFormat.__init__(self)
1478
 
        bzrdir.BzrFormat.__init__(self)
 
2252
        super(MetaDirRepositoryFormat, self).__init__()
1479
2253
 
1480
2254
    def _create_control_files(self, a_bzrdir):
1481
2255
        """Create the required files and the initial control_files object."""
1491
2265
        """Upload the initial blank content."""
1492
2266
        control_files = self._create_control_files(a_bzrdir)
1493
2267
        control_files.lock_write()
1494
 
        transport = control_files._transport
1495
 
        if shared == True:
1496
 
            utf8_files += [('shared-storage', '')]
1497
2268
        try:
1498
 
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
1499
 
            for (filename, content_stream) in files:
1500
 
                transport.put_file(filename, content_stream,
1501
 
                    mode=a_bzrdir._get_file_mode())
1502
 
            for (filename, content_bytes) in utf8_files:
1503
 
                transport.put_bytes_non_atomic(filename, content_bytes,
1504
 
                    mode=a_bzrdir._get_file_mode())
 
2269
            control_files._transport.mkdir_multi(dirs,
 
2270
                    mode=control_files._dir_mode)
 
2271
            for file, content in files:
 
2272
                control_files.put(file, content)
 
2273
            for file, content in utf8_files:
 
2274
                control_files.put_utf8(file, content)
 
2275
            if shared == True:
 
2276
                control_files.put_utf8('shared-storage', '')
1505
2277
        finally:
1506
2278
            control_files.unlock()
1507
2279
 
1508
 
    @classmethod
1509
 
    def find_format(klass, a_bzrdir):
1510
 
        """Return the format for the repository object in a_bzrdir.
1511
 
 
1512
 
        This is used by bzr native formats that have a "format" file in
1513
 
        the repository.  Other methods may be used by different types of
1514
 
        control directory.
1515
 
        """
1516
 
        try:
1517
 
            transport = a_bzrdir.get_repository_transport(None)
1518
 
            format_string = transport.get_bytes("format")
1519
 
        except errors.NoSuchFile:
1520
 
            raise errors.NoRepositoryPresent(a_bzrdir)
1521
 
        return klass._find_format(format_registry, 'repository', format_string)
1522
 
 
1523
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
1524
 
            basedir=None):
1525
 
        RepositoryFormat.check_support_status(self,
1526
 
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
1527
 
            basedir=basedir)
1528
 
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
1529
 
            recommend_upgrade=recommend_upgrade, basedir=basedir)
1530
 
 
1531
 
 
1532
 
# formats which have no format string are not discoverable or independently
1533
 
# creatable on disk, so are not registered in format_registry.  They're
1534
 
# all in bzrlib.repofmt.knitreponow.  When an instance of one of these is
1535
 
# needed, it's constructed directly by the ControlDir.  Non-native formats where
 
2280
 
 
2281
# formats which have no format string are not discoverable
 
2282
# and not independently creatable, so are not registered.  They're 
 
2283
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
2284
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1536
2285
# the repository is not separately opened are similar.
1537
2286
 
1538
2287
format_registry.register_lazy(
 
2288
    'Bazaar-NG Repository format 7',
 
2289
    'bzrlib.repofmt.weaverepo',
 
2290
    'RepositoryFormat7'
 
2291
    )
 
2292
 
 
2293
format_registry.register_lazy(
1539
2294
    'Bazaar-NG Knit Repository Format 1',
1540
2295
    'bzrlib.repofmt.knitrepo',
1541
2296
    'RepositoryFormatKnit1',
1558
2313
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
1559
2314
format_registry.register_lazy(
1560
2315
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1561
 
    'bzrlib.repofmt.knitpack_repo',
 
2316
    'bzrlib.repofmt.pack_repo',
1562
2317
    'RepositoryFormatKnitPack1',
1563
2318
    )
1564
2319
format_registry.register_lazy(
1565
2320
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1566
 
    'bzrlib.repofmt.knitpack_repo',
 
2321
    'bzrlib.repofmt.pack_repo',
1567
2322
    'RepositoryFormatKnitPack3',
1568
2323
    )
1569
2324
format_registry.register_lazy(
1570
2325
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1571
 
    'bzrlib.repofmt.knitpack_repo',
 
2326
    'bzrlib.repofmt.pack_repo',
1572
2327
    'RepositoryFormatKnitPack4',
1573
2328
    )
1574
 
format_registry.register_lazy(
1575
 
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
1576
 
    'bzrlib.repofmt.knitpack_repo',
1577
 
    'RepositoryFormatKnitPack5',
1578
 
    )
1579
 
format_registry.register_lazy(
1580
 
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
1581
 
    'bzrlib.repofmt.knitpack_repo',
1582
 
    'RepositoryFormatKnitPack5RichRoot',
1583
 
    )
1584
 
format_registry.register_lazy(
1585
 
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
1586
 
    'bzrlib.repofmt.knitpack_repo',
1587
 
    'RepositoryFormatKnitPack5RichRootBroken',
1588
 
    )
1589
 
format_registry.register_lazy(
1590
 
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
1591
 
    'bzrlib.repofmt.knitpack_repo',
1592
 
    'RepositoryFormatKnitPack6',
1593
 
    )
1594
 
format_registry.register_lazy(
1595
 
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
1596
 
    'bzrlib.repofmt.knitpack_repo',
1597
 
    'RepositoryFormatKnitPack6RichRoot',
1598
 
    )
1599
 
format_registry.register_lazy(
1600
 
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
1601
 
    'bzrlib.repofmt.groupcompress_repo',
1602
 
    'RepositoryFormat2a',
1603
 
    )
1604
 
 
1605
 
# Development formats.
1606
 
# Check their docstrings to see if/when they are obsolete.
1607
 
format_registry.register_lazy(
1608
 
    ("Bazaar development format 2 with subtree support "
1609
 
        "(needs bzr.dev from before 1.8)\n"),
1610
 
    'bzrlib.repofmt.knitpack_repo',
1611
 
    'RepositoryFormatPackDevelopment2Subtree',
1612
 
    )
1613
 
format_registry.register_lazy(
1614
 
    'Bazaar development format 8\n',
1615
 
    'bzrlib.repofmt.groupcompress_repo',
1616
 
    'RepositoryFormat2aSubtree',
1617
 
    )
 
2329
# Development formats. 
 
2330
# 1.2->1.3
 
2331
# development 0 - stub to introduce development versioning scheme.
 
2332
format_registry.register_lazy(
 
2333
    "Bazaar development format 0 (needs bzr.dev from before 1.3)\n",
 
2334
    'bzrlib.repofmt.pack_repo',
 
2335
    'RepositoryFormatPackDevelopment0',
 
2336
    )
 
2337
format_registry.register_lazy(
 
2338
    ("Bazaar development format 0 with subtree support "
 
2339
        "(needs bzr.dev from before 1.3)\n"),
 
2340
    'bzrlib.repofmt.pack_repo',
 
2341
    'RepositoryFormatPackDevelopment0Subtree',
 
2342
    )
 
2343
# 1.3->1.4 go below here
1618
2344
 
1619
2345
 
1620
2346
class InterRepository(InterObject):
1621
2347
    """This class represents operations taking place between two repositories.
1622
2348
 
1623
2349
    Its instances have methods like copy_content and fetch, and contain
1624
 
    references to the source and target repositories these operations can be
 
2350
    references to the source and target repositories these operations can be 
1625
2351
    carried out on.
1626
2352
 
1627
2353
    Often we will provide convenience methods on 'repository' which carry out
1632
2358
    _optimisers = []
1633
2359
    """The available optimised InterRepository types."""
1634
2360
 
1635
 
    @needs_write_lock
1636
2361
    def copy_content(self, revision_id=None):
1637
 
        """Make a complete copy of the content in self into destination.
1638
 
 
1639
 
        This is a destructive operation! Do not use it on existing
1640
 
        repositories.
1641
 
 
1642
 
        :param revision_id: Only copy the content needed to construct
1643
 
                            revision_id and its parents.
1644
 
        """
1645
 
        try:
1646
 
            self.target.set_make_working_trees(self.source.make_working_trees())
1647
 
        except NotImplementedError:
1648
 
            pass
1649
 
        self.target.fetch(self.source, revision_id=revision_id)
1650
 
 
1651
 
    @needs_write_lock
1652
 
    def fetch(self, revision_id=None, find_ghosts=False):
 
2362
        raise NotImplementedError(self.copy_content)
 
2363
 
 
2364
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1653
2365
        """Fetch the content required to construct revision_id.
1654
2366
 
1655
2367
        The content is copied from self.source to self.target.
1656
2368
 
1657
2369
        :param revision_id: if None all content is copied, if NULL_REVISION no
1658
2370
                            content is copied.
1659
 
        :return: None.
 
2371
        :param pb: optional progress bar to use for progress reports. If not
 
2372
                   provided a default one will be created.
 
2373
 
 
2374
        Returns the copied revision count and the failed revisions in a tuple:
 
2375
        (copied, failures).
1660
2376
        """
1661
2377
        raise NotImplementedError(self.fetch)
1662
2378
 
1663
 
    @needs_read_lock
1664
 
    def search_missing_revision_ids(self,
1665
 
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1666
 
            find_ghosts=True, revision_ids=None, if_present_ids=None,
1667
 
            limit=None):
1668
 
        """Return the revision ids that source has that target does not.
1669
 
 
1670
 
        :param revision_id: only return revision ids included by this
1671
 
            revision_id.
1672
 
        :param revision_ids: return revision ids included by these
1673
 
            revision_ids.  NoSuchRevision will be raised if any of these
1674
 
            revisions are not present.
1675
 
        :param if_present_ids: like revision_ids, but will not cause
1676
 
            NoSuchRevision if any of these are absent, instead they will simply
1677
 
            not be in the result.  This is useful for e.g. finding revisions
1678
 
            to fetch for tags, which may reference absent revisions.
1679
 
        :param find_ghosts: If True find missing revisions in deep history
1680
 
            rather than just finding the surface difference.
1681
 
        :param limit: Maximum number of revisions to return, topologically
1682
 
            ordered
 
2379
    def _walk_to_common_revisions(self, revision_ids):
 
2380
        """Walk out from revision_ids in source to revisions target has.
 
2381
 
 
2382
        :param revision_ids: The start point for the search.
 
2383
        :return: A set of revision ids.
 
2384
        """
 
2385
        graph = self.source.get_graph()
 
2386
        missing_revs = set()
 
2387
        # ensure we don't pay silly lookup costs.
 
2388
        revision_ids = frozenset(revision_ids)
 
2389
        searcher = graph._make_breadth_first_searcher(revision_ids)
 
2390
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
2391
        while True:
 
2392
            try:
 
2393
                next_revs, ghosts = searcher.next_with_ghosts()
 
2394
            except StopIteration:
 
2395
                break
 
2396
            if revision_ids.intersection(ghosts):
 
2397
                absent_ids = set(revision_ids.intersection(ghosts))
 
2398
                # If all absent_ids are present in target, no error is needed.
 
2399
                absent_ids.difference_update(
 
2400
                    self.target.has_revisions(absent_ids))
 
2401
                if absent_ids:
 
2402
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
 
2403
            # we don't care about other ghosts as we can't fetch them and
 
2404
            # haven't been asked to.
 
2405
            next_revs = set(next_revs)
 
2406
            # we always have NULL_REVISION present.
 
2407
            have_revs = self.target.has_revisions(next_revs).union(null_set)
 
2408
            missing_revs.update(next_revs - have_revs)
 
2409
            searcher.stop_searching_any(have_revs)
 
2410
        return searcher.get_result()
 
2411
   
 
2412
    @deprecated_method(symbol_versioning.one_two)
 
2413
    @needs_read_lock
 
2414
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2415
        """Return the revision ids that source has that target does not.
 
2416
        
 
2417
        These are returned in topological order.
 
2418
 
 
2419
        :param revision_id: only return revision ids included by this
 
2420
                            revision_id.
 
2421
        :param find_ghosts: If True find missing revisions in deep history
 
2422
            rather than just finding the surface difference.
 
2423
        """
 
2424
        return list(self.search_missing_revision_ids(
 
2425
            revision_id, find_ghosts).get_keys())
 
2426
 
 
2427
    @needs_read_lock
 
2428
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2429
        """Return the revision ids that source has that target does not.
 
2430
        
 
2431
        :param revision_id: only return revision ids included by this
 
2432
                            revision_id.
 
2433
        :param find_ghosts: If True find missing revisions in deep history
 
2434
            rather than just finding the surface difference.
1683
2435
        :return: A bzrlib.graph.SearchResult.
1684
2436
        """
1685
 
        raise NotImplementedError(self.search_missing_revision_ids)
 
2437
        # stop searching at found target revisions.
 
2438
        if not find_ghosts and revision_id is not None:
 
2439
            return self._walk_to_common_revisions([revision_id])
 
2440
        # generic, possibly worst case, slow code path.
 
2441
        target_ids = set(self.target.all_revision_ids())
 
2442
        if revision_id is not None:
 
2443
            source_ids = self.source.get_ancestry(revision_id)
 
2444
            assert source_ids[0] is None
 
2445
            source_ids.pop(0)
 
2446
        else:
 
2447
            source_ids = self.source.all_revision_ids()
 
2448
        result_set = set(source_ids).difference(target_ids)
 
2449
        return self.source.revision_ids_to_search_result(result_set)
1686
2450
 
1687
2451
    @staticmethod
1688
2452
    def _same_model(source, target):
1689
 
        """True if source and target have the same data representation.
1690
 
 
1691
 
        Note: this is always called on the base class; overriding it in a
1692
 
        subclass will have no effect.
1693
 
        """
1694
 
        try:
1695
 
            InterRepository._assert_same_model(source, target)
1696
 
            return True
1697
 
        except errors.IncompatibleRepositories, e:
 
2453
        """True if source and target have the same data representation."""
 
2454
        if source.supports_rich_root() != target.supports_rich_root():
1698
2455
            return False
1699
 
 
1700
 
    @staticmethod
1701
 
    def _assert_same_model(source, target):
1702
 
        """Raise an exception if two repositories do not use the same model.
1703
 
        """
1704
 
        if source.supports_rich_root() != target.supports_rich_root():
1705
 
            raise errors.IncompatibleRepositories(source, target,
1706
 
                "different rich-root support")
1707
2456
        if source._serializer != target._serializer:
1708
 
            raise errors.IncompatibleRepositories(source, target,
1709
 
                "different serializers")
 
2457
            return False
 
2458
        return True
 
2459
 
 
2460
 
 
2461
class InterSameDataRepository(InterRepository):
 
2462
    """Code for converting between repositories that represent the same data.
 
2463
    
 
2464
    Data format and model must match for this to work.
 
2465
    """
 
2466
 
 
2467
    @classmethod
 
2468
    def _get_repo_format_to_test(self):
 
2469
        """Repository format for testing with.
 
2470
        
 
2471
        InterSameData can pull from subtree to subtree and from non-subtree to
 
2472
        non-subtree, so we test this with the richest repository format.
 
2473
        """
 
2474
        from bzrlib.repofmt import knitrepo
 
2475
        return knitrepo.RepositoryFormatKnit3()
 
2476
 
 
2477
    @staticmethod
 
2478
    def is_compatible(source, target):
 
2479
        return InterRepository._same_model(source, target)
 
2480
 
 
2481
    @needs_write_lock
 
2482
    def copy_content(self, revision_id=None):
 
2483
        """Make a complete copy of the content in self into destination.
 
2484
 
 
2485
        This copies both the repository's revision data, and configuration information
 
2486
        such as the make_working_trees setting.
 
2487
        
 
2488
        This is a destructive operation! Do not use it on existing 
 
2489
        repositories.
 
2490
 
 
2491
        :param revision_id: Only copy the content needed to construct
 
2492
                            revision_id and its parents.
 
2493
        """
 
2494
        try:
 
2495
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2496
        except NotImplementedError:
 
2497
            pass
 
2498
        # but don't bother fetching if we have the needed data now.
 
2499
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2500
            self.target.has_revision(revision_id)):
 
2501
            return
 
2502
        self.target.fetch(self.source, revision_id=revision_id)
 
2503
 
 
2504
    @needs_write_lock
 
2505
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2506
        """See InterRepository.fetch()."""
 
2507
        from bzrlib.fetch import GenericRepoFetcher
 
2508
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2509
               self.source, self.source._format, self.target,
 
2510
               self.target._format)
 
2511
        f = GenericRepoFetcher(to_repository=self.target,
 
2512
                               from_repository=self.source,
 
2513
                               last_revision=revision_id,
 
2514
                               pb=pb, find_ghosts=find_ghosts)
 
2515
        return f.count_copied, f.failed_revisions
 
2516
 
 
2517
 
 
2518
class InterWeaveRepo(InterSameDataRepository):
 
2519
    """Optimised code paths between Weave based repositories.
 
2520
    
 
2521
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
2522
    implemented lazy inter-object optimisation.
 
2523
    """
 
2524
 
 
2525
    @classmethod
 
2526
    def _get_repo_format_to_test(self):
 
2527
        from bzrlib.repofmt import weaverepo
 
2528
        return weaverepo.RepositoryFormat7()
 
2529
 
 
2530
    @staticmethod
 
2531
    def is_compatible(source, target):
 
2532
        """Be compatible with known Weave formats.
 
2533
        
 
2534
        We don't test for the stores being of specific types because that
 
2535
        could lead to confusing results, and there is no need to be 
 
2536
        overly general.
 
2537
        """
 
2538
        from bzrlib.repofmt.weaverepo import (
 
2539
                RepositoryFormat5,
 
2540
                RepositoryFormat6,
 
2541
                RepositoryFormat7,
 
2542
                )
 
2543
        try:
 
2544
            return (isinstance(source._format, (RepositoryFormat5,
 
2545
                                                RepositoryFormat6,
 
2546
                                                RepositoryFormat7)) and
 
2547
                    isinstance(target._format, (RepositoryFormat5,
 
2548
                                                RepositoryFormat6,
 
2549
                                                RepositoryFormat7)))
 
2550
        except AttributeError:
 
2551
            return False
 
2552
    
 
2553
    @needs_write_lock
 
2554
    def copy_content(self, revision_id=None):
 
2555
        """See InterRepository.copy_content()."""
 
2556
        # weave specific optimised path:
 
2557
        try:
 
2558
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2559
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
2560
            pass
 
2561
        # FIXME do not peek!
 
2562
        if self.source.control_files._transport.listable():
 
2563
            pb = ui.ui_factory.nested_progress_bar()
 
2564
            try:
 
2565
                self.target.weave_store.copy_all_ids(
 
2566
                    self.source.weave_store,
 
2567
                    pb=pb,
 
2568
                    from_transaction=self.source.get_transaction(),
 
2569
                    to_transaction=self.target.get_transaction())
 
2570
                pb.update('copying inventory', 0, 1)
 
2571
                self.target.control_weaves.copy_multi(
 
2572
                    self.source.control_weaves, ['inventory'],
 
2573
                    from_transaction=self.source.get_transaction(),
 
2574
                    to_transaction=self.target.get_transaction())
 
2575
                self.target._revision_store.text_store.copy_all_ids(
 
2576
                    self.source._revision_store.text_store,
 
2577
                    pb=pb)
 
2578
            finally:
 
2579
                pb.finished()
 
2580
        else:
 
2581
            self.target.fetch(self.source, revision_id=revision_id)
 
2582
 
 
2583
    @needs_write_lock
 
2584
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2585
        """See InterRepository.fetch()."""
 
2586
        from bzrlib.fetch import GenericRepoFetcher
 
2587
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2588
               self.source, self.source._format, self.target, self.target._format)
 
2589
        f = GenericRepoFetcher(to_repository=self.target,
 
2590
                               from_repository=self.source,
 
2591
                               last_revision=revision_id,
 
2592
                               pb=pb, find_ghosts=find_ghosts)
 
2593
        return f.count_copied, f.failed_revisions
 
2594
 
 
2595
    @needs_read_lock
 
2596
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2597
        """See InterRepository.missing_revision_ids()."""
 
2598
        # we want all revisions to satisfy revision_id in source.
 
2599
        # but we don't want to stat every file here and there.
 
2600
        # we want then, all revisions other needs to satisfy revision_id 
 
2601
        # checked, but not those that we have locally.
 
2602
        # so the first thing is to get a subset of the revisions to 
 
2603
        # satisfy revision_id in source, and then eliminate those that
 
2604
        # we do already have. 
 
2605
        # this is slow on high latency connection to self, but as as this
 
2606
        # disk format scales terribly for push anyway due to rewriting 
 
2607
        # inventory.weave, this is considered acceptable.
 
2608
        # - RBC 20060209
 
2609
        if revision_id is not None:
 
2610
            source_ids = self.source.get_ancestry(revision_id)
 
2611
            assert source_ids[0] is None
 
2612
            source_ids.pop(0)
 
2613
        else:
 
2614
            source_ids = self.source._all_possible_ids()
 
2615
        source_ids_set = set(source_ids)
 
2616
        # source_ids is the worst possible case we may need to pull.
 
2617
        # now we want to filter source_ids against what we actually
 
2618
        # have in target, but don't try to check for existence where we know
 
2619
        # we do not have a revision as that would be pointless.
 
2620
        target_ids = set(self.target._all_possible_ids())
 
2621
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
2622
        actually_present_revisions = set(
 
2623
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2624
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2625
        if revision_id is not None:
 
2626
            # we used get_ancestry to determine source_ids then we are assured all
 
2627
            # revisions referenced are present as they are installed in topological order.
 
2628
            # and the tip revision was validated by get_ancestry.
 
2629
            result_set = required_revisions
 
2630
        else:
 
2631
            # if we just grabbed the possibly available ids, then 
 
2632
            # we only have an estimate of whats available and need to validate
 
2633
            # that against the revision records.
 
2634
            result_set = set(
 
2635
                self.source._eliminate_revisions_not_present(required_revisions))
 
2636
        return self.source.revision_ids_to_search_result(result_set)
 
2637
 
 
2638
 
 
2639
class InterKnitRepo(InterSameDataRepository):
 
2640
    """Optimised code paths between Knit based repositories."""
 
2641
 
 
2642
    @classmethod
 
2643
    def _get_repo_format_to_test(self):
 
2644
        from bzrlib.repofmt import knitrepo
 
2645
        return knitrepo.RepositoryFormatKnit1()
 
2646
 
 
2647
    @staticmethod
 
2648
    def is_compatible(source, target):
 
2649
        """Be compatible with known Knit formats.
 
2650
        
 
2651
        We don't test for the stores being of specific types because that
 
2652
        could lead to confusing results, and there is no need to be 
 
2653
        overly general.
 
2654
        """
 
2655
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
2656
        try:
 
2657
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
2658
                isinstance(target._format, RepositoryFormatKnit))
 
2659
        except AttributeError:
 
2660
            return False
 
2661
        return are_knits and InterRepository._same_model(source, target)
 
2662
 
 
2663
    @needs_write_lock
 
2664
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2665
        """See InterRepository.fetch()."""
 
2666
        from bzrlib.fetch import KnitRepoFetcher
 
2667
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2668
               self.source, self.source._format, self.target, self.target._format)
 
2669
        f = KnitRepoFetcher(to_repository=self.target,
 
2670
                            from_repository=self.source,
 
2671
                            last_revision=revision_id,
 
2672
                            pb=pb, find_ghosts=find_ghosts)
 
2673
        return f.count_copied, f.failed_revisions
 
2674
 
 
2675
    @needs_read_lock
 
2676
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2677
        """See InterRepository.missing_revision_ids()."""
 
2678
        if revision_id is not None:
 
2679
            source_ids = self.source.get_ancestry(revision_id)
 
2680
            assert source_ids[0] is None
 
2681
            source_ids.pop(0)
 
2682
        else:
 
2683
            source_ids = self.source.all_revision_ids()
 
2684
        source_ids_set = set(source_ids)
 
2685
        # source_ids is the worst possible case we may need to pull.
 
2686
        # now we want to filter source_ids against what we actually
 
2687
        # have in target, but don't try to check for existence where we know
 
2688
        # we do not have a revision as that would be pointless.
 
2689
        target_ids = set(self.target.all_revision_ids())
 
2690
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
2691
        actually_present_revisions = set(
 
2692
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2693
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2694
        if revision_id is not None:
 
2695
            # we used get_ancestry to determine source_ids then we are assured all
 
2696
            # revisions referenced are present as they are installed in topological order.
 
2697
            # and the tip revision was validated by get_ancestry.
 
2698
            result_set = required_revisions
 
2699
        else:
 
2700
            # if we just grabbed the possibly available ids, then 
 
2701
            # we only have an estimate of whats available and need to validate
 
2702
            # that against the revision records.
 
2703
            result_set = set(
 
2704
                self.source._eliminate_revisions_not_present(required_revisions))
 
2705
        return self.source.revision_ids_to_search_result(result_set)
 
2706
 
 
2707
 
 
2708
class InterPackRepo(InterSameDataRepository):
 
2709
    """Optimised code paths between Pack based repositories."""
 
2710
 
 
2711
    @classmethod
 
2712
    def _get_repo_format_to_test(self):
 
2713
        from bzrlib.repofmt import pack_repo
 
2714
        return pack_repo.RepositoryFormatKnitPack1()
 
2715
 
 
2716
    @staticmethod
 
2717
    def is_compatible(source, target):
 
2718
        """Be compatible with known Pack formats.
 
2719
        
 
2720
        We don't test for the stores being of specific types because that
 
2721
        could lead to confusing results, and there is no need to be 
 
2722
        overly general.
 
2723
        """
 
2724
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2725
        try:
 
2726
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2727
                isinstance(target._format, RepositoryFormatPack))
 
2728
        except AttributeError:
 
2729
            return False
 
2730
        return are_packs and InterRepository._same_model(source, target)
 
2731
 
 
2732
    @needs_write_lock
 
2733
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2734
        """See InterRepository.fetch()."""
 
2735
        from bzrlib.repofmt.pack_repo import Packer
 
2736
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2737
               self.source, self.source._format, self.target, self.target._format)
 
2738
        self.count_copied = 0
 
2739
        if revision_id is None:
 
2740
            # TODO:
 
2741
            # everything to do - use pack logic
 
2742
            # to fetch from all packs to one without
 
2743
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2744
            # till then:
 
2745
            revision_ids = self.source.all_revision_ids()
 
2746
            # implementing the TODO will involve:
 
2747
            # - detecting when all of a pack is selected
 
2748
            # - avoiding as much as possible pre-selection, so the
 
2749
            # more-core routines such as create_pack_from_packs can filter in
 
2750
            # a just-in-time fashion. (though having a HEADS list on a
 
2751
            # repository might make this a lot easier, because we could
 
2752
            # sensibly detect 'new revisions' without doing a full index scan.
 
2753
        elif _mod_revision.is_null(revision_id):
 
2754
            # nothing to do:
 
2755
            return (0, [])
 
2756
        else:
 
2757
            try:
 
2758
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2759
                    find_ghosts=find_ghosts).get_keys()
 
2760
            except errors.NoSuchRevision:
 
2761
                raise errors.InstallFailed([revision_id])
 
2762
        packs = self.source._pack_collection.all_packs()
 
2763
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
2764
            revision_ids).pack()
 
2765
        if pack is not None:
 
2766
            self.target._pack_collection._save_pack_names()
 
2767
            # Trigger an autopack. This may duplicate effort as we've just done
 
2768
            # a pack creation, but for now it is simpler to think about as
 
2769
            # 'upload data, then repack if needed'.
 
2770
            self.target._pack_collection.autopack()
 
2771
            return (pack.get_revision_count(), [])
 
2772
        else:
 
2773
            return (0, [])
 
2774
 
 
2775
    @needs_read_lock
 
2776
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2777
        """See InterRepository.missing_revision_ids().
 
2778
        
 
2779
        :param find_ghosts: Find ghosts throughout the ancestry of
 
2780
            revision_id.
 
2781
        """
 
2782
        if not find_ghosts and revision_id is not None:
 
2783
            return self._walk_to_common_revisions([revision_id])
 
2784
        elif revision_id is not None:
 
2785
            source_ids = self.source.get_ancestry(revision_id)
 
2786
            assert source_ids[0] is None
 
2787
            source_ids.pop(0)
 
2788
        else:
 
2789
            source_ids = self.source.all_revision_ids()
 
2790
        # source_ids is the worst possible case we may need to pull.
 
2791
        # now we want to filter source_ids against what we actually
 
2792
        # have in target, but don't try to check for existence where we know
 
2793
        # we do not have a revision as that would be pointless.
 
2794
        target_ids = set(self.target.all_revision_ids())
 
2795
        result_set = set(source_ids).difference(target_ids)
 
2796
        return self.source.revision_ids_to_search_result(result_set)
 
2797
 
 
2798
 
 
2799
class InterModel1and2(InterRepository):
 
2800
 
 
2801
    @classmethod
 
2802
    def _get_repo_format_to_test(self):
 
2803
        return None
 
2804
 
 
2805
    @staticmethod
 
2806
    def is_compatible(source, target):
 
2807
        if not source.supports_rich_root() and target.supports_rich_root():
 
2808
            return True
 
2809
        else:
 
2810
            return False
 
2811
 
 
2812
    @needs_write_lock
 
2813
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2814
        """See InterRepository.fetch()."""
 
2815
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2816
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2817
                                 from_repository=self.source,
 
2818
                                 last_revision=revision_id,
 
2819
                                 pb=pb, find_ghosts=find_ghosts)
 
2820
        return f.count_copied, f.failed_revisions
 
2821
 
 
2822
    @needs_write_lock
 
2823
    def copy_content(self, revision_id=None):
 
2824
        """Make a complete copy of the content in self into destination.
 
2825
        
 
2826
        This is a destructive operation! Do not use it on existing 
 
2827
        repositories.
 
2828
 
 
2829
        :param revision_id: Only copy the content needed to construct
 
2830
                            revision_id and its parents.
 
2831
        """
 
2832
        try:
 
2833
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2834
        except NotImplementedError:
 
2835
            pass
 
2836
        # but don't bother fetching if we have the needed data now.
 
2837
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2838
            self.target.has_revision(revision_id)):
 
2839
            return
 
2840
        self.target.fetch(self.source, revision_id=revision_id)
 
2841
 
 
2842
 
 
2843
class InterKnit1and2(InterKnitRepo):
 
2844
 
 
2845
    @classmethod
 
2846
    def _get_repo_format_to_test(self):
 
2847
        return None
 
2848
 
 
2849
    @staticmethod
 
2850
    def is_compatible(source, target):
 
2851
        """Be compatible with Knit1 source and Knit3 target"""
 
2852
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
2853
        try:
 
2854
            from bzrlib.repofmt.knitrepo import (RepositoryFormatKnit1,
 
2855
                RepositoryFormatKnit3)
 
2856
            from bzrlib.repofmt.pack_repo import (
 
2857
                RepositoryFormatKnitPack1,
 
2858
                RepositoryFormatKnitPack3,
 
2859
                RepositoryFormatPackDevelopment0,
 
2860
                RepositoryFormatPackDevelopment0Subtree,
 
2861
                )
 
2862
            nosubtrees = (
 
2863
                RepositoryFormatKnit1,
 
2864
                RepositoryFormatKnitPack1,
 
2865
                RepositoryFormatPackDevelopment0,
 
2866
                )
 
2867
            subtrees = (
 
2868
                RepositoryFormatKnit3,
 
2869
                RepositoryFormatKnitPack3,
 
2870
                RepositoryFormatPackDevelopment0Subtree,
 
2871
                )
 
2872
            return (isinstance(source._format, nosubtrees) and
 
2873
                isinstance(target._format, subtrees))
 
2874
        except AttributeError:
 
2875
            return False
 
2876
 
 
2877
    @needs_write_lock
 
2878
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2879
        """See InterRepository.fetch()."""
 
2880
        from bzrlib.fetch import Knit1to2Fetcher
 
2881
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2882
               self.source, self.source._format, self.target, 
 
2883
               self.target._format)
 
2884
        f = Knit1to2Fetcher(to_repository=self.target,
 
2885
                            from_repository=self.source,
 
2886
                            last_revision=revision_id,
 
2887
                            pb=pb, find_ghosts=find_ghosts)
 
2888
        return f.count_copied, f.failed_revisions
 
2889
 
 
2890
 
 
2891
class InterDifferingSerializer(InterKnitRepo):
 
2892
 
 
2893
    @classmethod
 
2894
    def _get_repo_format_to_test(self):
 
2895
        return None
 
2896
 
 
2897
    @staticmethod
 
2898
    def is_compatible(source, target):
 
2899
        """Be compatible with Knit2 source and Knit3 target"""
 
2900
        if source.supports_rich_root() != target.supports_rich_root():
 
2901
            return False
 
2902
        # Ideally, we'd support fetching if the source had no tree references
 
2903
        # even if it supported them...
 
2904
        if (getattr(source, '_format.supports_tree_reference', False) and
 
2905
            not getattr(target, '_format.supports_tree_reference', False)):
 
2906
            return False
 
2907
        return True
 
2908
 
 
2909
    @needs_write_lock
 
2910
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2911
        """See InterRepository.fetch()."""
 
2912
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
2913
            revision_id, find_ghosts=find_ghosts).get_keys()
 
2914
        revision_ids = tsort.topo_sort(
 
2915
            self.source.get_graph().get_parent_map(revision_ids))
 
2916
        def revisions_iterator():
 
2917
            for current_revision_id in revision_ids:
 
2918
                revision = self.source.get_revision(current_revision_id)
 
2919
                tree = self.source.revision_tree(current_revision_id)
 
2920
                try:
 
2921
                    signature = self.source.get_signature_text(
 
2922
                        current_revision_id)
 
2923
                except errors.NoSuchRevision:
 
2924
                    signature = None
 
2925
                yield revision, tree, signature
 
2926
        if pb is None:
 
2927
            my_pb = ui.ui_factory.nested_progress_bar()
 
2928
            pb = my_pb
 
2929
        else:
 
2930
            my_pb = None
 
2931
        try:
 
2932
            install_revisions(self.target, revisions_iterator(),
 
2933
                              len(revision_ids), pb)
 
2934
        finally:
 
2935
            if my_pb is not None:
 
2936
                my_pb.finished()
 
2937
        return len(revision_ids), 0
 
2938
 
 
2939
 
 
2940
class InterRemoteToOther(InterRepository):
 
2941
 
 
2942
    def __init__(self, source, target):
 
2943
        InterRepository.__init__(self, source, target)
 
2944
        self._real_inter = None
 
2945
 
 
2946
    @staticmethod
 
2947
    def is_compatible(source, target):
 
2948
        if not isinstance(source, remote.RemoteRepository):
 
2949
            return False
 
2950
        # Is source's model compatible with target's model?
 
2951
        source._ensure_real()
 
2952
        real_source = source._real_repository
 
2953
        assert not isinstance(real_source, remote.RemoteRepository), (
 
2954
            "We don't support remote repos backed by remote repos yet.")
 
2955
        return InterRepository._same_model(real_source, target)
 
2956
 
 
2957
    @needs_write_lock
 
2958
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2959
        """See InterRepository.fetch()."""
 
2960
        from bzrlib.fetch import RemoteToOtherFetcher
 
2961
        mutter("Using fetch logic to copy between %s(remote) and %s(%s)",
 
2962
               self.source, self.target, self.target._format)
 
2963
        # TODO: jam 20070210 This should be an assert, not a translate
 
2964
        revision_id = osutils.safe_revision_id(revision_id)
 
2965
        f = RemoteToOtherFetcher(to_repository=self.target,
 
2966
                                 from_repository=self.source,
 
2967
                                 last_revision=revision_id,
 
2968
                                 pb=pb, find_ghosts=find_ghosts)
 
2969
        return f.count_copied, f.failed_revisions
 
2970
 
 
2971
    @classmethod
 
2972
    def _get_repo_format_to_test(self):
 
2973
        return None
 
2974
 
 
2975
 
 
2976
class InterOtherToRemote(InterRepository):
 
2977
 
 
2978
    def __init__(self, source, target):
 
2979
        InterRepository.__init__(self, source, target)
 
2980
        self._real_inter = None
 
2981
 
 
2982
    @staticmethod
 
2983
    def is_compatible(source, target):
 
2984
        if isinstance(target, remote.RemoteRepository):
 
2985
            return True
 
2986
        return False
 
2987
 
 
2988
    def _ensure_real_inter(self):
 
2989
        if self._real_inter is None:
 
2990
            self.target._ensure_real()
 
2991
            real_target = self.target._real_repository
 
2992
            self._real_inter = InterRepository.get(self.source, real_target)
 
2993
    
 
2994
    def copy_content(self, revision_id=None):
 
2995
        self._ensure_real_inter()
 
2996
        self._real_inter.copy_content(revision_id=revision_id)
 
2997
 
 
2998
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2999
        self._ensure_real_inter()
 
3000
        self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3001
            find_ghosts=find_ghosts)
 
3002
 
 
3003
    @classmethod
 
3004
    def _get_repo_format_to_test(self):
 
3005
        return None
 
3006
 
 
3007
 
 
3008
InterRepository.register_optimiser(InterDifferingSerializer)
 
3009
InterRepository.register_optimiser(InterSameDataRepository)
 
3010
InterRepository.register_optimiser(InterWeaveRepo)
 
3011
InterRepository.register_optimiser(InterKnitRepo)
 
3012
InterRepository.register_optimiser(InterModel1and2)
 
3013
InterRepository.register_optimiser(InterKnit1and2)
 
3014
InterRepository.register_optimiser(InterPackRepo)
 
3015
InterRepository.register_optimiser(InterRemoteToOther)
 
3016
InterRepository.register_optimiser(InterOtherToRemote)
1710
3017
 
1711
3018
 
1712
3019
class CopyConverter(object):
1713
3020
    """A repository conversion tool which just performs a copy of the content.
1714
 
 
 
3021
    
1715
3022
    This is slow but quite reliable.
1716
3023
    """
1717
3024
 
1721
3028
        :param target_format: The format the resulting repository should be.
1722
3029
        """
1723
3030
        self.target_format = target_format
1724
 
 
 
3031
        
1725
3032
    def convert(self, repo, pb):
1726
3033
        """Perform the conversion of to_convert, giving feedback via pb.
1727
3034
 
1728
3035
        :param to_convert: The disk object to convert.
1729
3036
        :param pb: a progress bar to use for progress information.
1730
3037
        """
1731
 
        pb = ui.ui_factory.nested_progress_bar()
 
3038
        self.pb = pb
1732
3039
        self.count = 0
1733
3040
        self.total = 4
1734
3041
        # this is only useful with metadir layouts - separated repo content.
1735
3042
        # trigger an assertion if not such
1736
3043
        repo._format.get_format_string()
1737
3044
        self.repo_dir = repo.bzrdir
1738
 
        pb.update(gettext('Moving repository to repository.backup'))
 
3045
        self.step('Moving repository to repository.backup')
1739
3046
        self.repo_dir.transport.move('repository', 'repository.backup')
1740
3047
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1741
3048
        repo._format.check_conversion_target(self.target_format)
1742
3049
        self.source_repo = repo._format.open(self.repo_dir,
1743
3050
            _found=True,
1744
3051
            _override_transport=backup_transport)
1745
 
        pb.update(gettext('Creating new repository'))
 
3052
        self.step('Creating new repository')
1746
3053
        converted = self.target_format.initialize(self.repo_dir,
1747
3054
                                                  self.source_repo.is_shared())
1748
3055
        converted.lock_write()
1749
3056
        try:
1750
 
            pb.update(gettext('Copying content'))
 
3057
            self.step('Copying content into repository.')
1751
3058
            self.source_repo.copy_content_into(converted)
1752
3059
        finally:
1753
3060
            converted.unlock()
1754
 
        pb.update(gettext('Deleting old repository content'))
 
3061
        self.step('Deleting old repository content.')
1755
3062
        self.repo_dir.transport.delete_tree('repository.backup')
1756
 
        ui.ui_factory.note(gettext('repository converted'))
1757
 
        pb.finished()
 
3063
        self.pb.note('repository converted')
 
3064
 
 
3065
    def step(self, message):
 
3066
        """Update the pb by a step."""
 
3067
        self.count +=1
 
3068
        self.pb.update(message, self.count, self.total)
 
3069
 
 
3070
 
 
3071
_unescape_map = {
 
3072
    'apos':"'",
 
3073
    'quot':'"',
 
3074
    'amp':'&',
 
3075
    'lt':'<',
 
3076
    'gt':'>'
 
3077
}
 
3078
 
 
3079
 
 
3080
def _unescaper(match, _map=_unescape_map):
 
3081
    code = match.group(1)
 
3082
    try:
 
3083
        return _map[code]
 
3084
    except KeyError:
 
3085
        if not code.startswith('#'):
 
3086
            raise
 
3087
        return unichr(int(code[1:])).encode('utf8')
 
3088
 
 
3089
 
 
3090
_unescape_re = None
 
3091
 
 
3092
 
 
3093
def _unescape_xml(data):
 
3094
    """Unescape predefined XML entities in a string of data."""
 
3095
    global _unescape_re
 
3096
    if _unescape_re is None:
 
3097
        _unescape_re = re.compile('\&([^;]*);')
 
3098
    return _unescape_re.sub(_unescaper, data)
 
3099
 
 
3100
 
 
3101
class _VersionedFileChecker(object):
 
3102
 
 
3103
    def __init__(self, repository):
 
3104
        self.repository = repository
 
3105
        self.text_index = self.repository._generate_text_key_index()
 
3106
    
 
3107
    def calculate_file_version_parents(self, revision_id, file_id):
 
3108
        """Calculate the correct parents for a file version according to
 
3109
        the inventories.
 
3110
        """
 
3111
        parent_keys = self.text_index[(file_id, revision_id)]
 
3112
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3113
            return ()
 
3114
        # strip the file_id, for the weave api
 
3115
        return tuple([revision_id for file_id, revision_id in parent_keys])
 
3116
 
 
3117
    def check_file_version_parents(self, weave, file_id):
 
3118
        """Check the parents stored in a versioned file are correct.
 
3119
 
 
3120
        It also detects file versions that are not referenced by their
 
3121
        corresponding revision's inventory.
 
3122
 
 
3123
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3124
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3125
            correct_parents)} for each revision_id where the stored parents
 
3126
            are not correct.  dangling_file_versions is a set of (file_id,
 
3127
            revision_id) tuples for versions that are present in this versioned
 
3128
            file, but not used by the corresponding inventory.
 
3129
        """
 
3130
        wrong_parents = {}
 
3131
        unused_versions = set()
 
3132
        versions = weave.versions()
 
3133
        parent_map = weave.get_parent_map(versions)
 
3134
        for num, revision_id in enumerate(versions):
 
3135
            try:
 
3136
                correct_parents = self.calculate_file_version_parents(
 
3137
                    revision_id, file_id)
 
3138
            except KeyError:
 
3139
                # The version is not part of the used keys.
 
3140
                unused_versions.add(revision_id)
 
3141
            else:
 
3142
                try:
 
3143
                    knit_parents = tuple(parent_map[revision_id])
 
3144
                except errors.RevisionNotPresent:
 
3145
                    knit_parents = None
 
3146
                if correct_parents != knit_parents:
 
3147
                    wrong_parents[revision_id] = (knit_parents, correct_parents)
 
3148
        return wrong_parents, unused_versions
 
3149
 
 
3150
 
 
3151
def _old_get_graph(repository, revision_id):
 
3152
    """DO NOT USE. That is all. I'm serious."""
 
3153
    graph = repository.get_graph()
 
3154
    revision_graph = dict(((key, value) for key, value in
 
3155
        graph.iter_ancestry([revision_id]) if value is not None))
 
3156
    return _strip_NULL_ghosts(revision_graph)
1758
3157
 
1759
3158
 
1760
3159
def _strip_NULL_ghosts(revision_graph):
1766
3165
        revision_graph[key] = tuple(parent for parent in parents if parent
1767
3166
            in revision_graph)
1768
3167
    return revision_graph
1769
 
 
1770
 
 
1771
 
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
1772
 
                    stop_revision=None):
1773
 
    """Extend the partial history to include a given index
1774
 
 
1775
 
    If a stop_index is supplied, stop when that index has been reached.
1776
 
    If a stop_revision is supplied, stop when that revision is
1777
 
    encountered.  Otherwise, stop when the beginning of history is
1778
 
    reached.
1779
 
 
1780
 
    :param stop_index: The index which should be present.  When it is
1781
 
        present, history extension will stop.
1782
 
    :param stop_revision: The revision id which should be present.  When
1783
 
        it is encountered, history extension will stop.
1784
 
    """
1785
 
    start_revision = partial_history_cache[-1]
1786
 
    graph = repo.get_graph()
1787
 
    iterator = graph.iter_lefthand_ancestry(start_revision,
1788
 
        (_mod_revision.NULL_REVISION,))
1789
 
    try:
1790
 
        # skip the last revision in the list
1791
 
        iterator.next()
1792
 
        while True:
1793
 
            if (stop_index is not None and
1794
 
                len(partial_history_cache) > stop_index):
1795
 
                break
1796
 
            if partial_history_cache[-1] == stop_revision:
1797
 
                break
1798
 
            revision_id = iterator.next()
1799
 
            partial_history_cache.append(revision_id)
1800
 
    except StopIteration:
1801
 
        # No more history
1802
 
        return
1803
 
 
1804
 
 
1805
 
class _LazyListJoin(object):
1806
 
    """An iterable yielding the contents of many lists as one list.
1807
 
 
1808
 
    Each iterator made from this will reflect the current contents of the lists
1809
 
    at the time the iterator is made.
1810
 
    
1811
 
    This is used by Repository's _make_parents_provider implementation so that
1812
 
    it is safe to do::
1813
 
 
1814
 
      pp = repo._make_parents_provider()      # uses a list of fallback repos
1815
 
      pp.add_fallback_repository(other_repo)  # appends to that list
1816
 
      result = pp.get_parent_map(...)
1817
 
      # The result will include revs from other_repo
1818
 
    """
1819
 
 
1820
 
    def __init__(self, *list_parts):
1821
 
        self.list_parts = list_parts
1822
 
 
1823
 
    def __iter__(self):
1824
 
        full_list = []
1825
 
        for list_part in self.list_parts:
1826
 
            full_list.extend(list_part)
1827
 
        return iter(full_list)
1828
 
 
1829
 
    def __repr__(self):
1830
 
        return "%s.%s(%s)" % (self.__module__, self.__class__.__name__,
1831
 
                              self.list_parts)