← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

Merge up bzr.dev.

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