~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Jelmer Vernooij
  • Date: 2008-07-08 15:58:12 UTC
  • mfrom: (3353.1.4 paramiko-1.7.2-compat)
  • mto: This revision was merged to the branch mainline in revision 3531.
  • Revision ID: jelmer@samba.org-20080708155812-gacwrgs7d7n48a0d
Merge bashprompt script that prints the bzr branch nick.

Show diffs side-by-side

added added

removed removed

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