← 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-07-02 00:49:15 UTC
  • mfrom: (1706.2.8 bzr.dev.lsprof)
  • Revision ID: pqm@pqm.ubuntu.com-20060702004915-501855cc9fc14e10
(robey) updates for lsprof

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