← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2009-10-02 20:32:50 UTC
  • mto: (4679.6.1 2.1-export-c-api)
  • mto: This revision was merged to the branch mainline in revision 4735.
  • Revision ID: john@arbash-meinel.com-20091002203250-q6iv6o2mwjqp4g53
Add __iter__ support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from binascii import hexlify
18
 
from copy import deepcopy
19
 
from cStringIO import StringIO
 
17
from bzrlib.lazy_import import lazy_import
 
18
lazy_import(globals(), """
 
19
import cStringIO
20
20
import re
21
21
import time
22
 
from unittest import TestSuite
23
 
 
24
 
from bzrlib import bzrdir, check, delta, gpg, errors, xml5, ui, transactions, osutils
 
22
 
 
23
from bzrlib import (
 
24
    bzrdir,
 
25
    check,
 
26
    chk_map,
 
27
    debug,
 
28
    errors,
 
29
    fifo_cache,
 
30
    generate_ids,
 
31
    gpg,
 
32
    graph,
 
33
    inventory,
 
34
    inventory_delta,
 
35
    lazy_regex,
 
36
    lockable_files,
 
37
    lockdir,
 
38
    lru_cache,
 
39
    osutils,
 
40
    revision as _mod_revision,
 
41
    symbol_versioning,
 
42
    tsort,
 
43
    ui,
 
44
    versionedfile,
 
45
    )
 
46
from bzrlib.bundle import serializer
 
47
from bzrlib.revisiontree import RevisionTree
 
48
from bzrlib.store.versioned import VersionedFileStore
 
49
from bzrlib.testament import Testament
 
50
""")
 
51
 
25
52
from bzrlib.decorators import needs_read_lock, needs_write_lock
26
 
from bzrlib.errors import InvalidRevisionId
27
 
from bzrlib.graph import Graph
28
53
from bzrlib.inter import InterObject
29
 
from bzrlib.inventory import Inventory
30
 
from bzrlib.knit import KnitVersionedFile, KnitPlainFactory
31
 
from bzrlib.lockable_files import LockableFiles, TransportLock
32
 
from bzrlib.lockdir import LockDir
33
 
from bzrlib.osutils import (safe_unicode, rand_bytes, compact_date, 
34
 
                            local_time_offset)
35
 
from bzrlib.revision import NULL_REVISION, Revision
36
 
from bzrlib.revisiontree import RevisionTree
37
 
from bzrlib.store.versioned import VersionedFileStore, WeaveStore
38
 
from bzrlib.store.text import TextStore
39
 
from bzrlib.symbol_versioning import (deprecated_method,
40
 
        zero_nine, 
41
 
        )
42
 
from bzrlib.testament import Testament
43
 
from bzrlib.trace import mutter, note, warning
44
 
from bzrlib.tsort import topo_sort
45
 
from bzrlib.weave import WeaveFile
 
54
from bzrlib.inventory import (
 
55
    Inventory,
 
56
    InventoryDirectory,
 
57
    ROOT_ID,
 
58
    entry_factory,
 
59
    )
 
60
from bzrlib import registry
 
61
from bzrlib.trace import (
 
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
46
63
 
47
64
 
48
65
# Old formats display a warning, but only once
49
66
_deprecation_warning_done = False
50
67
 
51
68
 
 
69
class CommitBuilder(object):
 
70
    """Provides an interface to build up a commit.
 
71
 
 
72
    This allows describing a tree to be committed without needing to
 
73
    know the internals of the format of the repository.
 
74
    """
 
75
 
 
76
    # all clients should supply tree roots.
 
77
    record_root_entry = True
 
78
    # the default CommitBuilder does not manage trees whose root is versioned.
 
79
    _versioned_root = False
 
80
 
 
81
    def __init__(self, repository, parents, config, timestamp=None,
 
82
                 timezone=None, committer=None, revprops=None,
 
83
                 revision_id=None):
 
84
        """Initiate a CommitBuilder.
 
85
 
 
86
        :param repository: Repository to commit to.
 
87
        :param parents: Revision ids of the parents of the new revision.
 
88
        :param config: Configuration to use.
 
89
        :param timestamp: Optional timestamp recorded for commit.
 
90
        :param timezone: Optional timezone for timestamp.
 
91
        :param committer: Optional committer to set for commit.
 
92
        :param revprops: Optional dictionary of revision properties.
 
93
        :param revision_id: Optional revision id.
 
94
        """
 
95
        self._config = config
 
96
 
 
97
        if committer is None:
 
98
            self._committer = self._config.username()
 
99
        else:
 
100
            self._committer = committer
 
101
 
 
102
        self.new_inventory = Inventory(None)
 
103
        self._new_revision_id = revision_id
 
104
        self.parents = parents
 
105
        self.repository = repository
 
106
 
 
107
        self._revprops = {}
 
108
        if revprops is not None:
 
109
            self._validate_revprops(revprops)
 
110
            self._revprops.update(revprops)
 
111
 
 
112
        if timestamp is None:
 
113
            timestamp = time.time()
 
114
        # Restrict resolution to 1ms
 
115
        self._timestamp = round(timestamp, 3)
 
116
 
 
117
        if timezone is None:
 
118
            self._timezone = osutils.local_time_offset()
 
119
        else:
 
120
            self._timezone = int(timezone)
 
121
 
 
122
        self._generate_revision_if_needed()
 
123
        self.__heads = graph.HeadsCache(repository.get_graph()).heads
 
124
        self._basis_delta = []
 
125
        # API compatibility, older code that used CommitBuilder did not call
 
126
        # .record_delete(), which means the delta that is computed would not be
 
127
        # valid. Callers that will call record_delete() should call
 
128
        # .will_record_deletes() to indicate that.
 
129
        self._recording_deletes = False
 
130
        # memo'd check for no-op commits.
 
131
        self._any_changes = False
 
132
 
 
133
    def any_changes(self):
 
134
        """Return True if any entries were changed.
 
135
        
 
136
        This includes merge-only changes. It is the core for the --unchanged
 
137
        detection in commit.
 
138
 
 
139
        :return: True if any changes have occured.
 
140
        """
 
141
        return self._any_changes
 
142
 
 
143
    def _validate_unicode_text(self, text, context):
 
144
        """Verify things like commit messages don't have bogus characters."""
 
145
        if '\r' in text:
 
146
            raise ValueError('Invalid value for %s: %r' % (context, text))
 
147
 
 
148
    def _validate_revprops(self, revprops):
 
149
        for key, value in revprops.iteritems():
 
150
            # We know that the XML serializers do not round trip '\r'
 
151
            # correctly, so refuse to accept them
 
152
            if not isinstance(value, basestring):
 
153
                raise ValueError('revision property (%s) is not a valid'
 
154
                                 ' (unicode) string: %r' % (key, value))
 
155
            self._validate_unicode_text(value,
 
156
                                        'revision property (%s)' % (key,))
 
157
 
 
158
    def commit(self, message):
 
159
        """Make the actual commit.
 
160
 
 
161
        :return: The revision id of the recorded revision.
 
162
        """
 
163
        self._validate_unicode_text(message, 'commit message')
 
164
        rev = _mod_revision.Revision(
 
165
                       timestamp=self._timestamp,
 
166
                       timezone=self._timezone,
 
167
                       committer=self._committer,
 
168
                       message=message,
 
169
                       inventory_sha1=self.inv_sha1,
 
170
                       revision_id=self._new_revision_id,
 
171
                       properties=self._revprops)
 
172
        rev.parent_ids = self.parents
 
173
        self.repository.add_revision(self._new_revision_id, rev,
 
174
            self.new_inventory, self._config)
 
175
        self.repository.commit_write_group()
 
176
        return self._new_revision_id
 
177
 
 
178
    def abort(self):
 
179
        """Abort the commit that is being built.
 
180
        """
 
181
        self.repository.abort_write_group()
 
182
 
 
183
    def revision_tree(self):
 
184
        """Return the tree that was just committed.
 
185
 
 
186
        After calling commit() this can be called to get a RevisionTree
 
187
        representing the newly committed tree. This is preferred to
 
188
        calling Repository.revision_tree() because that may require
 
189
        deserializing the inventory, while we already have a copy in
 
190
        memory.
 
191
        """
 
192
        if self.new_inventory is None:
 
193
            self.new_inventory = self.repository.get_inventory(
 
194
                self._new_revision_id)
 
195
        return RevisionTree(self.repository, self.new_inventory,
 
196
            self._new_revision_id)
 
197
 
 
198
    def finish_inventory(self):
 
199
        """Tell the builder that the inventory is finished.
 
200
 
 
201
        :return: The inventory id in the repository, which can be used with
 
202
            repository.get_inventory.
 
203
        """
 
204
        if self.new_inventory is None:
 
205
            # an inventory delta was accumulated without creating a new
 
206
            # inventory.
 
207
            basis_id = self.basis_delta_revision
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
209
                basis_id, self._basis_delta, self._new_revision_id,
 
210
                self.parents)
 
211
        else:
 
212
            if self.new_inventory.root is None:
 
213
                raise AssertionError('Root entry should be supplied to'
 
214
                    ' record_entry_contents, as of bzr 0.10.')
 
215
                self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
216
            self.new_inventory.revision_id = self._new_revision_id
 
217
            self.inv_sha1 = self.repository.add_inventory(
 
218
                self._new_revision_id,
 
219
                self.new_inventory,
 
220
                self.parents
 
221
                )
 
222
        return self._new_revision_id
 
223
 
 
224
    def _gen_revision_id(self):
 
225
        """Return new revision-id."""
 
226
        return generate_ids.gen_revision_id(self._config.username(),
 
227
                                            self._timestamp)
 
228
 
 
229
    def _generate_revision_if_needed(self):
 
230
        """Create a revision id if None was supplied.
 
231
 
 
232
        If the repository can not support user-specified revision ids
 
233
        they should override this function and raise CannotSetRevisionId
 
234
        if _new_revision_id is not None.
 
235
 
 
236
        :raises: CannotSetRevisionId
 
237
        """
 
238
        if self._new_revision_id is None:
 
239
            self._new_revision_id = self._gen_revision_id()
 
240
            self.random_revid = True
 
241
        else:
 
242
            self.random_revid = False
 
243
 
 
244
    def _heads(self, file_id, revision_ids):
 
245
        """Calculate the graph heads for revision_ids in the graph of file_id.
 
246
 
 
247
        This can use either a per-file graph or a global revision graph as we
 
248
        have an identity relationship between the two graphs.
 
249
        """
 
250
        return self.__heads(revision_ids)
 
251
 
 
252
    def _check_root(self, ie, parent_invs, tree):
 
253
        """Helper for record_entry_contents.
 
254
 
 
255
        :param ie: An entry being added.
 
256
        :param parent_invs: The inventories of the parent revisions of the
 
257
            commit.
 
258
        :param tree: The tree that is being committed.
 
259
        """
 
260
        # In this revision format, root entries have no knit or weave When
 
261
        # serializing out to disk and back in root.revision is always
 
262
        # _new_revision_id
 
263
        ie.revision = self._new_revision_id
 
264
 
 
265
    def _require_root_change(self, tree):
 
266
        """Enforce an appropriate root object change.
 
267
 
 
268
        This is called once when record_iter_changes is called, if and only if
 
269
        the root was not in the delta calculated by record_iter_changes.
 
270
 
 
271
        :param tree: The tree which is being committed.
 
272
        """
 
273
        # NB: if there are no parents then this method is not called, so no
 
274
        # need to guard on parents having length.
 
275
        entry = entry_factory['directory'](tree.path2id(''), '',
 
276
            None)
 
277
        entry.revision = self._new_revision_id
 
278
        self._basis_delta.append(('', '', entry.file_id, entry))
 
279
 
 
280
    def _get_delta(self, ie, basis_inv, path):
 
281
        """Get a delta against the basis inventory for ie."""
 
282
        if ie.file_id not in basis_inv:
 
283
            # add
 
284
            result = (None, path, ie.file_id, ie)
 
285
            self._basis_delta.append(result)
 
286
            return result
 
287
        elif ie != basis_inv[ie.file_id]:
 
288
            # common but altered
 
289
            # TODO: avoid tis id2path call.
 
290
            result = (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
291
            self._basis_delta.append(result)
 
292
            return result
 
293
        else:
 
294
            # common, unaltered
 
295
            return None
 
296
 
 
297
    def get_basis_delta(self):
 
298
        """Return the complete inventory delta versus the basis inventory.
 
299
 
 
300
        This has been built up with the calls to record_delete and
 
301
        record_entry_contents. The client must have already called
 
302
        will_record_deletes() to indicate that they will be generating a
 
303
        complete delta.
 
304
 
 
305
        :return: An inventory delta, suitable for use with apply_delta, or
 
306
            Repository.add_inventory_by_delta, etc.
 
307
        """
 
308
        if not self._recording_deletes:
 
309
            raise AssertionError("recording deletes not activated.")
 
310
        return self._basis_delta
 
311
 
 
312
    def record_delete(self, path, file_id):
 
313
        """Record that a delete occured against a basis tree.
 
314
 
 
315
        This is an optional API - when used it adds items to the basis_delta
 
316
        being accumulated by the commit builder. It cannot be called unless the
 
317
        method will_record_deletes() has been called to inform the builder that
 
318
        a delta is being supplied.
 
319
 
 
320
        :param path: The path of the thing deleted.
 
321
        :param file_id: The file id that was deleted.
 
322
        """
 
323
        if not self._recording_deletes:
 
324
            raise AssertionError("recording deletes not activated.")
 
325
        delta = (path, None, file_id, None)
 
326
        self._basis_delta.append(delta)
 
327
        self._any_changes = True
 
328
        return delta
 
329
 
 
330
    def will_record_deletes(self):
 
331
        """Tell the commit builder that deletes are being notified.
 
332
 
 
333
        This enables the accumulation of an inventory delta; for the resulting
 
334
        commit to be valid, deletes against the basis MUST be recorded via
 
335
        builder.record_delete().
 
336
        """
 
337
        self._recording_deletes = True
 
338
        try:
 
339
            basis_id = self.parents[0]
 
340
        except IndexError:
 
341
            basis_id = _mod_revision.NULL_REVISION
 
342
        self.basis_delta_revision = basis_id
 
343
 
 
344
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
345
        content_summary):
 
346
        """Record the content of ie from tree into the commit if needed.
 
347
 
 
348
        Side effect: sets ie.revision when unchanged
 
349
 
 
350
        :param ie: An inventory entry present in the commit.
 
351
        :param parent_invs: The inventories of the parent revisions of the
 
352
            commit.
 
353
        :param path: The path the entry is at in the tree.
 
354
        :param tree: The tree which contains this entry and should be used to
 
355
            obtain content.
 
356
        :param content_summary: Summary data from the tree about the paths
 
357
            content - stat, length, exec, sha/link target. This is only
 
358
            accessed when the entry has a revision of None - that is when it is
 
359
            a candidate to commit.
 
360
        :return: A tuple (change_delta, version_recorded, fs_hash).
 
361
            change_delta is an inventory_delta change for this entry against
 
362
            the basis tree of the commit, or None if no change occured against
 
363
            the basis tree.
 
364
            version_recorded is True if a new version of the entry has been
 
365
            recorded. For instance, committing a merge where a file was only
 
366
            changed on the other side will return (delta, False).
 
367
            fs_hash is either None, or the hash details for the path (currently
 
368
            a tuple of the contents sha1 and the statvalue returned by
 
369
            tree.get_file_with_stat()).
 
370
        """
 
371
        if self.new_inventory.root is None:
 
372
            if ie.parent_id is not None:
 
373
                raise errors.RootMissing()
 
374
            self._check_root(ie, parent_invs, tree)
 
375
        if ie.revision is None:
 
376
            kind = content_summary[0]
 
377
        else:
 
378
            # ie is carried over from a prior commit
 
379
            kind = ie.kind
 
380
        # XXX: repository specific check for nested tree support goes here - if
 
381
        # the repo doesn't want nested trees we skip it ?
 
382
        if (kind == 'tree-reference' and
 
383
            not self.repository._format.supports_tree_reference):
 
384
            # mismatch between commit builder logic and repository:
 
385
            # this needs the entry creation pushed down into the builder.
 
386
            raise NotImplementedError('Missing repository subtree support.')
 
387
        self.new_inventory.add(ie)
 
388
 
 
389
        # TODO: slow, take it out of the inner loop.
 
390
        try:
 
391
            basis_inv = parent_invs[0]
 
392
        except IndexError:
 
393
            basis_inv = Inventory(root_id=None)
 
394
 
 
395
        # ie.revision is always None if the InventoryEntry is considered
 
396
        # for committing. We may record the previous parents revision if the
 
397
        # content is actually unchanged against a sole head.
 
398
        if ie.revision is not None:
 
399
            if not self._versioned_root and path == '':
 
400
                # repositories that do not version the root set the root's
 
401
                # revision to the new commit even when no change occurs (more
 
402
                # specifically, they do not record a revision on the root; and
 
403
                # the rev id is assigned to the root during deserialisation -
 
404
                # this masks when a change may have occurred against the basis.
 
405
                # To match this we always issue a delta, because the revision
 
406
                # of the root will always be changing.
 
407
                if ie.file_id in basis_inv:
 
408
                    delta = (basis_inv.id2path(ie.file_id), path,
 
409
                        ie.file_id, ie)
 
410
                else:
 
411
                    # add
 
412
                    delta = (None, path, ie.file_id, ie)
 
413
                self._basis_delta.append(delta)
 
414
                return delta, False, None
 
415
            else:
 
416
                # we don't need to commit this, because the caller already
 
417
                # determined that an existing revision of this file is
 
418
                # appropriate. If its not being considered for committing then
 
419
                # it and all its parents to the root must be unaltered so
 
420
                # no-change against the basis.
 
421
                if ie.revision == self._new_revision_id:
 
422
                    raise AssertionError("Impossible situation, a skipped "
 
423
                        "inventory entry (%r) claims to be modified in this "
 
424
                        "commit (%r).", (ie, self._new_revision_id))
 
425
                return None, False, None
 
426
        # XXX: Friction: parent_candidates should return a list not a dict
 
427
        #      so that we don't have to walk the inventories again.
 
428
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
429
        head_set = self._heads(ie.file_id, parent_candiate_entries.keys())
 
430
        heads = []
 
431
        for inv in parent_invs:
 
432
            if ie.file_id in inv:
 
433
                old_rev = inv[ie.file_id].revision
 
434
                if old_rev in head_set:
 
435
                    heads.append(inv[ie.file_id].revision)
 
436
                    head_set.remove(inv[ie.file_id].revision)
 
437
 
 
438
        store = False
 
439
        # now we check to see if we need to write a new record to the
 
440
        # file-graph.
 
441
        # We write a new entry unless there is one head to the ancestors, and
 
442
        # the kind-derived content is unchanged.
 
443
 
 
444
        # Cheapest check first: no ancestors, or more the one head in the
 
445
        # ancestors, we write a new node.
 
446
        if len(heads) != 1:
 
447
            store = True
 
448
        if not store:
 
449
            # There is a single head, look it up for comparison
 
450
            parent_entry = parent_candiate_entries[heads[0]]
 
451
            # if the non-content specific data has changed, we'll be writing a
 
452
            # node:
 
453
            if (parent_entry.parent_id != ie.parent_id or
 
454
                parent_entry.name != ie.name):
 
455
                store = True
 
456
        # now we need to do content specific checks:
 
457
        if not store:
 
458
            # if the kind changed the content obviously has
 
459
            if kind != parent_entry.kind:
 
460
                store = True
 
461
        # Stat cache fingerprint feedback for the caller - None as we usually
 
462
        # don't generate one.
 
463
        fingerprint = None
 
464
        if kind == 'file':
 
465
            if content_summary[2] is None:
 
466
                raise ValueError("Files must not have executable = None")
 
467
            if not store:
 
468
                # We can't trust a check of the file length because of content
 
469
                # filtering...
 
470
                if (# if the exec bit has changed we have to store:
 
471
                    parent_entry.executable != content_summary[2]):
 
472
                    store = True
 
473
                elif parent_entry.text_sha1 == content_summary[3]:
 
474
                    # all meta and content is unchanged (using a hash cache
 
475
                    # hit to check the sha)
 
476
                    ie.revision = parent_entry.revision
 
477
                    ie.text_size = parent_entry.text_size
 
478
                    ie.text_sha1 = parent_entry.text_sha1
 
479
                    ie.executable = parent_entry.executable
 
480
                    return self._get_delta(ie, basis_inv, path), False, None
 
481
                else:
 
482
                    # Either there is only a hash change(no hash cache entry,
 
483
                    # or same size content change), or there is no change on
 
484
                    # this file at all.
 
485
                    # Provide the parent's hash to the store layer, so that the
 
486
                    # content is unchanged we will not store a new node.
 
487
                    nostore_sha = parent_entry.text_sha1
 
488
            if store:
 
489
                # We want to record a new node regardless of the presence or
 
490
                # absence of a content change in the file.
 
491
                nostore_sha = None
 
492
            ie.executable = content_summary[2]
 
493
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
 
494
            try:
 
495
                text = file_obj.read()
 
496
            finally:
 
497
                file_obj.close()
 
498
            try:
 
499
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
500
                    ie.file_id, text, heads, nostore_sha)
 
501
                # Let the caller know we generated a stat fingerprint.
 
502
                fingerprint = (ie.text_sha1, stat_value)
 
503
            except errors.ExistingContent:
 
504
                # Turns out that the file content was unchanged, and we were
 
505
                # only going to store a new node if it was changed. Carry over
 
506
                # the entry.
 
507
                ie.revision = parent_entry.revision
 
508
                ie.text_size = parent_entry.text_size
 
509
                ie.text_sha1 = parent_entry.text_sha1
 
510
                ie.executable = parent_entry.executable
 
511
                return self._get_delta(ie, basis_inv, path), False, None
 
512
        elif kind == 'directory':
 
513
            if not store:
 
514
                # all data is meta here, nothing specific to directory, so
 
515
                # carry over:
 
516
                ie.revision = parent_entry.revision
 
517
                return self._get_delta(ie, basis_inv, path), False, None
 
518
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
519
        elif kind == 'symlink':
 
520
            current_link_target = content_summary[3]
 
521
            if not store:
 
522
                # symlink target is not generic metadata, check if it has
 
523
                # changed.
 
524
                if current_link_target != parent_entry.symlink_target:
 
525
                    store = True
 
526
            if not store:
 
527
                # unchanged, carry over.
 
528
                ie.revision = parent_entry.revision
 
529
                ie.symlink_target = parent_entry.symlink_target
 
530
                return self._get_delta(ie, basis_inv, path), False, None
 
531
            ie.symlink_target = current_link_target
 
532
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
533
        elif kind == 'tree-reference':
 
534
            if not store:
 
535
                if content_summary[3] != parent_entry.reference_revision:
 
536
                    store = True
 
537
            if not store:
 
538
                # unchanged, carry over.
 
539
                ie.reference_revision = parent_entry.reference_revision
 
540
                ie.revision = parent_entry.revision
 
541
                return self._get_delta(ie, basis_inv, path), False, None
 
542
            ie.reference_revision = content_summary[3]
 
543
            if ie.reference_revision is None:
 
544
                raise AssertionError("invalid content_summary for nested tree: %r"
 
545
                    % (content_summary,))
 
546
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
547
        else:
 
548
            raise NotImplementedError('unknown kind')
 
549
        ie.revision = self._new_revision_id
 
550
        self._any_changes = True
 
551
        return self._get_delta(ie, basis_inv, path), True, fingerprint
 
552
 
 
553
    def record_iter_changes(self, tree, basis_revision_id, iter_changes,
 
554
        _entry_factory=entry_factory):
 
555
        """Record a new tree via iter_changes.
 
556
 
 
557
        :param tree: The tree to obtain text contents from for changed objects.
 
558
        :param basis_revision_id: The revision id of the tree the iter_changes
 
559
            has been generated against. Currently assumed to be the same
 
560
            as self.parents[0] - if it is not, errors may occur.
 
561
        :param iter_changes: An iter_changes iterator with the changes to apply
 
562
            to basis_revision_id. The iterator must not include any items with
 
563
            a current kind of None - missing items must be either filtered out
 
564
            or errored-on beefore record_iter_changes sees the item.
 
565
        :param _entry_factory: Private method to bind entry_factory locally for
 
566
            performance.
 
567
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
 
568
            tree._observed_sha1.
 
569
        """
 
570
        # Create an inventory delta based on deltas between all the parents and
 
571
        # deltas between all the parent inventories. We use inventory delta's 
 
572
        # between the inventory objects because iter_changes masks
 
573
        # last-changed-field only changes.
 
574
        # Working data:
 
575
        # file_id -> change map, change is fileid, paths, changed, versioneds,
 
576
        # parents, names, kinds, executables
 
577
        merged_ids = {}
 
578
        # {file_id -> revision_id -> inventory entry, for entries in parent
 
579
        # trees that are not parents[0]
 
580
        parent_entries = {}
 
581
        ghost_basis = False
 
582
        try:
 
583
            revtrees = list(self.repository.revision_trees(self.parents))
 
584
        except errors.NoSuchRevision:
 
585
            # one or more ghosts, slow path.
 
586
            revtrees = []
 
587
            for revision_id in self.parents:
 
588
                try:
 
589
                    revtrees.append(self.repository.revision_tree(revision_id))
 
590
                except errors.NoSuchRevision:
 
591
                    if not revtrees:
 
592
                        basis_revision_id = _mod_revision.NULL_REVISION
 
593
                        ghost_basis = True
 
594
                    revtrees.append(self.repository.revision_tree(
 
595
                        _mod_revision.NULL_REVISION))
 
596
        # The basis inventory from a repository 
 
597
        if revtrees:
 
598
            basis_inv = revtrees[0].inventory
 
599
        else:
 
600
            basis_inv = self.repository.revision_tree(
 
601
                _mod_revision.NULL_REVISION).inventory
 
602
        if len(self.parents) > 0:
 
603
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
604
                raise Exception(
 
605
                    "arbitrary basis parents not yet supported with merges")
 
606
            for revtree in revtrees[1:]:
 
607
                for change in revtree.inventory._make_delta(basis_inv):
 
608
                    if change[1] is None:
 
609
                        # Not present in this parent.
 
610
                        continue
 
611
                    if change[2] not in merged_ids:
 
612
                        if change[0] is not None:
 
613
                            basis_entry = basis_inv[change[2]]
 
614
                            merged_ids[change[2]] = [
 
615
                                # basis revid
 
616
                                basis_entry.revision,
 
617
                                # new tree revid
 
618
                                change[3].revision]
 
619
                            parent_entries[change[2]] = {
 
620
                                # basis parent
 
621
                                basis_entry.revision:basis_entry,
 
622
                                # this parent 
 
623
                                change[3].revision:change[3],
 
624
                                }
 
625
                        else:
 
626
                            merged_ids[change[2]] = [change[3].revision]
 
627
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
628
                    else:
 
629
                        merged_ids[change[2]].append(change[3].revision)
 
630
                        parent_entries[change[2]][change[3].revision] = change[3]
 
631
        else:
 
632
            merged_ids = {}
 
633
        # Setup the changes from the tree:
 
634
        # changes maps file_id -> (change, [parent revision_ids])
 
635
        changes= {}
 
636
        for change in iter_changes:
 
637
            # This probably looks up in basis_inv way to much.
 
638
            if change[1][0] is not None:
 
639
                head_candidate = [basis_inv[change[0]].revision]
 
640
            else:
 
641
                head_candidate = []
 
642
            changes[change[0]] = change, merged_ids.get(change[0],
 
643
                head_candidate)
 
644
        unchanged_merged = set(merged_ids) - set(changes)
 
645
        # Extend the changes dict with synthetic changes to record merges of
 
646
        # texts.
 
647
        for file_id in unchanged_merged:
 
648
            # Record a merged version of these items that did not change vs the
 
649
            # basis. This can be either identical parallel changes, or a revert
 
650
            # of a specific file after a merge. The recorded content will be
 
651
            # that of the current tree (which is the same as the basis), but
 
652
            # the per-file graph will reflect a merge.
 
653
            # NB:XXX: We are reconstructing path information we had, this
 
654
            # should be preserved instead.
 
655
            # inv delta  change: (file_id, (path_in_source, path_in_target),
 
656
            #   changed_content, versioned, parent, name, kind,
 
657
            #   executable)
 
658
            try:
 
659
                basis_entry = basis_inv[file_id]
 
660
            except errors.NoSuchId:
 
661
                # a change from basis->some_parents but file_id isn't in basis
 
662
                # so was new in the merge, which means it must have changed
 
663
                # from basis -> current, and as it hasn't the add was reverted
 
664
                # by the user. So we discard this change.
 
665
                pass
 
666
            else:
 
667
                change = (file_id,
 
668
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
669
                    False, (True, True),
 
670
                    (basis_entry.parent_id, basis_entry.parent_id),
 
671
                    (basis_entry.name, basis_entry.name),
 
672
                    (basis_entry.kind, basis_entry.kind),
 
673
                    (basis_entry.executable, basis_entry.executable))
 
674
                changes[file_id] = (change, merged_ids[file_id])
 
675
        # changes contains tuples with the change and a set of inventory
 
676
        # candidates for the file.
 
677
        # inv delta is:
 
678
        # old_path, new_path, file_id, new_inventory_entry
 
679
        seen_root = False # Is the root in the basis delta?
 
680
        inv_delta = self._basis_delta
 
681
        modified_rev = self._new_revision_id
 
682
        for change, head_candidates in changes.values():
 
683
            if change[3][1]: # versioned in target.
 
684
                # Several things may be happening here:
 
685
                # We may have a fork in the per-file graph
 
686
                #  - record a change with the content from tree
 
687
                # We may have a change against < all trees  
 
688
                #  - carry over the tree that hasn't changed
 
689
                # We may have a change against all trees
 
690
                #  - record the change with the content from tree
 
691
                kind = change[6][1]
 
692
                file_id = change[0]
 
693
                entry = _entry_factory[kind](file_id, change[5][1],
 
694
                    change[4][1])
 
695
                head_set = self._heads(change[0], set(head_candidates))
 
696
                heads = []
 
697
                # Preserve ordering.
 
698
                for head_candidate in head_candidates:
 
699
                    if head_candidate in head_set:
 
700
                        heads.append(head_candidate)
 
701
                        head_set.remove(head_candidate)
 
702
                carried_over = False
 
703
                if len(heads) == 1:
 
704
                    # Could be a carry-over situation:
 
705
                    parent_entry_revs = parent_entries.get(file_id, None)
 
706
                    if parent_entry_revs:
 
707
                        parent_entry = parent_entry_revs.get(heads[0], None)
 
708
                    else:
 
709
                        parent_entry = None
 
710
                    if parent_entry is None:
 
711
                        # The parent iter_changes was called against is the one
 
712
                        # that is the per-file head, so any change is relevant
 
713
                        # iter_changes is valid.
 
714
                        carry_over_possible = False
 
715
                    else:
 
716
                        # could be a carry over situation
 
717
                        # A change against the basis may just indicate a merge,
 
718
                        # we need to check the content against the source of the
 
719
                        # merge to determine if it was changed after the merge
 
720
                        # or carried over.
 
721
                        if (parent_entry.kind != entry.kind or
 
722
                            parent_entry.parent_id != entry.parent_id or
 
723
                            parent_entry.name != entry.name):
 
724
                            # Metadata common to all entries has changed
 
725
                            # against per-file parent
 
726
                            carry_over_possible = False
 
727
                        else:
 
728
                            carry_over_possible = True
 
729
                        # per-type checks for changes against the parent_entry
 
730
                        # are done below.
 
731
                else:
 
732
                    # Cannot be a carry-over situation
 
733
                    carry_over_possible = False
 
734
                # Populate the entry in the delta
 
735
                if kind == 'file':
 
736
                    # XXX: There is still a small race here: If someone reverts the content of a file
 
737
                    # after iter_changes examines and decides it has changed,
 
738
                    # we will unconditionally record a new version even if some
 
739
                    # other process reverts it while commit is running (with
 
740
                    # the revert happening after iter_changes did it's
 
741
                    # examination).
 
742
                    if change[7][1]:
 
743
                        entry.executable = True
 
744
                    else:
 
745
                        entry.executable = False
 
746
                    if (carry_over_possible and
 
747
                        parent_entry.executable == entry.executable):
 
748
                            # Check the file length, content hash after reading
 
749
                            # the file.
 
750
                            nostore_sha = parent_entry.text_sha1
 
751
                    else:
 
752
                        nostore_sha = None
 
753
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
 
754
                    try:
 
755
                        text = file_obj.read()
 
756
                    finally:
 
757
                        file_obj.close()
 
758
                    try:
 
759
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
 
760
                            file_id, text, heads, nostore_sha)
 
761
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
762
                    except errors.ExistingContent:
 
763
                        # No content change against a carry_over parent
 
764
                        # Perhaps this should also yield a fs hash update?
 
765
                        carried_over = True
 
766
                        entry.text_size = parent_entry.text_size
 
767
                        entry.text_sha1 = parent_entry.text_sha1
 
768
                elif kind == 'symlink':
 
769
                    # Wants a path hint?
 
770
                    entry.symlink_target = tree.get_symlink_target(file_id)
 
771
                    if (carry_over_possible and
 
772
                        parent_entry.symlink_target == entry.symlink_target):
 
773
                        carried_over = True
 
774
                    else:
 
775
                        self._add_text_to_weave(change[0], '', heads, None)
 
776
                elif kind == 'directory':
 
777
                    if carry_over_possible:
 
778
                        carried_over = True
 
779
                    else:
 
780
                        # Nothing to set on the entry.
 
781
                        # XXX: split into the Root and nonRoot versions.
 
782
                        if change[1][1] != '' or self.repository.supports_rich_root():
 
783
                            self._add_text_to_weave(change[0], '', heads, None)
 
784
                elif kind == 'tree-reference':
 
785
                    if not self.repository._format.supports_tree_reference:
 
786
                        # This isn't quite sane as an error, but we shouldn't
 
787
                        # ever see this code path in practice: tree's don't
 
788
                        # permit references when the repo doesn't support tree
 
789
                        # references.
 
790
                        raise errors.UnsupportedOperation(tree.add_reference,
 
791
                            self.repository)
 
792
                    reference_revision = tree.get_reference_revision(change[0])
 
793
                    entry.reference_revision = reference_revision
 
794
                    if (carry_over_possible and
 
795
                        parent_entry.reference_revision == reference_revision):
 
796
                        carried_over = True
 
797
                    else:
 
798
                        self._add_text_to_weave(change[0], '', heads, None)
 
799
                else:
 
800
                    raise AssertionError('unknown kind %r' % kind)
 
801
                if not carried_over:
 
802
                    entry.revision = modified_rev
 
803
                else:
 
804
                    entry.revision = parent_entry.revision
 
805
            else:
 
806
                entry = None
 
807
            new_path = change[1][1]
 
808
            inv_delta.append((change[1][0], new_path, change[0], entry))
 
809
            if new_path == '':
 
810
                seen_root = True
 
811
        self.new_inventory = None
 
812
        if len(inv_delta):
 
813
            # This should perhaps be guarded by a check that the basis we
 
814
            # commit against is the basis for the commit and if not do a delta
 
815
            # against the basis.
 
816
            self._any_changes = True
 
817
        if not seen_root:
 
818
            # housekeeping root entry changes do not affect no-change commits.
 
819
            self._require_root_change(tree)
 
820
        self.basis_delta_revision = basis_revision_id
 
821
 
 
822
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
 
823
        parent_keys = tuple([(file_id, parent) for parent in parents])
 
824
        return self.repository.texts._add_text(
 
825
            (file_id, self._new_revision_id), parent_keys, new_text,
 
826
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
 
827
 
 
828
 
 
829
class RootCommitBuilder(CommitBuilder):
 
830
    """This commitbuilder actually records the root id"""
 
831
 
 
832
    # the root entry gets versioned properly by this builder.
 
833
    _versioned_root = True
 
834
 
 
835
    def _check_root(self, ie, parent_invs, tree):
 
836
        """Helper for record_entry_contents.
 
837
 
 
838
        :param ie: An entry being added.
 
839
        :param parent_invs: The inventories of the parent revisions of the
 
840
            commit.
 
841
        :param tree: The tree that is being committed.
 
842
        """
 
843
 
 
844
    def _require_root_change(self, tree):
 
845
        """Enforce an appropriate root object change.
 
846
 
 
847
        This is called once when record_iter_changes is called, if and only if
 
848
        the root was not in the delta calculated by record_iter_changes.
 
849
 
 
850
        :param tree: The tree which is being committed.
 
851
        """
 
852
        # versioned roots do not change unless the tree found a change.
 
853
 
 
854
 
 
855
######################################################################
 
856
# Repositories
 
857
 
 
858
 
52
859
class Repository(object):
53
860
    """Repository holding history for one or more branches.
54
861
 
56
863
    revisions and file history.  It's normally accessed only by the Branch,
57
864
    which views a particular line of development through that history.
58
865
 
59
 
    The Repository builds on top of Stores and a Transport, which respectively 
60
 
    describe the disk data format and the way of accessing the (possibly 
 
866
    The Repository builds on top of some byte storage facilies (the revisions,
 
867
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
 
868
    which respectively provide byte storage and a means to access the (possibly
61
869
    remote) disk.
 
870
 
 
871
    The byte storage facilities are addressed via tuples, which we refer to
 
872
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
873
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
874
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
 
875
    byte string made up of a hash identifier and a hash value.
 
876
    We use this interface because it allows low friction with the underlying
 
877
    code that implements disk indices, network encoding and other parts of
 
878
    bzrlib.
 
879
 
 
880
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
 
881
        the serialised revisions for the repository. This can be used to obtain
 
882
        revision graph information or to access raw serialised revisions.
 
883
        The result of trying to insert data into the repository via this store
 
884
        is undefined: it should be considered read-only except for implementors
 
885
        of repositories.
 
886
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
887
        the serialised signatures for the repository. This can be used to
 
888
        obtain access to raw serialised signatures.  The result of trying to
 
889
        insert data into the repository via this store is undefined: it should
 
890
        be considered read-only except for implementors of repositories.
 
891
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
892
        the serialised inventories for the repository. This can be used to
 
893
        obtain unserialised inventories.  The result of trying to insert data
 
894
        into the repository via this store is undefined: it should be
 
895
        considered read-only except for implementors of repositories.
 
896
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
897
        texts of files and directories for the repository. This can be used to
 
898
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
899
        is usually a better interface for accessing file texts.
 
900
        The result of trying to insert data into the repository via this store
 
901
        is undefined: it should be considered read-only except for implementors
 
902
        of repositories.
 
903
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
 
904
        any data the repository chooses to store or have indexed by its hash.
 
905
        The result of trying to insert data into the repository via this store
 
906
        is undefined: it should be considered read-only except for implementors
 
907
        of repositories.
 
908
    :ivar _transport: Transport for file access to repository, typically
 
909
        pointing to .bzr/repository.
62
910
    """
63
911
 
64
 
    @needs_write_lock
65
 
    def add_inventory(self, revid, inv, parents):
66
 
        """Add the inventory inv to the repository as revid.
67
 
        
68
 
        :param parents: The revision ids of the parents that revid
 
912
    # What class to use for a CommitBuilder. Often its simpler to change this
 
913
    # in a Repository class subclass rather than to override
 
914
    # get_commit_builder.
 
915
    _commit_builder_class = CommitBuilder
 
916
    # The search regex used by xml based repositories to determine what things
 
917
    # where changed in a single commit.
 
918
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
919
        r'file_id="(?P<file_id>[^"]+)"'
 
920
        r'.* revision="(?P<revision_id>[^"]+)"'
 
921
        )
 
922
 
 
923
    def abort_write_group(self, suppress_errors=False):
 
924
        """Commit the contents accrued within the current write group.
 
925
 
 
926
        :param suppress_errors: if true, abort_write_group will catch and log
 
927
            unexpected errors that happen during the abort, rather than
 
928
            allowing them to propagate.  Defaults to False.
 
929
 
 
930
        :seealso: start_write_group.
 
931
        """
 
932
        if self._write_group is not self.get_transaction():
 
933
            # has an unlock or relock occured ?
 
934
            if suppress_errors:
 
935
                mutter(
 
936
                '(suppressed) mismatched lock context and write group. %r, %r',
 
937
                self._write_group, self.get_transaction())
 
938
                return
 
939
            raise errors.BzrError(
 
940
                'mismatched lock context and write group. %r, %r' %
 
941
                (self._write_group, self.get_transaction()))
 
942
        try:
 
943
            self._abort_write_group()
 
944
        except Exception, exc:
 
945
            self._write_group = None
 
946
            if not suppress_errors:
 
947
                raise
 
948
            mutter('abort_write_group failed')
 
949
            log_exception_quietly()
 
950
            note('bzr: ERROR (ignored): %s', exc)
 
951
        self._write_group = None
 
952
 
 
953
    def _abort_write_group(self):
 
954
        """Template method for per-repository write group cleanup.
 
955
 
 
956
        This is called during abort before the write group is considered to be
 
957
        finished and should cleanup any internal state accrued during the write
 
958
        group. There is no requirement that data handed to the repository be
 
959
        *not* made available - this is not a rollback - but neither should any
 
960
        attempt be made to ensure that data added is fully commited. Abort is
 
961
        invoked when an error has occured so futher disk or network operations
 
962
        may not be possible or may error and if possible should not be
 
963
        attempted.
 
964
        """
 
965
 
 
966
    def add_fallback_repository(self, repository):
 
967
        """Add a repository to use for looking up data not held locally.
 
968
 
 
969
        :param repository: A repository.
 
970
        """
 
971
        if not self._format.supports_external_lookups:
 
972
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
973
        if self.is_locked():
 
974
            # This repository will call fallback.unlock() when we transition to
 
975
            # the unlocked state, so we make sure to increment the lock count
 
976
            repository.lock_read()
 
977
        self._check_fallback_repository(repository)
 
978
        self._fallback_repositories.append(repository)
 
979
        self.texts.add_fallback_versioned_files(repository.texts)
 
980
        self.inventories.add_fallback_versioned_files(repository.inventories)
 
981
        self.revisions.add_fallback_versioned_files(repository.revisions)
 
982
        self.signatures.add_fallback_versioned_files(repository.signatures)
 
983
        if self.chk_bytes is not None:
 
984
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
 
985
 
 
986
    def _check_fallback_repository(self, repository):
 
987
        """Check that this repository can fallback to repository safely.
 
988
 
 
989
        Raise an error if not.
 
990
 
 
991
        :param repository: A repository to fallback to.
 
992
        """
 
993
        return InterRepository._assert_same_model(self, repository)
 
994
 
 
995
    def add_inventory(self, revision_id, inv, parents):
 
996
        """Add the inventory inv to the repository as revision_id.
 
997
 
 
998
        :param parents: The revision ids of the parents that revision_id
69
999
                        is known to have and are in the repository already.
70
1000
 
71
 
        returns the sha1 of the serialized inventory.
72
 
        """
73
 
        assert inv.revision_id is None or inv.revision_id == revid, \
74
 
            "Mismatch between inventory revision" \
75
 
            " id and insertion revid (%r, %r)" % (inv.revision_id, revid)
76
 
        inv_text = xml5.serializer_v5.write_inventory_to_string(inv)
77
 
        inv_sha1 = osutils.sha_string(inv_text)
78
 
        inv_vf = self.control_weaves.get_weave('inventory',
79
 
                                               self.get_transaction())
80
 
        self._inventory_add_lines(inv_vf, revid, parents, osutils.split_lines(inv_text))
81
 
        return inv_sha1
82
 
 
83
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
84
 
        final_parents = []
85
 
        for parent in parents:
86
 
            if parent in inv_vf:
87
 
                final_parents.append(parent)
88
 
 
89
 
        inv_vf.add_lines(revid, final_parents, lines)
90
 
 
91
 
    @needs_write_lock
92
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
93
 
        """Add rev to the revision store as rev_id.
94
 
 
95
 
        :param rev_id: the revision id to use.
 
1001
        :returns: The validator(which is a sha1 digest, though what is sha'd is
 
1002
            repository format specific) of the serialized inventory.
 
1003
        """
 
1004
        if not self.is_in_write_group():
 
1005
            raise AssertionError("%r not in write group" % (self,))
 
1006
        _mod_revision.check_not_reserved_id(revision_id)
 
1007
        if not (inv.revision_id is None or inv.revision_id == revision_id):
 
1008
            raise AssertionError(
 
1009
                "Mismatch between inventory revision"
 
1010
                " id and insertion revid (%r, %r)"
 
1011
                % (inv.revision_id, revision_id))
 
1012
        if inv.root is None:
 
1013
            raise AssertionError()
 
1014
        return self._add_inventory_checked(revision_id, inv, parents)
 
1015
 
 
1016
    def _add_inventory_checked(self, revision_id, inv, parents):
 
1017
        """Add inv to the repository after checking the inputs.
 
1018
 
 
1019
        This function can be overridden to allow different inventory styles.
 
1020
 
 
1021
        :seealso: add_inventory, for the contract.
 
1022
        """
 
1023
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1024
        return self._inventory_add_lines(revision_id, parents,
 
1025
            inv_lines, check_content=False)
 
1026
 
 
1027
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1028
                               parents, basis_inv=None, propagate_caches=False):
 
1029
        """Add a new inventory expressed as a delta against another revision.
 
1030
 
 
1031
        See the inventory developers documentation for the theory behind
 
1032
        inventory deltas.
 
1033
 
 
1034
        :param basis_revision_id: The inventory id the delta was created
 
1035
            against. (This does not have to be a direct parent.)
 
1036
        :param delta: The inventory delta (see Inventory.apply_delta for
 
1037
            details).
 
1038
        :param new_revision_id: The revision id that the inventory is being
 
1039
            added for.
 
1040
        :param parents: The revision ids of the parents that revision_id is
 
1041
            known to have and are in the repository already. These are supplied
 
1042
            for repositories that depend on the inventory graph for revision
 
1043
            graph access, as well as for those that pun ancestry with delta
 
1044
            compression.
 
1045
        :param basis_inv: The basis inventory if it is already known,
 
1046
            otherwise None.
 
1047
        :param propagate_caches: If True, the caches for this inventory are
 
1048
          copied to and updated for the result if possible.
 
1049
 
 
1050
        :returns: (validator, new_inv)
 
1051
            The validator(which is a sha1 digest, though what is sha'd is
 
1052
            repository format specific) of the serialized inventory, and the
 
1053
            resulting inventory.
 
1054
        """
 
1055
        if not self.is_in_write_group():
 
1056
            raise AssertionError("%r not in write group" % (self,))
 
1057
        _mod_revision.check_not_reserved_id(new_revision_id)
 
1058
        basis_tree = self.revision_tree(basis_revision_id)
 
1059
        basis_tree.lock_read()
 
1060
        try:
 
1061
            # Note that this mutates the inventory of basis_tree, which not all
 
1062
            # inventory implementations may support: A better idiom would be to
 
1063
            # return a new inventory, but as there is no revision tree cache in
 
1064
            # repository this is safe for now - RBC 20081013
 
1065
            if basis_inv is None:
 
1066
                basis_inv = basis_tree.inventory
 
1067
            basis_inv.apply_delta(delta)
 
1068
            basis_inv.revision_id = new_revision_id
 
1069
            return (self.add_inventory(new_revision_id, basis_inv, parents),
 
1070
                    basis_inv)
 
1071
        finally:
 
1072
            basis_tree.unlock()
 
1073
 
 
1074
    def _inventory_add_lines(self, revision_id, parents, lines,
 
1075
        check_content=True):
 
1076
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
1077
        parents = [(parent,) for parent in parents]
 
1078
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
1079
            check_content=check_content)[0]
 
1080
        self.inventories._access.flush()
 
1081
        return result
 
1082
 
 
1083
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
1084
        """Add rev to the revision store as revision_id.
 
1085
 
 
1086
        :param revision_id: the revision id to use.
96
1087
        :param rev: The revision object.
97
1088
        :param inv: The inventory for the revision. if None, it will be looked
98
1089
                    up in the inventory storer
100
1091
                       If supplied its signature_needed method will be used
101
1092
                       to determine if a signature should be made.
102
1093
        """
 
1094
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
1095
        #       rev.parent_ids?
 
1096
        _mod_revision.check_not_reserved_id(revision_id)
103
1097
        if config is not None and config.signature_needed():
104
1098
            if inv is None:
105
 
                inv = self.get_inventory(rev_id)
 
1099
                inv = self.get_inventory(revision_id)
106
1100
            plaintext = Testament(rev, inv).as_short_text()
107
1101
            self.store_revision_signature(
108
 
                gpg.GPGStrategy(config), plaintext, rev_id)
109
 
        if not rev_id in self.get_inventory_weave():
 
1102
                gpg.GPGStrategy(config), plaintext, revision_id)
 
1103
        # check inventory present
 
1104
        if not self.inventories.get_parent_map([(revision_id,)]):
110
1105
            if inv is None:
111
 
                raise errors.WeaveRevisionNotPresent(rev_id,
112
 
                                                     self.get_inventory_weave())
 
1106
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1107
                                                     self.inventories)
113
1108
            else:
114
1109
                # yes, this is not suitable for adding with ghosts.
115
 
                self.add_inventory(rev_id, inv, rev.parent_ids)
116
 
        self._revision_store.add_revision(rev, self.get_transaction())
 
1110
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1111
                                                        rev.parent_ids)
 
1112
        else:
 
1113
            key = (revision_id,)
 
1114
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1115
        self._add_revision(rev)
117
1116
 
118
 
    @needs_read_lock
119
 
    def _all_possible_ids(self):
120
 
        """Return all the possible revisions that we could find."""
121
 
        return self.get_inventory_weave().versions()
 
1117
    def _add_revision(self, revision):
 
1118
        text = self._serializer.write_revision_to_string(revision)
 
1119
        key = (revision.revision_id,)
 
1120
        parents = tuple((parent,) for parent in revision.parent_ids)
 
1121
        self.revisions.add_lines(key, parents, osutils.split_lines(text))
122
1122
 
123
1123
    def all_revision_ids(self):
124
 
        """Returns a list of all the revision ids in the repository. 
 
1124
        """Returns a list of all the revision ids in the repository.
125
1125
 
126
 
        This is deprecated because code should generally work on the graph
127
 
        reachable from a particular revision, and ignore any other revisions
128
 
        that might be present.  There is no direct replacement method.
 
1126
        This is conceptually deprecated because code should generally work on
 
1127
        the graph reachable from a particular revision, and ignore any other
 
1128
        revisions that might be present.  There is no direct replacement
 
1129
        method.
129
1130
        """
 
1131
        if 'evil' in debug.debug_flags:
 
1132
            mutter_callsite(2, "all_revision_ids is linear with history.")
130
1133
        return self._all_revision_ids()
131
1134
 
132
 
    @needs_read_lock
133
1135
    def _all_revision_ids(self):
134
 
        """Returns a list of all the revision ids in the repository. 
 
1136
        """Returns a list of all the revision ids in the repository.
135
1137
 
136
 
        These are in as much topological order as the underlying store can 
137
 
        present: for weaves ghosts may lead to a lack of correctness until
138
 
        the reweave updates the parents list.
 
1138
        These are in as much topological order as the underlying store can
 
1139
        present.
139
1140
        """
140
 
        if self._revision_store.text_store.listable():
141
 
            return self._revision_store.all_revision_ids(self.get_transaction())
142
 
        result = self._all_possible_ids()
143
 
        return self._eliminate_revisions_not_present(result)
 
1141
        raise NotImplementedError(self._all_revision_ids)
144
1142
 
145
1143
    def break_lock(self):
146
1144
        """Break a lock if one is present from another instance.
157
1155
        Returns a set of the present revisions.
158
1156
        """
159
1157
        result = []
160
 
        for id in revision_ids:
161
 
            if self.has_revision(id):
162
 
               result.append(id)
163
 
        return result
 
1158
        graph = self.get_graph()
 
1159
        parent_map = graph.get_parent_map(revision_ids)
 
1160
        # The old API returned a list, should this actually be a set?
 
1161
        return parent_map.keys()
 
1162
 
 
1163
    def _check_inventories(self, checker):
 
1164
        """Check the inventories found from the revision scan.
 
1165
        
 
1166
        This is responsible for verifying the sha1 of inventories and
 
1167
        creating a pending_keys set that covers data referenced by inventories.
 
1168
        """
 
1169
        bar = ui.ui_factory.nested_progress_bar()
 
1170
        try:
 
1171
            self._do_check_inventories(checker, bar)
 
1172
        finally:
 
1173
            bar.finished()
 
1174
 
 
1175
    def _do_check_inventories(self, checker, bar):
 
1176
        """Helper for _check_inventories."""
 
1177
        revno = 0
 
1178
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
 
1179
        kinds = ['chk_bytes', 'texts']
 
1180
        count = len(checker.pending_keys)
 
1181
        bar.update("inventories", 0, 2)
 
1182
        current_keys = checker.pending_keys
 
1183
        checker.pending_keys = {}
 
1184
        # Accumulate current checks.
 
1185
        for key in current_keys:
 
1186
            if key[0] != 'inventories' and key[0] not in kinds:
 
1187
                checker._report_items.append('unknown key type %r' % (key,))
 
1188
            keys[key[0]].add(key[1:])
 
1189
        if keys['inventories']:
 
1190
            # NB: output order *should* be roughly sorted - topo or
 
1191
            # inverse topo depending on repository - either way decent
 
1192
            # to just delta against. However, pre-CHK formats didn't
 
1193
            # try to optimise inventory layout on disk. As such the
 
1194
            # pre-CHK code path does not use inventory deltas.
 
1195
            last_object = None
 
1196
            for record in self.inventories.check(keys=keys['inventories']):
 
1197
                if record.storage_kind == 'absent':
 
1198
                    checker._report_items.append(
 
1199
                        'Missing inventory {%s}' % (record.key,))
 
1200
                else:
 
1201
                    last_object = self._check_record('inventories', record,
 
1202
                        checker, last_object,
 
1203
                        current_keys[('inventories',) + record.key])
 
1204
            del keys['inventories']
 
1205
        else:
 
1206
            return
 
1207
        bar.update("texts", 1)
 
1208
        while (checker.pending_keys or keys['chk_bytes']
 
1209
            or keys['texts']):
 
1210
            # Something to check.
 
1211
            current_keys = checker.pending_keys
 
1212
            checker.pending_keys = {}
 
1213
            # Accumulate current checks.
 
1214
            for key in current_keys:
 
1215
                if key[0] not in kinds:
 
1216
                    checker._report_items.append('unknown key type %r' % (key,))
 
1217
                keys[key[0]].add(key[1:])
 
1218
            # Check the outermost kind only - inventories || chk_bytes || texts
 
1219
            for kind in kinds:
 
1220
                if keys[kind]:
 
1221
                    last_object = None
 
1222
                    for record in getattr(self, kind).check(keys=keys[kind]):
 
1223
                        if record.storage_kind == 'absent':
 
1224
                            checker._report_items.append(
 
1225
                                'Missing %s {%s}' % (kind, record.key,))
 
1226
                        else:
 
1227
                            last_object = self._check_record(kind, record,
 
1228
                                checker, last_object, current_keys[(kind,) + record.key])
 
1229
                    keys[kind] = set()
 
1230
                    break
 
1231
 
 
1232
    def _check_record(self, kind, record, checker, last_object, item_data):
 
1233
        """Check a single text from this repository."""
 
1234
        if kind == 'inventories':
 
1235
            rev_id = record.key[0]
 
1236
            inv = self.deserialise_inventory(rev_id,
 
1237
                record.get_bytes_as('fulltext'))
 
1238
            if last_object is not None:
 
1239
                delta = inv._make_delta(last_object)
 
1240
                for old_path, path, file_id, ie in delta:
 
1241
                    if ie is None:
 
1242
                        continue
 
1243
                    ie.check(checker, rev_id, inv)
 
1244
            else:
 
1245
                for path, ie in inv.iter_entries():
 
1246
                    ie.check(checker, rev_id, inv)
 
1247
            if self._format.fast_deltas:
 
1248
                return inv
 
1249
        elif kind == 'chk_bytes':
 
1250
            # No code written to check chk_bytes for this repo format.
 
1251
            checker._report_items.append(
 
1252
                'unsupported key type chk_bytes for %s' % (record.key,))
 
1253
        elif kind == 'texts':
 
1254
            self._check_text(record, checker, item_data)
 
1255
        else:
 
1256
            checker._report_items.append(
 
1257
                'unknown key type %s for %s' % (kind, record.key))
 
1258
 
 
1259
    def _check_text(self, record, checker, item_data):
 
1260
        """Check a single text."""
 
1261
        # Check it is extractable.
 
1262
        # TODO: check length.
 
1263
        if record.storage_kind == 'chunked':
 
1264
            chunks = record.get_bytes_as(record.storage_kind)
 
1265
            sha1 = osutils.sha_strings(chunks)
 
1266
            length = sum(map(len, chunks))
 
1267
        else:
 
1268
            content = record.get_bytes_as('fulltext')
 
1269
            sha1 = osutils.sha_string(content)
 
1270
            length = len(content)
 
1271
        if item_data and sha1 != item_data[1]:
 
1272
            checker._report_items.append(
 
1273
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
 
1274
                (record.key, sha1, item_data[1], item_data[2]))
164
1275
 
165
1276
    @staticmethod
166
1277
    def create(a_bzrdir):
167
1278
        """Construct the current default format repository in a_bzrdir."""
168
1279
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
169
1280
 
170
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
1281
    def __init__(self, _format, a_bzrdir, control_files):
171
1282
        """instantiate a Repository.
172
1283
 
173
1284
        :param _format: The format of the repository on disk.
182
1293
        # the following are part of the public API for Repository:
183
1294
        self.bzrdir = a_bzrdir
184
1295
        self.control_files = control_files
185
 
        self._revision_store = _revision_store
186
 
        self.text_store = text_store
187
 
        # backwards compatibility
188
 
        self.weave_store = text_store
189
 
        # not right yet - should be more semantically clear ? 
190
 
        # 
191
 
        self.control_store = control_store
192
 
        self.control_weaves = control_store
 
1296
        self._transport = control_files._transport
 
1297
        self.base = self._transport.base
 
1298
        # for tests
 
1299
        self._reconcile_does_inventory_gc = True
 
1300
        self._reconcile_fixes_text_parents = False
 
1301
        self._reconcile_backsup_inventory = True
 
1302
        # not right yet - should be more semantically clear ?
 
1303
        #
193
1304
        # TODO: make sure to construct the right store classes, etc, depending
194
1305
        # on whether escaping is required.
195
1306
        self._warn_if_deprecated()
 
1307
        self._write_group = None
 
1308
        # Additional places to query for data.
 
1309
        self._fallback_repositories = []
 
1310
        # An InventoryEntry cache, used during deserialization
 
1311
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
196
1312
 
197
1313
    def __repr__(self):
198
 
        return '%s(%r)' % (self.__class__.__name__, 
199
 
                           self.bzrdir.transport.base)
 
1314
        if self._fallback_repositories:
 
1315
            return '%s(%r, fallback_repositories=%r)' % (
 
1316
                self.__class__.__name__,
 
1317
                self.base,
 
1318
                self._fallback_repositories)
 
1319
        else:
 
1320
            return '%s(%r)' % (self.__class__.__name__,
 
1321
                               self.base)
 
1322
 
 
1323
    def _has_same_fallbacks(self, other_repo):
 
1324
        """Returns true if the repositories have the same fallbacks."""
 
1325
        my_fb = self._fallback_repositories
 
1326
        other_fb = other_repo._fallback_repositories
 
1327
        if len(my_fb) != len(other_fb):
 
1328
            return False
 
1329
        for f, g in zip(my_fb, other_fb):
 
1330
            if not f.has_same_location(g):
 
1331
                return False
 
1332
        return True
 
1333
 
 
1334
    def has_same_location(self, other):
 
1335
        """Returns a boolean indicating if this repository is at the same
 
1336
        location as another repository.
 
1337
 
 
1338
        This might return False even when two repository objects are accessing
 
1339
        the same physical repository via different URLs.
 
1340
        """
 
1341
        if self.__class__ is not other.__class__:
 
1342
            return False
 
1343
        return (self._transport.base == other._transport.base)
 
1344
 
 
1345
    def is_in_write_group(self):
 
1346
        """Return True if there is an open write group.
 
1347
 
 
1348
        :seealso: start_write_group.
 
1349
        """
 
1350
        return self._write_group is not None
200
1351
 
201
1352
    def is_locked(self):
202
1353
        return self.control_files.is_locked()
203
1354
 
204
 
    def lock_write(self):
205
 
        self.control_files.lock_write()
 
1355
    def is_write_locked(self):
 
1356
        """Return True if this object is write locked."""
 
1357
        return self.is_locked() and self.control_files._lock_mode == 'w'
 
1358
 
 
1359
    def lock_write(self, token=None):
 
1360
        """Lock this repository for writing.
 
1361
 
 
1362
        This causes caching within the repository obejct to start accumlating
 
1363
        data during reads, and allows a 'write_group' to be obtained. Write
 
1364
        groups must be used for actual data insertion.
 
1365
 
 
1366
        :param token: if this is already locked, then lock_write will fail
 
1367
            unless the token matches the existing lock.
 
1368
        :returns: a token if this instance supports tokens, otherwise None.
 
1369
        :raises TokenLockingNotSupported: when a token is given but this
 
1370
            instance doesn't support using token locks.
 
1371
        :raises MismatchedToken: if the specified token doesn't match the token
 
1372
            of the existing lock.
 
1373
        :seealso: start_write_group.
 
1374
 
 
1375
        A token should be passed in if you know that you have locked the object
 
1376
        some other way, and need to synchronise this object's state with that
 
1377
        fact.
 
1378
 
 
1379
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1380
        """
 
1381
        locked = self.is_locked()
 
1382
        result = self.control_files.lock_write(token=token)
 
1383
        if not locked:
 
1384
            for repo in self._fallback_repositories:
 
1385
                # Writes don't affect fallback repos
 
1386
                repo.lock_read()
 
1387
            self._refresh_data()
 
1388
        return result
206
1389
 
207
1390
    def lock_read(self):
 
1391
        locked = self.is_locked()
208
1392
        self.control_files.lock_read()
 
1393
        if not locked:
 
1394
            for repo in self._fallback_repositories:
 
1395
                repo.lock_read()
 
1396
            self._refresh_data()
209
1397
 
210
1398
    def get_physical_lock_status(self):
211
1399
        return self.control_files.get_physical_lock_status()
212
1400
 
213
 
    @needs_read_lock
214
 
    def missing_revision_ids(self, other, revision_id=None):
 
1401
    def leave_lock_in_place(self):
 
1402
        """Tell this repository not to release the physical lock when this
 
1403
        object is unlocked.
 
1404
 
 
1405
        If lock_write doesn't return a token, then this method is not supported.
 
1406
        """
 
1407
        self.control_files.leave_in_place()
 
1408
 
 
1409
    def dont_leave_lock_in_place(self):
 
1410
        """Tell this repository to release the physical lock when this
 
1411
        object is unlocked, even if it didn't originally acquire it.
 
1412
 
 
1413
        If lock_write doesn't return a token, then this method is not supported.
 
1414
        """
 
1415
        self.control_files.dont_leave_in_place()
 
1416
 
 
1417
    @needs_read_lock
 
1418
    def gather_stats(self, revid=None, committers=None):
 
1419
        """Gather statistics from a revision id.
 
1420
 
 
1421
        :param revid: The revision id to gather statistics from, if None, then
 
1422
            no revision specific statistics are gathered.
 
1423
        :param committers: Optional parameter controlling whether to grab
 
1424
            a count of committers from the revision specific statistics.
 
1425
        :return: A dictionary of statistics. Currently this contains:
 
1426
            committers: The number of committers if requested.
 
1427
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
1428
                most ancestor of revid, if revid is not the NULL_REVISION.
 
1429
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
1430
                not the NULL_REVISION.
 
1431
            revisions: The total revision count in the repository.
 
1432
            size: An estimate disk size of the repository in bytes.
 
1433
        """
 
1434
        result = {}
 
1435
        if revid and committers:
 
1436
            result['committers'] = 0
 
1437
        if revid and revid != _mod_revision.NULL_REVISION:
 
1438
            if committers:
 
1439
                all_committers = set()
 
1440
            revisions = self.get_ancestry(revid)
 
1441
            # pop the leading None
 
1442
            revisions.pop(0)
 
1443
            first_revision = None
 
1444
            if not committers:
 
1445
                # ignore the revisions in the middle - just grab first and last
 
1446
                revisions = revisions[0], revisions[-1]
 
1447
            for revision in self.get_revisions(revisions):
 
1448
                if not first_revision:
 
1449
                    first_revision = revision
 
1450
                if committers:
 
1451
                    all_committers.add(revision.committer)
 
1452
            last_revision = revision
 
1453
            if committers:
 
1454
                result['committers'] = len(all_committers)
 
1455
            result['firstrev'] = (first_revision.timestamp,
 
1456
                first_revision.timezone)
 
1457
            result['latestrev'] = (last_revision.timestamp,
 
1458
                last_revision.timezone)
 
1459
 
 
1460
        # now gather global repository information
 
1461
        # XXX: This is available for many repos regardless of listability.
 
1462
        if self.bzrdir.root_transport.listable():
 
1463
            # XXX: do we want to __define len__() ?
 
1464
            # Maybe the versionedfiles object should provide a different
 
1465
            # method to get the number of keys.
 
1466
            result['revisions'] = len(self.revisions.keys())
 
1467
            # result['size'] = t
 
1468
        return result
 
1469
 
 
1470
    def find_branches(self, using=False):
 
1471
        """Find branches underneath this repository.
 
1472
 
 
1473
        This will include branches inside other branches.
 
1474
 
 
1475
        :param using: If True, list only branches using this repository.
 
1476
        """
 
1477
        if using and not self.is_shared():
 
1478
            try:
 
1479
                return [self.bzrdir.open_branch()]
 
1480
            except errors.NotBranchError:
 
1481
                return []
 
1482
        class Evaluator(object):
 
1483
 
 
1484
            def __init__(self):
 
1485
                self.first_call = True
 
1486
 
 
1487
            def __call__(self, bzrdir):
 
1488
                # On the first call, the parameter is always the bzrdir
 
1489
                # containing the current repo.
 
1490
                if not self.first_call:
 
1491
                    try:
 
1492
                        repository = bzrdir.open_repository()
 
1493
                    except errors.NoRepositoryPresent:
 
1494
                        pass
 
1495
                    else:
 
1496
                        return False, (None, repository)
 
1497
                self.first_call = False
 
1498
                try:
 
1499
                    value = (bzrdir.open_branch(), None)
 
1500
                except errors.NotBranchError:
 
1501
                    value = (None, None)
 
1502
                return True, value
 
1503
 
 
1504
        branches = []
 
1505
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1506
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1507
            if branch is not None:
 
1508
                branches.append(branch)
 
1509
            if not using and repository is not None:
 
1510
                branches.extend(repository.find_branches())
 
1511
        return branches
 
1512
 
 
1513
    @needs_read_lock
 
1514
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
215
1515
        """Return the revision ids that other has that this does not.
216
 
        
 
1516
 
217
1517
        These are returned in topological order.
218
1518
 
219
1519
        revision_id: only return revision ids included by revision_id.
220
1520
        """
221
 
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
1521
        return InterRepository.get(other, self).search_missing_revision_ids(
 
1522
            revision_id, find_ghosts)
222
1523
 
223
1524
    @staticmethod
224
1525
    def open(base):
230
1531
        control = bzrdir.BzrDir.open(base)
231
1532
        return control.open_repository()
232
1533
 
233
 
    def copy_content_into(self, destination, revision_id=None, basis=None):
 
1534
    def copy_content_into(self, destination, revision_id=None):
234
1535
        """Make a complete copy of the content in self into destination.
 
1536
 
 
1537
        This is a destructive operation! Do not use it on existing
 
1538
        repositories.
 
1539
        """
 
1540
        return InterRepository.get(self, destination).copy_content(revision_id)
 
1541
 
 
1542
    def commit_write_group(self):
 
1543
        """Commit the contents accrued within the current write group.
 
1544
 
 
1545
        :seealso: start_write_group.
235
1546
        
236
 
        This is a destructive operation! Do not use it on existing 
237
 
        repositories.
238
 
        """
239
 
        return InterRepository.get(self, destination).copy_content(revision_id, basis)
240
 
 
241
 
    def fetch(self, source, revision_id=None, pb=None):
 
1547
        :return: it may return an opaque hint that can be passed to 'pack'.
 
1548
        """
 
1549
        if self._write_group is not self.get_transaction():
 
1550
            # has an unlock or relock occured ?
 
1551
            raise errors.BzrError('mismatched lock context %r and '
 
1552
                'write group %r.' %
 
1553
                (self.get_transaction(), self._write_group))
 
1554
        result = self._commit_write_group()
 
1555
        self._write_group = None
 
1556
        return result
 
1557
 
 
1558
    def _commit_write_group(self):
 
1559
        """Template method for per-repository write group cleanup.
 
1560
 
 
1561
        This is called before the write group is considered to be
 
1562
        finished and should ensure that all data handed to the repository
 
1563
        for writing during the write group is safely committed (to the
 
1564
        extent possible considering file system caching etc).
 
1565
        """
 
1566
 
 
1567
    def suspend_write_group(self):
 
1568
        raise errors.UnsuspendableWriteGroup(self)
 
1569
 
 
1570
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1571
        """Return the keys of missing inventory parents for revisions added in
 
1572
        this write group.
 
1573
 
 
1574
        A revision is not complete if the inventory delta for that revision
 
1575
        cannot be calculated.  Therefore if the parent inventories of a
 
1576
        revision are not present, the revision is incomplete, and e.g. cannot
 
1577
        be streamed by a smart server.  This method finds missing inventory
 
1578
        parents for revisions added in this write group.
 
1579
        """
 
1580
        if not self._format.supports_external_lookups:
 
1581
            # This is only an issue for stacked repositories
 
1582
            return set()
 
1583
        if not self.is_in_write_group():
 
1584
            raise AssertionError('not in a write group')
 
1585
 
 
1586
        # XXX: We assume that every added revision already has its
 
1587
        # corresponding inventory, so we only check for parent inventories that
 
1588
        # might be missing, rather than all inventories.
 
1589
        parents = set(self.revisions._index.get_missing_parents())
 
1590
        parents.discard(_mod_revision.NULL_REVISION)
 
1591
        unstacked_inventories = self.inventories._index
 
1592
        present_inventories = unstacked_inventories.get_parent_map(
 
1593
            key[-1:] for key in parents)
 
1594
        parents.difference_update(present_inventories)
 
1595
        if len(parents) == 0:
 
1596
            # No missing parent inventories.
 
1597
            return set()
 
1598
        if not check_for_missing_texts:
 
1599
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1600
        # Ok, now we have a list of missing inventories.  But these only matter
 
1601
        # if the inventories that reference them are missing some texts they
 
1602
        # appear to introduce.
 
1603
        # XXX: Texts referenced by all added inventories need to be present,
 
1604
        # but at the moment we're only checking for texts referenced by
 
1605
        # inventories at the graph's edge.
 
1606
        key_deps = self.revisions._index._key_dependencies
 
1607
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1608
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1609
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1610
        missing_texts = set()
 
1611
        for file_id, version_ids in file_ids.iteritems():
 
1612
            missing_texts.update(
 
1613
                (file_id, version_id) for version_id in version_ids)
 
1614
        present_texts = self.texts.get_parent_map(missing_texts)
 
1615
        missing_texts.difference_update(present_texts)
 
1616
        if not missing_texts:
 
1617
            # No texts are missing, so all revisions and their deltas are
 
1618
            # reconstructable.
 
1619
            return set()
 
1620
        # Alternatively the text versions could be returned as the missing
 
1621
        # keys, but this is likely to be less data.
 
1622
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1623
        return missing_keys
 
1624
 
 
1625
    def refresh_data(self):
 
1626
        """Re-read any data needed to to synchronise with disk.
 
1627
 
 
1628
        This method is intended to be called after another repository instance
 
1629
        (such as one used by a smart server) has inserted data into the
 
1630
        repository. It may not be called during a write group, but may be
 
1631
        called at any other time.
 
1632
        """
 
1633
        if self.is_in_write_group():
 
1634
            raise errors.InternalBzrError(
 
1635
                "May not refresh_data while in a write group.")
 
1636
        self._refresh_data()
 
1637
 
 
1638
    def resume_write_group(self, tokens):
 
1639
        if not self.is_write_locked():
 
1640
            raise errors.NotWriteLocked(self)
 
1641
        if self._write_group:
 
1642
            raise errors.BzrError('already in a write group')
 
1643
        self._resume_write_group(tokens)
 
1644
        # so we can detect unlock/relock - the write group is now entered.
 
1645
        self._write_group = self.get_transaction()
 
1646
 
 
1647
    def _resume_write_group(self, tokens):
 
1648
        raise errors.UnsuspendableWriteGroup(self)
 
1649
 
 
1650
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1651
            fetch_spec=None):
242
1652
        """Fetch the content required to construct revision_id from source.
243
1653
 
244
 
        If revision_id is None all content is copied.
 
1654
        If revision_id is None and fetch_spec is None, then all content is
 
1655
        copied.
 
1656
 
 
1657
        fetch() may not be used when the repository is in a write group -
 
1658
        either finish the current write group before using fetch, or use
 
1659
        fetch before starting the write group.
 
1660
 
 
1661
        :param find_ghosts: Find and copy revisions in the source that are
 
1662
            ghosts in the target (and not reachable directly by walking out to
 
1663
            the first-present revision in target from revision_id).
 
1664
        :param revision_id: If specified, all the content needed for this
 
1665
            revision ID will be copied to the target.  Fetch will determine for
 
1666
            itself which content needs to be copied.
 
1667
        :param fetch_spec: If specified, a SearchResult or
 
1668
            PendingAncestryResult that describes which revisions to copy.  This
 
1669
            allows copying multiple heads at once.  Mutually exclusive with
 
1670
            revision_id.
245
1671
        """
246
 
        return InterRepository.get(source, self).fetch(revision_id=revision_id,
247
 
                                                       pb=pb)
248
 
 
249
 
    def get_commit_builder(self, branch, parents, config, timestamp=None, 
250
 
                           timezone=None, committer=None, revprops=None, 
 
1672
        if fetch_spec is not None and revision_id is not None:
 
1673
            raise AssertionError(
 
1674
                "fetch_spec and revision_id are mutually exclusive.")
 
1675
        if self.is_in_write_group():
 
1676
            raise errors.InternalBzrError(
 
1677
                "May not fetch while in a write group.")
 
1678
        # fast path same-url fetch operations
 
1679
        # TODO: lift out to somewhere common with RemoteRepository
 
1680
        # <https://bugs.edge.launchpad.net/bzr/+bug/401646>
 
1681
        if (self.has_same_location(source)
 
1682
            and fetch_spec is None
 
1683
            and self._has_same_fallbacks(source)):
 
1684
            # check that last_revision is in 'from' and then return a
 
1685
            # no-operation.
 
1686
            if (revision_id is not None and
 
1687
                not _mod_revision.is_null(revision_id)):
 
1688
                self.get_revision(revision_id)
 
1689
            return 0, []
 
1690
        # if there is no specific appropriate InterRepository, this will get
 
1691
        # the InterRepository base class, which raises an
 
1692
        # IncompatibleRepositories when asked to fetch.
 
1693
        inter = InterRepository.get(source, self)
 
1694
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1695
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1696
 
 
1697
    def create_bundle(self, target, base, fileobj, format=None):
 
1698
        return serializer.write_bundle(self, target, base, fileobj, format)
 
1699
 
 
1700
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
1701
                           timezone=None, committer=None, revprops=None,
251
1702
                           revision_id=None):
252
1703
        """Obtain a CommitBuilder for this repository.
253
 
        
 
1704
 
254
1705
        :param branch: Branch to commit to.
255
1706
        :param parents: Revision ids of the parents of the new revision.
256
1707
        :param config: Configuration to use.
260
1711
        :param revprops: Optional dictionary of revision properties.
261
1712
        :param revision_id: Optional revision id.
262
1713
        """
263
 
        return CommitBuilder(self, parents, config, timestamp, timezone,
264
 
                             committer, revprops, revision_id)
 
1714
        if self._fallback_repositories:
 
1715
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1716
                "to a stacked branch. See "
 
1717
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1718
        result = self._commit_builder_class(self, parents, config,
 
1719
            timestamp, timezone, committer, revprops, revision_id)
 
1720
        self.start_write_group()
 
1721
        return result
265
1722
 
266
1723
    def unlock(self):
 
1724
        if (self.control_files._lock_count == 1 and
 
1725
            self.control_files._lock_mode == 'w'):
 
1726
            if self._write_group is not None:
 
1727
                self.abort_write_group()
 
1728
                self.control_files.unlock()
 
1729
                raise errors.BzrError(
 
1730
                    'Must end write groups before releasing write locks.')
267
1731
        self.control_files.unlock()
 
1732
        if self.control_files._lock_count == 0:
 
1733
            self._inventory_entry_cache.clear()
 
1734
            for repo in self._fallback_repositories:
 
1735
                repo.unlock()
268
1736
 
269
1737
    @needs_read_lock
270
 
    def clone(self, a_bzrdir, revision_id=None, basis=None):
 
1738
    def clone(self, a_bzrdir, revision_id=None):
271
1739
        """Clone this repository into a_bzrdir using the current format.
272
1740
 
273
1741
        Currently no check is made that the format of this repository and
274
1742
        the bzrdir format are compatible. FIXME RBC 20060201.
275
 
        """
 
1743
 
 
1744
        :return: The newly created destination repository.
 
1745
        """
 
1746
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
1747
        # probably not very useful -- mbp 20070423
 
1748
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
1749
        self.copy_content_into(dest_repo, revision_id)
 
1750
        return dest_repo
 
1751
 
 
1752
    def start_write_group(self):
 
1753
        """Start a write group in the repository.
 
1754
 
 
1755
        Write groups are used by repositories which do not have a 1:1 mapping
 
1756
        between file ids and backend store to manage the insertion of data from
 
1757
        both fetch and commit operations.
 
1758
 
 
1759
        A write lock is required around the start_write_group/commit_write_group
 
1760
        for the support of lock-requiring repository formats.
 
1761
 
 
1762
        One can only insert data into a repository inside a write group.
 
1763
 
 
1764
        :return: None.
 
1765
        """
 
1766
        if not self.is_write_locked():
 
1767
            raise errors.NotWriteLocked(self)
 
1768
        if self._write_group:
 
1769
            raise errors.BzrError('already in a write group')
 
1770
        self._start_write_group()
 
1771
        # so we can detect unlock/relock - the write group is now entered.
 
1772
        self._write_group = self.get_transaction()
 
1773
 
 
1774
    def _start_write_group(self):
 
1775
        """Template method for per-repository write group startup.
 
1776
 
 
1777
        This is called before the write group is considered to be
 
1778
        entered.
 
1779
        """
 
1780
 
 
1781
    @needs_read_lock
 
1782
    def sprout(self, to_bzrdir, revision_id=None):
 
1783
        """Create a descendent repository for new development.
 
1784
 
 
1785
        Unlike clone, this does not copy the settings of the repository.
 
1786
        """
 
1787
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
1788
        dest_repo.fetch(self, revision_id=revision_id)
 
1789
        return dest_repo
 
1790
 
 
1791
    def _create_sprouting_repo(self, a_bzrdir, shared):
276
1792
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
277
1793
            # use target default format.
278
 
            result = a_bzrdir.create_repository()
279
 
        # FIXME RBC 20060209 split out the repository type to avoid this check ?
280
 
        elif isinstance(a_bzrdir._format,
281
 
                      (bzrdir.BzrDirFormat4,
282
 
                       bzrdir.BzrDirFormat5,
283
 
                       bzrdir.BzrDirFormat6)):
284
 
            result = a_bzrdir.open_repository()
 
1794
            dest_repo = a_bzrdir.create_repository()
285
1795
        else:
286
 
            result = self._format.initialize(a_bzrdir, shared=self.is_shared())
287
 
        self.copy_content_into(result, revision_id, basis)
288
 
        return result
 
1796
            # Most control formats need the repository to be specifically
 
1797
            # created, but on some old all-in-one formats it's not needed
 
1798
            try:
 
1799
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1800
            except errors.UninitializableFormat:
 
1801
                dest_repo = a_bzrdir.open_repository()
 
1802
        return dest_repo
 
1803
 
 
1804
    def _get_sink(self):
 
1805
        """Return a sink for streaming into this repository."""
 
1806
        return StreamSink(self)
 
1807
 
 
1808
    def _get_source(self, to_format):
 
1809
        """Return a source for streaming from this repository."""
 
1810
        return StreamSource(self, to_format)
289
1811
 
290
1812
    @needs_read_lock
291
1813
    def has_revision(self, revision_id):
292
1814
        """True if this repository has a copy of the revision."""
293
 
        return self._revision_store.has_revision_id(revision_id,
294
 
                                                    self.get_transaction())
 
1815
        return revision_id in self.has_revisions((revision_id,))
 
1816
 
 
1817
    @needs_read_lock
 
1818
    def has_revisions(self, revision_ids):
 
1819
        """Probe to find out the presence of multiple revisions.
 
1820
 
 
1821
        :param revision_ids: An iterable of revision_ids.
 
1822
        :return: A set of the revision_ids that were present.
 
1823
        """
 
1824
        parent_map = self.revisions.get_parent_map(
 
1825
            [(rev_id,) for rev_id in revision_ids])
 
1826
        result = set()
 
1827
        if _mod_revision.NULL_REVISION in revision_ids:
 
1828
            result.add(_mod_revision.NULL_REVISION)
 
1829
        result.update([key[0] for key in parent_map])
 
1830
        return result
 
1831
 
 
1832
    @needs_read_lock
 
1833
    def get_revision(self, revision_id):
 
1834
        """Return the Revision object for a named revision."""
 
1835
        return self.get_revisions([revision_id])[0]
295
1836
 
296
1837
    @needs_read_lock
297
1838
    def get_revision_reconcile(self, revision_id):
298
1839
        """'reconcile' helper routine that allows access to a revision always.
299
 
        
 
1840
 
300
1841
        This variant of get_revision does not cross check the weave graph
301
1842
        against the revision one as get_revision does: but it should only
302
1843
        be used by reconcile, or reconcile-alike commands that are correcting
303
1844
        or testing the revision graph.
304
1845
        """
305
 
        if not revision_id or not isinstance(revision_id, basestring):
306
 
            raise InvalidRevisionId(revision_id=revision_id, branch=self)
307
 
        return self._revision_store.get_revisions([revision_id],
308
 
                                                  self.get_transaction())[0]
 
1846
        return self._get_revisions([revision_id])[0]
 
1847
 
309
1848
    @needs_read_lock
310
1849
    def get_revisions(self, revision_ids):
311
 
        return self._revision_store.get_revisions(revision_ids,
312
 
                                                  self.get_transaction())
 
1850
        """Get many revisions at once.
 
1851
        
 
1852
        Repositories that need to check data on every revision read should 
 
1853
        subclass this method.
 
1854
        """
 
1855
        return self._get_revisions(revision_ids)
 
1856
 
 
1857
    @needs_read_lock
 
1858
    def _get_revisions(self, revision_ids):
 
1859
        """Core work logic to get many revisions without sanity checks."""
 
1860
        revs = {}
 
1861
        for revid, rev in self._iter_revisions(revision_ids):
 
1862
            if rev is None:
 
1863
                raise errors.NoSuchRevision(self, revid)
 
1864
            revs[revid] = rev
 
1865
        return [revs[revid] for revid in revision_ids]
 
1866
 
 
1867
    def _iter_revisions(self, revision_ids):
 
1868
        """Iterate over revision objects.
 
1869
 
 
1870
        :param revision_ids: An iterable of revisions to examine. None may be
 
1871
            passed to request all revisions known to the repository. Note that
 
1872
            not all repositories can find unreferenced revisions; for those
 
1873
            repositories only referenced ones will be returned.
 
1874
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1875
            those asked for but not available) are returned as (revid, None).
 
1876
        """
 
1877
        if revision_ids is None:
 
1878
            revision_ids = self.all_revision_ids()
 
1879
        else:
 
1880
            for rev_id in revision_ids:
 
1881
                if not rev_id or not isinstance(rev_id, basestring):
 
1882
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1883
        keys = [(key,) for key in revision_ids]
 
1884
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
 
1885
        for record in stream:
 
1886
            revid = record.key[0]
 
1887
            if record.storage_kind == 'absent':
 
1888
                yield (revid, None)
 
1889
            else:
 
1890
                text = record.get_bytes_as('fulltext')
 
1891
                rev = self._serializer.read_revision_from_string(text)
 
1892
                yield (revid, rev)
313
1893
 
314
1894
    @needs_read_lock
315
1895
    def get_revision_xml(self, revision_id):
316
 
        rev = self.get_revision(revision_id) 
317
 
        rev_tmp = StringIO()
 
1896
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1897
        #       would have already do it.
 
1898
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1899
        # TODO: this can't just be replaced by:
 
1900
        # return self._serializer.write_revision_to_string(
 
1901
        #     self.get_revision(revision_id))
 
1902
        # as cStringIO preservers the encoding unlike write_revision_to_string
 
1903
        # or some other call down the path.
 
1904
        rev = self.get_revision(revision_id)
 
1905
        rev_tmp = cStringIO.StringIO()
318
1906
        # the current serializer..
319
 
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
1907
        self._serializer.write_revision(rev, rev_tmp)
320
1908
        rev_tmp.seek(0)
321
1909
        return rev_tmp.getvalue()
322
1910
 
323
 
    @needs_read_lock
324
 
    def get_revision(self, revision_id):
325
 
        """Return the Revision object for a named revision"""
326
 
        r = self.get_revision_reconcile(revision_id)
327
 
        # weave corruption can lead to absent revision markers that should be
328
 
        # present.
329
 
        # the following test is reasonably cheap (it needs a single weave read)
330
 
        # and the weave is cached in read transactions. In write transactions
331
 
        # it is not cached but typically we only read a small number of
332
 
        # revisions. For knits when they are introduced we will probably want
333
 
        # to ensure that caching write transactions are in use.
334
 
        inv = self.get_inventory_weave()
335
 
        self._check_revision_parents(r, inv)
336
 
        return r
337
 
 
338
 
    @needs_read_lock
339
 
    def get_deltas_for_revisions(self, revisions):
 
1911
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
340
1912
        """Produce a generator of revision deltas.
341
 
        
 
1913
 
342
1914
        Note that the input is a sequence of REVISIONS, not revision_ids.
343
1915
        Trees will be held in memory until the generator exits.
344
1916
        Each delta is relative to the revision's lefthand predecessor.
 
1917
 
 
1918
        :param specific_fileids: if not None, the result is filtered
 
1919
          so that only those file-ids, their parents and their
 
1920
          children are included.
345
1921
        """
 
1922
        # Get the revision-ids of interest
346
1923
        required_trees = set()
347
1924
        for revision in revisions:
348
1925
            required_trees.add(revision.revision_id)
349
1926
            required_trees.update(revision.parent_ids[:1])
350
 
        trees = dict((t.get_revision_id(), t) for 
351
 
                     t in self.revision_trees(required_trees))
 
1927
 
 
1928
        # Get the matching filtered trees. Note that it's more
 
1929
        # efficient to pass filtered trees to changes_from() rather
 
1930
        # than doing the filtering afterwards. changes_from() could
 
1931
        # arguably do the filtering itself but it's path-based, not
 
1932
        # file-id based, so filtering before or afterwards is
 
1933
        # currently easier.
 
1934
        if specific_fileids is None:
 
1935
            trees = dict((t.get_revision_id(), t) for
 
1936
                t in self.revision_trees(required_trees))
 
1937
        else:
 
1938
            trees = dict((t.get_revision_id(), t) for
 
1939
                t in self._filtered_revision_trees(required_trees,
 
1940
                specific_fileids))
 
1941
 
 
1942
        # Calculate the deltas
352
1943
        for revision in revisions:
353
1944
            if not revision.parent_ids:
354
 
                old_tree = self.revision_tree(None)
 
1945
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
355
1946
            else:
356
1947
                old_tree = trees[revision.parent_ids[0]]
357
1948
            yield trees[revision.revision_id].changes_from(old_tree)
358
1949
 
359
1950
    @needs_read_lock
360
 
    def get_revision_delta(self, revision_id):
 
1951
    def get_revision_delta(self, revision_id, specific_fileids=None):
361
1952
        """Return the delta for one revision.
362
1953
 
363
1954
        The delta is relative to the left-hand predecessor of the
364
1955
        revision.
 
1956
 
 
1957
        :param specific_fileids: if not None, the result is filtered
 
1958
          so that only those file-ids, their parents and their
 
1959
          children are included.
365
1960
        """
366
1961
        r = self.get_revision(revision_id)
367
 
        return list(self.get_deltas_for_revisions([r]))[0]
368
 
 
369
 
    def _check_revision_parents(self, revision, inventory):
370
 
        """Private to Repository and Fetch.
371
 
        
372
 
        This checks the parentage of revision in an inventory weave for 
373
 
        consistency and is only applicable to inventory-weave-for-ancestry
374
 
        using repository formats & fetchers.
375
 
        """
376
 
        weave_parents = inventory.get_parents(revision.revision_id)
377
 
        weave_names = inventory.versions()
378
 
        for parent_id in revision.parent_ids:
379
 
            if parent_id in weave_names:
380
 
                # this parent must not be a ghost.
381
 
                if not parent_id in weave_parents:
382
 
                    # but it is a ghost
383
 
                    raise errors.CorruptRepository(self)
 
1962
        return list(self.get_deltas_for_revisions([r],
 
1963
            specific_fileids=specific_fileids))[0]
384
1964
 
385
1965
    @needs_write_lock
386
1966
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
387
1967
        signature = gpg_strategy.sign(plaintext)
388
 
        self._revision_store.add_revision_signature_text(revision_id,
389
 
                                                         signature,
390
 
                                                         self.get_transaction())
391
 
 
392
 
    def fileids_altered_by_revision_ids(self, revision_ids):
393
 
        """Find the file ids and versions affected by revisions.
394
 
 
395
 
        :param revisions: an iterable containing revision ids.
396
 
        :return: a dictionary mapping altered file-ids to an iterable of
397
 
        revision_ids. Each altered file-ids has the exact revision_ids that
398
 
        altered it listed explicitly.
399
 
        """
400
 
        assert isinstance(self._format, (RepositoryFormat5,
401
 
                                         RepositoryFormat6,
402
 
                                         RepositoryFormat7,
403
 
                                         RepositoryFormatKnit1)), \
404
 
            ("fileids_altered_by_revision_ids only supported for branches " 
405
 
             "which store inventory as unnested xml, not on %r" % self)
406
 
        selected_revision_ids = set(revision_ids)
407
 
        w = self.get_inventory_weave()
 
1968
        self.add_signature_text(revision_id, signature)
 
1969
 
 
1970
    @needs_write_lock
 
1971
    def add_signature_text(self, revision_id, signature):
 
1972
        self.signatures.add_lines((revision_id,), (),
 
1973
            osutils.split_lines(signature))
 
1974
 
 
1975
    def find_text_key_references(self):
 
1976
        """Find the text key references within the repository.
 
1977
 
 
1978
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
1979
            to whether they were referred to by the inventory of the
 
1980
            revision_id that they contain. The inventory texts from all present
 
1981
            revision ids are assessed to generate this report.
 
1982
        """
 
1983
        revision_keys = self.revisions.keys()
 
1984
        w = self.inventories
 
1985
        pb = ui.ui_factory.nested_progress_bar()
 
1986
        try:
 
1987
            return self._find_text_key_references_from_xml_inventory_lines(
 
1988
                w.iter_lines_added_or_present_in_keys(revision_keys, pb=pb))
 
1989
        finally:
 
1990
            pb.finished()
 
1991
 
 
1992
    def _find_text_key_references_from_xml_inventory_lines(self,
 
1993
        line_iterator):
 
1994
        """Core routine for extracting references to texts from inventories.
 
1995
 
 
1996
        This performs the translation of xml lines to revision ids.
 
1997
 
 
1998
        :param line_iterator: An iterator of lines, origin_version_id
 
1999
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
2000
            to whether they were referred to by the inventory of the
 
2001
            revision_id that they contain. Note that if that revision_id was
 
2002
            not part of the line_iterator's output then False will be given -
 
2003
            even though it may actually refer to that key.
 
2004
        """
 
2005
        if not self._serializer.support_altered_by_hack:
 
2006
            raise AssertionError(
 
2007
                "_find_text_key_references_from_xml_inventory_lines only "
 
2008
                "supported for branches which store inventory as unnested xml"
 
2009
                ", not on %r" % self)
408
2010
        result = {}
409
2011
 
410
2012
        # this code needs to read every new line in every inventory for the
411
2013
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
412
 
        # not present in one of those inventories is unnecessary but not 
 
2014
        # not present in one of those inventories is unnecessary but not
413
2015
        # harmful because we are filtering by the revision id marker in the
414
 
        # inventory lines : we only select file ids altered in one of those  
 
2016
        # inventory lines : we only select file ids altered in one of those
415
2017
        # revisions. We don't need to see all lines in the inventory because
416
2018
        # only those added in an inventory in rev X can contain a revision=X
417
2019
        # line.
418
 
        for line in w.iter_lines_added_or_present_in_versions(selected_revision_ids):
419
 
            start = line.find('file_id="')+9
420
 
            if start < 9: continue
421
 
            end = line.find('"', start)
422
 
            assert end>= 0
423
 
            file_id = _unescape_xml(line[start:end])
424
 
 
425
 
            start = line.find('revision="')+10
426
 
            if start < 10: continue
427
 
            end = line.find('"', start)
428
 
            assert end>= 0
429
 
            revision_id = _unescape_xml(line[start:end])
430
 
            if revision_id in selected_revision_ids:
431
 
                result.setdefault(file_id, set()).add(revision_id)
432
 
        return result
433
 
 
434
 
    @needs_read_lock
435
 
    def get_inventory_weave(self):
436
 
        return self.control_weaves.get_weave('inventory',
437
 
            self.get_transaction())
 
2020
        unescape_revid_cache = {}
 
2021
        unescape_fileid_cache = {}
 
2022
 
 
2023
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
2024
        # of lines, so it has had a lot of inlining and optimizing done.
 
2025
        # Sorry that it is a little bit messy.
 
2026
        # Move several functions to be local variables, since this is a long
 
2027
        # running loop.
 
2028
        search = self._file_ids_altered_regex.search
 
2029
        unescape = _unescape_xml
 
2030
        setdefault = result.setdefault
 
2031
        for line, line_key in line_iterator:
 
2032
            match = search(line)
 
2033
            if match is None:
 
2034
                continue
 
2035
            # One call to match.group() returning multiple items is quite a
 
2036
            # bit faster than 2 calls to match.group() each returning 1
 
2037
            file_id, revision_id = match.group('file_id', 'revision_id')
 
2038
 
 
2039
            # Inlining the cache lookups helps a lot when you make 170,000
 
2040
            # lines and 350k ids, versus 8.4 unique ids.
 
2041
            # Using a cache helps in 2 ways:
 
2042
            #   1) Avoids unnecessary decoding calls
 
2043
            #   2) Re-uses cached strings, which helps in future set and
 
2044
            #      equality checks.
 
2045
            # (2) is enough that removing encoding entirely along with
 
2046
            # the cache (so we are using plain strings) results in no
 
2047
            # performance improvement.
 
2048
            try:
 
2049
                revision_id = unescape_revid_cache[revision_id]
 
2050
            except KeyError:
 
2051
                unescaped = unescape(revision_id)
 
2052
                unescape_revid_cache[revision_id] = unescaped
 
2053
                revision_id = unescaped
 
2054
 
 
2055
            # Note that unconditionally unescaping means that we deserialise
 
2056
            # every fileid, which for general 'pull' is not great, but we don't
 
2057
            # really want to have some many fulltexts that this matters anyway.
 
2058
            # RBC 20071114.
 
2059
            try:
 
2060
                file_id = unescape_fileid_cache[file_id]
 
2061
            except KeyError:
 
2062
                unescaped = unescape(file_id)
 
2063
                unescape_fileid_cache[file_id] = unescaped
 
2064
                file_id = unescaped
 
2065
 
 
2066
            key = (file_id, revision_id)
 
2067
            setdefault(key, False)
 
2068
            if revision_id == line_key[-1]:
 
2069
                result[key] = True
 
2070
        return result
 
2071
 
 
2072
    def _inventory_xml_lines_for_keys(self, keys):
 
2073
        """Get a line iterator of the sort needed for findind references.
 
2074
 
 
2075
        Not relevant for non-xml inventory repositories.
 
2076
 
 
2077
        Ghosts in revision_keys are ignored.
 
2078
 
 
2079
        :param revision_keys: The revision keys for the inventories to inspect.
 
2080
        :return: An iterator over (inventory line, revid) for the fulltexts of
 
2081
            all of the xml inventories specified by revision_keys.
 
2082
        """
 
2083
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2084
        for record in stream:
 
2085
            if record.storage_kind != 'absent':
 
2086
                chunks = record.get_bytes_as('chunked')
 
2087
                revid = record.key[-1]
 
2088
                lines = osutils.chunks_to_lines(chunks)
 
2089
                for line in lines:
 
2090
                    yield line, revid
 
2091
 
 
2092
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
 
2093
        revision_keys):
 
2094
        """Helper routine for fileids_altered_by_revision_ids.
 
2095
 
 
2096
        This performs the translation of xml lines to revision ids.
 
2097
 
 
2098
        :param line_iterator: An iterator of lines, origin_version_id
 
2099
        :param revision_keys: The revision ids to filter for. This should be a
 
2100
            set or other type which supports efficient __contains__ lookups, as
 
2101
            the revision key from each parsed line will be looked up in the
 
2102
            revision_keys filter.
 
2103
        :return: a dictionary mapping altered file-ids to an iterable of
 
2104
        revision_ids. Each altered file-ids has the exact revision_ids that
 
2105
        altered it listed explicitly.
 
2106
        """
 
2107
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2108
                line_iterator).iterkeys())
 
2109
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
2110
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
 
2111
            self._inventory_xml_lines_for_keys(parent_keys)))
 
2112
        new_keys = seen - parent_seen
 
2113
        result = {}
 
2114
        setdefault = result.setdefault
 
2115
        for key in new_keys:
 
2116
            setdefault(key[0], set()).add(key[-1])
 
2117
        return result
 
2118
 
 
2119
    def _find_parent_ids_of_revisions(self, revision_ids):
 
2120
        """Find all parent ids that are mentioned in the revision graph.
 
2121
 
 
2122
        :return: set of revisions that are parents of revision_ids which are
 
2123
            not part of revision_ids themselves
 
2124
        """
 
2125
        parent_map = self.get_parent_map(revision_ids)
 
2126
        parent_ids = set()
 
2127
        map(parent_ids.update, parent_map.itervalues())
 
2128
        parent_ids.difference_update(revision_ids)
 
2129
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
2130
        return parent_ids
 
2131
 
 
2132
    def _find_parent_keys_of_revisions(self, revision_keys):
 
2133
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
2134
 
 
2135
        :param revision_keys: An iterable of revision_keys.
 
2136
        :return: The parents of all revision_keys that are not already in
 
2137
            revision_keys
 
2138
        """
 
2139
        parent_map = self.revisions.get_parent_map(revision_keys)
 
2140
        parent_keys = set()
 
2141
        map(parent_keys.update, parent_map.itervalues())
 
2142
        parent_keys.difference_update(revision_keys)
 
2143
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
2144
        return parent_keys
 
2145
 
 
2146
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
 
2147
        """Find the file ids and versions affected by revisions.
 
2148
 
 
2149
        :param revisions: an iterable containing revision ids.
 
2150
        :param _inv_weave: The inventory weave from this repository or None.
 
2151
            If None, the inventory weave will be opened automatically.
 
2152
        :return: a dictionary mapping altered file-ids to an iterable of
 
2153
        revision_ids. Each altered file-ids has the exact revision_ids that
 
2154
        altered it listed explicitly.
 
2155
        """
 
2156
        selected_keys = set((revid,) for revid in revision_ids)
 
2157
        w = _inv_weave or self.inventories
 
2158
        pb = ui.ui_factory.nested_progress_bar()
 
2159
        try:
 
2160
            return self._find_file_ids_from_xml_inventory_lines(
 
2161
                w.iter_lines_added_or_present_in_keys(
 
2162
                    selected_keys, pb=pb),
 
2163
                selected_keys)
 
2164
        finally:
 
2165
            pb.finished()
 
2166
 
 
2167
    def iter_files_bytes(self, desired_files):
 
2168
        """Iterate through file versions.
 
2169
 
 
2170
        Files will not necessarily be returned in the order they occur in
 
2171
        desired_files.  No specific order is guaranteed.
 
2172
 
 
2173
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
2174
        value supplied by the caller as part of desired_files.  It should
 
2175
        uniquely identify the file version in the caller's context.  (Examples:
 
2176
        an index number or a TreeTransform trans_id.)
 
2177
 
 
2178
        bytes_iterator is an iterable of bytestrings for the file.  The
 
2179
        kind of iterable and length of the bytestrings are unspecified, but for
 
2180
        this implementation, it is a list of bytes produced by
 
2181
        VersionedFile.get_record_stream().
 
2182
 
 
2183
        :param desired_files: a list of (file_id, revision_id, identifier)
 
2184
            triples
 
2185
        """
 
2186
        text_keys = {}
 
2187
        for file_id, revision_id, callable_data in desired_files:
 
2188
            text_keys[(file_id, revision_id)] = callable_data
 
2189
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
 
2190
            if record.storage_kind == 'absent':
 
2191
                raise errors.RevisionNotPresent(record.key, self)
 
2192
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
2193
 
 
2194
    def _generate_text_key_index(self, text_key_references=None,
 
2195
        ancestors=None):
 
2196
        """Generate a new text key index for the repository.
 
2197
 
 
2198
        This is an expensive function that will take considerable time to run.
 
2199
 
 
2200
        :return: A dict mapping text keys ((file_id, revision_id) tuples) to a
 
2201
            list of parents, also text keys. When a given key has no parents,
 
2202
            the parents list will be [NULL_REVISION].
 
2203
        """
 
2204
        # All revisions, to find inventory parents.
 
2205
        if ancestors is None:
 
2206
            graph = self.get_graph()
 
2207
            ancestors = graph.get_parent_map(self.all_revision_ids())
 
2208
        if text_key_references is None:
 
2209
            text_key_references = self.find_text_key_references()
 
2210
        pb = ui.ui_factory.nested_progress_bar()
 
2211
        try:
 
2212
            return self._do_generate_text_key_index(ancestors,
 
2213
                text_key_references, pb)
 
2214
        finally:
 
2215
            pb.finished()
 
2216
 
 
2217
    def _do_generate_text_key_index(self, ancestors, text_key_references, pb):
 
2218
        """Helper for _generate_text_key_index to avoid deep nesting."""
 
2219
        revision_order = tsort.topo_sort(ancestors)
 
2220
        invalid_keys = set()
 
2221
        revision_keys = {}
 
2222
        for revision_id in revision_order:
 
2223
            revision_keys[revision_id] = set()
 
2224
        text_count = len(text_key_references)
 
2225
        # a cache of the text keys to allow reuse; costs a dict of all the
 
2226
        # keys, but saves a 2-tuple for every child of a given key.
 
2227
        text_key_cache = {}
 
2228
        for text_key, valid in text_key_references.iteritems():
 
2229
            if not valid:
 
2230
                invalid_keys.add(text_key)
 
2231
            else:
 
2232
                revision_keys[text_key[1]].add(text_key)
 
2233
            text_key_cache[text_key] = text_key
 
2234
        del text_key_references
 
2235
        text_index = {}
 
2236
        text_graph = graph.Graph(graph.DictParentsProvider(text_index))
 
2237
        NULL_REVISION = _mod_revision.NULL_REVISION
 
2238
        # Set a cache with a size of 10 - this suffices for bzr.dev but may be
 
2239
        # too small for large or very branchy trees. However, for 55K path
 
2240
        # trees, it would be easy to use too much memory trivially. Ideally we
 
2241
        # could gauge this by looking at available real memory etc, but this is
 
2242
        # always a tricky proposition.
 
2243
        inventory_cache = lru_cache.LRUCache(10)
 
2244
        batch_size = 10 # should be ~150MB on a 55K path tree
 
2245
        batch_count = len(revision_order) / batch_size + 1
 
2246
        processed_texts = 0
 
2247
        pb.update("Calculating text parents", processed_texts, text_count)
 
2248
        for offset in xrange(batch_count):
 
2249
            to_query = revision_order[offset * batch_size:(offset + 1) *
 
2250
                batch_size]
 
2251
            if not to_query:
 
2252
                break
 
2253
            for revision_id in to_query:
 
2254
                parent_ids = ancestors[revision_id]
 
2255
                for text_key in revision_keys[revision_id]:
 
2256
                    pb.update("Calculating text parents", processed_texts)
 
2257
                    processed_texts += 1
 
2258
                    candidate_parents = []
 
2259
                    for parent_id in parent_ids:
 
2260
                        parent_text_key = (text_key[0], parent_id)
 
2261
                        try:
 
2262
                            check_parent = parent_text_key not in \
 
2263
                                revision_keys[parent_id]
 
2264
                        except KeyError:
 
2265
                            # the parent parent_id is a ghost:
 
2266
                            check_parent = False
 
2267
                            # truncate the derived graph against this ghost.
 
2268
                            parent_text_key = None
 
2269
                        if check_parent:
 
2270
                            # look at the parent commit details inventories to
 
2271
                            # determine possible candidates in the per file graph.
 
2272
                            # TODO: cache here.
 
2273
                            try:
 
2274
                                inv = inventory_cache[parent_id]
 
2275
                            except KeyError:
 
2276
                                inv = self.revision_tree(parent_id).inventory
 
2277
                                inventory_cache[parent_id] = inv
 
2278
                            try:
 
2279
                                parent_entry = inv[text_key[0]]
 
2280
                            except (KeyError, errors.NoSuchId):
 
2281
                                parent_entry = None
 
2282
                            if parent_entry is not None:
 
2283
                                parent_text_key = (
 
2284
                                    text_key[0], parent_entry.revision)
 
2285
                            else:
 
2286
                                parent_text_key = None
 
2287
                        if parent_text_key is not None:
 
2288
                            candidate_parents.append(
 
2289
                                text_key_cache[parent_text_key])
 
2290
                    parent_heads = text_graph.heads(candidate_parents)
 
2291
                    new_parents = list(parent_heads)
 
2292
                    new_parents.sort(key=lambda x:candidate_parents.index(x))
 
2293
                    if new_parents == []:
 
2294
                        new_parents = [NULL_REVISION]
 
2295
                    text_index[text_key] = new_parents
 
2296
 
 
2297
        for text_key in invalid_keys:
 
2298
            text_index[text_key] = [NULL_REVISION]
 
2299
        return text_index
 
2300
 
 
2301
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
2302
        """Get an iterable listing the keys of all the data introduced by a set
 
2303
        of revision IDs.
 
2304
 
 
2305
        The keys will be ordered so that the corresponding items can be safely
 
2306
        fetched and inserted in that order.
 
2307
 
 
2308
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
2309
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
2310
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
2311
        """
 
2312
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
 
2313
            yield result
 
2314
        del _files_pb
 
2315
        for result in self._find_non_file_keys_to_fetch(revision_ids):
 
2316
            yield result
 
2317
 
 
2318
    def _find_file_keys_to_fetch(self, revision_ids, pb):
 
2319
        # XXX: it's a bit weird to control the inventory weave caching in this
 
2320
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
2321
        # maybe this generator should explicitly have the contract that it
 
2322
        # should not be iterated until the previously yielded item has been
 
2323
        # processed?
 
2324
        inv_w = self.inventories
 
2325
 
 
2326
        # file ids that changed
 
2327
        file_ids = self.fileids_altered_by_revision_ids(revision_ids, inv_w)
 
2328
        count = 0
 
2329
        num_file_ids = len(file_ids)
 
2330
        for file_id, altered_versions in file_ids.iteritems():
 
2331
            if pb is not None:
 
2332
                pb.update("Fetch texts", count, num_file_ids)
 
2333
            count += 1
 
2334
            yield ("file", file_id, altered_versions)
 
2335
 
 
2336
    def _find_non_file_keys_to_fetch(self, revision_ids):
 
2337
        # inventory
 
2338
        yield ("inventory", None, revision_ids)
 
2339
 
 
2340
        # signatures
 
2341
        # XXX: Note ATM no callers actually pay attention to this return
 
2342
        #      instead they just use the list of revision ids and ignore
 
2343
        #      missing sigs. Consider removing this work entirely
 
2344
        revisions_with_signatures = set(self.signatures.get_parent_map(
 
2345
            [(r,) for r in revision_ids]))
 
2346
        revisions_with_signatures = set(
 
2347
            [r for (r,) in revisions_with_signatures])
 
2348
        revisions_with_signatures.intersection_update(revision_ids)
 
2349
        yield ("signatures", None, revisions_with_signatures)
 
2350
 
 
2351
        # revisions
 
2352
        yield ("revisions", None, revision_ids)
438
2353
 
439
2354
    @needs_read_lock
440
2355
    def get_inventory(self, revision_id):
441
 
        """Get Inventory object by hash."""
442
 
        return self.deserialise_inventory(
443
 
            revision_id, self.get_inventory_xml(revision_id))
 
2356
        """Get Inventory object by revision id."""
 
2357
        return self.iter_inventories([revision_id]).next()
 
2358
 
 
2359
    def iter_inventories(self, revision_ids, ordering=None):
 
2360
        """Get many inventories by revision_ids.
 
2361
 
 
2362
        This will buffer some or all of the texts used in constructing the
 
2363
        inventories in memory, but will only parse a single inventory at a
 
2364
        time.
 
2365
 
 
2366
        :param revision_ids: The expected revision ids of the inventories.
 
2367
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2368
            specified, the order of revision_ids will be preserved (by
 
2369
            buffering if necessary).
 
2370
        :return: An iterator of inventories.
 
2371
        """
 
2372
        if ((None in revision_ids)
 
2373
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
2374
            raise ValueError('cannot get null revision inventory')
 
2375
        return self._iter_inventories(revision_ids, ordering)
 
2376
 
 
2377
    def _iter_inventories(self, revision_ids, ordering):
 
2378
        """single-document based inventory iteration."""
 
2379
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2380
        for text, revision_id in inv_xmls:
 
2381
            yield self.deserialise_inventory(revision_id, text)
 
2382
 
 
2383
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2384
        if ordering is None:
 
2385
            order_as_requested = True
 
2386
            ordering = 'unordered'
 
2387
        else:
 
2388
            order_as_requested = False
 
2389
        keys = [(revision_id,) for revision_id in revision_ids]
 
2390
        if not keys:
 
2391
            return
 
2392
        if order_as_requested:
 
2393
            key_iter = iter(keys)
 
2394
            next_key = key_iter.next()
 
2395
        stream = self.inventories.get_record_stream(keys, ordering, True)
 
2396
        text_chunks = {}
 
2397
        for record in stream:
 
2398
            if record.storage_kind != 'absent':
 
2399
                chunks = record.get_bytes_as('chunked')
 
2400
                if order_as_requested:
 
2401
                    text_chunks[record.key] = chunks
 
2402
                else:
 
2403
                    yield ''.join(chunks), record.key[-1]
 
2404
            else:
 
2405
                raise errors.NoSuchRevision(self, record.key)
 
2406
            if order_as_requested:
 
2407
                # Yield as many results as we can while preserving order.
 
2408
                while next_key in text_chunks:
 
2409
                    chunks = text_chunks.pop(next_key)
 
2410
                    yield ''.join(chunks), next_key[-1]
 
2411
                    try:
 
2412
                        next_key = key_iter.next()
 
2413
                    except StopIteration:
 
2414
                        # We still want to fully consume the get_record_stream,
 
2415
                        # just in case it is not actually finished at this point
 
2416
                        next_key = None
 
2417
                        break
444
2418
 
445
2419
    def deserialise_inventory(self, revision_id, xml):
446
 
        """Transform the xml into an inventory object. 
 
2420
        """Transform the xml into an inventory object.
447
2421
 
448
2422
        :param revision_id: The expected revision id of the inventory.
449
2423
        :param xml: A serialised inventory.
450
2424
        """
451
 
        return xml5.serializer_v5.read_inventory_from_string(xml)
 
2425
        result = self._serializer.read_inventory_from_string(xml, revision_id,
 
2426
                    entry_cache=self._inventory_entry_cache)
 
2427
        if result.revision_id != revision_id:
 
2428
            raise AssertionError('revision id mismatch %s != %s' % (
 
2429
                result.revision_id, revision_id))
 
2430
        return result
 
2431
 
 
2432
    def serialise_inventory(self, inv):
 
2433
        return self._serializer.write_inventory_to_string(inv)
 
2434
 
 
2435
    def _serialise_inventory_to_lines(self, inv):
 
2436
        return self._serializer.write_inventory_to_lines(inv)
 
2437
 
 
2438
    def get_serializer_format(self):
 
2439
        return self._serializer.format_num
452
2440
 
453
2441
    @needs_read_lock
454
2442
    def get_inventory_xml(self, revision_id):
455
2443
        """Get inventory XML as a file object."""
 
2444
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
456
2445
        try:
457
 
            assert isinstance(revision_id, basestring), type(revision_id)
458
 
            iw = self.get_inventory_weave()
459
 
            return iw.get_text(revision_id)
460
 
        except IndexError:
 
2446
            text, revision_id = texts.next()
 
2447
        except StopIteration:
461
2448
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
2449
        return text
462
2450
 
463
2451
    @needs_read_lock
464
2452
    def get_inventory_sha1(self, revision_id):
466
2454
        """
467
2455
        return self.get_revision(revision_id).inventory_sha1
468
2456
 
469
 
    @needs_read_lock
470
 
    def get_revision_graph(self, revision_id=None):
471
 
        """Return a dictionary containing the revision graph.
472
 
        
473
 
        :param revision_id: The revision_id to get a graph from. If None, then
474
 
        the entire revision graph is returned. This is a deprecated mode of
475
 
        operation and will be removed in the future.
476
 
        :return: a dictionary of revision_id->revision_parents_list.
477
 
        """
478
 
        # special case NULL_REVISION
479
 
        if revision_id == NULL_REVISION:
480
 
            return {}
481
 
        weave = self.get_inventory_weave()
482
 
        all_revisions = self._eliminate_revisions_not_present(weave.versions())
483
 
        entire_graph = dict([(node, weave.get_parents(node)) for 
484
 
                             node in all_revisions])
485
 
        if revision_id is None:
486
 
            return entire_graph
487
 
        elif revision_id not in entire_graph:
488
 
            raise errors.NoSuchRevision(self, revision_id)
489
 
        else:
490
 
            # add what can be reached from revision_id
491
 
            result = {}
492
 
            pending = set([revision_id])
493
 
            while len(pending) > 0:
494
 
                node = pending.pop()
495
 
                result[node] = entire_graph[node]
496
 
                for revision_id in result[node]:
497
 
                    if revision_id not in result:
498
 
                        pending.add(revision_id)
499
 
            return result
500
 
 
501
 
    @needs_read_lock
502
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
503
 
        """Return a graph of the revisions with ghosts marked as applicable.
504
 
 
505
 
        :param revision_ids: an iterable of revisions to graph or None for all.
506
 
        :return: a Graph object with the graph reachable from revision_ids.
507
 
        """
508
 
        result = Graph()
509
 
        if not revision_ids:
510
 
            pending = set(self.all_revision_ids())
511
 
            required = set([])
512
 
        else:
513
 
            pending = set(revision_ids)
514
 
            # special case NULL_REVISION
515
 
            if NULL_REVISION in pending:
516
 
                pending.remove(NULL_REVISION)
517
 
            required = set(pending)
518
 
        done = set([])
519
 
        while len(pending):
520
 
            revision_id = pending.pop()
 
2457
    def get_rev_id_for_revno(self, revno, known_pair):
 
2458
        """Return the revision id of a revno, given a later (revno, revid)
 
2459
        pair in the same history.
 
2460
 
 
2461
        :return: if found (True, revid).  If the available history ran out
 
2462
            before reaching the revno, then this returns
 
2463
            (False, (closest_revno, closest_revid)).
 
2464
        """
 
2465
        known_revno, known_revid = known_pair
 
2466
        partial_history = [known_revid]
 
2467
        distance_from_known = known_revno - revno
 
2468
        if distance_from_known < 0:
 
2469
            raise ValueError(
 
2470
                'requested revno (%d) is later than given known revno (%d)'
 
2471
                % (revno, known_revno))
 
2472
        try:
 
2473
            _iter_for_revno(
 
2474
                self, partial_history, stop_index=distance_from_known)
 
2475
        except errors.RevisionNotPresent, err:
 
2476
            if err.revision_id == known_revid:
 
2477
                # The start revision (known_revid) wasn't found.
 
2478
                raise
 
2479
            # This is a stacked repository with no fallbacks, or a there's a
 
2480
            # left-hand ghost.  Either way, even though the revision named in
 
2481
            # the error isn't in this repo, we know it's the next step in this
 
2482
            # left-hand history.
 
2483
            partial_history.append(err.revision_id)
 
2484
        if len(partial_history) <= distance_from_known:
 
2485
            # Didn't find enough history to get a revid for the revno.
 
2486
            earliest_revno = known_revno - len(partial_history) + 1
 
2487
            return (False, (earliest_revno, partial_history[-1]))
 
2488
        if len(partial_history) - 1 > distance_from_known:
 
2489
            raise AssertionError('_iter_for_revno returned too much history')
 
2490
        return (True, partial_history[-1])
 
2491
 
 
2492
    def iter_reverse_revision_history(self, revision_id):
 
2493
        """Iterate backwards through revision ids in the lefthand history
 
2494
 
 
2495
        :param revision_id: The revision id to start with.  All its lefthand
 
2496
            ancestors will be traversed.
 
2497
        """
 
2498
        graph = self.get_graph()
 
2499
        next_id = revision_id
 
2500
        while True:
 
2501
            if next_id in (None, _mod_revision.NULL_REVISION):
 
2502
                return
521
2503
            try:
522
 
                rev = self.get_revision(revision_id)
523
 
            except errors.NoSuchRevision:
524
 
                if revision_id in required:
525
 
                    raise
526
 
                # a ghost
527
 
                result.add_ghost(revision_id)
528
 
                continue
529
 
            for parent_id in rev.parent_ids:
530
 
                # is this queued or done ?
531
 
                if (parent_id not in pending and
532
 
                    parent_id not in done):
533
 
                    # no, queue it.
534
 
                    pending.add(parent_id)
535
 
            result.add_node(revision_id, rev.parent_ids)
536
 
            done.add(revision_id)
537
 
        return result
 
2504
                parents = graph.get_parent_map([next_id])[next_id]
 
2505
            except KeyError:
 
2506
                raise errors.RevisionNotPresent(next_id, self)
 
2507
            yield next_id
 
2508
            if len(parents) == 0:
 
2509
                return
 
2510
            else:
 
2511
                next_id = parents[0]
538
2512
 
539
2513
    @needs_read_lock
540
2514
    def get_revision_inventory(self, revision_id):
552
2526
        else:
553
2527
            return self.get_inventory(revision_id)
554
2528
 
555
 
    @needs_read_lock
556
2529
    def is_shared(self):
557
2530
        """Return True if this repository is flagged as a shared repository."""
558
2531
        raise NotImplementedError(self.is_shared)
564
2537
        reconciler = RepoReconciler(self, thorough=thorough)
565
2538
        reconciler.reconcile()
566
2539
        return reconciler
567
 
    
 
2540
 
 
2541
    def _refresh_data(self):
 
2542
        """Helper called from lock_* to ensure coherency with disk.
 
2543
 
 
2544
        The default implementation does nothing; it is however possible
 
2545
        for repositories to maintain loaded indices across multiple locks
 
2546
        by checking inside their implementation of this method to see
 
2547
        whether their indices are still valid. This depends of course on
 
2548
        the disk format being validatable in this manner. This method is
 
2549
        also called by the refresh_data() public interface to cause a refresh
 
2550
        to occur while in a write lock so that data inserted by a smart server
 
2551
        push operation is visible on the client's instance of the physical
 
2552
        repository.
 
2553
        """
 
2554
 
568
2555
    @needs_read_lock
569
2556
    def revision_tree(self, revision_id):
570
2557
        """Return Tree for a revision on this branch.
571
2558
 
572
 
        `revision_id` may be None for the empty tree revision.
 
2559
        `revision_id` may be NULL_REVISION for the empty tree revision.
573
2560
        """
 
2561
        revision_id = _mod_revision.ensure_null(revision_id)
574
2562
        # TODO: refactor this to use an existing revision object
575
2563
        # so we don't need to read it in twice.
576
 
        if revision_id is None or revision_id == NULL_REVISION:
577
 
            return RevisionTree(self, Inventory(), NULL_REVISION)
 
2564
        if revision_id == _mod_revision.NULL_REVISION:
 
2565
            return RevisionTree(self, Inventory(root_id=None),
 
2566
                                _mod_revision.NULL_REVISION)
578
2567
        else:
579
2568
            inv = self.get_revision_inventory(revision_id)
580
2569
            return RevisionTree(self, inv, revision_id)
581
2570
 
582
 
    @needs_read_lock
583
2571
    def revision_trees(self, revision_ids):
584
 
        """Return Tree for a revision on this branch.
585
 
 
586
 
        `revision_id` may not be None or 'null:'"""
587
 
        assert None not in revision_ids
588
 
        assert NULL_REVISION not in revision_ids
589
 
        texts = self.get_inventory_weave().get_texts(revision_ids)
590
 
        for text, revision_id in zip(texts, revision_ids):
591
 
            inv = self.deserialise_inventory(revision_id, text)
592
 
            yield RevisionTree(self, inv, revision_id)
 
2572
        """Return Trees for revisions in this repository.
 
2573
 
 
2574
        :param revision_ids: a sequence of revision-ids;
 
2575
          a revision-id may not be None or 'null:'
 
2576
        """
 
2577
        inventories = self.iter_inventories(revision_ids)
 
2578
        for inv in inventories:
 
2579
            yield RevisionTree(self, inv, inv.revision_id)
 
2580
 
 
2581
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2582
        """Return Tree for a revision on this branch with only some files.
 
2583
 
 
2584
        :param revision_ids: a sequence of revision-ids;
 
2585
          a revision-id may not be None or 'null:'
 
2586
        :param file_ids: if not None, the result is filtered
 
2587
          so that only those file-ids, their parents and their
 
2588
          children are included.
 
2589
        """
 
2590
        inventories = self.iter_inventories(revision_ids)
 
2591
        for inv in inventories:
 
2592
            # Should we introduce a FilteredRevisionTree class rather
 
2593
            # than pre-filter the inventory here?
 
2594
            filtered_inv = inv.filter(file_ids)
 
2595
            yield RevisionTree(self, filtered_inv, filtered_inv.revision_id)
593
2596
 
594
2597
    @needs_read_lock
595
 
    def get_ancestry(self, revision_id):
 
2598
    def get_ancestry(self, revision_id, topo_sorted=True):
596
2599
        """Return a list of revision-ids integrated by a revision.
597
2600
 
598
 
        The first element of the list is always None, indicating the origin 
599
 
        revision.  This might change when we have history horizons, or 
 
2601
        The first element of the list is always None, indicating the origin
 
2602
        revision.  This might change when we have history horizons, or
600
2603
        perhaps we should have a new API.
601
 
        
 
2604
 
602
2605
        This is topologically sorted.
603
2606
        """
604
 
        if revision_id is None:
 
2607
        if _mod_revision.is_null(revision_id):
605
2608
            return [None]
606
2609
        if not self.has_revision(revision_id):
607
2610
            raise errors.NoSuchRevision(self, revision_id)
608
 
        w = self.get_inventory_weave()
609
 
        candidates = w.get_ancestry(revision_id)
610
 
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
611
 
 
612
 
    @needs_read_lock
613
 
    def print_file(self, file, revision_id):
614
 
        """Print `file` to stdout.
615
 
        
616
 
        FIXME RBC 20060125 as John Meinel points out this is a bad api
617
 
        - it writes to stdout, it assumes that that is valid etc. Fix
618
 
        by creating a new more flexible convenience function.
 
2611
        graph = self.get_graph()
 
2612
        keys = set()
 
2613
        search = graph._make_breadth_first_searcher([revision_id])
 
2614
        while True:
 
2615
            try:
 
2616
                found, ghosts = search.next_with_ghosts()
 
2617
            except StopIteration:
 
2618
                break
 
2619
            keys.update(found)
 
2620
        if _mod_revision.NULL_REVISION in keys:
 
2621
            keys.remove(_mod_revision.NULL_REVISION)
 
2622
        if topo_sorted:
 
2623
            parent_map = graph.get_parent_map(keys)
 
2624
            keys = tsort.topo_sort(parent_map)
 
2625
        return [None] + list(keys)
 
2626
 
 
2627
    def pack(self, hint=None):
 
2628
        """Compress the data within the repository.
 
2629
 
 
2630
        This operation only makes sense for some repository types. For other
 
2631
        types it should be a no-op that just returns.
 
2632
 
 
2633
        This stub method does not require a lock, but subclasses should use
 
2634
        @needs_write_lock as this is a long running call its reasonable to
 
2635
        implicitly lock for the user.
 
2636
 
 
2637
        :param hint: If not supplied, the whole repository is packed.
 
2638
            If supplied, the repository may use the hint parameter as a
 
2639
            hint for the parts of the repository to pack. A hint can be
 
2640
            obtained from the result of commit_write_group(). Out of
 
2641
            date hints are simply ignored, because concurrent operations
 
2642
            can obsolete them rapidly.
619
2643
        """
620
 
        tree = self.revision_tree(revision_id)
621
 
        # use inventory as it was in that revision
622
 
        file_id = tree.inventory.path2id(file)
623
 
        if not file_id:
624
 
            # TODO: jam 20060427 Write a test for this code path
625
 
            #       it had a bug in it, and was raising the wrong
626
 
            #       exception.
627
 
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
628
 
        tree.print_file(file_id)
629
2644
 
630
2645
    def get_transaction(self):
631
2646
        return self.control_files.get_transaction()
632
2647
 
633
 
    def revision_parents(self, revid):
634
 
        return self.get_inventory_weave().parent_names(revid)
 
2648
    def get_parent_map(self, revision_ids):
 
2649
        """See graph.StackedParentsProvider.get_parent_map"""
 
2650
        # revisions index works in keys; this just works in revisions
 
2651
        # therefore wrap and unwrap
 
2652
        query_keys = []
 
2653
        result = {}
 
2654
        for revision_id in revision_ids:
 
2655
            if revision_id == _mod_revision.NULL_REVISION:
 
2656
                result[revision_id] = ()
 
2657
            elif revision_id is None:
 
2658
                raise ValueError('get_parent_map(None) is not valid')
 
2659
            else:
 
2660
                query_keys.append((revision_id ,))
 
2661
        for ((revision_id,), parent_keys) in \
 
2662
                self.revisions.get_parent_map(query_keys).iteritems():
 
2663
            if parent_keys:
 
2664
                result[revision_id] = tuple(parent_revid
 
2665
                    for (parent_revid,) in parent_keys)
 
2666
            else:
 
2667
                result[revision_id] = (_mod_revision.NULL_REVISION,)
 
2668
        return result
 
2669
 
 
2670
    def _make_parents_provider(self):
 
2671
        return self
 
2672
 
 
2673
    def get_graph(self, other_repository=None):
 
2674
        """Return the graph walker for this repository format"""
 
2675
        parents_provider = self._make_parents_provider()
 
2676
        if (other_repository is not None and
 
2677
            not self.has_same_location(other_repository)):
 
2678
            parents_provider = graph.StackedParentsProvider(
 
2679
                [parents_provider, other_repository._make_parents_provider()])
 
2680
        return graph.Graph(parents_provider)
 
2681
 
 
2682
    def _get_versioned_file_checker(self, text_key_references=None,
 
2683
        ancestors=None):
 
2684
        """Return an object suitable for checking versioned files.
 
2685
        
 
2686
        :param text_key_references: if non-None, an already built
 
2687
            dictionary mapping text keys ((fileid, revision_id) tuples)
 
2688
            to whether they were referred to by the inventory of the
 
2689
            revision_id that they contain. If None, this will be
 
2690
            calculated.
 
2691
        :param ancestors: Optional result from
 
2692
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2693
            available.
 
2694
        """
 
2695
        return _VersionedFileChecker(self,
 
2696
            text_key_references=text_key_references, ancestors=ancestors)
 
2697
 
 
2698
    def revision_ids_to_search_result(self, result_set):
 
2699
        """Convert a set of revision ids to a graph SearchResult."""
 
2700
        result_parents = set()
 
2701
        for parents in self.get_graph().get_parent_map(
 
2702
            result_set).itervalues():
 
2703
            result_parents.update(parents)
 
2704
        included_keys = result_set.intersection(result_parents)
 
2705
        start_keys = result_set.difference(included_keys)
 
2706
        exclude_keys = result_parents.difference(result_set)
 
2707
        result = graph.SearchResult(start_keys, exclude_keys,
 
2708
            len(result_set), result_set)
 
2709
        return result
635
2710
 
636
2711
    @needs_write_lock
637
2712
    def set_make_working_trees(self, new_value):
644
2719
                          working trees.
645
2720
        """
646
2721
        raise NotImplementedError(self.set_make_working_trees)
647
 
    
 
2722
 
648
2723
    def make_working_trees(self):
649
2724
        """Returns the policy for making working trees on new branches."""
650
2725
        raise NotImplementedError(self.make_working_trees)
657
2732
    @needs_read_lock
658
2733
    def has_signature_for_revision_id(self, revision_id):
659
2734
        """Query for a revision signature for revision_id in the repository."""
660
 
        return self._revision_store.has_signature(revision_id,
661
 
                                                  self.get_transaction())
 
2735
        if not self.has_revision(revision_id):
 
2736
            raise errors.NoSuchRevision(self, revision_id)
 
2737
        sig_present = (1 == len(
 
2738
            self.signatures.get_parent_map([(revision_id,)])))
 
2739
        return sig_present
662
2740
 
663
2741
    @needs_read_lock
664
2742
    def get_signature_text(self, revision_id):
665
2743
        """Return the text for a signature."""
666
 
        return self._revision_store.get_signature_text(revision_id,
667
 
                                                       self.get_transaction())
 
2744
        stream = self.signatures.get_record_stream([(revision_id,)],
 
2745
            'unordered', True)
 
2746
        record = stream.next()
 
2747
        if record.storage_kind == 'absent':
 
2748
            raise errors.NoSuchRevision(self, revision_id)
 
2749
        return record.get_bytes_as('fulltext')
668
2750
 
669
2751
    @needs_read_lock
670
 
    def check(self, revision_ids):
 
2752
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
671
2753
        """Check consistency of all history of given revision_ids.
672
2754
 
673
2755
        Different repository implementations should override _check().
674
2756
 
675
2757
        :param revision_ids: A non-empty list of revision_ids whose ancestry
676
2758
             will be checked.  Typically the last revision_id of a branch.
 
2759
        :param callback_refs: A dict of check-refs to resolve and callback
 
2760
            the check/_check method on the items listed as wanting the ref.
 
2761
            see bzrlib.check.
 
2762
        :param check_repo: If False do not check the repository contents, just 
 
2763
            calculate the data callback_refs requires and call them back.
677
2764
        """
678
 
        if not revision_ids:
679
 
            raise ValueError("revision_ids must be non-empty in %s.check" 
680
 
                    % (self,))
681
 
        return self._check(revision_ids)
 
2765
        return self._check(revision_ids, callback_refs=callback_refs,
 
2766
            check_repo=check_repo)
682
2767
 
683
 
    def _check(self, revision_ids):
684
 
        result = check.Check(self)
685
 
        result.check()
 
2768
    def _check(self, revision_ids, callback_refs, check_repo):
 
2769
        result = check.Check(self, check_repo=check_repo)
 
2770
        result.check(callback_refs)
686
2771
        return result
687
2772
 
688
2773
    def _warn_if_deprecated(self):
693
2778
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
694
2779
                % (self._format, self.bzrdir.transport.base))
695
2780
 
696
 
 
697
 
class AllInOneRepository(Repository):
698
 
    """Legacy support - the repository behaviour for all-in-one branches."""
699
 
 
700
 
    def __init__(self, _format, a_bzrdir, _revision_store, control_store, text_store):
701
 
        # we reuse one control files instance.
702
 
        dir_mode = a_bzrdir._control_files._dir_mode
703
 
        file_mode = a_bzrdir._control_files._file_mode
704
 
 
705
 
        def get_store(name, compressed=True, prefixed=False):
706
 
            # FIXME: This approach of assuming stores are all entirely compressed
707
 
            # or entirely uncompressed is tidy, but breaks upgrade from 
708
 
            # some existing branches where there's a mixture; we probably 
709
 
            # still want the option to look for both.
710
 
            relpath = a_bzrdir._control_files._escape(name)
711
 
            store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
712
 
                              prefixed=prefixed, compressed=compressed,
713
 
                              dir_mode=dir_mode,
714
 
                              file_mode=file_mode)
715
 
            #if self._transport.should_cache():
716
 
            #    cache_path = os.path.join(self.cache_root, name)
717
 
            #    os.mkdir(cache_path)
718
 
            #    store = bzrlib.store.CachedStore(store, cache_path)
719
 
            return store
720
 
 
721
 
        # not broken out yet because the controlweaves|inventory_store
722
 
        # and text_store | weave_store bits are still different.
723
 
        if isinstance(_format, RepositoryFormat4):
724
 
            # cannot remove these - there is still no consistent api 
725
 
            # which allows access to this old info.
726
 
            self.inventory_store = get_store('inventory-store')
727
 
            text_store = get_store('text-store')
728
 
        super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, _revision_store, control_store, text_store)
729
 
 
730
 
    @needs_read_lock
731
 
    def is_shared(self):
732
 
        """AllInOne repositories cannot be shared."""
733
 
        return False
734
 
 
735
 
    @needs_write_lock
736
 
    def set_make_working_trees(self, new_value):
737
 
        """Set the policy flag for making working trees when creating branches.
738
 
 
739
 
        This only applies to branches that use this repository.
740
 
 
741
 
        The default is 'True'.
742
 
        :param new_value: True to restore the default, False to disable making
743
 
                          working trees.
 
2781
    def supports_rich_root(self):
 
2782
        return self._format.rich_root_data
 
2783
 
 
2784
    def _check_ascii_revisionid(self, revision_id, method):
 
2785
        """Private helper for ascii-only repositories."""
 
2786
        # weave repositories refuse to store revisionids that are non-ascii.
 
2787
        if revision_id is not None:
 
2788
            # weaves require ascii revision ids.
 
2789
            if isinstance(revision_id, unicode):
 
2790
                try:
 
2791
                    revision_id.encode('ascii')
 
2792
                except UnicodeEncodeError:
 
2793
                    raise errors.NonAsciiRevisionId(method, self)
 
2794
            else:
 
2795
                try:
 
2796
                    revision_id.decode('ascii')
 
2797
                except UnicodeDecodeError:
 
2798
                    raise errors.NonAsciiRevisionId(method, self)
 
2799
 
 
2800
    def revision_graph_can_have_wrong_parents(self):
 
2801
        """Is it possible for this repository to have a revision graph with
 
2802
        incorrect parents?
 
2803
 
 
2804
        If True, then this repository must also implement
 
2805
        _find_inconsistent_revision_parents so that check and reconcile can
 
2806
        check for inconsistencies before proceeding with other checks that may
 
2807
        depend on the revision index being consistent.
744
2808
        """
745
 
        raise NotImplementedError(self.set_make_working_trees)
746
 
    
747
 
    def make_working_trees(self):
748
 
        """Returns the policy for making working trees on new branches."""
749
 
        return True
 
2809
        raise NotImplementedError(self.revision_graph_can_have_wrong_parents)
 
2810
 
 
2811
 
 
2812
# remove these delegates a while after bzr 0.15
 
2813
def __make_delegated(name, from_module):
 
2814
    def _deprecated_repository_forwarder():
 
2815
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
2816
            % (name, from_module),
 
2817
            DeprecationWarning,
 
2818
            stacklevel=2)
 
2819
        m = __import__(from_module, globals(), locals(), [name])
 
2820
        try:
 
2821
            return getattr(m, name)
 
2822
        except AttributeError:
 
2823
            raise AttributeError('module %s has no name %s'
 
2824
                    % (m, name))
 
2825
    globals()[name] = _deprecated_repository_forwarder
 
2826
 
 
2827
for _name in [
 
2828
        'AllInOneRepository',
 
2829
        'WeaveMetaDirRepository',
 
2830
        'PreSplitOutRepositoryFormat',
 
2831
        'RepositoryFormat4',
 
2832
        'RepositoryFormat5',
 
2833
        'RepositoryFormat6',
 
2834
        'RepositoryFormat7',
 
2835
        ]:
 
2836
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
2837
 
 
2838
for _name in [
 
2839
        'KnitRepository',
 
2840
        'RepositoryFormatKnit',
 
2841
        'RepositoryFormatKnit1',
 
2842
        ]:
 
2843
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
750
2844
 
751
2845
 
752
2846
def install_revision(repository, rev, revision_tree):
753
2847
    """Install all revision data into a repository."""
 
2848
    install_revisions(repository, [(rev, revision_tree, None)])
 
2849
 
 
2850
 
 
2851
def install_revisions(repository, iterable, num_revisions=None, pb=None):
 
2852
    """Install all revision data into a repository.
 
2853
 
 
2854
    Accepts an iterable of revision, tree, signature tuples.  The signature
 
2855
    may be None.
 
2856
    """
 
2857
    repository.start_write_group()
 
2858
    try:
 
2859
        inventory_cache = lru_cache.LRUCache(10)
 
2860
        for n, (revision, revision_tree, signature) in enumerate(iterable):
 
2861
            _install_revision(repository, revision, revision_tree, signature,
 
2862
                inventory_cache)
 
2863
            if pb is not None:
 
2864
                pb.update('Transferring revisions', n + 1, num_revisions)
 
2865
    except:
 
2866
        repository.abort_write_group()
 
2867
        raise
 
2868
    else:
 
2869
        repository.commit_write_group()
 
2870
 
 
2871
 
 
2872
def _install_revision(repository, rev, revision_tree, signature,
 
2873
    inventory_cache):
 
2874
    """Install all revision data into a repository."""
754
2875
    present_parents = []
755
2876
    parent_trees = {}
756
2877
    for p_id in rev.parent_ids:
758
2879
            present_parents.append(p_id)
759
2880
            parent_trees[p_id] = repository.revision_tree(p_id)
760
2881
        else:
761
 
            parent_trees[p_id] = repository.revision_tree(None)
 
2882
            parent_trees[p_id] = repository.revision_tree(
 
2883
                                     _mod_revision.NULL_REVISION)
762
2884
 
763
2885
    inv = revision_tree.inventory
764
 
    
765
 
    # backwards compatability hack: skip the root id.
766
2886
    entries = inv.iter_entries()
767
 
    entries.next()
 
2887
    # backwards compatibility hack: skip the root id.
 
2888
    if not repository.supports_rich_root():
 
2889
        path, root = entries.next()
 
2890
        if root.revision != rev.revision_id:
 
2891
            raise errors.IncompatibleRevision(repr(repository))
 
2892
    text_keys = {}
 
2893
    for path, ie in entries:
 
2894
        text_keys[(ie.file_id, ie.revision)] = ie
 
2895
    text_parent_map = repository.texts.get_parent_map(text_keys)
 
2896
    missing_texts = set(text_keys) - set(text_parent_map)
768
2897
    # Add the texts that are not already present
769
 
    for path, ie in entries:
770
 
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
771
 
                repository.get_transaction())
772
 
        if ie.revision not in w:
773
 
            text_parents = []
774
 
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
775
 
            # with InventoryEntry.find_previous_heads(). if it is, then there
776
 
            # is a latent bug here where the parents may have ancestors of each
777
 
            # other. RBC, AB
778
 
            for revision, tree in parent_trees.iteritems():
779
 
                if ie.file_id not in tree:
780
 
                    continue
781
 
                parent_id = tree.inventory[ie.file_id].revision
782
 
                if parent_id in text_parents:
783
 
                    continue
784
 
                text_parents.append(parent_id)
785
 
                    
786
 
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
787
 
                repository.get_transaction())
788
 
            lines = revision_tree.get_file(ie.file_id).readlines()
789
 
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
2898
    for text_key in missing_texts:
 
2899
        ie = text_keys[text_key]
 
2900
        text_parents = []
 
2901
        # FIXME: TODO: The following loop overlaps/duplicates that done by
 
2902
        # commit to determine parents. There is a latent/real bug here where
 
2903
        # the parents inserted are not those commit would do - in particular
 
2904
        # they are not filtered by heads(). RBC, AB
 
2905
        for revision, tree in parent_trees.iteritems():
 
2906
            if ie.file_id not in tree:
 
2907
                continue
 
2908
            parent_id = tree.inventory[ie.file_id].revision
 
2909
            if parent_id in text_parents:
 
2910
                continue
 
2911
            text_parents.append((ie.file_id, parent_id))
 
2912
        lines = revision_tree.get_file(ie.file_id).readlines()
 
2913
        repository.texts.add_lines(text_key, text_parents, lines)
790
2914
    try:
791
2915
        # install the inventory
792
 
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
2916
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
 
2917
            # Cache this inventory
 
2918
            inventory_cache[rev.revision_id] = inv
 
2919
            try:
 
2920
                basis_inv = inventory_cache[rev.parent_ids[0]]
 
2921
            except KeyError:
 
2922
                repository.add_inventory(rev.revision_id, inv, present_parents)
 
2923
            else:
 
2924
                delta = inv._make_delta(basis_inv)
 
2925
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
 
2926
                    rev.revision_id, present_parents)
 
2927
        else:
 
2928
            repository.add_inventory(rev.revision_id, inv, present_parents)
793
2929
    except errors.RevisionAlreadyPresent:
794
2930
        pass
 
2931
    if signature is not None:
 
2932
        repository.add_signature_text(rev.revision_id, signature)
795
2933
    repository.add_revision(rev.revision_id, rev, inv)
796
2934
 
797
2935
 
798
2936
class MetaDirRepository(Repository):
799
 
    """Repositories in the new meta-dir layout."""
800
 
 
801
 
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
802
 
        super(MetaDirRepository, self).__init__(_format,
803
 
                                                a_bzrdir,
804
 
                                                control_files,
805
 
                                                _revision_store,
806
 
                                                control_store,
807
 
                                                text_store)
808
 
        dir_mode = self.control_files._dir_mode
809
 
        file_mode = self.control_files._file_mode
810
 
 
811
 
    @needs_read_lock
 
2937
    """Repositories in the new meta-dir layout.
 
2938
 
 
2939
    :ivar _transport: Transport for access to repository control files,
 
2940
        typically pointing to .bzr/repository.
 
2941
    """
 
2942
 
 
2943
    def __init__(self, _format, a_bzrdir, control_files):
 
2944
        super(MetaDirRepository, self).__init__(_format, a_bzrdir, control_files)
 
2945
        self._transport = control_files._transport
 
2946
 
812
2947
    def is_shared(self):
813
2948
        """Return True if this repository is flagged as a shared repository."""
814
 
        return self.control_files._transport.has('shared-storage')
 
2949
        return self._transport.has('shared-storage')
815
2950
 
816
2951
    @needs_write_lock
817
2952
    def set_make_working_trees(self, new_value):
825
2960
        """
826
2961
        if new_value:
827
2962
            try:
828
 
                self.control_files._transport.delete('no-working-trees')
 
2963
                self._transport.delete('no-working-trees')
829
2964
            except errors.NoSuchFile:
830
2965
                pass
831
2966
        else:
832
 
            self.control_files.put_utf8('no-working-trees', '')
833
 
    
 
2967
            self._transport.put_bytes('no-working-trees', '',
 
2968
                mode=self.bzrdir._get_file_mode())
 
2969
 
834
2970
    def make_working_trees(self):
835
2971
        """Returns the policy for making working trees on new branches."""
836
 
        return not self.control_files._transport.has('no-working-trees')
837
 
 
838
 
 
839
 
class KnitRepository(MetaDirRepository):
840
 
    """Knit format repository."""
841
 
 
842
 
    def _warn_if_deprecated(self):
843
 
        # This class isn't deprecated
844
 
        pass
845
 
 
846
 
    def _inventory_add_lines(self, inv_vf, revid, parents, lines):
847
 
        inv_vf.add_lines_with_ghosts(revid, parents, lines)
848
 
 
849
 
    @needs_read_lock
850
 
    def _all_revision_ids(self):
851
 
        """See Repository.all_revision_ids()."""
852
 
        # Knits get the revision graph from the index of the revision knit, so
853
 
        # it's always possible even if they're on an unlistable transport.
854
 
        return self._revision_store.all_revision_ids(self.get_transaction())
855
 
 
856
 
    def fileid_involved_between_revs(self, from_revid, to_revid):
857
 
        """Find file_id(s) which are involved in the changes between revisions.
858
 
 
859
 
        This determines the set of revisions which are involved, and then
860
 
        finds all file ids affected by those revisions.
861
 
        """
862
 
        vf = self._get_revision_vf()
863
 
        from_set = set(vf.get_ancestry(from_revid))
864
 
        to_set = set(vf.get_ancestry(to_revid))
865
 
        changed = to_set.difference(from_set)
866
 
        return self._fileid_involved_by_set(changed)
867
 
 
868
 
    def fileid_involved(self, last_revid=None):
869
 
        """Find all file_ids modified in the ancestry of last_revid.
870
 
 
871
 
        :param last_revid: If None, last_revision() will be used.
872
 
        """
873
 
        if not last_revid:
874
 
            changed = set(self.all_revision_ids())
875
 
        else:
876
 
            changed = set(self.get_ancestry(last_revid))
877
 
        if None in changed:
878
 
            changed.remove(None)
879
 
        return self._fileid_involved_by_set(changed)
880
 
 
881
 
    @needs_read_lock
882
 
    def get_ancestry(self, revision_id):
883
 
        """Return a list of revision-ids integrated by a revision.
884
 
        
885
 
        This is topologically sorted.
886
 
        """
887
 
        if revision_id is None:
888
 
            return [None]
889
 
        vf = self._get_revision_vf()
890
 
        try:
891
 
            return [None] + vf.get_ancestry(revision_id)
892
 
        except errors.RevisionNotPresent:
893
 
            raise errors.NoSuchRevision(self, revision_id)
894
 
 
895
 
    @needs_read_lock
896
 
    def get_revision(self, revision_id):
897
 
        """Return the Revision object for a named revision"""
898
 
        return self.get_revision_reconcile(revision_id)
899
 
 
900
 
    @needs_read_lock
901
 
    def get_revision_graph(self, revision_id=None):
902
 
        """Return a dictionary containing the revision graph.
903
 
 
904
 
        :param revision_id: The revision_id to get a graph from. If None, then
905
 
        the entire revision graph is returned. This is a deprecated mode of
906
 
        operation and will be removed in the future.
907
 
        :return: a dictionary of revision_id->revision_parents_list.
908
 
        """
909
 
        # special case NULL_REVISION
910
 
        if revision_id == NULL_REVISION:
911
 
            return {}
912
 
        weave = self._get_revision_vf()
913
 
        entire_graph = weave.get_graph()
914
 
        if revision_id is None:
915
 
            return weave.get_graph()
916
 
        elif revision_id not in weave:
917
 
            raise errors.NoSuchRevision(self, revision_id)
918
 
        else:
919
 
            # add what can be reached from revision_id
920
 
            result = {}
921
 
            pending = set([revision_id])
922
 
            while len(pending) > 0:
923
 
                node = pending.pop()
924
 
                result[node] = weave.get_parents(node)
925
 
                for revision_id in result[node]:
926
 
                    if revision_id not in result:
927
 
                        pending.add(revision_id)
928
 
            return result
929
 
 
930
 
    @needs_read_lock
931
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
932
 
        """Return a graph of the revisions with ghosts marked as applicable.
933
 
 
934
 
        :param revision_ids: an iterable of revisions to graph or None for all.
935
 
        :return: a Graph object with the graph reachable from revision_ids.
936
 
        """
937
 
        result = Graph()
938
 
        vf = self._get_revision_vf()
939
 
        versions = set(vf.versions())
940
 
        if not revision_ids:
941
 
            pending = set(self.all_revision_ids())
942
 
            required = set([])
943
 
        else:
944
 
            pending = set(revision_ids)
945
 
            # special case NULL_REVISION
946
 
            if NULL_REVISION in pending:
947
 
                pending.remove(NULL_REVISION)
948
 
            required = set(pending)
949
 
        done = set([])
950
 
        while len(pending):
951
 
            revision_id = pending.pop()
952
 
            if not revision_id in versions:
953
 
                if revision_id in required:
954
 
                    raise errors.NoSuchRevision(self, revision_id)
955
 
                # a ghost
956
 
                result.add_ghost(revision_id)
957
 
                # mark it as done so we don't try for it again.
958
 
                done.add(revision_id)
959
 
                continue
960
 
            parent_ids = vf.get_parents_with_ghosts(revision_id)
961
 
            for parent_id in parent_ids:
962
 
                # is this queued or done ?
963
 
                if (parent_id not in pending and
964
 
                    parent_id not in done):
965
 
                    # no, queue it.
966
 
                    pending.add(parent_id)
967
 
            result.add_node(revision_id, parent_ids)
968
 
            done.add(revision_id)
969
 
        return result
970
 
 
971
 
    def _get_revision_vf(self):
972
 
        """:return: a versioned file containing the revisions."""
973
 
        vf = self._revision_store.get_revision_file(self.get_transaction())
974
 
        return vf
975
 
 
976
 
    @needs_write_lock
977
 
    def reconcile(self, other=None, thorough=False):
978
 
        """Reconcile this repository."""
979
 
        from bzrlib.reconcile import KnitReconciler
980
 
        reconciler = KnitReconciler(self, thorough=thorough)
981
 
        reconciler.reconcile()
982
 
        return reconciler
983
 
    
984
 
    def revision_parents(self, revision_id):
985
 
        return self._get_revision_vf().get_parents(revision_id)
986
 
 
 
2972
        return not self._transport.has('no-working-trees')
 
2973
 
 
2974
 
 
2975
class MetaDirVersionedFileRepository(MetaDirRepository):
 
2976
    """Repositories in a meta-dir, that work via versioned file objects."""
 
2977
 
 
2978
    def __init__(self, _format, a_bzrdir, control_files):
 
2979
        super(MetaDirVersionedFileRepository, self).__init__(_format, a_bzrdir,
 
2980
            control_files)
 
2981
 
 
2982
 
 
2983
network_format_registry = registry.FormatRegistry()
 
2984
"""Registry of formats indexed by their network name.
 
2985
 
 
2986
The network name for a repository format is an identifier that can be used when
 
2987
referring to formats with smart server operations. See
 
2988
RepositoryFormat.network_name() for more detail.
 
2989
"""
 
2990
 
 
2991
 
 
2992
format_registry = registry.FormatRegistry(network_format_registry)
 
2993
"""Registry of formats, indexed by their BzrDirMetaFormat format string.
 
2994
 
 
2995
This can contain either format instances themselves, or classes/factories that
 
2996
can be called to obtain one.
 
2997
"""
 
2998
 
 
2999
 
 
3000
#####################################################################
 
3001
# Repository Formats
987
3002
 
988
3003
class RepositoryFormat(object):
989
3004
    """A repository format.
990
3005
 
991
 
    Formats provide three things:
 
3006
    Formats provide four things:
992
3007
     * An initialization routine to construct repository data on disk.
993
 
     * a format string which is used when the BzrDir supports versioned
994
 
       children.
 
3008
     * a optional format string which is used when the BzrDir supports
 
3009
       versioned children.
995
3010
     * an open routine which returns a Repository instance.
996
 
 
997
 
    Formats are placed in an dict by their format string for reference 
998
 
    during opening. These should be subclasses of RepositoryFormat
999
 
    for consistency.
 
3011
     * A network name for referring to the format in smart server RPC
 
3012
       methods.
 
3013
 
 
3014
    There is one and only one Format subclass for each on-disk format. But
 
3015
    there can be one Repository subclass that is used for several different
 
3016
    formats. The _format attribute on a Repository instance can be used to
 
3017
    determine the disk format.
 
3018
 
 
3019
    Formats are placed in a registry by their format string for reference
 
3020
    during opening. These should be subclasses of RepositoryFormat for
 
3021
    consistency.
1000
3022
 
1001
3023
    Once a format is deprecated, just deprecate the initialize and open
1002
 
    methods on the format class. Do not deprecate the object, as the 
1003
 
    object will be created every system load.
 
3024
    methods on the format class. Do not deprecate the object, as the
 
3025
    object may be created even when a repository instance hasn't been
 
3026
    created.
1004
3027
 
1005
3028
    Common instance attributes:
1006
3029
    _matchingbzrdir - the bzrdir format that the repository format was
1007
3030
    originally written to work with. This can be used if manually
1008
3031
    constructing a bzrdir and repository, or more commonly for test suite
1009
 
    parameterisation.
 
3032
    parameterization.
1010
3033
    """
1011
3034
 
1012
 
    _default_format = None
1013
 
    """The default format used for new repositories."""
1014
 
 
1015
 
    _formats = {}
1016
 
    """The known formats."""
 
3035
    # Set to True or False in derived classes. True indicates that the format
 
3036
    # supports ghosts gracefully.
 
3037
    supports_ghosts = None
 
3038
    # Can this repository be given external locations to lookup additional
 
3039
    # data. Set to True or False in derived classes.
 
3040
    supports_external_lookups = None
 
3041
    # Does this format support CHK bytestring lookups. Set to True or False in
 
3042
    # derived classes.
 
3043
    supports_chks = None
 
3044
    # Should commit add an inventory, or an inventory delta to the repository.
 
3045
    _commit_inv_deltas = True
 
3046
    # What order should fetch operations request streams in?
 
3047
    # The default is unordered as that is the cheapest for an origin to
 
3048
    # provide.
 
3049
    _fetch_order = 'unordered'
 
3050
    # Does this repository format use deltas that can be fetched as-deltas ?
 
3051
    # (E.g. knits, where the knit deltas can be transplanted intact.
 
3052
    # We default to False, which will ensure that enough data to get
 
3053
    # a full text out of any fetch stream will be grabbed.
 
3054
    _fetch_uses_deltas = False
 
3055
    # Should fetch trigger a reconcile after the fetch? Only needed for
 
3056
    # some repository formats that can suffer internal inconsistencies.
 
3057
    _fetch_reconcile = False
 
3058
    # Does this format have < O(tree_size) delta generation. Used to hint what
 
3059
    # code path for commit, amongst other things.
 
3060
    fast_deltas = None
 
3061
    # Does doing a pack operation compress data? Useful for the pack UI command
 
3062
    # (so if there is one pack, the operation can still proceed because it may
 
3063
    # help), and for fetching when data won't have come from the same
 
3064
    # compressor.
 
3065
    pack_compresses = False
 
3066
    # Does the repository inventory storage understand references to trees?
 
3067
    supports_tree_reference = None
1017
3068
 
1018
3069
    def __str__(self):
1019
3070
        return "<%s>" % self.__class__.__name__
1020
3071
 
 
3072
    def __eq__(self, other):
 
3073
        # format objects are generally stateless
 
3074
        return isinstance(other, self.__class__)
 
3075
 
 
3076
    def __ne__(self, other):
 
3077
        return not self == other
 
3078
 
1021
3079
    @classmethod
1022
3080
    def find_format(klass, a_bzrdir):
1023
 
        """Return the format for the repository object in a_bzrdir."""
 
3081
        """Return the format for the repository object in a_bzrdir.
 
3082
 
 
3083
        This is used by bzr native formats that have a "format" file in
 
3084
        the repository.  Other methods may be used by different types of
 
3085
        control directory.
 
3086
        """
1024
3087
        try:
1025
3088
            transport = a_bzrdir.get_repository_transport(None)
1026
3089
            format_string = transport.get("format").read()
1027
 
            return klass._formats[format_string]
 
3090
            return format_registry.get(format_string)
1028
3091
        except errors.NoSuchFile:
1029
3092
            raise errors.NoRepositoryPresent(a_bzrdir)
1030
3093
        except KeyError:
1031
 
            raise errors.UnknownFormatError(format=format_string)
1032
 
 
1033
 
    def _get_control_store(self, repo_transport, control_files):
1034
 
        """Return the control store for this repository."""
1035
 
        raise NotImplementedError(self._get_control_store)
1036
 
    
 
3094
            raise errors.UnknownFormatError(format=format_string,
 
3095
                                            kind='repository')
 
3096
 
 
3097
    @classmethod
 
3098
    def register_format(klass, format):
 
3099
        format_registry.register(format.get_format_string(), format)
 
3100
 
 
3101
    @classmethod
 
3102
    def unregister_format(klass, format):
 
3103
        format_registry.remove(format.get_format_string())
 
3104
 
1037
3105
    @classmethod
1038
3106
    def get_default_format(klass):
1039
3107
        """Return the current default format."""
1040
 
        return klass._default_format
 
3108
        from bzrlib import bzrdir
 
3109
        return bzrdir.format_registry.make_bzrdir('default').repository_format
1041
3110
 
1042
3111
    def get_format_string(self):
1043
3112
        """Return the ASCII format string that identifies this format.
1044
 
        
1045
 
        Note that in pre format ?? repositories the format string is 
 
3113
 
 
3114
        Note that in pre format ?? repositories the format string is
1046
3115
        not permitted nor written to disk.
1047
3116
        """
1048
3117
        raise NotImplementedError(self.get_format_string)
1051
3120
        """Return the short description for this format."""
1052
3121
        raise NotImplementedError(self.get_format_description)
1053
3122
 
1054
 
    def _get_revision_store(self, repo_transport, control_files):
1055
 
        """Return the revision store object for this a_bzrdir."""
1056
 
        raise NotImplementedError(self._get_revision_store)
1057
 
 
1058
 
    def _get_text_rev_store(self,
1059
 
                            transport,
1060
 
                            control_files,
1061
 
                            name,
1062
 
                            compressed=True,
1063
 
                            prefixed=False,
1064
 
                            serializer=None):
1065
 
        """Common logic for getting a revision store for a repository.
1066
 
        
1067
 
        see self._get_revision_store for the subclass-overridable method to 
1068
 
        get the store for a repository.
1069
 
        """
1070
 
        from bzrlib.store.revision.text import TextRevisionStore
1071
 
        dir_mode = control_files._dir_mode
1072
 
        file_mode = control_files._file_mode
1073
 
        text_store =TextStore(transport.clone(name),
1074
 
                              prefixed=prefixed,
1075
 
                              compressed=compressed,
1076
 
                              dir_mode=dir_mode,
1077
 
                              file_mode=file_mode)
1078
 
        _revision_store = TextRevisionStore(text_store, serializer)
1079
 
        return _revision_store
1080
 
 
 
3123
    # TODO: this shouldn't be in the base class, it's specific to things that
 
3124
    # use weaves or knits -- mbp 20070207
1081
3125
    def _get_versioned_file_store(self,
1082
3126
                                  name,
1083
3127
                                  transport,
1084
3128
                                  control_files,
1085
3129
                                  prefixed=True,
1086
 
                                  versionedfile_class=WeaveFile,
 
3130
                                  versionedfile_class=None,
 
3131
                                  versionedfile_kwargs={},
1087
3132
                                  escaped=False):
 
3133
        if versionedfile_class is None:
 
3134
            versionedfile_class = self._versionedfile_class
1088
3135
        weave_transport = control_files._transport.clone(name)
1089
3136
        dir_mode = control_files._dir_mode
1090
3137
        file_mode = control_files._file_mode
1092
3139
                                  dir_mode=dir_mode,
1093
3140
                                  file_mode=file_mode,
1094
3141
                                  versionedfile_class=versionedfile_class,
 
3142
                                  versionedfile_kwargs=versionedfile_kwargs,
1095
3143
                                  escaped=escaped)
1096
3144
 
1097
3145
    def initialize(self, a_bzrdir, shared=False):
1099
3147
 
1100
3148
        :param a_bzrdir: The bzrdir to put the new repository in it.
1101
3149
        :param shared: The repository should be initialized as a sharable one.
 
3150
        :returns: The new repository object.
1102
3151
 
1103
3152
        This may raise UninitializableFormat if shared repository are not
1104
3153
        compatible the a_bzrdir.
1105
3154
        """
 
3155
        raise NotImplementedError(self.initialize)
1106
3156
 
1107
3157
    def is_supported(self):
1108
3158
        """Is this format supported?
1109
3159
 
1110
3160
        Supported formats must be initializable and openable.
1111
 
        Unsupported formats may not support initialization or committing or 
 
3161
        Unsupported formats may not support initialization or committing or
1112
3162
        some other features depending on the reason for not being supported.
1113
3163
        """
1114
3164
        return True
1115
3165
 
 
3166
    def network_name(self):
 
3167
        """A simple byte string uniquely identifying this format for RPC calls.
 
3168
 
 
3169
        MetaDir repository formats use their disk format string to identify the
 
3170
        repository over the wire. All in one formats such as bzr < 0.8, and
 
3171
        foreign formats like svn/git and hg should use some marker which is
 
3172
        unique and immutable.
 
3173
        """
 
3174
        raise NotImplementedError(self.network_name)
 
3175
 
 
3176
    def check_conversion_target(self, target_format):
 
3177
        if self.rich_root_data and not target_format.rich_root_data:
 
3178
            raise errors.BadConversionTarget(
 
3179
                'Does not support rich root data.', target_format,
 
3180
                from_format=self)
 
3181
        if (self.supports_tree_reference and 
 
3182
            not getattr(target_format, 'supports_tree_reference', False)):
 
3183
            raise errors.BadConversionTarget(
 
3184
                'Does not support nested trees', target_format,
 
3185
                from_format=self)
 
3186
 
1116
3187
    def open(self, a_bzrdir, _found=False):
1117
3188
        """Return an instance of this format for the bzrdir a_bzrdir.
1118
 
        
 
3189
 
1119
3190
        _found is a private parameter, do not use it.
1120
3191
        """
1121
3192
        raise NotImplementedError(self.open)
1122
3193
 
1123
 
    @classmethod
1124
 
    def register_format(klass, format):
1125
 
        klass._formats[format.get_format_string()] = format
1126
 
 
1127
 
    @classmethod
1128
 
    def set_default_format(klass, format):
1129
 
        klass._default_format = format
1130
 
 
1131
 
    @classmethod
1132
 
    def unregister_format(klass, format):
1133
 
        assert klass._formats[format.get_format_string()] is format
1134
 
        del klass._formats[format.get_format_string()]
1135
 
 
1136
 
 
1137
 
class PreSplitOutRepositoryFormat(RepositoryFormat):
1138
 
    """Base class for the pre split out repository formats."""
1139
 
 
1140
 
    def initialize(self, a_bzrdir, shared=False, _internal=False):
1141
 
        """Create a weave repository.
1142
 
        
1143
 
        TODO: when creating split out bzr branch formats, move this to a common
1144
 
        base for Format5, Format6. or something like that.
1145
 
        """
1146
 
        from bzrlib.weavefile import write_weave_v5
1147
 
        from bzrlib.weave import Weave
1148
 
 
1149
 
        if shared:
1150
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
1151
 
 
1152
 
        if not _internal:
1153
 
            # always initialized when the bzrdir is.
1154
 
            return self.open(a_bzrdir, _found=True)
1155
 
        
1156
 
        # Create an empty weave
1157
 
        sio = StringIO()
1158
 
        write_weave_v5(Weave(), sio)
1159
 
        empty_weave = sio.getvalue()
1160
 
 
1161
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1162
 
        dirs = ['revision-store', 'weaves']
1163
 
        files = [('inventory.weave', StringIO(empty_weave)),
1164
 
                 ]
1165
 
        
1166
 
        # FIXME: RBC 20060125 don't peek under the covers
1167
 
        # NB: no need to escape relative paths that are url safe.
1168
 
        control_files = LockableFiles(a_bzrdir.transport, 'branch-lock',
1169
 
                                      TransportLock)
1170
 
        control_files.create_lock()
1171
 
        control_files.lock_write()
1172
 
        control_files._transport.mkdir_multi(dirs,
1173
 
                mode=control_files._dir_mode)
1174
 
        try:
1175
 
            for file, content in files:
1176
 
                control_files.put(file, content)
1177
 
        finally:
1178
 
            control_files.unlock()
1179
 
        return self.open(a_bzrdir, _found=True)
1180
 
 
1181
 
    def _get_control_store(self, repo_transport, control_files):
1182
 
        """Return the control store for this repository."""
1183
 
        return self._get_versioned_file_store('',
1184
 
                                              repo_transport,
1185
 
                                              control_files,
1186
 
                                              prefixed=False)
1187
 
 
1188
 
    def _get_text_store(self, transport, control_files):
1189
 
        """Get a store for file texts for this format."""
1190
 
        raise NotImplementedError(self._get_text_store)
1191
 
 
1192
 
    def open(self, a_bzrdir, _found=False):
1193
 
        """See RepositoryFormat.open()."""
1194
 
        if not _found:
1195
 
            # we are being called directly and must probe.
1196
 
            raise NotImplementedError
1197
 
 
1198
 
        repo_transport = a_bzrdir.get_repository_transport(None)
1199
 
        control_files = a_bzrdir._control_files
1200
 
        text_store = self._get_text_store(repo_transport, control_files)
1201
 
        control_store = self._get_control_store(repo_transport, control_files)
1202
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1203
 
        return AllInOneRepository(_format=self,
1204
 
                                  a_bzrdir=a_bzrdir,
1205
 
                                  _revision_store=_revision_store,
1206
 
                                  control_store=control_store,
1207
 
                                  text_store=text_store)
1208
 
 
1209
 
 
1210
 
class RepositoryFormat4(PreSplitOutRepositoryFormat):
1211
 
    """Bzr repository format 4.
1212
 
 
1213
 
    This repository format has:
1214
 
     - flat stores
1215
 
     - TextStores for texts, inventories,revisions.
1216
 
 
1217
 
    This format is deprecated: it indexes texts using a text id which is
1218
 
    removed in format 5; initialization and write support for this format
1219
 
    has been removed.
1220
 
    """
1221
 
 
1222
 
    def __init__(self):
1223
 
        super(RepositoryFormat4, self).__init__()
1224
 
        self._matchingbzrdir = bzrdir.BzrDirFormat4()
1225
 
 
1226
 
    def get_format_description(self):
1227
 
        """See RepositoryFormat.get_format_description()."""
1228
 
        return "Repository format 4"
1229
 
 
1230
 
    def initialize(self, url, shared=False, _internal=False):
1231
 
        """Format 4 branches cannot be created."""
1232
 
        raise errors.UninitializableFormat(self)
1233
 
 
1234
 
    def is_supported(self):
1235
 
        """Format 4 is not supported.
1236
 
 
1237
 
        It is not supported because the model changed from 4 to 5 and the
1238
 
        conversion logic is expensive - so doing it on the fly was not 
1239
 
        feasible.
1240
 
        """
1241
 
        return False
1242
 
 
1243
 
    def _get_control_store(self, repo_transport, control_files):
1244
 
        """Format 4 repositories have no formal control store at this point.
1245
 
        
1246
 
        This will cause any control-file-needing apis to fail - this is desired.
1247
 
        """
1248
 
        return None
1249
 
    
1250
 
    def _get_revision_store(self, repo_transport, control_files):
1251
 
        """See RepositoryFormat._get_revision_store()."""
1252
 
        from bzrlib.xml4 import serializer_v4
1253
 
        return self._get_text_rev_store(repo_transport,
1254
 
                                        control_files,
1255
 
                                        'revision-store',
1256
 
                                        serializer=serializer_v4)
1257
 
 
1258
 
    def _get_text_store(self, transport, control_files):
1259
 
        """See RepositoryFormat._get_text_store()."""
1260
 
 
1261
 
 
1262
 
class RepositoryFormat5(PreSplitOutRepositoryFormat):
1263
 
    """Bzr control format 5.
1264
 
 
1265
 
    This repository format has:
1266
 
     - weaves for file texts and inventory
1267
 
     - flat stores
1268
 
     - TextStores for revisions and signatures.
1269
 
    """
1270
 
 
1271
 
    def __init__(self):
1272
 
        super(RepositoryFormat5, self).__init__()
1273
 
        self._matchingbzrdir = bzrdir.BzrDirFormat5()
1274
 
 
1275
 
    def get_format_description(self):
1276
 
        """See RepositoryFormat.get_format_description()."""
1277
 
        return "Weave repository format 5"
1278
 
 
1279
 
    def _get_revision_store(self, repo_transport, control_files):
1280
 
        """See RepositoryFormat._get_revision_store()."""
1281
 
        """Return the revision store object for this a_bzrdir."""
1282
 
        return self._get_text_rev_store(repo_transport,
1283
 
                                        control_files,
1284
 
                                        'revision-store',
1285
 
                                        compressed=False)
1286
 
 
1287
 
    def _get_text_store(self, transport, control_files):
1288
 
        """See RepositoryFormat._get_text_store()."""
1289
 
        return self._get_versioned_file_store('weaves', transport, control_files, prefixed=False)
1290
 
 
1291
 
 
1292
 
class RepositoryFormat6(PreSplitOutRepositoryFormat):
1293
 
    """Bzr control format 6.
1294
 
 
1295
 
    This repository format has:
1296
 
     - weaves for file texts and inventory
1297
 
     - hash subdirectory based stores.
1298
 
     - TextStores for revisions and signatures.
1299
 
    """
1300
 
 
1301
 
    def __init__(self):
1302
 
        super(RepositoryFormat6, self).__init__()
1303
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1304
 
 
1305
 
    def get_format_description(self):
1306
 
        """See RepositoryFormat.get_format_description()."""
1307
 
        return "Weave repository format 6"
1308
 
 
1309
 
    def _get_revision_store(self, repo_transport, control_files):
1310
 
        """See RepositoryFormat._get_revision_store()."""
1311
 
        return self._get_text_rev_store(repo_transport,
1312
 
                                        control_files,
1313
 
                                        'revision-store',
1314
 
                                        compressed=False,
1315
 
                                        prefixed=True)
1316
 
 
1317
 
    def _get_text_store(self, transport, control_files):
1318
 
        """See RepositoryFormat._get_text_store()."""
1319
 
        return self._get_versioned_file_store('weaves', transport, control_files)
1320
 
 
1321
3194
 
1322
3195
class MetaDirRepositoryFormat(RepositoryFormat):
1323
3196
    """Common base class for the new repositories using the metadir layout."""
1324
3197
 
 
3198
    rich_root_data = False
 
3199
    supports_tree_reference = False
 
3200
    supports_external_lookups = False
 
3201
 
 
3202
    @property
 
3203
    def _matchingbzrdir(self):
 
3204
        matching = bzrdir.BzrDirMetaFormat1()
 
3205
        matching.repository_format = self
 
3206
        return matching
 
3207
 
1325
3208
    def __init__(self):
1326
3209
        super(MetaDirRepositoryFormat, self).__init__()
1327
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1328
3210
 
1329
3211
    def _create_control_files(self, a_bzrdir):
1330
3212
        """Create the required files and the initial control_files object."""
1331
3213
        # FIXME: RBC 20060125 don't peek under the covers
1332
3214
        # NB: no need to escape relative paths that are url safe.
1333
3215
        repository_transport = a_bzrdir.get_repository_transport(self)
1334
 
        control_files = LockableFiles(repository_transport, 'lock', LockDir)
 
3216
        control_files = lockable_files.LockableFiles(repository_transport,
 
3217
                                'lock', lockdir.LockDir)
1335
3218
        control_files.create_lock()
1336
3219
        return control_files
1337
3220
 
1339
3222
        """Upload the initial blank content."""
1340
3223
        control_files = self._create_control_files(a_bzrdir)
1341
3224
        control_files.lock_write()
 
3225
        transport = control_files._transport
 
3226
        if shared == True:
 
3227
            utf8_files += [('shared-storage', '')]
1342
3228
        try:
1343
 
            control_files._transport.mkdir_multi(dirs,
1344
 
                    mode=control_files._dir_mode)
1345
 
            for file, content in files:
1346
 
                control_files.put(file, content)
1347
 
            for file, content in utf8_files:
1348
 
                control_files.put_utf8(file, content)
1349
 
            if shared == True:
1350
 
                control_files.put_utf8('shared-storage', '')
 
3229
            transport.mkdir_multi(dirs, mode=a_bzrdir._get_dir_mode())
 
3230
            for (filename, content_stream) in files:
 
3231
                transport.put_file(filename, content_stream,
 
3232
                    mode=a_bzrdir._get_file_mode())
 
3233
            for (filename, content_bytes) in utf8_files:
 
3234
                transport.put_bytes_non_atomic(filename, content_bytes,
 
3235
                    mode=a_bzrdir._get_file_mode())
1351
3236
        finally:
1352
3237
            control_files.unlock()
1353
3238
 
1354
 
 
1355
 
class RepositoryFormat7(MetaDirRepositoryFormat):
1356
 
    """Bzr repository 7.
1357
 
 
1358
 
    This repository format has:
1359
 
     - weaves for file texts and inventory
1360
 
     - hash subdirectory based stores.
1361
 
     - TextStores for revisions and signatures.
1362
 
     - a format marker of its own
1363
 
     - an optional 'shared-storage' flag
1364
 
     - an optional 'no-working-trees' flag
1365
 
    """
1366
 
 
1367
 
    def _get_control_store(self, repo_transport, control_files):
1368
 
        """Return the control store for this repository."""
1369
 
        return self._get_versioned_file_store('',
1370
 
                                              repo_transport,
1371
 
                                              control_files,
1372
 
                                              prefixed=False)
1373
 
 
1374
 
    def get_format_string(self):
1375
 
        """See RepositoryFormat.get_format_string()."""
1376
 
        return "Bazaar-NG Repository format 7"
1377
 
 
1378
 
    def get_format_description(self):
1379
 
        """See RepositoryFormat.get_format_description()."""
1380
 
        return "Weave repository format 7"
1381
 
 
1382
 
    def _get_revision_store(self, repo_transport, control_files):
1383
 
        """See RepositoryFormat._get_revision_store()."""
1384
 
        return self._get_text_rev_store(repo_transport,
1385
 
                                        control_files,
1386
 
                                        'revision-store',
1387
 
                                        compressed=False,
1388
 
                                        prefixed=True,
1389
 
                                        )
1390
 
 
1391
 
    def _get_text_store(self, transport, control_files):
1392
 
        """See RepositoryFormat._get_text_store()."""
1393
 
        return self._get_versioned_file_store('weaves',
1394
 
                                              transport,
1395
 
                                              control_files)
1396
 
 
1397
 
    def initialize(self, a_bzrdir, shared=False):
1398
 
        """Create a weave repository.
1399
 
 
1400
 
        :param shared: If true the repository will be initialized as a shared
1401
 
                       repository.
1402
 
        """
1403
 
        from bzrlib.weavefile import write_weave_v5
1404
 
        from bzrlib.weave import Weave
1405
 
 
1406
 
        # Create an empty weave
1407
 
        sio = StringIO()
1408
 
        write_weave_v5(Weave(), sio)
1409
 
        empty_weave = sio.getvalue()
1410
 
 
1411
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1412
 
        dirs = ['revision-store', 'weaves']
1413
 
        files = [('inventory.weave', StringIO(empty_weave)), 
1414
 
                 ]
1415
 
        utf8_files = [('format', self.get_format_string())]
1416
 
 
1417
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1418
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1419
 
 
1420
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1421
 
        """See RepositoryFormat.open().
1422
 
        
1423
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1424
 
                                    repository at a slightly different url
1425
 
                                    than normal. I.e. during 'upgrade'.
1426
 
        """
1427
 
        if not _found:
1428
 
            format = RepositoryFormat.find_format(a_bzrdir)
1429
 
            assert format.__class__ ==  self.__class__
1430
 
        if _override_transport is not None:
1431
 
            repo_transport = _override_transport
1432
 
        else:
1433
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1434
 
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
1435
 
        text_store = self._get_text_store(repo_transport, control_files)
1436
 
        control_store = self._get_control_store(repo_transport, control_files)
1437
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1438
 
        return MetaDirRepository(_format=self,
1439
 
                                 a_bzrdir=a_bzrdir,
1440
 
                                 control_files=control_files,
1441
 
                                 _revision_store=_revision_store,
1442
 
                                 control_store=control_store,
1443
 
                                 text_store=text_store)
1444
 
 
1445
 
 
1446
 
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
1447
 
    """Bzr repository knit format 1.
1448
 
 
1449
 
    This repository format has:
1450
 
     - knits for file texts and inventory
1451
 
     - hash subdirectory based stores.
1452
 
     - knits for revisions and signatures
1453
 
     - TextStores for revisions and signatures.
1454
 
     - a format marker of its own
1455
 
     - an optional 'shared-storage' flag
1456
 
     - an optional 'no-working-trees' flag
1457
 
     - a LockDir lock
1458
 
 
1459
 
    This format was introduced in bzr 0.8.
1460
 
    """
1461
 
 
1462
 
    def _get_control_store(self, repo_transport, control_files):
1463
 
        """Return the control store for this repository."""
1464
 
        return VersionedFileStore(
1465
 
            repo_transport,
1466
 
            prefixed=False,
1467
 
            file_mode=control_files._file_mode,
1468
 
            versionedfile_class=KnitVersionedFile,
1469
 
            versionedfile_kwargs={'factory':KnitPlainFactory()},
1470
 
            )
1471
 
 
1472
 
    def get_format_string(self):
1473
 
        """See RepositoryFormat.get_format_string()."""
1474
 
        return "Bazaar-NG Knit Repository Format 1"
1475
 
 
1476
 
    def get_format_description(self):
1477
 
        """See RepositoryFormat.get_format_description()."""
1478
 
        return "Knit repository format 1"
1479
 
 
1480
 
    def _get_revision_store(self, repo_transport, control_files):
1481
 
        """See RepositoryFormat._get_revision_store()."""
1482
 
        from bzrlib.store.revision.knit import KnitRevisionStore
1483
 
        versioned_file_store = VersionedFileStore(
1484
 
            repo_transport,
1485
 
            file_mode=control_files._file_mode,
1486
 
            prefixed=False,
1487
 
            precious=True,
1488
 
            versionedfile_class=KnitVersionedFile,
1489
 
            versionedfile_kwargs={'delta':False, 'factory':KnitPlainFactory()},
1490
 
            escaped=True,
1491
 
            )
1492
 
        return KnitRevisionStore(versioned_file_store)
1493
 
 
1494
 
    def _get_text_store(self, transport, control_files):
1495
 
        """See RepositoryFormat._get_text_store()."""
1496
 
        return self._get_versioned_file_store('knits',
1497
 
                                              transport,
1498
 
                                              control_files,
1499
 
                                              versionedfile_class=KnitVersionedFile,
1500
 
                                              escaped=True)
1501
 
 
1502
 
    def initialize(self, a_bzrdir, shared=False):
1503
 
        """Create a knit format 1 repository.
1504
 
 
1505
 
        :param a_bzrdir: bzrdir to contain the new repository; must already
1506
 
            be initialized.
1507
 
        :param shared: If true the repository will be initialized as a shared
1508
 
                       repository.
1509
 
        """
1510
 
        mutter('creating repository in %s.', a_bzrdir.transport.base)
1511
 
        dirs = ['revision-store', 'knits']
1512
 
        files = []
1513
 
        utf8_files = [('format', self.get_format_string())]
1514
 
        
1515
 
        self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
1516
 
        repo_transport = a_bzrdir.get_repository_transport(None)
1517
 
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
1518
 
        control_store = self._get_control_store(repo_transport, control_files)
1519
 
        transaction = transactions.WriteTransaction()
1520
 
        # trigger a write of the inventory store.
1521
 
        control_store.get_weave_or_empty('inventory', transaction)
1522
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1523
 
        _revision_store.has_revision_id('A', transaction)
1524
 
        _revision_store.get_signature_file(transaction)
1525
 
        return self.open(a_bzrdir=a_bzrdir, _found=True)
1526
 
 
1527
 
    def open(self, a_bzrdir, _found=False, _override_transport=None):
1528
 
        """See RepositoryFormat.open().
1529
 
        
1530
 
        :param _override_transport: INTERNAL USE ONLY. Allows opening the
1531
 
                                    repository at a slightly different url
1532
 
                                    than normal. I.e. during 'upgrade'.
1533
 
        """
1534
 
        if not _found:
1535
 
            format = RepositoryFormat.find_format(a_bzrdir)
1536
 
            assert format.__class__ ==  self.__class__
1537
 
        if _override_transport is not None:
1538
 
            repo_transport = _override_transport
1539
 
        else:
1540
 
            repo_transport = a_bzrdir.get_repository_transport(None)
1541
 
        control_files = LockableFiles(repo_transport, 'lock', LockDir)
1542
 
        text_store = self._get_text_store(repo_transport, control_files)
1543
 
        control_store = self._get_control_store(repo_transport, control_files)
1544
 
        _revision_store = self._get_revision_store(repo_transport, control_files)
1545
 
        return KnitRepository(_format=self,
1546
 
                              a_bzrdir=a_bzrdir,
1547
 
                              control_files=control_files,
1548
 
                              _revision_store=_revision_store,
1549
 
                              control_store=control_store,
1550
 
                              text_store=text_store)
1551
 
 
1552
 
 
1553
 
# formats which have no format string are not discoverable
1554
 
# and not independently creatable, so are not registered.
1555
 
RepositoryFormat.register_format(RepositoryFormat7())
1556
 
_default_format = RepositoryFormatKnit1()
1557
 
RepositoryFormat.register_format(_default_format)
1558
 
RepositoryFormat.set_default_format(_default_format)
1559
 
_legacy_formats = [RepositoryFormat4(),
1560
 
                   RepositoryFormat5(),
1561
 
                   RepositoryFormat6()]
 
3239
    def network_name(self):
 
3240
        """Metadir formats have matching disk and network format strings."""
 
3241
        return self.get_format_string()
 
3242
 
 
3243
 
 
3244
# Pre-0.8 formats that don't have a disk format string (because they are
 
3245
# versioned by the matching control directory). We use the control directories
 
3246
# disk format string as a key for the network_name because they meet the
 
3247
# constraints (simple string, unique, immutable).
 
3248
network_format_registry.register_lazy(
 
3249
    "Bazaar-NG branch, format 5\n",
 
3250
    'bzrlib.repofmt.weaverepo',
 
3251
    'RepositoryFormat5',
 
3252
)
 
3253
network_format_registry.register_lazy(
 
3254
    "Bazaar-NG branch, format 6\n",
 
3255
    'bzrlib.repofmt.weaverepo',
 
3256
    'RepositoryFormat6',
 
3257
)
 
3258
 
 
3259
# formats which have no format string are not discoverable or independently
 
3260
# creatable on disk, so are not registered in format_registry.  They're
 
3261
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
3262
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
3263
# the repository is not separately opened are similar.
 
3264
 
 
3265
format_registry.register_lazy(
 
3266
    'Bazaar-NG Repository format 7',
 
3267
    'bzrlib.repofmt.weaverepo',
 
3268
    'RepositoryFormat7'
 
3269
    )
 
3270
 
 
3271
format_registry.register_lazy(
 
3272
    'Bazaar-NG Knit Repository Format 1',
 
3273
    'bzrlib.repofmt.knitrepo',
 
3274
    'RepositoryFormatKnit1',
 
3275
    )
 
3276
 
 
3277
format_registry.register_lazy(
 
3278
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
3279
    'bzrlib.repofmt.knitrepo',
 
3280
    'RepositoryFormatKnit3',
 
3281
    )
 
3282
 
 
3283
format_registry.register_lazy(
 
3284
    'Bazaar Knit Repository Format 4 (bzr 1.0)\n',
 
3285
    'bzrlib.repofmt.knitrepo',
 
3286
    'RepositoryFormatKnit4',
 
3287
    )
 
3288
 
 
3289
# Pack-based formats. There is one format for pre-subtrees, and one for
 
3290
# post-subtrees to allow ease of testing.
 
3291
# NOTE: These are experimental in 0.92. Stable in 1.0 and above
 
3292
format_registry.register_lazy(
 
3293
    'Bazaar pack repository format 1 (needs bzr 0.92)\n',
 
3294
    'bzrlib.repofmt.pack_repo',
 
3295
    'RepositoryFormatKnitPack1',
 
3296
    )
 
3297
format_registry.register_lazy(
 
3298
    'Bazaar pack repository format 1 with subtree support (needs bzr 0.92)\n',
 
3299
    'bzrlib.repofmt.pack_repo',
 
3300
    'RepositoryFormatKnitPack3',
 
3301
    )
 
3302
format_registry.register_lazy(
 
3303
    'Bazaar pack repository format 1 with rich root (needs bzr 1.0)\n',
 
3304
    'bzrlib.repofmt.pack_repo',
 
3305
    'RepositoryFormatKnitPack4',
 
3306
    )
 
3307
format_registry.register_lazy(
 
3308
    'Bazaar RepositoryFormatKnitPack5 (bzr 1.6)\n',
 
3309
    'bzrlib.repofmt.pack_repo',
 
3310
    'RepositoryFormatKnitPack5',
 
3311
    )
 
3312
format_registry.register_lazy(
 
3313
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6.1)\n',
 
3314
    'bzrlib.repofmt.pack_repo',
 
3315
    'RepositoryFormatKnitPack5RichRoot',
 
3316
    )
 
3317
format_registry.register_lazy(
 
3318
    'Bazaar RepositoryFormatKnitPack5RichRoot (bzr 1.6)\n',
 
3319
    'bzrlib.repofmt.pack_repo',
 
3320
    'RepositoryFormatKnitPack5RichRootBroken',
 
3321
    )
 
3322
format_registry.register_lazy(
 
3323
    'Bazaar RepositoryFormatKnitPack6 (bzr 1.9)\n',
 
3324
    'bzrlib.repofmt.pack_repo',
 
3325
    'RepositoryFormatKnitPack6',
 
3326
    )
 
3327
format_registry.register_lazy(
 
3328
    'Bazaar RepositoryFormatKnitPack6RichRoot (bzr 1.9)\n',
 
3329
    'bzrlib.repofmt.pack_repo',
 
3330
    'RepositoryFormatKnitPack6RichRoot',
 
3331
    )
 
3332
 
 
3333
# Development formats.
 
3334
# Obsolete but kept pending a CHK based subtree format.
 
3335
format_registry.register_lazy(
 
3336
    ("Bazaar development format 2 with subtree support "
 
3337
        "(needs bzr.dev from before 1.8)\n"),
 
3338
    'bzrlib.repofmt.pack_repo',
 
3339
    'RepositoryFormatPackDevelopment2Subtree',
 
3340
    )
 
3341
 
 
3342
# 1.14->1.16 go below here
 
3343
format_registry.register_lazy(
 
3344
    'Bazaar development format - group compression and chk inventory'
 
3345
        ' (needs bzr.dev from 1.14)\n',
 
3346
    'bzrlib.repofmt.groupcompress_repo',
 
3347
    'RepositoryFormatCHK1',
 
3348
    )
 
3349
 
 
3350
format_registry.register_lazy(
 
3351
    'Bazaar development format - chk repository with bencode revision '
 
3352
        'serialization (needs bzr.dev from 1.16)\n',
 
3353
    'bzrlib.repofmt.groupcompress_repo',
 
3354
    'RepositoryFormatCHK2',
 
3355
    )
 
3356
format_registry.register_lazy(
 
3357
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3358
    'bzrlib.repofmt.groupcompress_repo',
 
3359
    'RepositoryFormat2a',
 
3360
    )
1562
3361
 
1563
3362
 
1564
3363
class InterRepository(InterObject):
1565
3364
    """This class represents operations taking place between two repositories.
1566
3365
 
1567
3366
    Its instances have methods like copy_content and fetch, and contain
1568
 
    references to the source and target repositories these operations can be 
 
3367
    references to the source and target repositories these operations can be
1569
3368
    carried out on.
1570
3369
 
1571
3370
    Often we will provide convenience methods on 'repository' which carry out
1573
3372
    InterRepository.get(other).method_name(parameters).
1574
3373
    """
1575
3374
 
1576
 
    _optimisers = set()
 
3375
    _walk_to_common_revisions_batch_size = 50
 
3376
    _optimisers = []
1577
3377
    """The available optimised InterRepository types."""
1578
3378
 
1579
3379
    @needs_write_lock
1580
 
    def copy_content(self, revision_id=None, basis=None):
 
3380
    def copy_content(self, revision_id=None):
1581
3381
        """Make a complete copy of the content in self into destination.
1582
 
        
1583
 
        This is a destructive operation! Do not use it on existing 
 
3382
 
 
3383
        This is a destructive operation! Do not use it on existing
1584
3384
        repositories.
1585
3385
 
1586
3386
        :param revision_id: Only copy the content needed to construct
1587
3387
                            revision_id and its parents.
1588
 
        :param basis: Copy the needed data preferentially from basis.
1589
3388
        """
1590
3389
        try:
1591
3390
            self.target.set_make_working_trees(self.source.make_working_trees())
1592
3391
        except NotImplementedError:
1593
3392
            pass
1594
 
        # grab the basis available data
1595
 
        if basis is not None:
1596
 
            self.target.fetch(basis, revision_id=revision_id)
1597
 
        # but don't bother fetching if we have the needed data now.
1598
 
        if (revision_id not in (None, NULL_REVISION) and 
1599
 
            self.target.has_revision(revision_id)):
1600
 
            return
1601
3393
        self.target.fetch(self.source, revision_id=revision_id)
1602
3394
 
1603
3395
    @needs_write_lock
1604
 
    def fetch(self, revision_id=None, pb=None):
 
3396
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3397
            fetch_spec=None):
1605
3398
        """Fetch the content required to construct revision_id.
1606
3399
 
1607
 
        The content is copied from source to target.
 
3400
        The content is copied from self.source to self.target.
1608
3401
 
1609
3402
        :param revision_id: if None all content is copied, if NULL_REVISION no
1610
3403
                            content is copied.
1611
3404
        :param pb: optional progress bar to use for progress reports. If not
1612
3405
                   provided a default one will be created.
1613
 
 
1614
 
        Returns the copied revision count and the failed revisions in a tuple:
1615
 
        (copied, failures).
 
3406
        :return: None.
1616
3407
        """
1617
 
        from bzrlib.fetch import GenericRepoFetcher
1618
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1619
 
               self.source, self.source._format, self.target, self.target._format)
1620
 
        f = GenericRepoFetcher(to_repository=self.target,
 
3408
        from bzrlib.fetch import RepoFetcher
 
3409
        f = RepoFetcher(to_repository=self.target,
1621
3410
                               from_repository=self.source,
1622
3411
                               last_revision=revision_id,
1623
 
                               pb=pb)
1624
 
        return f.count_copied, f.failed_revisions
 
3412
                               fetch_spec=fetch_spec,
 
3413
                               pb=pb, find_ghosts=find_ghosts)
 
3414
 
 
3415
    def _walk_to_common_revisions(self, revision_ids):
 
3416
        """Walk out from revision_ids in source to revisions target has.
 
3417
 
 
3418
        :param revision_ids: The start point for the search.
 
3419
        :return: A set of revision ids.
 
3420
        """
 
3421
        target_graph = self.target.get_graph()
 
3422
        revision_ids = frozenset(revision_ids)
 
3423
        missing_revs = set()
 
3424
        source_graph = self.source.get_graph()
 
3425
        # ensure we don't pay silly lookup costs.
 
3426
        searcher = source_graph._make_breadth_first_searcher(revision_ids)
 
3427
        null_set = frozenset([_mod_revision.NULL_REVISION])
 
3428
        searcher_exhausted = False
 
3429
        while True:
 
3430
            next_revs = set()
 
3431
            ghosts = set()
 
3432
            # Iterate the searcher until we have enough next_revs
 
3433
            while len(next_revs) < self._walk_to_common_revisions_batch_size:
 
3434
                try:
 
3435
                    next_revs_part, ghosts_part = searcher.next_with_ghosts()
 
3436
                    next_revs.update(next_revs_part)
 
3437
                    ghosts.update(ghosts_part)
 
3438
                except StopIteration:
 
3439
                    searcher_exhausted = True
 
3440
                    break
 
3441
            # If there are ghosts in the source graph, and the caller asked for
 
3442
            # them, make sure that they are present in the target.
 
3443
            # We don't care about other ghosts as we can't fetch them and
 
3444
            # haven't been asked to.
 
3445
            ghosts_to_check = set(revision_ids.intersection(ghosts))
 
3446
            revs_to_get = set(next_revs).union(ghosts_to_check)
 
3447
            if revs_to_get:
 
3448
                have_revs = set(target_graph.get_parent_map(revs_to_get))
 
3449
                # we always have NULL_REVISION present.
 
3450
                have_revs = have_revs.union(null_set)
 
3451
                # Check if the target is missing any ghosts we need.
 
3452
                ghosts_to_check.difference_update(have_revs)
 
3453
                if ghosts_to_check:
 
3454
                    # One of the caller's revision_ids is a ghost in both the
 
3455
                    # source and the target.
 
3456
                    raise errors.NoSuchRevision(
 
3457
                        self.source, ghosts_to_check.pop())
 
3458
                missing_revs.update(next_revs - have_revs)
 
3459
                # Because we may have walked past the original stop point, make
 
3460
                # sure everything is stopped
 
3461
                stop_revs = searcher.find_seen_ancestors(have_revs)
 
3462
                searcher.stop_searching_any(stop_revs)
 
3463
            if searcher_exhausted:
 
3464
                break
 
3465
        return searcher.get_result()
1625
3466
 
1626
3467
    @needs_read_lock
1627
 
    def missing_revision_ids(self, revision_id=None):
 
3468
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1628
3469
        """Return the revision ids that source has that target does not.
1629
 
        
1630
 
        These are returned in topological order.
1631
3470
 
1632
3471
        :param revision_id: only return revision ids included by this
1633
3472
                            revision_id.
 
3473
        :param find_ghosts: If True find missing revisions in deep history
 
3474
            rather than just finding the surface difference.
 
3475
        :return: A bzrlib.graph.SearchResult.
1634
3476
        """
 
3477
        # stop searching at found target revisions.
 
3478
        if not find_ghosts and revision_id is not None:
 
3479
            return self._walk_to_common_revisions([revision_id])
1635
3480
        # generic, possibly worst case, slow code path.
1636
3481
        target_ids = set(self.target.all_revision_ids())
1637
3482
        if revision_id is not None:
1638
3483
            source_ids = self.source.get_ancestry(revision_id)
1639
 
            assert source_ids[0] == None
 
3484
            if source_ids[0] is not None:
 
3485
                raise AssertionError()
1640
3486
            source_ids.pop(0)
1641
3487
        else:
1642
3488
            source_ids = self.source.all_revision_ids()
1643
3489
        result_set = set(source_ids).difference(target_ids)
1644
 
        # this may look like a no-op: its not. It preserves the ordering
1645
 
        # other_ids had while only returning the members from other_ids
1646
 
        # that we've decided we need.
1647
 
        return [rev_id for rev_id in source_ids if rev_id in result_set]
1648
 
 
1649
 
 
1650
 
class InterWeaveRepo(InterRepository):
1651
 
    """Optimised code paths between Weave based repositories."""
1652
 
 
1653
 
    _matching_repo_format = RepositoryFormat7()
1654
 
    """Repository format for testing with."""
 
3490
        return self.source.revision_ids_to_search_result(result_set)
 
3491
 
 
3492
    @staticmethod
 
3493
    def _same_model(source, target):
 
3494
        """True if source and target have the same data representation.
 
3495
 
 
3496
        Note: this is always called on the base class; overriding it in a
 
3497
        subclass will have no effect.
 
3498
        """
 
3499
        try:
 
3500
            InterRepository._assert_same_model(source, target)
 
3501
            return True
 
3502
        except errors.IncompatibleRepositories, e:
 
3503
            return False
 
3504
 
 
3505
    @staticmethod
 
3506
    def _assert_same_model(source, target):
 
3507
        """Raise an exception if two repositories do not use the same model.
 
3508
        """
 
3509
        if source.supports_rich_root() != target.supports_rich_root():
 
3510
            raise errors.IncompatibleRepositories(source, target,
 
3511
                "different rich-root support")
 
3512
        if source._serializer != target._serializer:
 
3513
            raise errors.IncompatibleRepositories(source, target,
 
3514
                "different serializers")
 
3515
 
 
3516
 
 
3517
class InterSameDataRepository(InterRepository):
 
3518
    """Code for converting between repositories that represent the same data.
 
3519
 
 
3520
    Data format and model must match for this to work.
 
3521
    """
 
3522
 
 
3523
    @classmethod
 
3524
    def _get_repo_format_to_test(self):
 
3525
        """Repository format for testing with.
 
3526
 
 
3527
        InterSameData can pull from subtree to subtree and from non-subtree to
 
3528
        non-subtree, so we test this with the richest repository format.
 
3529
        """
 
3530
        from bzrlib.repofmt import knitrepo
 
3531
        return knitrepo.RepositoryFormatKnit3()
 
3532
 
 
3533
    @staticmethod
 
3534
    def is_compatible(source, target):
 
3535
        return InterRepository._same_model(source, target)
 
3536
 
 
3537
 
 
3538
class InterWeaveRepo(InterSameDataRepository):
 
3539
    """Optimised code paths between Weave based repositories.
 
3540
 
 
3541
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
3542
    implemented lazy inter-object optimisation.
 
3543
    """
 
3544
 
 
3545
    @classmethod
 
3546
    def _get_repo_format_to_test(self):
 
3547
        from bzrlib.repofmt import weaverepo
 
3548
        return weaverepo.RepositoryFormat7()
1655
3549
 
1656
3550
    @staticmethod
1657
3551
    def is_compatible(source, target):
1658
3552
        """Be compatible with known Weave formats.
1659
 
        
 
3553
 
1660
3554
        We don't test for the stores being of specific types because that
1661
 
        could lead to confusing results, and there is no need to be 
 
3555
        could lead to confusing results, and there is no need to be
1662
3556
        overly general.
1663
3557
        """
 
3558
        from bzrlib.repofmt.weaverepo import (
 
3559
                RepositoryFormat5,
 
3560
                RepositoryFormat6,
 
3561
                RepositoryFormat7,
 
3562
                )
1664
3563
        try:
1665
3564
            return (isinstance(source._format, (RepositoryFormat5,
1666
3565
                                                RepositoryFormat6,
1670
3569
                                                RepositoryFormat7)))
1671
3570
        except AttributeError:
1672
3571
            return False
1673
 
    
 
3572
 
1674
3573
    @needs_write_lock
1675
 
    def copy_content(self, revision_id=None, basis=None):
 
3574
    def copy_content(self, revision_id=None):
1676
3575
        """See InterRepository.copy_content()."""
1677
3576
        # weave specific optimised path:
1678
 
        if basis is not None:
1679
 
            # copy the basis in, then fetch remaining data.
1680
 
            basis.copy_content_into(self.target, revision_id)
1681
 
            # the basis copy_content_into could miss-set this.
 
3577
        try:
 
3578
            self.target.set_make_working_trees(self.source.make_working_trees())
 
3579
        except (errors.RepositoryUpgradeRequired, NotImplemented):
 
3580
            pass
 
3581
        # FIXME do not peek!
 
3582
        if self.source._transport.listable():
 
3583
            pb = ui.ui_factory.nested_progress_bar()
1682
3584
            try:
1683
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1684
 
            except NotImplementedError:
1685
 
                pass
 
3585
                self.target.texts.insert_record_stream(
 
3586
                    self.source.texts.get_record_stream(
 
3587
                        self.source.texts.keys(), 'topological', False))
 
3588
                pb.update('Copying inventory', 0, 1)
 
3589
                self.target.inventories.insert_record_stream(
 
3590
                    self.source.inventories.get_record_stream(
 
3591
                        self.source.inventories.keys(), 'topological', False))
 
3592
                self.target.signatures.insert_record_stream(
 
3593
                    self.source.signatures.get_record_stream(
 
3594
                        self.source.signatures.keys(),
 
3595
                        'unordered', True))
 
3596
                self.target.revisions.insert_record_stream(
 
3597
                    self.source.revisions.get_record_stream(
 
3598
                        self.source.revisions.keys(),
 
3599
                        'topological', True))
 
3600
            finally:
 
3601
                pb.finished()
 
3602
        else:
1686
3603
            self.target.fetch(self.source, revision_id=revision_id)
1687
 
        else:
1688
 
            try:
1689
 
                self.target.set_make_working_trees(self.source.make_working_trees())
1690
 
            except NotImplementedError:
1691
 
                pass
1692
 
            # FIXME do not peek!
1693
 
            if self.source.control_files._transport.listable():
1694
 
                pb = ui.ui_factory.nested_progress_bar()
1695
 
                try:
1696
 
                    self.target.weave_store.copy_all_ids(
1697
 
                        self.source.weave_store,
1698
 
                        pb=pb,
1699
 
                        from_transaction=self.source.get_transaction(),
1700
 
                        to_transaction=self.target.get_transaction())
1701
 
                    pb.update('copying inventory', 0, 1)
1702
 
                    self.target.control_weaves.copy_multi(
1703
 
                        self.source.control_weaves, ['inventory'],
1704
 
                        from_transaction=self.source.get_transaction(),
1705
 
                        to_transaction=self.target.get_transaction())
1706
 
                    self.target._revision_store.text_store.copy_all_ids(
1707
 
                        self.source._revision_store.text_store,
1708
 
                        pb=pb)
1709
 
                finally:
1710
 
                    pb.finished()
1711
 
            else:
1712
 
                self.target.fetch(self.source, revision_id=revision_id)
1713
 
 
1714
 
    @needs_write_lock
1715
 
    def fetch(self, revision_id=None, pb=None):
1716
 
        """See InterRepository.fetch()."""
1717
 
        from bzrlib.fetch import GenericRepoFetcher
1718
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1719
 
               self.source, self.source._format, self.target, self.target._format)
1720
 
        f = GenericRepoFetcher(to_repository=self.target,
1721
 
                               from_repository=self.source,
1722
 
                               last_revision=revision_id,
1723
 
                               pb=pb)
1724
 
        return f.count_copied, f.failed_revisions
1725
3604
 
1726
3605
    @needs_read_lock
1727
 
    def missing_revision_ids(self, revision_id=None):
 
3606
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1728
3607
        """See InterRepository.missing_revision_ids()."""
1729
3608
        # we want all revisions to satisfy revision_id in source.
1730
3609
        # but we don't want to stat every file here and there.
1731
 
        # we want then, all revisions other needs to satisfy revision_id 
 
3610
        # we want then, all revisions other needs to satisfy revision_id
1732
3611
        # checked, but not those that we have locally.
1733
 
        # so the first thing is to get a subset of the revisions to 
 
3612
        # so the first thing is to get a subset of the revisions to
1734
3613
        # satisfy revision_id in source, and then eliminate those that
1735
 
        # we do already have. 
1736
 
        # this is slow on high latency connection to self, but as as this
1737
 
        # disk format scales terribly for push anyway due to rewriting 
 
3614
        # we do already have.
 
3615
        # this is slow on high latency connection to self, but as this
 
3616
        # disk format scales terribly for push anyway due to rewriting
1738
3617
        # inventory.weave, this is considered acceptable.
1739
3618
        # - RBC 20060209
1740
3619
        if revision_id is not None:
1741
3620
            source_ids = self.source.get_ancestry(revision_id)
1742
 
            assert source_ids[0] == None
 
3621
            if source_ids[0] is not None:
 
3622
                raise AssertionError()
1743
3623
            source_ids.pop(0)
1744
3624
        else:
1745
3625
            source_ids = self.source._all_possible_ids()
1750
3630
        # we do not have a revision as that would be pointless.
1751
3631
        target_ids = set(self.target._all_possible_ids())
1752
3632
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1753
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3633
        actually_present_revisions = set(
 
3634
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1754
3635
        required_revisions = source_ids_set.difference(actually_present_revisions)
1755
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1756
3636
        if revision_id is not None:
1757
3637
            # we used get_ancestry to determine source_ids then we are assured all
1758
3638
            # revisions referenced are present as they are installed in topological order.
1759
3639
            # and the tip revision was validated by get_ancestry.
1760
 
            return required_topo_revisions
 
3640
            result_set = required_revisions
1761
3641
        else:
1762
 
            # if we just grabbed the possibly available ids, then 
 
3642
            # if we just grabbed the possibly available ids, then
1763
3643
            # we only have an estimate of whats available and need to validate
1764
3644
            # that against the revision records.
1765
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1766
 
 
1767
 
 
1768
 
class InterKnitRepo(InterRepository):
 
3645
            result_set = set(
 
3646
                self.source._eliminate_revisions_not_present(required_revisions))
 
3647
        return self.source.revision_ids_to_search_result(result_set)
 
3648
 
 
3649
 
 
3650
class InterKnitRepo(InterSameDataRepository):
1769
3651
    """Optimised code paths between Knit based repositories."""
1770
3652
 
1771
 
    _matching_repo_format = RepositoryFormatKnit1()
1772
 
    """Repository format for testing with."""
 
3653
    @classmethod
 
3654
    def _get_repo_format_to_test(self):
 
3655
        from bzrlib.repofmt import knitrepo
 
3656
        return knitrepo.RepositoryFormatKnit1()
1773
3657
 
1774
3658
    @staticmethod
1775
3659
    def is_compatible(source, target):
1776
3660
        """Be compatible with known Knit formats.
1777
 
        
 
3661
 
1778
3662
        We don't test for the stores being of specific types because that
1779
 
        could lead to confusing results, and there is no need to be 
 
3663
        could lead to confusing results, and there is no need to be
1780
3664
        overly general.
1781
3665
        """
 
3666
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
1782
3667
        try:
1783
 
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
1784
 
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
3668
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
3669
                isinstance(target._format, RepositoryFormatKnit))
1785
3670
        except AttributeError:
1786
3671
            return False
1787
 
 
1788
 
    @needs_write_lock
1789
 
    def fetch(self, revision_id=None, pb=None):
1790
 
        """See InterRepository.fetch()."""
1791
 
        from bzrlib.fetch import KnitRepoFetcher
1792
 
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1793
 
               self.source, self.source._format, self.target, self.target._format)
1794
 
        f = KnitRepoFetcher(to_repository=self.target,
1795
 
                            from_repository=self.source,
1796
 
                            last_revision=revision_id,
1797
 
                            pb=pb)
1798
 
        return f.count_copied, f.failed_revisions
 
3672
        return are_knits and InterRepository._same_model(source, target)
1799
3673
 
1800
3674
    @needs_read_lock
1801
 
    def missing_revision_ids(self, revision_id=None):
 
3675
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
1802
3676
        """See InterRepository.missing_revision_ids()."""
1803
3677
        if revision_id is not None:
1804
3678
            source_ids = self.source.get_ancestry(revision_id)
1805
 
            assert source_ids[0] == None
 
3679
            if source_ids[0] is not None:
 
3680
                raise AssertionError()
1806
3681
            source_ids.pop(0)
1807
3682
        else:
1808
 
            source_ids = self.source._all_possible_ids()
 
3683
            source_ids = self.source.all_revision_ids()
1809
3684
        source_ids_set = set(source_ids)
1810
3685
        # source_ids is the worst possible case we may need to pull.
1811
3686
        # now we want to filter source_ids against what we actually
1812
3687
        # have in target, but don't try to check for existence where we know
1813
3688
        # we do not have a revision as that would be pointless.
1814
 
        target_ids = set(self.target._all_possible_ids())
 
3689
        target_ids = set(self.target.all_revision_ids())
1815
3690
        possibly_present_revisions = target_ids.intersection(source_ids_set)
1816
 
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
3691
        actually_present_revisions = set(
 
3692
            self.target._eliminate_revisions_not_present(possibly_present_revisions))
1817
3693
        required_revisions = source_ids_set.difference(actually_present_revisions)
1818
 
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1819
3694
        if revision_id is not None:
1820
3695
            # we used get_ancestry to determine source_ids then we are assured all
1821
3696
            # revisions referenced are present as they are installed in topological order.
1822
3697
            # and the tip revision was validated by get_ancestry.
1823
 
            return required_topo_revisions
 
3698
            result_set = required_revisions
1824
3699
        else:
1825
 
            # if we just grabbed the possibly available ids, then 
 
3700
            # if we just grabbed the possibly available ids, then
1826
3701
            # we only have an estimate of whats available and need to validate
1827
3702
            # that against the revision records.
1828
 
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
1829
 
 
 
3703
            result_set = set(
 
3704
                self.source._eliminate_revisions_not_present(required_revisions))
 
3705
        return self.source.revision_ids_to_search_result(result_set)
 
3706
 
 
3707
 
 
3708
class InterDifferingSerializer(InterRepository):
 
3709
 
 
3710
    @classmethod
 
3711
    def _get_repo_format_to_test(self):
 
3712
        return None
 
3713
 
 
3714
    @staticmethod
 
3715
    def is_compatible(source, target):
 
3716
        """Be compatible with Knit2 source and Knit3 target"""
 
3717
        # This is redundant with format.check_conversion_target(), however that
 
3718
        # raises an exception, and we just want to say "False" as in we won't
 
3719
        # support converting between these formats.
 
3720
        if 'IDS_never' in debug.debug_flags:
 
3721
            return False
 
3722
        if source.supports_rich_root() and not target.supports_rich_root():
 
3723
            return False
 
3724
        if (source._format.supports_tree_reference
 
3725
            and not target._format.supports_tree_reference):
 
3726
            return False
 
3727
        if target._fallback_repositories and target._format.supports_chks:
 
3728
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3729
            # adds to stacked repos.
 
3730
            return False
 
3731
        if 'IDS_always' in debug.debug_flags:
 
3732
            return True
 
3733
        # Only use this code path for local source and target.  IDS does far
 
3734
        # too much IO (both bandwidth and roundtrips) over a network.
 
3735
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3736
            return False
 
3737
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3738
            return False
 
3739
        return True
 
3740
 
 
3741
    def _get_trees(self, revision_ids, cache):
 
3742
        possible_trees = []
 
3743
        for rev_id in revision_ids:
 
3744
            if rev_id in cache:
 
3745
                possible_trees.append((rev_id, cache[rev_id]))
 
3746
            else:
 
3747
                # Not cached, but inventory might be present anyway.
 
3748
                try:
 
3749
                    tree = self.source.revision_tree(rev_id)
 
3750
                except errors.NoSuchRevision:
 
3751
                    # Nope, parent is ghost.
 
3752
                    pass
 
3753
                else:
 
3754
                    cache[rev_id] = tree
 
3755
                    possible_trees.append((rev_id, tree))
 
3756
        return possible_trees
 
3757
 
 
3758
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
 
3759
        """Get the best delta and base for this revision.
 
3760
 
 
3761
        :return: (basis_id, delta)
 
3762
        """
 
3763
        deltas = []
 
3764
        # Generate deltas against each tree, to find the shortest.
 
3765
        texts_possibly_new_in_tree = set()
 
3766
        for basis_id, basis_tree in possible_trees:
 
3767
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3768
            for old_path, new_path, file_id, new_entry in delta:
 
3769
                if new_path is None:
 
3770
                    # This file_id isn't present in the new rev, so we don't
 
3771
                    # care about it.
 
3772
                    continue
 
3773
                if not new_path:
 
3774
                    # Rich roots are handled elsewhere...
 
3775
                    continue
 
3776
                kind = new_entry.kind
 
3777
                if kind != 'directory' and kind != 'file':
 
3778
                    # No text record associated with this inventory entry.
 
3779
                    continue
 
3780
                # This is a directory or file that has changed somehow.
 
3781
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
 
3782
            deltas.append((len(delta), basis_id, delta))
 
3783
        deltas.sort()
 
3784
        return deltas[0][1:]
 
3785
 
 
3786
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3787
        """Find all parent revisions that are absent, but for which the
 
3788
        inventory is present, and copy those inventories.
 
3789
 
 
3790
        This is necessary to preserve correctness when the source is stacked
 
3791
        without fallbacks configured.  (Note that in cases like upgrade the
 
3792
        source may be not have _fallback_repositories even though it is
 
3793
        stacked.)
 
3794
        """
 
3795
        parent_revs = set()
 
3796
        for parents in parent_map.values():
 
3797
            parent_revs.update(parents)
 
3798
        present_parents = self.source.get_parent_map(parent_revs)
 
3799
        absent_parents = set(parent_revs).difference(present_parents)
 
3800
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3801
            (rev_id,) for rev_id in absent_parents)
 
3802
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3803
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3804
            current_revision_id = parent_tree.get_revision_id()
 
3805
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3806
                (current_revision_id,)]
 
3807
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3808
            basis_id = _mod_revision.NULL_REVISION
 
3809
            basis_tree = self.source.revision_tree(basis_id)
 
3810
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3811
            self.target.add_inventory_by_delta(
 
3812
                basis_id, delta, current_revision_id, parents_parents)
 
3813
            cache[current_revision_id] = parent_tree
 
3814
 
 
3815
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3816
        """Fetch across a few revisions.
 
3817
 
 
3818
        :param revision_ids: The revisions to copy
 
3819
        :param basis_id: The revision_id of a tree that must be in cache, used
 
3820
            as a basis for delta when no other base is available
 
3821
        :param cache: A cache of RevisionTrees that we can use.
 
3822
        :return: The revision_id of the last converted tree. The RevisionTree
 
3823
            for it will be in cache
 
3824
        """
 
3825
        # Walk though all revisions; get inventory deltas, copy referenced
 
3826
        # texts that delta references, insert the delta, revision and
 
3827
        # signature.
 
3828
        root_keys_to_create = set()
 
3829
        text_keys = set()
 
3830
        pending_deltas = []
 
3831
        pending_revisions = []
 
3832
        parent_map = self.source.get_parent_map(revision_ids)
 
3833
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3834
        for tree in self.source.revision_trees(revision_ids):
 
3835
            # Find a inventory delta for this revision.
 
3836
            # Find text entries that need to be copied, too.
 
3837
            current_revision_id = tree.get_revision_id()
 
3838
            parent_ids = parent_map.get(current_revision_id, ())
 
3839
            parent_trees = self._get_trees(parent_ids, cache)
 
3840
            possible_trees = list(parent_trees)
 
3841
            if len(possible_trees) == 0:
 
3842
                # There either aren't any parents, or the parents are ghosts,
 
3843
                # so just use the last converted tree.
 
3844
                possible_trees.append((basis_id, cache[basis_id]))
 
3845
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
 
3846
                                                           possible_trees)
 
3847
            revision = self.source.get_revision(current_revision_id)
 
3848
            pending_deltas.append((basis_id, delta,
 
3849
                current_revision_id, revision.parent_ids))
 
3850
            if self._converting_to_rich_root:
 
3851
                self._revision_id_to_root_id[current_revision_id] = \
 
3852
                    tree.get_root_id()
 
3853
            # Determine which texts are in present in this revision but not in
 
3854
            # any of the available parents.
 
3855
            texts_possibly_new_in_tree = set()
 
3856
            for old_path, new_path, file_id, entry in delta:
 
3857
                if new_path is None:
 
3858
                    # This file_id isn't present in the new rev
 
3859
                    continue
 
3860
                if not new_path:
 
3861
                    # This is the root
 
3862
                    if not self.target.supports_rich_root():
 
3863
                        # The target doesn't support rich root, so we don't
 
3864
                        # copy
 
3865
                        continue
 
3866
                    if self._converting_to_rich_root:
 
3867
                        # This can't be copied normally, we have to insert
 
3868
                        # it specially
 
3869
                        root_keys_to_create.add((file_id, entry.revision))
 
3870
                        continue
 
3871
                kind = entry.kind
 
3872
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3873
            for basis_id, basis_tree in possible_trees:
 
3874
                basis_inv = basis_tree.inventory
 
3875
                for file_key in list(texts_possibly_new_in_tree):
 
3876
                    file_id, file_revision = file_key
 
3877
                    try:
 
3878
                        entry = basis_inv[file_id]
 
3879
                    except errors.NoSuchId:
 
3880
                        continue
 
3881
                    if entry.revision == file_revision:
 
3882
                        texts_possibly_new_in_tree.remove(file_key)
 
3883
            text_keys.update(texts_possibly_new_in_tree)
 
3884
            pending_revisions.append(revision)
 
3885
            cache[current_revision_id] = tree
 
3886
            basis_id = current_revision_id
 
3887
        # Copy file texts
 
3888
        from_texts = self.source.texts
 
3889
        to_texts = self.target.texts
 
3890
        if root_keys_to_create:
 
3891
            from bzrlib.fetch import _new_root_data_stream
 
3892
            root_stream = _new_root_data_stream(
 
3893
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3894
                self.source)
 
3895
            to_texts.insert_record_stream(root_stream)
 
3896
        to_texts.insert_record_stream(from_texts.get_record_stream(
 
3897
            text_keys, self.target._format._fetch_order,
 
3898
            not self.target._format._fetch_uses_deltas))
 
3899
        # insert inventory deltas
 
3900
        for delta in pending_deltas:
 
3901
            self.target.add_inventory_by_delta(*delta)
 
3902
        if self.target._fallback_repositories:
 
3903
            # Make sure this stacked repository has all the parent inventories
 
3904
            # for the new revisions that we are about to insert.  We do this
 
3905
            # before adding the revisions so that no revision is added until
 
3906
            # all the inventories it may depend on are added.
 
3907
            # Note that this is overzealous, as we may have fetched these in an
 
3908
            # earlier batch.
 
3909
            parent_ids = set()
 
3910
            revision_ids = set()
 
3911
            for revision in pending_revisions:
 
3912
                revision_ids.add(revision.revision_id)
 
3913
                parent_ids.update(revision.parent_ids)
 
3914
            parent_ids.difference_update(revision_ids)
 
3915
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3916
            parent_map = self.source.get_parent_map(parent_ids)
 
3917
            # we iterate over parent_map and not parent_ids because we don't
 
3918
            # want to try copying any revision which is a ghost
 
3919
            for parent_tree in self.source.revision_trees(parent_map):
 
3920
                current_revision_id = parent_tree.get_revision_id()
 
3921
                parents_parents = parent_map[current_revision_id]
 
3922
                possible_trees = self._get_trees(parents_parents, cache)
 
3923
                if len(possible_trees) == 0:
 
3924
                    # There either aren't any parents, or the parents are
 
3925
                    # ghosts, so just use the last converted tree.
 
3926
                    possible_trees.append((basis_id, cache[basis_id]))
 
3927
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3928
                    parents_parents, possible_trees)
 
3929
                self.target.add_inventory_by_delta(
 
3930
                    basis_id, delta, current_revision_id, parents_parents)
 
3931
        # insert signatures and revisions
 
3932
        for revision in pending_revisions:
 
3933
            try:
 
3934
                signature = self.source.get_signature_text(
 
3935
                    revision.revision_id)
 
3936
                self.target.add_signature_text(revision.revision_id,
 
3937
                    signature)
 
3938
            except errors.NoSuchRevision:
 
3939
                pass
 
3940
            self.target.add_revision(revision.revision_id, revision)
 
3941
        return basis_id
 
3942
 
 
3943
    def _fetch_all_revisions(self, revision_ids, pb):
 
3944
        """Fetch everything for the list of revisions.
 
3945
 
 
3946
        :param revision_ids: The list of revisions to fetch. Must be in
 
3947
            topological order.
 
3948
        :param pb: A ProgressTask
 
3949
        :return: None
 
3950
        """
 
3951
        basis_id, basis_tree = self._get_basis(revision_ids[0])
 
3952
        batch_size = 100
 
3953
        cache = lru_cache.LRUCache(100)
 
3954
        cache[basis_id] = basis_tree
 
3955
        del basis_tree # We don't want to hang on to it here
 
3956
        hints = []
 
3957
        for offset in range(0, len(revision_ids), batch_size):
 
3958
            self.target.start_write_group()
 
3959
            try:
 
3960
                pb.update('Transferring revisions', offset,
 
3961
                          len(revision_ids))
 
3962
                batch = revision_ids[offset:offset+batch_size]
 
3963
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
3964
            except:
 
3965
                self.target.abort_write_group()
 
3966
                raise
 
3967
            else:
 
3968
                hint = self.target.commit_write_group()
 
3969
                if hint:
 
3970
                    hints.extend(hint)
 
3971
        if hints and self.target._format.pack_compresses:
 
3972
            self.target.pack(hint=hints)
 
3973
        pb.update('Transferring revisions', len(revision_ids),
 
3974
                  len(revision_ids))
 
3975
 
 
3976
    @needs_write_lock
 
3977
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3978
            fetch_spec=None):
 
3979
        """See InterRepository.fetch()."""
 
3980
        if fetch_spec is not None:
 
3981
            raise AssertionError("Not implemented yet...")
 
3982
        if (not self.source.supports_rich_root()
 
3983
            and self.target.supports_rich_root()):
 
3984
            self._converting_to_rich_root = True
 
3985
            self._revision_id_to_root_id = {}
 
3986
        else:
 
3987
            self._converting_to_rich_root = False
 
3988
        revision_ids = self.target.search_missing_revision_ids(self.source,
 
3989
            revision_id, find_ghosts=find_ghosts).get_keys()
 
3990
        if not revision_ids:
 
3991
            return 0, 0
 
3992
        revision_ids = tsort.topo_sort(
 
3993
            self.source.get_graph().get_parent_map(revision_ids))
 
3994
        if not revision_ids:
 
3995
            return 0, 0
 
3996
        # Walk though all revisions; get inventory deltas, copy referenced
 
3997
        # texts that delta references, insert the delta, revision and
 
3998
        # signature.
 
3999
        if pb is None:
 
4000
            my_pb = ui.ui_factory.nested_progress_bar()
 
4001
            pb = my_pb
 
4002
        else:
 
4003
            symbol_versioning.warn(
 
4004
                symbol_versioning.deprecated_in((1, 14, 0))
 
4005
                % "pb parameter to fetch()")
 
4006
            my_pb = None
 
4007
        try:
 
4008
            self._fetch_all_revisions(revision_ids, pb)
 
4009
        finally:
 
4010
            if my_pb is not None:
 
4011
                my_pb.finished()
 
4012
        return len(revision_ids), 0
 
4013
 
 
4014
    def _get_basis(self, first_revision_id):
 
4015
        """Get a revision and tree which exists in the target.
 
4016
 
 
4017
        This assumes that first_revision_id is selected for transmission
 
4018
        because all other ancestors are already present. If we can't find an
 
4019
        ancestor we fall back to NULL_REVISION since we know that is safe.
 
4020
 
 
4021
        :return: (basis_id, basis_tree)
 
4022
        """
 
4023
        first_rev = self.source.get_revision(first_revision_id)
 
4024
        try:
 
4025
            basis_id = first_rev.parent_ids[0]
 
4026
            # only valid as a basis if the target has it
 
4027
            self.target.get_revision(basis_id)
 
4028
            # Try to get a basis tree - if its a ghost it will hit the
 
4029
            # NoSuchRevision case.
 
4030
            basis_tree = self.source.revision_tree(basis_id)
 
4031
        except (IndexError, errors.NoSuchRevision):
 
4032
            basis_id = _mod_revision.NULL_REVISION
 
4033
            basis_tree = self.source.revision_tree(basis_id)
 
4034
        return basis_id, basis_tree
 
4035
 
 
4036
 
 
4037
InterRepository.register_optimiser(InterDifferingSerializer)
 
4038
InterRepository.register_optimiser(InterSameDataRepository)
1830
4039
InterRepository.register_optimiser(InterWeaveRepo)
1831
4040
InterRepository.register_optimiser(InterKnitRepo)
1832
4041
 
1833
4042
 
1834
 
class RepositoryTestProviderAdapter(object):
1835
 
    """A tool to generate a suite testing multiple repository formats at once.
1836
 
 
1837
 
    This is done by copying the test once for each transport and injecting
1838
 
    the transport_server, transport_readonly_server, and bzrdir_format and
1839
 
    repository_format classes into each copy. Each copy is also given a new id()
1840
 
    to make it easy to identify.
1841
 
    """
1842
 
 
1843
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1844
 
        self._transport_server = transport_server
1845
 
        self._transport_readonly_server = transport_readonly_server
1846
 
        self._formats = formats
1847
 
    
1848
 
    def adapt(self, test):
1849
 
        result = TestSuite()
1850
 
        for repository_format, bzrdir_format in self._formats:
1851
 
            new_test = deepcopy(test)
1852
 
            new_test.transport_server = self._transport_server
1853
 
            new_test.transport_readonly_server = self._transport_readonly_server
1854
 
            new_test.bzrdir_format = bzrdir_format
1855
 
            new_test.repository_format = repository_format
1856
 
            def make_new_test_id():
1857
 
                new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
1858
 
                return lambda: new_id
1859
 
            new_test.id = make_new_test_id()
1860
 
            result.addTest(new_test)
1861
 
        return result
1862
 
 
1863
 
 
1864
 
class InterRepositoryTestProviderAdapter(object):
1865
 
    """A tool to generate a suite testing multiple inter repository formats.
1866
 
 
1867
 
    This is done by copying the test once for each interrepo provider and injecting
1868
 
    the transport_server, transport_readonly_server, repository_format and 
1869
 
    repository_to_format classes into each copy.
1870
 
    Each copy is also given a new id() to make it easy to identify.
1871
 
    """
1872
 
 
1873
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1874
 
        self._transport_server = transport_server
1875
 
        self._transport_readonly_server = transport_readonly_server
1876
 
        self._formats = formats
1877
 
    
1878
 
    def adapt(self, test):
1879
 
        result = TestSuite()
1880
 
        for interrepo_class, repository_format, repository_format_to in self._formats:
1881
 
            new_test = deepcopy(test)
1882
 
            new_test.transport_server = self._transport_server
1883
 
            new_test.transport_readonly_server = self._transport_readonly_server
1884
 
            new_test.interrepo_class = interrepo_class
1885
 
            new_test.repository_format = repository_format
1886
 
            new_test.repository_format_to = repository_format_to
1887
 
            def make_new_test_id():
1888
 
                new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
1889
 
                return lambda: new_id
1890
 
            new_test.id = make_new_test_id()
1891
 
            result.addTest(new_test)
1892
 
        return result
1893
 
 
1894
 
    @staticmethod
1895
 
    def default_test_list():
1896
 
        """Generate the default list of interrepo permutations to test."""
1897
 
        result = []
1898
 
        # test the default InterRepository between format 6 and the current 
1899
 
        # default format.
1900
 
        # XXX: robertc 20060220 reinstate this when there are two supported
1901
 
        # formats which do not have an optimal code path between them.
1902
 
        result.append((InterRepository,
1903
 
                       RepositoryFormat6(),
1904
 
                       RepositoryFormatKnit1()))
1905
 
        for optimiser in InterRepository._optimisers:
1906
 
            result.append((optimiser,
1907
 
                           optimiser._matching_repo_format,
1908
 
                           optimiser._matching_repo_format
1909
 
                           ))
1910
 
        # if there are specific combinations we want to use, we can add them 
1911
 
        # here.
1912
 
        return result
1913
 
 
1914
 
 
1915
4043
class CopyConverter(object):
1916
4044
    """A repository conversion tool which just performs a copy of the content.
1917
 
    
 
4045
 
1918
4046
    This is slow but quite reliable.
1919
4047
    """
1920
4048
 
1924
4052
        :param target_format: The format the resulting repository should be.
1925
4053
        """
1926
4054
        self.target_format = target_format
1927
 
        
 
4055
 
1928
4056
    def convert(self, repo, pb):
1929
4057
        """Perform the conversion of to_convert, giving feedback via pb.
1930
4058
 
1941
4069
        self.step('Moving repository to repository.backup')
1942
4070
        self.repo_dir.transport.move('repository', 'repository.backup')
1943
4071
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
4072
        repo._format.check_conversion_target(self.target_format)
1944
4073
        self.source_repo = repo._format.open(self.repo_dir,
1945
4074
            _found=True,
1946
4075
            _override_transport=backup_transport)
1949
4078
                                                  self.source_repo.is_shared())
1950
4079
        converted.lock_write()
1951
4080
        try:
1952
 
            self.step('Copying content into repository.')
 
4081
            self.step('Copying content')
1953
4082
            self.source_repo.copy_content_into(converted)
1954
4083
        finally:
1955
4084
            converted.unlock()
1956
 
        self.step('Deleting old repository content.')
 
4085
        self.step('Deleting old repository content')
1957
4086
        self.repo_dir.transport.delete_tree('repository.backup')
1958
4087
        self.pb.note('repository converted')
1959
4088
 
1963
4092
        self.pb.update(message, self.count, self.total)
1964
4093
 
1965
4094
 
1966
 
class CommitBuilder(object):
1967
 
    """Provides an interface to build up a commit.
1968
 
 
1969
 
    This allows describing a tree to be committed without needing to 
1970
 
    know the internals of the format of the repository.
1971
 
    """
1972
 
    def __init__(self, repository, parents, config, timestamp=None, 
1973
 
                 timezone=None, committer=None, revprops=None, 
1974
 
                 revision_id=None):
1975
 
        """Initiate a CommitBuilder.
1976
 
 
1977
 
        :param repository: Repository to commit to.
1978
 
        :param parents: Revision ids of the parents of the new revision.
1979
 
        :param config: Configuration to use.
1980
 
        :param timestamp: Optional timestamp recorded for commit.
1981
 
        :param timezone: Optional timezone for timestamp.
1982
 
        :param committer: Optional committer to set for commit.
1983
 
        :param revprops: Optional dictionary of revision properties.
1984
 
        :param revision_id: Optional revision id.
1985
 
        """
1986
 
        self._config = config
1987
 
 
1988
 
        if committer is None:
1989
 
            self._committer = self._config.username()
1990
 
        else:
1991
 
            assert isinstance(committer, basestring), type(committer)
1992
 
            self._committer = committer
1993
 
 
1994
 
        self.new_inventory = Inventory()
1995
 
        self._new_revision_id = revision_id
1996
 
        self.parents = parents
1997
 
        self.repository = repository
1998
 
 
1999
 
        self._revprops = {}
2000
 
        if revprops is not None:
2001
 
            self._revprops.update(revprops)
2002
 
 
2003
 
        if timestamp is None:
2004
 
            timestamp = time.time()
2005
 
        # Restrict resolution to 1ms
2006
 
        self._timestamp = round(timestamp, 3)
2007
 
 
2008
 
        if timezone is None:
2009
 
            self._timezone = local_time_offset()
2010
 
        else:
2011
 
            self._timezone = int(timezone)
2012
 
 
2013
 
        self._generate_revision_if_needed()
2014
 
 
2015
 
    def commit(self, message):
2016
 
        """Make the actual commit.
2017
 
 
2018
 
        :return: The revision id of the recorded revision.
2019
 
        """
2020
 
        rev = Revision(timestamp=self._timestamp,
2021
 
                       timezone=self._timezone,
2022
 
                       committer=self._committer,
2023
 
                       message=message,
2024
 
                       inventory_sha1=self.inv_sha1,
2025
 
                       revision_id=self._new_revision_id,
2026
 
                       properties=self._revprops)
2027
 
        rev.parent_ids = self.parents
2028
 
        self.repository.add_revision(self._new_revision_id, rev, 
2029
 
            self.new_inventory, self._config)
2030
 
        return self._new_revision_id
2031
 
 
2032
 
    def finish_inventory(self):
2033
 
        """Tell the builder that the inventory is finished."""
2034
 
        self.new_inventory.revision_id = self._new_revision_id
2035
 
        self.inv_sha1 = self.repository.add_inventory(
2036
 
            self._new_revision_id,
2037
 
            self.new_inventory,
2038
 
            self.parents
2039
 
            )
2040
 
 
2041
 
    def _gen_revision_id(self):
2042
 
        """Return new revision-id."""
2043
 
        s = '%s-%s-' % (self._config.user_email(), 
2044
 
                        compact_date(self._timestamp))
2045
 
        s += hexlify(rand_bytes(8))
2046
 
        return s
2047
 
 
2048
 
    def _generate_revision_if_needed(self):
2049
 
        """Create a revision id if None was supplied.
2050
 
        
2051
 
        If the repository can not support user-specified revision ids
2052
 
        they should override this function and raise UnsupportedOperation
2053
 
        if _new_revision_id is not None.
2054
 
 
2055
 
        :raises: UnsupportedOperation
2056
 
        """
2057
 
        if self._new_revision_id is None:
2058
 
            self._new_revision_id = self._gen_revision_id()
2059
 
 
2060
 
    def record_entry_contents(self, ie, parent_invs, path, tree):
2061
 
        """Record the content of ie from tree into the commit if needed.
2062
 
 
2063
 
        :param ie: An inventory entry present in the commit.
2064
 
        :param parent_invs: The inventories of the parent revisions of the
2065
 
            commit.
2066
 
        :param path: The path the entry is at in the tree.
2067
 
        :param tree: The tree which contains this entry and should be used to 
2068
 
        obtain content.
2069
 
        """
2070
 
        self.new_inventory.add(ie)
2071
 
 
2072
 
        # ie.revision is always None if the InventoryEntry is considered
2073
 
        # for committing. ie.snapshot will record the correct revision 
2074
 
        # which may be the sole parent if it is untouched.
2075
 
        if ie.revision is not None:
2076
 
            return
2077
 
        previous_entries = ie.find_previous_heads(
2078
 
            parent_invs,
2079
 
            self.repository.weave_store,
2080
 
            self.repository.get_transaction())
2081
 
        # we are creating a new revision for ie in the history store
2082
 
        # and inventory.
2083
 
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2084
 
 
2085
 
    def modified_directory(self, file_id, file_parents):
2086
 
        """Record the presence of a symbolic link.
2087
 
 
2088
 
        :param file_id: The file_id of the link to record.
2089
 
        :param file_parents: The per-file parent revision ids.
2090
 
        """
2091
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2092
 
    
2093
 
    def modified_file_text(self, file_id, file_parents,
2094
 
                           get_content_byte_lines, text_sha1=None,
2095
 
                           text_size=None):
2096
 
        """Record the text of file file_id
2097
 
 
2098
 
        :param file_id: The file_id of the file to record the text of.
2099
 
        :param file_parents: The per-file parent revision ids.
2100
 
        :param get_content_byte_lines: A callable which will return the byte
2101
 
            lines for the file.
2102
 
        :param text_sha1: Optional SHA1 of the file contents.
2103
 
        :param text_size: Optional size of the file contents.
2104
 
        """
2105
 
        # mutter('storing text of file {%s} in revision {%s} into %r',
2106
 
        #        file_id, self._new_revision_id, self.repository.weave_store)
2107
 
        # special case to avoid diffing on renames or 
2108
 
        # reparenting
2109
 
        if (len(file_parents) == 1
2110
 
            and text_sha1 == file_parents.values()[0].text_sha1
2111
 
            and text_size == file_parents.values()[0].text_size):
2112
 
            previous_ie = file_parents.values()[0]
2113
 
            versionedfile = self.repository.weave_store.get_weave(file_id, 
2114
 
                self.repository.get_transaction())
2115
 
            versionedfile.clone_text(self._new_revision_id, 
2116
 
                previous_ie.revision, file_parents.keys())
2117
 
            return text_sha1, text_size
2118
 
        else:
2119
 
            new_lines = get_content_byte_lines()
2120
 
            # TODO: Rather than invoking sha_strings here, _add_text_to_weave
2121
 
            # should return the SHA1 and size
2122
 
            self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2123
 
            return osutils.sha_strings(new_lines), \
2124
 
                sum(map(len, new_lines))
2125
 
 
2126
 
    def modified_link(self, file_id, file_parents, link_target):
2127
 
        """Record the presence of a symbolic link.
2128
 
 
2129
 
        :param file_id: The file_id of the link to record.
2130
 
        :param file_parents: The per-file parent revision ids.
2131
 
        :param link_target: Target location of this link.
2132
 
        """
2133
 
        self._add_text_to_weave(file_id, [], file_parents.keys())
2134
 
 
2135
 
    def _add_text_to_weave(self, file_id, new_lines, parents):
2136
 
        versionedfile = self.repository.weave_store.get_weave_or_empty(
2137
 
            file_id, self.repository.get_transaction())
2138
 
        versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2139
 
        versionedfile.clear_cache()
2140
 
 
2141
 
 
2142
4095
_unescape_map = {
2143
4096
    'apos':"'",
2144
4097
    'quot':'"',
2149
4102
 
2150
4103
 
2151
4104
def _unescaper(match, _map=_unescape_map):
2152
 
    return _map[match.group(1)]
 
4105
    code = match.group(1)
 
4106
    try:
 
4107
        return _map[code]
 
4108
    except KeyError:
 
4109
        if not code.startswith('#'):
 
4110
            raise
 
4111
        return unichr(int(code[1:])).encode('utf8')
2153
4112
 
2154
4113
 
2155
4114
_unescape_re = None
2159
4118
    """Unescape predefined XML entities in a string of data."""
2160
4119
    global _unescape_re
2161
4120
    if _unescape_re is None:
2162
 
        _unescape_re = re.compile('\&([^;]*);')
 
4121
        _unescape_re = re.compile('\&([^;]*);')
2163
4122
    return _unescape_re.sub(_unescaper, data)
 
4123
 
 
4124
 
 
4125
class _VersionedFileChecker(object):
 
4126
 
 
4127
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
4128
        self.repository = repository
 
4129
        self.text_index = self.repository._generate_text_key_index(
 
4130
            text_key_references=text_key_references, ancestors=ancestors)
 
4131
 
 
4132
    def calculate_file_version_parents(self, text_key):
 
4133
        """Calculate the correct parents for a file version according to
 
4134
        the inventories.
 
4135
        """
 
4136
        parent_keys = self.text_index[text_key]
 
4137
        if parent_keys == [_mod_revision.NULL_REVISION]:
 
4138
            return ()
 
4139
        return tuple(parent_keys)
 
4140
 
 
4141
    def check_file_version_parents(self, texts, progress_bar=None):
 
4142
        """Check the parents stored in a versioned file are correct.
 
4143
 
 
4144
        It also detects file versions that are not referenced by their
 
4145
        corresponding revision's inventory.
 
4146
 
 
4147
        :returns: A tuple of (wrong_parents, dangling_file_versions).
 
4148
            wrong_parents is a dict mapping {revision_id: (stored_parents,
 
4149
            correct_parents)} for each revision_id where the stored parents
 
4150
            are not correct.  dangling_file_versions is a set of (file_id,
 
4151
            revision_id) tuples for versions that are present in this versioned
 
4152
            file, but not used by the corresponding inventory.
 
4153
        """
 
4154
        local_progress = None
 
4155
        if progress_bar is None:
 
4156
            local_progress = ui.ui_factory.nested_progress_bar()
 
4157
            progress_bar = local_progress
 
4158
        try:
 
4159
            return self._check_file_version_parents(texts, progress_bar)
 
4160
        finally:
 
4161
            if local_progress:
 
4162
                local_progress.finished()
 
4163
 
 
4164
    def _check_file_version_parents(self, texts, progress_bar):
 
4165
        """See check_file_version_parents."""
 
4166
        wrong_parents = {}
 
4167
        self.file_ids = set([file_id for file_id, _ in
 
4168
            self.text_index.iterkeys()])
 
4169
        # text keys is now grouped by file_id
 
4170
        n_versions = len(self.text_index)
 
4171
        progress_bar.update('loading text store', 0, n_versions)
 
4172
        parent_map = self.repository.texts.get_parent_map(self.text_index)
 
4173
        # On unlistable transports this could well be empty/error...
 
4174
        text_keys = self.repository.texts.keys()
 
4175
        unused_keys = frozenset(text_keys) - set(self.text_index)
 
4176
        for num, key in enumerate(self.text_index.iterkeys()):
 
4177
            progress_bar.update('checking text graph', num, n_versions)
 
4178
            correct_parents = self.calculate_file_version_parents(key)
 
4179
            try:
 
4180
                knit_parents = parent_map[key]
 
4181
            except errors.RevisionNotPresent:
 
4182
                # Missing text!
 
4183
                knit_parents = None
 
4184
            if correct_parents != knit_parents:
 
4185
                wrong_parents[key] = (knit_parents, correct_parents)
 
4186
        return wrong_parents, unused_keys
 
4187
 
 
4188
 
 
4189
def _old_get_graph(repository, revision_id):
 
4190
    """DO NOT USE. That is all. I'm serious."""
 
4191
    graph = repository.get_graph()
 
4192
    revision_graph = dict(((key, value) for key, value in
 
4193
        graph.iter_ancestry([revision_id]) if value is not None))
 
4194
    return _strip_NULL_ghosts(revision_graph)
 
4195
 
 
4196
 
 
4197
def _strip_NULL_ghosts(revision_graph):
 
4198
    """Also don't use this. more compatibility code for unmigrated clients."""
 
4199
    # Filter ghosts, and null:
 
4200
    if _mod_revision.NULL_REVISION in revision_graph:
 
4201
        del revision_graph[_mod_revision.NULL_REVISION]
 
4202
    for key, parents in revision_graph.items():
 
4203
        revision_graph[key] = tuple(parent for parent in parents if parent
 
4204
            in revision_graph)
 
4205
    return revision_graph
 
4206
 
 
4207
 
 
4208
class StreamSink(object):
 
4209
    """An object that can insert a stream into a repository.
 
4210
 
 
4211
    This interface handles the complexity of reserialising inventories and
 
4212
    revisions from different formats, and allows unidirectional insertion into
 
4213
    stacked repositories without looking for the missing basis parents
 
4214
    beforehand.
 
4215
    """
 
4216
 
 
4217
    def __init__(self, target_repo):
 
4218
        self.target_repo = target_repo
 
4219
 
 
4220
    def insert_stream(self, stream, src_format, resume_tokens):
 
4221
        """Insert a stream's content into the target repository.
 
4222
 
 
4223
        :param src_format: a bzr repository format.
 
4224
 
 
4225
        :return: a list of resume tokens and an  iterable of keys additional
 
4226
            items required before the insertion can be completed.
 
4227
        """
 
4228
        self.target_repo.lock_write()
 
4229
        try:
 
4230
            if resume_tokens:
 
4231
                self.target_repo.resume_write_group(resume_tokens)
 
4232
                is_resume = True
 
4233
            else:
 
4234
                self.target_repo.start_write_group()
 
4235
                is_resume = False
 
4236
            try:
 
4237
                # locked_insert_stream performs a commit|suspend.
 
4238
                return self._locked_insert_stream(stream, src_format, is_resume)
 
4239
            except:
 
4240
                self.target_repo.abort_write_group(suppress_errors=True)
 
4241
                raise
 
4242
        finally:
 
4243
            self.target_repo.unlock()
 
4244
 
 
4245
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
4246
        to_serializer = self.target_repo._format._serializer
 
4247
        src_serializer = src_format._serializer
 
4248
        new_pack = None
 
4249
        if to_serializer == src_serializer:
 
4250
            # If serializers match and the target is a pack repository, set the
 
4251
            # write cache size on the new pack.  This avoids poor performance
 
4252
            # on transports where append is unbuffered (such as
 
4253
            # RemoteTransport).  This is safe to do because nothing should read
 
4254
            # back from the target repository while a stream with matching
 
4255
            # serialization is being inserted.
 
4256
            # The exception is that a delta record from the source that should
 
4257
            # be a fulltext may need to be expanded by the target (see
 
4258
            # test_fetch_revisions_with_deltas_into_pack); but we take care to
 
4259
            # explicitly flush any buffered writes first in that rare case.
 
4260
            try:
 
4261
                new_pack = self.target_repo._pack_collection._new_pack
 
4262
            except AttributeError:
 
4263
                # Not a pack repository
 
4264
                pass
 
4265
            else:
 
4266
                new_pack.set_write_cache_size(1024*1024)
 
4267
        for substream_type, substream in stream:
 
4268
            if 'stream' in debug.debug_flags:
 
4269
                mutter('inserting substream: %s', substream_type)
 
4270
            if substream_type == 'texts':
 
4271
                self.target_repo.texts.insert_record_stream(substream)
 
4272
            elif substream_type == 'inventories':
 
4273
                if src_serializer == to_serializer:
 
4274
                    self.target_repo.inventories.insert_record_stream(
 
4275
                        substream)
 
4276
                else:
 
4277
                    self._extract_and_insert_inventories(
 
4278
                        substream, src_serializer)
 
4279
            elif substream_type == 'inventory-deltas':
 
4280
                self._extract_and_insert_inventory_deltas(
 
4281
                    substream, src_serializer)
 
4282
            elif substream_type == 'chk_bytes':
 
4283
                # XXX: This doesn't support conversions, as it assumes the
 
4284
                #      conversion was done in the fetch code.
 
4285
                self.target_repo.chk_bytes.insert_record_stream(substream)
 
4286
            elif substream_type == 'revisions':
 
4287
                # This may fallback to extract-and-insert more often than
 
4288
                # required if the serializers are different only in terms of
 
4289
                # the inventory.
 
4290
                if src_serializer == to_serializer:
 
4291
                    self.target_repo.revisions.insert_record_stream(
 
4292
                        substream)
 
4293
                else:
 
4294
                    self._extract_and_insert_revisions(substream,
 
4295
                        src_serializer)
 
4296
            elif substream_type == 'signatures':
 
4297
                self.target_repo.signatures.insert_record_stream(substream)
 
4298
            else:
 
4299
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4300
        # Done inserting data, and the missing_keys calculations will try to
 
4301
        # read back from the inserted data, so flush the writes to the new pack
 
4302
        # (if this is pack format).
 
4303
        if new_pack is not None:
 
4304
            new_pack._write_data('', flush=True)
 
4305
        # Find all the new revisions (including ones from resume_tokens)
 
4306
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4307
            check_for_missing_texts=is_resume)
 
4308
        try:
 
4309
            for prefix, versioned_file in (
 
4310
                ('texts', self.target_repo.texts),
 
4311
                ('inventories', self.target_repo.inventories),
 
4312
                ('revisions', self.target_repo.revisions),
 
4313
                ('signatures', self.target_repo.signatures),
 
4314
                ('chk_bytes', self.target_repo.chk_bytes),
 
4315
                ):
 
4316
                if versioned_file is None:
 
4317
                    continue
 
4318
                missing_keys.update((prefix,) + key for key in
 
4319
                    versioned_file.get_missing_compression_parent_keys())
 
4320
        except NotImplementedError:
 
4321
            # cannot even attempt suspending, and missing would have failed
 
4322
            # during stream insertion.
 
4323
            missing_keys = set()
 
4324
        else:
 
4325
            if missing_keys:
 
4326
                # suspend the write group and tell the caller what we is
 
4327
                # missing. We know we can suspend or else we would not have
 
4328
                # entered this code path. (All repositories that can handle
 
4329
                # missing keys can handle suspending a write group).
 
4330
                write_group_tokens = self.target_repo.suspend_write_group()
 
4331
                return write_group_tokens, missing_keys
 
4332
        hint = self.target_repo.commit_write_group()
 
4333
        if (to_serializer != src_serializer and
 
4334
            self.target_repo._format.pack_compresses):
 
4335
            self.target_repo.pack(hint=hint)
 
4336
        return [], set()
 
4337
 
 
4338
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4339
        target_rich_root = self.target_repo._format.rich_root_data
 
4340
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4341
        for record in substream:
 
4342
            # Insert the delta directly
 
4343
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4344
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4345
            try:
 
4346
                parse_result = deserialiser.parse_text_bytes(
 
4347
                    inventory_delta_bytes)
 
4348
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4349
                trace.mutter("Incompatible delta: %s", err.msg)
 
4350
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4351
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4352
            revision_id = new_id
 
4353
            parents = [key[0] for key in record.parents]
 
4354
            self.target_repo.add_inventory_by_delta(
 
4355
                basis_id, inv_delta, revision_id, parents)
 
4356
 
 
4357
    def _extract_and_insert_inventories(self, substream, serializer,
 
4358
            parse_delta=None):
 
4359
        """Generate a new inventory versionedfile in target, converting data.
 
4360
 
 
4361
        The inventory is retrieved from the source, (deserializing it), and
 
4362
        stored in the target (reserializing it in a different format).
 
4363
        """
 
4364
        target_rich_root = self.target_repo._format.rich_root_data
 
4365
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4366
        for record in substream:
 
4367
            # It's not a delta, so it must be a fulltext in the source
 
4368
            # serializer's format.
 
4369
            bytes = record.get_bytes_as('fulltext')
 
4370
            revision_id = record.key[0]
 
4371
            inv = serializer.read_inventory_from_string(bytes, revision_id)
 
4372
            parents = [key[0] for key in record.parents]
 
4373
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4374
            # No need to keep holding this full inv in memory when the rest of
 
4375
            # the substream is likely to be all deltas.
 
4376
            del inv
 
4377
 
 
4378
    def _extract_and_insert_revisions(self, substream, serializer):
 
4379
        for record in substream:
 
4380
            bytes = record.get_bytes_as('fulltext')
 
4381
            revision_id = record.key[0]
 
4382
            rev = serializer.read_revision_from_string(bytes)
 
4383
            if rev.revision_id != revision_id:
 
4384
                raise AssertionError('wtf: %s != %s' % (rev, revision_id))
 
4385
            self.target_repo.add_revision(revision_id, rev)
 
4386
 
 
4387
    def finished(self):
 
4388
        if self.target_repo._format._fetch_reconcile:
 
4389
            self.target_repo.reconcile()
 
4390
 
 
4391
 
 
4392
class StreamSource(object):
 
4393
    """A source of a stream for fetching between repositories."""
 
4394
 
 
4395
    def __init__(self, from_repository, to_format):
 
4396
        """Create a StreamSource streaming from from_repository."""
 
4397
        self.from_repository = from_repository
 
4398
        self.to_format = to_format
 
4399
 
 
4400
    def delta_on_metadata(self):
 
4401
        """Return True if delta's are permitted on metadata streams.
 
4402
 
 
4403
        That is on revisions and signatures.
 
4404
        """
 
4405
        src_serializer = self.from_repository._format._serializer
 
4406
        target_serializer = self.to_format._serializer
 
4407
        return (self.to_format._fetch_uses_deltas and
 
4408
            src_serializer == target_serializer)
 
4409
 
 
4410
    def _fetch_revision_texts(self, revs):
 
4411
        # fetch signatures first and then the revision texts
 
4412
        # may need to be a InterRevisionStore call here.
 
4413
        from_sf = self.from_repository.signatures
 
4414
        # A missing signature is just skipped.
 
4415
        keys = [(rev_id,) for rev_id in revs]
 
4416
        signatures = versionedfile.filter_absent(from_sf.get_record_stream(
 
4417
            keys,
 
4418
            self.to_format._fetch_order,
 
4419
            not self.to_format._fetch_uses_deltas))
 
4420
        # If a revision has a delta, this is actually expanded inside the
 
4421
        # insert_record_stream code now, which is an alternate fix for
 
4422
        # bug #261339
 
4423
        from_rf = self.from_repository.revisions
 
4424
        revisions = from_rf.get_record_stream(
 
4425
            keys,
 
4426
            self.to_format._fetch_order,
 
4427
            not self.delta_on_metadata())
 
4428
        return [('signatures', signatures), ('revisions', revisions)]
 
4429
 
 
4430
    def _generate_root_texts(self, revs):
 
4431
        """This will be called by get_stream between fetching weave texts and
 
4432
        fetching the inventory weave.
 
4433
        """
 
4434
        if self._rich_root_upgrade():
 
4435
            import bzrlib.fetch
 
4436
            return bzrlib.fetch.Inter1and2Helper(
 
4437
                self.from_repository).generate_root_texts(revs)
 
4438
        else:
 
4439
            return []
 
4440
 
 
4441
    def get_stream(self, search):
 
4442
        phase = 'file'
 
4443
        revs = search.get_keys()
 
4444
        graph = self.from_repository.get_graph()
 
4445
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
4446
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
 
4447
        text_keys = []
 
4448
        for knit_kind, file_id, revisions in data_to_fetch:
 
4449
            if knit_kind != phase:
 
4450
                phase = knit_kind
 
4451
                # Make a new progress bar for this phase
 
4452
            if knit_kind == "file":
 
4453
                # Accumulate file texts
 
4454
                text_keys.extend([(file_id, revision) for revision in
 
4455
                    revisions])
 
4456
            elif knit_kind == "inventory":
 
4457
                # Now copy the file texts.
 
4458
                from_texts = self.from_repository.texts
 
4459
                yield ('texts', from_texts.get_record_stream(
 
4460
                    text_keys, self.to_format._fetch_order,
 
4461
                    not self.to_format._fetch_uses_deltas))
 
4462
                # Cause an error if a text occurs after we have done the
 
4463
                # copy.
 
4464
                text_keys = None
 
4465
                # Before we process the inventory we generate the root
 
4466
                # texts (if necessary) so that the inventories references
 
4467
                # will be valid.
 
4468
                for _ in self._generate_root_texts(revs):
 
4469
                    yield _
 
4470
                # we fetch only the referenced inventories because we do not
 
4471
                # know for unselected inventories whether all their required
 
4472
                # texts are present in the other repository - it could be
 
4473
                # corrupt.
 
4474
                for info in self._get_inventory_stream(revs):
 
4475
                    yield info
 
4476
            elif knit_kind == "signatures":
 
4477
                # Nothing to do here; this will be taken care of when
 
4478
                # _fetch_revision_texts happens.
 
4479
                pass
 
4480
            elif knit_kind == "revisions":
 
4481
                for record in self._fetch_revision_texts(revs):
 
4482
                    yield record
 
4483
            else:
 
4484
                raise AssertionError("Unknown knit kind %r" % knit_kind)
 
4485
 
 
4486
    def get_stream_for_missing_keys(self, missing_keys):
 
4487
        # missing keys can only occur when we are byte copying and not
 
4488
        # translating (because translation means we don't send
 
4489
        # unreconstructable deltas ever).
 
4490
        keys = {}
 
4491
        keys['texts'] = set()
 
4492
        keys['revisions'] = set()
 
4493
        keys['inventories'] = set()
 
4494
        keys['chk_bytes'] = set()
 
4495
        keys['signatures'] = set()
 
4496
        for key in missing_keys:
 
4497
            keys[key[0]].add(key[1:])
 
4498
        if len(keys['revisions']):
 
4499
            # If we allowed copying revisions at this point, we could end up
 
4500
            # copying a revision without copying its required texts: a
 
4501
            # violation of the requirements for repository integrity.
 
4502
            raise AssertionError(
 
4503
                'cannot copy revisions to fill in missing deltas %s' % (
 
4504
                    keys['revisions'],))
 
4505
        for substream_kind, keys in keys.iteritems():
 
4506
            vf = getattr(self.from_repository, substream_kind)
 
4507
            if vf is None and keys:
 
4508
                    raise AssertionError(
 
4509
                        "cannot fill in keys for a versioned file we don't"
 
4510
                        " have: %s needs %s" % (substream_kind, keys))
 
4511
            if not keys:
 
4512
                # No need to stream something we don't have
 
4513
                continue
 
4514
            if substream_kind == 'inventories':
 
4515
                # Some missing keys are genuinely ghosts, filter those out.
 
4516
                present = self.from_repository.inventories.get_parent_map(keys)
 
4517
                revs = [key[0] for key in present]
 
4518
                # Get the inventory stream more-or-less as we do for the
 
4519
                # original stream; there's no reason to assume that records
 
4520
                # direct from the source will be suitable for the sink.  (Think
 
4521
                # e.g. 2a -> 1.9-rich-root).
 
4522
                for info in self._get_inventory_stream(revs, missing=True):
 
4523
                    yield info
 
4524
                continue
 
4525
 
 
4526
            # Ask for full texts always so that we don't need more round trips
 
4527
            # after this stream.
 
4528
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4529
            # records. The Sink is responsible for doing another check to
 
4530
            # ensure that ghosts don't introduce missing data for future
 
4531
            # fetches.
 
4532
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4533
                self.to_format._fetch_order, True))
 
4534
            yield substream_kind, stream
 
4535
 
 
4536
    def inventory_fetch_order(self):
 
4537
        if self._rich_root_upgrade():
 
4538
            return 'topological'
 
4539
        else:
 
4540
            return self.to_format._fetch_order
 
4541
 
 
4542
    def _rich_root_upgrade(self):
 
4543
        return (not self.from_repository._format.rich_root_data and
 
4544
            self.to_format.rich_root_data)
 
4545
 
 
4546
    def _get_inventory_stream(self, revision_ids, missing=False):
 
4547
        from_format = self.from_repository._format
 
4548
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4549
            from_format.network_name() == self.to_format.network_name()):
 
4550
            raise AssertionError(
 
4551
                "this case should be handled by GroupCHKStreamSource")
 
4552
        elif 'forceinvdeltas' in debug.debug_flags:
 
4553
            return self._get_convertable_inventory_stream(revision_ids,
 
4554
                    delta_versus_null=missing)
 
4555
        elif from_format.network_name() == self.to_format.network_name():
 
4556
            # Same format.
 
4557
            return self._get_simple_inventory_stream(revision_ids,
 
4558
                    missing=missing)
 
4559
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4560
                and from_format._serializer == self.to_format._serializer):
 
4561
            # Essentially the same format.
 
4562
            return self._get_simple_inventory_stream(revision_ids,
 
4563
                    missing=missing)
 
4564
        else:
 
4565
            # Any time we switch serializations, we want to use an
 
4566
            # inventory-delta based approach.
 
4567
            return self._get_convertable_inventory_stream(revision_ids,
 
4568
                    delta_versus_null=missing)
 
4569
 
 
4570
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4571
        # NB: This currently reopens the inventory weave in source;
 
4572
        # using a single stream interface instead would avoid this.
 
4573
        from_weave = self.from_repository.inventories
 
4574
        if missing:
 
4575
            delta_closure = True
 
4576
        else:
 
4577
            delta_closure = not self.delta_on_metadata()
 
4578
        yield ('inventories', from_weave.get_record_stream(
 
4579
            [(rev_id,) for rev_id in revision_ids],
 
4580
            self.inventory_fetch_order(), delta_closure))
 
4581
 
 
4582
    def _get_convertable_inventory_stream(self, revision_ids,
 
4583
                                          delta_versus_null=False):
 
4584
        # The source is using CHKs, but the target either doesn't or it has a
 
4585
        # different serializer.  The StreamSink code expects to be able to
 
4586
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4587
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4588
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4589
        yield ('inventory-deltas',
 
4590
           self._stream_invs_as_deltas(revision_ids,
 
4591
                                       delta_versus_null=delta_versus_null))
 
4592
 
 
4593
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4594
        """Return a stream of inventory-deltas for the given rev ids.
 
4595
 
 
4596
        :param revision_ids: The list of inventories to transmit
 
4597
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4598
            entry, instead compute the delta versus the NULL_REVISION. This
 
4599
            effectively streams a complete inventory. Used for stuff like
 
4600
            filling in missing parents, etc.
 
4601
        """
 
4602
        from_repo = self.from_repository
 
4603
        revision_keys = [(rev_id,) for rev_id in revision_ids]
 
4604
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
 
4605
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4606
        # method...
 
4607
        inventories = self.from_repository.iter_inventories(
 
4608
            revision_ids, 'topological')
 
4609
        format = from_repo._format
 
4610
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4611
        inventory_cache = lru_cache.LRUCache(50)
 
4612
        null_inventory = from_repo.revision_tree(
 
4613
            _mod_revision.NULL_REVISION).inventory
 
4614
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4615
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4616
        # repo back into a non-rich-root repo ought to be allowed)
 
4617
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4618
            versioned_root=format.rich_root_data,
 
4619
            tree_references=format.supports_tree_reference)
 
4620
        for inv in inventories:
 
4621
            key = (inv.revision_id,)
 
4622
            parent_keys = parent_map.get(key, ())
 
4623
            delta = None
 
4624
            if not delta_versus_null and parent_keys:
 
4625
                # The caller did not ask for complete inventories and we have
 
4626
                # some parents that we can delta against.  Make a delta against
 
4627
                # each parent so that we can find the smallest.
 
4628
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4629
                for parent_id in parent_ids:
 
4630
                    if parent_id not in invs_sent_so_far:
 
4631
                        # We don't know that the remote side has this basis, so
 
4632
                        # we can't use it.
 
4633
                        continue
 
4634
                    if parent_id == _mod_revision.NULL_REVISION:
 
4635
                        parent_inv = null_inventory
 
4636
                    else:
 
4637
                        parent_inv = inventory_cache.get(parent_id, None)
 
4638
                        if parent_inv is None:
 
4639
                            parent_inv = from_repo.get_inventory(parent_id)
 
4640
                    candidate_delta = inv._make_delta(parent_inv)
 
4641
                    if (delta is None or
 
4642
                        len(delta) > len(candidate_delta)):
 
4643
                        delta = candidate_delta
 
4644
                        basis_id = parent_id
 
4645
            if delta is None:
 
4646
                # Either none of the parents ended up being suitable, or we
 
4647
                # were asked to delta against NULL
 
4648
                basis_id = _mod_revision.NULL_REVISION
 
4649
                delta = inv._make_delta(null_inventory)
 
4650
            invs_sent_so_far.add(inv.revision_id)
 
4651
            inventory_cache[inv.revision_id] = inv
 
4652
            delta_serialized = ''.join(
 
4653
                serializer.delta_to_lines(basis_id, key[-1], delta))
 
4654
            yield versionedfile.FulltextContentFactory(
 
4655
                key, parent_keys, None, delta_serialized)
 
4656
 
 
4657
 
 
4658
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
4659
                    stop_revision=None):
 
4660
    """Extend the partial history to include a given index
 
4661
 
 
4662
    If a stop_index is supplied, stop when that index has been reached.
 
4663
    If a stop_revision is supplied, stop when that revision is
 
4664
    encountered.  Otherwise, stop when the beginning of history is
 
4665
    reached.
 
4666
 
 
4667
    :param stop_index: The index which should be present.  When it is
 
4668
        present, history extension will stop.
 
4669
    :param stop_revision: The revision id which should be present.  When
 
4670
        it is encountered, history extension will stop.
 
4671
    """
 
4672
    start_revision = partial_history_cache[-1]
 
4673
    iterator = repo.iter_reverse_revision_history(start_revision)
 
4674
    try:
 
4675
        #skip the last revision in the list
 
4676
        iterator.next()
 
4677
        while True:
 
4678
            if (stop_index is not None and
 
4679
                len(partial_history_cache) > stop_index):
 
4680
                break
 
4681
            if partial_history_cache[-1] == stop_revision:
 
4682
                break
 
4683
            revision_id = iterator.next()
 
4684
            partial_history_cache.append(revision_id)
 
4685
    except StopIteration:
 
4686
        # No more history
 
4687
        return
 
4688