← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-05-06 11:40:10 UTC
  • mfrom: (3400.1.3 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080506114010-jwclr2qtiekvawjg
Remove erroneous creation of branch-name file in cmd_branch

Show diffs side-by-side

added added

removed removed

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