← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-05-19 06:14:38 UTC
  • mfrom: (1704.2.23 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060519061438-6300caf3926c3cff
(mbp) small fixes

Show diffs side-by-side

added added

removed removed

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