← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-03 07:18:36 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100203071836-u9b86q68fr9ri5s6
Fix NEWS.

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