← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: John Arbash Meinel
  • Date: 2006-06-19 14:40:19 UTC
  • mto: This revision was merged to the branch mainline in revision 1794.
  • Revision ID: john@arbash-meinel.com-20060619144019-873a4a8d252f7896
Refactor import stuff into separate functions. Update news

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