~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Jelmer Vernooij
  • Date: 2009-02-03 15:48:02 UTC
  • mto: (3978.3.6 branch-bzrdir-inter)
  • mto: This revision was merged to the branch mainline in revision 4250.
  • Revision ID: jelmer@samba.org-20090203154802-niup4xrso35yba65
Move most of push to IterGenericBranchBzrDir.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from cStringIO import StringIO
18
 
 
19
17
from bzrlib.lazy_import import lazy_import
20
18
lazy_import(globals(), """
21
 
from binascii import hexlify
22
 
from copy import deepcopy
 
19
import cStringIO
23
20
import re
24
21
import time
25
 
import unittest
26
22
 
27
23
from bzrlib import (
28
24
    bzrdir,
29
25
    check,
30
 
    delta,
 
26
    debug,
31
27
    errors,
 
28
    fifo_cache,
 
29
    generate_ids,
32
30
    gpg,
33
31
    graph,
34
 
    knit,
 
32
    lazy_regex,
35
33
    lockable_files,
36
34
    lockdir,
 
35
    lru_cache,
37
36
    osutils,
 
37
    remote,
38
38
    revision as _mod_revision,
39
39
    symbol_versioning,
40
 
    transactions,
 
40
    tsort,
41
41
    ui,
42
 
    weave,
43
 
    weavefile,
44
 
    xml5,
45
 
    xml6,
46
 
    )
47
 
from bzrlib.osutils import (
48
 
    rand_bytes,
49
 
    compact_date, 
50
 
    local_time_offset,
51
 
    )
 
42
    versionedfile,
 
43
    )
 
44
from bzrlib.bundle import serializer
52
45
from bzrlib.revisiontree import RevisionTree
53
46
from bzrlib.store.versioned import VersionedFileStore
54
 
from bzrlib.store.text import TextStore
55
47
from bzrlib.testament import Testament
56
48
""")
57
49
 
 
50
from bzrlib import registry
58
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
59
52
from bzrlib.inter import InterObject
60
53
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
61
54
from bzrlib.symbol_versioning import (
62
55
        deprecated_method,
63
 
        zero_nine,
 
56
        one_one,
 
57
        one_two,
 
58
        one_six,
64
59
        )
65
 
from bzrlib.trace import mutter, note, warning
 
60
from bzrlib.trace import (
 
61
    log_exception_quietly, note, mutter, mutter_callsite, warning)
66
62
 
67
63
 
68
64
# Old formats display a warning, but only once
69
65
_deprecation_warning_done = False
70
66
 
71
67
 
 
68
class CommitBuilder(object):
 
69
    """Provides an interface to build up a commit.
 
70
 
 
71
    This allows describing a tree to be committed without needing to
 
72
    know the internals of the format of the repository.
 
73
    """
 
74
 
 
75
    # all clients should supply tree roots.
 
76
    record_root_entry = True
 
77
    # the default CommitBuilder does not manage trees whose root is versioned.
 
78
    _versioned_root = False
 
79
 
 
80
    def __init__(self, repository, parents, config, timestamp=None,
 
81
                 timezone=None, committer=None, revprops=None,
 
82
                 revision_id=None):
 
83
        """Initiate a CommitBuilder.
 
84
 
 
85
        :param repository: Repository to commit to.
 
86
        :param parents: Revision ids of the parents of the new revision.
 
87
        :param config: Configuration to use.
 
88
        :param timestamp: Optional timestamp recorded for commit.
 
89
        :param timezone: Optional timezone for timestamp.
 
90
        :param committer: Optional committer to set for commit.
 
91
        :param revprops: Optional dictionary of revision properties.
 
92
        :param revision_id: Optional revision id.
 
93
        """
 
94
        self._config = config
 
95
 
 
96
        if committer is None:
 
97
            self._committer = self._config.username()
 
98
        else:
 
99
            self._committer = committer
 
100
 
 
101
        self.new_inventory = Inventory(None)
 
102
        self._new_revision_id = revision_id
 
103
        self.parents = parents
 
104
        self.repository = repository
 
105
 
 
106
        self._revprops = {}
 
107
        if revprops is not None:
 
108
            self._validate_revprops(revprops)
 
109
            self._revprops.update(revprops)
 
110
 
 
111
        if timestamp is None:
 
112
            timestamp = time.time()
 
113
        # Restrict resolution to 1ms
 
114
        self._timestamp = round(timestamp, 3)
 
115
 
 
116
        if timezone is None:
 
117
            self._timezone = osutils.local_time_offset()
 
118
        else:
 
119
            self._timezone = int(timezone)
 
120
 
 
121
        self._generate_revision_if_needed()
 
122
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
123
        self._basis_delta = []
 
124
        # API compatibility, older code that used CommitBuilder did not call
 
125
        # .record_delete(), which means the delta that is computed would not be
 
126
        # valid. Callers that will call record_delete() should call
 
127
        # .will_record_deletes() to indicate that.
 
128
        self._recording_deletes = False
 
129
 
 
130
    def _validate_unicode_text(self, text, context):
 
131
        """Verify things like commit messages don't have bogus characters."""
 
132
        if '\r' in text:
 
133
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
134
 
 
135
    def _validate_revprops(self, revprops):
 
136
        for key, value in revprops.iteritems():
 
137
            # We know that the XML serializers do not round trip '\r'
 
138
            # correctly, so refuse to accept them
 
139
            if not isinstance(value, basestring):
 
140
                raise ValueError('revision property (%s) is not a valid'
 
141
                                 ' (unicode) string: %r' % (key, value))
 
142
            self._validate_unicode_text(value,
 
143
                                        'revision property (%s)' % (key,))
 
144
 
 
145
    def commit(self, message):
 
146
        """Make the actual commit.
 
147
 
 
148
        :return: The revision id of the recorded revision.
 
149
        """
 
150
        self._validate_unicode_text(message, 'commit message')
 
151
        rev = _mod_revision.Revision(
 
152
                       timestamp=self._timestamp,
 
153
                       timezone=self._timezone,
 
154
                       committer=self._committer,
 
155
                       message=message,
 
156
                       inventory_sha1=self.inv_sha1,
 
157
                       revision_id=self._new_revision_id,
 
158
                       properties=self._revprops)
 
159
        rev.parent_ids = self.parents
 
160
        self.repository.add_revision(self._new_revision_id, rev,
 
161
            self.new_inventory, self._config)
 
162
        self.repository.commit_write_group()
 
163
        return self._new_revision_id
 
164
 
 
165
    def abort(self):
 
166
        """Abort the commit that is being built.
 
167
        """
 
168
        self.repository.abort_write_group()
 
169
 
 
170
    def revision_tree(self):
 
171
        """Return the tree that was just committed.
 
172
 
 
173
        After calling commit() this can be called to get a RevisionTree
 
174
        representing the newly committed tree. This is preferred to
 
175
        calling Repository.revision_tree() because that may require
 
176
        deserializing the inventory, while we already have a copy in
 
177
        memory.
 
178
        """
 
179
        return RevisionTree(self.repository, self.new_inventory,
 
180
                            self._new_revision_id)
 
181
 
 
182
    def finish_inventory(self):
 
183
        """Tell the builder that the inventory is finished."""
 
184
        if self.new_inventory.root is None:
 
185
            raise AssertionError('Root entry should be supplied to'
 
186
                ' record_entry_contents, as of bzr 0.10.')
 
187
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
188
        self.new_inventory.revision_id = self._new_revision_id
 
189
        self.inv_sha1 = self.repository.add_inventory(
 
190
            self._new_revision_id,
 
191
            self.new_inventory,
 
192
            self.parents
 
193
            )
 
194
 
 
195
    def _gen_revision_id(self):
 
196
        """Return new revision-id."""
 
197
        return generate_ids.gen_revision_id(self._config.username(),
 
198
                                            self._timestamp)
 
199
 
 
200
    def _generate_revision_if_needed(self):
 
201
        """Create a revision id if None was supplied.
 
202
        
 
203
        If the repository can not support user-specified revision ids
 
204
        they should override this function and raise CannotSetRevisionId
 
205
        if _new_revision_id is not None.
 
206
 
 
207
        :raises: CannotSetRevisionId
 
208
        """
 
209
        if self._new_revision_id is None:
 
210
            self._new_revision_id = self._gen_revision_id()
 
211
            self.random_revid = True
 
212
        else:
 
213
            self.random_revid = False
 
214
 
 
215
    def _heads(self, file_id, revision_ids):
 
216
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
217
 
 
218
        This can use either a per-file graph or a global revision graph as we
 
219
        have an identity relationship between the two graphs.
 
220
        """
 
221
        return self.__heads(revision_ids)
 
222
 
 
223
    def _check_root(self, ie, parent_invs, tree):
 
224
        """Helper for record_entry_contents.
 
225
 
 
226
        :param ie: An entry being added.
 
227
        :param parent_invs: The inventories of the parent revisions of the
 
228
            commit.
 
229
        :param tree: The tree that is being committed.
 
230
        """
 
231
        # In this revision format, root entries have no knit or weave When
 
232
        # serializing out to disk and back in root.revision is always
 
233
        # _new_revision_id
 
234
        ie.revision = self._new_revision_id
 
235
 
 
236
    def _get_delta(self, ie, basis_inv, path):
 
237
        """Get a delta against the basis inventory for ie."""
 
238
        if ie.file_id not in basis_inv:
 
239
            # add
 
240
            result = (None, path, ie.file_id, ie)
 
241
            self._basis_delta.append(result)
 
242
            return result
 
243
        elif ie != basis_inv[ie.file_id]:
 
244
            # common but altered
 
245
            # TODO: avoid tis id2path call.
 
246
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
247
            self._basis_delta.append(result)
 
248
            return result
 
249
        else:
 
250
            # common, unaltered
 
251
            return None
 
252
 
 
253
    def get_basis_delta(self):
 
254
        """Return the complete inventory delta versus the basis inventory.
 
255
 
 
256
        This has been built up with the calls to record_delete and
 
257
        record_entry_contents. The client must have already called
 
258
        will_record_deletes() to indicate that they will be generating a
 
259
        complete delta.
 
260
 
 
261
        :return: An inventory delta, suitable for use with apply_delta, or
 
262
            Repository.add_inventory_by_delta, etc.
 
263
        """
 
264
        if not self._recording_deletes:
 
265
            raise AssertionError("recording deletes not activated.")
 
266
        return self._basis_delta
 
267
 
 
268
    def record_delete(self, path, file_id):
 
269
        """Record that a delete occured against a basis tree.
 
270
 
 
271
        This is an optional API - when used it adds items to the basis_delta
 
272
        being accumulated by the commit builder. It cannot be called unless the
 
273
        method will_record_deletes() has been called to inform the builder that
 
274
        a delta is being supplied.
 
275
 
 
276
        :param path: The path of the thing deleted.
 
277
        :param file_id: The file id that was deleted.
 
278
        """
 
279
        if not self._recording_deletes:
 
280
            raise AssertionError("recording deletes not activated.")
 
281
        delta = (path, None, file_id, None)
 
282
        self._basis_delta.append(delta)
 
283
        return delta
 
284
 
 
285
    def will_record_deletes(self):
 
286
        """Tell the commit builder that deletes are being notified.
 
287
 
 
288
        This enables the accumulation of an inventory delta; for the resulting
 
289
        commit to be valid, deletes against the basis MUST be recorded via
 
290
        builder.record_delete().
 
291
        """
 
292
        self._recording_deletes = True
 
293
 
 
294
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
295
        content_summary):
 
296
        """Record the content of ie from tree into the commit if needed.
 
297
 
 
298
        Side effect: sets ie.revision when unchanged
 
299
 
 
300
        :param ie: An inventory entry present in the commit.
 
301
        :param parent_invs: The inventories of the parent revisions of the
 
302
            commit.
 
303
        :param path: The path the entry is at in the tree.
 
304
        :param tree: The tree which contains this entry and should be used to 
 
305
            obtain content.
 
306
        :param content_summary: Summary data from the tree about the paths
 
307
            content - stat, length, exec, sha/link target. This is only
 
308
            accessed when the entry has a revision of None - that is when it is
 
309
            a candidate to commit.
 
310
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
311
            change_delta is an inventory_delta change for this entry against
 
312
            the basis tree of the commit, or None if no change occured against
 
313
            the basis tree.
 
314
            version_recorded is True if a new version of the entry has been
 
315
            recorded. For instance, committing a merge where a file was only
 
316
            changed on the other side will return (delta, False).
 
317
            fs_hash is either None, or the hash details for the path (currently
 
318
            a tuple of the contents sha1 and the statvalue returned by
 
319
            tree.get_file_with_stat()).
 
320
        """
 
321
        if self.new_inventory.root is None:
 
322
            if ie.parent_id is not None:
 
323
                raise errors.RootMissing()
 
324
            self._check_root(ie, parent_invs, tree)
 
325
        if ie.revision is None:
 
326
            kind = content_summary[0]
 
327
        else:
 
328
            # ie is carried over from a prior commit
 
329
            kind = ie.kind
 
330
        # XXX: repository specific check for nested tree support goes here - if
 
331
        # the repo doesn't want nested trees we skip it ?
 
332
        if (kind == 'tree-reference' and
 
333
            not self.repository._format.supports_tree_reference):
 
334
            # mismatch between commit builder logic and repository:
 
335
            # this needs the entry creation pushed down into the builder.
 
336
            raise NotImplementedError('Missing repository subtree support.')
 
337
        self.new_inventory.add(ie)
 
338
 
 
339
        # TODO: slow, take it out of the inner loop.
 
340
        try:
 
341
            basis_inv = parent_invs[0]
 
342
        except IndexError:
 
343
            basis_inv = Inventory(root_id=None)
 
344
 
 
345
        # ie.revision is always None if the InventoryEntry is considered
 
346
        # for committing. We may record the previous parents revision if the
 
347
        # content is actually unchanged against a sole head.
 
348
        if ie.revision is not None:
 
349
            if not self._versioned_root and path == '':
 
350
                # repositories that do not version the root set the root's
 
351
                # revision to the new commit even when no change occurs (more
 
352
                # specifically, they do not record a revision on the root; and
 
353
                # the rev id is assigned to the root during deserialisation -
 
354
                # this masks when a change may have occurred against the basis.
 
355
                # To match this we always issue a delta, because the revision
 
356
                # of the root will always be changing.
 
357
                if ie.file_id in basis_inv:
 
358
                    delta = (basis_inv.id2path(ie.file_id), path,
 
359
                        ie.file_id, ie)
 
360
                else:
 
361
                    # add
 
362
                    delta = (None, path, ie.file_id, ie)
 
363
                self._basis_delta.append(delta)
 
364
                return delta, False, None
 
365
            else:
 
366
                # we don't need to commit this, because the caller already
 
367
                # determined that an existing revision of this file is
 
368
                # appropriate. If its not being considered for committing then
 
369
                # it and all its parents to the root must be unaltered so
 
370
                # no-change against the basis.
 
371
                if ie.revision == self._new_revision_id:
 
372
                    raise AssertionError("Impossible situation, a skipped "
 
373
                        "inventory entry (%r) claims to be modified in this "
 
374
                        "commit (%r).", (ie, self._new_revision_id))
 
375
                return None, False, None
 
376
        # XXX: Friction: parent_candidates should return a list not a dict
 
377
        #      so that we don't have to walk the inventories again.
 
378
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
379
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
380
        heads = []
 
381
        for inv in parent_invs:
 
382
            if ie.file_id in inv:
 
383
                old_rev = inv[ie.file_id].revision
 
384
                if old_rev in head_set:
 
385
                    heads.append(inv[ie.file_id].revision)
 
386
                    head_set.remove(inv[ie.file_id].revision)
 
387
 
 
388
        store = False
 
389
        # now we check to see if we need to write a new record to the
 
390
        # file-graph.
 
391
        # We write a new entry unless there is one head to the ancestors, and
 
392
        # the kind-derived content is unchanged.
 
393
 
 
394
        # Cheapest check first: no ancestors, or more the one head in the
 
395
        # ancestors, we write a new node.
 
396
        if len(heads) != 1:
 
397
            store = True
 
398
        if not store:
 
399
            # There is a single head, look it up for comparison
 
400
            parent_entry = parent_candiate_entries[heads[0]]
 
401
            # if the non-content specific data has changed, we'll be writing a
 
402
            # node:
 
403
            if (parent_entry.parent_id != ie.parent_id or
 
404
                parent_entry.name != ie.name):
 
405
                store = True
 
406
        # now we need to do content specific checks:
 
407
        if not store:
 
408
            # if the kind changed the content obviously has
 
409
            if kind != parent_entry.kind:
 
410
                store = True
 
411
        # Stat cache fingerprint feedback for the caller - None as we usually
 
412
        # don't generate one.
 
413
        fingerprint = None
 
414
        if kind == 'file':
 
415
            if content_summary[2] is None:
 
416
                raise ValueError("Files must not have executable = None")
 
417
            if not store:
 
418
                if (# if the file length changed we have to store:
 
419
                    parent_entry.text_size != content_summary[1] or
 
420
                    # if the exec bit has changed we have to store:
 
421
                    parent_entry.executable != content_summary[2]):
 
422
                    store = True
 
423
                elif parent_entry.text_sha1 == content_summary[3]:
 
424
                    # all meta and content is unchanged (using a hash cache
 
425
                    # hit to check the sha)
 
426
                    ie.revision = parent_entry.revision
 
427
                    ie.text_size = parent_entry.text_size
 
428
                    ie.text_sha1 = parent_entry.text_sha1
 
429
                    ie.executable = parent_entry.executable
 
430
                    return self._get_delta(ie, basis_inv, path), False, None
 
431
                else:
 
432
                    # Either there is only a hash change(no hash cache entry,
 
433
                    # or same size content change), or there is no change on
 
434
                    # this file at all.
 
435
                    # Provide the parent's hash to the store layer, so that the
 
436
                    # content is unchanged we will not store a new node.
 
437
                    nostore_sha = parent_entry.text_sha1
 
438
            if store:
 
439
                # We want to record a new node regardless of the presence or
 
440
                # absence of a content change in the file.
 
441
                nostore_sha = None
 
442
            ie.executable = content_summary[2]
 
443
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
444
            try:
 
445
                lines = file_obj.readlines()
 
446
            finally:
 
447
                file_obj.close()
 
448
            try:
 
449
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
450
                    ie.file_id, lines, heads, nostore_sha)
 
451
                # Let the caller know we generated a stat fingerprint.
 
452
                fingerprint = (ie.text_sha1, stat_value)
 
453
            except errors.ExistingContent:
 
454
                # Turns out that the file content was unchanged, and we were
 
455
                # only going to store a new node if it was changed. Carry over
 
456
                # the entry.
 
457
                ie.revision = parent_entry.revision
 
458
                ie.text_size = parent_entry.text_size
 
459
                ie.text_sha1 = parent_entry.text_sha1
 
460
                ie.executable = parent_entry.executable
 
461
                return self._get_delta(ie, basis_inv, path), False, None
 
462
        elif kind == 'directory':
 
463
            if not store:
 
464
                # all data is meta here, nothing specific to directory, so
 
465
                # carry over:
 
466
                ie.revision = parent_entry.revision
 
467
                return self._get_delta(ie, basis_inv, path), False, None
 
468
            lines = []
 
469
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
470
        elif kind == 'symlink':
 
471
            current_link_target = content_summary[3]
 
472
            if not store:
 
473
                # symlink target is not generic metadata, check if it has
 
474
                # changed.
 
475
                if current_link_target != parent_entry.symlink_target:
 
476
                    store = True
 
477
            if not store:
 
478
                # unchanged, carry over.
 
479
                ie.revision = parent_entry.revision
 
480
                ie.symlink_target = parent_entry.symlink_target
 
481
                return self._get_delta(ie, basis_inv, path), False, None
 
482
            ie.symlink_target = current_link_target
 
483
            lines = []
 
484
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
485
        elif kind == 'tree-reference':
 
486
            if not store:
 
487
                if content_summary[3] != parent_entry.reference_revision:
 
488
                    store = True
 
489
            if not store:
 
490
                # unchanged, carry over.
 
491
                ie.reference_revision = parent_entry.reference_revision
 
492
                ie.revision = parent_entry.revision
 
493
                return self._get_delta(ie, basis_inv, path), False, None
 
494
            ie.reference_revision = content_summary[3]
 
495
            lines = []
 
496
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
497
        else:
 
498
            raise NotImplementedError('unknown kind')
 
499
        ie.revision = self._new_revision_id
 
500
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
501
 
 
502
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
503
        # Note: as we read the content directly from the tree, we know its not
 
504
        # been turned into unicode or badly split - but a broken tree
 
505
        # implementation could give us bad output from readlines() so this is
 
506
        # not a guarantee of safety. What would be better is always checking
 
507
        # the content during test suite execution. RBC 20070912
 
508
        parent_keys = tuple((file_id, parent) for parent in parents)
 
509
        return self.repository.texts.add_lines(
 
510
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
511
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
512
            check_content=False)[0:2]
 
513
 
 
514
 
 
515
class RootCommitBuilder(CommitBuilder):
 
516
    """This commitbuilder actually records the root id"""
 
517
    
 
518
    # the root entry gets versioned properly by this builder.
 
519
    _versioned_root = True
 
520
 
 
521
    def _check_root(self, ie, parent_invs, tree):
 
522
        """Helper for record_entry_contents.
 
523
 
 
524
        :param ie: An entry being added.
 
525
        :param parent_invs: The inventories of the parent revisions of the
 
526
            commit.
 
527
        :param tree: The tree that is being committed.
 
528
        """
 
529
 
 
530
 
 
531
######################################################################
 
532
# Repositories
 
533
 
72
534
class Repository(object):
73
535
    """Repository holding history for one or more branches.
74
536
 
76
538
    revisions and file history.  It's normally accessed only by the Branch,
77
539
    which views a particular line of development through that history.
78
540
 
79
 
    The Repository builds on top of Stores and a Transport, which respectively 
80
 
    describe the disk data format and the way of accessing the (possibly 
 
541
    The Repository builds on top of some byte storage facilies (the revisions,
 
542
    signatures, inventories and texts attributes) and a Transport, which
 
543
    respectively provide byte storage and a means to access the (possibly
81
544
    remote) disk.
 
545
 
 
546
    The byte storage facilities are addressed via tuples, which we refer to
 
547
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
548
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
549
    (file_id, revision_id). We use this interface because it allows low
 
550
    friction with the underlying code that implements disk indices, network
 
551
    encoding and other parts of bzrlib.
 
552
 
 
553
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
 
554
        the serialised revisions for the repository. This can be used to obtain
 
555
        revision graph information or to access raw serialised revisions.
 
556
        The result of trying to insert data into the repository via this store
 
557
        is undefined: it should be considered read-only except for implementors
 
558
        of repositories.
 
559
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
560
        the serialised signatures for the repository. This can be used to
 
561
        obtain access to raw serialised signatures.  The result of trying to
 
562
        insert data into the repository via this store is undefined: it should
 
563
        be considered read-only except for implementors of repositories.
 
564
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
565
        the serialised inventories for the repository. This can be used to
 
566
        obtain unserialised inventories.  The result of trying to insert data
 
567
        into the repository via this store is undefined: it should be
 
568
        considered read-only except for implementors of repositories.
 
569
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
570
        texts of files and directories for the repository. This can be used to
 
571
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
572
        is usually a better interface for accessing file texts.
 
573
        The result of trying to insert data into the repository via this store
 
574
        is undefined: it should be considered read-only except for implementors
 
575
        of repositories.
 
576
    :ivar _transport: Transport for file access to repository, typically
 
577
        pointing to .bzr/repository.
82
578
    """
83
579
 
84
 
    @needs_write_lock
85
 
    def add_inventory(self, revid, inv, parents):
86
 
        """Add the inventory inv to the repository as revid.
87
 
        
88
 
        :param parents: The revision ids of the parents that revid
 
580
    # What class to use for a CommitBuilder. Often its simpler to change this
 
581
    # in a Repository class subclass rather than to override
 
582
    # get_commit_builder.
 
583
    _commit_builder_class = CommitBuilder
 
584
    # The search regex used by xml based repositories to determine what things
 
585
    # where changed in a single commit.
 
586
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
587
        r'file_id="(?P<file_id>[^"]+)"'
 
588
        r'.* revision="(?P<revision_id>[^"]+)"'
 
589
        )
 
590
 
 
591
    def abort_write_group(self, suppress_errors=False):
 
592
        """Commit the contents accrued within the current write group.
 
593
 
 
594
        :param suppress_errors: if true, abort_write_group will catch and log
 
595
            unexpected errors that happen during the abort, rather than
 
596
            allowing them to propagate.  Defaults to False.
 
597
 
 
598
        :seealso: start_write_group.
 
599
        """
 
600
        if self._write_group is not self.get_transaction():
 
601
            # has an unlock or relock occured ?
 
602
            raise errors.BzrError('mismatched lock context and write group.')
 
603
        try:
 
604
            self._abort_write_group()
 
605
        except Exception, exc:
 
606
            self._write_group = None
 
607
            if not suppress_errors:
 
608
                raise
 
609
            mutter('abort_write_group failed')
 
610
            log_exception_quietly()
 
611
            note('bzr: ERROR (ignored): %s', exc)
 
612
        self._write_group = None
 
613
 
 
614
    def _abort_write_group(self):
 
615
        """Template method for per-repository write group cleanup.
 
616
        
 
617
        This is called during abort before the write group is considered to be 
 
618
        finished and should cleanup any internal state accrued during the write
 
619
        group. There is no requirement that data handed to the repository be
 
620
        *not* made available - this is not a rollback - but neither should any
 
621
        attempt be made to ensure that data added is fully commited. Abort is
 
622
        invoked when an error has occured so futher disk or network operations
 
623
        may not be possible or may error and if possible should not be
 
624
        attempted.
 
625
        """
 
626
 
 
627
    def add_fallback_repository(self, repository):
 
628
        """Add a repository to use for looking up data not held locally.
 
629
        
 
630
        :param repository: A repository.
 
631
        """
 
632
        if not self._format.supports_external_lookups:
 
633
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
634
        self._check_fallback_repository(repository)
 
635
        self._fallback_repositories.append(repository)
 
636
        self.texts.add_fallback_versioned_files(repository.texts)
 
637
        self.inventories.add_fallback_versioned_files(repository.inventories)
 
638
        self.revisions.add_fallback_versioned_files(repository.revisions)
 
639
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
640
        self._fetch_order = 'topological'
 
641
 
 
642
    def _check_fallback_repository(self, repository):
 
643
        """Check that this repository can fallback to repository safely.
 
644
 
 
645
        Raise an error if not.
 
646
        
 
647
        :param repository: A repository to fallback to.
 
648
        """
 
649
        return InterRepository._assert_same_model(self, repository)
 
650
 
 
651
    def add_inventory(self, revision_id, inv, parents):
 
652
        """Add the inventory inv to the repository as revision_id.
 
653
        
 
654
        :param parents: The revision ids of the parents that revision_id
89
655
                        is known to have and are in the repository already.
90
656
 
91
 
        returns the sha1 of the serialized inventory.
92
 
        """
93
 
        assert inv.revision_id is None or inv.revision_id == revid, \
94
 
            "Mismatch between inventory revision" \
95
 
            " id and insertion revid (%r, %r)" % (inv.revision_id, revid)
96
 
        assert inv.root is not None
97
 
        inv_text = self.serialise_inventory(inv)
98
 
        inv_sha1 = osutils.sha_string(inv_text)
99
 
        inv_vf = self.control_weaves.get_weave('inventory',
100
 
                                               self.get_transaction())
101
 
        self._inventory_add_lines(inv_vf, revid, parents, osutils.split_lines(inv_text))
102
 
        return inv_sha1
103
 
 
104
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
105
 
        final_parents = []
106
 
        for parent in parents:
107
 
            if parent in inv_vf:
108
 
                final_parents.append(parent)
109
 
 
110
 
        inv_vf.add_lines(revid, final_parents, lines)
111
 
 
112
 
    @needs_write_lock
113
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
114
 
        """Add rev to the revision store as rev_id.
115
 
 
116
 
        :param rev_id: the revision id to use.
 
657
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
658
            repository format specific) of the serialized inventory.
 
659
        """
 
660
        if not self.is_in_write_group():
 
661
            raise AssertionError("%r not in write group" % (self,))
 
662
        _mod_revision.check_not_reserved_id(revision_id)
 
663
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
664
            raise AssertionError(
 
665
                "Mismatch between inventory revision"
 
666
                " id and insertion revid (%r, %r)"
 
667
                % (inv.revision_id, revision_id))
 
668
        if inv.root is None:
 
669
            raise AssertionError()
 
670
        inv_lines = self._serialise_inventory_to_lines(inv)
 
671
        return self._inventory_add_lines(revision_id, parents,
 
672
            inv_lines, check_content=False)
 
673
 
 
674
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
675
                               parents):
 
676
        """Add a new inventory expressed as a delta against another revision.
 
677
 
 
678
        :param basis_revision_id: The inventory id the delta was created
 
679
            against. (This does not have to be a direct parent.)
 
680
        :param delta: The inventory delta (see Inventory.apply_delta for
 
681
            details).
 
682
        :param new_revision_id: The revision id that the inventory is being
 
683
            added for.
 
684
        :param parents: The revision ids of the parents that revision_id is
 
685
            known to have and are in the repository already. These are supplied
 
686
            for repositories that depend on the inventory graph for revision
 
687
            graph access, as well as for those that pun ancestry with delta
 
688
            compression.
 
689
 
 
690
        :returns: (validator, new_inv)
 
691
            The validator(which is a sha1 digest, though what is sha'd is
 
692
            repository format specific) of the serialized inventory, and the
 
693
            resulting inventory.
 
694
        """
 
695
        if not self.is_in_write_group():
 
696
            raise AssertionError("%r not in write group" % (self,))
 
697
        _mod_revision.check_not_reserved_id(new_revision_id)
 
698
        basis_tree = self.revision_tree(basis_revision_id)
 
699
        basis_tree.lock_read()
 
700
        try:
 
701
            # Note that this mutates the inventory of basis_tree, which not all
 
702
            # inventory implementations may support: A better idiom would be to
 
703
            # return a new inventory, but as there is no revision tree cache in
 
704
            # repository this is safe for now - RBC 20081013
 
705
            basis_inv = basis_tree.inventory
 
706
            basis_inv.apply_delta(delta)
 
707
            basis_inv.revision_id = new_revision_id
 
708
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
709
                    basis_inv)
 
710
        finally:
 
711
            basis_tree.unlock()
 
712
 
 
713
    def _inventory_add_lines(self, revision_id, parents, lines,
 
714
        check_content=True):
 
715
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
716
        parents = [(parent,) for parent in parents]
 
717
        return self.inventories.add_lines((revision_id,), parents, lines,
 
718
            check_content=check_content)[0]
 
719
 
 
720
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
721
        """Add rev to the revision store as revision_id.
 
722
 
 
723
        :param revision_id: the revision id to use.
117
724
        :param rev: The revision object.
118
725
        :param inv: The inventory for the revision. if None, it will be looked
119
726
                    up in the inventory storer
121
728
                       If supplied its signature_needed method will be used
122
729
                       to determine if a signature should be made.
123
730
        """
 
731
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
732
        #       rev.parent_ids?
 
733
        _mod_revision.check_not_reserved_id(revision_id)
124
734
        if config is not None and config.signature_needed():
125
735
            if inv is None:
126
 
                inv = self.get_inventory(rev_id)
 
736
                inv = self.get_inventory(revision_id)
127
737
            plaintext = Testament(rev, inv).as_short_text()
128
738
            self.store_revision_signature(
129
 
                gpg.GPGStrategy(config), plaintext, rev_id)
130
 
        if not rev_id in self.get_inventory_weave():
 
739
                gpg.GPGStrategy(config), plaintext, revision_id)
 
740
        # check inventory present
 
741
        if not self.inventories.get_parent_map([(revision_id,)]):
131
742
            if inv is None:
132
 
                raise errors.WeaveRevisionNotPresent(rev_id,
133
 
                                                     self.get_inventory_weave())
 
743
                raise errors.WeaveRevisionNotPresent(revision_id,
 
744
                                                     self.inventories)
134
745
            else:
135
746
                # yes, this is not suitable for adding with ghosts.
136
 
                self.add_inventory(rev_id, inv, rev.parent_ids)
137
 
        self._revision_store.add_revision(rev, self.get_transaction())
 
747
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
748
                                                        rev.parent_ids)
 
749
        else:
 
750
            key = (revision_id,)
 
751
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
752
        self._add_revision(rev)
138
753
 
139
 
    @needs_read_lock
140
 
    def _all_possible_ids(self):
141
 
        """Return all the possible revisions that we could find."""
142
 
        return self.get_inventory_weave().versions()
 
754
    def _add_revision(self, revision):
 
755
        text = self._serializer.write_revision_to_string(revision)
 
756
        key = (revision.revision_id,)
 
757
        parents = tuple((parent,) for parent in revision.parent_ids)
 
758
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
143
759
 
144
760
    def all_revision_ids(self):
145
761
        """Returns a list of all the revision ids in the repository. 
146
762
 
147
 
        This is deprecated because code should generally work on the graph
148
 
        reachable from a particular revision, and ignore any other revisions
149
 
        that might be present.  There is no direct replacement method.
 
763
        This is conceptually deprecated because code should generally work on
 
764
        the graph reachable from a particular revision, and ignore any other
 
765
        revisions that might be present.  There is no direct replacement
 
766
        method.
150
767
        """
 
768
        if 'evil' in debug.debug_flags:
 
769
            mutter_callsite(2, "all_revision_ids is linear with history.")
151
770
        return self._all_revision_ids()
152
771
 
153
 
    @needs_read_lock
154
772
    def _all_revision_ids(self):
155
773
        """Returns a list of all the revision ids in the repository. 
156
774
 
157
775
        These are in as much topological order as the underlying store can 
158
 
        present: for weaves ghosts may lead to a lack of correctness until
159
 
        the reweave updates the parents list.
 
776
        present.
160
777
        """
161
 
        if self._revision_store.text_store.listable():
162
 
            return self._revision_store.all_revision_ids(self.get_transaction())
163
 
        result = self._all_possible_ids()
164
 
        return self._eliminate_revisions_not_present(result)
 
778
        raise NotImplementedError(self._all_revision_ids)
165
779
 
166
780
    def break_lock(self):
167
781
        """Break a lock if one is present from another instance.
178
792
        Returns a set of the present revisions.
179
793
        """
180
794
        result = []
181
 
        for id in revision_ids:
182
 
            if self.has_revision(id):
183
 
               result.append(id)
184
 
        return result
 
795
        graph = self.get_graph()
 
796
        parent_map = graph.get_parent_map(revision_ids)
 
797
        # The old API returned a list, should this actually be a set?
 
798
        return parent_map.keys()
185
799
 
186
800
    @staticmethod
187
801
    def create(a_bzrdir):
188
802
        """Construct the current default format repository in a_bzrdir."""
189
803
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
190
804
 
191
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
805
    def __init__(self, _format, a_bzrdir, control_files):
192
806
        """instantiate a Repository.
193
807
 
194
808
        :param _format: The format of the repository on disk.
203
817
        # the following are part of the public API for Repository:
204
818
        self.bzrdir = a_bzrdir
205
819
        self.control_files = control_files
206
 
        self._revision_store = _revision_store
207
 
        self.text_store = text_store
208
 
        # backwards compatibility
209
 
        self.weave_store = text_store
 
820
        self._transport = control_files._transport
 
821
        self.base = self._transport.base
 
822
        # for tests
 
823
        self._reconcile_does_inventory_gc = True
 
824
        self._reconcile_fixes_text_parents = False
 
825
        self._reconcile_backsup_inventory = True
210
826
        # not right yet - should be more semantically clear ? 
211
827
        # 
212
 
        self.control_store = control_store
213
 
        self.control_weaves = control_store
214
828
        # TODO: make sure to construct the right store classes, etc, depending
215
829
        # on whether escaping is required.
216
830
        self._warn_if_deprecated()
217
 
        self._serializer = xml5.serializer_v5
 
831
        self._write_group = None
 
832
        # Additional places to query for data.
 
833
        self._fallback_repositories = []
 
834
        # What order should fetch operations request streams in?
 
835
        # The default is unordered as that is the cheapest for an origin to
 
836
        # provide.
 
837
        self._fetch_order = 'unordered'
 
838
        # Does this repository use deltas that can be fetched as-deltas ?
 
839
        # (E.g. knits, where the knit deltas can be transplanted intact.
 
840
        # We default to False, which will ensure that enough data to get
 
841
        # a full text out of any fetch stream will be grabbed.
 
842
        self._fetch_uses_deltas = False
 
843
        # Should fetch trigger a reconcile after the fetch? Only needed for
 
844
        # some repository formats that can suffer internal inconsistencies.
 
845
        self._fetch_reconcile = False
 
846
        # An InventoryEntry cache, used during deserialization
 
847
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
218
848
 
219
849
    def __repr__(self):
220
 
        return '%s(%r)' % (self.__class__.__name__, 
221
 
                           self.bzrdir.transport.base)
 
850
        return '%s(%r)' % (self.__class__.__name__,
 
851
                           self.base)
 
852
 
 
853
    def has_same_location(self, other):
 
854
        """Returns a boolean indicating if this repository is at the same
 
855
        location as another repository.
 
856
 
 
857
        This might return False even when two repository objects are accessing
 
858
        the same physical repository via different URLs.
 
859
        """
 
860
        if self.__class__ is not other.__class__:
 
861
            return False
 
862
        return (self._transport.base == other._transport.base)
 
863
 
 
864
    def is_in_write_group(self):
 
865
        """Return True if there is an open write group.
 
866
 
 
867
        :seealso: start_write_group.
 
868
        """
 
869
        return self._write_group is not None
222
870
 
223
871
    def is_locked(self):
224
872
        return self.control_files.is_locked()
225
873
 
226
 
    def lock_write(self):
227
 
        self.control_files.lock_write()
 
874
    def is_write_locked(self):
 
875
        """Return True if this object is write locked."""
 
876
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
877
 
 
878
    def lock_write(self, token=None):
 
879
        """Lock this repository for writing.
 
880
 
 
881
        This causes caching within the repository obejct to start accumlating
 
882
        data during reads, and allows a 'write_group' to be obtained. Write
 
883
        groups must be used for actual data insertion.
 
884
        
 
885
        :param token: if this is already locked, then lock_write will fail
 
886
            unless the token matches the existing lock.
 
887
        :returns: a token if this instance supports tokens, otherwise None.
 
888
        :raises TokenLockingNotSupported: when a token is given but this
 
889
            instance doesn't support using token locks.
 
890
        :raises MismatchedToken: if the specified token doesn't match the token
 
891
            of the existing lock.
 
892
        :seealso: start_write_group.
 
893
 
 
894
        A token should be passed in if you know that you have locked the object
 
895
        some other way, and need to synchronise this object's state with that
 
896
        fact.
 
897
 
 
898
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
899
        """
 
900
        result = self.control_files.lock_write(token=token)
 
901
        for repo in self._fallback_repositories:
 
902
            # Writes don't affect fallback repos
 
903
            repo.lock_read()
 
904
        self._refresh_data()
 
905
        return result
228
906
 
229
907
    def lock_read(self):
230
908
        self.control_files.lock_read()
 
909
        for repo in self._fallback_repositories:
 
910
            repo.lock_read()
 
911
        self._refresh_data()
231
912
 
232
913
    def get_physical_lock_status(self):
233
914
        return self.control_files.get_physical_lock_status()
234
915
 
235
 
    @needs_read_lock
236
 
    def missing_revision_ids(self, other, revision_id=None):
237
 
        """Return the revision ids that other has that this does not.
238
 
        
239
 
        These are returned in topological order.
240
 
 
241
 
        revision_id: only return revision ids included by revision_id.
242
 
        """
243
 
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
916
    def leave_lock_in_place(self):
 
917
        """Tell this repository not to release the physical lock when this
 
918
        object is unlocked.
 
919
        
 
920
        If lock_write doesn't return a token, then this method is not supported.
 
921
        """
 
922
        self.control_files.leave_in_place()
 
923
 
 
924
    def dont_leave_lock_in_place(self):
 
925
        """Tell this repository to release the physical lock when this
 
926
        object is unlocked, even if it didn't originally acquire it.
 
927
 
 
928
        If lock_write doesn't return a token, then this method is not supported.
 
929
        """
 
930
        self.control_files.dont_leave_in_place()
 
931
 
 
932
    @needs_read_lock
 
933
    def gather_stats(self, revid=None, committers=None):
 
934
        """Gather statistics from a revision id.
 
935
 
 
936
        :param revid: The revision id to gather statistics from, if None, then
 
937
            no revision specific statistics are gathered.
 
938
        :param committers: Optional parameter controlling whether to grab
 
939
            a count of committers from the revision specific statistics.
 
940
        :return: A dictionary of statistics. Currently this contains:
 
941
            committers: The number of committers if requested.
 
942
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
943
                most ancestor of revid, if revid is not the NULL_REVISION.
 
944
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
945
                not the NULL_REVISION.
 
946
            revisions: The total revision count in the repository.
 
947
            size: An estimate disk size of the repository in bytes.
 
948
        """
 
949
        result = {}
 
950
        if revid and committers:
 
951
            result['committers'] = 0
 
952
        if revid and revid != _mod_revision.NULL_REVISION:
 
953
            if committers:
 
954
                all_committers = set()
 
955
            revisions = self.get_ancestry(revid)
 
956
            # pop the leading None
 
957
            revisions.pop(0)
 
958
            first_revision = None
 
959
            if not committers:
 
960
                # ignore the revisions in the middle - just grab first and last
 
961
                revisions = revisions[0], revisions[-1]
 
962
            for revision in self.get_revisions(revisions):
 
963
                if not first_revision:
 
964
                    first_revision = revision
 
965
                if committers:
 
966
                    all_committers.add(revision.committer)
 
967
            last_revision = revision
 
968
            if committers:
 
969
                result['committers'] = len(all_committers)
 
970
            result['firstrev'] = (first_revision.timestamp,
 
971
                first_revision.timezone)
 
972
            result['latestrev'] = (last_revision.timestamp,
 
973
                last_revision.timezone)
 
974
 
 
975
        # now gather global repository information
 
976
        # XXX: This is available for many repos regardless of listability.
 
977
        if self.bzrdir.root_transport.listable():
 
978
            # XXX: do we want to __define len__() ?
 
979
            # Maybe the versionedfiles object should provide a different
 
980
            # method to get the number of keys.
 
981
            result['revisions'] = len(self.revisions.keys())
 
982
            # result['size'] = t
 
983
        return result
 
984
 
 
985
    def find_branches(self, using=False):
 
986
        """Find branches underneath this repository.
 
987
 
 
988
        This will include branches inside other branches.
 
989
 
 
990
        :param using: If True, list only branches using this repository.
 
991
        """
 
992
        if using and not self.is_shared():
 
993
            try:
 
994
                return [self.bzrdir.open_branch()]
 
995
            except errors.NotBranchError:
 
996
                return []
 
997
        class Evaluator(object):
 
998
 
 
999
            def __init__(self):
 
1000
                self.first_call = True
 
1001
 
 
1002
            def __call__(self, bzrdir):
 
1003
                # On the first call, the parameter is always the bzrdir
 
1004
                # containing the current repo.
 
1005
                if not self.first_call:
 
1006
                    try:
 
1007
                        repository = bzrdir.open_repository()
 
1008
                    except errors.NoRepositoryPresent:
 
1009
                        pass
 
1010
                    else:
 
1011
                        return False, (None, repository)
 
1012
                self.first_call = False
 
1013
                try:
 
1014
                    value = (bzrdir.open_branch(), None)
 
1015
                except errors.NotBranchError:
 
1016
                    value = (None, None)
 
1017
                return True, value
 
1018
 
 
1019
        branches = []
 
1020
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1021
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1022
            if branch is not None:
 
1023
                branches.append(branch)
 
1024
            if not using and repository is not None:
 
1025
                branches.extend(repository.find_branches())
 
1026
        return branches
 
1027
 
 
1028
    @needs_read_lock
 
1029
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1030
        """Return the revision ids that other has that this does not.
 
1031
        
 
1032
        These are returned in topological order.
 
1033
 
 
1034
        revision_id: only return revision ids included by revision_id.
 
1035
        """
 
1036
        return InterRepository.get(other, self).search_missing_revision_ids(
 
1037
            revision_id, find_ghosts)
 
1038
 
 
1039
    @deprecated_method(one_two)
 
1040
    @needs_read_lock
 
1041
    def missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1042
        """Return the revision ids that other has that this does not.
 
1043
        
 
1044
        These are returned in topological order.
 
1045
 
 
1046
        revision_id: only return revision ids included by revision_id.
 
1047
        """
 
1048
        keys =  self.search_missing_revision_ids(
 
1049
            other, revision_id, find_ghosts).get_keys()
 
1050
        other.lock_read()
 
1051
        try:
 
1052
            parents = other.get_graph().get_parent_map(keys)
 
1053
        finally:
 
1054
            other.unlock()
 
1055
        return tsort.topo_sort(parents)
244
1056
 
245
1057
    @staticmethod
246
1058
    def open(base):
252
1064
        control = bzrdir.BzrDir.open(base)
253
1065
        return control.open_repository()
254
1066
 
255
 
    def copy_content_into(self, destination, revision_id=None, basis=None):
 
1067
    def copy_content_into(self, destination, revision_id=None):
256
1068
        """Make a complete copy of the content in self into destination.
257
1069
        
258
1070
        This is a destructive operation! Do not use it on existing 
259
1071
        repositories.
260
1072
        """
261
 
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
262
 
 
263
 
    def fetch(self, source, revision_id=None, pb=None):
 
1073
        return InterRepository.get(self, destination).copy_content(revision_id)
 
1074
 
 
1075
    def commit_write_group(self):
 
1076
        """Commit the contents accrued within the current write group.
 
1077
 
 
1078
        :seealso: start_write_group.
 
1079
        """
 
1080
        if self._write_group is not self.get_transaction():
 
1081
            # has an unlock or relock occured ?
 
1082
            raise errors.BzrError('mismatched lock context %r and '
 
1083
                'write group %r.' %
 
1084
                (self.get_transaction(), self._write_group))
 
1085
        self._commit_write_group()
 
1086
        self._write_group = None
 
1087
 
 
1088
    def _commit_write_group(self):
 
1089
        """Template method for per-repository write group cleanup.
 
1090
        
 
1091
        This is called before the write group is considered to be 
 
1092
        finished and should ensure that all data handed to the repository
 
1093
        for writing during the write group is safely committed (to the 
 
1094
        extent possible considering file system caching etc).
 
1095
        """
 
1096
 
 
1097
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
264
1098
        """Fetch the content required to construct revision_id from source.
265
1099
 
266
1100
        If revision_id is None all content is copied.
 
1101
        :param find_ghosts: Find and copy revisions in the source that are
 
1102
            ghosts in the target (and not reachable directly by walking out to
 
1103
            the first-present revision in target from revision_id).
267
1104
        """
268
 
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
269
 
                                                       pb=pb)
270
 
 
271
 
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
272
 
                           timezone=None, committer=None, revprops=None, 
 
1105
        # fast path same-url fetch operations
 
1106
        if self.has_same_location(source):
 
1107
            # check that last_revision is in 'from' and then return a
 
1108
            # no-operation.
 
1109
            if (revision_id is not None and
 
1110
                not _mod_revision.is_null(revision_id)):
 
1111
                self.get_revision(revision_id)
 
1112
            return 0, []
 
1113
        # if there is no specific appropriate InterRepository, this will get
 
1114
        # the InterRepository base class, which raises an
 
1115
        # IncompatibleRepositories when asked to fetch.
 
1116
        inter = InterRepository.get(source, self)
 
1117
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1118
            find_ghosts=find_ghosts)
 
1119
 
 
1120
    def create_bundle(self, target, base, fileobj, format=None):
 
1121
        return serializer.write_bundle(self, target, base, fileobj, format)
 
1122
 
 
1123
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
1124
                           timezone=None, committer=None, revprops=None,
273
1125
                           revision_id=None):
274
1126
        """Obtain a CommitBuilder for this repository.
275
1127
        
282
1134
        :param revprops: Optional dictionary of revision properties.
283
1135
        :param revision_id: Optional revision id.
284
1136
        """
285
 
        return _CommitBuilder(self, parents, config, timestamp, timezone,
286
 
                              committer, revprops, revision_id)
 
1137
        result = self._commit_builder_class(self, parents, config,
 
1138
            timestamp, timezone, committer, revprops, revision_id)
 
1139
        self.start_write_group()
 
1140
        return result
287
1141
 
288
1142
    def unlock(self):
 
1143
        if (self.control_files._lock_count == 1 and
 
1144
            self.control_files._lock_mode == 'w'):
 
1145
            if self._write_group is not None:
 
1146
                self.abort_write_group()
 
1147
                self.control_files.unlock()
 
1148
                raise errors.BzrError(
 
1149
                    'Must end write groups before releasing write locks.')
289
1150
        self.control_files.unlock()
 
1151
        if self.control_files._lock_count == 0:
 
1152
            self._inventory_entry_cache.clear()
 
1153
        for repo in self._fallback_repositories:
 
1154
            repo.unlock()
290
1155
 
291
1156
    @needs_read_lock
292
 
    def clone(self, a_bzrdir, revision_id=None, basis=None):
 
1157
    def clone(self, a_bzrdir, revision_id=None):
293
1158
        """Clone this repository into a_bzrdir using the current format.
294
1159
 
295
1160
        Currently no check is made that the format of this repository and
296
1161
        the bzrdir format are compatible. FIXME RBC 20060201.
297
 
        """
 
1162
 
 
1163
        :return: The newly created destination repository.
 
1164
        """
 
1165
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
1166
        # probably not very useful -- mbp 20070423
 
1167
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
1168
        self.copy_content_into(dest_repo, revision_id)
 
1169
        return dest_repo
 
1170
 
 
1171
    def start_write_group(self):
 
1172
        """Start a write group in the repository.
 
1173
 
 
1174
        Write groups are used by repositories which do not have a 1:1 mapping
 
1175
        between file ids and backend store to manage the insertion of data from
 
1176
        both fetch and commit operations.
 
1177
 
 
1178
        A write lock is required around the start_write_group/commit_write_group
 
1179
        for the support of lock-requiring repository formats.
 
1180
 
 
1181
        One can only insert data into a repository inside a write group.
 
1182
 
 
1183
        :return: None.
 
1184
        """
 
1185
        if not self.is_write_locked():
 
1186
            raise errors.NotWriteLocked(self)
 
1187
        if self._write_group:
 
1188
            raise errors.BzrError('already in a write group')
 
1189
        self._start_write_group()
 
1190
        # so we can detect unlock/relock - the write group is now entered.
 
1191
        self._write_group = self.get_transaction()
 
1192
 
 
1193
    def _start_write_group(self):
 
1194
        """Template method for per-repository write group startup.
 
1195
        
 
1196
        This is called before the write group is considered to be 
 
1197
        entered.
 
1198
        """
 
1199
 
 
1200
    @needs_read_lock
 
1201
    def sprout(self, to_bzrdir, revision_id=None):
 
1202
        """Create a descendent repository for new development.
 
1203
 
 
1204
        Unlike clone, this does not copy the settings of the repository.
 
1205
        """
 
1206
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
1207
        dest_repo.fetch(self, revision_id=revision_id)
 
1208
        return dest_repo
 
1209
 
 
1210
    def _create_sprouting_repo(self, a_bzrdir, shared):
298
1211
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
299
1212
            # use target default format.
300
 
            result = a_bzrdir.create_repository()
301
 
        # FIXME RBC 20060209 split out the repository type to avoid this check ?
302
 
        elif isinstance(a_bzrdir._format,
303
 
                      (bzrdir.BzrDirFormat4,
304
 
                       bzrdir.BzrDirFormat5,
305
 
                       bzrdir.BzrDirFormat6)):
306
 
            result = a_bzrdir.open_repository()
 
1213
            dest_repo = a_bzrdir.create_repository()
307
1214
        else:
308
 
            result = self._format.initialize(a_bzrdir, shared=self.is_shared())
309
 
        self.copy_content_into(result, revision_id, basis)
310
 
        return result
 
1215
            # Most control formats need the repository to be specifically
 
1216
            # created, but on some old all-in-one formats it's not needed
 
1217
            try:
 
1218
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1219
            except errors.UninitializableFormat:
 
1220
                dest_repo = a_bzrdir.open_repository()
 
1221
        return dest_repo
311
1222
 
312
1223
    @needs_read_lock
313
1224
    def has_revision(self, revision_id):
314
1225
        """True if this repository has a copy of the revision."""
315
 
        return self._revision_store.has_revision_id(revision_id,
316
 
                                                    self.get_transaction())
 
1226
        return revision_id in self.has_revisions((revision_id,))
 
1227
 
 
1228
    @needs_read_lock
 
1229
    def has_revisions(self, revision_ids):
 
1230
        """Probe to find out the presence of multiple revisions.
 
1231
 
 
1232
        :param revision_ids: An iterable of revision_ids.
 
1233
        :return: A set of the revision_ids that were present.
 
1234
        """
 
1235
        parent_map = self.revisions.get_parent_map(
 
1236
            [(rev_id,) for rev_id in revision_ids])
 
1237
        result = set()
 
1238
        if _mod_revision.NULL_REVISION in revision_ids:
 
1239
            result.add(_mod_revision.NULL_REVISION)
 
1240
        result.update([key[0] for key in parent_map])
 
1241
        return result
 
1242
 
 
1243
    @needs_read_lock
 
1244
    def get_revision(self, revision_id):
 
1245
        """Return the Revision object for a named revision."""
 
1246
        return self.get_revisions([revision_id])[0]
317
1247
 
318
1248
    @needs_read_lock
319
1249
    def get_revision_reconcile(self, revision_id):
324
1254
        be used by reconcile, or reconcile-alike commands that are correcting
325
1255
        or testing the revision graph.
326
1256
        """
327
 
        if not revision_id or not isinstance(revision_id, basestring):
328
 
            raise errors.InvalidRevisionId(revision_id=revision_id,
329
 
                                           branch=self)
330
 
        return self._revision_store.get_revisions([revision_id],
331
 
                                                  self.get_transaction())[0]
 
1257
        return self._get_revisions([revision_id])[0]
 
1258
 
332
1259
    @needs_read_lock
333
1260
    def get_revisions(self, revision_ids):
334
 
        return self._revision_store.get_revisions(revision_ids,
335
 
                                                  self.get_transaction())
 
1261
        """Get many revisions at once."""
 
1262
        return self._get_revisions(revision_ids)
 
1263
 
 
1264
    @needs_read_lock
 
1265
    def _get_revisions(self, revision_ids):
 
1266
        """Core work logic to get many revisions without sanity checks."""
 
1267
        for rev_id in revision_ids:
 
1268
            if not rev_id or not isinstance(rev_id, basestring):
 
1269
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1270
        keys = [(key,) for key in revision_ids]
 
1271
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
 
1272
        revs = {}
 
1273
        for record in stream:
 
1274
            if record.storage_kind == 'absent':
 
1275
                raise errors.NoSuchRevision(self, record.key[0])
 
1276
            text = record.get_bytes_as('fulltext')
 
1277
            rev = self._serializer.read_revision_from_string(text)
 
1278
            revs[record.key[0]] = rev
 
1279
        return [revs[revid] for revid in revision_ids]
336
1280
 
337
1281
    @needs_read_lock
338
1282
    def get_revision_xml(self, revision_id):
339
 
        rev = self.get_revision(revision_id) 
340
 
        rev_tmp = StringIO()
 
1283
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1284
        #       would have already do it.
 
1285
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1286
        rev = self.get_revision(revision_id)
 
1287
        rev_tmp = cStringIO.StringIO()
341
1288
        # the current serializer..
342
 
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1289
        self._serializer.write_revision(rev, rev_tmp)
343
1290
        rev_tmp.seek(0)
344
1291
        return rev_tmp.getvalue()
345
1292
 
346
 
    @needs_read_lock
347
 
    def get_revision(self, revision_id):
348
 
        """Return the Revision object for a named revision"""
349
 
        r = self.get_revision_reconcile(revision_id)
350
 
        # weave corruption can lead to absent revision markers that should be
351
 
        # present.
352
 
        # the following test is reasonably cheap (it needs a single weave read)
353
 
        # and the weave is cached in read transactions. In write transactions
354
 
        # it is not cached but typically we only read a small number of
355
 
        # revisions. For knits when they are introduced we will probably want
356
 
        # to ensure that caching write transactions are in use.
357
 
        inv = self.get_inventory_weave()
358
 
        self._check_revision_parents(r, inv)
359
 
        return r
360
 
 
361
 
    @needs_read_lock
362
1293
    def get_deltas_for_revisions(self, revisions):
363
1294
        """Produce a generator of revision deltas.
364
1295
        
374
1305
                     t in self.revision_trees(required_trees))
375
1306
        for revision in revisions:
376
1307
            if not revision.parent_ids:
377
 
                old_tree = self.revision_tree(None)
 
1308
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
378
1309
            else:
379
1310
                old_tree = trees[revision.parent_ids[0]]
380
1311
            yield trees[revision.revision_id].changes_from(old_tree)
389
1320
        r = self.get_revision(revision_id)
390
1321
        return list(self.get_deltas_for_revisions([r]))[0]
391
1322
 
392
 
    def _check_revision_parents(self, revision, inventory):
393
 
        """Private to Repository and Fetch.
394
 
        
395
 
        This checks the parentage of revision in an inventory weave for 
396
 
        consistency and is only applicable to inventory-weave-for-ancestry
397
 
        using repository formats & fetchers.
398
 
        """
399
 
        weave_parents = inventory.get_parents(revision.revision_id)
400
 
        weave_names = inventory.versions()
401
 
        for parent_id in revision.parent_ids:
402
 
            if parent_id in weave_names:
403
 
                # this parent must not be a ghost.
404
 
                if not parent_id in weave_parents:
405
 
                    # but it is a ghost
406
 
                    raise errors.CorruptRepository(self)
407
 
 
408
1323
    @needs_write_lock
409
1324
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
410
1325
        signature = gpg_strategy.sign(plaintext)
411
 
        self._revision_store.add_revision_signature_text(revision_id,
412
 
                                                         signature,
413
 
                                                         self.get_transaction())
414
 
 
415
 
    def fileids_altered_by_revision_ids(self, revision_ids):
416
 
        """Find the file ids and versions affected by revisions.
417
 
 
418
 
        :param revisions: an iterable containing revision ids.
419
 
        :return: a dictionary mapping altered file-ids to an iterable of
 
1326
        self.add_signature_text(revision_id, signature)
 
1327
 
 
1328
    @needs_write_lock
 
1329
    def add_signature_text(self, revision_id, signature):
 
1330
        self.signatures.add_lines((revision_id,), (),
 
1331
            osutils.split_lines(signature))
 
1332
 
 
1333
    def find_text_key_references(self):
 
1334
        """Find the text key references within the repository.
 
1335
 
 
1336
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
420
1337
        revision_ids. Each altered file-ids has the exact revision_ids that
421
1338
        altered it listed explicitly.
422
 
        """
423
 
        assert self._serializer.support_altered_by_hack, \
424
 
            ("fileids_altered_by_revision_ids only supported for branches " 
425
 
             "which store inventory as unnested xml, not on %r" % self)
426
 
        selected_revision_ids = set(revision_ids)
427
 
        w = self.get_inventory_weave()
 
1339
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1340
            to whether they were referred to by the inventory of the
 
1341
            revision_id that they contain. The inventory texts from all present
 
1342
            revision ids are assessed to generate this report.
 
1343
        """
 
1344
        revision_keys = self.revisions.keys()
 
1345
        w = self.inventories
 
1346
        pb = ui.ui_factory.nested_progress_bar()
 
1347
        try:
 
1348
            return self._find_text_key_references_from_xml_inventory_lines(
 
1349
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1350
        finally:
 
1351
            pb.finished()
 
1352
 
 
1353
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1354
        line_iterator):
 
1355
        """Core routine for extracting references to texts from inventories.
 
1356
 
 
1357
        This performs the translation of xml lines to revision ids.
 
1358
 
 
1359
        :param line_iterator: An iterator of lines, origin_version_id
 
1360
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1361
            to whether they were referred to by the inventory of the
 
1362
            revision_id that they contain. Note that if that revision_id was
 
1363
            not part of the line_iterator's output then False will be given -
 
1364
            even though it may actually refer to that key.
 
1365
        """
 
1366
        if not self._serializer.support_altered_by_hack:
 
1367
            raise AssertionError(
 
1368
                "_find_text_key_references_from_xml_inventory_lines only "
 
1369
                "supported for branches which store inventory as unnested xml"
 
1370
                ", not on %r" % self)
428
1371
        result = {}
429
1372
 
430
1373
        # this code needs to read every new line in every inventory for the
435
1378
        # revisions. We don't need to see all lines in the inventory because
436
1379
        # only those added in an inventory in rev X can contain a revision=X
437
1380
        # line.
438
 
        pb = ui.ui_factory.nested_progress_bar()
439
 
        try:
440
 
            for line in w.iter_lines_added_or_present_in_versions(
441
 
                selected_revision_ids, pb=pb):
442
 
                start = line.find('file_id="')+9
443
 
                if start < 9: continue
444
 
                end = line.find('"', start)
445
 
                assert end>= 0
446
 
                file_id = _unescape_xml(line[start:end])
447
 
 
448
 
                start = line.find('revision="')+10
449
 
                if start < 10: continue
450
 
                end = line.find('"', start)
451
 
                assert end>= 0
452
 
                revision_id = _unescape_xml(line[start:end])
453
 
                if revision_id in selected_revision_ids:
454
 
                    result.setdefault(file_id, set()).add(revision_id)
455
 
        finally:
456
 
            pb.finished()
457
 
        return result
458
 
 
459
 
    @needs_read_lock
460
 
    def get_inventory_weave(self):
461
 
        return self.control_weaves.get_weave('inventory',
462
 
            self.get_transaction())
 
1381
        unescape_revid_cache = {}
 
1382
        unescape_fileid_cache = {}
 
1383
 
 
1384
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
1385
        # of lines, so it has had a lot of inlining and optimizing done.
 
1386
        # Sorry that it is a little bit messy.
 
1387
        # Move several functions to be local variables, since this is a long
 
1388
        # running loop.
 
1389
        search = self._file_ids_altered_regex.search
 
1390
        unescape = _unescape_xml
 
1391
        setdefault = result.setdefault
 
1392
        for line, line_key in line_iterator:
 
1393
            match = search(line)
 
1394
            if match is None:
 
1395
                continue
 
1396
            # One call to match.group() returning multiple items is quite a
 
1397
            # bit faster than 2 calls to match.group() each returning 1
 
1398
            file_id, revision_id = match.group('file_id', 'revision_id')
 
1399
 
 
1400
            # Inlining the cache lookups helps a lot when you make 170,000
 
1401
            # lines and 350k ids, versus 8.4 unique ids.
 
1402
            # Using a cache helps in 2 ways:
 
1403
            #   1) Avoids unnecessary decoding calls
 
1404
            #   2) Re-uses cached strings, which helps in future set and
 
1405
            #      equality checks.
 
1406
            # (2) is enough that removing encoding entirely along with
 
1407
            # the cache (so we are using plain strings) results in no
 
1408
            # performance improvement.
 
1409
            try:
 
1410
                revision_id = unescape_revid_cache[revision_id]
 
1411
            except KeyError:
 
1412
                unescaped = unescape(revision_id)
 
1413
                unescape_revid_cache[revision_id] = unescaped
 
1414
                revision_id = unescaped
 
1415
 
 
1416
            # Note that unconditionally unescaping means that we deserialise
 
1417
            # every fileid, which for general 'pull' is not great, but we don't
 
1418
            # really want to have some many fulltexts that this matters anyway.
 
1419
            # RBC 20071114.
 
1420
            try:
 
1421
                file_id = unescape_fileid_cache[file_id]
 
1422
            except KeyError:
 
1423
                unescaped = unescape(file_id)
 
1424
                unescape_fileid_cache[file_id] = unescaped
 
1425
                file_id = unescaped
 
1426
 
 
1427
            key = (file_id, revision_id)
 
1428
            setdefault(key, False)
 
1429
            if revision_id == line_key[-1]:
 
1430
                result[key] = True
 
1431
        return result
 
1432
 
 
1433
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
1434
        revision_ids):
 
1435
        """Helper routine for fileids_altered_by_revision_ids.
 
1436
 
 
1437
        This performs the translation of xml lines to revision ids.
 
1438
 
 
1439
        :param line_iterator: An iterator of lines, origin_version_id
 
1440
        :param revision_ids: The revision ids to filter for. This should be a
 
1441
            set or other type which supports efficient __contains__ lookups, as
 
1442
            the revision id from each parsed line will be looked up in the
 
1443
            revision_ids filter.
 
1444
        :return: a dictionary mapping altered file-ids to an iterable of
 
1445
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1446
        altered it listed explicitly.
 
1447
        """
 
1448
        result = {}
 
1449
        setdefault = result.setdefault
 
1450
        for key in \
 
1451
            self._find_text_key_references_from_xml_inventory_lines(
 
1452
                line_iterator).iterkeys():
 
1453
            # once data is all ensured-consistent; then this is
 
1454
            # if revision_id == version_id
 
1455
            if key[-1:] in revision_ids:
 
1456
                setdefault(key[0], set()).add(key[-1])
 
1457
        return result
 
1458
 
 
1459
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
 
1460
        """Find the file ids and versions affected by revisions.
 
1461
 
 
1462
        :param revisions: an iterable containing revision ids.
 
1463
        :param _inv_weave: The inventory weave from this repository or None.
 
1464
            If None, the inventory weave will be opened automatically.
 
1465
        :return: a dictionary mapping altered file-ids to an iterable of
 
1466
        revision_ids. Each altered file-ids has the exact revision_ids that
 
1467
        altered it listed explicitly.
 
1468
        """
 
1469
        selected_keys = set((revid,) for revid in revision_ids)
 
1470
        w = _inv_weave or self.inventories
 
1471
        pb = ui.ui_factory.nested_progress_bar()
 
1472
        try:
 
1473
            return self._find_file_ids_from_xml_inventory_lines(
 
1474
                w.iter_lines_added_or_present_in_keys(
 
1475
                    selected_keys, pb=pb),
 
1476
                selected_keys)
 
1477
        finally:
 
1478
            pb.finished()
 
1479
 
 
1480
    def iter_files_bytes(self, desired_files):
 
1481
        """Iterate through file versions.
 
1482
 
 
1483
        Files will not necessarily be returned in the order they occur in
 
1484
        desired_files.  No specific order is guaranteed.
 
1485
 
 
1486
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
1487
        value supplied by the caller as part of desired_files.  It should
 
1488
        uniquely identify the file version in the caller's context.  (Examples:
 
1489
        an index number or a TreeTransform trans_id.)
 
1490
 
 
1491
        bytes_iterator is an iterable of bytestrings for the file.  The
 
1492
        kind of iterable and length of the bytestrings are unspecified, but for
 
1493
        this implementation, it is a list of bytes produced by
 
1494
        VersionedFile.get_record_stream().
 
1495
 
 
1496
        :param desired_files: a list of (file_id, revision_id, identifier)
 
1497
            triples
 
1498
        """
 
1499
        text_keys = {}
 
1500
        for file_id, revision_id, callable_data in desired_files:
 
1501
            text_keys[(file_id, revision_id)] = callable_data
 
1502
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
 
1503
            if record.storage_kind == 'absent':
 
1504
                raise errors.RevisionNotPresent(record.key, self)
 
1505
            yield text_keys[record.key], record.get_bytes_as('fulltext')
 
1506
 
 
1507
    def _generate_text_key_index(self, text_key_references=None,
 
1508
        ancestors=None):
 
1509
        """Generate a new text key index for the repository.
 
1510
 
 
1511
        This is an expensive function that will take considerable time to run.
 
1512
 
 
1513
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
1514
            list of parents, also text keys. When a given key has no parents,
 
1515
            the parents list will be [NULL_REVISION].
 
1516
        """
 
1517
        # All revisions, to find inventory parents.
 
1518
        if ancestors is None:
 
1519
            graph = self.get_graph()
 
1520
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
1521
        if text_key_references is None:
 
1522
            text_key_references = self.find_text_key_references()
 
1523
        pb = ui.ui_factory.nested_progress_bar()
 
1524
        try:
 
1525
            return self._do_generate_text_key_index(ancestors,
 
1526
                text_key_references, pb)
 
1527
        finally:
 
1528
            pb.finished()
 
1529
 
 
1530
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
1531
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
1532
        revision_order = tsort.topo_sort(ancestors)
 
1533
        invalid_keys = set()
 
1534
        revision_keys = {}
 
1535
        for revision_id in revision_order:
 
1536
            revision_keys[revision_id] = set()
 
1537
        text_count = len(text_key_references)
 
1538
        # a cache of the text keys to allow reuse; costs a dict of all the
 
1539
        # keys, but saves a 2-tuple for every child of a given key.
 
1540
        text_key_cache = {}
 
1541
        for text_key, valid in text_key_references.iteritems():
 
1542
            if not valid:
 
1543
                invalid_keys.add(text_key)
 
1544
            else:
 
1545
                revision_keys[text_key[1]].add(text_key)
 
1546
            text_key_cache[text_key] = text_key
 
1547
        del text_key_references
 
1548
        text_index = {}
 
1549
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
1550
        NULL_REVISION = _mod_revision.NULL_REVISION
 
1551
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
1552
        # too small for large or very branchy trees. However, for 55K path
 
1553
        # trees, it would be easy to use too much memory trivially. Ideally we
 
1554
        # could gauge this by looking at available real memory etc, but this is
 
1555
        # always a tricky proposition.
 
1556
        inventory_cache = lru_cache.LRUCache(10)
 
1557
        batch_size = 10 # should be ~150MB on a 55K path tree
 
1558
        batch_count = len(revision_order) / batch_size + 1
 
1559
        processed_texts = 0
 
1560
        pb.update("Calculating text parents.", processed_texts, text_count)
 
1561
        for offset in xrange(batch_count):
 
1562
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
1563
                batch_size]
 
1564
            if not to_query:
 
1565
                break
 
1566
            for rev_tree in self.revision_trees(to_query):
 
1567
                revision_id = rev_tree.get_revision_id()
 
1568
                parent_ids = ancestors[revision_id]
 
1569
                for text_key in revision_keys[revision_id]:
 
1570
                    pb.update("Calculating text parents.", processed_texts)
 
1571
                    processed_texts += 1
 
1572
                    candidate_parents = []
 
1573
                    for parent_id in parent_ids:
 
1574
                        parent_text_key = (text_key[0], parent_id)
 
1575
                        try:
 
1576
                            check_parent = parent_text_key not in \
 
1577
                                revision_keys[parent_id]
 
1578
                        except KeyError:
 
1579
                            # the parent parent_id is a ghost:
 
1580
                            check_parent = False
 
1581
                            # truncate the derived graph against this ghost.
 
1582
                            parent_text_key = None
 
1583
                        if check_parent:
 
1584
                            # look at the parent commit details inventories to
 
1585
                            # determine possible candidates in the per file graph.
 
1586
                            # TODO: cache here.
 
1587
                            try:
 
1588
                                inv = inventory_cache[parent_id]
 
1589
                            except KeyError:
 
1590
                                inv = self.revision_tree(parent_id).inventory
 
1591
                                inventory_cache[parent_id] = inv
 
1592
                            parent_entry = inv._byid.get(text_key[0], None)
 
1593
                            if parent_entry is not None:
 
1594
                                parent_text_key = (
 
1595
                                    text_key[0], parent_entry.revision)
 
1596
                            else:
 
1597
                                parent_text_key = None
 
1598
                        if parent_text_key is not None:
 
1599
                            candidate_parents.append(
 
1600
                                text_key_cache[parent_text_key])
 
1601
                    parent_heads = text_graph.heads(candidate_parents)
 
1602
                    new_parents = list(parent_heads)
 
1603
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
1604
                    if new_parents == []:
 
1605
                        new_parents = [NULL_REVISION]
 
1606
                    text_index[text_key] = new_parents
 
1607
 
 
1608
        for text_key in invalid_keys:
 
1609
            text_index[text_key] = [NULL_REVISION]
 
1610
        return text_index
 
1611
 
 
1612
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1613
        """Get an iterable listing the keys of all the data introduced by a set
 
1614
        of revision IDs.
 
1615
 
 
1616
        The keys will be ordered so that the corresponding items can be safely
 
1617
        fetched and inserted in that order.
 
1618
 
 
1619
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
1620
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
1621
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
1622
        """
 
1623
        # XXX: it's a bit weird to control the inventory weave caching in this
 
1624
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
1625
        # maybe this generator should explicitly have the contract that it
 
1626
        # should not be iterated until the previously yielded item has been
 
1627
        # processed?
 
1628
        inv_w = self.inventories
 
1629
 
 
1630
        # file ids that changed
 
1631
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
1632
        count = 0
 
1633
        num_file_ids = len(file_ids)
 
1634
        for file_id, altered_versions in file_ids.iteritems():
 
1635
            if _files_pb is not None:
 
1636
                _files_pb.update("fetch texts", count, num_file_ids)
 
1637
            count += 1
 
1638
            yield ("file", file_id, altered_versions)
 
1639
        # We're done with the files_pb.  Note that it finished by the caller,
 
1640
        # just as it was created by the caller.
 
1641
        del _files_pb
 
1642
 
 
1643
        # inventory
 
1644
        yield ("inventory", None, revision_ids)
 
1645
 
 
1646
        # signatures
 
1647
        # XXX: Note ATM no callers actually pay attention to this return
 
1648
        #      instead they just use the list of revision ids and ignore
 
1649
        #      missing sigs. Consider removing this work entirely
 
1650
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
1651
            [(r,) for r in revision_ids]))
 
1652
        revisions_with_signatures = set(
 
1653
            [r for (r,) in revisions_with_signatures])
 
1654
        revisions_with_signatures.intersection_update(revision_ids)
 
1655
        yield ("signatures", None, revisions_with_signatures)
 
1656
 
 
1657
        # revisions
 
1658
        yield ("revisions", None, revision_ids)
463
1659
 
464
1660
    @needs_read_lock
465
1661
    def get_inventory(self, revision_id):
466
 
        """Get Inventory object by hash."""
467
 
        return self.deserialise_inventory(
468
 
            revision_id, self.get_inventory_xml(revision_id))
 
1662
        """Get Inventory object by revision id."""
 
1663
        return self.iter_inventories([revision_id]).next()
 
1664
 
 
1665
    def iter_inventories(self, revision_ids):
 
1666
        """Get many inventories by revision_ids.
 
1667
 
 
1668
        This will buffer some or all of the texts used in constructing the
 
1669
        inventories in memory, but will only parse a single inventory at a
 
1670
        time.
 
1671
 
 
1672
        :return: An iterator of inventories.
 
1673
        """
 
1674
        if ((None in revision_ids)
 
1675
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1676
            raise ValueError('cannot get null revision inventory')
 
1677
        return self._iter_inventories(revision_ids)
 
1678
 
 
1679
    def _iter_inventories(self, revision_ids):
 
1680
        """single-document based inventory iteration."""
 
1681
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
1682
            yield self.deserialise_inventory(revision_id, text)
 
1683
 
 
1684
    def _iter_inventory_xmls(self, revision_ids):
 
1685
        keys = [(revision_id,) for revision_id in revision_ids]
 
1686
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
1687
        text_chunks = {}
 
1688
        for record in stream:
 
1689
            if record.storage_kind != 'absent':
 
1690
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
1691
            else:
 
1692
                raise errors.NoSuchRevision(self, record.key)
 
1693
        for key in keys:
 
1694
            chunks = text_chunks.pop(key)
 
1695
            yield ''.join(chunks), key[-1]
469
1696
 
470
1697
    def deserialise_inventory(self, revision_id, xml):
471
1698
        """Transform the xml into an inventory object. 
473
1700
        :param revision_id: The expected revision id of the inventory.
474
1701
        :param xml: A serialised inventory.
475
1702
        """
476
 
        result = self._serializer.read_inventory_from_string(xml)
477
 
        result.root.revision = revision_id
 
1703
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
1704
                    entry_cache=self._inventory_entry_cache)
 
1705
        if result.revision_id != revision_id:
 
1706
            raise AssertionError('revision id mismatch %s != %s' % (
 
1707
                result.revision_id, revision_id))
478
1708
        return result
479
1709
 
480
1710
    def serialise_inventory(self, inv):
481
1711
        return self._serializer.write_inventory_to_string(inv)
482
1712
 
 
1713
    def _serialise_inventory_to_lines(self, inv):
 
1714
        return self._serializer.write_inventory_to_lines(inv)
 
1715
 
 
1716
    def get_serializer_format(self):
 
1717
        return self._serializer.format_num
 
1718
 
483
1719
    @needs_read_lock
484
1720
    def get_inventory_xml(self, revision_id):
485
1721
        """Get inventory XML as a file object."""
 
1722
        texts = self._iter_inventory_xmls([revision_id])
486
1723
        try:
487
 
            assert isinstance(revision_id, basestring), type(revision_id)
488
 
            iw = self.get_inventory_weave()
489
 
            return iw.get_text(revision_id)
490
 
        except IndexError:
 
1724
            text, revision_id = texts.next()
 
1725
        except StopIteration:
491
1726
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
1727
        return text
492
1728
 
493
1729
    @needs_read_lock
494
1730
    def get_inventory_sha1(self, revision_id):
496
1732
        """
497
1733
        return self.get_revision(revision_id).inventory_sha1
498
1734
 
499
 
    @needs_read_lock
500
 
    def get_revision_graph(self, revision_id=None):
501
 
        """Return a dictionary containing the revision graph.
502
 
        
503
 
        :param revision_id: The revision_id to get a graph from. If None, then
504
 
        the entire revision graph is returned. This is a deprecated mode of
505
 
        operation and will be removed in the future.
506
 
        :return: a dictionary of revision_id->revision_parents_list.
507
 
        """
508
 
        # special case NULL_REVISION
509
 
        if revision_id == _mod_revision.NULL_REVISION:
510
 
            return {}
511
 
        a_weave = self.get_inventory_weave()
512
 
        all_revisions = self._eliminate_revisions_not_present(
513
 
                                a_weave.versions())
514
 
        entire_graph = dict([(node, a_weave.get_parents(node)) for 
515
 
                             node in all_revisions])
516
 
        if revision_id is None:
517
 
            return entire_graph
518
 
        elif revision_id not in entire_graph:
519
 
            raise errors.NoSuchRevision(self, revision_id)
520
 
        else:
521
 
            # add what can be reached from revision_id
522
 
            result = {}
523
 
            pending = set([revision_id])
524
 
            while len(pending) > 0:
525
 
                node = pending.pop()
526
 
                result[node] = entire_graph[node]
527
 
                for revision_id in result[node]:
528
 
                    if revision_id not in result:
529
 
                        pending.add(revision_id)
530
 
            return result
531
 
 
532
 
    @needs_read_lock
533
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
534
 
        """Return a graph of the revisions with ghosts marked as applicable.
535
 
 
536
 
        :param revision_ids: an iterable of revisions to graph or None for all.
537
 
        :return: a Graph object with the graph reachable from revision_ids.
538
 
        """
539
 
        result = graph.Graph()
540
 
        if not revision_ids:
541
 
            pending = set(self.all_revision_ids())
542
 
            required = set([])
543
 
        else:
544
 
            pending = set(revision_ids)
545
 
            # special case NULL_REVISION
546
 
            if _mod_revision.NULL_REVISION in pending:
547
 
                pending.remove(_mod_revision.NULL_REVISION)
548
 
            required = set(pending)
549
 
        done = set([])
550
 
        while len(pending):
551
 
            revision_id = pending.pop()
552
 
            try:
553
 
                rev = self.get_revision(revision_id)
554
 
            except errors.NoSuchRevision:
555
 
                if revision_id in required:
556
 
                    raise
557
 
                # a ghost
558
 
                result.add_ghost(revision_id)
559
 
                continue
560
 
            for parent_id in rev.parent_ids:
561
 
                # is this queued or done ?
562
 
                if (parent_id not in pending and
563
 
                    parent_id not in done):
564
 
                    # no, queue it.
565
 
                    pending.add(parent_id)
566
 
            result.add_node(revision_id, rev.parent_ids)
567
 
            done.add(revision_id)
568
 
        return result
 
1735
    def iter_reverse_revision_history(self, revision_id):
 
1736
        """Iterate backwards through revision ids in the lefthand history
 
1737
 
 
1738
        :param revision_id: The revision id to start with.  All its lefthand
 
1739
            ancestors will be traversed.
 
1740
        """
 
1741
        graph = self.get_graph()
 
1742
        next_id = revision_id
 
1743
        while True:
 
1744
            if next_id in (None, _mod_revision.NULL_REVISION):
 
1745
                return
 
1746
            yield next_id
 
1747
            # Note: The following line may raise KeyError in the event of
 
1748
            # truncated history. We decided not to have a try:except:raise
 
1749
            # RevisionNotPresent here until we see a use for it, because of the
 
1750
            # cost in an inner loop that is by its very nature O(history).
 
1751
            # Robert Collins 20080326
 
1752
            parents = graph.get_parent_map([next_id])[next_id]
 
1753
            if len(parents) == 0:
 
1754
                return
 
1755
            else:
 
1756
                next_id = parents[0]
569
1757
 
570
1758
    @needs_read_lock
571
1759
    def get_revision_inventory(self, revision_id):
583
1771
        else:
584
1772
            return self.get_inventory(revision_id)
585
1773
 
586
 
    @needs_read_lock
587
1774
    def is_shared(self):
588
1775
        """Return True if this repository is flagged as a shared repository."""
589
1776
        raise NotImplementedError(self.is_shared)
595
1782
        reconciler = RepoReconciler(self, thorough=thorough)
596
1783
        reconciler.reconcile()
597
1784
        return reconciler
598
 
    
 
1785
 
 
1786
    def _refresh_data(self):
 
1787
        """Helper called from lock_* to ensure coherency with disk.
 
1788
 
 
1789
        The default implementation does nothing; it is however possible
 
1790
        for repositories to maintain loaded indices across multiple locks
 
1791
        by checking inside their implementation of this method to see
 
1792
        whether their indices are still valid. This depends of course on
 
1793
        the disk format being validatable in this manner.
 
1794
        """
 
1795
 
599
1796
    @needs_read_lock
600
1797
    def revision_tree(self, revision_id):
601
1798
        """Return Tree for a revision on this branch.
602
1799
 
603
 
        `revision_id` may be None for the empty tree revision.
 
1800
        `revision_id` may be NULL_REVISION for the empty tree revision.
604
1801
        """
 
1802
        revision_id = _mod_revision.ensure_null(revision_id)
605
1803
        # TODO: refactor this to use an existing revision object
606
1804
        # so we don't need to read it in twice.
607
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1805
        if revision_id == _mod_revision.NULL_REVISION:
608
1806
            return RevisionTree(self, Inventory(root_id=None), 
609
1807
                                _mod_revision.NULL_REVISION)
610
1808
        else:
611
1809
            inv = self.get_revision_inventory(revision_id)
612
1810
            return RevisionTree(self, inv, revision_id)
613
1811
 
614
 
    @needs_read_lock
615
1812
    def revision_trees(self, revision_ids):
616
1813
        """Return Tree for a revision on this branch.
617
1814
 
618
1815
        `revision_id` may not be None or 'null:'"""
619
 
        assert None not in revision_ids
620
 
        assert _mod_revision.NULL_REVISION not in revision_ids
621
 
        texts = self.get_inventory_weave().get_texts(revision_ids)
622
 
        for text, revision_id in zip(texts, revision_ids):
623
 
            inv = self.deserialise_inventory(revision_id, text)
624
 
            yield RevisionTree(self, inv, revision_id)
 
1816
        inventories = self.iter_inventories(revision_ids)
 
1817
        for inv in inventories:
 
1818
            yield RevisionTree(self, inv, inv.revision_id)
625
1819
 
626
1820
    @needs_read_lock
627
 
    def get_ancestry(self, revision_id):
 
1821
    def get_ancestry(self, revision_id, topo_sorted=True):
628
1822
        """Return a list of revision-ids integrated by a revision.
629
1823
 
630
1824
        The first element of the list is always None, indicating the origin 
633
1827
        
634
1828
        This is topologically sorted.
635
1829
        """
636
 
        if revision_id is None:
 
1830
        if _mod_revision.is_null(revision_id):
637
1831
            return [None]
638
1832
        if not self.has_revision(revision_id):
639
1833
            raise errors.NoSuchRevision(self, revision_id)
640
 
        w = self.get_inventory_weave()
641
 
        candidates = w.get_ancestry(revision_id)
642
 
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
1834
        graph = self.get_graph()
 
1835
        keys = set()
 
1836
        search = graph._make_breadth_first_searcher([revision_id])
 
1837
        while True:
 
1838
            try:
 
1839
                found, ghosts = search.next_with_ghosts()
 
1840
            except StopIteration:
 
1841
                break
 
1842
            keys.update(found)
 
1843
        if _mod_revision.NULL_REVISION in keys:
 
1844
            keys.remove(_mod_revision.NULL_REVISION)
 
1845
        if topo_sorted:
 
1846
            parent_map = graph.get_parent_map(keys)
 
1847
            keys = tsort.topo_sort(parent_map)
 
1848
        return [None] + list(keys)
 
1849
 
 
1850
    def pack(self):
 
1851
        """Compress the data within the repository.
 
1852
 
 
1853
        This operation only makes sense for some repository types. For other
 
1854
        types it should be a no-op that just returns.
 
1855
 
 
1856
        This stub method does not require a lock, but subclasses should use
 
1857
        @needs_write_lock as this is a long running call its reasonable to 
 
1858
        implicitly lock for the user.
 
1859
        """
643
1860
 
644
1861
    @needs_read_lock
 
1862
    @deprecated_method(one_six)
645
1863
    def print_file(self, file, revision_id):
646
1864
        """Print `file` to stdout.
647
1865
        
662
1880
    def get_transaction(self):
663
1881
        return self.control_files.get_transaction()
664
1882
 
665
 
    def revision_parents(self, revid):
666
 
        return self.get_inventory_weave().parent_names(revid)
 
1883
    @deprecated_method(one_one)
 
1884
    def get_parents(self, revision_ids):
 
1885
        """See StackedParentsProvider.get_parents"""
 
1886
        parent_map = self.get_parent_map(revision_ids)
 
1887
        return [parent_map.get(r, None) for r in revision_ids]
 
1888
 
 
1889
    def get_parent_map(self, revision_ids):
 
1890
        """See graph._StackedParentsProvider.get_parent_map"""
 
1891
        # revisions index works in keys; this just works in revisions
 
1892
        # therefore wrap and unwrap
 
1893
        query_keys = []
 
1894
        result = {}
 
1895
        for revision_id in revision_ids:
 
1896
            if revision_id == _mod_revision.NULL_REVISION:
 
1897
                result[revision_id] = ()
 
1898
            elif revision_id is None:
 
1899
                raise ValueError('get_parent_map(None) is not valid')
 
1900
            else:
 
1901
                query_keys.append((revision_id ,))
 
1902
        for ((revision_id,), parent_keys) in \
 
1903
                self.revisions.get_parent_map(query_keys).iteritems():
 
1904
            if parent_keys:
 
1905
                result[revision_id] = tuple(parent_revid
 
1906
                    for (parent_revid,) in parent_keys)
 
1907
            else:
 
1908
                result[revision_id] = (_mod_revision.NULL_REVISION,)
 
1909
        return result
 
1910
 
 
1911
    def _make_parents_provider(self):
 
1912
        return self
 
1913
 
 
1914
    def get_graph(self, other_repository=None):
 
1915
        """Return the graph walker for this repository format"""
 
1916
        parents_provider = self._make_parents_provider()
 
1917
        if (other_repository is not None and
 
1918
            not self.has_same_location(other_repository)):
 
1919
            parents_provider = graph._StackedParentsProvider(
 
1920
                [parents_provider, other_repository._make_parents_provider()])
 
1921
        return graph.Graph(parents_provider)
 
1922
 
 
1923
    def _get_versioned_file_checker(self):
 
1924
        """Return an object suitable for checking versioned files."""
 
1925
        return _VersionedFileChecker(self)
 
1926
 
 
1927
    def revision_ids_to_search_result(self, result_set):
 
1928
        """Convert a set of revision ids to a graph SearchResult."""
 
1929
        result_parents = set()
 
1930
        for parents in self.get_graph().get_parent_map(
 
1931
            result_set).itervalues():
 
1932
            result_parents.update(parents)
 
1933
        included_keys = result_set.intersection(result_parents)
 
1934
        start_keys = result_set.difference(included_keys)
 
1935
        exclude_keys = result_parents.difference(result_set)
 
1936
        result = graph.SearchResult(start_keys, exclude_keys,
 
1937
            len(result_set), result_set)
 
1938
        return result
667
1939
 
668
1940
    @needs_write_lock
669
1941
    def set_make_working_trees(self, new_value):
689
1961
    @needs_read_lock
690
1962
    def has_signature_for_revision_id(self, revision_id):
691
1963
        """Query for a revision signature for revision_id in the repository."""
692
 
        return self._revision_store.has_signature(revision_id,
693
 
                                                  self.get_transaction())
 
1964
        if not self.has_revision(revision_id):
 
1965
            raise errors.NoSuchRevision(self, revision_id)
 
1966
        sig_present = (1 == len(
 
1967
            self.signatures.get_parent_map([(revision_id,)])))
 
1968
        return sig_present
694
1969
 
695
1970
    @needs_read_lock
696
1971
    def get_signature_text(self, revision_id):
697
1972
        """Return the text for a signature."""
698
 
        return self._revision_store.get_signature_text(revision_id,
699
 
                                                       self.get_transaction())
 
1973
        stream = self.signatures.get_record_stream([(revision_id,)],
 
1974
            'unordered', True)
 
1975
        record = stream.next()
 
1976
        if record.storage_kind == 'absent':
 
1977
            raise errors.NoSuchRevision(self, revision_id)
 
1978
        return record.get_bytes_as('fulltext')
700
1979
 
701
1980
    @needs_read_lock
702
 
    def check(self, revision_ids):
 
1981
    def check(self, revision_ids=None):
703
1982
        """Check consistency of all history of given revision_ids.
704
1983
 
705
1984
        Different repository implementations should override _check().
707
1986
        :param revision_ids: A non-empty list of revision_ids whose ancestry
708
1987
             will be checked.  Typically the last revision_id of a branch.
709
1988
        """
710
 
        if not revision_ids:
711
 
            raise ValueError("revision_ids must be non-empty in %s.check" 
712
 
                    % (self,))
713
1989
        return self._check(revision_ids)
714
1990
 
715
1991
    def _check(self, revision_ids):
728
2004
    def supports_rich_root(self):
729
2005
        return self._format.rich_root_data
730
2006
 
731
 
 
732
 
class AllInOneRepository(Repository):
733
 
    """Legacy support - the repository behaviour for all-in-one branches."""
734
 
 
735
 
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
736
 
        # we reuse one control files instance.
737
 
        dir_mode = a_bzrdir._control_files._dir_mode
738
 
        file_mode = a_bzrdir._control_files._file_mode
739
 
 
740
 
        def get_store(name, compressed=True, prefixed=False):
741
 
            # FIXME: This approach of assuming stores are all entirely compressed
742
 
            # or entirely uncompressed is tidy, but breaks upgrade from 
743
 
            # some existing branches where there's a mixture; we probably 
744
 
            # still want the option to look for both.
745
 
            relpath = a_bzrdir._control_files._escape(name)
746
 
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
747
 
                              prefixed=prefixed, compressed=compressed,
748
 
                              dir_mode=dir_mode,
749
 
                              file_mode=file_mode)
750
 
            #if self._transport.should_cache():
751
 
            #    cache_path = os.path.join(self.cache_root, name)
752
 
            #    os.mkdir(cache_path)
753
 
            #    store = bzrlib.store.CachedStore(store, cache_path)
754
 
            return store
755
 
 
756
 
        # not broken out yet because the controlweaves|inventory_store
757
 
        # and text_store | weave_store bits are still different.
758
 
        if isinstance(_format, RepositoryFormat4):
759
 
            # cannot remove these - there is still no consistent api 
760
 
            # which allows access to this old info.
761
 
            self.inventory_store = get_store('inventory-store')
762
 
            text_store = get_store('text-store')
763
 
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
764
 
 
765
 
    @needs_read_lock
766
 
    def is_shared(self):
767
 
        """AllInOne repositories cannot be shared."""
768
 
        return False
769
 
 
770
 
    @needs_write_lock
771
 
    def set_make_working_trees(self, new_value):
772
 
        """Set the policy flag for making working trees when creating branches.
773
 
 
774
 
        This only applies to branches that use this repository.
775
 
 
776
 
        The default is 'True'.
777
 
        :param new_value: True to restore the default, False to disable making
778
 
                          working trees.
 
2007
    def _check_ascii_revisionid(self, revision_id, method):
 
2008
        """Private helper for ascii-only repositories."""
 
2009
        # weave repositories refuse to store revisionids that are non-ascii.
 
2010
        if revision_id is not None:
 
2011
            # weaves require ascii revision ids.
 
2012
            if isinstance(revision_id, unicode):
 
2013
                try:
 
2014
                    revision_id.encode('ascii')
 
2015
                except UnicodeEncodeError:
 
2016
                    raise errors.NonAsciiRevisionId(method, self)
 
2017
            else:
 
2018
                try:
 
2019
                    revision_id.decode('ascii')
 
2020
                except UnicodeDecodeError:
 
2021
                    raise errors.NonAsciiRevisionId(method, self)
 
2022
    
 
2023
    def revision_graph_can_have_wrong_parents(self):
 
2024
        """Is it possible for this repository to have a revision graph with
 
2025
        incorrect parents?
 
2026
 
 
2027
        If True, then this repository must also implement
 
2028
        _find_inconsistent_revision_parents so that check and reconcile can
 
2029
        check for inconsistencies before proceeding with other checks that may
 
2030
        depend on the revision index being consistent.
779
2031
        """
780
 
        raise NotImplementedError(self.set_make_working_trees)
781
 
    
782
 
    def make_working_trees(self):
783
 
        """Returns the policy for making working trees on new branches."""
784
 
        return True
 
2032
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
2033
 
 
2034
 
 
2035
# remove these delegates a while after bzr 0.15
 
2036
def __make_delegated(name, from_module):
 
2037
    def _deprecated_repository_forwarder():
 
2038
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
2039
            % (name, from_module),
 
2040
            DeprecationWarning,
 
2041
            stacklevel=2)
 
2042
        m = __import__(from_module, globals(), locals(), [name])
 
2043
        try:
 
2044
            return getattr(m, name)
 
2045
        except AttributeError:
 
2046
            raise AttributeError('module %s has no name %s'
 
2047
                    % (m, name))
 
2048
    globals()[name] = _deprecated_repository_forwarder
 
2049
 
 
2050
for _name in [
 
2051
        'AllInOneRepository',
 
2052
        'WeaveMetaDirRepository',
 
2053
        'PreSplitOutRepositoryFormat',
 
2054
        'RepositoryFormat4',
 
2055
        'RepositoryFormat5',
 
2056
        'RepositoryFormat6',
 
2057
        'RepositoryFormat7',
 
2058
        ]:
 
2059
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
2060
 
 
2061
for _name in [
 
2062
        'KnitRepository',
 
2063
        'RepositoryFormatKnit',
 
2064
        'RepositoryFormatKnit1',
 
2065
        ]:
 
2066
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
785
2067
 
786
2068
 
787
2069
def install_revision(repository, rev, revision_tree):
788
2070
    """Install all revision data into a repository."""
 
2071
    install_revisions(repository, [(rev, revision_tree, None)])
 
2072
 
 
2073
 
 
2074
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
2075
    """Install all revision data into a repository.
 
2076
 
 
2077
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
2078
    may be None.
 
2079
    """
 
2080
    repository.start_write_group()
 
2081
    try:
 
2082
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
2083
            _install_revision(repository, revision, revision_tree, signature)
 
2084
            if pb is not None:
 
2085
                pb.update('Transferring revisions', n + 1, num_revisions)
 
2086
    except:
 
2087
        repository.abort_write_group()
 
2088
        raise
 
2089
    else:
 
2090
        repository.commit_write_group()
 
2091
 
 
2092
 
 
2093
def _install_revision(repository, rev, revision_tree, signature):
 
2094
    """Install all revision data into a repository."""
789
2095
    present_parents = []
790
2096
    parent_trees = {}
791
2097
    for p_id in rev.parent_ids:
793
2099
            present_parents.append(p_id)
794
2100
            parent_trees[p_id] = repository.revision_tree(p_id)
795
2101
        else:
796
 
            parent_trees[p_id] = repository.revision_tree(None)
 
2102
            parent_trees[p_id] = repository.revision_tree(
 
2103
                                     _mod_revision.NULL_REVISION)
797
2104
 
798
2105
    inv = revision_tree.inventory
799
2106
    entries = inv.iter_entries()
800
 
    # backwards compatability hack: skip the root id.
 
2107
    # backwards compatibility hack: skip the root id.
801
2108
    if not repository.supports_rich_root():
802
2109
        path, root = entries.next()
803
2110
        if root.revision != rev.revision_id:
804
2111
            raise errors.IncompatibleRevision(repr(repository))
 
2112
    text_keys = {}
 
2113
    for path, ie in entries:
 
2114
        text_keys[(ie.file_id, ie.revision)] = ie
 
2115
    text_parent_map = repository.texts.get_parent_map(text_keys)
 
2116
    missing_texts = set(text_keys) - set(text_parent_map)
805
2117
    # Add the texts that are not already present
806
 
    for path, ie in entries:
807
 
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
808
 
                repository.get_transaction())
809
 
        if ie.revision not in w:
810
 
            text_parents = []
811
 
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
812
 
            # with InventoryEntry.find_previous_heads(). if it is, then there
813
 
            # is a latent bug here where the parents may have ancestors of each
814
 
            # other. RBC, AB
815
 
            for revision, tree in parent_trees.iteritems():
816
 
                if ie.file_id not in tree:
817
 
                    continue
818
 
                parent_id = tree.inventory[ie.file_id].revision
819
 
                if parent_id in text_parents:
820
 
                    continue
821
 
                text_parents.append(parent_id)
822
 
                    
823
 
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
824
 
                repository.get_transaction())
825
 
            lines = revision_tree.get_file(ie.file_id).readlines()
826
 
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
2118
    for text_key in missing_texts:
 
2119
        ie = text_keys[text_key]
 
2120
        text_parents = []
 
2121
        # FIXME: TODO: The following loop overlaps/duplicates that done by
 
2122
        # commit to determine parents. There is a latent/real bug here where
 
2123
        # the parents inserted are not those commit would do - in particular
 
2124
        # they are not filtered by heads(). RBC, AB
 
2125
        for revision, tree in parent_trees.iteritems():
 
2126
            if ie.file_id not in tree:
 
2127
                continue
 
2128
            parent_id = tree.inventory[ie.file_id].revision
 
2129
            if parent_id in text_parents:
 
2130
                continue
 
2131
            text_parents.append((ie.file_id, parent_id))
 
2132
        lines = revision_tree.get_file(ie.file_id).readlines()
 
2133
        repository.texts.add_lines(text_key, text_parents, lines)
827
2134
    try:
828
2135
        # install the inventory
829
2136
        repository.add_inventory(rev.revision_id, inv, present_parents)
830
2137
    except errors.RevisionAlreadyPresent:
831
2138
        pass
 
2139
    if signature is not None:
 
2140
        repository.add_signature_text(rev.revision_id, signature)
832
2141
    repository.add_revision(rev.revision_id, rev, inv)
833
2142
 
834
2143
 
835
2144
class MetaDirRepository(Repository):
836
 
    """Repositories in the new meta-dir layout."""
837
 
 
838
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
839
 
        super(MetaDirRepository, self).__init__(_format,
840
 
                                                a_bzrdir,
841
 
                                                control_files,
842
 
                                                _revision_store,
843
 
                                                control_store,
844
 
                                                text_store)
845
 
        dir_mode = self.control_files._dir_mode
846
 
        file_mode = self.control_files._file_mode
847
 
 
848
 
    @needs_read_lock
 
2145
    """Repositories in the new meta-dir layout.
 
2146
    
 
2147
    :ivar _transport: Transport for access to repository control files,
 
2148
        typically pointing to .bzr/repository.
 
2149
    """
 
2150
 
 
2151
    def __init__(self, _format, a_bzrdir, control_files):
 
2152
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
 
2153
        self._transport = control_files._transport
 
2154
 
849
2155
    def is_shared(self):
850
2156
        """Return True if this repository is flagged as a shared repository."""
851
 
        return self.control_files._transport.has('shared-storage')
 
2157
        return self._transport.has('shared-storage')
852
2158
 
853
2159
    @needs_write_lock
854
2160
    def set_make_working_trees(self, new_value):
862
2168
        """
863
2169
        if new_value:
864
2170
            try:
865
 
                self.control_files._transport.delete('no-working-trees')
 
2171
                self._transport.delete('no-working-trees')
866
2172
            except errors.NoSuchFile:
867
2173
                pass
868
2174
        else:
869
 
            self.control_files.put_utf8('no-working-trees', '')
 
2175
            self._transport.put_bytes('no-working-trees', '',
 
2176
                mode=self.bzrdir._get_file_mode())
870
2177
    
871
2178
    def make_working_trees(self):
872
2179
        """Returns the policy for making working trees on new branches."""
873
 
        return not self.control_files._transport.has('no-working-trees')
874
 
 
875
 
 
876
 
class KnitRepository(MetaDirRepository):
877
 
    """Knit format repository."""
878
 
 
879
 
    def _warn_if_deprecated(self):
880
 
        # This class isn't deprecated
881
 
        pass
882
 
 
883
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
884
 
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
885
 
 
886
 
    @needs_read_lock
887
 
    def _all_revision_ids(self):
888
 
        """See Repository.all_revision_ids()."""
889
 
        # Knits get the revision graph from the index of the revision knit, so
890
 
        # it's always possible even if they're on an unlistable transport.
891
 
        return self._revision_store.all_revision_ids(self.get_transaction())
892
 
 
893
 
    def fileid_involved_between_revs(self, from_revid, to_revid):
894
 
        """Find file_id(s) which are involved in the changes between revisions.
895
 
 
896
 
        This determines the set of revisions which are involved, and then
897
 
        finds all file ids affected by those revisions.
898
 
        """
899
 
        vf = self._get_revision_vf()
900
 
        from_set = set(vf.get_ancestry(from_revid))
901
 
        to_set = set(vf.get_ancestry(to_revid))
902
 
        changed = to_set.difference(from_set)
903
 
        return self._fileid_involved_by_set(changed)
904
 
 
905
 
    def fileid_involved(self, last_revid=None):
906
 
        """Find all file_ids modified in the ancestry of last_revid.
907
 
 
908
 
        :param last_revid: If None, last_revision() will be used.
909
 
        """
910
 
        if not last_revid:
911
 
            changed = set(self.all_revision_ids())
912
 
        else:
913
 
            changed = set(self.get_ancestry(last_revid))
914
 
        if None in changed:
915
 
            changed.remove(None)
916
 
        return self._fileid_involved_by_set(changed)
917
 
 
918
 
    @needs_read_lock
919
 
    def get_ancestry(self, revision_id):
920
 
        """Return a list of revision-ids integrated by a revision.
921
 
        
922
 
        This is topologically sorted.
923
 
        """
924
 
        if revision_id is None:
925
 
            return [None]
926
 
        vf = self._get_revision_vf()
927
 
        try:
928
 
            return [None] + vf.get_ancestry(revision_id)
929
 
        except errors.RevisionNotPresent:
930
 
            raise errors.NoSuchRevision(self, revision_id)
931
 
 
932
 
    @needs_read_lock
933
 
    def get_revision(self, revision_id):
934
 
        """Return the Revision object for a named revision"""
935
 
        return self.get_revision_reconcile(revision_id)
936
 
 
937
 
    @needs_read_lock
938
 
    def get_revision_graph(self, revision_id=None):
939
 
        """Return a dictionary containing the revision graph.
940
 
 
941
 
        :param revision_id: The revision_id to get a graph from. If None, then
942
 
        the entire revision graph is returned. This is a deprecated mode of
943
 
        operation and will be removed in the future.
944
 
        :return: a dictionary of revision_id->revision_parents_list.
945
 
        """
946
 
        # special case NULL_REVISION
947
 
        if revision_id == _mod_revision.NULL_REVISION:
948
 
            return {}
949
 
        a_weave = self._get_revision_vf()
950
 
        entire_graph = a_weave.get_graph()
951
 
        if revision_id is None:
952
 
            return a_weave.get_graph()
953
 
        elif revision_id not in a_weave:
954
 
            raise errors.NoSuchRevision(self, revision_id)
955
 
        else:
956
 
            # add what can be reached from revision_id
957
 
            result = {}
958
 
            pending = set([revision_id])
959
 
            while len(pending) > 0:
960
 
                node = pending.pop()
961
 
                result[node] = a_weave.get_parents(node)
962
 
                for revision_id in result[node]:
963
 
                    if revision_id not in result:
964
 
                        pending.add(revision_id)
965
 
            return result
966
 
 
967
 
    @needs_read_lock
968
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
969
 
        """Return a graph of the revisions with ghosts marked as applicable.
970
 
 
971
 
        :param revision_ids: an iterable of revisions to graph or None for all.
972
 
        :return: a Graph object with the graph reachable from revision_ids.
973
 
        """
974
 
        result = graph.Graph()
975
 
        vf = self._get_revision_vf()
976
 
        versions = set(vf.versions())
977
 
        if not revision_ids:
978
 
            pending = set(self.all_revision_ids())
979
 
            required = set([])
980
 
        else:
981
 
            pending = set(revision_ids)
982
 
            # special case NULL_REVISION
983
 
            if _mod_revision.NULL_REVISION in pending:
984
 
                pending.remove(_mod_revision.NULL_REVISION)
985
 
            required = set(pending)
986
 
        done = set([])
987
 
        while len(pending):
988
 
            revision_id = pending.pop()
989
 
            if not revision_id in versions:
990
 
                if revision_id in required:
991
 
                    raise errors.NoSuchRevision(self, revision_id)
992
 
                # a ghost
993
 
                result.add_ghost(revision_id)
994
 
                # mark it as done so we don't try for it again.
995
 
                done.add(revision_id)
996
 
                continue
997
 
            parent_ids = vf.get_parents_with_ghosts(revision_id)
998
 
            for parent_id in parent_ids:
999
 
                # is this queued or done ?
1000
 
                if (parent_id not in pending and
1001
 
                    parent_id not in done):
1002
 
                    # no, queue it.
1003
 
                    pending.add(parent_id)
1004
 
            result.add_node(revision_id, parent_ids)
1005
 
            done.add(revision_id)
1006
 
        return result
1007
 
 
1008
 
    def _get_revision_vf(self):
1009
 
        """:return: a versioned file containing the revisions."""
1010
 
        vf = self._revision_store.get_revision_file(self.get_transaction())
1011
 
        return vf
1012
 
 
1013
 
    @needs_write_lock
1014
 
    def reconcile(self, other=None, thorough=False):
1015
 
        """Reconcile this repository."""
1016
 
        from bzrlib.reconcile import KnitReconciler
1017
 
        reconciler = KnitReconciler(self, thorough=thorough)
1018
 
        reconciler.reconcile()
1019
 
        return reconciler
 
2180
        return not self._transport.has('no-working-trees')
 
2181
 
 
2182
 
 
2183
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2184
    """Repositories in a meta-dir, that work via versioned file objects."""
 
2185
 
 
2186
    def __init__(self, _format, a_bzrdir, control_files):
 
2187
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2188
            control_files)
 
2189
 
 
2190
 
 
2191
class RepositoryFormatRegistry(registry.Registry):
 
2192
    """Registry of RepositoryFormats."""
 
2193
 
 
2194
    def get(self, format_string):
 
2195
        r = registry.Registry.get(self, format_string)
 
2196
        if callable(r):
 
2197
            r = r()
 
2198
        return r
1020
2199
    
1021
 
    def revision_parents(self, revision_id):
1022
 
        return self._get_revision_vf().get_parents(revision_id)
1023
 
 
1024
 
 
1025
 
class KnitRepository2(KnitRepository):
1026
 
    """"""
1027
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store,
1028
 
                 control_store, text_store):
1029
 
        KnitRepository.__init__(self, _format, a_bzrdir, control_files,
1030
 
                              _revision_store, control_store, text_store)
1031
 
        self._serializer = xml6.serializer_v6
1032
 
 
1033
 
    def deserialise_inventory(self, revision_id, xml):
1034
 
        """Transform the xml into an inventory object. 
1035
 
 
1036
 
        :param revision_id: The expected revision id of the inventory.
1037
 
        :param xml: A serialised inventory.
1038
 
        """
1039
 
        result = self._serializer.read_inventory_from_string(xml)
1040
 
        assert result.root.revision is not None
1041
 
        return result
1042
 
 
1043
 
    def serialise_inventory(self, inv):
1044
 
        """Transform the inventory object into XML text.
1045
 
 
1046
 
        :param revision_id: The expected revision id of the inventory.
1047
 
        :param xml: A serialised inventory.
1048
 
        """
1049
 
        assert inv.revision_id is not None
1050
 
        assert inv.root.revision is not None
1051
 
        return KnitRepository.serialise_inventory(self, inv)
1052
 
 
1053
 
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
1054
 
                           timezone=None, committer=None, revprops=None, 
1055
 
                           revision_id=None):
1056
 
        """Obtain a CommitBuilder for this repository.
1057
 
        
1058
 
        :param branch: Branch to commit to.
1059
 
        :param parents: Revision ids of the parents of the new revision.
1060
 
        :param config: Configuration to use.
1061
 
        :param timestamp: Optional timestamp recorded for commit.
1062
 
        :param timezone: Optional timezone for timestamp.
1063
 
        :param committer: Optional committer to set for commit.
1064
 
        :param revprops: Optional dictionary of revision properties.
1065
 
        :param revision_id: Optional revision id.
1066
 
        """
1067
 
        return RootCommitBuilder(self, parents, config, timestamp, timezone,
1068
 
                                 committer, revprops, revision_id)
1069
 
 
 
2200
 
 
2201
format_registry = RepositoryFormatRegistry()
 
2202
"""Registry of formats, indexed by their identifying format string.
 
2203
 
 
2204
This can contain either format instances themselves, or classes/factories that
 
2205
can be called to obtain one.
 
2206
"""
 
2207
 
 
2208
 
 
2209
#####################################################################
 
2210
# Repository Formats
1070
2211
 
1071
2212
class RepositoryFormat(object):
1072
2213
    """A repository format.
1077
2218
       children.
1078
2219
     * an open routine which returns a Repository instance.
1079
2220
 
 
2221
    There is one and only one Format subclass for each on-disk format. But
 
2222
    there can be one Repository subclass that is used for several different
 
2223
    formats. The _format attribute on a Repository instance can be used to
 
2224
    determine the disk format.
 
2225
 
1080
2226
    Formats are placed in an dict by their format string for reference 
1081
2227
    during opening. These should be subclasses of RepositoryFormat
1082
2228
    for consistency.
1089
2235
    _matchingbzrdir - the bzrdir format that the repository format was
1090
2236
    originally written to work with. This can be used if manually
1091
2237
    constructing a bzrdir and repository, or more commonly for test suite
1092
 
    parameterisation.
 
2238
    parameterization.
1093
2239
    """
1094
2240
 
1095
 
    _default_format = None
1096
 
    """The default format used for new repositories."""
1097
 
 
1098
 
    _formats = {}
1099
 
    """The known formats."""
 
2241
    # Set to True or False in derived classes. True indicates that the format
 
2242
    # supports ghosts gracefully.
 
2243
    supports_ghosts = None
 
2244
    # Can this repository be given external locations to lookup additional
 
2245
    # data. Set to True or False in derived classes.
 
2246
    supports_external_lookups = None
1100
2247
 
1101
2248
    def __str__(self):
1102
2249
        return "<%s>" % self.__class__.__name__
1103
2250
 
 
2251
    def __eq__(self, other):
 
2252
        # format objects are generally stateless
 
2253
        return isinstance(other, self.__class__)
 
2254
 
 
2255
    def __ne__(self, other):
 
2256
        return not self == other
 
2257
 
1104
2258
    @classmethod
1105
2259
    def find_format(klass, a_bzrdir):
1106
 
        """Return the format for the repository object in a_bzrdir."""
 
2260
        """Return the format for the repository object in a_bzrdir.
 
2261
        
 
2262
        This is used by bzr native formats that have a "format" file in
 
2263
        the repository.  Other methods may be used by different types of 
 
2264
        control directory.
 
2265
        """
1107
2266
        try:
1108
2267
            transport = a_bzrdir.get_repository_transport(None)
1109
2268
            format_string = transport.get("format").read()
1110
 
            return klass._formats[format_string]
 
2269
            return format_registry.get(format_string)
1111
2270
        except errors.NoSuchFile:
1112
2271
            raise errors.NoRepositoryPresent(a_bzrdir)
1113
2272
        except KeyError:
1114
 
            raise errors.UnknownFormatError(format=format_string)
1115
 
 
1116
 
    def _get_control_store(self, repo_transport, control_files):
1117
 
        """Return the control store for this repository."""
1118
 
        raise NotImplementedError(self._get_control_store)
 
2273
            raise errors.UnknownFormatError(format=format_string,
 
2274
                                            kind='repository')
 
2275
 
 
2276
    @classmethod
 
2277
    def register_format(klass, format):
 
2278
        format_registry.register(format.get_format_string(), format)
 
2279
 
 
2280
    @classmethod
 
2281
    def unregister_format(klass, format):
 
2282
        format_registry.remove(format.get_format_string())
1119
2283
    
1120
2284
    @classmethod
1121
2285
    def get_default_format(klass):
1122
2286
        """Return the current default format."""
1123
 
        return klass._default_format
 
2287
        from bzrlib import bzrdir
 
2288
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1124
2289
 
1125
2290
    def get_format_string(self):
1126
2291
        """Return the ASCII format string that identifies this format.
1134
2299
        """Return the short description for this format."""
1135
2300
        raise NotImplementedError(self.get_format_description)
1136
2301
 
1137
 
    def _get_revision_store(self, repo_transport, control_files):
1138
 
        """Return the revision store object for this a_bzrdir."""
1139
 
        raise NotImplementedError(self._get_revision_store)
1140
 
 
1141
 
    def _get_text_rev_store(self,
1142
 
                            transport,
1143
 
                            control_files,
1144
 
                            name,
1145
 
                            compressed=True,
1146
 
                            prefixed=False,
1147
 
                            serializer=None):
1148
 
        """Common logic for getting a revision store for a repository.
1149
 
        
1150
 
        see self._get_revision_store for the subclass-overridable method to 
1151
 
        get the store for a repository.
1152
 
        """
1153
 
        from bzrlib.store.revision.text import TextRevisionStore
1154
 
        dir_mode = control_files._dir_mode
1155
 
        file_mode = control_files._file_mode
1156
 
        text_store =TextStore(transport.clone(name),
1157
 
                              prefixed=prefixed,
1158
 
                              compressed=compressed,
1159
 
                              dir_mode=dir_mode,
1160
 
                              file_mode=file_mode)
1161
 
        _revision_store = TextRevisionStore(text_store, serializer)
1162
 
        return _revision_store
1163
 
 
 
2302
    # TODO: this shouldn't be in the base class, it's specific to things that
 
2303
    # use weaves or knits -- mbp 20070207
1164
2304
    def _get_versioned_file_store(self,
1165
2305
                                  name,
1166
2306
                                  transport,
1167
2307
                                  control_files,
1168
2308
                                  prefixed=True,
1169
 
                                  versionedfile_class=weave.WeaveFile,
 
2309
                                  versionedfile_class=None,
1170
2310
                                  versionedfile_kwargs={},
1171
2311
                                  escaped=False):
 
2312
        if versionedfile_class is None:
 
2313
            versionedfile_class = self._versionedfile_class
1172
2314
        weave_transport = control_files._transport.clone(name)
1173
2315
        dir_mode = control_files._dir_mode
1174
2316
        file_mode = control_files._file_mode
1184
2326
 
1185
2327
        :param a_bzrdir: The bzrdir to put the new repository in it.
1186
2328
        :param shared: The repository should be initialized as a sharable one.
1187
 
 
 
2329
        :returns: The new repository object.
 
2330
        
1188
2331
        This may raise UninitializableFormat if shared repository are not
1189
2332
        compatible the a_bzrdir.
1190
2333
        """
 
2334
        raise NotImplementedError(self.initialize)
1191
2335
 
1192
2336
    def is_supported(self):
1193
2337
        """Is this format supported?
1208
2352
        """
1209
2353
        raise NotImplementedError(self.open)
1210
2354
 
1211
 
    @classmethod
1212
 
    def register_format(klass, format):
1213
 
        klass._formats[format.get_format_string()] = format
1214
 
 
1215
 
    @classmethod
1216
 
    def set_default_format(klass, format):
1217
 
        klass._default_format = format
1218
 
 
1219
 
    @classmethod
1220
 
    def unregister_format(klass, format):
1221
 
        assert klass._formats[format.get_format_string()] is format
1222
 
        del klass._formats[format.get_format_string()]
1223
 
 
1224
 
 
1225
 
class PreSplitOutRepositoryFormat(RepositoryFormat):
1226
 
    """Base class for the pre split out repository formats."""
1227
 
 
1228
 
    rich_root_data = False
1229
 
 
1230
 
    def initialize(self, a_bzrdir, shared=False, _internal=False):
1231
 
        """Create a weave repository.
1232
 
        
1233
 
        TODO: when creating split out bzr branch formats, move this to a common
1234
 
        base for Format5, Format6. or something like that.
1235
 
        """
1236
 
        if shared:
1237
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
1238
 
 
1239
 
        if not _internal:
1240
 
            # always initialized when the bzrdir is.
1241
 
            return self.open(a_bzrdir, _found=True)
1242
 
        
1243
 
        # Create an empty weave
1244
 
        sio = StringIO()
1245
 
        weavefile.write_weave_v5(weave.Weave(), sio)
1246
 
        empty_weave = sio.getvalue()
1247
 
 
1248
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1249
 
        dirs = ['revision-store', 'weaves']
1250
 
        files = [('inventory.weave', StringIO(empty_weave)),
1251
 
                 ]
1252
 
        
1253
 
        # FIXME: RBC 20060125 don't peek under the covers
1254
 
        # NB: no need to escape relative paths that are url safe.
1255
 
        control_files = lockable_files.LockableFiles(a_bzrdir.transport,
1256
 
                                'branch-lock', lockable_files.TransportLock)
1257
 
        control_files.create_lock()
1258
 
        control_files.lock_write()
1259
 
        control_files._transport.mkdir_multi(dirs,
1260
 
                mode=control_files._dir_mode)
1261
 
        try:
1262
 
            for file, content in files:
1263
 
                control_files.put(file, content)
1264
 
        finally:
1265
 
            control_files.unlock()
1266
 
        return self.open(a_bzrdir, _found=True)
1267
 
 
1268
 
    def _get_control_store(self, repo_transport, control_files):
1269
 
        """Return the control store for this repository."""
1270
 
        return self._get_versioned_file_store('',
1271
 
                                              repo_transport,
1272
 
                                              control_files,
1273
 
                                              prefixed=False)
1274
 
 
1275
 
    def _get_text_store(self, transport, control_files):
1276
 
        """Get a store for file texts for this format."""
1277
 
        raise NotImplementedError(self._get_text_store)
1278
 
 
1279
 
    def open(self, a_bzrdir, _found=False):
1280
 
        """See RepositoryFormat.open()."""
1281
 
        if not _found:
1282
 
            # we are being called directly and must probe.
1283
 
            raise NotImplementedError
1284
 
 
1285
 
        repo_transport = a_bzrdir.get_repository_transport(None)
1286
 
        control_files = a_bzrdir._control_files
1287
 
        text_store = self._get_text_store(repo_transport, control_files)
1288
 
        control_store = self._get_control_store(repo_transport, control_files)
1289
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1290
 
        return AllInOneRepository(_format=self,
1291
 
                                  a_bzrdir=a_bzrdir,
1292
 
                                  _revision_store=_revision_store,
1293
 
                                  control_store=control_store,
1294
 
                                  text_store=text_store)
1295
 
 
1296
 
    def check_conversion_target(self, target_format):
1297
 
        pass
1298
 
 
1299
 
 
1300
 
class RepositoryFormat4(PreSplitOutRepositoryFormat):
1301
 
    """Bzr repository format 4.
1302
 
 
1303
 
    This repository format has:
1304
 
     - flat stores
1305
 
     - TextStores for texts, inventories,revisions.
1306
 
 
1307
 
    This format is deprecated: it indexes texts using a text id which is
1308
 
    removed in format 5; initialization and write support for this format
1309
 
    has been removed.
1310
 
    """
1311
 
 
1312
 
    def __init__(self):
1313
 
        super(RepositoryFormat4, self).__init__()
1314
 
        self._matchingbzrdir = bzrdir.BzrDirFormat4()
1315
 
 
1316
 
    def get_format_description(self):
1317
 
        """See RepositoryFormat.get_format_description()."""
1318
 
        return "Repository format 4"
1319
 
 
1320
 
    def initialize(self, url, shared=False, _internal=False):
1321
 
        """Format 4 branches cannot be created."""
1322
 
        raise errors.UninitializableFormat(self)
1323
 
 
1324
 
    def is_supported(self):
1325
 
        """Format 4 is not supported.
1326
 
 
1327
 
        It is not supported because the model changed from 4 to 5 and the
1328
 
        conversion logic is expensive - so doing it on the fly was not 
1329
 
        feasible.
1330
 
        """
1331
 
        return False
1332
 
 
1333
 
    def _get_control_store(self, repo_transport, control_files):
1334
 
        """Format 4 repositories have no formal control store at this point.
1335
 
        
1336
 
        This will cause any control-file-needing apis to fail - this is desired.
1337
 
        """
1338
 
        return None
1339
 
    
1340
 
    def _get_revision_store(self, repo_transport, control_files):
1341
 
        """See RepositoryFormat._get_revision_store()."""
1342
 
        from bzrlib.xml4 import serializer_v4
1343
 
        return self._get_text_rev_store(repo_transport,
1344
 
                                        control_files,
1345
 
                                        'revision-store',
1346
 
                                        serializer=serializer_v4)
1347
 
 
1348
 
    def _get_text_store(self, transport, control_files):
1349
 
        """See RepositoryFormat._get_text_store()."""
1350
 
 
1351
 
 
1352
 
class RepositoryFormat5(PreSplitOutRepositoryFormat):
1353
 
    """Bzr control format 5.
1354
 
 
1355
 
    This repository format has:
1356
 
     - weaves for file texts and inventory
1357
 
     - flat stores
1358
 
     - TextStores for revisions and signatures.
1359
 
    """
1360
 
 
1361
 
    def __init__(self):
1362
 
        super(RepositoryFormat5, self).__init__()
1363
 
        self._matchingbzrdir = bzrdir.BzrDirFormat5()
1364
 
 
1365
 
    def get_format_description(self):
1366
 
        """See RepositoryFormat.get_format_description()."""
1367
 
        return "Weave repository format 5"
1368
 
 
1369
 
    def _get_revision_store(self, repo_transport, control_files):
1370
 
        """See RepositoryFormat._get_revision_store()."""
1371
 
        """Return the revision store object for this a_bzrdir."""
1372
 
        return self._get_text_rev_store(repo_transport,
1373
 
                                        control_files,
1374
 
                                        'revision-store',
1375
 
                                        compressed=False)
1376
 
 
1377
 
    def _get_text_store(self, transport, control_files):
1378
 
        """See RepositoryFormat._get_text_store()."""
1379
 
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
1380
 
 
1381
 
 
1382
 
class RepositoryFormat6(PreSplitOutRepositoryFormat):
1383
 
    """Bzr control format 6.
1384
 
 
1385
 
    This repository format has:
1386
 
     - weaves for file texts and inventory
1387
 
     - hash subdirectory based stores.
1388
 
     - TextStores for revisions and signatures.
1389
 
    """
1390
 
 
1391
 
    def __init__(self):
1392
 
        super(RepositoryFormat6, self).__init__()
1393
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1394
 
 
1395
 
    def get_format_description(self):
1396
 
        """See RepositoryFormat.get_format_description()."""
1397
 
        return "Weave repository format 6"
1398
 
 
1399
 
    def _get_revision_store(self, repo_transport, control_files):
1400
 
        """See RepositoryFormat._get_revision_store()."""
1401
 
        return self._get_text_rev_store(repo_transport,
1402
 
                                        control_files,
1403
 
                                        'revision-store',
1404
 
                                        compressed=False,
1405
 
                                        prefixed=True)
1406
 
 
1407
 
    def _get_text_store(self, transport, control_files):
1408
 
        """See RepositoryFormat._get_text_store()."""
1409
 
        return self._get_versioned_file_store('weaves', transport, control_files)
1410
 
 
1411
2355
 
1412
2356
class MetaDirRepositoryFormat(RepositoryFormat):
1413
2357
    """Common base class for the new repositories using the metadir layout."""
1414
2358
 
1415
2359
    rich_root_data = False
 
2360
    supports_tree_reference = False
 
2361
    supports_external_lookups = False
 
2362
 
 
2363
    @property
 
2364
    def _matchingbzrdir(self):
 
2365
        matching = bzrdir.BzrDirMetaFormat1()
 
2366
        matching.repository_format = self
 
2367
        return matching
1416
2368
 
1417
2369
    def __init__(self):
1418
2370
        super(MetaDirRepositoryFormat, self).__init__()
1419
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1420
2371
 
1421
2372
    def _create_control_files(self, a_bzrdir):
1422
2373
        """Create the required files and the initial control_files object."""
1432
2383
        """Upload the initial blank content."""
1433
2384
        control_files = self._create_control_files(a_bzrdir)
1434
2385
        control_files.lock_write()
 
2386
        transport = control_files._transport
 
2387
        if shared == True:
 
2388
            utf8_files += [('shared-storage', '')]
1435
2389
        try:
1436
 
            control_files._transport.mkdir_multi(dirs,
1437
 
                    mode=control_files._dir_mode)
1438
 
            for file, content in files:
1439
 
                control_files.put(file, content)
1440
 
            for file, content in utf8_files:
1441
 
                control_files.put_utf8(file, content)
1442
 
            if shared == True:
1443
 
                control_files.put_utf8('shared-storage', '')
 
2390
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
 
2391
            for (filename, content_stream) in files:
 
2392
                transport.put_file(filename, content_stream,
 
2393
                    mode=a_bzrdir._get_file_mode())
 
2394
            for (filename, content_bytes) in utf8_files:
 
2395
                transport.put_bytes_non_atomic(filename, content_bytes,
 
2396
                    mode=a_bzrdir._get_file_mode())
1444
2397
        finally:
1445
2398
            control_files.unlock()
1446
2399
 
1447
2400
 
1448
 
class RepositoryFormat7(MetaDirRepositoryFormat):
1449
 
    """Bzr repository 7.
1450
 
 
1451
 
    This repository format has:
1452
 
     - weaves for file texts and inventory
1453
 
     - hash subdirectory based stores.
1454
 
     - TextStores for revisions and signatures.
1455
 
     - a format marker of its own
1456
 
     - an optional 'shared-storage' flag
1457
 
     - an optional 'no-working-trees' flag
1458
 
    """
1459
 
 
1460
 
    def _get_control_store(self, repo_transport, control_files):
1461
 
        """Return the control store for this repository."""
1462
 
        return self._get_versioned_file_store('',
1463
 
                                              repo_transport,
1464
 
                                              control_files,
1465
 
                                              prefixed=False)
1466
 
 
1467
 
    def get_format_string(self):
1468
 
        """See RepositoryFormat.get_format_string()."""
1469
 
        return "Bazaar-NG Repository format 7"
1470
 
 
1471
 
    def get_format_description(self):
1472
 
        """See RepositoryFormat.get_format_description()."""
1473
 
        return "Weave repository format 7"
1474
 
 
1475
 
    def check_conversion_target(self, target_format):
1476
 
        pass
1477
 
 
1478
 
    def _get_revision_store(self, repo_transport, control_files):
1479
 
        """See RepositoryFormat._get_revision_store()."""
1480
 
        return self._get_text_rev_store(repo_transport,
1481
 
                                        control_files,
1482
 
                                        'revision-store',
1483
 
                                        compressed=False,
1484
 
                                        prefixed=True,
1485
 
                                        )
1486
 
 
1487
 
    def _get_text_store(self, transport, control_files):
1488
 
        """See RepositoryFormat._get_text_store()."""
1489
 
        return self._get_versioned_file_store('weaves',
1490
 
                                              transport,
1491
 
                                              control_files)
1492
 
 
1493
 
    def initialize(self, a_bzrdir, shared=False):
1494
 
        """Create a weave repository.
1495
 
 
1496
 
        :param shared: If true the repository will be initialized as a shared
1497
 
                       repository.
1498
 
        """
1499
 
        # Create an empty weave
1500
 
        sio = StringIO()
1501
 
        weavefile.write_weave_v5(weave.Weave(), sio)
1502
 
        empty_weave = sio.getvalue()
1503
 
 
1504
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1505
 
        dirs = ['revision-store', 'weaves']
1506
 
        files = [('inventory.weave', StringIO(empty_weave)), 
1507
 
                 ]
1508
 
        utf8_files = [('format', self.get_format_string())]
1509
 
 
1510
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1511
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1512
 
 
1513
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1514
 
        """See RepositoryFormat.open().
1515
 
        
1516
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1517
 
                                    repository at a slightly different url
1518
 
                                    than normal. I.e. during 'upgrade'.
1519
 
        """
1520
 
        if not _found:
1521
 
            format = RepositoryFormat.find_format(a_bzrdir)
1522
 
            assert format.__class__ ==  self.__class__
1523
 
        if _override_transport is not None:
1524
 
            repo_transport = _override_transport
1525
 
        else:
1526
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1527
 
        control_files = lockable_files.LockableFiles(repo_transport,
1528
 
                                'lock', lockdir.LockDir)
1529
 
        text_store = self._get_text_store(repo_transport, control_files)
1530
 
        control_store = self._get_control_store(repo_transport, control_files)
1531
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1532
 
        return MetaDirRepository(_format=self,
1533
 
                                 a_bzrdir=a_bzrdir,
1534
 
                                 control_files=control_files,
1535
 
                                 _revision_store=_revision_store,
1536
 
                                 control_store=control_store,
1537
 
                                 text_store=text_store)
1538
 
 
1539
 
 
1540
 
class RepositoryFormatKnit(MetaDirRepositoryFormat):
1541
 
    """Bzr repository knit format (generalized). 
1542
 
 
1543
 
    This repository format has:
1544
 
     - knits for file texts and inventory
1545
 
     - hash subdirectory based stores.
1546
 
     - knits for revisions and signatures
1547
 
     - TextStores for revisions and signatures.
1548
 
     - a format marker of its own
1549
 
     - an optional 'shared-storage' flag
1550
 
     - an optional 'no-working-trees' flag
1551
 
     - a LockDir lock
1552
 
    """
1553
 
 
1554
 
    def _get_control_store(self, repo_transport, control_files):
1555
 
        """Return the control store for this repository."""
1556
 
        return VersionedFileStore(
1557
 
            repo_transport,
1558
 
            prefixed=False,
1559
 
            file_mode=control_files._file_mode,
1560
 
            versionedfile_class=knit.KnitVersionedFile,
1561
 
            versionedfile_kwargs={'factory':knit.KnitPlainFactory()},
1562
 
            )
1563
 
 
1564
 
    def _get_revision_store(self, repo_transport, control_files):
1565
 
        """See RepositoryFormat._get_revision_store()."""
1566
 
        from bzrlib.store.revision.knit import KnitRevisionStore
1567
 
        versioned_file_store = VersionedFileStore(
1568
 
            repo_transport,
1569
 
            file_mode=control_files._file_mode,
1570
 
            prefixed=False,
1571
 
            precious=True,
1572
 
            versionedfile_class=knit.KnitVersionedFile,
1573
 
            versionedfile_kwargs={'delta':False,
1574
 
                                  'factory':knit.KnitPlainFactory(),
1575
 
                                 },
1576
 
            escaped=True,
1577
 
            )
1578
 
        return KnitRevisionStore(versioned_file_store)
1579
 
 
1580
 
    def _get_text_store(self, transport, control_files):
1581
 
        """See RepositoryFormat._get_text_store()."""
1582
 
        return self._get_versioned_file_store('knits',
1583
 
                                  transport,
1584
 
                                  control_files,
1585
 
                                  versionedfile_class=knit.KnitVersionedFile,
1586
 
                                  versionedfile_kwargs={
1587
 
                                      'create_parent_dir':True,
1588
 
                                      'delay_create':True,
1589
 
                                      'dir_mode':control_files._dir_mode,
1590
 
                                  },
1591
 
                                  escaped=True)
1592
 
 
1593
 
    def initialize(self, a_bzrdir, shared=False):
1594
 
        """Create a knit format 1 repository.
1595
 
 
1596
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
1597
 
            be initialized.
1598
 
        :param shared: If true the repository will be initialized as a shared
1599
 
                       repository.
1600
 
        """
1601
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1602
 
        dirs = ['revision-store', 'knits']
1603
 
        files = []
1604
 
        utf8_files = [('format', self.get_format_string())]
1605
 
        
1606
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1607
 
        repo_transport = a_bzrdir.get_repository_transport(None)
1608
 
        control_files = lockable_files.LockableFiles(repo_transport,
1609
 
                                'lock', lockdir.LockDir)
1610
 
        control_store = self._get_control_store(repo_transport, control_files)
1611
 
        transaction = transactions.WriteTransaction()
1612
 
        # trigger a write of the inventory store.
1613
 
        control_store.get_weave_or_empty('inventory', transaction)
1614
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1615
 
        _revision_store.has_revision_id('A', transaction)
1616
 
        _revision_store.get_signature_file(transaction)
1617
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1618
 
 
1619
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1620
 
        """See RepositoryFormat.open().
1621
 
        
1622
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1623
 
                                    repository at a slightly different url
1624
 
                                    than normal. I.e. during 'upgrade'.
1625
 
        """
1626
 
        if not _found:
1627
 
            format = RepositoryFormat.find_format(a_bzrdir)
1628
 
            assert format.__class__ ==  self.__class__
1629
 
        if _override_transport is not None:
1630
 
            repo_transport = _override_transport
1631
 
        else:
1632
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1633
 
        control_files = lockable_files.LockableFiles(repo_transport,
1634
 
                                'lock', lockdir.LockDir)
1635
 
        text_store = self._get_text_store(repo_transport, control_files)
1636
 
        control_store = self._get_control_store(repo_transport, control_files)
1637
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1638
 
        return KnitRepository(_format=self,
1639
 
                              a_bzrdir=a_bzrdir,
1640
 
                              control_files=control_files,
1641
 
                              _revision_store=_revision_store,
1642
 
                              control_store=control_store,
1643
 
                              text_store=text_store)
1644
 
 
1645
 
 
1646
 
class RepositoryFormatKnit1(RepositoryFormatKnit):
1647
 
    """Bzr repository knit format 1.
1648
 
 
1649
 
    This repository format has:
1650
 
     - knits for file texts and inventory
1651
 
     - hash subdirectory based stores.
1652
 
     - knits for revisions and signatures
1653
 
     - TextStores for revisions and signatures.
1654
 
     - a format marker of its own
1655
 
     - an optional 'shared-storage' flag
1656
 
     - an optional 'no-working-trees' flag
1657
 
     - a LockDir lock
1658
 
 
1659
 
    This format was introduced in bzr 0.8.
1660
 
    """
1661
 
    def get_format_string(self):
1662
 
        """See RepositoryFormat.get_format_string()."""
1663
 
        return "Bazaar-NG Knit Repository Format 1"
1664
 
 
1665
 
    def get_format_description(self):
1666
 
        """See RepositoryFormat.get_format_description()."""
1667
 
        return "Knit repository format 1"
1668
 
 
1669
 
    def check_conversion_target(self, target_format):
1670
 
        pass
1671
 
 
1672
 
 
1673
 
class RepositoryFormatKnit2(RepositoryFormatKnit):
1674
 
    """Bzr repository knit format 2.
1675
 
 
1676
 
    THIS FORMAT IS EXPERIMENTAL
1677
 
    This repository format has:
1678
 
     - knits for file texts and inventory
1679
 
     - hash subdirectory based stores.
1680
 
     - knits for revisions and signatures
1681
 
     - TextStores for revisions and signatures.
1682
 
     - a format marker of its own
1683
 
     - an optional 'shared-storage' flag
1684
 
     - an optional 'no-working-trees' flag
1685
 
     - a LockDir lock
1686
 
     - Support for recording full info about the tree root
1687
 
 
1688
 
    """
1689
 
    
1690
 
    rich_root_data = True
1691
 
 
1692
 
    def get_format_string(self):
1693
 
        """See RepositoryFormat.get_format_string()."""
1694
 
        return "Bazaar Knit Repository Format 2\n"
1695
 
 
1696
 
    def get_format_description(self):
1697
 
        """See RepositoryFormat.get_format_description()."""
1698
 
        return "Knit repository format 2"
1699
 
 
1700
 
    def check_conversion_target(self, target_format):
1701
 
        if not target_format.rich_root_data:
1702
 
            raise errors.BadConversionTarget(
1703
 
                'Does not support rich root data.', target_format)
1704
 
 
1705
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1706
 
        """See RepositoryFormat.open().
1707
 
        
1708
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1709
 
                                    repository at a slightly different url
1710
 
                                    than normal. I.e. during 'upgrade'.
1711
 
        """
1712
 
        if not _found:
1713
 
            format = RepositoryFormat.find_format(a_bzrdir)
1714
 
            assert format.__class__ ==  self.__class__
1715
 
        if _override_transport is not None:
1716
 
            repo_transport = _override_transport
1717
 
        else:
1718
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1719
 
        control_files = lockable_files.LockableFiles(repo_transport, 'lock',
1720
 
                                                     lockdir.LockDir)
1721
 
        text_store = self._get_text_store(repo_transport, control_files)
1722
 
        control_store = self._get_control_store(repo_transport, control_files)
1723
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1724
 
        return KnitRepository2(_format=self,
1725
 
                               a_bzrdir=a_bzrdir,
1726
 
                               control_files=control_files,
1727
 
                               _revision_store=_revision_store,
1728
 
                               control_store=control_store,
1729
 
                               text_store=text_store)
1730
 
 
1731
 
 
1732
 
 
1733
2401
# formats which have no format string are not discoverable
1734
 
# and not independently creatable, so are not registered.
1735
 
RepositoryFormat.register_format(RepositoryFormat7())
1736
 
_default_format = RepositoryFormatKnit1()
1737
 
RepositoryFormat.register_format(_default_format)
1738
 
RepositoryFormat.register_format(RepositoryFormatKnit2())
1739
 
RepositoryFormat.set_default_format(_default_format)
1740
 
_legacy_formats = [RepositoryFormat4(),
1741
 
                   RepositoryFormat5(),
1742
 
                   RepositoryFormat6()]
 
2402
# and not independently creatable, so are not registered.  They're 
 
2403
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
2404
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
2405
# the repository is not separately opened are similar.
 
2406
 
 
2407
format_registry.register_lazy(
 
2408
    'Bazaar-NG Repository format 7',
 
2409
    'bzrlib.repofmt.weaverepo',
 
2410
    'RepositoryFormat7'
 
2411
    )
 
2412
 
 
2413
format_registry.register_lazy(
 
2414
    'Bazaar-NG Knit Repository Format 1',
 
2415
    'bzrlib.repofmt.knitrepo',
 
2416
    'RepositoryFormatKnit1',
 
2417
    )
 
2418
 
 
2419
format_registry.register_lazy(
 
2420
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
2421
    'bzrlib.repofmt.knitrepo',
 
2422
    'RepositoryFormatKnit3',
 
2423
    )
 
2424
 
 
2425
format_registry.register_lazy(
 
2426
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
2427
    'bzrlib.repofmt.knitrepo',
 
2428
    'RepositoryFormatKnit4',
 
2429
    )
 
2430
 
 
2431
# Pack-based formats. There is one format for pre-subtrees, and one for
 
2432
# post-subtrees to allow ease of testing.
 
2433
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
2434
format_registry.register_lazy(
 
2435
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
2436
    'bzrlib.repofmt.pack_repo',
 
2437
    'RepositoryFormatKnitPack1',
 
2438
    )
 
2439
format_registry.register_lazy(
 
2440
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
2441
    'bzrlib.repofmt.pack_repo',
 
2442
    'RepositoryFormatKnitPack3',
 
2443
    )
 
2444
format_registry.register_lazy(
 
2445
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
2446
    'bzrlib.repofmt.pack_repo',
 
2447
    'RepositoryFormatKnitPack4',
 
2448
    )
 
2449
format_registry.register_lazy(
 
2450
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
 
2451
    'bzrlib.repofmt.pack_repo',
 
2452
    'RepositoryFormatKnitPack5',
 
2453
    )
 
2454
format_registry.register_lazy(
 
2455
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
 
2456
    'bzrlib.repofmt.pack_repo',
 
2457
    'RepositoryFormatKnitPack5RichRoot',
 
2458
    )
 
2459
format_registry.register_lazy(
 
2460
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
 
2461
    'bzrlib.repofmt.pack_repo',
 
2462
    'RepositoryFormatKnitPack5RichRootBroken',
 
2463
    )
 
2464
format_registry.register_lazy(
 
2465
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
2466
    'bzrlib.repofmt.pack_repo',
 
2467
    'RepositoryFormatKnitPack6',
 
2468
    )
 
2469
format_registry.register_lazy(
 
2470
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
2471
    'bzrlib.repofmt.pack_repo',
 
2472
    'RepositoryFormatKnitPack6RichRoot',
 
2473
    )
 
2474
 
 
2475
# Development formats. 
 
2476
# 1.7->1.8 go below here
 
2477
format_registry.register_lazy(
 
2478
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2479
    'bzrlib.repofmt.pack_repo',
 
2480
    'RepositoryFormatPackDevelopment2',
 
2481
    )
 
2482
format_registry.register_lazy(
 
2483
    ("Bazaar development format 2 with subtree support "
 
2484
        "(needs bzr.dev from before 1.8)\n"),
 
2485
    'bzrlib.repofmt.pack_repo',
 
2486
    'RepositoryFormatPackDevelopment2Subtree',
 
2487
    )
1743
2488
 
1744
2489
 
1745
2490
class InterRepository(InterObject):
1754
2499
    InterRepository.get(other).method_name(parameters).
1755
2500
    """
1756
2501
 
 
2502
    _walk_to_common_revisions_batch_size = 1
1757
2503
    _optimisers = []
1758
2504
    """The available optimised InterRepository types."""
1759
2505
 
1760
 
    def copy_content(self, revision_id=None, basis=None):
 
2506
    def __init__(self, source, target):
 
2507
        InterObject.__init__(self, source, target)
 
2508
        # These two attributes may be overridden by e.g. InterOtherToRemote to
 
2509
        # provide a faster implementation.
 
2510
        self.target_get_graph = self.target.get_graph
 
2511
        self.target_get_parent_map = self.target.get_parent_map
 
2512
 
 
2513
    def copy_content(self, revision_id=None):
1761
2514
        raise NotImplementedError(self.copy_content)
1762
2515
 
1763
 
    def fetch(self, revision_id=None, pb=None):
 
2516
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1764
2517
        """Fetch the content required to construct revision_id.
1765
2518
 
1766
2519
        The content is copied from self.source to self.target.
1770
2523
        :param pb: optional progress bar to use for progress reports. If not
1771
2524
                   provided a default one will be created.
1772
2525
 
1773
 
        Returns the copied revision count and the failed revisions in a tuple:
1774
 
        (copied, failures).
1775
 
        """
1776
 
        raise NotImplementedError(self.fetch)
1777
 
   
 
2526
        :returns: (copied_revision_count, failures).
 
2527
        """
 
2528
        # Normally we should find a specific InterRepository subclass to do
 
2529
        # the fetch; if nothing else then at least InterSameDataRepository.
 
2530
        # If none of them is suitable it looks like fetching is not possible;
 
2531
        # we try to give a good message why.  _assert_same_model will probably
 
2532
        # give a helpful message; otherwise a generic one.
 
2533
        self._assert_same_model(self.source, self.target)
 
2534
        raise errors.IncompatibleRepositories(self.source, self.target,
 
2535
            "no suitableInterRepository found")
 
2536
 
 
2537
    def _walk_to_common_revisions(self, revision_ids):
 
2538
        """Walk out from revision_ids in source to revisions target has.
 
2539
 
 
2540
        :param revision_ids: The start point for the search.
 
2541
        :return: A set of revision ids.
 
2542
        """
 
2543
        target_graph = self.target_get_graph()
 
2544
        revision_ids = frozenset(revision_ids)
 
2545
        # Fast path for the case where all the revisions are already in the
 
2546
        # target repo.
 
2547
        # (Although this does incur an extra round trip for the
 
2548
        # fairly common case where the target doesn't already have the revision
 
2549
        # we're pushing.)
 
2550
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2551
            return graph.SearchResult(revision_ids, set(), 0, set())
 
2552
        missing_revs = set()
 
2553
        source_graph = self.source.get_graph()
 
2554
        # ensure we don't pay silly lookup costs.
 
2555
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
2556
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
2557
        searcher_exhausted = False
 
2558
        while True:
 
2559
            next_revs = set()
 
2560
            ghosts = set()
 
2561
            # Iterate the searcher until we have enough next_revs
 
2562
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
2563
                try:
 
2564
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
2565
                    next_revs.update(next_revs_part)
 
2566
                    ghosts.update(ghosts_part)
 
2567
                except StopIteration:
 
2568
                    searcher_exhausted = True
 
2569
                    break
 
2570
            # If there are ghosts in the source graph, and the caller asked for
 
2571
            # them, make sure that they are present in the target.
 
2572
            # We don't care about other ghosts as we can't fetch them and
 
2573
            # haven't been asked to.
 
2574
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
2575
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
2576
            if revs_to_get:
 
2577
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
2578
                # we always have NULL_REVISION present.
 
2579
                have_revs = have_revs.union(null_set)
 
2580
                # Check if the target is missing any ghosts we need.
 
2581
                ghosts_to_check.difference_update(have_revs)
 
2582
                if ghosts_to_check:
 
2583
                    # One of the caller's revision_ids is a ghost in both the
 
2584
                    # source and the target.
 
2585
                    raise errors.NoSuchRevision(
 
2586
                        self.source, ghosts_to_check.pop())
 
2587
                missing_revs.update(next_revs - have_revs)
 
2588
                # Because we may have walked past the original stop point, make
 
2589
                # sure everything is stopped
 
2590
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
2591
                searcher.stop_searching_any(stop_revs)
 
2592
            if searcher_exhausted:
 
2593
                break
 
2594
        return searcher.get_result()
 
2595
 
 
2596
    @deprecated_method(one_two)
1778
2597
    @needs_read_lock
1779
 
    def missing_revision_ids(self, revision_id=None):
 
2598
    def missing_revision_ids(self, revision_id=None, find_ghosts=True):
1780
2599
        """Return the revision ids that source has that target does not.
1781
2600
        
1782
2601
        These are returned in topological order.
1783
2602
 
1784
2603
        :param revision_id: only return revision ids included by this
1785
2604
                            revision_id.
1786
 
        """
 
2605
        :param find_ghosts: If True find missing revisions in deep history
 
2606
            rather than just finding the surface difference.
 
2607
        """
 
2608
        return list(self.search_missing_revision_ids(
 
2609
            revision_id, find_ghosts).get_keys())
 
2610
 
 
2611
    @needs_read_lock
 
2612
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
2613
        """Return the revision ids that source has that target does not.
 
2614
        
 
2615
        :param revision_id: only return revision ids included by this
 
2616
                            revision_id.
 
2617
        :param find_ghosts: If True find missing revisions in deep history
 
2618
            rather than just finding the surface difference.
 
2619
        :return: A bzrlib.graph.SearchResult.
 
2620
        """
 
2621
        # stop searching at found target revisions.
 
2622
        if not find_ghosts and revision_id is not None:
 
2623
            return self._walk_to_common_revisions([revision_id])
1787
2624
        # generic, possibly worst case, slow code path.
1788
2625
        target_ids = set(self.target.all_revision_ids())
1789
2626
        if revision_id is not None:
1790
2627
            source_ids = self.source.get_ancestry(revision_id)
1791
 
            assert source_ids[0] is None
 
2628
            if source_ids[0] is not None:
 
2629
                raise AssertionError()
1792
2630
            source_ids.pop(0)
1793
2631
        else:
1794
2632
            source_ids = self.source.all_revision_ids()
1795
2633
        result_set = set(source_ids).difference(target_ids)
1796
 
        # this may look like a no-op: its not. It preserves the ordering
1797
 
        # other_ids had while only returning the members from other_ids
1798
 
        # that we've decided we need.
1799
 
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
2634
        return self.source.revision_ids_to_search_result(result_set)
 
2635
 
 
2636
    @staticmethod
 
2637
    def _same_model(source, target):
 
2638
        """True if source and target have the same data representation.
 
2639
        
 
2640
        Note: this is always called on the base class; overriding it in a
 
2641
        subclass will have no effect.
 
2642
        """
 
2643
        try:
 
2644
            InterRepository._assert_same_model(source, target)
 
2645
            return True
 
2646
        except errors.IncompatibleRepositories, e:
 
2647
            return False
 
2648
 
 
2649
    @staticmethod
 
2650
    def _assert_same_model(source, target):
 
2651
        """Raise an exception if two repositories do not use the same model.
 
2652
        """
 
2653
        if source.supports_rich_root() != target.supports_rich_root():
 
2654
            raise errors.IncompatibleRepositories(source, target,
 
2655
                "different rich-root support")
 
2656
        if source._serializer != target._serializer:
 
2657
            raise errors.IncompatibleRepositories(source, target,
 
2658
                "different serializers")
1800
2659
 
1801
2660
 
1802
2661
class InterSameDataRepository(InterRepository):
1805
2664
    Data format and model must match for this to work.
1806
2665
    """
1807
2666
 
1808
 
    _matching_repo_format = RepositoryFormat4()
1809
 
    """Repository format for testing with."""
 
2667
    @classmethod
 
2668
    def _get_repo_format_to_test(self):
 
2669
        """Repository format for testing with.
 
2670
        
 
2671
        InterSameData can pull from subtree to subtree and from non-subtree to
 
2672
        non-subtree, so we test this with the richest repository format.
 
2673
        """
 
2674
        from bzrlib.repofmt import knitrepo
 
2675
        return knitrepo.RepositoryFormatKnit3()
1810
2676
 
1811
2677
    @staticmethod
1812
2678
    def is_compatible(source, target):
1813
 
        if not isinstance(source, Repository):
1814
 
            return False
1815
 
        if not isinstance(target, Repository):
1816
 
            return False
1817
 
        if source._format.rich_root_data == target._format.rich_root_data:
1818
 
            return True
1819
 
        else:
1820
 
            return False
 
2679
        return InterRepository._same_model(source, target)
1821
2680
 
1822
2681
    @needs_write_lock
1823
 
    def copy_content(self, revision_id=None, basis=None):
 
2682
    def copy_content(self, revision_id=None):
1824
2683
        """Make a complete copy of the content in self into destination.
 
2684
 
 
2685
        This copies both the repository's revision data, and configuration information
 
2686
        such as the make_working_trees setting.
1825
2687
        
1826
2688
        This is a destructive operation! Do not use it on existing 
1827
2689
        repositories.
1828
2690
 
1829
2691
        :param revision_id: Only copy the content needed to construct
1830
2692
                            revision_id and its parents.
1831
 
        :param basis: Copy the needed data preferentially from basis.
1832
2693
        """
1833
2694
        try:
1834
2695
            self.target.set_make_working_trees(self.source.make_working_trees())
1835
2696
        except NotImplementedError:
1836
2697
            pass
1837
 
        # grab the basis available data
1838
 
        if basis is not None:
1839
 
            self.target.fetch(basis, revision_id=revision_id)
1840
2698
        # but don't bother fetching if we have the needed data now.
1841
2699
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
1842
2700
            self.target.has_revision(revision_id)):
1844
2702
        self.target.fetch(self.source, revision_id=revision_id)
1845
2703
 
1846
2704
    @needs_write_lock
1847
 
    def fetch(self, revision_id=None, pb=None):
 
2705
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1848
2706
        """See InterRepository.fetch()."""
1849
 
        from bzrlib.fetch import GenericRepoFetcher
 
2707
        from bzrlib.fetch import RepoFetcher
1850
2708
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1851
 
               self.source, self.source._format, self.target, 
 
2709
               self.source, self.source._format, self.target,
1852
2710
               self.target._format)
1853
 
        f = GenericRepoFetcher(to_repository=self.target,
 
2711
        f = RepoFetcher(to_repository=self.target,
1854
2712
                               from_repository=self.source,
1855
2713
                               last_revision=revision_id,
1856
 
                               pb=pb)
 
2714
                               pb=pb, find_ghosts=find_ghosts)
1857
2715
        return f.count_copied, f.failed_revisions
1858
2716
 
1859
2717
 
1860
2718
class InterWeaveRepo(InterSameDataRepository):
1861
 
    """Optimised code paths between Weave based repositories."""
 
2719
    """Optimised code paths between Weave based repositories.
 
2720
    
 
2721
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
2722
    implemented lazy inter-object optimisation.
 
2723
    """
1862
2724
 
1863
 
    _matching_repo_format = RepositoryFormat7()
1864
 
    """Repository format for testing with."""
 
2725
    @classmethod
 
2726
    def _get_repo_format_to_test(self):
 
2727
        from bzrlib.repofmt import weaverepo
 
2728
        return weaverepo.RepositoryFormat7()
1865
2729
 
1866
2730
    @staticmethod
1867
2731
    def is_compatible(source, target):
1871
2735
        could lead to confusing results, and there is no need to be 
1872
2736
        overly general.
1873
2737
        """
 
2738
        from bzrlib.repofmt.weaverepo import (
 
2739
                RepositoryFormat5,
 
2740
                RepositoryFormat6,
 
2741
                RepositoryFormat7,
 
2742
                )
1874
2743
        try:
1875
2744
            return (isinstance(source._format, (RepositoryFormat5,
1876
2745
                                                RepositoryFormat6,
1882
2751
            return False
1883
2752
    
1884
2753
    @needs_write_lock
1885
 
    def copy_content(self, revision_id=None, basis=None):
 
2754
    def copy_content(self, revision_id=None):
1886
2755
        """See InterRepository.copy_content()."""
1887
2756
        # weave specific optimised path:
1888
 
        if basis is not None:
1889
 
            # copy the basis in, then fetch remaining data.
1890
 
            basis.copy_content_into(self.target, revision_id)
1891
 
            # the basis copy_content_into could miss-set this.
 
2757
        try:
 
2758
            self.target.set_make_working_trees(self.source.make_working_trees())
 
2759
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
2760
            pass
 
2761
        # FIXME do not peek!
 
2762
        if self.source._transport.listable():
 
2763
            pb = ui.ui_factory.nested_progress_bar()
1892
2764
            try:
1893
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1894
 
            except NotImplementedError:
1895
 
                pass
 
2765
                self.target.texts.insert_record_stream(
 
2766
                    self.source.texts.get_record_stream(
 
2767
                        self.source.texts.keys(), 'topological', False))
 
2768
                pb.update('copying inventory', 0, 1)
 
2769
                self.target.inventories.insert_record_stream(
 
2770
                    self.source.inventories.get_record_stream(
 
2771
                        self.source.inventories.keys(), 'topological', False))
 
2772
                self.target.signatures.insert_record_stream(
 
2773
                    self.source.signatures.get_record_stream(
 
2774
                        self.source.signatures.keys(),
 
2775
                        'unordered', True))
 
2776
                self.target.revisions.insert_record_stream(
 
2777
                    self.source.revisions.get_record_stream(
 
2778
                        self.source.revisions.keys(),
 
2779
                        'topological', True))
 
2780
            finally:
 
2781
                pb.finished()
 
2782
        else:
1896
2783
            self.target.fetch(self.source, revision_id=revision_id)
1897
 
        else:
1898
 
            try:
1899
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1900
 
            except NotImplementedError:
1901
 
                pass
1902
 
            # FIXME do not peek!
1903
 
            if self.source.control_files._transport.listable():
1904
 
                pb = ui.ui_factory.nested_progress_bar()
1905
 
                try:
1906
 
                    self.target.weave_store.copy_all_ids(
1907
 
                        self.source.weave_store,
1908
 
                        pb=pb,
1909
 
                        from_transaction=self.source.get_transaction(),
1910
 
                        to_transaction=self.target.get_transaction())
1911
 
                    pb.update('copying inventory', 0, 1)
1912
 
                    self.target.control_weaves.copy_multi(
1913
 
                        self.source.control_weaves, ['inventory'],
1914
 
                        from_transaction=self.source.get_transaction(),
1915
 
                        to_transaction=self.target.get_transaction())
1916
 
                    self.target._revision_store.text_store.copy_all_ids(
1917
 
                        self.source._revision_store.text_store,
1918
 
                        pb=pb)
1919
 
                finally:
1920
 
                    pb.finished()
1921
 
            else:
1922
 
                self.target.fetch(self.source, revision_id=revision_id)
1923
2784
 
1924
2785
    @needs_write_lock
1925
 
    def fetch(self, revision_id=None, pb=None):
 
2786
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
1926
2787
        """See InterRepository.fetch()."""
1927
 
        from bzrlib.fetch import GenericRepoFetcher
 
2788
        from bzrlib.fetch import RepoFetcher
1928
2789
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1929
2790
               self.source, self.source._format, self.target, self.target._format)
1930
 
        f = GenericRepoFetcher(to_repository=self.target,
 
2791
        f = RepoFetcher(to_repository=self.target,
1931
2792
                               from_repository=self.source,
1932
2793
                               last_revision=revision_id,
1933
 
                               pb=pb)
 
2794
                               pb=pb, find_ghosts=find_ghosts)
1934
2795
        return f.count_copied, f.failed_revisions
1935
2796
 
1936
2797
    @needs_read_lock
1937
 
    def missing_revision_ids(self, revision_id=None):
 
2798
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1938
2799
        """See InterRepository.missing_revision_ids()."""
1939
2800
        # we want all revisions to satisfy revision_id in source.
1940
2801
        # but we don't want to stat every file here and there.
1949
2810
        # - RBC 20060209
1950
2811
        if revision_id is not None:
1951
2812
            source_ids = self.source.get_ancestry(revision_id)
1952
 
            assert source_ids[0] is None
 
2813
            if source_ids[0] is not None:
 
2814
                raise AssertionError()
1953
2815
            source_ids.pop(0)
1954
2816
        else:
1955
2817
            source_ids = self.source._all_possible_ids()
1960
2822
        # we do not have a revision as that would be pointless.
1961
2823
        target_ids = set(self.target._all_possible_ids())
1962
2824
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1963
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2825
        actually_present_revisions = set(
 
2826
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1964
2827
        required_revisions = source_ids_set.difference(actually_present_revisions)
1965
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1966
2828
        if revision_id is not None:
1967
2829
            # we used get_ancestry to determine source_ids then we are assured all
1968
2830
            # revisions referenced are present as they are installed in topological order.
1969
2831
            # and the tip revision was validated by get_ancestry.
1970
 
            return required_topo_revisions
 
2832
            result_set = required_revisions
1971
2833
        else:
1972
2834
            # if we just grabbed the possibly available ids, then 
1973
2835
            # we only have an estimate of whats available and need to validate
1974
2836
            # that against the revision records.
1975
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
2837
            result_set = set(
 
2838
                self.source._eliminate_revisions_not_present(required_revisions))
 
2839
        return self.source.revision_ids_to_search_result(result_set)
1976
2840
 
1977
2841
 
1978
2842
class InterKnitRepo(InterSameDataRepository):
1979
2843
    """Optimised code paths between Knit based repositories."""
1980
2844
 
1981
 
    _matching_repo_format = RepositoryFormatKnit1()
1982
 
    """Repository format for testing with."""
 
2845
    @classmethod
 
2846
    def _get_repo_format_to_test(self):
 
2847
        from bzrlib.repofmt import knitrepo
 
2848
        return knitrepo.RepositoryFormatKnit1()
1983
2849
 
1984
2850
    @staticmethod
1985
2851
    def is_compatible(source, target):
1989
2855
        could lead to confusing results, and there is no need to be 
1990
2856
        overly general.
1991
2857
        """
 
2858
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
1992
2859
        try:
1993
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1994
 
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
2860
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
2861
                isinstance(target._format, RepositoryFormatKnit))
1995
2862
        except AttributeError:
1996
2863
            return False
 
2864
        return are_knits and InterRepository._same_model(source, target)
1997
2865
 
1998
2866
    @needs_write_lock
1999
 
    def fetch(self, revision_id=None, pb=None):
 
2867
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2000
2868
        """See InterRepository.fetch()."""
2001
 
        from bzrlib.fetch import KnitRepoFetcher
 
2869
        from bzrlib.fetch import RepoFetcher
2002
2870
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2003
2871
               self.source, self.source._format, self.target, self.target._format)
2004
 
        f = KnitRepoFetcher(to_repository=self.target,
 
2872
        f = RepoFetcher(to_repository=self.target,
2005
2873
                            from_repository=self.source,
2006
2874
                            last_revision=revision_id,
2007
 
                            pb=pb)
 
2875
                            pb=pb, find_ghosts=find_ghosts)
2008
2876
        return f.count_copied, f.failed_revisions
2009
2877
 
2010
2878
    @needs_read_lock
2011
 
    def missing_revision_ids(self, revision_id=None):
 
2879
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
2012
2880
        """See InterRepository.missing_revision_ids()."""
2013
2881
        if revision_id is not None:
2014
2882
            source_ids = self.source.get_ancestry(revision_id)
2015
 
            assert source_ids[0] is None
 
2883
            if source_ids[0] is not None:
 
2884
                raise AssertionError()
2016
2885
            source_ids.pop(0)
2017
2886
        else:
2018
 
            source_ids = self.source._all_possible_ids()
 
2887
            source_ids = self.source.all_revision_ids()
2019
2888
        source_ids_set = set(source_ids)
2020
2889
        # source_ids is the worst possible case we may need to pull.
2021
2890
        # now we want to filter source_ids against what we actually
2022
2891
        # have in target, but don't try to check for existence where we know
2023
2892
        # we do not have a revision as that would be pointless.
2024
 
        target_ids = set(self.target._all_possible_ids())
 
2893
        target_ids = set(self.target.all_revision_ids())
2025
2894
        possibly_present_revisions = target_ids.intersection(source_ids_set)
2026
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
2895
        actually_present_revisions = set(
 
2896
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
2027
2897
        required_revisions = source_ids_set.difference(actually_present_revisions)
2028
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
2029
2898
        if revision_id is not None:
2030
2899
            # we used get_ancestry to determine source_ids then we are assured all
2031
2900
            # revisions referenced are present as they are installed in topological order.
2032
2901
            # and the tip revision was validated by get_ancestry.
2033
 
            return required_topo_revisions
 
2902
            result_set = required_revisions
2034
2903
        else:
2035
2904
            # if we just grabbed the possibly available ids, then 
2036
2905
            # we only have an estimate of whats available and need to validate
2037
2906
            # that against the revision records.
2038
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
2907
            result_set = set(
 
2908
                self.source._eliminate_revisions_not_present(required_revisions))
 
2909
        return self.source.revision_ids_to_search_result(result_set)
 
2910
 
 
2911
 
 
2912
class InterPackRepo(InterSameDataRepository):
 
2913
    """Optimised code paths between Pack based repositories."""
 
2914
 
 
2915
    @classmethod
 
2916
    def _get_repo_format_to_test(self):
 
2917
        from bzrlib.repofmt import pack_repo
 
2918
        return pack_repo.RepositoryFormatKnitPack1()
 
2919
 
 
2920
    @staticmethod
 
2921
    def is_compatible(source, target):
 
2922
        """Be compatible with known Pack formats.
 
2923
        
 
2924
        We don't test for the stores being of specific types because that
 
2925
        could lead to confusing results, and there is no need to be 
 
2926
        overly general.
 
2927
        """
 
2928
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
2929
        try:
 
2930
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
2931
                isinstance(target._format, RepositoryFormatPack))
 
2932
        except AttributeError:
 
2933
            return False
 
2934
        return are_packs and InterRepository._same_model(source, target)
 
2935
 
 
2936
    @needs_write_lock
 
2937
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
2938
        """See InterRepository.fetch()."""
 
2939
        if (len(self.source._fallback_repositories) > 0 or
 
2940
            len(self.target._fallback_repositories) > 0):
 
2941
            # The pack layer is not aware of fallback repositories, so when
 
2942
            # fetching from a stacked repository or into a stacked repository
 
2943
            # we use the generic fetch logic which uses the VersionedFiles
 
2944
            # attributes on repository.
 
2945
            from bzrlib.fetch import RepoFetcher
 
2946
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
2947
                                  pb, find_ghosts)
 
2948
            return fetcher.count_copied, fetcher.failed_revisions
 
2949
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
2950
               self.source, self.source._format, self.target, self.target._format)
 
2951
        self.count_copied = 0
 
2952
        if revision_id is None:
 
2953
            # TODO:
 
2954
            # everything to do - use pack logic
 
2955
            # to fetch from all packs to one without
 
2956
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
2957
            # till then:
 
2958
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
2959
            revision_ids = source_revision_ids - \
 
2960
                frozenset(self.target_get_parent_map(source_revision_ids))
 
2961
            revision_keys = [(revid,) for revid in revision_ids]
 
2962
            target_pack_collection = self._get_target_pack_collection()
 
2963
            index = target_pack_collection.revision_index.combined_index
 
2964
            present_revision_ids = set(item[1][0] for item in
 
2965
                index.iter_entries(revision_keys))
 
2966
            revision_ids = set(revision_ids) - present_revision_ids
 
2967
            # implementing the TODO will involve:
 
2968
            # - detecting when all of a pack is selected
 
2969
            # - avoiding as much as possible pre-selection, so the
 
2970
            # more-core routines such as create_pack_from_packs can filter in
 
2971
            # a just-in-time fashion. (though having a HEADS list on a
 
2972
            # repository might make this a lot easier, because we could
 
2973
            # sensibly detect 'new revisions' without doing a full index scan.
 
2974
        elif _mod_revision.is_null(revision_id):
 
2975
            # nothing to do:
 
2976
            return (0, [])
 
2977
        else:
 
2978
            try:
 
2979
                revision_ids = self.search_missing_revision_ids(revision_id,
 
2980
                    find_ghosts=find_ghosts).get_keys()
 
2981
            except errors.NoSuchRevision:
 
2982
                raise errors.InstallFailed([revision_id])
 
2983
            if len(revision_ids) == 0:
 
2984
                return (0, [])
 
2985
        return self._pack(self.source, self.target, revision_ids)
 
2986
 
 
2987
    def _pack(self, source, target, revision_ids):
 
2988
        from bzrlib.repofmt.pack_repo import Packer
 
2989
        target_pack_collection = self._get_target_pack_collection()
 
2990
        packs = source._pack_collection.all_packs()
 
2991
        pack = Packer(target_pack_collection, packs, '.fetch',
 
2992
            revision_ids).pack()
 
2993
        if pack is not None:
 
2994
            target_pack_collection._save_pack_names()
 
2995
            copied_revs = pack.get_revision_count()
 
2996
            # Trigger an autopack. This may duplicate effort as we've just done
 
2997
            # a pack creation, but for now it is simpler to think about as
 
2998
            # 'upload data, then repack if needed'.
 
2999
            self._autopack()
 
3000
            return (copied_revs, [])
 
3001
        else:
 
3002
            return (0, [])
 
3003
 
 
3004
    def _autopack(self):
 
3005
        self.target._pack_collection.autopack()
 
3006
        
 
3007
    def _get_target_pack_collection(self):
 
3008
        return self.target._pack_collection
 
3009
 
 
3010
    @needs_read_lock
 
3011
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3012
        """See InterRepository.missing_revision_ids().
 
3013
        
 
3014
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3015
            revision_id.
 
3016
        """
 
3017
        if not find_ghosts and revision_id is not None:
 
3018
            return self._walk_to_common_revisions([revision_id])
 
3019
        elif revision_id is not None:
 
3020
            # Find ghosts: search for revisions pointing from one repository to
 
3021
            # the other, and vice versa, anywhere in the history of revision_id.
 
3022
            graph = self.target_get_graph(other_repository=self.source)
 
3023
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3024
            found_ids = set()
 
3025
            while True:
 
3026
                try:
 
3027
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3028
                except StopIteration:
 
3029
                    break
 
3030
                if revision_id in ghosts:
 
3031
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3032
                found_ids.update(next_revs)
 
3033
                found_ids.update(ghosts)
 
3034
            found_ids = frozenset(found_ids)
 
3035
            # Double query here: should be able to avoid this by changing the
 
3036
            # graph api further.
 
3037
            result_set = found_ids - frozenset(
 
3038
                self.target_get_parent_map(found_ids))
 
3039
        else:
 
3040
            source_ids = self.source.all_revision_ids()
 
3041
            # source_ids is the worst possible case we may need to pull.
 
3042
            # now we want to filter source_ids against what we actually
 
3043
            # have in target, but don't try to check for existence where we know
 
3044
            # we do not have a revision as that would be pointless.
 
3045
            target_ids = set(self.target.all_revision_ids())
 
3046
            result_set = set(source_ids).difference(target_ids)
 
3047
        return self.source.revision_ids_to_search_result(result_set)
2039
3048
 
2040
3049
 
2041
3050
class InterModel1and2(InterRepository):
2042
3051
 
2043
 
    _matching_repo_format = None
 
3052
    @classmethod
 
3053
    def _get_repo_format_to_test(self):
 
3054
        return None
2044
3055
 
2045
3056
    @staticmethod
2046
3057
    def is_compatible(source, target):
2047
 
        if not isinstance(source, Repository):
2048
 
            return False
2049
 
        if not isinstance(target, Repository):
2050
 
            return False
2051
 
        if not source._format.rich_root_data and target._format.rich_root_data:
 
3058
        if not source.supports_rich_root() and target.supports_rich_root():
2052
3059
            return True
2053
3060
        else:
2054
3061
            return False
2055
3062
 
2056
3063
    @needs_write_lock
2057
 
    def fetch(self, revision_id=None, pb=None):
 
3064
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2058
3065
        """See InterRepository.fetch()."""
2059
3066
        from bzrlib.fetch import Model1toKnit2Fetcher
2060
3067
        f = Model1toKnit2Fetcher(to_repository=self.target,
2061
3068
                                 from_repository=self.source,
2062
3069
                                 last_revision=revision_id,
2063
 
                                 pb=pb)
 
3070
                                 pb=pb, find_ghosts=find_ghosts)
2064
3071
        return f.count_copied, f.failed_revisions
2065
3072
 
2066
3073
    @needs_write_lock
2067
 
    def copy_content(self, revision_id=None, basis=None):
 
3074
    def copy_content(self, revision_id=None):
2068
3075
        """Make a complete copy of the content in self into destination.
2069
3076
        
2070
3077
        This is a destructive operation! Do not use it on existing 
2072
3079
 
2073
3080
        :param revision_id: Only copy the content needed to construct
2074
3081
                            revision_id and its parents.
2075
 
        :param basis: Copy the needed data preferentially from basis.
2076
3082
        """
2077
3083
        try:
2078
3084
            self.target.set_make_working_trees(self.source.make_working_trees())
2079
3085
        except NotImplementedError:
2080
3086
            pass
2081
 
        # grab the basis available data
2082
 
        if basis is not None:
2083
 
            self.target.fetch(basis, revision_id=revision_id)
2084
3087
        # but don't bother fetching if we have the needed data now.
2085
3088
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
2086
3089
            self.target.has_revision(revision_id)):
2090
3093
 
2091
3094
class InterKnit1and2(InterKnitRepo):
2092
3095
 
2093
 
    _matching_repo_format = None
 
3096
    @classmethod
 
3097
    def _get_repo_format_to_test(self):
 
3098
        return None
2094
3099
 
2095
3100
    @staticmethod
2096
3101
    def is_compatible(source, target):
2097
 
        """Be compatible with Knit1 source and Knit2 target"""
 
3102
        """Be compatible with Knit1 source and Knit3 target"""
2098
3103
        try:
2099
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
2100
 
                    isinstance(target._format, (RepositoryFormatKnit2)))
 
3104
            from bzrlib.repofmt.knitrepo import (
 
3105
                RepositoryFormatKnit1,
 
3106
                RepositoryFormatKnit3,
 
3107
                )
 
3108
            from bzrlib.repofmt.pack_repo import (
 
3109
                RepositoryFormatKnitPack1,
 
3110
                RepositoryFormatKnitPack3,
 
3111
                RepositoryFormatKnitPack4,
 
3112
                RepositoryFormatKnitPack5,
 
3113
                RepositoryFormatKnitPack5RichRoot,
 
3114
                RepositoryFormatKnitPack6,
 
3115
                RepositoryFormatKnitPack6RichRoot,
 
3116
                RepositoryFormatPackDevelopment2,
 
3117
                RepositoryFormatPackDevelopment2Subtree,
 
3118
                )
 
3119
            norichroot = (
 
3120
                RepositoryFormatKnit1,            # no rr, no subtree
 
3121
                RepositoryFormatKnitPack1,        # no rr, no subtree
 
3122
                RepositoryFormatPackDevelopment2, # no rr, no subtree
 
3123
                RepositoryFormatKnitPack5,        # no rr, no subtree
 
3124
                RepositoryFormatKnitPack6,        # no rr, no subtree
 
3125
                )
 
3126
            richroot = (
 
3127
                RepositoryFormatKnit3,            # rr, subtree
 
3128
                RepositoryFormatKnitPack3,        # rr, subtree
 
3129
                RepositoryFormatKnitPack4,        # rr, no subtree
 
3130
                RepositoryFormatKnitPack5RichRoot,# rr, no subtree
 
3131
                RepositoryFormatKnitPack6RichRoot,# rr, no subtree
 
3132
                RepositoryFormatPackDevelopment2Subtree, # rr, subtree
 
3133
                )
 
3134
            for format in norichroot:
 
3135
                if format.rich_root_data:
 
3136
                    raise AssertionError('Format %s is a rich-root format'
 
3137
                        ' but is included in the non-rich-root list'
 
3138
                        % (format,))
 
3139
            for format in richroot:
 
3140
                if not format.rich_root_data:
 
3141
                    raise AssertionError('Format %s is not a rich-root format'
 
3142
                        ' but is included in the rich-root list'
 
3143
                        % (format,))
 
3144
            # TODO: One alternative is to just check format.rich_root_data,
 
3145
            #       instead of keeping membership lists. However, the formats
 
3146
            #       *also* have to use the same 'Knit' style of storage
 
3147
            #       (line-deltas, fulltexts, etc.)
 
3148
            return (isinstance(source._format, norichroot) and
 
3149
                    isinstance(target._format, richroot))
2101
3150
        except AttributeError:
2102
3151
            return False
2103
3152
 
2104
3153
    @needs_write_lock
2105
 
    def fetch(self, revision_id=None, pb=None):
 
3154
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
2106
3155
        """See InterRepository.fetch()."""
2107
3156
        from bzrlib.fetch import Knit1to2Fetcher
2108
3157
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
2111
3160
        f = Knit1to2Fetcher(to_repository=self.target,
2112
3161
                            from_repository=self.source,
2113
3162
                            last_revision=revision_id,
2114
 
                            pb=pb)
 
3163
                            pb=pb, find_ghosts=find_ghosts)
2115
3164
        return f.count_copied, f.failed_revisions
2116
3165
 
2117
3166
 
 
3167
class InterDifferingSerializer(InterKnitRepo):
 
3168
 
 
3169
    @classmethod
 
3170
    def _get_repo_format_to_test(self):
 
3171
        return None
 
3172
 
 
3173
    @staticmethod
 
3174
    def is_compatible(source, target):
 
3175
        """Be compatible with Knit2 source and Knit3 target"""
 
3176
        if source.supports_rich_root() != target.supports_rich_root():
 
3177
            return False
 
3178
        # Ideally, we'd support fetching if the source had no tree references
 
3179
        # even if it supported them...
 
3180
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3181
            not getattr(target, '_format.supports_tree_reference', False)):
 
3182
            return False
 
3183
        return True
 
3184
 
 
3185
    def _fetch_batch(self, revision_ids, basis_id, basis_tree):
 
3186
        """Fetch across a few revisions.
 
3187
 
 
3188
        :param revision_ids: The revisions to copy
 
3189
        :param basis_id: The revision_id of basis_tree
 
3190
        :param basis_tree: A tree that is not in revision_ids which should
 
3191
            already exist in the target.
 
3192
        :return: (basis_id, basis_tree) A new basis to use now that these trees
 
3193
            have been copied.
 
3194
        """
 
3195
        # Walk though all revisions; get inventory deltas, copy referenced
 
3196
        # texts that delta references, insert the delta, revision and
 
3197
        # signature.
 
3198
        text_keys = set()
 
3199
        pending_deltas = []
 
3200
        pending_revisions = []
 
3201
        for tree in self.source.revision_trees(revision_ids):
 
3202
            current_revision_id = tree.get_revision_id()
 
3203
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3204
            for old_path, new_path, file_id, entry in delta:
 
3205
                if new_path is not None:
 
3206
                    if not (new_path or self.target.supports_rich_root()):
 
3207
                        # We leave the inventory delta in, because that
 
3208
                        # will have the deserialised inventory root
 
3209
                        # pointer.
 
3210
                        continue
 
3211
                    # TODO: Do we need:
 
3212
                    #       "if entry.revision == current_revision_id" ?
 
3213
                    if entry.revision == current_revision_id:
 
3214
                        text_keys.add((file_id, entry.revision))
 
3215
            revision = self.source.get_revision(current_revision_id)
 
3216
            pending_deltas.append((basis_id, delta,
 
3217
                current_revision_id, revision.parent_ids))
 
3218
            pending_revisions.append(revision)
 
3219
            basis_id = current_revision_id
 
3220
            basis_tree = tree
 
3221
        # Copy file texts
 
3222
        from_texts = self.source.texts
 
3223
        to_texts = self.target.texts
 
3224
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3225
            text_keys, self.target._fetch_order,
 
3226
            not self.target._fetch_uses_deltas))
 
3227
        # insert deltas
 
3228
        for delta in pending_deltas:
 
3229
            self.target.add_inventory_by_delta(*delta)
 
3230
        # insert signatures and revisions
 
3231
        for revision in pending_revisions:
 
3232
            try:
 
3233
                signature = self.source.get_signature_text(
 
3234
                    revision.revision_id)
 
3235
                self.target.add_signature_text(revision.revision_id,
 
3236
                    signature)
 
3237
            except errors.NoSuchRevision:
 
3238
                pass
 
3239
            self.target.add_revision(revision.revision_id, revision)
 
3240
        return basis_id, basis_tree
 
3241
 
 
3242
    def _fetch_all_revisions(self, revision_ids, pb):
 
3243
        """Fetch everything for the list of revisions.
 
3244
 
 
3245
        :param revision_ids: The list of revisions to fetch. Must be in
 
3246
            topological order.
 
3247
        :param pb: A ProgressBar
 
3248
        :return: None
 
3249
        """
 
3250
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3251
        batch_size = 100
 
3252
        for offset in range(0, len(revision_ids), batch_size):
 
3253
            self.target.start_write_group()
 
3254
            try:
 
3255
                pb.update('Transferring revisions', offset,
 
3256
                          len(revision_ids))
 
3257
                batch = revision_ids[offset:offset+batch_size]
 
3258
                basis_id, basis_tree = self._fetch_batch(batch,
 
3259
                    basis_id, basis_tree)
 
3260
            except:
 
3261
                self.target.abort_write_group()
 
3262
                raise
 
3263
            else:
 
3264
                self.target.commit_write_group()
 
3265
        pb.update('Transferring revisions', len(revision_ids),
 
3266
                  len(revision_ids))
 
3267
 
 
3268
    @needs_write_lock
 
3269
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3270
        """See InterRepository.fetch()."""
 
3271
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
3272
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3273
        if not revision_ids:
 
3274
            return 0, 0
 
3275
        revision_ids = tsort.topo_sort(
 
3276
            self.source.get_graph().get_parent_map(revision_ids))
 
3277
        if pb is None:
 
3278
            my_pb = ui.ui_factory.nested_progress_bar()
 
3279
            pb = my_pb
 
3280
        else:
 
3281
            my_pb = None
 
3282
        try:
 
3283
            self._fetch_all_revisions(revision_ids, pb)
 
3284
        finally:
 
3285
            if my_pb is not None:
 
3286
                my_pb.finished()
 
3287
        return len(revision_ids), 0
 
3288
 
 
3289
    def _get_basis(self, first_revision_id):
 
3290
        """Get a revision and tree which exists in the target.
 
3291
 
 
3292
        This assumes that first_revision_id is selected for transmission
 
3293
        because all other ancestors are already present. If we can't find an
 
3294
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
3295
 
 
3296
        :return: (basis_id, basis_tree)
 
3297
        """
 
3298
        first_rev = self.source.get_revision(first_revision_id)
 
3299
        try:
 
3300
            basis_id = first_rev.parent_ids[0]
 
3301
            # only valid as a basis if the target has it
 
3302
            self.target.get_revision(basis_id)
 
3303
            # Try to get a basis tree - if its a ghost it will hit the
 
3304
            # NoSuchRevision case.
 
3305
            basis_tree = self.source.revision_tree(basis_id)
 
3306
        except (IndexError, errors.NoSuchRevision):
 
3307
            basis_id = _mod_revision.NULL_REVISION
 
3308
            basis_tree = self.source.revision_tree(basis_id)
 
3309
        return basis_id, basis_tree
 
3310
 
 
3311
 
 
3312
class InterOtherToRemote(InterRepository):
 
3313
    """An InterRepository that simply delegates to the 'real' InterRepository
 
3314
    calculated for (source, target._real_repository).
 
3315
    """
 
3316
 
 
3317
    _walk_to_common_revisions_batch_size = 50
 
3318
 
 
3319
    def __init__(self, source, target):
 
3320
        InterRepository.__init__(self, source, target)
 
3321
        self._real_inter = None
 
3322
 
 
3323
    @staticmethod
 
3324
    def is_compatible(source, target):
 
3325
        if isinstance(target, remote.RemoteRepository):
 
3326
            return True
 
3327
        return False
 
3328
 
 
3329
    def _ensure_real_inter(self):
 
3330
        if self._real_inter is None:
 
3331
            self.target._ensure_real()
 
3332
            real_target = self.target._real_repository
 
3333
            self._real_inter = InterRepository.get(self.source, real_target)
 
3334
            # Make _real_inter use the RemoteRepository for get_parent_map
 
3335
            self._real_inter.target_get_graph = self.target.get_graph
 
3336
            self._real_inter.target_get_parent_map = self.target.get_parent_map
 
3337
    
 
3338
    def copy_content(self, revision_id=None):
 
3339
        self._ensure_real_inter()
 
3340
        self._real_inter.copy_content(revision_id=revision_id)
 
3341
 
 
3342
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3343
        self._ensure_real_inter()
 
3344
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3345
            find_ghosts=find_ghosts)
 
3346
 
 
3347
    @classmethod
 
3348
    def _get_repo_format_to_test(self):
 
3349
        return None
 
3350
 
 
3351
 
 
3352
class InterRemoteToOther(InterRepository):
 
3353
 
 
3354
    def __init__(self, source, target):
 
3355
        InterRepository.__init__(self, source, target)
 
3356
        self._real_inter = None
 
3357
 
 
3358
    @staticmethod
 
3359
    def is_compatible(source, target):
 
3360
        if not isinstance(source, remote.RemoteRepository):
 
3361
            return False
 
3362
        # Is source's model compatible with target's model?
 
3363
        source._ensure_real()
 
3364
        real_source = source._real_repository
 
3365
        if isinstance(real_source, remote.RemoteRepository):
 
3366
            raise NotImplementedError(
 
3367
                "We don't support remote repos backed by remote repos yet.")
 
3368
        return InterRepository._same_model(real_source, target)
 
3369
 
 
3370
    def _ensure_real_inter(self):
 
3371
        if self._real_inter is None:
 
3372
            self.source._ensure_real()
 
3373
            real_source = self.source._real_repository
 
3374
            self._real_inter = InterRepository.get(real_source, self.target)
 
3375
    
 
3376
    def fetch(self, revision_id=None, pb=None, find_ghosts=False):
 
3377
        self._ensure_real_inter()
 
3378
        return self._real_inter.fetch(revision_id=revision_id, pb=pb,
 
3379
            find_ghosts=find_ghosts)
 
3380
 
 
3381
    def copy_content(self, revision_id=None):
 
3382
        self._ensure_real_inter()
 
3383
        self._real_inter.copy_content(revision_id=revision_id)
 
3384
 
 
3385
    @classmethod
 
3386
    def _get_repo_format_to_test(self):
 
3387
        return None
 
3388
 
 
3389
 
 
3390
 
 
3391
class InterPackToRemotePack(InterPackRepo):
 
3392
    """A specialisation of InterPackRepo for a target that is a
 
3393
    RemoteRepository.
 
3394
 
 
3395
    This will use the get_parent_map RPC rather than plain readvs, and also
 
3396
    uses an RPC for autopacking.
 
3397
    """
 
3398
 
 
3399
    _walk_to_common_revisions_batch_size = 50
 
3400
 
 
3401
    @staticmethod
 
3402
    def is_compatible(source, target):
 
3403
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3404
        if isinstance(source._format, RepositoryFormatPack):
 
3405
            if isinstance(target, remote.RemoteRepository):
 
3406
                target._ensure_real()
 
3407
                if isinstance(target._real_repository._format,
 
3408
                              RepositoryFormatPack):
 
3409
                    if InterRepository._same_model(source, target):
 
3410
                        return True
 
3411
        return False
 
3412
    
 
3413
    def _autopack(self):
 
3414
        self.target.autopack()
 
3415
        
 
3416
    def _get_target_pack_collection(self):
 
3417
        return self.target._real_repository._pack_collection
 
3418
 
 
3419
    @classmethod
 
3420
    def _get_repo_format_to_test(self):
 
3421
        return None
 
3422
 
 
3423
 
 
3424
InterRepository.register_optimiser(InterDifferingSerializer)
2118
3425
InterRepository.register_optimiser(InterSameDataRepository)
2119
3426
InterRepository.register_optimiser(InterWeaveRepo)
2120
3427
InterRepository.register_optimiser(InterKnitRepo)
2121
3428
InterRepository.register_optimiser(InterModel1and2)
2122
3429
InterRepository.register_optimiser(InterKnit1and2)
2123
 
 
2124
 
 
2125
 
class RepositoryTestProviderAdapter(object):
2126
 
    """A tool to generate a suite testing multiple repository formats at once.
2127
 
 
2128
 
    This is done by copying the test once for each transport and injecting
2129
 
    the transport_server, transport_readonly_server, and bzrdir_format and
2130
 
    repository_format classes into each copy. Each copy is also given a new id()
2131
 
    to make it easy to identify.
2132
 
    """
2133
 
 
2134
 
    def __init__(self, transport_server, transport_readonly_server, formats):
2135
 
        self._transport_server = transport_server
2136
 
        self._transport_readonly_server = transport_readonly_server
2137
 
        self._formats = formats
2138
 
    
2139
 
    def adapt(self, test):
2140
 
        result = unittest.TestSuite()
2141
 
        for repository_format, bzrdir_format in self._formats:
2142
 
            new_test = deepcopy(test)
2143
 
            new_test.transport_server = self._transport_server
2144
 
            new_test.transport_readonly_server = self._transport_readonly_server
2145
 
            new_test.bzrdir_format = bzrdir_format
2146
 
            new_test.repository_format = repository_format
2147
 
            def make_new_test_id():
2148
 
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
2149
 
                return lambda: new_id
2150
 
            new_test.id = make_new_test_id()
2151
 
            result.addTest(new_test)
2152
 
        return result
2153
 
 
2154
 
 
2155
 
class InterRepositoryTestProviderAdapter(object):
2156
 
    """A tool to generate a suite testing multiple inter repository formats.
2157
 
 
2158
 
    This is done by copying the test once for each interrepo provider and injecting
2159
 
    the transport_server, transport_readonly_server, repository_format and 
2160
 
    repository_to_format classes into each copy.
2161
 
    Each copy is also given a new id() to make it easy to identify.
2162
 
    """
2163
 
 
2164
 
    def __init__(self, transport_server, transport_readonly_server, formats):
2165
 
        self._transport_server = transport_server
2166
 
        self._transport_readonly_server = transport_readonly_server
2167
 
        self._formats = formats
2168
 
    
2169
 
    def adapt(self, test):
2170
 
        result = unittest.TestSuite()
2171
 
        for interrepo_class, repository_format, repository_format_to in self._formats:
2172
 
            new_test = deepcopy(test)
2173
 
            new_test.transport_server = self._transport_server
2174
 
            new_test.transport_readonly_server = self._transport_readonly_server
2175
 
            new_test.interrepo_class = interrepo_class
2176
 
            new_test.repository_format = repository_format
2177
 
            new_test.repository_format_to = repository_format_to
2178
 
            def make_new_test_id():
2179
 
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
2180
 
                return lambda: new_id
2181
 
            new_test.id = make_new_test_id()
2182
 
            result.addTest(new_test)
2183
 
        return result
2184
 
 
2185
 
    @staticmethod
2186
 
    def default_test_list():
2187
 
        """Generate the default list of interrepo permutations to test."""
2188
 
        result = []
2189
 
        # test the default InterRepository between format 6 and the current 
2190
 
        # default format.
2191
 
        # XXX: robertc 20060220 reinstate this when there are two supported
2192
 
        # formats which do not have an optimal code path between them.
2193
 
        #result.append((InterRepository,
2194
 
        #               RepositoryFormat6(),
2195
 
        #               RepositoryFormatKnit1()))
2196
 
        for optimiser in InterRepository._optimisers:
2197
 
            if optimiser._matching_repo_format is not None:
2198
 
                result.append((optimiser,
2199
 
                               optimiser._matching_repo_format,
2200
 
                               optimiser._matching_repo_format
2201
 
                               ))
2202
 
        # if there are specific combinations we want to use, we can add them 
2203
 
        # here.
2204
 
        result.append((InterModel1and2, RepositoryFormat5(),
2205
 
                       RepositoryFormatKnit2()))
2206
 
        result.append((InterKnit1and2, RepositoryFormatKnit1(),
2207
 
                       RepositoryFormatKnit2()))
2208
 
        return result
 
3430
InterRepository.register_optimiser(InterPackRepo)
 
3431
InterRepository.register_optimiser(InterOtherToRemote)
 
3432
InterRepository.register_optimiser(InterRemoteToOther)
 
3433
InterRepository.register_optimiser(InterPackToRemotePack)
2209
3434
 
2210
3435
 
2211
3436
class CopyConverter(object):
2260
3485
        self.pb.update(message, self.count, self.total)
2261
3486
 
2262
3487
 
2263
 
class CommitBuilder(object):
2264
 
    """Provides an interface to build up a commit.
2265
 
 
2266
 
    This allows describing a tree to be committed without needing to 
2267
 
    know the internals of the format of the repository.
2268
 
    """
2269
 
    
2270
 
    record_root_entry = False
2271
 
    def __init__(self, repository, parents, config, timestamp=None, 
2272
 
                 timezone=None, committer=None, revprops=None, 
2273
 
                 revision_id=None):
2274
 
        """Initiate a CommitBuilder.
2275
 
 
2276
 
        :param repository: Repository to commit to.
2277
 
        :param parents: Revision ids of the parents of the new revision.
2278
 
        :param config: Configuration to use.
2279
 
        :param timestamp: Optional timestamp recorded for commit.
2280
 
        :param timezone: Optional timezone for timestamp.
2281
 
        :param committer: Optional committer to set for commit.
2282
 
        :param revprops: Optional dictionary of revision properties.
2283
 
        :param revision_id: Optional revision id.
2284
 
        """
2285
 
        self._config = config
2286
 
 
2287
 
        if committer is None:
2288
 
            self._committer = self._config.username()
2289
 
        else:
2290
 
            assert isinstance(committer, basestring), type(committer)
2291
 
            self._committer = committer
2292
 
 
2293
 
        self.new_inventory = Inventory(None)
2294
 
        self._new_revision_id = revision_id
2295
 
        self.parents = parents
2296
 
        self.repository = repository
2297
 
 
2298
 
        self._revprops = {}
2299
 
        if revprops is not None:
2300
 
            self._revprops.update(revprops)
2301
 
 
2302
 
        if timestamp is None:
2303
 
            timestamp = time.time()
2304
 
        # Restrict resolution to 1ms
2305
 
        self._timestamp = round(timestamp, 3)
2306
 
 
2307
 
        if timezone is None:
2308
 
            self._timezone = local_time_offset()
2309
 
        else:
2310
 
            self._timezone = int(timezone)
2311
 
 
2312
 
        self._generate_revision_if_needed()
2313
 
 
2314
 
    def commit(self, message):
2315
 
        """Make the actual commit.
2316
 
 
2317
 
        :return: The revision id of the recorded revision.
2318
 
        """
2319
 
        rev = _mod_revision.Revision(
2320
 
                       timestamp=self._timestamp,
2321
 
                       timezone=self._timezone,
2322
 
                       committer=self._committer,
2323
 
                       message=message,
2324
 
                       inventory_sha1=self.inv_sha1,
2325
 
                       revision_id=self._new_revision_id,
2326
 
                       properties=self._revprops)
2327
 
        rev.parent_ids = self.parents
2328
 
        self.repository.add_revision(self._new_revision_id, rev, 
2329
 
            self.new_inventory, self._config)
2330
 
        return self._new_revision_id
2331
 
 
2332
 
    def revision_tree(self):
2333
 
        """Return the tree that was just committed.
2334
 
 
2335
 
        After calling commit() this can be called to get a RevisionTree
2336
 
        representing the newly committed tree. This is preferred to
2337
 
        calling Repository.revision_tree() because that may require
2338
 
        deserializing the inventory, while we already have a copy in
2339
 
        memory.
2340
 
        """
2341
 
        return RevisionTree(self.repository, self.new_inventory,
2342
 
                            self._new_revision_id)
2343
 
 
2344
 
    def finish_inventory(self):
2345
 
        """Tell the builder that the inventory is finished."""
2346
 
        if self.new_inventory.root is None:
2347
 
            symbol_versioning.warn('Root entry should be supplied to'
2348
 
                ' record_entry_contents, as of bzr 0.10.',
2349
 
                 DeprecationWarning, stacklevel=2)
2350
 
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
2351
 
        self.new_inventory.revision_id = self._new_revision_id
2352
 
        self.inv_sha1 = self.repository.add_inventory(
2353
 
            self._new_revision_id,
2354
 
            self.new_inventory,
2355
 
            self.parents
2356
 
            )
2357
 
 
2358
 
    def _gen_revision_id(self):
2359
 
        """Return new revision-id."""
2360
 
        s = '%s-%s-' % (self._config.user_email(), 
2361
 
                        compact_date(self._timestamp))
2362
 
        s += hexlify(rand_bytes(8))
2363
 
        return s
2364
 
 
2365
 
    def _generate_revision_if_needed(self):
2366
 
        """Create a revision id if None was supplied.
2367
 
        
2368
 
        If the repository can not support user-specified revision ids
2369
 
        they should override this function and raise UnsupportedOperation
2370
 
        if _new_revision_id is not None.
2371
 
 
2372
 
        :raises: UnsupportedOperation
2373
 
        """
2374
 
        if self._new_revision_id is None:
2375
 
            self._new_revision_id = self._gen_revision_id()
2376
 
 
2377
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2378
 
        """Record the content of ie from tree into the commit if needed.
2379
 
 
2380
 
        Side effect: sets ie.revision when unchanged
2381
 
 
2382
 
        :param ie: An inventory entry present in the commit.
2383
 
        :param parent_invs: The inventories of the parent revisions of the
2384
 
            commit.
2385
 
        :param path: The path the entry is at in the tree.
2386
 
        :param tree: The tree which contains this entry and should be used to 
2387
 
        obtain content.
2388
 
        """
2389
 
        if self.new_inventory.root is None and ie.parent_id is not None:
2390
 
            symbol_versioning.warn('Root entry should be supplied to'
2391
 
                ' record_entry_contents, as of bzr 0.10.',
2392
 
                 DeprecationWarning, stacklevel=2)
2393
 
            self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
2394
 
                                       '', tree)
2395
 
        self.new_inventory.add(ie)
2396
 
 
2397
 
        # ie.revision is always None if the InventoryEntry is considered
2398
 
        # for committing. ie.snapshot will record the correct revision 
2399
 
        # which may be the sole parent if it is untouched.
2400
 
        if ie.revision is not None:
2401
 
            return
2402
 
 
2403
 
        # In this revision format, root entries have no knit or weave
2404
 
        if ie is self.new_inventory.root:
2405
 
            # When serializing out to disk and back in
2406
 
            # root.revision is always _new_revision_id
2407
 
            ie.revision = self._new_revision_id
2408
 
            return
2409
 
        previous_entries = ie.find_previous_heads(
2410
 
            parent_invs,
2411
 
            self.repository.weave_store,
2412
 
            self.repository.get_transaction())
2413
 
        # we are creating a new revision for ie in the history store
2414
 
        # and inventory.
2415
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2416
 
 
2417
 
    def modified_directory(self, file_id, file_parents):
2418
 
        """Record the presence of a symbolic link.
2419
 
 
2420
 
        :param file_id: The file_id of the link to record.
2421
 
        :param file_parents: The per-file parent revision ids.
2422
 
        """
2423
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2424
 
    
2425
 
    def modified_file_text(self, file_id, file_parents,
2426
 
                           get_content_byte_lines, text_sha1=None,
2427
 
                           text_size=None):
2428
 
        """Record the text of file file_id
2429
 
 
2430
 
        :param file_id: The file_id of the file to record the text of.
2431
 
        :param file_parents: The per-file parent revision ids.
2432
 
        :param get_content_byte_lines: A callable which will return the byte
2433
 
            lines for the file.
2434
 
        :param text_sha1: Optional SHA1 of the file contents.
2435
 
        :param text_size: Optional size of the file contents.
2436
 
        """
2437
 
        # mutter('storing text of file {%s} in revision {%s} into %r',
2438
 
        #        file_id, self._new_revision_id, self.repository.weave_store)
2439
 
        # special case to avoid diffing on renames or 
2440
 
        # reparenting
2441
 
        if (len(file_parents) == 1
2442
 
            and text_sha1 == file_parents.values()[0].text_sha1
2443
 
            and text_size == file_parents.values()[0].text_size):
2444
 
            previous_ie = file_parents.values()[0]
2445
 
            versionedfile = self.repository.weave_store.get_weave(file_id, 
2446
 
                self.repository.get_transaction())
2447
 
            versionedfile.clone_text(self._new_revision_id, 
2448
 
                previous_ie.revision, file_parents.keys())
2449
 
            return text_sha1, text_size
2450
 
        else:
2451
 
            new_lines = get_content_byte_lines()
2452
 
            # TODO: Rather than invoking sha_strings here, _add_text_to_weave
2453
 
            # should return the SHA1 and size
2454
 
            self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2455
 
            return osutils.sha_strings(new_lines), \
2456
 
                sum(map(len, new_lines))
2457
 
 
2458
 
    def modified_link(self, file_id, file_parents, link_target):
2459
 
        """Record the presence of a symbolic link.
2460
 
 
2461
 
        :param file_id: The file_id of the link to record.
2462
 
        :param file_parents: The per-file parent revision ids.
2463
 
        :param link_target: Target location of this link.
2464
 
        """
2465
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2466
 
 
2467
 
    def _add_text_to_weave(self, file_id, new_lines, parents):
2468
 
        versionedfile = self.repository.weave_store.get_weave_or_empty(
2469
 
            file_id, self.repository.get_transaction())
2470
 
        versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2471
 
        versionedfile.clear_cache()
2472
 
 
2473
 
 
2474
 
class _CommitBuilder(CommitBuilder):
2475
 
    """Temporary class so old CommitBuilders are detected properly
2476
 
    
2477
 
    Note: CommitBuilder works whether or not root entry is recorded.
2478
 
    """
2479
 
 
2480
 
    record_root_entry = True
2481
 
 
2482
 
 
2483
 
class RootCommitBuilder(CommitBuilder):
2484
 
    """This commitbuilder actually records the root id"""
2485
 
    
2486
 
    record_root_entry = True
2487
 
 
2488
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2489
 
        """Record the content of ie from tree into the commit if needed.
2490
 
 
2491
 
        Side effect: sets ie.revision when unchanged
2492
 
 
2493
 
        :param ie: An inventory entry present in the commit.
2494
 
        :param parent_invs: The inventories of the parent revisions of the
2495
 
            commit.
2496
 
        :param path: The path the entry is at in the tree.
2497
 
        :param tree: The tree which contains this entry and should be used to 
2498
 
        obtain content.
2499
 
        """
2500
 
        assert self.new_inventory.root is not None or ie.parent_id is None
2501
 
        self.new_inventory.add(ie)
2502
 
 
2503
 
        # ie.revision is always None if the InventoryEntry is considered
2504
 
        # for committing. ie.snapshot will record the correct revision 
2505
 
        # which may be the sole parent if it is untouched.
2506
 
        if ie.revision is not None:
2507
 
            return
2508
 
 
2509
 
        previous_entries = ie.find_previous_heads(
2510
 
            parent_invs,
2511
 
            self.repository.weave_store,
2512
 
            self.repository.get_transaction())
2513
 
        # we are creating a new revision for ie in the history store
2514
 
        # and inventory.
2515
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2516
 
 
2517
 
 
2518
3488
_unescape_map = {
2519
3489
    'apos':"'",
2520
3490
    'quot':'"',
2525
3495
 
2526
3496
 
2527
3497
def _unescaper(match, _map=_unescape_map):
2528
 
    return _map[match.group(1)]
 
3498
    code = match.group(1)
 
3499
    try:
 
3500
        return _map[code]
 
3501
    except KeyError:
 
3502
        if not code.startswith('#'):
 
3503
            raise
 
3504
        return unichr(int(code[1:])).encode('utf8')
2529
3505
 
2530
3506
 
2531
3507
_unescape_re = None
2537
3513
    if _unescape_re is None:
2538
3514
        _unescape_re = re.compile('\&([^;]*);')
2539
3515
    return _unescape_re.sub(_unescaper, data)
 
3516
 
 
3517
 
 
3518
class _VersionedFileChecker(object):
 
3519
 
 
3520
    def __init__(self, repository):
 
3521
        self.repository = repository
 
3522
        self.text_index = self.repository._generate_text_key_index()
 
3523
    
 
3524
    def calculate_file_version_parents(self, text_key):
 
3525
        """Calculate the correct parents for a file version according to
 
3526
        the inventories.
 
3527
        """
 
3528
        parent_keys = self.text_index[text_key]
 
3529
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
3530
            return ()
 
3531
        return tuple(parent_keys)
 
3532
 
 
3533
    def check_file_version_parents(self, texts, progress_bar=None):
 
3534
        """Check the parents stored in a versioned file are correct.
 
3535
 
 
3536
        It also detects file versions that are not referenced by their
 
3537
        corresponding revision's inventory.
 
3538
 
 
3539
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
3540
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
3541
            correct_parents)} for each revision_id where the stored parents
 
3542
            are not correct.  dangling_file_versions is a set of (file_id,
 
3543
            revision_id) tuples for versions that are present in this versioned
 
3544
            file, but not used by the corresponding inventory.
 
3545
        """
 
3546
        wrong_parents = {}
 
3547
        self.file_ids = set([file_id for file_id, _ in
 
3548
            self.text_index.iterkeys()])
 
3549
        # text keys is now grouped by file_id
 
3550
        n_weaves = len(self.file_ids)
 
3551
        files_in_revisions = {}
 
3552
        revisions_of_files = {}
 
3553
        n_versions = len(self.text_index)
 
3554
        progress_bar.update('loading text store', 0, n_versions)
 
3555
        parent_map = self.repository.texts.get_parent_map(self.text_index)
 
3556
        # On unlistable transports this could well be empty/error...
 
3557
        text_keys = self.repository.texts.keys()
 
3558
        unused_keys = frozenset(text_keys) - set(self.text_index)
 
3559
        for num, key in enumerate(self.text_index.iterkeys()):
 
3560
            if progress_bar is not None:
 
3561
                progress_bar.update('checking text graph', num, n_versions)
 
3562
            correct_parents = self.calculate_file_version_parents(key)
 
3563
            try:
 
3564
                knit_parents = parent_map[key]
 
3565
            except errors.RevisionNotPresent:
 
3566
                # Missing text!
 
3567
                knit_parents = None
 
3568
            if correct_parents != knit_parents:
 
3569
                wrong_parents[key] = (knit_parents, correct_parents)
 
3570
        return wrong_parents, unused_keys
 
3571
 
 
3572
 
 
3573
def _old_get_graph(repository, revision_id):
 
3574
    """DO NOT USE. That is all. I'm serious."""
 
3575
    graph = repository.get_graph()
 
3576
    revision_graph = dict(((key, value) for key, value in
 
3577
        graph.iter_ancestry([revision_id]) if value is not None))
 
3578
    return _strip_NULL_ghosts(revision_graph)
 
3579
 
 
3580
 
 
3581
def _strip_NULL_ghosts(revision_graph):
 
3582
    """Also don't use this. more compatibility code for unmigrated clients."""
 
3583
    # Filter ghosts, and null:
 
3584
    if _mod_revision.NULL_REVISION in revision_graph:
 
3585
        del revision_graph[_mod_revision.NULL_REVISION]
 
3586
    for key, parents in revision_graph.items():
 
3587
        revision_graph[key] = tuple(parent for parent in parents if parent
 
3588
            in revision_graph)
 
3589
    return revision_graph