~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2008-07-09 21:42:24 UTC
  • mto: This revision was merged to the branch mainline in revision 3543.
  • Revision ID: john@arbash-meinel.com-20080709214224-r75k87r6a01pfc3h
Restore a real weave merge to 'bzr merge --weave'.

To do so efficiently, we only add the simple LCAs to the final weave
object, unless we run into complexities with the merge graph.
This gives the same effective result as adding all the texts,
with the advantage of not having to extract all of them.

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