← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Alexander Belchenko
  • Date: 2008-02-07 07:53:19 UTC
  • mto: This revision was merged to the branch mainline in revision 3231.
  • Revision ID: bialix@ukr.net-20080207075319-d9jj7as8i5ztiff7
some cleanup in package_mf.py; mention about load_from_zip() deprecation in NEWS.

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
        try:
 
424
            return versionedfile.add_lines_with_ghosts(
 
425
                self._new_revision_id, parents, new_lines,
 
426
                nostore_sha=nostore_sha, random_id=self.random_revid,
 
427
                check_content=False)[0:2]
 
428
        finally:
 
429
            versionedfile.clear_cache()
 
430
 
 
431
 
 
432
class RootCommitBuilder(CommitBuilder):
 
433
    """This commitbuilder actually records the root id"""
 
434
    
 
435
    # the root entry gets versioned properly by this builder.
 
436
    _versioned_root = True
 
437
 
 
438
    def _check_root(self, ie, parent_invs, tree):
 
439
        """Helper for record_entry_contents.
 
440
 
 
441
        :param ie: An entry being added.
 
442
        :param parent_invs: The inventories of the parent revisions of the
 
443
            commit.
 
444
        :param tree: The tree that is being committed.
 
445
        """
245
446
 
246
447
 
247
448
######################################################################
248
449
# Repositories
249
450
 
250
 
 
251
 
class Repository(_RelockDebugMixin, controldir.ControlComponent):
 
451
class Repository(object):
252
452
    """Repository holding history for one or more branches.
253
453
 
254
454
    The repository holds and retrieves historical information including
255
455
    revisions and file history.  It's normally accessed only by the Branch,
256
456
    which views a particular line of development through that history.
257
457
 
258
 
    See VersionedFileRepository in bzrlib.vf_repository for the
259
 
    base class for most Bazaar repositories.
 
458
    The Repository builds on top of Stores and a Transport, which respectively 
 
459
    describe the disk data format and the way of accessing the (possibly 
 
460
    remote) disk.
260
461
    """
261
462
 
262
 
    def abort_write_group(self, suppress_errors=False):
 
463
    # What class to use for a CommitBuilder. Often its simpler to change this
 
464
    # in a Repository class subclass rather than to override
 
465
    # get_commit_builder.
 
466
    _commit_builder_class = CommitBuilder
 
467
    # The search regex used by xml based repositories to determine what things
 
468
    # where changed in a single commit.
 
469
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
470
        r'file_id="(?P<file_id>[^"]+)"'
 
471
        r'.* revision="(?P<revision_id>[^"]+)"'
 
472
        )
 
473
 
 
474
    def abort_write_group(self):
263
475
        """Commit the contents accrued within the current write group.
264
476
 
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
477
        :seealso: start_write_group.
270
478
        """
271
479
        if self._write_group is not self.get_transaction():
272
480
            # 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)
 
481
            raise errors.BzrError('mismatched lock context and write group.')
 
482
        self._abort_write_group()
290
483
        self._write_group = None
291
484
 
292
485
    def _abort_write_group(self):
293
486
        """Template method for per-repository write group cleanup.
294
 
 
295
 
        This is called during abort before the write group is considered to be
 
487
        
 
488
        This is called during abort before the write group is considered to be 
296
489
        finished and should cleanup any internal state accrued during the write
297
490
        group. There is no requirement that data handed to the repository be
298
491
        *not* made available - this is not a rollback - but neither should any
302
495
        attempted.
303
496
        """
304
497
 
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)
 
498
    def add_inventory(self, revision_id, inv, parents):
 
499
        """Add the inventory inv to the repository as revision_id.
 
500
        
 
501
        :param parents: The revision ids of the parents that revision_id
 
502
                        is known to have and are in the repository already.
 
503
 
 
504
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
505
            repository format specific) of the serialized inventory.
 
506
        """
 
507
        assert self.is_in_write_group()
 
508
        _mod_revision.check_not_reserved_id(revision_id)
 
509
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
510
            "Mismatch between inventory revision" \
 
511
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
512
        assert inv.root is not None
 
513
        inv_lines = self._serialise_inventory_to_lines(inv)
 
514
        inv_vf = self.get_inventory_weave()
 
515
        return self._inventory_add_lines(inv_vf, revision_id, parents,
 
516
            inv_lines, check_content=False)
 
517
 
 
518
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
 
519
        check_content=True):
 
520
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
521
        final_parents = []
 
522
        for parent in parents:
 
523
            if parent in inv_vf:
 
524
                final_parents.append(parent)
 
525
        return inv_vf.add_lines(revision_id, final_parents, lines,
 
526
            check_content=check_content)[0]
 
527
 
 
528
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
529
        """Add rev to the revision store as revision_id.
 
530
 
 
531
        :param revision_id: the revision id to use.
 
532
        :param rev: The revision object.
 
533
        :param inv: The inventory for the revision. if None, it will be looked
 
534
                    up in the inventory storer
 
535
        :param config: If None no digital signature will be created.
 
536
                       If supplied its signature_needed method will be used
 
537
                       to determine if a signature should be made.
 
538
        """
 
539
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
540
        #       rev.parent_ids?
 
541
        _mod_revision.check_not_reserved_id(revision_id)
 
542
        if config is not None and config.signature_needed():
 
543
            if inv is None:
 
544
                inv = self.get_inventory(revision_id)
 
545
            plaintext = Testament(rev, inv).as_short_text()
 
546
            self.store_revision_signature(
 
547
                gpg.GPGStrategy(config), plaintext, revision_id)
 
548
        if not revision_id in self.get_inventory_weave():
 
549
            if inv is None:
 
550
                raise errors.WeaveRevisionNotPresent(revision_id,
 
551
                                                     self.get_inventory_weave())
 
552
            else:
 
553
                # yes, this is not suitable for adding with ghosts.
 
554
                self.add_inventory(revision_id, inv, rev.parent_ids)
 
555
        self._revision_store.add_revision(rev, self.get_transaction())
 
556
 
 
557
    def _add_revision_text(self, revision_id, text):
 
558
        revision = self._revision_store._serializer.read_revision_from_string(
 
559
            text)
 
560
        self._revision_store._add_revision(revision, StringIO(text),
 
561
                                           self.get_transaction())
320
562
 
321
563
    def all_revision_ids(self):
322
 
        """Returns a list of all the revision ids in the repository.
 
564
        """Returns a list of all the revision ids in the repository. 
323
565
 
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.
 
566
        This is deprecated because code should generally work on the graph
 
567
        reachable from a particular revision, and ignore any other revisions
 
568
        that might be present.  There is no direct replacement method.
328
569
        """
329
570
        if 'evil' in debug.debug_flags:
330
571
            mutter_callsite(2, "all_revision_ids is linear with history.")
331
572
        return self._all_revision_ids()
332
573
 
333
574
    def _all_revision_ids(self):
334
 
        """Returns a list of all the revision ids in the repository.
 
575
        """Returns a list of all the revision ids in the repository. 
335
576
 
336
 
        These are in as much topological order as the underlying store can
 
577
        These are in as much topological order as the underlying store can 
337
578
        present.
338
579
        """
339
580
        raise NotImplementedError(self._all_revision_ids)
346
587
        """
347
588
        self.control_files.break_lock()
348
589
 
 
590
    @needs_read_lock
 
591
    def _eliminate_revisions_not_present(self, revision_ids):
 
592
        """Check every revision id in revision_ids to see if we have it.
 
593
 
 
594
        Returns a set of the present revisions.
 
595
        """
 
596
        result = []
 
597
        for id in revision_ids:
 
598
            if self.has_revision(id):
 
599
               result.append(id)
 
600
        return result
 
601
 
349
602
    @staticmethod
350
 
    def create(controldir):
351
 
        """Construct the current default format repository in controldir."""
352
 
        return RepositoryFormat.get_default_format().initialize(controldir)
 
603
    def create(a_bzrdir):
 
604
        """Construct the current default format repository in a_bzrdir."""
 
605
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
353
606
 
354
 
    def __init__(self, _format, controldir, control_files):
 
607
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
355
608
        """instantiate a Repository.
356
609
 
357
610
        :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.
 
611
        :param a_bzrdir: The BzrDir of the repository.
 
612
 
 
613
        In the future we will have a single api for all stores for
 
614
        getting file texts, inventories and revisions, then
 
615
        this construct will accept instances of those things.
360
616
        """
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
617
        super(Repository, self).__init__()
365
618
        self._format = _format
366
619
        # the following are part of the public API for Repository:
367
 
        self.bzrdir = controldir
 
620
        self.bzrdir = a_bzrdir
368
621
        self.control_files = control_files
 
622
        self._revision_store = _revision_store
 
623
        # backwards compatibility
 
624
        self.weave_store = text_store
369
625
        # for tests
 
626
        self._reconcile_does_inventory_gc = True
 
627
        self._reconcile_fixes_text_parents = False
 
628
        self._reconcile_backsup_inventory = True
 
629
        # not right yet - should be more semantically clear ? 
 
630
        # 
 
631
        self.control_store = control_store
 
632
        self.control_weaves = control_store
 
633
        # TODO: make sure to construct the right store classes, etc, depending
 
634
        # on whether escaping is required.
 
635
        self._warn_if_deprecated()
370
636
        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
 
637
        self.base = control_files._transport.base
381
638
 
382
639
    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
 
640
        return '%s(%r)' % (self.__class__.__name__,
 
641
                           self.base)
402
642
 
403
643
    def has_same_location(self, other):
404
644
        """Returns a boolean indicating if this repository is at the same
409
649
        """
410
650
        if self.__class__ is not other.__class__:
411
651
            return False
412
 
        return (self.control_url == other.control_url)
 
652
        return (self.control_files._transport.base ==
 
653
                other.control_files._transport.base)
413
654
 
414
655
    def is_in_write_group(self):
415
656
        """Return True if there is an open write group.
431
672
        This causes caching within the repository obejct to start accumlating
432
673
        data during reads, and allows a 'write_group' to be obtained. Write
433
674
        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
 
 
 
675
        
441
676
        :param token: if this is already locked, then lock_write will fail
442
677
            unless the token matches the existing lock.
443
678
        :returns: a token if this instance supports tokens, otherwise None.
446
681
        :raises MismatchedToken: if the specified token doesn't match the token
447
682
            of the existing lock.
448
683
        :seealso: start_write_group.
449
 
        :return: A RepositoryWriteLockResult.
 
684
 
 
685
        A token should be passed in if you know that you have locked the object
 
686
        some other way, and need to synchronise this object's state with that
 
687
        fact.
 
688
 
 
689
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
450
690
        """
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)
 
691
        result = self.control_files.lock_write(token=token)
 
692
        self._refresh_data()
 
693
        return result
461
694
 
462
695
    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
696
        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)
 
697
        self._refresh_data()
477
698
 
478
699
    def get_physical_lock_status(self):
479
700
        return self.control_files.get_physical_lock_status()
481
702
    def leave_lock_in_place(self):
482
703
        """Tell this repository not to release the physical lock when this
483
704
        object is unlocked.
484
 
 
 
705
        
485
706
        If lock_write doesn't return a token, then this method is not supported.
486
707
        """
487
708
        self.control_files.leave_in_place()
515
736
        if revid and committers:
516
737
            result['committers'] = 0
517
738
        if revid and revid != _mod_revision.NULL_REVISION:
518
 
            graph = self.get_graph()
519
739
            if committers:
520
740
                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
 
741
            revisions = self.get_ancestry(revid)
 
742
            # pop the leading None
 
743
            revisions.pop(0)
 
744
            first_revision = None
524
745
            if not committers:
525
746
                # ignore the revisions in the middle - just grab first and last
526
747
                revisions = revisions[0], revisions[-1]
527
748
            for revision in self.get_revisions(revisions):
528
 
                if not last_revision:
529
 
                    last_revision = revision
 
749
                if not first_revision:
 
750
                    first_revision = revision
530
751
                if committers:
531
752
                    all_committers.add(revision.committer)
532
 
            first_revision = revision
 
753
            last_revision = revision
533
754
            if committers:
534
755
                result['committers'] = len(all_committers)
535
756
            result['firstrev'] = (first_revision.timestamp,
536
757
                first_revision.timezone)
537
758
            result['latestrev'] = (last_revision.timestamp,
538
759
                last_revision.timezone)
 
760
 
 
761
        # now gather global repository information
 
762
        if self.bzrdir.root_transport.listable():
 
763
            c, t = self._revision_store.total_size(self.get_transaction())
 
764
            result['revisions'] = c
 
765
            result['size'] = t
539
766
        return result
540
767
 
541
768
    def find_branches(self, using=False):
546
773
        :param using: If True, list only branches using this repository.
547
774
        """
548
775
        if using and not self.is_shared():
549
 
            return self.bzrdir.list_branches()
 
776
            try:
 
777
                return [self.bzrdir.open_branch()]
 
778
            except errors.NotBranchError:
 
779
                return []
550
780
        class Evaluator(object):
551
781
 
552
782
            def __init__(self):
553
783
                self.first_call = True
554
784
 
555
 
            def __call__(self, controldir):
556
 
                # On the first call, the parameter is always the controldir
 
785
            def __call__(self, bzrdir):
 
786
                # On the first call, the parameter is always the bzrdir
557
787
                # containing the current repo.
558
788
                if not self.first_call:
559
789
                    try:
560
 
                        repository = controldir.open_repository()
 
790
                        repository = bzrdir.open_repository()
561
791
                    except errors.NoRepositoryPresent:
562
792
                        pass
563
793
                    else:
564
 
                        return False, ([], repository)
 
794
                        return False, (None, repository)
565
795
                self.first_call = False
566
 
                value = (controldir.list_branches(), None)
 
796
                try:
 
797
                    value = (bzrdir.open_branch(), None)
 
798
                except errors.NotBranchError:
 
799
                    value = (None, None)
567
800
                return True, value
568
801
 
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)
 
802
        branches = []
 
803
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
804
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
805
            if branch is not None:
 
806
                branches.append(branch)
574
807
            if not using and repository is not None:
575
 
                ret.extend(repository.find_branches())
576
 
        return ret
 
808
                branches.extend(repository.find_branches())
 
809
        return branches
 
810
 
 
811
    def get_data_stream(self, revision_ids):
 
812
        raise NotImplementedError(self.get_data_stream)
 
813
 
 
814
    def get_data_stream_for_search(self, search_result):
 
815
        """Get a data stream that can be inserted to a repository.
 
816
 
 
817
        :param search_result: A bzrlib.graph.SearchResult selecting the
 
818
            revisions to get.
 
819
        :return: A data stream that can be inserted into a repository using
 
820
            insert_data_stream.
 
821
        """
 
822
        raise NotImplementedError(self.get_data_stream_for_search)
 
823
 
 
824
    def insert_data_stream(self, stream):
 
825
        """XXX What does this really do? 
 
826
        
 
827
        Is it a substitute for fetch? 
 
828
        Should it manage its own write group ?
 
829
        """
 
830
        for item_key, bytes in stream:
 
831
            if item_key[0] == 'file':
 
832
                (file_id,) = item_key[1:]
 
833
                knit = self.weave_store.get_weave_or_empty(
 
834
                    file_id, self.get_transaction())
 
835
            elif item_key == ('inventory',):
 
836
                knit = self.get_inventory_weave()
 
837
            elif item_key == ('revisions',):
 
838
                knit = self._revision_store.get_revision_file(
 
839
                    self.get_transaction())
 
840
            elif item_key == ('signatures',):
 
841
                knit = self._revision_store.get_signature_file(
 
842
                    self.get_transaction())
 
843
            else:
 
844
                raise errors.RepositoryDataStreamError(
 
845
                    "Unrecognised data stream key '%s'" % (item_key,))
 
846
            decoded_list = bencode.bdecode(bytes)
 
847
            format = decoded_list.pop(0)
 
848
            data_list = []
 
849
            knit_bytes = ''
 
850
            for version, options, parents, some_bytes in decoded_list:
 
851
                data_list.append((version, options, len(some_bytes), parents))
 
852
                knit_bytes += some_bytes
 
853
            buffer = StringIO(knit_bytes)
 
854
            def reader_func(count):
 
855
                if count is None:
 
856
                    return buffer.read()
 
857
                else:
 
858
                    return buffer.read(count)
 
859
            knit.insert_data_stream(
 
860
                (format, data_list, reader_func))
577
861
 
578
862
    @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):
 
863
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
583
864
        """Return the revision ids that other has that this does not.
584
 
 
 
865
        
585
866
        These are returned in topological order.
586
867
 
587
868
        revision_id: only return revision ids included by revision_id.
588
869
        """
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
870
        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)
 
871
            revision_id, find_ghosts)
 
872
 
 
873
    @deprecated_method(symbol_versioning.one_two)
 
874
    @needs_read_lock
 
875
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
876
        """Return the revision ids that other has that this does not.
 
877
        
 
878
        These are returned in topological order.
 
879
 
 
880
        revision_id: only return revision ids included by revision_id.
 
881
        """
 
882
        keys =  self.search_missing_revision_ids(
 
883
            other, revision_id, find_ghosts).get_keys()
 
884
        other.lock_read()
 
885
        try:
 
886
            parents = other.get_graph().get_parent_map(keys)
 
887
        finally:
 
888
            other.unlock()
 
889
        return tsort.topo_sort(parents)
602
890
 
603
891
    @staticmethod
604
892
    def open(base):
607
895
        For instance, if the repository is at URL/.bzr/repository,
608
896
        Repository.open(URL) -> a Repository instance.
609
897
        """
610
 
        control = controldir.ControlDir.open(base)
 
898
        control = bzrdir.BzrDir.open(base)
611
899
        return control.open_repository()
612
900
 
613
901
    def copy_content_into(self, destination, revision_id=None):
614
902
        """Make a complete copy of the content in self into destination.
615
 
 
616
 
        This is a destructive operation! Do not use it on existing
 
903
        
 
904
        This is a destructive operation! Do not use it on existing 
617
905
        repositories.
618
906
        """
619
907
        return InterRepository.get(self, destination).copy_content(revision_id)
622
910
        """Commit the contents accrued within the current write group.
623
911
 
624
912
        :seealso: start_write_group.
625
 
        
626
 
        :return: it may return an opaque hint that can be passed to 'pack'.
627
913
        """
628
914
        if self._write_group is not self.get_transaction():
629
915
            # has an unlock or relock occured ?
630
916
            raise errors.BzrError('mismatched lock context %r and '
631
917
                'write group %r.' %
632
918
                (self.get_transaction(), self._write_group))
633
 
        result = self._commit_write_group()
 
919
        self._commit_write_group()
634
920
        self._write_group = None
635
 
        return result
636
921
 
637
922
    def _commit_write_group(self):
638
923
        """Template method for per-repository write group cleanup.
639
 
 
640
 
        This is called before the write group is considered to be
 
924
        
 
925
        This is called before the write group is considered to be 
641
926
        finished and should ensure that all data handed to the repository
642
 
        for writing during the write group is safely committed (to the
 
927
        for writing during the write group is safely committed (to the 
643
928
        extent possible considering file system caching etc).
644
929
        """
645
930
 
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):
 
931
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
681
932
        """Fetch the content required to construct revision_id from source.
682
933
 
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
 
 
 
934
        If revision_id is None all content is copied.
689
935
        :param find_ghosts: Find and copy revisions in the source that are
690
936
            ghosts in the target (and not reachable directly by walking out to
691
937
            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
938
        """
696
 
        if self.is_in_write_group():
697
 
            raise errors.InternalBzrError(
698
 
                "May not fetch while in a write group.")
699
939
        # 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)):
 
940
        if self.has_same_location(source):
704
941
            # check that last_revision is in 'from' and then return a
705
942
            # no-operation.
706
943
            if (revision_id is not None and
708
945
                self.get_revision(revision_id)
709
946
            return 0, []
710
947
        inter = InterRepository.get(source, self)
711
 
        return inter.fetch(revision_id=revision_id, find_ghosts=find_ghosts)
 
948
        try:
 
949
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
950
        except NotImplementedError:
 
951
            raise errors.IncompatibleRepositories(source, self)
712
952
 
713
953
    def create_bundle(self, target, base, fileobj, format=None):
714
954
        return serializer.write_bundle(self, target, base, fileobj, format)
715
955
 
716
 
    def get_commit_builder(self, branch, parents, config_stack, timestamp=None,
 
956
    def get_commit_builder(self, branch, parents, config, timestamp=None,
717
957
                           timezone=None, committer=None, revprops=None,
718
 
                           revision_id=None, lossy=False):
 
958
                           revision_id=None):
719
959
        """Obtain a CommitBuilder for this repository.
720
 
 
 
960
        
721
961
        :param branch: Branch to commit to.
722
962
        :param parents: Revision ids of the parents of the new revision.
723
 
        :param config_stack: Configuration stack to use.
 
963
        :param config: Configuration to use.
724
964
        :param timestamp: Optional timestamp recorded for commit.
725
965
        :param timezone: Optional timezone for timestamp.
726
966
        :param committer: Optional committer to set for commit.
727
967
        :param revprops: Optional dictionary of revision properties.
728
968
        :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
969
        """
732
 
        raise NotImplementedError(self.get_commit_builder)
 
970
        result = self._commit_builder_class(self, parents, config,
 
971
            timestamp, timezone, committer, revprops, revision_id)
 
972
        self.start_write_group()
 
973
        return result
733
974
 
734
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
735
975
    def unlock(self):
736
976
        if (self.control_files._lock_count == 1 and
737
977
            self.control_files._lock_mode == 'w'):
741
981
                raise errors.BzrError(
742
982
                    'Must end write groups before releasing write locks.')
743
983
        self.control_files.unlock()
744
 
        if self.control_files._lock_count == 0:
745
 
            for repo in self._fallback_repositories:
746
 
                repo.unlock()
747
984
 
748
985
    @needs_read_lock
749
 
    def clone(self, controldir, revision_id=None):
750
 
        """Clone this repository into controldir using the current format.
 
986
    def clone(self, a_bzrdir, revision_id=None):
 
987
        """Clone this repository into a_bzrdir using the current format.
751
988
 
752
989
        Currently no check is made that the format of this repository and
753
990
        the bzrdir format are compatible. FIXME RBC 20060201.
756
993
        """
757
994
        # TODO: deprecate after 0.16; cloning this with all its settings is
758
995
        # probably not very useful -- mbp 20070423
759
 
        dest_repo = self._create_sprouting_repo(
760
 
            controldir, shared=self.is_shared())
 
996
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
761
997
        self.copy_content_into(dest_repo, revision_id)
762
998
        return dest_repo
763
999
 
785
1021
 
786
1022
    def _start_write_group(self):
787
1023
        """Template method for per-repository write group startup.
788
 
 
789
 
        This is called before the write group is considered to be
 
1024
        
 
1025
        This is called before the write group is considered to be 
790
1026
        entered.
791
1027
        """
792
1028
 
818
1054
        """True if this repository has a copy of the revision."""
819
1055
        return revision_id in self.has_revisions((revision_id,))
820
1056
 
821
 
    @needs_read_lock
822
1057
    def has_revisions(self, revision_ids):
823
1058
        """Probe to find out the presence of multiple revisions.
824
1059
 
827
1062
        """
828
1063
        raise NotImplementedError(self.has_revisions)
829
1064
 
 
1065
        return self._revision_store.has_revision_id(revision_id,
 
1066
                                                    self.get_transaction())
 
1067
 
830
1068
    @needs_read_lock
831
1069
    def get_revision(self, revision_id):
832
1070
        """Return the Revision object for a named revision."""
833
1071
        return self.get_revisions([revision_id])[0]
834
1072
 
 
1073
    @needs_read_lock
835
1074
    def get_revision_reconcile(self, revision_id):
836
1075
        """'reconcile' helper routine that allows access to a revision always.
837
 
 
 
1076
        
838
1077
        This variant of get_revision does not cross check the weave graph
839
1078
        against the revision one as get_revision does: but it should only
840
1079
        be used by reconcile, or reconcile-alike commands that are correcting
841
1080
        or testing the revision graph.
842
1081
        """
843
 
        raise NotImplementedError(self.get_revision_reconcile)
 
1082
        return self._get_revisions([revision_id])[0]
844
1083
 
 
1084
    @needs_read_lock
845
1085
    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):
 
1086
        """Get many revisions at once."""
 
1087
        return self._get_revisions(revision_ids)
 
1088
 
 
1089
    @needs_read_lock
 
1090
    def _get_revisions(self, revision_ids):
 
1091
        """Core work logic to get many revisions without sanity checks."""
 
1092
        for rev_id in revision_ids:
 
1093
            if not rev_id or not isinstance(rev_id, basestring):
 
1094
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1095
        revs = self._revision_store.get_revisions(revision_ids,
 
1096
                                                  self.get_transaction())
 
1097
        for rev in revs:
 
1098
            assert not isinstance(rev.revision_id, unicode)
 
1099
            for parent_id in rev.parent_ids:
 
1100
                assert not isinstance(parent_id, unicode)
 
1101
        return revs
 
1102
 
 
1103
    @needs_read_lock
 
1104
    def get_revision_xml(self, revision_id):
 
1105
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1106
        #       would have already do it.
 
1107
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1108
        rev = self.get_revision(revision_id)
 
1109
        rev_tmp = StringIO()
 
1110
        # the current serializer..
 
1111
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1112
        rev_tmp.seek(0)
 
1113
        return rev_tmp.getvalue()
 
1114
 
 
1115
    @needs_read_lock
 
1116
    def get_deltas_for_revisions(self, revisions):
854
1117
        """Produce a generator of revision deltas.
855
 
 
 
1118
        
856
1119
        Note that the input is a sequence of REVISIONS, not revision_ids.
857
1120
        Trees will be held in memory until the generator exits.
858
1121
        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
1122
        """
864
 
        # Get the revision-ids of interest
865
1123
        required_trees = set()
866
1124
        for revision in revisions:
867
1125
            required_trees.add(revision.revision_id)
868
1126
            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
 
1127
        trees = dict((t.get_revision_id(), t) for 
 
1128
                     t in self.revision_trees(required_trees))
885
1129
        for revision in revisions:
886
1130
            if not revision.parent_ids:
887
 
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
1131
                old_tree = self.revision_tree(None)
888
1132
            else:
889
1133
                old_tree = trees[revision.parent_ids[0]]
890
1134
            yield trees[revision.revision_id].changes_from(old_tree)
891
1135
 
892
1136
    @needs_read_lock
893
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1137
    def get_revision_delta(self, revision_id):
894
1138
        """Return the delta for one revision.
895
1139
 
896
1140
        The delta is relative to the left-hand predecessor of the
897
1141
        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
1142
        """
903
1143
        r = self.get_revision(revision_id)
904
 
        return list(self.get_deltas_for_revisions([r],
905
 
            specific_fileids=specific_fileids))[0]
 
1144
        return list(self.get_deltas_for_revisions([r]))[0]
906
1145
 
907
1146
    @needs_write_lock
908
1147
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
909
1148
        signature = gpg_strategy.sign(plaintext)
910
1149
        self.add_signature_text(revision_id, signature)
911
1150
 
 
1151
    @needs_write_lock
912
1152
    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
 
1153
        self._revision_store.add_revision_signature_text(revision_id,
 
1154
                                                         signature,
 
1155
                                                         self.get_transaction())
 
1156
 
 
1157
    def find_text_key_references(self):
 
1158
        """Find the text key references within the repository.
 
1159
 
 
1160
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
1161
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1162
        altered it listed explicitly.
 
1163
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1164
            to whether they were referred to by the inventory of the
 
1165
            revision_id that they contain. The inventory texts from all present
 
1166
            revision ids are assessed to generate this report.
 
1167
        """
 
1168
        revision_ids = self.all_revision_ids()
 
1169
        w = self.get_inventory_weave()
 
1170
        pb = ui.ui_factory.nested_progress_bar()
 
1171
        try:
 
1172
            return self._find_text_key_references_from_xml_inventory_lines(
 
1173
                w.iter_lines_added_or_present_in_versions(revision_ids, pb=pb))
 
1174
        finally:
 
1175
            pb.finished()
 
1176
 
 
1177
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1178
        line_iterator):
 
1179
        """Core routine for extracting references to texts from inventories.
 
1180
 
 
1181
        This performs the translation of xml lines to revision ids.
 
1182
 
 
1183
        :param line_iterator: An iterator of lines, origin_version_id
 
1184
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1185
            to whether they were referred to by the inventory of the
 
1186
            revision_id that they contain. Note that if that revision_id was
 
1187
            not part of the line_iterator's output then False will be given -
 
1188
            even though it may actually refer to that key.
 
1189
        """
 
1190
        if not self._serializer.support_altered_by_hack:
 
1191
            raise AssertionError(
 
1192
                "_find_text_key_references_from_xml_inventory_lines only "
 
1193
                "supported for branches which store inventory as unnested xml"
 
1194
                ", not on %r" % self)
 
1195
        result = {}
 
1196
 
 
1197
        # this code needs to read every new line in every inventory for the
 
1198
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
1199
        # not present in one of those inventories is unnecessary but not 
 
1200
        # harmful because we are filtering by the revision id marker in the
 
1201
        # inventory lines : we only select file ids altered in one of those  
 
1202
        # revisions. We don't need to see all lines in the inventory because
 
1203
        # only those added in an inventory in rev X can contain a revision=X
 
1204
        # line.
 
1205
        unescape_revid_cache = {}
 
1206
        unescape_fileid_cache = {}
 
1207
 
 
1208
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1209
        # of lines, so it has had a lot of inlining and optimizing done.
 
1210
        # Sorry that it is a little bit messy.
 
1211
        # Move several functions to be local variables, since this is a long
 
1212
        # running loop.
 
1213
        search = self._file_ids_altered_regex.search
 
1214
        unescape = _unescape_xml
 
1215
        setdefault = result.setdefault
 
1216
        for line, version_id in line_iterator:
 
1217
            match = search(line)
 
1218
            if match is None:
 
1219
                continue
 
1220
            # One call to match.group() returning multiple items is quite a
 
1221
            # bit faster than 2 calls to match.group() each returning 1
 
1222
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1223
 
 
1224
            # Inlining the cache lookups helps a lot when you make 170,000
 
1225
            # lines and 350k ids, versus 8.4 unique ids.
 
1226
            # Using a cache helps in 2 ways:
 
1227
            #   1) Avoids unnecessary decoding calls
 
1228
            #   2) Re-uses cached strings, which helps in future set and
 
1229
            #      equality checks.
 
1230
            # (2) is enough that removing encoding entirely along with
 
1231
            # the cache (so we are using plain strings) results in no
 
1232
            # performance improvement.
 
1233
            try:
 
1234
                revision_id = unescape_revid_cache[revision_id]
 
1235
            except KeyError:
 
1236
                unescaped = unescape(revision_id)
 
1237
                unescape_revid_cache[revision_id] = unescaped
 
1238
                revision_id = unescaped
 
1239
 
 
1240
            # Note that unconditionally unescaping means that we deserialise
 
1241
            # every fileid, which for general 'pull' is not great, but we don't
 
1242
            # really want to have some many fulltexts that this matters anyway.
 
1243
            # RBC 20071114.
 
1244
            try:
 
1245
                file_id = unescape_fileid_cache[file_id]
 
1246
            except KeyError:
 
1247
                unescaped = unescape(file_id)
 
1248
                unescape_fileid_cache[file_id] = unescaped
 
1249
                file_id = unescaped
 
1250
 
 
1251
            key = (file_id, revision_id)
 
1252
            setdefault(key, False)
 
1253
            if revision_id == version_id:
 
1254
                result[key] = True
 
1255
        return result
 
1256
 
 
1257
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1258
        revision_ids):
 
1259
        """Helper routine for fileids_altered_by_revision_ids.
 
1260
 
 
1261
        This performs the translation of xml lines to revision ids.
 
1262
 
 
1263
        :param line_iterator: An iterator of lines, origin_version_id
 
1264
        :param revision_ids: The revision ids to filter for. This should be a
 
1265
            set or other type which supports efficient __contains__ lookups, as
 
1266
            the revision id from each parsed line will be looked up in the
 
1267
            revision_ids filter.
 
1268
        :return: a dictionary mapping altered file-ids to an iterable of
 
1269
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1270
        altered it listed explicitly.
 
1271
        """
 
1272
        result = {}
 
1273
        setdefault = result.setdefault
 
1274
        for file_id, revision_id in \
 
1275
            self._find_text_key_references_from_xml_inventory_lines(
 
1276
                line_iterator).iterkeys():
 
1277
            # once data is all ensured-consistent; then this is
 
1278
            # if revision_id == version_id
 
1279
            if revision_id in revision_ids:
 
1280
                setdefault(file_id, set()).add(revision_id)
 
1281
        return result
 
1282
 
 
1283
    def fileids_altered_by_revision_ids(self, revision_ids):
 
1284
        """Find the file ids and versions affected by revisions.
 
1285
 
 
1286
        :param revisions: an iterable containing revision ids.
 
1287
        :return: a dictionary mapping altered file-ids to an iterable of
 
1288
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1289
        altered it listed explicitly.
 
1290
        """
 
1291
        selected_revision_ids = set(revision_ids)
 
1292
        w = self.get_inventory_weave()
 
1293
        pb = ui.ui_factory.nested_progress_bar()
 
1294
        try:
 
1295
            return self._find_file_ids_from_xml_inventory_lines(
 
1296
                w.iter_lines_added_or_present_in_versions(
 
1297
                    selected_revision_ids, pb=pb),
 
1298
                selected_revision_ids)
 
1299
        finally:
 
1300
            pb.finished()
932
1301
 
933
1302
    def iter_files_bytes(self, desired_files):
934
1303
        """Iterate through file versions.
941
1310
        uniquely identify the file version in the caller's context.  (Examples:
942
1311
        an index number or a TreeTransform trans_id.)
943
1312
 
 
1313
        bytes_iterator is an iterable of bytestrings for the file.  The
 
1314
        kind of iterable and length of the bytestrings are unspecified, but for
 
1315
        this implementation, it is a list of lines produced by
 
1316
        VersionedFile.get_lines().
 
1317
 
944
1318
        :param desired_files: a list of (file_id, revision_id, identifier)
945
1319
            triples
946
1320
        """
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
 
 
 
1321
        transaction = self.get_transaction()
 
1322
        for file_id, revision_id, callable_data in desired_files:
 
1323
            try:
 
1324
                weave = self.weave_store.get_weave(file_id, transaction)
 
1325
            except errors.NoSuchFile:
 
1326
                raise errors.NoSuchIdInRepository(self, file_id)
 
1327
            yield callable_data, weave.get_lines(revision_id)
 
1328
 
 
1329
    def _generate_text_key_index(self, text_key_references=None,
 
1330
        ancestors=None):
 
1331
        """Generate a new text key index for the repository.
 
1332
 
 
1333
        This is an expensive function that will take considerable time to run.
 
1334
 
 
1335
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
1336
            list of parents, also text keys. When a given key has no parents,
 
1337
            the parents list will be [NULL_REVISION].
 
1338
        """
 
1339
        # All revisions, to find inventory parents.
 
1340
        if ancestors is None:
 
1341
            revision_graph = self.get_revision_graph_with_ghosts()
 
1342
            ancestors = revision_graph.get_ancestors()
 
1343
        if text_key_references is None:
 
1344
            text_key_references = self.find_text_key_references()
 
1345
        pb = ui.ui_factory.nested_progress_bar()
 
1346
        try:
 
1347
            return self._do_generate_text_key_index(ancestors,
 
1348
                text_key_references, pb)
 
1349
        finally:
 
1350
            pb.finished()
 
1351
 
 
1352
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
1353
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
1354
        revision_order = tsort.topo_sort(ancestors)
 
1355
        invalid_keys = set()
 
1356
        revision_keys = {}
 
1357
        for revision_id in revision_order:
 
1358
            revision_keys[revision_id] = set()
 
1359
        text_count = len(text_key_references)
 
1360
        # a cache of the text keys to allow reuse; costs a dict of all the
 
1361
        # keys, but saves a 2-tuple for every child of a given key.
 
1362
        text_key_cache = {}
 
1363
        for text_key, valid in text_key_references.iteritems():
 
1364
            if not valid:
 
1365
                invalid_keys.add(text_key)
 
1366
            else:
 
1367
                revision_keys[text_key[1]].add(text_key)
 
1368
            text_key_cache[text_key] = text_key
 
1369
        del text_key_references
 
1370
        text_index = {}
 
1371
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
1372
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1373
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
1374
        # too small for large or very branchy trees. However, for 55K path
 
1375
        # trees, it would be easy to use too much memory trivially. Ideally we
 
1376
        # could gauge this by looking at available real memory etc, but this is
 
1377
        # always a tricky proposition.
 
1378
        inventory_cache = lru_cache.LRUCache(10)
 
1379
        batch_size = 10 # should be ~150MB on a 55K path tree
 
1380
        batch_count = len(revision_order) / batch_size + 1
 
1381
        processed_texts = 0
 
1382
        pb.update("Calculating text parents.", processed_texts, text_count)
 
1383
        for offset in xrange(batch_count):
 
1384
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
1385
                batch_size]
 
1386
            if not to_query:
 
1387
                break
 
1388
            for rev_tree in self.revision_trees(to_query):
 
1389
                revision_id = rev_tree.get_revision_id()
 
1390
                parent_ids = ancestors[revision_id]
 
1391
                for text_key in revision_keys[revision_id]:
 
1392
                    pb.update("Calculating text parents.", processed_texts)
 
1393
                    processed_texts += 1
 
1394
                    candidate_parents = []
 
1395
                    for parent_id in parent_ids:
 
1396
                        parent_text_key = (text_key[0], parent_id)
 
1397
                        try:
 
1398
                            check_parent = parent_text_key not in \
 
1399
                                revision_keys[parent_id]
 
1400
                        except KeyError:
 
1401
                            # the parent parent_id is a ghost:
 
1402
                            check_parent = False
 
1403
                            # truncate the derived graph against this ghost.
 
1404
                            parent_text_key = None
 
1405
                        if check_parent:
 
1406
                            # look at the parent commit details inventories to
 
1407
                            # determine possible candidates in the per file graph.
 
1408
                            # TODO: cache here.
 
1409
                            try:
 
1410
                                inv = inventory_cache[parent_id]
 
1411
                            except KeyError:
 
1412
                                inv = self.revision_tree(parent_id).inventory
 
1413
                                inventory_cache[parent_id] = inv
 
1414
                            parent_entry = inv._byid.get(text_key[0], None)
 
1415
                            if parent_entry is not None:
 
1416
                                parent_text_key = (
 
1417
                                    text_key[0], parent_entry.revision)
 
1418
                            else:
 
1419
                                parent_text_key = None
 
1420
                        if parent_text_key is not None:
 
1421
                            candidate_parents.append(
 
1422
                                text_key_cache[parent_text_key])
 
1423
                    parent_heads = text_graph.heads(candidate_parents)
 
1424
                    new_parents = list(parent_heads)
 
1425
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
1426
                    if new_parents == []:
 
1427
                        new_parents = [NULL_REVISION]
 
1428
                    text_index[text_key] = new_parents
 
1429
 
 
1430
        for text_key in invalid_keys:
 
1431
            text_index[text_key] = [NULL_REVISION]
 
1432
        return text_index
 
1433
 
 
1434
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1435
        """Get an iterable listing the keys of all the data introduced by a set
 
1436
        of revision IDs.
 
1437
 
 
1438
        The keys will be ordered so that the corresponding items can be safely
 
1439
        fetched and inserted in that order.
 
1440
 
 
1441
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
1442
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
1443
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
1444
        """
 
1445
        # XXX: it's a bit weird to control the inventory weave caching in this
 
1446
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
1447
        # maybe this generator should explicitly have the contract that it
 
1448
        # should not be iterated until the previously yielded item has been
 
1449
        # processed?
 
1450
        self.lock_read()
 
1451
        inv_w = self.get_inventory_weave()
 
1452
        inv_w.enable_cache()
 
1453
 
 
1454
        # file ids that changed
 
1455
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
 
1456
        count = 0
 
1457
        num_file_ids = len(file_ids)
 
1458
        for file_id, altered_versions in file_ids.iteritems():
 
1459
            if _files_pb is not None:
 
1460
                _files_pb.update("fetch texts", count, num_file_ids)
 
1461
            count += 1
 
1462
            yield ("file", file_id, altered_versions)
 
1463
        # We're done with the files_pb.  Note that it finished by the caller,
 
1464
        # just as it was created by the caller.
 
1465
        del _files_pb
 
1466
 
 
1467
        # inventory
 
1468
        yield ("inventory", None, revision_ids)
 
1469
        inv_w.clear_cache()
 
1470
 
 
1471
        # signatures
 
1472
        revisions_with_signatures = set()
 
1473
        for rev_id in revision_ids:
 
1474
            try:
 
1475
                self.get_signature_text(rev_id)
 
1476
            except errors.NoSuchRevision:
 
1477
                # not signed.
 
1478
                pass
 
1479
            else:
 
1480
                revisions_with_signatures.add(rev_id)
 
1481
        self.unlock()
 
1482
        yield ("signatures", None, revisions_with_signatures)
 
1483
 
 
1484
        # revisions
 
1485
        yield ("revisions", None, revision_ids)
 
1486
 
 
1487
    @needs_read_lock
 
1488
    def get_inventory_weave(self):
 
1489
        return self.control_weaves.get_weave('inventory',
 
1490
            self.get_transaction())
 
1491
 
 
1492
    @needs_read_lock
 
1493
    def get_inventory(self, revision_id):
 
1494
        """Get Inventory object by revision id."""
 
1495
        return self.iter_inventories([revision_id]).next()
 
1496
 
 
1497
    def iter_inventories(self, revision_ids):
 
1498
        """Get many inventories by revision_ids.
 
1499
 
 
1500
        This will buffer some or all of the texts used in constructing the
 
1501
        inventories in memory, but will only parse a single inventory at a
 
1502
        time.
 
1503
 
 
1504
        :return: An iterator of inventories.
 
1505
        """
 
1506
        assert None not in revision_ids
 
1507
        assert _mod_revision.NULL_REVISION not in revision_ids
 
1508
        return self._iter_inventories(revision_ids)
 
1509
 
 
1510
    def _iter_inventories(self, revision_ids):
 
1511
        """single-document based inventory iteration."""
 
1512
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
1513
        for text, revision_id in zip(texts, revision_ids):
 
1514
            yield self.deserialise_inventory(revision_id, text)
 
1515
 
 
1516
    def deserialise_inventory(self, revision_id, xml):
 
1517
        """Transform the xml into an inventory object. 
 
1518
 
 
1519
        :param revision_id: The expected revision id of the inventory.
 
1520
        :param xml: A serialised inventory.
 
1521
        """
 
1522
        result = self._serializer.read_inventory_from_string(xml, revision_id)
 
1523
        if result.revision_id != revision_id:
 
1524
            raise AssertionError('revision id mismatch %s != %s' % (
 
1525
                result.revision_id, revision_id))
 
1526
        return result
 
1527
 
 
1528
    def serialise_inventory(self, inv):
 
1529
        return self._serializer.write_inventory_to_string(inv)
 
1530
 
 
1531
    def _serialise_inventory_to_lines(self, inv):
 
1532
        return self._serializer.write_inventory_to_lines(inv)
 
1533
 
 
1534
    def get_serializer_format(self):
 
1535
        return self._serializer.format_num
 
1536
 
 
1537
    @needs_read_lock
 
1538
    def get_inventory_xml(self, revision_id):
 
1539
        """Get inventory XML as a file object."""
 
1540
        try:
 
1541
            assert isinstance(revision_id, str), type(revision_id)
 
1542
            iw = self.get_inventory_weave()
 
1543
            return iw.get_text(revision_id)
 
1544
        except IndexError:
 
1545
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
1546
 
 
1547
    @needs_read_lock
 
1548
    def get_inventory_sha1(self, revision_id):
 
1549
        """Return the sha1 hash of the inventory entry
 
1550
        """
 
1551
        return self.get_revision(revision_id).inventory_sha1
 
1552
 
 
1553
    @needs_read_lock
 
1554
    def get_revision_graph(self, revision_id=None):
 
1555
        """Return a dictionary containing the revision graph.
 
1556
 
 
1557
        NB: This method should not be used as it accesses the entire graph all
 
1558
        at once, which is much more data than most operations should require.
 
1559
 
 
1560
        :param revision_id: The revision_id to get a graph from. If None, then
 
1561
        the entire revision graph is returned. This is a deprecated mode of
 
1562
        operation and will be removed in the future.
 
1563
        :return: a dictionary of revision_id->revision_parents_list.
 
1564
        """
 
1565
        raise NotImplementedError(self.get_revision_graph)
 
1566
 
 
1567
    @needs_read_lock
 
1568
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1569
        """Return a graph of the revisions with ghosts marked as applicable.
 
1570
 
 
1571
        :param revision_ids: an iterable of revisions to graph or None for all.
 
1572
        :return: a Graph object with the graph reachable from revision_ids.
 
1573
        """
 
1574
        if 'evil' in debug.debug_flags:
 
1575
            mutter_callsite(3,
 
1576
                "get_revision_graph_with_ghosts scales with size of history.")
 
1577
        result = deprecated_graph.Graph()
 
1578
        if not revision_ids:
 
1579
            pending = set(self.all_revision_ids())
 
1580
            required = set([])
 
1581
        else:
 
1582
            pending = set(revision_ids)
 
1583
            # special case NULL_REVISION
 
1584
            if _mod_revision.NULL_REVISION in pending:
 
1585
                pending.remove(_mod_revision.NULL_REVISION)
 
1586
            required = set(pending)
 
1587
        done = set([])
 
1588
        while len(pending):
 
1589
            revision_id = pending.pop()
 
1590
            try:
 
1591
                rev = self.get_revision(revision_id)
 
1592
            except errors.NoSuchRevision:
 
1593
                if revision_id in required:
 
1594
                    raise
 
1595
                # a ghost
 
1596
                result.add_ghost(revision_id)
 
1597
                continue
 
1598
            for parent_id in rev.parent_ids:
 
1599
                # is this queued or done ?
 
1600
                if (parent_id not in pending and
 
1601
                    parent_id not in done):
 
1602
                    # no, queue it.
 
1603
                    pending.add(parent_id)
 
1604
            result.add_node(revision_id, rev.parent_ids)
 
1605
            done.add(revision_id)
 
1606
        return result
 
1607
 
 
1608
    def _get_history_vf(self):
 
1609
        """Get a versionedfile whose history graph reflects all revisions.
 
1610
 
 
1611
        For weave repositories, this is the inventory weave.
 
1612
        """
 
1613
        return self.get_inventory_weave()
 
1614
 
 
1615
    def iter_reverse_revision_history(self, revision_id):
 
1616
        """Iterate backwards through revision ids in the lefthand history
 
1617
 
 
1618
        :param revision_id: The revision id to start with.  All its lefthand
 
1619
            ancestors will be traversed.
 
1620
        """
 
1621
        if revision_id in (None, _mod_revision.NULL_REVISION):
 
1622
            return
 
1623
        next_id = revision_id
 
1624
        versionedfile = self._get_history_vf()
 
1625
        while True:
 
1626
            yield next_id
 
1627
            parents = versionedfile.get_parents(next_id)
 
1628
            if len(parents) == 0:
 
1629
                return
 
1630
            else:
 
1631
                next_id = parents[0]
 
1632
 
 
1633
    @needs_read_lock
 
1634
    def get_revision_inventory(self, revision_id):
 
1635
        """Return inventory of a past revision."""
 
1636
        # TODO: Unify this with get_inventory()
 
1637
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
1638
        # must be the same as its revision, so this is trivial.
 
1639
        if revision_id is None:
 
1640
            # This does not make sense: if there is no revision,
 
1641
            # then it is the current tree inventory surely ?!
 
1642
            # and thus get_root_id() is something that looks at the last
 
1643
            # commit on the branch, and the get_root_id is an inventory check.
 
1644
            raise NotImplementedError
 
1645
            # return Inventory(self.get_root_id())
 
1646
        else:
 
1647
            return self.get_inventory(revision_id)
 
1648
 
 
1649
    @needs_read_lock
984
1650
    def is_shared(self):
985
1651
        """Return True if this repository is flagged as a shared repository."""
986
1652
        raise NotImplementedError(self.is_shared)
1000
1666
        for repositories to maintain loaded indices across multiple locks
1001
1667
        by checking inside their implementation of this method to see
1002
1668
        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.
 
1669
        the disk format being validatable in this manner.
1008
1670
        """
1009
1671
 
1010
1672
    @needs_read_lock
1011
1673
    def revision_tree(self, revision_id):
1012
1674
        """Return Tree for a revision on this branch.
1013
1675
 
1014
 
        `revision_id` may be NULL_REVISION for the empty tree revision.
 
1676
        `revision_id` may be None for the empty tree revision.
1015
1677
        """
1016
 
        raise NotImplementedError(self.revision_tree)
 
1678
        # TODO: refactor this to use an existing revision object
 
1679
        # so we don't need to read it in twice.
 
1680
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1681
            return RevisionTree(self, Inventory(root_id=None), 
 
1682
                                _mod_revision.NULL_REVISION)
 
1683
        else:
 
1684
            inv = self.get_revision_inventory(revision_id)
 
1685
            return RevisionTree(self, inv, revision_id)
1017
1686
 
 
1687
    @needs_read_lock
1018
1688
    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:'
 
1689
        """Return Tree for a revision on this branch.
 
1690
 
 
1691
        `revision_id` may not be None or 'null:'"""
 
1692
        inventories = self.iter_inventories(revision_ids)
 
1693
        for inv in inventories:
 
1694
            yield RevisionTree(self, inv, inv.revision_id)
 
1695
 
 
1696
    @needs_read_lock
 
1697
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1698
        """Return a list of revision-ids integrated by a revision.
 
1699
 
 
1700
        The first element of the list is always None, indicating the origin 
 
1701
        revision.  This might change when we have history horizons, or 
 
1702
        perhaps we should have a new API.
 
1703
        
 
1704
        This is topologically sorted.
1023
1705
        """
1024
 
        raise NotImplementedError(self.revision_trees)
 
1706
        if _mod_revision.is_null(revision_id):
 
1707
            return [None]
 
1708
        if not self.has_revision(revision_id):
 
1709
            raise errors.NoSuchRevision(self, revision_id)
 
1710
        w = self.get_inventory_weave()
 
1711
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
1712
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
1025
1713
 
1026
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1714
    def pack(self):
1027
1715
        """Compress the data within the repository.
1028
1716
 
1029
1717
        This operation only makes sense for some repository types. For other
1030
1718
        types it should be a no-op that just returns.
1031
1719
 
1032
1720
        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
 
1721
        @needs_write_lock as this is a long running call its reasonable to 
1034
1722
        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
 
        """
 
1723
        """
 
1724
 
 
1725
    @needs_read_lock
 
1726
    def print_file(self, file, revision_id):
 
1727
        """Print `file` to stdout.
 
1728
        
 
1729
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
1730
        - it writes to stdout, it assumes that that is valid etc. Fix
 
1731
        by creating a new more flexible convenience function.
 
1732
        """
 
1733
        tree = self.revision_tree(revision_id)
 
1734
        # use inventory as it was in that revision
 
1735
        file_id = tree.inventory.path2id(file)
 
1736
        if not file_id:
 
1737
            # TODO: jam 20060427 Write a test for this code path
 
1738
            #       it had a bug in it, and was raising the wrong
 
1739
            #       exception.
 
1740
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
1741
        tree.print_file(file_id)
1046
1742
 
1047
1743
    def get_transaction(self):
1048
1744
        return self.control_files.get_transaction()
1049
1745
 
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:
 
1746
    def revision_parents(self, revision_id):
 
1747
        return self.get_inventory_weave().parent_names(revision_id)
 
1748
 
 
1749
    @deprecated_method(symbol_versioning.one_one)
 
1750
    def get_parents(self, revision_ids):
 
1751
        """See StackedParentsProvider.get_parents"""
 
1752
        parent_map = self.get_parent_map(revision_ids)
 
1753
        return [parent_map.get(r, None) for r in revision_ids]
 
1754
 
 
1755
    def get_parent_map(self, keys):
 
1756
        """See graph._StackedParentsProvider.get_parent_map"""
 
1757
        parent_map = {}
 
1758
        for revision_id in keys:
1061
1759
            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
 
1760
                parent_map[revision_id] = ()
 
1761
            else:
 
1762
                try:
 
1763
                    parent_id_list = self.get_revision(revision_id).parent_ids
 
1764
                except errors.NoSuchRevision:
 
1765
                    pass
 
1766
                else:
 
1767
                    if len(parent_id_list) == 0:
 
1768
                        parent_ids = (_mod_revision.NULL_REVISION,)
 
1769
                    else:
 
1770
                        parent_ids = tuple(parent_id_list)
 
1771
                    parent_map[revision_id] = parent_ids
 
1772
        return parent_map
1076
1773
 
1077
1774
    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)
 
1775
        return self
1097
1776
 
1098
1777
    def get_graph(self, other_repository=None):
1099
1778
        """Return the graph walker for this repository format"""
1100
1779
        parents_provider = self._make_parents_provider()
1101
1780
        if (other_repository is not None and
1102
 
            not self.has_same_location(other_repository)):
1103
 
            parents_provider = graph.StackedParentsProvider(
 
1781
            other_repository.bzrdir.transport.base !=
 
1782
            self.bzrdir.transport.base):
 
1783
            parents_provider = graph._StackedParentsProvider(
1104
1784
                [parents_provider, other_repository._make_parents_provider()])
1105
1785
        return graph.Graph(parents_provider)
1106
1786
 
 
1787
    def _get_versioned_file_checker(self):
 
1788
        """Return an object suitable for checking versioned files."""
 
1789
        return _VersionedFileChecker(self)
 
1790
 
 
1791
    def revision_ids_to_search_result(self, result_set):
 
1792
        """Convert a set of revision ids to a graph SearchResult."""
 
1793
        result_parents = set()
 
1794
        for parents in self.get_graph().get_parent_map(
 
1795
            result_set).itervalues():
 
1796
            result_parents.update(parents)
 
1797
        included_keys = result_set.intersection(result_parents)
 
1798
        start_keys = result_set.difference(included_keys)
 
1799
        exclude_keys = result_parents.difference(result_set)
 
1800
        result = graph.SearchResult(start_keys, exclude_keys,
 
1801
            len(result_set), result_set)
 
1802
        return result
 
1803
 
1107
1804
    @needs_write_lock
1108
1805
    def set_make_working_trees(self, new_value):
1109
1806
        """Set the policy flag for making working trees when creating branches.
1115
1812
                          working trees.
1116
1813
        """
1117
1814
        raise NotImplementedError(self.set_make_working_trees)
1118
 
 
 
1815
    
1119
1816
    def make_working_trees(self):
1120
1817
        """Returns the policy for making working trees on new branches."""
1121
1818
        raise NotImplementedError(self.make_working_trees)
1122
1819
 
1123
1820
    @needs_write_lock
1124
1821
    def sign_revision(self, revision_id, gpg_strategy):
1125
 
        testament = _mod_testament.Testament.from_revision(self, revision_id)
1126
 
        plaintext = testament.as_short_text()
 
1822
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
1127
1823
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1128
1824
 
1129
1825
    @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
1826
    def has_signature_for_revision_id(self, revision_id):
1160
1827
        """Query for a revision signature for revision_id in the repository."""
1161
 
        raise NotImplementedError(self.has_signature_for_revision_id)
 
1828
        return self._revision_store.has_signature(revision_id,
 
1829
                                                  self.get_transaction())
1162
1830
 
 
1831
    @needs_read_lock
1163
1832
    def get_signature_text(self, revision_id):
1164
1833
        """Return the text for a signature."""
1165
 
        raise NotImplementedError(self.get_signature_text)
 
1834
        return self._revision_store.get_signature_text(revision_id,
 
1835
                                                       self.get_transaction())
1166
1836
 
1167
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1837
    @needs_read_lock
 
1838
    def check(self, revision_ids=None):
1168
1839
        """Check consistency of all history of given revision_ids.
1169
1840
 
1170
1841
        Different repository implementations should override _check().
1171
1842
 
1172
1843
        :param revision_ids: A non-empty list of revision_ids whose ancestry
1173
1844
             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
1845
        """
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
 
1846
        return self._check(revision_ids)
 
1847
 
 
1848
    def _check(self, revision_ids):
 
1849
        result = check.Check(self)
 
1850
        result.check()
 
1851
        return result
 
1852
 
 
1853
    def _warn_if_deprecated(self):
1189
1854
        global _deprecation_warning_done
1190
1855
        if _deprecation_warning_done:
1191
1856
            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
 
1857
        _deprecation_warning_done = True
 
1858
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
1859
                % (self._format, self.bzrdir.transport.base))
1204
1860
 
1205
1861
    def supports_rich_root(self):
1206
1862
        return self._format.rich_root_data
1220
1876
                    revision_id.decode('ascii')
1221
1877
                except UnicodeDecodeError:
1222
1878
                    raise errors.NonAsciiRevisionId(method, self)
 
1879
    
 
1880
    def revision_graph_can_have_wrong_parents(self):
 
1881
        """Is it possible for this repository to have a revision graph with
 
1882
        incorrect parents?
 
1883
 
 
1884
        If True, then this repository must also implement
 
1885
        _find_inconsistent_revision_parents so that check and reconcile can
 
1886
        check for inconsistencies before proceeding with other checks that may
 
1887
        depend on the revision index being consistent.
 
1888
        """
 
1889
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
1890
 
 
1891
 
 
1892
# remove these delegates a while after bzr 0.15
 
1893
def __make_delegated(name, from_module):
 
1894
    def _deprecated_repository_forwarder():
 
1895
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
1896
            % (name, from_module),
 
1897
            DeprecationWarning,
 
1898
            stacklevel=2)
 
1899
        m = __import__(from_module, globals(), locals(), [name])
 
1900
        try:
 
1901
            return getattr(m, name)
 
1902
        except AttributeError:
 
1903
            raise AttributeError('module %s has no name %s'
 
1904
                    % (m, name))
 
1905
    globals()[name] = _deprecated_repository_forwarder
 
1906
 
 
1907
for _name in [
 
1908
        'AllInOneRepository',
 
1909
        'WeaveMetaDirRepository',
 
1910
        'PreSplitOutRepositoryFormat',
 
1911
        'RepositoryFormat4',
 
1912
        'RepositoryFormat5',
 
1913
        'RepositoryFormat6',
 
1914
        'RepositoryFormat7',
 
1915
        ]:
 
1916
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
1917
 
 
1918
for _name in [
 
1919
        'KnitRepository',
 
1920
        'RepositoryFormatKnit',
 
1921
        'RepositoryFormatKnit1',
 
1922
        ]:
 
1923
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
1924
 
 
1925
 
 
1926
def install_revision(repository, rev, revision_tree):
 
1927
    """Install all revision data into a repository."""
 
1928
    install_revisions(repository, [(rev, revision_tree, None)])
 
1929
 
 
1930
 
 
1931
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
1932
    """Install all revision data into a repository.
 
1933
 
 
1934
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
1935
    may be None.
 
1936
    """
 
1937
    repository.start_write_group()
 
1938
    try:
 
1939
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
1940
            _install_revision(repository, revision, revision_tree, signature)
 
1941
            if pb is not None:
 
1942
                pb.update('Transferring revisions', n + 1, num_revisions)
 
1943
    except:
 
1944
        repository.abort_write_group()
 
1945
        raise
 
1946
    else:
 
1947
        repository.commit_write_group()
 
1948
 
 
1949
 
 
1950
def _install_revision(repository, rev, revision_tree, signature):
 
1951
    """Install all revision data into a repository."""
 
1952
    present_parents = []
 
1953
    parent_trees = {}
 
1954
    for p_id in rev.parent_ids:
 
1955
        if repository.has_revision(p_id):
 
1956
            present_parents.append(p_id)
 
1957
            parent_trees[p_id] = repository.revision_tree(p_id)
 
1958
        else:
 
1959
            parent_trees[p_id] = repository.revision_tree(None)
 
1960
 
 
1961
    inv = revision_tree.inventory
 
1962
    entries = inv.iter_entries()
 
1963
    # backwards compatibility hack: skip the root id.
 
1964
    if not repository.supports_rich_root():
 
1965
        path, root = entries.next()
 
1966
        if root.revision != rev.revision_id:
 
1967
            raise errors.IncompatibleRevision(repr(repository))
 
1968
    # Add the texts that are not already present
 
1969
    for path, ie in entries:
 
1970
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
1971
                repository.get_transaction())
 
1972
        if ie.revision not in w:
 
1973
            text_parents = []
 
1974
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
1975
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
1976
            # is a latent bug here where the parents may have ancestors of each
 
1977
            # other. RBC, AB
 
1978
            for revision, tree in parent_trees.iteritems():
 
1979
                if ie.file_id not in tree:
 
1980
                    continue
 
1981
                parent_id = tree.inventory[ie.file_id].revision
 
1982
                if parent_id in text_parents:
 
1983
                    continue
 
1984
                text_parents.append(parent_id)
 
1985
                    
 
1986
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
1987
                repository.get_transaction())
 
1988
            lines = revision_tree.get_file(ie.file_id).readlines()
 
1989
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
1990
    try:
 
1991
        # install the inventory
 
1992
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
1993
    except errors.RevisionAlreadyPresent:
 
1994
        pass
 
1995
    if signature is not None:
 
1996
        repository.add_signature_text(rev.revision_id, signature)
 
1997
    repository.add_revision(rev.revision_id, rev, inv)
1223
1998
 
1224
1999
 
1225
2000
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
 
 
 
2001
    """Repositories in the new meta-dir layout."""
 
2002
 
 
2003
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
2004
        super(MetaDirRepository, self).__init__(_format,
 
2005
                                                a_bzrdir,
 
2006
                                                control_files,
 
2007
                                                _revision_store,
 
2008
                                                control_store,
 
2009
                                                text_store)
 
2010
        dir_mode = self.control_files._dir_mode
 
2011
        file_mode = self.control_files._file_mode
 
2012
 
 
2013
    @needs_read_lock
1236
2014
    def is_shared(self):
1237
2015
        """Return True if this repository is flagged as a shared repository."""
1238
 
        return self._transport.has('shared-storage')
 
2016
        return self.control_files._transport.has('shared-storage')
1239
2017
 
1240
2018
    @needs_write_lock
1241
2019
    def set_make_working_trees(self, new_value):
1249
2027
        """
1250
2028
        if new_value:
1251
2029
            try:
1252
 
                self._transport.delete('no-working-trees')
 
2030
                self.control_files._transport.delete('no-working-trees')
1253
2031
            except errors.NoSuchFile:
1254
2032
                pass
1255
2033
        else:
1256
 
            self._transport.put_bytes('no-working-trees', '',
1257
 
                mode=self.bzrdir._get_file_mode())
1258
 
 
 
2034
            self.control_files.put_utf8('no-working-trees', '')
 
2035
    
1259
2036
    def make_working_trees(self):
1260
2037
        """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.
 
2038
        return not self.control_files._transport.has('no-working-trees')
 
2039
 
 
2040
 
 
2041
class RepositoryFormatRegistry(registry.Registry):
 
2042
    """Registry of RepositoryFormats."""
 
2043
 
 
2044
    def get(self, format_string):
 
2045
        r = registry.Registry.get(self, format_string)
 
2046
        if callable(r):
 
2047
            r = r()
 
2048
        return r
 
2049
    
 
2050
 
 
2051
format_registry = RepositoryFormatRegistry()
 
2052
"""Registry of formats, indexed by their identifying format string.
1293
2053
 
1294
2054
This can contain either format instances themselves, or classes/factories that
1295
2055
can be called to obtain one.
1299
2059
#####################################################################
1300
2060
# Repository Formats
1301
2061
 
1302
 
class RepositoryFormat(controldir.ControlComponentFormat):
 
2062
class RepositoryFormat(object):
1303
2063
    """A repository format.
1304
2064
 
1305
 
    Formats provide four things:
 
2065
    Formats provide three things:
1306
2066
     * An initialization routine to construct repository data on disk.
1307
 
     * a optional format string which is used when the BzrDir supports
1308
 
       versioned children.
 
2067
     * a format string which is used when the BzrDir supports versioned
 
2068
       children.
1309
2069
     * an open routine which returns a Repository instance.
1310
 
     * A network name for referring to the format in smart server RPC
1311
 
       methods.
1312
2070
 
1313
2071
    There is one and only one Format subclass for each on-disk format. But
1314
2072
    there can be one Repository subclass that is used for several different
1315
2073
    formats. The _format attribute on a Repository instance can be used to
1316
2074
    determine the disk format.
1317
2075
 
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.
 
2076
    Formats are placed in an dict by their format string for reference 
 
2077
    during opening. These should be subclasses of RepositoryFormat
 
2078
    for consistency.
1321
2079
 
1322
2080
    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.
 
2081
    methods on the format class. Do not deprecate the object, as the 
 
2082
    object will be created every system load.
1326
2083
 
1327
2084
    Common instance attributes:
1328
 
    _matchingbzrdir - the controldir format that the repository format was
 
2085
    _matchingbzrdir - the bzrdir format that the repository format was
1329
2086
    originally written to work with. This can be used if manually
1330
2087
    constructing a bzrdir and repository, or more commonly for test suite
1331
2088
    parameterization.
1334
2091
    # Set to True or False in derived classes. True indicates that the format
1335
2092
    # supports ghosts gracefully.
1336
2093
    supports_ghosts = None
1337
 
    # Can this repository be given external locations to lookup additional
1338
 
    # data. Set to True or False in derived classes.
1339
 
    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
2094
 
1380
 
    def __repr__(self):
1381
 
        return "%s()" % self.__class__.__name__
 
2095
    def __str__(self):
 
2096
        return "<%s>" % self.__class__.__name__
1382
2097
 
1383
2098
    def __eq__(self, other):
1384
2099
        # format objects are generally stateless
1387
2102
    def __ne__(self, other):
1388
2103
        return not self == other
1389
2104
 
 
2105
    @classmethod
 
2106
    def find_format(klass, a_bzrdir):
 
2107
        """Return the format for the repository object in a_bzrdir.
 
2108
        
 
2109
        This is used by bzr native formats that have a "format" file in
 
2110
        the repository.  Other methods may be used by different types of 
 
2111
        control directory.
 
2112
        """
 
2113
        try:
 
2114
            transport = a_bzrdir.get_repository_transport(None)
 
2115
            format_string = transport.get("format").read()
 
2116
            return format_registry.get(format_string)
 
2117
        except errors.NoSuchFile:
 
2118
            raise errors.NoRepositoryPresent(a_bzrdir)
 
2119
        except KeyError:
 
2120
            raise errors.UnknownFormatError(format=format_string)
 
2121
 
 
2122
    @classmethod
 
2123
    def register_format(klass, format):
 
2124
        format_registry.register(format.get_format_string(), format)
 
2125
 
 
2126
    @classmethod
 
2127
    def unregister_format(klass, format):
 
2128
        format_registry.remove(format.get_format_string())
 
2129
    
 
2130
    @classmethod
 
2131
    def get_default_format(klass):
 
2132
        """Return the current default format."""
 
2133
        from bzrlib import bzrdir
 
2134
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
2135
 
 
2136
    def _get_control_store(self, repo_transport, control_files):
 
2137
        """Return the control store for this repository."""
 
2138
        raise NotImplementedError(self._get_control_store)
 
2139
 
 
2140
    def get_format_string(self):
 
2141
        """Return the ASCII format string that identifies this format.
 
2142
        
 
2143
        Note that in pre format ?? repositories the format string is 
 
2144
        not permitted nor written to disk.
 
2145
        """
 
2146
        raise NotImplementedError(self.get_format_string)
 
2147
 
1390
2148
    def get_format_description(self):
1391
2149
        """Return the short description for this format."""
1392
2150
        raise NotImplementedError(self.get_format_description)
1393
2151
 
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.
 
2152
    def _get_revision_store(self, repo_transport, control_files):
 
2153
        """Return the revision store object for this a_bzrdir."""
 
2154
        raise NotImplementedError(self._get_revision_store)
 
2155
 
 
2156
    def _get_text_rev_store(self,
 
2157
                            transport,
 
2158
                            control_files,
 
2159
                            name,
 
2160
                            compressed=True,
 
2161
                            prefixed=False,
 
2162
                            serializer=None):
 
2163
        """Common logic for getting a revision store for a repository.
 
2164
        
 
2165
        see self._get_revision_store for the subclass-overridable method to 
 
2166
        get the store for a repository.
 
2167
        """
 
2168
        from bzrlib.store.revision.text import TextRevisionStore
 
2169
        dir_mode = control_files._dir_mode
 
2170
        file_mode = control_files._file_mode
 
2171
        text_store = TextStore(transport.clone(name),
 
2172
                              prefixed=prefixed,
 
2173
                              compressed=compressed,
 
2174
                              dir_mode=dir_mode,
 
2175
                              file_mode=file_mode)
 
2176
        _revision_store = TextRevisionStore(text_store, serializer)
 
2177
        return _revision_store
 
2178
 
 
2179
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2180
    # use weaves or knits -- mbp 20070207
 
2181
    def _get_versioned_file_store(self,
 
2182
                                  name,
 
2183
                                  transport,
 
2184
                                  control_files,
 
2185
                                  prefixed=True,
 
2186
                                  versionedfile_class=None,
 
2187
                                  versionedfile_kwargs={},
 
2188
                                  escaped=False):
 
2189
        if versionedfile_class is None:
 
2190
            versionedfile_class = self._versionedfile_class
 
2191
        weave_transport = control_files._transport.clone(name)
 
2192
        dir_mode = control_files._dir_mode
 
2193
        file_mode = control_files._file_mode
 
2194
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
2195
                                  dir_mode=dir_mode,
 
2196
                                  file_mode=file_mode,
 
2197
                                  versionedfile_class=versionedfile_class,
 
2198
                                  versionedfile_kwargs=versionedfile_kwargs,
 
2199
                                  escaped=escaped)
 
2200
 
 
2201
    def initialize(self, a_bzrdir, shared=False):
 
2202
        """Initialize a repository of this format in a_bzrdir.
 
2203
 
 
2204
        :param a_bzrdir: The bzrdir to put the new repository in it.
1398
2205
        :param shared: The repository should be initialized as a sharable one.
1399
2206
        :returns: The new repository object.
1400
 
 
 
2207
        
1401
2208
        This may raise UninitializableFormat if shared repository are not
1402
 
        compatible the controldir.
 
2209
        compatible the a_bzrdir.
1403
2210
        """
1404
2211
        raise NotImplementedError(self.initialize)
1405
2212
 
1407
2214
        """Is this format supported?
1408
2215
 
1409
2216
        Supported formats must be initializable and openable.
1410
 
        Unsupported formats may not support initialization or committing or
 
2217
        Unsupported formats may not support initialization or committing or 
1411
2218
        some other features depending on the reason for not being supported.
1412
2219
        """
1413
2220
        return True
1414
2221
 
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
2222
    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
 
 
 
2223
        raise NotImplementedError(self.check_conversion_target)
 
2224
 
 
2225
    def open(self, a_bzrdir, _found=False):
 
2226
        """Return an instance of this format for the bzrdir a_bzrdir.
 
2227
        
1447
2228
        _found is a private parameter, do not use it.
1448
2229
        """
1449
2230
        raise NotImplementedError(self.open)
1450
2231
 
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):
 
2232
 
 
2233
class MetaDirRepositoryFormat(RepositoryFormat):
1462
2234
    """Common base class for the new repositories using the metadir layout."""
1463
2235
 
1464
2236
    rich_root_data = False
1465
2237
    supports_tree_reference = False
1466
 
    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
 
2238
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1475
2239
 
1476
2240
    def __init__(self):
1477
 
        RepositoryFormat.__init__(self)
1478
 
        bzrdir.BzrFormat.__init__(self)
 
2241
        super(MetaDirRepositoryFormat, self).__init__()
1479
2242
 
1480
2243
    def _create_control_files(self, a_bzrdir):
1481
2244
        """Create the required files and the initial control_files object."""
1491
2254
        """Upload the initial blank content."""
1492
2255
        control_files = self._create_control_files(a_bzrdir)
1493
2256
        control_files.lock_write()
1494
 
        transport = control_files._transport
1495
 
        if shared == True:
1496
 
            utf8_files += [('shared-storage', '')]
1497
2257
        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())
 
2258
            control_files._transport.mkdir_multi(dirs,
 
2259
                    mode=control_files._dir_mode)
 
2260
            for file, content in files:
 
2261
                control_files.put(file, content)
 
2262
            for file, content in utf8_files:
 
2263
                control_files.put_utf8(file, content)
 
2264
            if shared == True:
 
2265
                control_files.put_utf8('shared-storage', '')
1505
2266
        finally:
1506
2267
            control_files.unlock()
1507
2268
 
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
 
2269
 
 
2270
# formats which have no format string are not discoverable
 
2271
# and not independently creatable, so are not registered.  They're 
 
2272
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
2273
# needed, it's constructed directly by the BzrDir.  Non-native formats where
1536
2274
# the repository is not separately opened are similar.
1537
2275
 
1538
2276
format_registry.register_lazy(
 
2277
    'Bazaar-NG Repository format 7',
 
2278
    'bzrlib.repofmt.weaverepo',
 
2279
    'RepositoryFormat7'
 
2280
    )
 
2281
 
 
2282
format_registry.register_lazy(
1539
2283
    'Bazaar-NG Knit Repository Format 1',
1540
2284
    'bzrlib.repofmt.knitrepo',
1541
2285
    'RepositoryFormatKnit1',
1555
2299
 
1556
2300
# Pack-based formats. There is one format for pre-subtrees, and one for
1557
2301
# post-subtrees to allow ease of testing.
1558
 
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
2302
# NOTE: These are experimental in 0.92.
1559
2303
format_registry.register_lazy(
1560
2304
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
1561
 
    'bzrlib.repofmt.knitpack_repo',
 
2305
    'bzrlib.repofmt.pack_repo',
1562
2306
    'RepositoryFormatKnitPack1',
1563
2307
    )
1564
2308
format_registry.register_lazy(
1565
2309
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
1566
 
    'bzrlib.repofmt.knitpack_repo',
 
2310
    'bzrlib.repofmt.pack_repo',
1567
2311
    'RepositoryFormatKnitPack3',
1568
2312
    )
1569
2313
format_registry.register_lazy(
1570
2314
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
1571
 
    'bzrlib.repofmt.knitpack_repo',
 
2315
    'bzrlib.repofmt.pack_repo',
1572
2316
    'RepositoryFormatKnitPack4',
1573
2317
    )
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
 
    )
1618
2318
 
1619
2319
 
1620
2320
class InterRepository(InterObject):
1621
2321
    """This class represents operations taking place between two repositories.
1622
2322
 
1623
2323
    Its instances have methods like copy_content and fetch, and contain
1624
 
    references to the source and target repositories these operations can be
 
2324
    references to the source and target repositories these operations can be 
1625
2325
    carried out on.
1626
2326
 
1627
2327
    Often we will provide convenience methods on 'repository' which carry out
1632
2332
    _optimisers = []
1633
2333
    """The available optimised InterRepository types."""
1634
2334
 
1635
 
    @needs_write_lock
1636
2335
    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):
 
2336
        raise NotImplementedError(self.copy_content)
 
2337
 
 
2338
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1653
2339
        """Fetch the content required to construct revision_id.
1654
2340
 
1655
2341
        The content is copied from self.source to self.target.
1656
2342
 
1657
2343
        :param revision_id: if None all content is copied, if NULL_REVISION no
1658
2344
                            content is copied.
1659
 
        :return: None.
 
2345
        :param pb: optional progress bar to use for progress reports. If not
 
2346
                   provided a default one will be created.
 
2347
 
 
2348
        Returns the copied revision count and the failed revisions in a tuple:
 
2349
        (copied, failures).
1660
2350
        """
1661
2351
        raise NotImplementedError(self.fetch)
1662
2352
 
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
 
2353
    def _walk_to_common_revisions(self, revision_ids):
 
2354
        """Walk out from revision_ids in source to revisions target has.
 
2355
 
 
2356
        :param revision_ids: The start point for the search.
 
2357
        :return: A set of revision ids.
 
2358
        """
 
2359
        graph = self.source.get_graph()
 
2360
        missing_revs = set()
 
2361
        # ensure we don't pay silly lookup costs.
 
2362
        revision_ids = frozenset(revision_ids)
 
2363
        searcher = graph._make_breadth_first_searcher(revision_ids)
 
2364
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
2365
        while True:
 
2366
            try:
 
2367
                next_revs, ghosts = searcher.next_with_ghosts()
 
2368
            except StopIteration:
 
2369
                break
 
2370
            if revision_ids.intersection(ghosts):
 
2371
                absent_ids = set(revision_ids.intersection(ghosts))
 
2372
                # If all absent_ids are present in target, no error is needed.
 
2373
                absent_ids.difference_update(
 
2374
                    self.target.has_revisions(absent_ids))
 
2375
                if absent_ids:
 
2376
                    raise errors.NoSuchRevision(self.source, absent_ids.pop())
 
2377
            # we don't care about other ghosts as we can't fetch them and
 
2378
            # haven't been asked to.
 
2379
            next_revs = set(next_revs)
 
2380
            # we always have NULL_REVISION present.
 
2381
            have_revs = self.target.has_revisions(next_revs).union(null_set)
 
2382
            missing_revs.update(next_revs - have_revs)
 
2383
            searcher.stop_searching_any(have_revs)
 
2384
        return searcher.get_result()
 
2385
   
 
2386
    @deprecated_method(symbol_versioning.one_two)
 
2387
    @needs_read_lock
 
2388
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2389
        """Return the revision ids that source has that target does not.
 
2390
        
 
2391
        These are returned in topological order.
 
2392
 
 
2393
        :param revision_id: only return revision ids included by this
 
2394
                            revision_id.
 
2395
        :param find_ghosts: If True find missing revisions in deep history
 
2396
            rather than just finding the surface difference.
 
2397
        """
 
2398
        return list(self.search_missing_revision_ids(
 
2399
            revision_id, find_ghosts).get_keys())
 
2400
 
 
2401
    @needs_read_lock
 
2402
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2403
        """Return the revision ids that source has that target does not.
 
2404
        
 
2405
        :param revision_id: only return revision ids included by this
 
2406
                            revision_id.
 
2407
        :param find_ghosts: If True find missing revisions in deep history
 
2408
            rather than just finding the surface difference.
1683
2409
        :return: A bzrlib.graph.SearchResult.
1684
2410
        """
1685
 
        raise NotImplementedError(self.search_missing_revision_ids)
 
2411
        # stop searching at found target revisions.
 
2412
        if not find_ghosts and revision_id is not None:
 
2413
            return self._walk_to_common_revisions([revision_id])
 
2414
        # generic, possibly worst case, slow code path.
 
2415
        target_ids = set(self.target.all_revision_ids())
 
2416
        if revision_id is not None:
 
2417
            source_ids = self.source.get_ancestry(revision_id)
 
2418
            assert source_ids[0] is None
 
2419
            source_ids.pop(0)
 
2420
        else:
 
2421
            source_ids = self.source.all_revision_ids()
 
2422
        result_set = set(source_ids).difference(target_ids)
 
2423
        return self.source.revision_ids_to_search_result(result_set)
1686
2424
 
1687
2425
    @staticmethod
1688
2426
    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:
 
2427
        """True if source and target have the same data representation."""
 
2428
        if source.supports_rich_root() != target.supports_rich_root():
1698
2429
            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
2430
        if source._serializer != target._serializer:
1708
 
            raise errors.IncompatibleRepositories(source, target,
1709
 
                "different serializers")
 
2431
            return False
 
2432
        return True
 
2433
 
 
2434
 
 
2435
class InterSameDataRepository(InterRepository):
 
2436
    """Code for converting between repositories that represent the same data.
 
2437
    
 
2438
    Data format and model must match for this to work.
 
2439
    """
 
2440
 
 
2441
    @classmethod
 
2442
    def _get_repo_format_to_test(self):
 
2443
        """Repository format for testing with.
 
2444
        
 
2445
        InterSameData can pull from subtree to subtree and from non-subtree to
 
2446
        non-subtree, so we test this with the richest repository format.
 
2447
        """
 
2448
        from bzrlib.repofmt import knitrepo
 
2449
        return knitrepo.RepositoryFormatKnit3()
 
2450
 
 
2451
    @staticmethod
 
2452
    def is_compatible(source, target):
 
2453
        return InterRepository._same_model(source, target)
 
2454
 
 
2455
    @needs_write_lock
 
2456
    def copy_content(self, revision_id=None):
 
2457
        """Make a complete copy of the content in self into destination.
 
2458
 
 
2459
        This copies both the repository's revision data, and configuration information
 
2460
        such as the make_working_trees setting.
 
2461
        
 
2462
        This is a destructive operation! Do not use it on existing 
 
2463
        repositories.
 
2464
 
 
2465
        :param revision_id: Only copy the content needed to construct
 
2466
                            revision_id and its parents.
 
2467
        """
 
2468
        try:
 
2469
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2470
        except NotImplementedError:
 
2471
            pass
 
2472
        # but don't bother fetching if we have the needed data now.
 
2473
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2474
            self.target.has_revision(revision_id)):
 
2475
            return
 
2476
        self.target.fetch(self.source, revision_id=revision_id)
 
2477
 
 
2478
    @needs_write_lock
 
2479
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2480
        """See InterRepository.fetch()."""
 
2481
        from bzrlib.fetch import GenericRepoFetcher
 
2482
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2483
               self.source, self.source._format, self.target,
 
2484
               self.target._format)
 
2485
        f = GenericRepoFetcher(to_repository=self.target,
 
2486
                               from_repository=self.source,
 
2487
                               last_revision=revision_id,
 
2488
                               pb=pb, find_ghosts=find_ghosts)
 
2489
        return f.count_copied, f.failed_revisions
 
2490
 
 
2491
 
 
2492
class InterWeaveRepo(InterSameDataRepository):
 
2493
    """Optimised code paths between Weave based repositories.
 
2494
    
 
2495
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
2496
    implemented lazy inter-object optimisation.
 
2497
    """
 
2498
 
 
2499
    @classmethod
 
2500
    def _get_repo_format_to_test(self):
 
2501
        from bzrlib.repofmt import weaverepo
 
2502
        return weaverepo.RepositoryFormat7()
 
2503
 
 
2504
    @staticmethod
 
2505
    def is_compatible(source, target):
 
2506
        """Be compatible with known Weave formats.
 
2507
        
 
2508
        We don't test for the stores being of specific types because that
 
2509
        could lead to confusing results, and there is no need to be 
 
2510
        overly general.
 
2511
        """
 
2512
        from bzrlib.repofmt.weaverepo import (
 
2513
                RepositoryFormat5,
 
2514
                RepositoryFormat6,
 
2515
                RepositoryFormat7,
 
2516
                )
 
2517
        try:
 
2518
            return (isinstance(source._format, (RepositoryFormat5,
 
2519
                                                RepositoryFormat6,
 
2520
                                                RepositoryFormat7)) and
 
2521
                    isinstance(target._format, (RepositoryFormat5,
 
2522
                                                RepositoryFormat6,
 
2523
                                                RepositoryFormat7)))
 
2524
        except AttributeError:
 
2525
            return False
 
2526
    
 
2527
    @needs_write_lock
 
2528
    def copy_content(self, revision_id=None):
 
2529
        """See InterRepository.copy_content()."""
 
2530
        # weave specific optimised path:
 
2531
        try:
 
2532
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2533
        except NotImplementedError:
 
2534
            pass
 
2535
        # FIXME do not peek!
 
2536
        if self.source.control_files._transport.listable():
 
2537
            pb = ui.ui_factory.nested_progress_bar()
 
2538
            try:
 
2539
                self.target.weave_store.copy_all_ids(
 
2540
                    self.source.weave_store,
 
2541
                    pb=pb,
 
2542
                    from_transaction=self.source.get_transaction(),
 
2543
                    to_transaction=self.target.get_transaction())
 
2544
                pb.update('copying inventory', 0, 1)
 
2545
                self.target.control_weaves.copy_multi(
 
2546
                    self.source.control_weaves, ['inventory'],
 
2547
                    from_transaction=self.source.get_transaction(),
 
2548
                    to_transaction=self.target.get_transaction())
 
2549
                self.target._revision_store.text_store.copy_all_ids(
 
2550
                    self.source._revision_store.text_store,
 
2551
                    pb=pb)
 
2552
            finally:
 
2553
                pb.finished()
 
2554
        else:
 
2555
            self.target.fetch(self.source, revision_id=revision_id)
 
2556
 
 
2557
    @needs_write_lock
 
2558
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2559
        """See InterRepository.fetch()."""
 
2560
        from bzrlib.fetch import GenericRepoFetcher
 
2561
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2562
               self.source, self.source._format, self.target, self.target._format)
 
2563
        f = GenericRepoFetcher(to_repository=self.target,
 
2564
                               from_repository=self.source,
 
2565
                               last_revision=revision_id,
 
2566
                               pb=pb, find_ghosts=find_ghosts)
 
2567
        return f.count_copied, f.failed_revisions
 
2568
 
 
2569
    @needs_read_lock
 
2570
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2571
        """See InterRepository.missing_revision_ids()."""
 
2572
        # we want all revisions to satisfy revision_id in source.
 
2573
        # but we don't want to stat every file here and there.
 
2574
        # we want then, all revisions other needs to satisfy revision_id 
 
2575
        # checked, but not those that we have locally.
 
2576
        # so the first thing is to get a subset of the revisions to 
 
2577
        # satisfy revision_id in source, and then eliminate those that
 
2578
        # we do already have. 
 
2579
        # this is slow on high latency connection to self, but as as this
 
2580
        # disk format scales terribly for push anyway due to rewriting 
 
2581
        # inventory.weave, this is considered acceptable.
 
2582
        # - RBC 20060209
 
2583
        if revision_id is not None:
 
2584
            source_ids = self.source.get_ancestry(revision_id)
 
2585
            assert source_ids[0] is None
 
2586
            source_ids.pop(0)
 
2587
        else:
 
2588
            source_ids = self.source._all_possible_ids()
 
2589
        source_ids_set = set(source_ids)
 
2590
        # source_ids is the worst possible case we may need to pull.
 
2591
        # now we want to filter source_ids against what we actually
 
2592
        # have in target, but don't try to check for existence where we know
 
2593
        # we do not have a revision as that would be pointless.
 
2594
        target_ids = set(self.target._all_possible_ids())
 
2595
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
2596
        actually_present_revisions = set(
 
2597
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2598
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2599
        if revision_id is not None:
 
2600
            # we used get_ancestry to determine source_ids then we are assured all
 
2601
            # revisions referenced are present as they are installed in topological order.
 
2602
            # and the tip revision was validated by get_ancestry.
 
2603
            result_set = required_revisions
 
2604
        else:
 
2605
            # if we just grabbed the possibly available ids, then 
 
2606
            # we only have an estimate of whats available and need to validate
 
2607
            # that against the revision records.
 
2608
            result_set = set(
 
2609
                self.source._eliminate_revisions_not_present(required_revisions))
 
2610
        return self.source.revision_ids_to_search_result(result_set)
 
2611
 
 
2612
 
 
2613
class InterKnitRepo(InterSameDataRepository):
 
2614
    """Optimised code paths between Knit based repositories."""
 
2615
 
 
2616
    @classmethod
 
2617
    def _get_repo_format_to_test(self):
 
2618
        from bzrlib.repofmt import knitrepo
 
2619
        return knitrepo.RepositoryFormatKnit1()
 
2620
 
 
2621
    @staticmethod
 
2622
    def is_compatible(source, target):
 
2623
        """Be compatible with known Knit formats.
 
2624
        
 
2625
        We don't test for the stores being of specific types because that
 
2626
        could lead to confusing results, and there is no need to be 
 
2627
        overly general.
 
2628
        """
 
2629
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
2630
        try:
 
2631
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
2632
                isinstance(target._format, RepositoryFormatKnit))
 
2633
        except AttributeError:
 
2634
            return False
 
2635
        return are_knits and InterRepository._same_model(source, target)
 
2636
 
 
2637
    @needs_write_lock
 
2638
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2639
        """See InterRepository.fetch()."""
 
2640
        from bzrlib.fetch import KnitRepoFetcher
 
2641
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2642
               self.source, self.source._format, self.target, self.target._format)
 
2643
        f = KnitRepoFetcher(to_repository=self.target,
 
2644
                            from_repository=self.source,
 
2645
                            last_revision=revision_id,
 
2646
                            pb=pb, find_ghosts=find_ghosts)
 
2647
        return f.count_copied, f.failed_revisions
 
2648
 
 
2649
    @needs_read_lock
 
2650
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2651
        """See InterRepository.missing_revision_ids()."""
 
2652
        if revision_id is not None:
 
2653
            source_ids = self.source.get_ancestry(revision_id)
 
2654
            assert source_ids[0] is None
 
2655
            source_ids.pop(0)
 
2656
        else:
 
2657
            source_ids = self.source.all_revision_ids()
 
2658
        source_ids_set = set(source_ids)
 
2659
        # source_ids is the worst possible case we may need to pull.
 
2660
        # now we want to filter source_ids against what we actually
 
2661
        # have in target, but don't try to check for existence where we know
 
2662
        # we do not have a revision as that would be pointless.
 
2663
        target_ids = set(self.target.all_revision_ids())
 
2664
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
2665
        actually_present_revisions = set(
 
2666
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2667
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
2668
        if revision_id is not None:
 
2669
            # we used get_ancestry to determine source_ids then we are assured all
 
2670
            # revisions referenced are present as they are installed in topological order.
 
2671
            # and the tip revision was validated by get_ancestry.
 
2672
            result_set = required_revisions
 
2673
        else:
 
2674
            # if we just grabbed the possibly available ids, then 
 
2675
            # we only have an estimate of whats available and need to validate
 
2676
            # that against the revision records.
 
2677
            result_set = set(
 
2678
                self.source._eliminate_revisions_not_present(required_revisions))
 
2679
        return self.source.revision_ids_to_search_result(result_set)
 
2680
 
 
2681
 
 
2682
class InterPackRepo(InterSameDataRepository):
 
2683
    """Optimised code paths between Pack based repositories."""
 
2684
 
 
2685
    @classmethod
 
2686
    def _get_repo_format_to_test(self):
 
2687
        from bzrlib.repofmt import pack_repo
 
2688
        return pack_repo.RepositoryFormatKnitPack1()
 
2689
 
 
2690
    @staticmethod
 
2691
    def is_compatible(source, target):
 
2692
        """Be compatible with known Pack formats.
 
2693
        
 
2694
        We don't test for the stores being of specific types because that
 
2695
        could lead to confusing results, and there is no need to be 
 
2696
        overly general.
 
2697
        """
 
2698
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2699
        try:
 
2700
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2701
                isinstance(target._format, RepositoryFormatPack))
 
2702
        except AttributeError:
 
2703
            return False
 
2704
        return are_packs and InterRepository._same_model(source, target)
 
2705
 
 
2706
    @needs_write_lock
 
2707
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2708
        """See InterRepository.fetch()."""
 
2709
        from bzrlib.repofmt.pack_repo import Packer
 
2710
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2711
               self.source, self.source._format, self.target, self.target._format)
 
2712
        self.count_copied = 0
 
2713
        if revision_id is None:
 
2714
            # TODO:
 
2715
            # everything to do - use pack logic
 
2716
            # to fetch from all packs to one without
 
2717
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2718
            # till then:
 
2719
            revision_ids = self.source.all_revision_ids()
 
2720
            # implementing the TODO will involve:
 
2721
            # - detecting when all of a pack is selected
 
2722
            # - avoiding as much as possible pre-selection, so the
 
2723
            # more-core routines such as create_pack_from_packs can filter in
 
2724
            # a just-in-time fashion. (though having a HEADS list on a
 
2725
            # repository might make this a lot easier, because we could
 
2726
            # sensibly detect 'new revisions' without doing a full index scan.
 
2727
        elif _mod_revision.is_null(revision_id):
 
2728
            # nothing to do:
 
2729
            return (0, [])
 
2730
        else:
 
2731
            try:
 
2732
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2733
                    find_ghosts=find_ghosts).get_keys()
 
2734
            except errors.NoSuchRevision:
 
2735
                raise errors.InstallFailed([revision_id])
 
2736
        packs = self.source._pack_collection.all_packs()
 
2737
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
2738
            revision_ids).pack()
 
2739
        if pack is not None:
 
2740
            self.target._pack_collection._save_pack_names()
 
2741
            # Trigger an autopack. This may duplicate effort as we've just done
 
2742
            # a pack creation, but for now it is simpler to think about as
 
2743
            # 'upload data, then repack if needed'.
 
2744
            self.target._pack_collection.autopack()
 
2745
            return (pack.get_revision_count(), [])
 
2746
        else:
 
2747
            return (0, [])
 
2748
 
 
2749
    @needs_read_lock
 
2750
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2751
        """See InterRepository.missing_revision_ids().
 
2752
        
 
2753
        :param find_ghosts: Find ghosts throughout the ancestry of
 
2754
            revision_id.
 
2755
        """
 
2756
        if not find_ghosts and revision_id is not None:
 
2757
            return self._walk_to_common_revisions([revision_id])
 
2758
        elif revision_id is not None:
 
2759
            source_ids = self.source.get_ancestry(revision_id)
 
2760
            assert source_ids[0] is None
 
2761
            source_ids.pop(0)
 
2762
        else:
 
2763
            source_ids = self.source.all_revision_ids()
 
2764
        # source_ids is the worst possible case we may need to pull.
 
2765
        # now we want to filter source_ids against what we actually
 
2766
        # have in target, but don't try to check for existence where we know
 
2767
        # we do not have a revision as that would be pointless.
 
2768
        target_ids = set(self.target.all_revision_ids())
 
2769
        result_set = set(source_ids).difference(target_ids)
 
2770
        return self.source.revision_ids_to_search_result(result_set)
 
2771
 
 
2772
 
 
2773
class InterModel1and2(InterRepository):
 
2774
 
 
2775
    @classmethod
 
2776
    def _get_repo_format_to_test(self):
 
2777
        return None
 
2778
 
 
2779
    @staticmethod
 
2780
    def is_compatible(source, target):
 
2781
        if not source.supports_rich_root() and target.supports_rich_root():
 
2782
            return True
 
2783
        else:
 
2784
            return False
 
2785
 
 
2786
    @needs_write_lock
 
2787
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2788
        """See InterRepository.fetch()."""
 
2789
        from bzrlib.fetch import Model1toKnit2Fetcher
 
2790
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
2791
                                 from_repository=self.source,
 
2792
                                 last_revision=revision_id,
 
2793
                                 pb=pb, find_ghosts=find_ghosts)
 
2794
        return f.count_copied, f.failed_revisions
 
2795
 
 
2796
    @needs_write_lock
 
2797
    def copy_content(self, revision_id=None):
 
2798
        """Make a complete copy of the content in self into destination.
 
2799
        
 
2800
        This is a destructive operation! Do not use it on existing 
 
2801
        repositories.
 
2802
 
 
2803
        :param revision_id: Only copy the content needed to construct
 
2804
                            revision_id and its parents.
 
2805
        """
 
2806
        try:
 
2807
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2808
        except NotImplementedError:
 
2809
            pass
 
2810
        # but don't bother fetching if we have the needed data now.
 
2811
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
2812
            self.target.has_revision(revision_id)):
 
2813
            return
 
2814
        self.target.fetch(self.source, revision_id=revision_id)
 
2815
 
 
2816
 
 
2817
class InterKnit1and2(InterKnitRepo):
 
2818
 
 
2819
    @classmethod
 
2820
    def _get_repo_format_to_test(self):
 
2821
        return None
 
2822
 
 
2823
    @staticmethod
 
2824
    def is_compatible(source, target):
 
2825
        """Be compatible with Knit1 source and Knit3 target"""
 
2826
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
2827
        try:
 
2828
            from bzrlib.repofmt.knitrepo import (RepositoryFormatKnit1,
 
2829
                RepositoryFormatKnit3)
 
2830
            from bzrlib.repofmt.pack_repo import (RepositoryFormatKnitPack1,
 
2831
                RepositoryFormatKnitPack3)
 
2832
            return (isinstance(source._format,
 
2833
                    (RepositoryFormatKnit1, RepositoryFormatKnitPack1)) and
 
2834
                isinstance(target._format,
 
2835
                    (RepositoryFormatKnit3, RepositoryFormatKnitPack3))
 
2836
                )
 
2837
        except AttributeError:
 
2838
            return False
 
2839
 
 
2840
    @needs_write_lock
 
2841
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2842
        """See InterRepository.fetch()."""
 
2843
        from bzrlib.fetch import Knit1to2Fetcher
 
2844
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2845
               self.source, self.source._format, self.target, 
 
2846
               self.target._format)
 
2847
        f = Knit1to2Fetcher(to_repository=self.target,
 
2848
                            from_repository=self.source,
 
2849
                            last_revision=revision_id,
 
2850
                            pb=pb, find_ghosts=find_ghosts)
 
2851
        return f.count_copied, f.failed_revisions
 
2852
 
 
2853
 
 
2854
class InterDifferingSerializer(InterKnitRepo):
 
2855
 
 
2856
    @classmethod
 
2857
    def _get_repo_format_to_test(self):
 
2858
        return None
 
2859
 
 
2860
    @staticmethod
 
2861
    def is_compatible(source, target):
 
2862
        """Be compatible with Knit2 source and Knit3 target"""
 
2863
        if source.supports_rich_root() != target.supports_rich_root():
 
2864
            return False
 
2865
        # Ideally, we'd support fetching if the source had no tree references
 
2866
        # even if it supported them...
 
2867
        if (getattr(source, '_format.supports_tree_reference', False) and
 
2868
            not getattr(target, '_format.supports_tree_reference', False)):
 
2869
            return False
 
2870
        return True
 
2871
 
 
2872
    @needs_write_lock
 
2873
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2874
        """See InterRepository.fetch()."""
 
2875
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
2876
            revision_id, find_ghosts=find_ghosts).get_keys()
 
2877
        revision_ids = tsort.topo_sort(
 
2878
            self.source.get_graph().get_parent_map(revision_ids))
 
2879
        def revisions_iterator():
 
2880
            for current_revision_id in revision_ids:
 
2881
                revision = self.source.get_revision(current_revision_id)
 
2882
                tree = self.source.revision_tree(current_revision_id)
 
2883
                try:
 
2884
                    signature = self.source.get_signature_text(
 
2885
                        current_revision_id)
 
2886
                except errors.NoSuchRevision:
 
2887
                    signature = None
 
2888
                yield revision, tree, signature
 
2889
        if pb is None:
 
2890
            my_pb = ui.ui_factory.nested_progress_bar()
 
2891
            pb = my_pb
 
2892
        else:
 
2893
            my_pb = None
 
2894
        try:
 
2895
            install_revisions(self.target, revisions_iterator(),
 
2896
                              len(revision_ids), pb)
 
2897
        finally:
 
2898
            if my_pb is not None:
 
2899
                my_pb.finished()
 
2900
        return len(revision_ids), 0
 
2901
 
 
2902
 
 
2903
class InterRemoteToOther(InterRepository):
 
2904
 
 
2905
    def __init__(self, source, target):
 
2906
        InterRepository.__init__(self, source, target)
 
2907
        self._real_inter = None
 
2908
 
 
2909
    @staticmethod
 
2910
    def is_compatible(source, target):
 
2911
        if not isinstance(source, remote.RemoteRepository):
 
2912
            return False
 
2913
        # Is source's model compatible with target's model?
 
2914
        source._ensure_real()
 
2915
        real_source = source._real_repository
 
2916
        assert not isinstance(real_source, remote.RemoteRepository), (
 
2917
            "We don't support remote repos backed by remote repos yet.")
 
2918
        return InterRepository._same_model(real_source, target)
 
2919
 
 
2920
    @needs_write_lock
 
2921
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2922
        """See InterRepository.fetch()."""
 
2923
        from bzrlib.fetch import RemoteToOtherFetcher
 
2924
        mutter("Using fetch logic to copy between %s(remote) and %s(%s)",
 
2925
               self.source, self.target, self.target._format)
 
2926
        # TODO: jam 20070210 This should be an assert, not a translate
 
2927
        revision_id = osutils.safe_revision_id(revision_id)
 
2928
        f = RemoteToOtherFetcher(to_repository=self.target,
 
2929
                                 from_repository=self.source,
 
2930
                                 last_revision=revision_id,
 
2931
                                 pb=pb, find_ghosts=find_ghosts)
 
2932
        return f.count_copied, f.failed_revisions
 
2933
 
 
2934
    @classmethod
 
2935
    def _get_repo_format_to_test(self):
 
2936
        return None
 
2937
 
 
2938
 
 
2939
class InterOtherToRemote(InterRepository):
 
2940
 
 
2941
    def __init__(self, source, target):
 
2942
        InterRepository.__init__(self, source, target)
 
2943
        self._real_inter = None
 
2944
 
 
2945
    @staticmethod
 
2946
    def is_compatible(source, target):
 
2947
        if isinstance(target, remote.RemoteRepository):
 
2948
            return True
 
2949
        return False
 
2950
 
 
2951
    def _ensure_real_inter(self):
 
2952
        if self._real_inter is None:
 
2953
            self.target._ensure_real()
 
2954
            real_target = self.target._real_repository
 
2955
            self._real_inter = InterRepository.get(self.source, real_target)
 
2956
    
 
2957
    def copy_content(self, revision_id=None):
 
2958
        self._ensure_real_inter()
 
2959
        self._real_inter.copy_content(revision_id=revision_id)
 
2960
 
 
2961
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2962
        self._ensure_real_inter()
 
2963
        self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
2964
            find_ghosts=find_ghosts)
 
2965
 
 
2966
    @classmethod
 
2967
    def _get_repo_format_to_test(self):
 
2968
        return None
 
2969
 
 
2970
 
 
2971
InterRepository.register_optimiser(InterDifferingSerializer)
 
2972
InterRepository.register_optimiser(InterSameDataRepository)
 
2973
InterRepository.register_optimiser(InterWeaveRepo)
 
2974
InterRepository.register_optimiser(InterKnitRepo)
 
2975
InterRepository.register_optimiser(InterModel1and2)
 
2976
InterRepository.register_optimiser(InterKnit1and2)
 
2977
InterRepository.register_optimiser(InterPackRepo)
 
2978
InterRepository.register_optimiser(InterRemoteToOther)
 
2979
InterRepository.register_optimiser(InterOtherToRemote)
1710
2980
 
1711
2981
 
1712
2982
class CopyConverter(object):
1713
2983
    """A repository conversion tool which just performs a copy of the content.
1714
 
 
 
2984
    
1715
2985
    This is slow but quite reliable.
1716
2986
    """
1717
2987
 
1721
2991
        :param target_format: The format the resulting repository should be.
1722
2992
        """
1723
2993
        self.target_format = target_format
1724
 
 
 
2994
        
1725
2995
    def convert(self, repo, pb):
1726
2996
        """Perform the conversion of to_convert, giving feedback via pb.
1727
2997
 
1728
2998
        :param to_convert: The disk object to convert.
1729
2999
        :param pb: a progress bar to use for progress information.
1730
3000
        """
1731
 
        pb = ui.ui_factory.nested_progress_bar()
 
3001
        self.pb = pb
1732
3002
        self.count = 0
1733
3003
        self.total = 4
1734
3004
        # this is only useful with metadir layouts - separated repo content.
1735
3005
        # trigger an assertion if not such
1736
3006
        repo._format.get_format_string()
1737
3007
        self.repo_dir = repo.bzrdir
1738
 
        pb.update(gettext('Moving repository to repository.backup'))
 
3008
        self.step('Moving repository to repository.backup')
1739
3009
        self.repo_dir.transport.move('repository', 'repository.backup')
1740
3010
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
1741
3011
        repo._format.check_conversion_target(self.target_format)
1742
3012
        self.source_repo = repo._format.open(self.repo_dir,
1743
3013
            _found=True,
1744
3014
            _override_transport=backup_transport)
1745
 
        pb.update(gettext('Creating new repository'))
 
3015
        self.step('Creating new repository')
1746
3016
        converted = self.target_format.initialize(self.repo_dir,
1747
3017
                                                  self.source_repo.is_shared())
1748
3018
        converted.lock_write()
1749
3019
        try:
1750
 
            pb.update(gettext('Copying content'))
 
3020
            self.step('Copying content into repository.')
1751
3021
            self.source_repo.copy_content_into(converted)
1752
3022
        finally:
1753
3023
            converted.unlock()
1754
 
        pb.update(gettext('Deleting old repository content'))
 
3024
        self.step('Deleting old repository content.')
1755
3025
        self.repo_dir.transport.delete_tree('repository.backup')
1756
 
        ui.ui_factory.note(gettext('repository converted'))
1757
 
        pb.finished()
1758
 
 
1759
 
 
1760
 
def _strip_NULL_ghosts(revision_graph):
1761
 
    """Also don't use this. more compatibility code for unmigrated clients."""
1762
 
    # Filter ghosts, and null:
1763
 
    if _mod_revision.NULL_REVISION in revision_graph:
1764
 
        del revision_graph[_mod_revision.NULL_REVISION]
1765
 
    for key, parents in revision_graph.items():
1766
 
        revision_graph[key] = tuple(parent for parent in parents if parent
1767
 
            in revision_graph)
1768
 
    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,))
 
3026
        self.pb.note('repository converted')
 
3027
 
 
3028
    def step(self, message):
 
3029
        """Update the pb by a step."""
 
3030
        self.count +=1
 
3031
        self.pb.update(message, self.count, self.total)
 
3032
 
 
3033
 
 
3034
_unescape_map = {
 
3035
    'apos':"'",
 
3036
    'quot':'"',
 
3037
    'amp':'&',
 
3038
    'lt':'<',
 
3039
    'gt':'>'
 
3040
}
 
3041
 
 
3042
 
 
3043
def _unescaper(match, _map=_unescape_map):
 
3044
    code = match.group(1)
1789
3045
    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.
 
3046
        return _map[code]
 
3047
    except KeyError:
 
3048
        if not code.startswith('#'):
 
3049
            raise
 
3050
        return unichr(int(code[1:])).encode('utf8')
 
3051
 
 
3052
 
 
3053
_unescape_re = None
 
3054
 
 
3055
 
 
3056
def _unescape_xml(data):
 
3057
    """Unescape predefined XML entities in a string of data."""
 
3058
    global _unescape_re
 
3059
    if _unescape_re is None:
 
3060
        _unescape_re = re.compile('\&([^;]*);')
 
3061
    return _unescape_re.sub(_unescaper, data)
 
3062
 
 
3063
 
 
3064
class _VersionedFileChecker(object):
 
3065
 
 
3066
    def __init__(self, repository):
 
3067
        self.repository = repository
 
3068
        self.text_index = self.repository._generate_text_key_index()
1810
3069
    
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)
 
3070
    def calculate_file_version_parents(self, revision_id, file_id):
 
3071
        """Calculate the correct parents for a file version according to
 
3072
        the inventories.
 
3073
        """
 
3074
        parent_keys = self.text_index[(file_id, revision_id)]
 
3075
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3076
            return ()
 
3077
        # strip the file_id, for the weave api
 
3078
        return tuple([revision_id for file_id, revision_id in parent_keys])
 
3079
 
 
3080
    def check_file_version_parents(self, weave, file_id):
 
3081
        """Check the parents stored in a versioned file are correct.
 
3082
 
 
3083
        It also detects file versions that are not referenced by their
 
3084
        corresponding revision's inventory.
 
3085
 
 
3086
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3087
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3088
            correct_parents)} for each revision_id where the stored parents
 
3089
            are not correct.  dangling_file_versions is a set of (file_id,
 
3090
            revision_id) tuples for versions that are present in this versioned
 
3091
            file, but not used by the corresponding inventory.
 
3092
        """
 
3093
        wrong_parents = {}
 
3094
        unused_versions = set()
 
3095
        for num, revision_id in enumerate(weave.versions()):
 
3096
            try:
 
3097
                correct_parents = self.calculate_file_version_parents(
 
3098
                    revision_id, file_id)
 
3099
            except KeyError:
 
3100
                # The version is not part of the used keys.
 
3101
                unused_versions.add(revision_id)
 
3102
            else:
 
3103
                try:
 
3104
                    knit_parents = tuple(weave.get_parents(revision_id))
 
3105
                except errors.RevisionNotPresent:
 
3106
                    knit_parents = None
 
3107
                if correct_parents != knit_parents:
 
3108
                    wrong_parents[revision_id] = (knit_parents, correct_parents)
 
3109
        return wrong_parents, unused_versions