1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
from cStringIO import StringIO
 
 
19
from bzrlib.lazy_import import lazy_import
 
 
20
lazy_import(globals(), """
 
 
39
    revision as _mod_revision,
 
 
44
from bzrlib.bundle import serializer
 
 
45
from bzrlib.revisiontree import RevisionTree
 
 
46
from bzrlib.store.versioned import VersionedFileStore
 
 
47
from bzrlib.store.text import TextStore
 
 
48
from bzrlib.testament import Testament
 
 
51
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
52
from bzrlib.inter import InterObject
 
 
53
from bzrlib.inventory import Inventory, InventoryDirectory, ROOT_ID
 
 
54
from bzrlib.symbol_versioning import (
 
 
57
from bzrlib.trace import mutter, mutter_callsite, note, warning
 
 
60
# Old formats display a warning, but only once
 
 
61
_deprecation_warning_done = False
 
 
64
class CommitBuilder(object):
 
 
65
    """Provides an interface to build up a commit.
 
 
67
    This allows describing a tree to be committed without needing to 
 
 
68
    know the internals of the format of the repository.
 
 
71
    # all clients should supply tree roots.
 
 
72
    record_root_entry = True
 
 
73
    # the default CommitBuilder does not manage trees whose root is versioned.
 
 
74
    _versioned_root = False
 
 
76
    def __init__(self, repository, parents, config, timestamp=None, 
 
 
77
                 timezone=None, committer=None, revprops=None, 
 
 
79
        """Initiate a CommitBuilder.
 
 
81
        :param repository: Repository to commit to.
 
 
82
        :param parents: Revision ids of the parents of the new revision.
 
 
83
        :param config: Configuration to use.
 
 
84
        :param timestamp: Optional timestamp recorded for commit.
 
 
85
        :param timezone: Optional timezone for timestamp.
 
 
86
        :param committer: Optional committer to set for commit.
 
 
87
        :param revprops: Optional dictionary of revision properties.
 
 
88
        :param revision_id: Optional revision id.
 
 
93
            self._committer = self._config.username()
 
 
95
            assert isinstance(committer, basestring), type(committer)
 
 
96
            self._committer = committer
 
 
98
        self.new_inventory = Inventory(None)
 
 
99
        self._new_revision_id = osutils.safe_revision_id(revision_id)
 
 
100
        self.parents = parents
 
 
101
        self.repository = repository
 
 
104
        if revprops is not None:
 
 
105
            self._revprops.update(revprops)
 
 
107
        if timestamp is None:
 
 
108
            timestamp = time.time()
 
 
109
        # Restrict resolution to 1ms
 
 
110
        self._timestamp = round(timestamp, 3)
 
 
113
            self._timezone = osutils.local_time_offset()
 
 
115
            self._timezone = int(timezone)
 
 
117
        self._generate_revision_if_needed()
 
 
118
        self._repo_graph = repository.get_graph()
 
 
120
    def commit(self, message):
 
 
121
        """Make the actual commit.
 
 
123
        :return: The revision id of the recorded revision.
 
 
125
        rev = _mod_revision.Revision(
 
 
126
                       timestamp=self._timestamp,
 
 
127
                       timezone=self._timezone,
 
 
128
                       committer=self._committer,
 
 
130
                       inventory_sha1=self.inv_sha1,
 
 
131
                       revision_id=self._new_revision_id,
 
 
132
                       properties=self._revprops)
 
 
133
        rev.parent_ids = self.parents
 
 
134
        self.repository.add_revision(self._new_revision_id, rev,
 
 
135
            self.new_inventory, self._config)
 
 
136
        self.repository.commit_write_group()
 
 
137
        return self._new_revision_id
 
 
140
        """Abort the commit that is being built.
 
 
142
        self.repository.abort_write_group()
 
 
144
    def revision_tree(self):
 
 
145
        """Return the tree that was just committed.
 
 
147
        After calling commit() this can be called to get a RevisionTree
 
 
148
        representing the newly committed tree. This is preferred to
 
 
149
        calling Repository.revision_tree() because that may require
 
 
150
        deserializing the inventory, while we already have a copy in
 
 
153
        return RevisionTree(self.repository, self.new_inventory,
 
 
154
                            self._new_revision_id)
 
 
156
    def finish_inventory(self):
 
 
157
        """Tell the builder that the inventory is finished."""
 
 
158
        if self.new_inventory.root is None:
 
 
159
            symbol_versioning.warn('Root entry should be supplied to'
 
 
160
                ' record_entry_contents, as of bzr 0.10.',
 
 
161
                 DeprecationWarning, stacklevel=2)
 
 
162
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
 
163
        self.new_inventory.revision_id = self._new_revision_id
 
 
164
        self.inv_sha1 = self.repository.add_inventory(
 
 
165
            self._new_revision_id,
 
 
170
    def _gen_revision_id(self):
 
 
171
        """Return new revision-id."""
 
 
172
        return generate_ids.gen_revision_id(self._config.username(),
 
 
175
    def _generate_revision_if_needed(self):
 
 
176
        """Create a revision id if None was supplied.
 
 
178
        If the repository can not support user-specified revision ids
 
 
179
        they should override this function and raise CannotSetRevisionId
 
 
180
        if _new_revision_id is not None.
 
 
182
        :raises: CannotSetRevisionId
 
 
184
        if self._new_revision_id is None:
 
 
185
            self._new_revision_id = self._gen_revision_id()
 
 
186
            self.random_revid = True
 
 
188
            self.random_revid = False
 
 
190
    def _check_root(self, ie, parent_invs, tree):
 
 
191
        """Helper for record_entry_contents.
 
 
193
        :param ie: An entry being added.
 
 
194
        :param parent_invs: The inventories of the parent revisions of the
 
 
196
        :param tree: The tree that is being committed.
 
 
198
        # In this revision format, root entries have no knit or weave When
 
 
199
        # serializing out to disk and back in root.revision is always
 
 
201
        ie.revision = self._new_revision_id
 
 
203
    def _get_delta(self, ie, basis_inv, path):
 
 
204
        """Get a delta against the basis inventory for ie."""
 
 
205
        if ie.file_id not in basis_inv:
 
 
207
            return (None, path, ie.file_id, ie)
 
 
208
        elif ie != basis_inv[ie.file_id]:
 
 
210
            # TODO: avoid tis id2path call.
 
 
211
            return (basis_inv.id2path(ie.file_id), path, ie.file_id, ie)
 
 
216
    def record_entry_contents(self, ie, parent_invs, path, tree,
 
 
218
        """Record the content of ie from tree into the commit if needed.
 
 
220
        Side effect: sets ie.revision when unchanged
 
 
222
        :param ie: An inventory entry present in the commit.
 
 
223
        :param parent_invs: The inventories of the parent revisions of the
 
 
225
        :param path: The path the entry is at in the tree.
 
 
226
        :param tree: The tree which contains this entry and should be used to 
 
 
228
        :param content_summary: Summary data from the tree about the paths
 
 
229
            content - stat, length, exec, sha/link target. This is only
 
 
230
            accessed when the entry has a revision of None - that is when it is
 
 
231
            a candidate to commit.
 
 
232
        :return: A tuple (change_delta, version_recorded). change_delta is 
 
 
233
            an inventory_delta change for this entry against the basis tree of
 
 
234
            the commit, or None if no change occured against the basis tree.
 
 
235
            version_recorded is True if a new version of the entry has been
 
 
236
            recorded. For instance, committing a merge where a file was only
 
 
237
            changed on the other side will return (delta, False).
 
 
239
        if self.new_inventory.root is None:
 
 
240
            if ie.parent_id is not None:
 
 
241
                raise errors.RootMissing()
 
 
242
            self._check_root(ie, parent_invs, tree)
 
 
243
        if ie.revision is None:
 
 
244
            kind = content_summary[0]
 
 
246
            # ie is carried over from a prior commit
 
 
248
        # XXX: repository specific check for nested tree support goes here - if
 
 
249
        # the repo doesn't want nested trees we skip it ?
 
 
250
        if (kind == 'tree-reference' and
 
 
251
            not self.repository._format.supports_tree_reference):
 
 
252
            # mismatch between commit builder logic and repository:
 
 
253
            # this needs the entry creation pushed down into the builder.
 
 
254
            raise NotImplementedError('Missing repository subtree support.')
 
 
255
        # transitional assert only, will remove before release.
 
 
256
        assert ie.kind == kind
 
 
257
        self.new_inventory.add(ie)
 
 
259
        # TODO: slow, take it out of the inner loop.
 
 
261
            basis_inv = parent_invs[0]
 
 
263
            basis_inv = Inventory(root_id=None)
 
 
265
        # ie.revision is always None if the InventoryEntry is considered
 
 
266
        # for committing. We may record the previous parents revision if the
 
 
267
        # content is actually unchanged against a sole head.
 
 
268
        if ie.revision is not None:
 
 
269
            if self._versioned_root or path != '':
 
 
270
                # not considered for commit
 
 
273
                # repositories that do not version the root set the root's
 
 
274
                # revision to the new commit even when no change occurs, and
 
 
275
                # this masks when a change may have occurred against the basis,
 
 
276
                # so calculate if one happened.
 
 
277
                if ie.file_id not in basis_inv:
 
 
279
                    delta = (None, path, ie.file_id, ie)
 
 
281
                    basis_id = basis_inv[ie.file_id]
 
 
282
                    if basis_id.name != '':
 
 
284
                        delta = (basis_inv.id2path(ie.file_id), path,
 
 
289
            # not considered for commit, OR, for non-rich-root 
 
 
290
            return delta, ie.revision == self._new_revision_id and (path != '' or
 
 
291
                self._versioned_root)
 
 
293
        # XXX: Friction: parent_candidates should return a list not a dict
 
 
294
        #      so that we don't have to walk the inventories again.
 
 
295
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
 
296
        head_set = self._repo_graph.heads(parent_candiate_entries.keys())
 
 
298
        for inv in parent_invs:
 
 
299
            if ie.file_id in inv:
 
 
300
                old_rev = inv[ie.file_id].revision
 
 
301
                if old_rev in head_set:
 
 
302
                    heads.append(inv[ie.file_id].revision)
 
 
303
                    head_set.remove(inv[ie.file_id].revision)
 
 
306
        # now we check to see if we need to write a new record to the
 
 
308
        # We write a new entry unless there is one head to the ancestors, and
 
 
309
        # the kind-derived content is unchanged.
 
 
311
        # Cheapest check first: no ancestors, or more the one head in the
 
 
312
        # ancestors, we write a new node.
 
 
316
            # There is a single head, look it up for comparison
 
 
317
            parent_entry = parent_candiate_entries[heads[0]]
 
 
318
            # if the non-content specific data has changed, we'll be writing a
 
 
320
            if (parent_entry.parent_id != ie.parent_id or
 
 
321
                parent_entry.name != ie.name):
 
 
323
        # now we need to do content specific checks:
 
 
325
            # if the kind changed the content obviously has
 
 
326
            if kind != parent_entry.kind:
 
 
330
                if (# if the file length changed we have to store:
 
 
331
                    parent_entry.text_size != content_summary[1] or
 
 
332
                    # if the exec bit has changed we have to store:
 
 
333
                    parent_entry.executable != content_summary[2]):
 
 
335
                elif parent_entry.text_sha1 == content_summary[3]:
 
 
336
                    # all meta and content is unchanged (using a hash cache
 
 
337
                    # hit to check the sha)
 
 
338
                    ie.revision = parent_entry.revision
 
 
339
                    ie.text_size = parent_entry.text_size
 
 
340
                    ie.text_sha1 = parent_entry.text_sha1
 
 
341
                    ie.executable = parent_entry.executable
 
 
342
                    return self._get_delta(ie, basis_inv, path), False
 
 
344
                    # Either there is only a hash change(no hash cache entry,
 
 
345
                    # or same size content change), or there is no change on
 
 
347
                    # Provide the parent's hash to the store layer, so that the
 
 
348
                    # content is unchanged we will not store a new node.
 
 
349
                    nostore_sha = parent_entry.text_sha1
 
 
351
                # We want to record a new node regardless of the presence or
 
 
352
                # absence of a content change in the file.
 
 
354
            ie.executable = content_summary[2]
 
 
355
            lines = tree.get_file(ie.file_id, path).readlines()
 
 
357
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
 
 
358
                    ie.file_id, lines, heads, nostore_sha)
 
 
359
            except errors.ExistingContent:
 
 
360
                # Turns out that the file content was unchanged, and we were
 
 
361
                # only going to store a new node if it was changed. Carry over
 
 
363
                ie.revision = parent_entry.revision
 
 
364
                ie.text_size = parent_entry.text_size
 
 
365
                ie.text_sha1 = parent_entry.text_sha1
 
 
366
                ie.executable = parent_entry.executable
 
 
367
                return self._get_delta(ie, basis_inv, path), False
 
 
368
        elif kind == 'directory':
 
 
370
                # all data is meta here, nothing specific to directory, so
 
 
372
                ie.revision = parent_entry.revision
 
 
373
                return self._get_delta(ie, basis_inv, path), False
 
 
375
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
 
376
        elif kind == 'symlink':
 
 
377
            current_link_target = content_summary[3]
 
 
379
                # symlink target is not generic metadata, check if it has
 
 
381
                if current_link_target != parent_entry.symlink_target:
 
 
384
                # unchanged, carry over.
 
 
385
                ie.revision = parent_entry.revision
 
 
386
                ie.symlink_target = parent_entry.symlink_target
 
 
387
                return self._get_delta(ie, basis_inv, path), False
 
 
388
            ie.symlink_target = current_link_target
 
 
390
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
 
391
        elif kind == 'tree-reference':
 
 
393
                if content_summary[3] != parent_entry.reference_revision:
 
 
396
                # unchanged, carry over.
 
 
397
                ie.reference_revision = parent_entry.reference_revision
 
 
398
                ie.revision = parent_entry.revision
 
 
399
                return self._get_delta(ie, basis_inv, path), False
 
 
400
            ie.reference_revision = content_summary[3]
 
 
402
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
 
404
            raise NotImplementedError('unknown kind')
 
 
405
        ie.revision = self._new_revision_id
 
 
406
        return self._get_delta(ie, basis_inv, path), True
 
 
408
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
 
409
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
 
410
            file_id, self.repository.get_transaction())
 
 
411
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
 
412
        # than add_lines, and allows committing when a parent is ghosted for
 
 
414
        # Note: as we read the content directly from the tree, we know its not
 
 
415
        # been turned into unicode or badly split - but a broken tree
 
 
416
        # implementation could give us bad output from readlines() so this is
 
 
417
        # not a guarantee of safety. What would be better is always checking
 
 
418
        # the content during test suite execution. RBC 20070912
 
 
420
            return versionedfile.add_lines_with_ghosts(
 
 
421
                self._new_revision_id, parents, new_lines,
 
 
422
                nostore_sha=nostore_sha, random_id=self.random_revid,
 
 
423
                check_content=False)[0:2]
 
 
425
            versionedfile.clear_cache()
 
 
428
class RootCommitBuilder(CommitBuilder):
 
 
429
    """This commitbuilder actually records the root id"""
 
 
431
    # the root entry gets versioned properly by this builder.
 
 
432
    _versioned_root = True
 
 
434
    def _check_root(self, ie, parent_invs, tree):
 
 
435
        """Helper for record_entry_contents.
 
 
437
        :param ie: An entry being added.
 
 
438
        :param parent_invs: The inventories of the parent revisions of the
 
 
440
        :param tree: The tree that is being committed.
 
 
444
######################################################################
 
 
447
class Repository(object):
 
 
448
    """Repository holding history for one or more branches.
 
 
450
    The repository holds and retrieves historical information including
 
 
451
    revisions and file history.  It's normally accessed only by the Branch,
 
 
452
    which views a particular line of development through that history.
 
 
454
    The Repository builds on top of Stores and a Transport, which respectively 
 
 
455
    describe the disk data format and the way of accessing the (possibly 
 
 
459
    # What class to use for a CommitBuilder. Often its simpler to change this
 
 
460
    # in a Repository class subclass rather than to override
 
 
461
    # get_commit_builder.
 
 
462
    _commit_builder_class = CommitBuilder
 
 
463
    # The search regex used by xml based repositories to determine what things
 
 
464
    # where changed in a single commit.
 
 
465
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
 
466
        r'file_id="(?P<file_id>[^"]+)"'
 
 
467
        r'.* revision="(?P<revision_id>[^"]+)"'
 
 
470
    def abort_write_group(self):
 
 
471
        """Commit the contents accrued within the current write group.
 
 
473
        :seealso: start_write_group.
 
 
475
        if self._write_group is not self.get_transaction():
 
 
476
            # has an unlock or relock occured ?
 
 
477
            raise errors.BzrError('mismatched lock context and write group.')
 
 
478
        self._abort_write_group()
 
 
479
        self._write_group = None
 
 
481
    def _abort_write_group(self):
 
 
482
        """Template method for per-repository write group cleanup.
 
 
484
        This is called during abort before the write group is considered to be 
 
 
485
        finished and should cleanup any internal state accrued during the write
 
 
486
        group. There is no requirement that data handed to the repository be
 
 
487
        *not* made available - this is not a rollback - but neither should any
 
 
488
        attempt be made to ensure that data added is fully commited. Abort is
 
 
489
        invoked when an error has occured so futher disk or network operations
 
 
490
        may not be possible or may error and if possible should not be
 
 
495
    def add_inventory(self, revision_id, inv, parents):
 
 
496
        """Add the inventory inv to the repository as revision_id.
 
 
498
        :param parents: The revision ids of the parents that revision_id
 
 
499
                        is known to have and are in the repository already.
 
 
501
        returns the sha1 of the serialized inventory.
 
 
503
        revision_id = osutils.safe_revision_id(revision_id)
 
 
504
        _mod_revision.check_not_reserved_id(revision_id)
 
 
505
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
 
506
            "Mismatch between inventory revision" \
 
 
507
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
 
508
        assert inv.root is not None
 
 
509
        inv_lines = self._serialise_inventory_to_lines(inv)
 
 
510
        inv_vf = self.get_inventory_weave()
 
 
511
        return self._inventory_add_lines(inv_vf, revision_id, parents,
 
 
512
            inv_lines, check_content=False)
 
 
514
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
 
 
516
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
 
518
        for parent in parents:
 
 
520
                final_parents.append(parent)
 
 
521
        return inv_vf.add_lines(revision_id, final_parents, lines,
 
 
522
            check_content=check_content)[0]
 
 
525
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
 
526
        """Add rev to the revision store as revision_id.
 
 
528
        :param revision_id: the revision id to use.
 
 
529
        :param rev: The revision object.
 
 
530
        :param inv: The inventory for the revision. if None, it will be looked
 
 
531
                    up in the inventory storer
 
 
532
        :param config: If None no digital signature will be created.
 
 
533
                       If supplied its signature_needed method will be used
 
 
534
                       to determine if a signature should be made.
 
 
536
        revision_id = osutils.safe_revision_id(revision_id)
 
 
537
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
 
539
        _mod_revision.check_not_reserved_id(revision_id)
 
 
540
        if config is not None and config.signature_needed():
 
 
542
                inv = self.get_inventory(revision_id)
 
 
543
            plaintext = Testament(rev, inv).as_short_text()
 
 
544
            self.store_revision_signature(
 
 
545
                gpg.GPGStrategy(config), plaintext, revision_id)
 
 
546
        if not revision_id in self.get_inventory_weave():
 
 
548
                raise errors.WeaveRevisionNotPresent(revision_id,
 
 
549
                                                     self.get_inventory_weave())
 
 
551
                # yes, this is not suitable for adding with ghosts.
 
 
552
                self.add_inventory(revision_id, inv, rev.parent_ids)
 
 
553
        self._revision_store.add_revision(rev, self.get_transaction())
 
 
555
    def _add_revision_text(self, revision_id, text):
 
 
556
        revision = self._revision_store._serializer.read_revision_from_string(
 
 
558
        self._revision_store._add_revision(revision, StringIO(text),
 
 
559
                                           self.get_transaction())
 
 
561
    def all_revision_ids(self):
 
 
562
        """Returns a list of all the revision ids in the repository. 
 
 
564
        This is deprecated because code should generally work on the graph
 
 
565
        reachable from a particular revision, and ignore any other revisions
 
 
566
        that might be present.  There is no direct replacement method.
 
 
568
        if 'evil' in debug.debug_flags:
 
 
569
            mutter_callsite(2, "all_revision_ids is linear with history.")
 
 
570
        return self._all_revision_ids()
 
 
572
    def _all_revision_ids(self):
 
 
573
        """Returns a list of all the revision ids in the repository. 
 
 
575
        These are in as much topological order as the underlying store can 
 
 
578
        raise NotImplementedError(self._all_revision_ids)
 
 
580
    def break_lock(self):
 
 
581
        """Break a lock if one is present from another instance.
 
 
583
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
586
        self.control_files.break_lock()
 
 
589
    def _eliminate_revisions_not_present(self, revision_ids):
 
 
590
        """Check every revision id in revision_ids to see if we have it.
 
 
592
        Returns a set of the present revisions.
 
 
595
        for id in revision_ids:
 
 
596
            if self.has_revision(id):
 
 
601
    def create(a_bzrdir):
 
 
602
        """Construct the current default format repository in a_bzrdir."""
 
 
603
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
 
 
605
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
 
606
        """instantiate a Repository.
 
 
608
        :param _format: The format of the repository on disk.
 
 
609
        :param a_bzrdir: The BzrDir of the repository.
 
 
611
        In the future we will have a single api for all stores for
 
 
612
        getting file texts, inventories and revisions, then
 
 
613
        this construct will accept instances of those things.
 
 
615
        super(Repository, self).__init__()
 
 
616
        self._format = _format
 
 
617
        # the following are part of the public API for Repository:
 
 
618
        self.bzrdir = a_bzrdir
 
 
619
        self.control_files = control_files
 
 
620
        self._revision_store = _revision_store
 
 
621
        # backwards compatibility
 
 
622
        self.weave_store = text_store
 
 
624
        self._reconcile_does_inventory_gc = True
 
 
625
        # not right yet - should be more semantically clear ? 
 
 
627
        self.control_store = control_store
 
 
628
        self.control_weaves = control_store
 
 
629
        # TODO: make sure to construct the right store classes, etc, depending
 
 
630
        # on whether escaping is required.
 
 
631
        self._warn_if_deprecated()
 
 
632
        self._write_group = None
 
 
633
        self.base = control_files._transport.base
 
 
636
        return '%s(%r)' % (self.__class__.__name__,
 
 
639
    def has_same_location(self, other):
 
 
640
        """Returns a boolean indicating if this repository is at the same
 
 
641
        location as another repository.
 
 
643
        This might return False even when two repository objects are accessing
 
 
644
        the same physical repository via different URLs.
 
 
646
        if self.__class__ is not other.__class__:
 
 
648
        return (self.control_files._transport.base ==
 
 
649
                other.control_files._transport.base)
 
 
651
    def is_in_write_group(self):
 
 
652
        """Return True if there is an open write group.
 
 
654
        :seealso: start_write_group.
 
 
656
        return self._write_group is not None
 
 
659
        return self.control_files.is_locked()
 
 
661
    def lock_write(self, token=None):
 
 
662
        """Lock this repository for writing.
 
 
664
        This causes caching within the repository obejct to start accumlating
 
 
665
        data during reads, and allows a 'write_group' to be obtained. Write
 
 
666
        groups must be used for actual data insertion.
 
 
668
        :param token: if this is already locked, then lock_write will fail
 
 
669
            unless the token matches the existing lock.
 
 
670
        :returns: a token if this instance supports tokens, otherwise None.
 
 
671
        :raises TokenLockingNotSupported: when a token is given but this
 
 
672
            instance doesn't support using token locks.
 
 
673
        :raises MismatchedToken: if the specified token doesn't match the token
 
 
674
            of the existing lock.
 
 
675
        :seealso: start_write_group.
 
 
677
        A token should be passed in if you know that you have locked the object
 
 
678
        some other way, and need to synchronise this object's state with that
 
 
681
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
 
683
        result = self.control_files.lock_write(token=token)
 
 
688
        self.control_files.lock_read()
 
 
691
    def get_physical_lock_status(self):
 
 
692
        return self.control_files.get_physical_lock_status()
 
 
694
    def leave_lock_in_place(self):
 
 
695
        """Tell this repository not to release the physical lock when this
 
 
698
        If lock_write doesn't return a token, then this method is not supported.
 
 
700
        self.control_files.leave_in_place()
 
 
702
    def dont_leave_lock_in_place(self):
 
 
703
        """Tell this repository to release the physical lock when this
 
 
704
        object is unlocked, even if it didn't originally acquire it.
 
 
706
        If lock_write doesn't return a token, then this method is not supported.
 
 
708
        self.control_files.dont_leave_in_place()
 
 
711
    def gather_stats(self, revid=None, committers=None):
 
 
712
        """Gather statistics from a revision id.
 
 
714
        :param revid: The revision id to gather statistics from, if None, then
 
 
715
            no revision specific statistics are gathered.
 
 
716
        :param committers: Optional parameter controlling whether to grab
 
 
717
            a count of committers from the revision specific statistics.
 
 
718
        :return: A dictionary of statistics. Currently this contains:
 
 
719
            committers: The number of committers if requested.
 
 
720
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
 
721
                most ancestor of revid, if revid is not the NULL_REVISION.
 
 
722
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
 
723
                not the NULL_REVISION.
 
 
724
            revisions: The total revision count in the repository.
 
 
725
            size: An estimate disk size of the repository in bytes.
 
 
728
        if revid and committers:
 
 
729
            result['committers'] = 0
 
 
730
        if revid and revid != _mod_revision.NULL_REVISION:
 
 
732
                all_committers = set()
 
 
733
            revisions = self.get_ancestry(revid)
 
 
734
            # pop the leading None
 
 
736
            first_revision = None
 
 
738
                # ignore the revisions in the middle - just grab first and last
 
 
739
                revisions = revisions[0], revisions[-1]
 
 
740
            for revision in self.get_revisions(revisions):
 
 
741
                if not first_revision:
 
 
742
                    first_revision = revision
 
 
744
                    all_committers.add(revision.committer)
 
 
745
            last_revision = revision
 
 
747
                result['committers'] = len(all_committers)
 
 
748
            result['firstrev'] = (first_revision.timestamp,
 
 
749
                first_revision.timezone)
 
 
750
            result['latestrev'] = (last_revision.timestamp,
 
 
751
                last_revision.timezone)
 
 
753
        # now gather global repository information
 
 
754
        if self.bzrdir.root_transport.listable():
 
 
755
            c, t = self._revision_store.total_size(self.get_transaction())
 
 
756
            result['revisions'] = c
 
 
761
    def missing_revision_ids(self, other, revision_id=None):
 
 
762
        """Return the revision ids that other has that this does not.
 
 
764
        These are returned in topological order.
 
 
766
        revision_id: only return revision ids included by revision_id.
 
 
768
        revision_id = osutils.safe_revision_id(revision_id)
 
 
769
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
 
773
        """Open the repository rooted at base.
 
 
775
        For instance, if the repository is at URL/.bzr/repository,
 
 
776
        Repository.open(URL) -> a Repository instance.
 
 
778
        control = bzrdir.BzrDir.open(base)
 
 
779
        return control.open_repository()
 
 
781
    def copy_content_into(self, destination, revision_id=None):
 
 
782
        """Make a complete copy of the content in self into destination.
 
 
784
        This is a destructive operation! Do not use it on existing 
 
 
787
        revision_id = osutils.safe_revision_id(revision_id)
 
 
788
        return InterRepository.get(self, destination).copy_content(revision_id)
 
 
790
    def commit_write_group(self):
 
 
791
        """Commit the contents accrued within the current write group.
 
 
793
        :seealso: start_write_group.
 
 
795
        if self._write_group is not self.get_transaction():
 
 
796
            # has an unlock or relock occured ?
 
 
797
            raise errors.BzrError('mismatched lock context %r and '
 
 
799
                (self.get_transaction(), self._write_group))
 
 
800
        self._commit_write_group()
 
 
801
        self._write_group = None
 
 
803
    def _commit_write_group(self):
 
 
804
        """Template method for per-repository write group cleanup.
 
 
806
        This is called before the write group is considered to be 
 
 
807
        finished and should ensure that all data handed to the repository
 
 
808
        for writing during the write group is safely committed (to the 
 
 
809
        extent possible considering file system caching etc).
 
 
812
    def fetch(self, source, revision_id=None, pb=None):
 
 
813
        """Fetch the content required to construct revision_id from source.
 
 
815
        If revision_id is None all content is copied.
 
 
817
        revision_id = osutils.safe_revision_id(revision_id)
 
 
818
        # fast path same-url fetch operations
 
 
819
        if self.has_same_location(source):
 
 
820
            # check that last_revision is in 'from' and then return a
 
 
822
            if (revision_id is not None and
 
 
823
                not _mod_revision.is_null(revision_id)):
 
 
824
                self.get_revision(revision_id)
 
 
826
        inter = InterRepository.get(source, self)
 
 
828
            return inter.fetch(revision_id=revision_id, pb=pb)
 
 
829
        except NotImplementedError:
 
 
830
            raise errors.IncompatibleRepositories(source, self)
 
 
832
    def create_bundle(self, target, base, fileobj, format=None):
 
 
833
        return serializer.write_bundle(self, target, base, fileobj, format)
 
 
835
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
 
836
                           timezone=None, committer=None, revprops=None,
 
 
838
        """Obtain a CommitBuilder for this repository.
 
 
840
        :param branch: Branch to commit to.
 
 
841
        :param parents: Revision ids of the parents of the new revision.
 
 
842
        :param config: Configuration to use.
 
 
843
        :param timestamp: Optional timestamp recorded for commit.
 
 
844
        :param timezone: Optional timezone for timestamp.
 
 
845
        :param committer: Optional committer to set for commit.
 
 
846
        :param revprops: Optional dictionary of revision properties.
 
 
847
        :param revision_id: Optional revision id.
 
 
849
        revision_id = osutils.safe_revision_id(revision_id)
 
 
850
        result = self._commit_builder_class(self, parents, config,
 
 
851
            timestamp, timezone, committer, revprops, revision_id)
 
 
852
        self.start_write_group()
 
 
856
        if (self.control_files._lock_count == 1 and
 
 
857
            self.control_files._lock_mode == 'w'):
 
 
858
            if self._write_group is not None:
 
 
859
                raise errors.BzrError(
 
 
860
                    'Must end write groups before releasing write locks.')
 
 
861
        self.control_files.unlock()
 
 
864
    def clone(self, a_bzrdir, revision_id=None):
 
 
865
        """Clone this repository into a_bzrdir using the current format.
 
 
867
        Currently no check is made that the format of this repository and
 
 
868
        the bzrdir format are compatible. FIXME RBC 20060201.
 
 
870
        :return: The newly created destination repository.
 
 
872
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
 
873
        # probably not very useful -- mbp 20070423
 
 
874
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
 
875
        self.copy_content_into(dest_repo, revision_id)
 
 
878
    def start_write_group(self):
 
 
879
        """Start a write group in the repository.
 
 
881
        Write groups are used by repositories which do not have a 1:1 mapping
 
 
882
        between file ids and backend store to manage the insertion of data from
 
 
883
        both fetch and commit operations.
 
 
885
        A write lock is required around the start_write_group/commit_write_group
 
 
886
        for the support of lock-requiring repository formats.
 
 
888
        One can only insert data into a repository inside a write group.
 
 
892
        if not self.is_locked() or self.control_files._lock_mode != 'w':
 
 
893
            raise errors.NotWriteLocked(self)
 
 
894
        if self._write_group:
 
 
895
            raise errors.BzrError('already in a write group')
 
 
896
        self._start_write_group()
 
 
897
        # so we can detect unlock/relock - the write group is now entered.
 
 
898
        self._write_group = self.get_transaction()
 
 
900
    def _start_write_group(self):
 
 
901
        """Template method for per-repository write group startup.
 
 
903
        This is called before the write group is considered to be 
 
 
908
    def sprout(self, to_bzrdir, revision_id=None):
 
 
909
        """Create a descendent repository for new development.
 
 
911
        Unlike clone, this does not copy the settings of the repository.
 
 
913
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
 
914
        dest_repo.fetch(self, revision_id=revision_id)
 
 
917
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
 
918
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
 
919
            # use target default format.
 
 
920
            dest_repo = a_bzrdir.create_repository()
 
 
922
            # Most control formats need the repository to be specifically
 
 
923
            # created, but on some old all-in-one formats it's not needed
 
 
925
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
 
926
            except errors.UninitializableFormat:
 
 
927
                dest_repo = a_bzrdir.open_repository()
 
 
931
    def has_revision(self, revision_id):
 
 
932
        """True if this repository has a copy of the revision."""
 
 
933
        if 'evil' in debug.debug_flags:
 
 
934
            mutter_callsite(3, "has_revision is a LBYL symptom.")
 
 
935
        revision_id = osutils.safe_revision_id(revision_id)
 
 
936
        return self._revision_store.has_revision_id(revision_id,
 
 
937
                                                    self.get_transaction())
 
 
940
    def get_revision(self, revision_id):
 
 
941
        """Return the Revision object for a named revision."""
 
 
942
        return self.get_revisions([revision_id])[0]
 
 
945
    def get_revision_reconcile(self, revision_id):
 
 
946
        """'reconcile' helper routine that allows access to a revision always.
 
 
948
        This variant of get_revision does not cross check the weave graph
 
 
949
        against the revision one as get_revision does: but it should only
 
 
950
        be used by reconcile, or reconcile-alike commands that are correcting
 
 
951
        or testing the revision graph.
 
 
953
        return self._get_revisions([revision_id])[0]
 
 
956
    def get_revisions(self, revision_ids):
 
 
957
        """Get many revisions at once."""
 
 
958
        return self._get_revisions(revision_ids)
 
 
961
    def _get_revisions(self, revision_ids):
 
 
962
        """Core work logic to get many revisions without sanity checks."""
 
 
963
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
 
964
        for rev_id in revision_ids:
 
 
965
            if not rev_id or not isinstance(rev_id, basestring):
 
 
966
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
 
967
        revs = self._revision_store.get_revisions(revision_ids,
 
 
968
                                                  self.get_transaction())
 
 
970
            assert not isinstance(rev.revision_id, unicode)
 
 
971
            for parent_id in rev.parent_ids:
 
 
972
                assert not isinstance(parent_id, unicode)
 
 
976
    def get_revision_xml(self, revision_id):
 
 
977
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
 
978
        #       would have already do it.
 
 
979
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
 
980
        revision_id = osutils.safe_revision_id(revision_id)
 
 
981
        rev = self.get_revision(revision_id)
 
 
983
        # the current serializer..
 
 
984
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
 
986
        return rev_tmp.getvalue()
 
 
989
    def get_deltas_for_revisions(self, revisions):
 
 
990
        """Produce a generator of revision deltas.
 
 
992
        Note that the input is a sequence of REVISIONS, not revision_ids.
 
 
993
        Trees will be held in memory until the generator exits.
 
 
994
        Each delta is relative to the revision's lefthand predecessor.
 
 
996
        required_trees = set()
 
 
997
        for revision in revisions:
 
 
998
            required_trees.add(revision.revision_id)
 
 
999
            required_trees.update(revision.parent_ids[:1])
 
 
1000
        trees = dict((t.get_revision_id(), t) for 
 
 
1001
                     t in self.revision_trees(required_trees))
 
 
1002
        for revision in revisions:
 
 
1003
            if not revision.parent_ids:
 
 
1004
                old_tree = self.revision_tree(None)
 
 
1006
                old_tree = trees[revision.parent_ids[0]]
 
 
1007
            yield trees[revision.revision_id].changes_from(old_tree)
 
 
1010
    def get_revision_delta(self, revision_id):
 
 
1011
        """Return the delta for one revision.
 
 
1013
        The delta is relative to the left-hand predecessor of the
 
 
1016
        r = self.get_revision(revision_id)
 
 
1017
        return list(self.get_deltas_for_revisions([r]))[0]
 
 
1020
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
 
1021
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1022
        signature = gpg_strategy.sign(plaintext)
 
 
1023
        self._revision_store.add_revision_signature_text(revision_id,
 
 
1025
                                                         self.get_transaction())
 
 
1027
    def fileids_altered_by_revision_ids(self, revision_ids):
 
 
1028
        """Find the file ids and versions affected by revisions.
 
 
1030
        :param revisions: an iterable containing revision ids.
 
 
1031
        :return: a dictionary mapping altered file-ids to an iterable of
 
 
1032
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
1033
        altered it listed explicitly.
 
 
1035
        assert self._serializer.support_altered_by_hack, \
 
 
1036
            ("fileids_altered_by_revision_ids only supported for branches " 
 
 
1037
             "which store inventory as unnested xml, not on %r" % self)
 
 
1038
        selected_revision_ids = set(osutils.safe_revision_id(r)
 
 
1039
                                    for r in revision_ids)
 
 
1040
        w = self.get_inventory_weave()
 
 
1043
        # this code needs to read every new line in every inventory for the
 
 
1044
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
 
1045
        # not present in one of those inventories is unnecessary but not 
 
 
1046
        # harmful because we are filtering by the revision id marker in the
 
 
1047
        # inventory lines : we only select file ids altered in one of those  
 
 
1048
        # revisions. We don't need to see all lines in the inventory because
 
 
1049
        # only those added in an inventory in rev X can contain a revision=X
 
 
1051
        unescape_revid_cache = {}
 
 
1052
        unescape_fileid_cache = {}
 
 
1054
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
 
1055
        # of lines, so it has had a lot of inlining and optimizing done.
 
 
1056
        # Sorry that it is a little bit messy.
 
 
1057
        # Move several functions to be local variables, since this is a long
 
 
1059
        search = self._file_ids_altered_regex.search
 
 
1060
        unescape = _unescape_xml
 
 
1061
        setdefault = result.setdefault
 
 
1062
        pb = ui.ui_factory.nested_progress_bar()
 
 
1064
            for line in w.iter_lines_added_or_present_in_versions(
 
 
1065
                                        selected_revision_ids, pb=pb):
 
 
1066
                match = search(line)
 
 
1069
                # One call to match.group() returning multiple items is quite a
 
 
1070
                # bit faster than 2 calls to match.group() each returning 1
 
 
1071
                file_id, revision_id = match.group('file_id', 'revision_id')
 
 
1073
                # Inlining the cache lookups helps a lot when you make 170,000
 
 
1074
                # lines and 350k ids, versus 8.4 unique ids.
 
 
1075
                # Using a cache helps in 2 ways:
 
 
1076
                #   1) Avoids unnecessary decoding calls
 
 
1077
                #   2) Re-uses cached strings, which helps in future set and
 
 
1079
                # (2) is enough that removing encoding entirely along with
 
 
1080
                # the cache (so we are using plain strings) results in no
 
 
1081
                # performance improvement.
 
 
1083
                    revision_id = unescape_revid_cache[revision_id]
 
 
1085
                    unescaped = unescape(revision_id)
 
 
1086
                    unescape_revid_cache[revision_id] = unescaped
 
 
1087
                    revision_id = unescaped
 
 
1089
                if revision_id in selected_revision_ids:
 
 
1091
                        file_id = unescape_fileid_cache[file_id]
 
 
1093
                        unescaped = unescape(file_id)
 
 
1094
                        unescape_fileid_cache[file_id] = unescaped
 
 
1096
                    setdefault(file_id, set()).add(revision_id)
 
 
1101
    def iter_files_bytes(self, desired_files):
 
 
1102
        """Iterate through file versions.
 
 
1104
        Files will not necessarily be returned in the order they occur in
 
 
1105
        desired_files.  No specific order is guaranteed.
 
 
1107
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
1108
        value supplied by the caller as part of desired_files.  It should
 
 
1109
        uniquely identify the file version in the caller's context.  (Examples:
 
 
1110
        an index number or a TreeTransform trans_id.)
 
 
1112
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
1113
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
1114
        this implementation, it is a list of lines produced by
 
 
1115
        VersionedFile.get_lines().
 
 
1117
        :param desired_files: a list of (file_id, revision_id, identifier)
 
 
1120
        transaction = self.get_transaction()
 
 
1121
        for file_id, revision_id, callable_data in desired_files:
 
 
1123
                weave = self.weave_store.get_weave(file_id, transaction)
 
 
1124
            except errors.NoSuchFile:
 
 
1125
                raise errors.NoSuchIdInRepository(self, file_id)
 
 
1126
            yield callable_data, weave.get_lines(revision_id)
 
 
1128
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
 
1129
        """Get an iterable listing the keys of all the data introduced by a set
 
 
1132
        The keys will be ordered so that the corresponding items can be safely
 
 
1133
        fetched and inserted in that order.
 
 
1135
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
 
1136
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
 
1137
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
 
1139
        # XXX: it's a bit weird to control the inventory weave caching in this
 
 
1140
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
 
1141
        # maybe this generator should explicitly have the contract that it
 
 
1142
        # should not be iterated until the previously yielded item has been
 
 
1144
        inv_w = self.get_inventory_weave()
 
 
1145
        inv_w.enable_cache()
 
 
1147
        # file ids that changed
 
 
1148
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
 
 
1150
        num_file_ids = len(file_ids)
 
 
1151
        for file_id, altered_versions in file_ids.iteritems():
 
 
1152
            if _files_pb is not None:
 
 
1153
                _files_pb.update("fetch texts", count, num_file_ids)
 
 
1155
            yield ("file", file_id, altered_versions)
 
 
1156
        # We're done with the files_pb.  Note that it finished by the caller,
 
 
1157
        # just as it was created by the caller.
 
 
1161
        yield ("inventory", None, revision_ids)
 
 
1165
        revisions_with_signatures = set()
 
 
1166
        for rev_id in revision_ids:
 
 
1168
                self.get_signature_text(rev_id)
 
 
1169
            except errors.NoSuchRevision:
 
 
1173
                revisions_with_signatures.add(rev_id)
 
 
1174
        yield ("signatures", None, revisions_with_signatures)
 
 
1177
        yield ("revisions", None, revision_ids)
 
 
1180
    def get_inventory_weave(self):
 
 
1181
        return self.control_weaves.get_weave('inventory',
 
 
1182
            self.get_transaction())
 
 
1185
    def get_inventory(self, revision_id):
 
 
1186
        """Get Inventory object by hash."""
 
 
1187
        # TODO: jam 20070210 Technically we don't need to sanitize, since all
 
 
1188
        #       called functions must sanitize.
 
 
1189
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1190
        return self.deserialise_inventory(
 
 
1191
            revision_id, self.get_inventory_xml(revision_id))
 
 
1193
    def deserialise_inventory(self, revision_id, xml):
 
 
1194
        """Transform the xml into an inventory object. 
 
 
1196
        :param revision_id: The expected revision id of the inventory.
 
 
1197
        :param xml: A serialised inventory.
 
 
1199
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1200
        result = self._serializer.read_inventory_from_string(xml)
 
 
1201
        result.root.revision = revision_id
 
 
1204
    def serialise_inventory(self, inv):
 
 
1205
        return self._serializer.write_inventory_to_string(inv)
 
 
1207
    def _serialise_inventory_to_lines(self, inv):
 
 
1208
        return self._serializer.write_inventory_to_lines(inv)
 
 
1210
    def get_serializer_format(self):
 
 
1211
        return self._serializer.format_num
 
 
1214
    def get_inventory_xml(self, revision_id):
 
 
1215
        """Get inventory XML as a file object."""
 
 
1216
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1218
            assert isinstance(revision_id, str), type(revision_id)
 
 
1219
            iw = self.get_inventory_weave()
 
 
1220
            return iw.get_text(revision_id)
 
 
1222
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
 
1225
    def get_inventory_sha1(self, revision_id):
 
 
1226
        """Return the sha1 hash of the inventory entry
 
 
1228
        # TODO: jam 20070210 Shouldn't this be deprecated / removed?
 
 
1229
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1230
        return self.get_revision(revision_id).inventory_sha1
 
 
1233
    def get_revision_graph(self, revision_id=None):
 
 
1234
        """Return a dictionary containing the revision graph.
 
 
1236
        NB: This method should not be used as it accesses the entire graph all
 
 
1237
        at once, which is much more data than most operations should require.
 
 
1239
        :param revision_id: The revision_id to get a graph from. If None, then
 
 
1240
        the entire revision graph is returned. This is a deprecated mode of
 
 
1241
        operation and will be removed in the future.
 
 
1242
        :return: a dictionary of revision_id->revision_parents_list.
 
 
1244
        raise NotImplementedError(self.get_revision_graph)
 
 
1247
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
 
1248
        """Return a graph of the revisions with ghosts marked as applicable.
 
 
1250
        :param revision_ids: an iterable of revisions to graph or None for all.
 
 
1251
        :return: a Graph object with the graph reachable from revision_ids.
 
 
1253
        if 'evil' in debug.debug_flags:
 
 
1255
                "get_revision_graph_with_ghosts scales with size of history.")
 
 
1256
        result = deprecated_graph.Graph()
 
 
1257
        if not revision_ids:
 
 
1258
            pending = set(self.all_revision_ids())
 
 
1261
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
 
 
1262
            # special case NULL_REVISION
 
 
1263
            if _mod_revision.NULL_REVISION in pending:
 
 
1264
                pending.remove(_mod_revision.NULL_REVISION)
 
 
1265
            required = set(pending)
 
 
1268
            revision_id = pending.pop()
 
 
1270
                rev = self.get_revision(revision_id)
 
 
1271
            except errors.NoSuchRevision:
 
 
1272
                if revision_id in required:
 
 
1275
                result.add_ghost(revision_id)
 
 
1277
            for parent_id in rev.parent_ids:
 
 
1278
                # is this queued or done ?
 
 
1279
                if (parent_id not in pending and
 
 
1280
                    parent_id not in done):
 
 
1282
                    pending.add(parent_id)
 
 
1283
            result.add_node(revision_id, rev.parent_ids)
 
 
1284
            done.add(revision_id)
 
 
1287
    def _get_history_vf(self):
 
 
1288
        """Get a versionedfile whose history graph reflects all revisions.
 
 
1290
        For weave repositories, this is the inventory weave.
 
 
1292
        return self.get_inventory_weave()
 
 
1294
    def iter_reverse_revision_history(self, revision_id):
 
 
1295
        """Iterate backwards through revision ids in the lefthand history
 
 
1297
        :param revision_id: The revision id to start with.  All its lefthand
 
 
1298
            ancestors will be traversed.
 
 
1300
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1301
        if revision_id in (None, _mod_revision.NULL_REVISION):
 
 
1303
        next_id = revision_id
 
 
1304
        versionedfile = self._get_history_vf()
 
 
1307
            parents = versionedfile.get_parents(next_id)
 
 
1308
            if len(parents) == 0:
 
 
1311
                next_id = parents[0]
 
 
1314
    def get_revision_inventory(self, revision_id):
 
 
1315
        """Return inventory of a past revision."""
 
 
1316
        # TODO: Unify this with get_inventory()
 
 
1317
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
 
1318
        # must be the same as its revision, so this is trivial.
 
 
1319
        if revision_id is None:
 
 
1320
            # This does not make sense: if there is no revision,
 
 
1321
            # then it is the current tree inventory surely ?!
 
 
1322
            # and thus get_root_id() is something that looks at the last
 
 
1323
            # commit on the branch, and the get_root_id is an inventory check.
 
 
1324
            raise NotImplementedError
 
 
1325
            # return Inventory(self.get_root_id())
 
 
1327
            return self.get_inventory(revision_id)
 
 
1330
    def is_shared(self):
 
 
1331
        """Return True if this repository is flagged as a shared repository."""
 
 
1332
        raise NotImplementedError(self.is_shared)
 
 
1335
    def reconcile(self, other=None, thorough=False):
 
 
1336
        """Reconcile this repository."""
 
 
1337
        from bzrlib.reconcile import RepoReconciler
 
 
1338
        reconciler = RepoReconciler(self, thorough=thorough)
 
 
1339
        reconciler.reconcile()
 
 
1342
    def _refresh_data(self):
 
 
1343
        """Helper called from lock_* to ensure coherency with disk.
 
 
1345
        The default implementation does nothing; it is however possible
 
 
1346
        for repositories to maintain loaded indices across multiple locks
 
 
1347
        by checking inside their implementation of this method to see
 
 
1348
        whether their indices are still valid. This depends of course on
 
 
1349
        the disk format being validatable in this manner.
 
 
1353
    def revision_tree(self, revision_id):
 
 
1354
        """Return Tree for a revision on this branch.
 
 
1356
        `revision_id` may be None for the empty tree revision.
 
 
1358
        # TODO: refactor this to use an existing revision object
 
 
1359
        # so we don't need to read it in twice.
 
 
1360
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
 
1361
            return RevisionTree(self, Inventory(root_id=None), 
 
 
1362
                                _mod_revision.NULL_REVISION)
 
 
1364
            revision_id = osutils.safe_revision_id(revision_id)
 
 
1365
            inv = self.get_revision_inventory(revision_id)
 
 
1366
            return RevisionTree(self, inv, revision_id)
 
 
1369
    def revision_trees(self, revision_ids):
 
 
1370
        """Return Tree for a revision on this branch.
 
 
1372
        `revision_id` may not be None or 'null:'"""
 
 
1373
        assert None not in revision_ids
 
 
1374
        assert _mod_revision.NULL_REVISION not in revision_ids
 
 
1375
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
 
1376
        for text, revision_id in zip(texts, revision_ids):
 
 
1377
            inv = self.deserialise_inventory(revision_id, text)
 
 
1378
            yield RevisionTree(self, inv, revision_id)
 
 
1381
    def get_ancestry(self, revision_id, topo_sorted=True):
 
 
1382
        """Return a list of revision-ids integrated by a revision.
 
 
1384
        The first element of the list is always None, indicating the origin 
 
 
1385
        revision.  This might change when we have history horizons, or 
 
 
1386
        perhaps we should have a new API.
 
 
1388
        This is topologically sorted.
 
 
1390
        if _mod_revision.is_null(revision_id):
 
 
1392
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1393
        if not self.has_revision(revision_id):
 
 
1394
            raise errors.NoSuchRevision(self, revision_id)
 
 
1395
        w = self.get_inventory_weave()
 
 
1396
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
 
1397
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
 
1400
        """Compress the data within the repository.
 
 
1402
        This operation only makes sense for some repository types. For other
 
 
1403
        types it should be a no-op that just returns.
 
 
1405
        This stub method does not require a lock, but subclasses should use
 
 
1406
        @needs_write_lock as this is a long running call its reasonable to 
 
 
1407
        implicitly lock for the user.
 
 
1411
    def print_file(self, file, revision_id):
 
 
1412
        """Print `file` to stdout.
 
 
1414
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
 
1415
        - it writes to stdout, it assumes that that is valid etc. Fix
 
 
1416
        by creating a new more flexible convenience function.
 
 
1418
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1419
        tree = self.revision_tree(revision_id)
 
 
1420
        # use inventory as it was in that revision
 
 
1421
        file_id = tree.inventory.path2id(file)
 
 
1423
            # TODO: jam 20060427 Write a test for this code path
 
 
1424
            #       it had a bug in it, and was raising the wrong
 
 
1426
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
 
1427
        tree.print_file(file_id)
 
 
1429
    def get_transaction(self):
 
 
1430
        return self.control_files.get_transaction()
 
 
1432
    def revision_parents(self, revision_id):
 
 
1433
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1434
        return self.get_inventory_weave().parent_names(revision_id)
 
 
1436
    def get_parents(self, revision_ids):
 
 
1437
        """See StackedParentsProvider.get_parents"""
 
 
1439
        for revision_id in revision_ids:
 
 
1440
            if revision_id == _mod_revision.NULL_REVISION:
 
 
1444
                    parents = self.get_revision(revision_id).parent_ids
 
 
1445
                except errors.NoSuchRevision:
 
 
1448
                    if len(parents) == 0:
 
 
1449
                        parents = [_mod_revision.NULL_REVISION]
 
 
1450
            parents_list.append(parents)
 
 
1453
    def _make_parents_provider(self):
 
 
1456
    def get_graph(self, other_repository=None):
 
 
1457
        """Return the graph walker for this repository format"""
 
 
1458
        parents_provider = self._make_parents_provider()
 
 
1459
        if (other_repository is not None and
 
 
1460
            other_repository.bzrdir.transport.base !=
 
 
1461
            self.bzrdir.transport.base):
 
 
1462
            parents_provider = graph._StackedParentsProvider(
 
 
1463
                [parents_provider, other_repository._make_parents_provider()])
 
 
1464
        return graph.Graph(parents_provider)
 
 
1467
    def set_make_working_trees(self, new_value):
 
 
1468
        """Set the policy flag for making working trees when creating branches.
 
 
1470
        This only applies to branches that use this repository.
 
 
1472
        The default is 'True'.
 
 
1473
        :param new_value: True to restore the default, False to disable making
 
 
1476
        raise NotImplementedError(self.set_make_working_trees)
 
 
1478
    def make_working_trees(self):
 
 
1479
        """Returns the policy for making working trees on new branches."""
 
 
1480
        raise NotImplementedError(self.make_working_trees)
 
 
1483
    def sign_revision(self, revision_id, gpg_strategy):
 
 
1484
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1485
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
 
1486
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
 
1489
    def has_signature_for_revision_id(self, revision_id):
 
 
1490
        """Query for a revision signature for revision_id in the repository."""
 
 
1491
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1492
        return self._revision_store.has_signature(revision_id,
 
 
1493
                                                  self.get_transaction())
 
 
1496
    def get_signature_text(self, revision_id):
 
 
1497
        """Return the text for a signature."""
 
 
1498
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1499
        return self._revision_store.get_signature_text(revision_id,
 
 
1500
                                                       self.get_transaction())
 
 
1503
    def check(self, revision_ids):
 
 
1504
        """Check consistency of all history of given revision_ids.
 
 
1506
        Different repository implementations should override _check().
 
 
1508
        :param revision_ids: A non-empty list of revision_ids whose ancestry
 
 
1509
             will be checked.  Typically the last revision_id of a branch.
 
 
1511
        if not revision_ids:
 
 
1512
            raise ValueError("revision_ids must be non-empty in %s.check" 
 
 
1514
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
 
1515
        return self._check(revision_ids)
 
 
1517
    def _check(self, revision_ids):
 
 
1518
        result = check.Check(self)
 
 
1522
    def _warn_if_deprecated(self):
 
 
1523
        global _deprecation_warning_done
 
 
1524
        if _deprecation_warning_done:
 
 
1526
        _deprecation_warning_done = True
 
 
1527
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
 
1528
                % (self._format, self.bzrdir.transport.base))
 
 
1530
    def supports_rich_root(self):
 
 
1531
        return self._format.rich_root_data
 
 
1533
    def _check_ascii_revisionid(self, revision_id, method):
 
 
1534
        """Private helper for ascii-only repositories."""
 
 
1535
        # weave repositories refuse to store revisionids that are non-ascii.
 
 
1536
        if revision_id is not None:
 
 
1537
            # weaves require ascii revision ids.
 
 
1538
            if isinstance(revision_id, unicode):
 
 
1540
                    revision_id.encode('ascii')
 
 
1541
                except UnicodeEncodeError:
 
 
1542
                    raise errors.NonAsciiRevisionId(method, self)
 
 
1545
                    revision_id.decode('ascii')
 
 
1546
                except UnicodeDecodeError:
 
 
1547
                    raise errors.NonAsciiRevisionId(method, self)
 
 
1551
# remove these delegates a while after bzr 0.15
 
 
1552
def __make_delegated(name, from_module):
 
 
1553
    def _deprecated_repository_forwarder():
 
 
1554
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
 
1555
            % (name, from_module),
 
 
1558
        m = __import__(from_module, globals(), locals(), [name])
 
 
1560
            return getattr(m, name)
 
 
1561
        except AttributeError:
 
 
1562
            raise AttributeError('module %s has no name %s'
 
 
1564
    globals()[name] = _deprecated_repository_forwarder
 
 
1567
        'AllInOneRepository',
 
 
1568
        'WeaveMetaDirRepository',
 
 
1569
        'PreSplitOutRepositoryFormat',
 
 
1570
        'RepositoryFormat4',
 
 
1571
        'RepositoryFormat5',
 
 
1572
        'RepositoryFormat6',
 
 
1573
        'RepositoryFormat7',
 
 
1575
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
 
1579
        'RepositoryFormatKnit',
 
 
1580
        'RepositoryFormatKnit1',
 
 
1582
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
 
1585
def install_revision(repository, rev, revision_tree):
 
 
1586
    """Install all revision data into a repository."""
 
 
1587
    present_parents = []
 
 
1589
    for p_id in rev.parent_ids:
 
 
1590
        if repository.has_revision(p_id):
 
 
1591
            present_parents.append(p_id)
 
 
1592
            parent_trees[p_id] = repository.revision_tree(p_id)
 
 
1594
            parent_trees[p_id] = repository.revision_tree(None)
 
 
1596
    inv = revision_tree.inventory
 
 
1597
    entries = inv.iter_entries()
 
 
1598
    # backwards compatibility hack: skip the root id.
 
 
1599
    if not repository.supports_rich_root():
 
 
1600
        path, root = entries.next()
 
 
1601
        if root.revision != rev.revision_id:
 
 
1602
            raise errors.IncompatibleRevision(repr(repository))
 
 
1603
    # Add the texts that are not already present
 
 
1604
    for path, ie in entries:
 
 
1605
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
 
1606
                repository.get_transaction())
 
 
1607
        if ie.revision not in w:
 
 
1609
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
 
1610
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
 
1611
            # is a latent bug here where the parents may have ancestors of each
 
 
1613
            for revision, tree in parent_trees.iteritems():
 
 
1614
                if ie.file_id not in tree:
 
 
1616
                parent_id = tree.inventory[ie.file_id].revision
 
 
1617
                if parent_id in text_parents:
 
 
1619
                text_parents.append(parent_id)
 
 
1621
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
 
1622
                repository.get_transaction())
 
 
1623
            lines = revision_tree.get_file(ie.file_id).readlines()
 
 
1624
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
 
1626
        # install the inventory
 
 
1627
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
 
1628
    except errors.RevisionAlreadyPresent:
 
 
1630
    repository.add_revision(rev.revision_id, rev, inv)
 
 
1633
class MetaDirRepository(Repository):
 
 
1634
    """Repositories in the new meta-dir layout."""
 
 
1636
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
 
1637
        super(MetaDirRepository, self).__init__(_format,
 
 
1643
        dir_mode = self.control_files._dir_mode
 
 
1644
        file_mode = self.control_files._file_mode
 
 
1647
    def is_shared(self):
 
 
1648
        """Return True if this repository is flagged as a shared repository."""
 
 
1649
        return self.control_files._transport.has('shared-storage')
 
 
1652
    def set_make_working_trees(self, new_value):
 
 
1653
        """Set the policy flag for making working trees when creating branches.
 
 
1655
        This only applies to branches that use this repository.
 
 
1657
        The default is 'True'.
 
 
1658
        :param new_value: True to restore the default, False to disable making
 
 
1663
                self.control_files._transport.delete('no-working-trees')
 
 
1664
            except errors.NoSuchFile:
 
 
1667
            self.control_files.put_utf8('no-working-trees', '')
 
 
1669
    def make_working_trees(self):
 
 
1670
        """Returns the policy for making working trees on new branches."""
 
 
1671
        return not self.control_files._transport.has('no-working-trees')
 
 
1674
class RepositoryFormatRegistry(registry.Registry):
 
 
1675
    """Registry of RepositoryFormats.
 
 
1678
    def get(self, format_string):
 
 
1679
        r = registry.Registry.get(self, format_string)
 
 
1685
format_registry = RepositoryFormatRegistry()
 
 
1686
"""Registry of formats, indexed by their identifying format string.
 
 
1688
This can contain either format instances themselves, or classes/factories that
 
 
1689
can be called to obtain one.
 
 
1693
#####################################################################
 
 
1694
# Repository Formats
 
 
1696
class RepositoryFormat(object):
 
 
1697
    """A repository format.
 
 
1699
    Formats provide three things:
 
 
1700
     * An initialization routine to construct repository data on disk.
 
 
1701
     * a format string which is used when the BzrDir supports versioned
 
 
1703
     * an open routine which returns a Repository instance.
 
 
1705
    Formats are placed in an dict by their format string for reference 
 
 
1706
    during opening. These should be subclasses of RepositoryFormat
 
 
1709
    Once a format is deprecated, just deprecate the initialize and open
 
 
1710
    methods on the format class. Do not deprecate the object, as the 
 
 
1711
    object will be created every system load.
 
 
1713
    Common instance attributes:
 
 
1714
    _matchingbzrdir - the bzrdir format that the repository format was
 
 
1715
    originally written to work with. This can be used if manually
 
 
1716
    constructing a bzrdir and repository, or more commonly for test suite
 
 
1721
        return "<%s>" % self.__class__.__name__
 
 
1723
    def __eq__(self, other):
 
 
1724
        # format objects are generally stateless
 
 
1725
        return isinstance(other, self.__class__)
 
 
1727
    def __ne__(self, other):
 
 
1728
        return not self == other
 
 
1731
    def find_format(klass, a_bzrdir):
 
 
1732
        """Return the format for the repository object in a_bzrdir.
 
 
1734
        This is used by bzr native formats that have a "format" file in
 
 
1735
        the repository.  Other methods may be used by different types of 
 
 
1739
            transport = a_bzrdir.get_repository_transport(None)
 
 
1740
            format_string = transport.get("format").read()
 
 
1741
            return format_registry.get(format_string)
 
 
1742
        except errors.NoSuchFile:
 
 
1743
            raise errors.NoRepositoryPresent(a_bzrdir)
 
 
1745
            raise errors.UnknownFormatError(format=format_string)
 
 
1748
    def register_format(klass, format):
 
 
1749
        format_registry.register(format.get_format_string(), format)
 
 
1752
    def unregister_format(klass, format):
 
 
1753
        format_registry.remove(format.get_format_string())
 
 
1756
    def get_default_format(klass):
 
 
1757
        """Return the current default format."""
 
 
1758
        from bzrlib import bzrdir
 
 
1759
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
 
1761
    def _get_control_store(self, repo_transport, control_files):
 
 
1762
        """Return the control store for this repository."""
 
 
1763
        raise NotImplementedError(self._get_control_store)
 
 
1765
    def get_format_string(self):
 
 
1766
        """Return the ASCII format string that identifies this format.
 
 
1768
        Note that in pre format ?? repositories the format string is 
 
 
1769
        not permitted nor written to disk.
 
 
1771
        raise NotImplementedError(self.get_format_string)
 
 
1773
    def get_format_description(self):
 
 
1774
        """Return the short description for this format."""
 
 
1775
        raise NotImplementedError(self.get_format_description)
 
 
1777
    def _get_revision_store(self, repo_transport, control_files):
 
 
1778
        """Return the revision store object for this a_bzrdir."""
 
 
1779
        raise NotImplementedError(self._get_revision_store)
 
 
1781
    def _get_text_rev_store(self,
 
 
1788
        """Common logic for getting a revision store for a repository.
 
 
1790
        see self._get_revision_store for the subclass-overridable method to 
 
 
1791
        get the store for a repository.
 
 
1793
        from bzrlib.store.revision.text import TextRevisionStore
 
 
1794
        dir_mode = control_files._dir_mode
 
 
1795
        file_mode = control_files._file_mode
 
 
1796
        text_store = TextStore(transport.clone(name),
 
 
1798
                              compressed=compressed,
 
 
1800
                              file_mode=file_mode)
 
 
1801
        _revision_store = TextRevisionStore(text_store, serializer)
 
 
1802
        return _revision_store
 
 
1804
    # TODO: this shouldn't be in the base class, it's specific to things that
 
 
1805
    # use weaves or knits -- mbp 20070207
 
 
1806
    def _get_versioned_file_store(self,
 
 
1811
                                  versionedfile_class=None,
 
 
1812
                                  versionedfile_kwargs={},
 
 
1814
        if versionedfile_class is None:
 
 
1815
            versionedfile_class = self._versionedfile_class
 
 
1816
        weave_transport = control_files._transport.clone(name)
 
 
1817
        dir_mode = control_files._dir_mode
 
 
1818
        file_mode = control_files._file_mode
 
 
1819
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
 
1821
                                  file_mode=file_mode,
 
 
1822
                                  versionedfile_class=versionedfile_class,
 
 
1823
                                  versionedfile_kwargs=versionedfile_kwargs,
 
 
1826
    def initialize(self, a_bzrdir, shared=False):
 
 
1827
        """Initialize a repository of this format in a_bzrdir.
 
 
1829
        :param a_bzrdir: The bzrdir to put the new repository in it.
 
 
1830
        :param shared: The repository should be initialized as a sharable one.
 
 
1831
        :returns: The new repository object.
 
 
1833
        This may raise UninitializableFormat if shared repository are not
 
 
1834
        compatible the a_bzrdir.
 
 
1836
        raise NotImplementedError(self.initialize)
 
 
1838
    def is_supported(self):
 
 
1839
        """Is this format supported?
 
 
1841
        Supported formats must be initializable and openable.
 
 
1842
        Unsupported formats may not support initialization or committing or 
 
 
1843
        some other features depending on the reason for not being supported.
 
 
1847
    def check_conversion_target(self, target_format):
 
 
1848
        raise NotImplementedError(self.check_conversion_target)
 
 
1850
    def open(self, a_bzrdir, _found=False):
 
 
1851
        """Return an instance of this format for the bzrdir a_bzrdir.
 
 
1853
        _found is a private parameter, do not use it.
 
 
1855
        raise NotImplementedError(self.open)
 
 
1858
class MetaDirRepositoryFormat(RepositoryFormat):
 
 
1859
    """Common base class for the new repositories using the metadir layout."""
 
 
1861
    rich_root_data = False
 
 
1862
    supports_tree_reference = False
 
 
1863
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1866
        super(MetaDirRepositoryFormat, self).__init__()
 
 
1868
    def _create_control_files(self, a_bzrdir):
 
 
1869
        """Create the required files and the initial control_files object."""
 
 
1870
        # FIXME: RBC 20060125 don't peek under the covers
 
 
1871
        # NB: no need to escape relative paths that are url safe.
 
 
1872
        repository_transport = a_bzrdir.get_repository_transport(self)
 
 
1873
        control_files = lockable_files.LockableFiles(repository_transport,
 
 
1874
                                'lock', lockdir.LockDir)
 
 
1875
        control_files.create_lock()
 
 
1876
        return control_files
 
 
1878
    def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
 
 
1879
        """Upload the initial blank content."""
 
 
1880
        control_files = self._create_control_files(a_bzrdir)
 
 
1881
        control_files.lock_write()
 
 
1883
            control_files._transport.mkdir_multi(dirs,
 
 
1884
                    mode=control_files._dir_mode)
 
 
1885
            for file, content in files:
 
 
1886
                control_files.put(file, content)
 
 
1887
            for file, content in utf8_files:
 
 
1888
                control_files.put_utf8(file, content)
 
 
1890
                control_files.put_utf8('shared-storage', '')
 
 
1892
            control_files.unlock()
 
 
1895
# formats which have no format string are not discoverable
 
 
1896
# and not independently creatable, so are not registered.  They're 
 
 
1897
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
 
1898
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
 
1899
# the repository is not separately opened are similar.
 
 
1901
format_registry.register_lazy(
 
 
1902
    'Bazaar-NG Repository format 7',
 
 
1903
    'bzrlib.repofmt.weaverepo',
 
 
1907
# KEEP in sync with bzrdir.format_registry default, which controls the overall
 
 
1908
# default control directory format
 
 
1909
format_registry.register_lazy(
 
 
1910
    'Bazaar-NG Knit Repository Format 1',
 
 
1911
    'bzrlib.repofmt.knitrepo',
 
 
1912
    'RepositoryFormatKnit1',
 
 
1914
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
 
 
1916
format_registry.register_lazy(
 
 
1917
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
 
1918
    'bzrlib.repofmt.knitrepo',
 
 
1919
    'RepositoryFormatKnit3',
 
 
1923
class InterRepository(InterObject):
 
 
1924
    """This class represents operations taking place between two repositories.
 
 
1926
    Its instances have methods like copy_content and fetch, and contain
 
 
1927
    references to the source and target repositories these operations can be 
 
 
1930
    Often we will provide convenience methods on 'repository' which carry out
 
 
1931
    operations with another repository - they will always forward to
 
 
1932
    InterRepository.get(other).method_name(parameters).
 
 
1936
    """The available optimised InterRepository types."""
 
 
1938
    def copy_content(self, revision_id=None):
 
 
1939
        raise NotImplementedError(self.copy_content)
 
 
1941
    def fetch(self, revision_id=None, pb=None):
 
 
1942
        """Fetch the content required to construct revision_id.
 
 
1944
        The content is copied from self.source to self.target.
 
 
1946
        :param revision_id: if None all content is copied, if NULL_REVISION no
 
 
1948
        :param pb: optional progress bar to use for progress reports. If not
 
 
1949
                   provided a default one will be created.
 
 
1951
        Returns the copied revision count and the failed revisions in a tuple:
 
 
1954
        raise NotImplementedError(self.fetch)
 
 
1957
    def missing_revision_ids(self, revision_id=None):
 
 
1958
        """Return the revision ids that source has that target does not.
 
 
1960
        These are returned in topological order.
 
 
1962
        :param revision_id: only return revision ids included by this
 
 
1965
        # generic, possibly worst case, slow code path.
 
 
1966
        target_ids = set(self.target.all_revision_ids())
 
 
1967
        if revision_id is not None:
 
 
1968
            # TODO: jam 20070210 InterRepository is internal enough that it
 
 
1969
            #       should assume revision_ids are already utf-8
 
 
1970
            revision_id = osutils.safe_revision_id(revision_id)
 
 
1971
            source_ids = self.source.get_ancestry(revision_id)
 
 
1972
            assert source_ids[0] is None
 
 
1975
            source_ids = self.source.all_revision_ids()
 
 
1976
        result_set = set(source_ids).difference(target_ids)
 
 
1977
        # this may look like a no-op: its not. It preserves the ordering
 
 
1978
        # other_ids had while only returning the members from other_ids
 
 
1979
        # that we've decided we need.
 
 
1980
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
 
1983
    def _same_model(source, target):
 
 
1984
        """True if source and target have the same data representation."""
 
 
1985
        if source.supports_rich_root() != target.supports_rich_root():
 
 
1987
        if source._serializer != target._serializer:
 
 
1992
class InterSameDataRepository(InterRepository):
 
 
1993
    """Code for converting between repositories that represent the same data.
 
 
1995
    Data format and model must match for this to work.
 
 
1999
    def _get_repo_format_to_test(self):
 
 
2000
        """Repository format for testing with.
 
 
2002
        InterSameData can pull from subtree to subtree and from non-subtree to
 
 
2003
        non-subtree, so we test this with the richest repository format.
 
 
2005
        from bzrlib.repofmt import knitrepo
 
 
2006
        return knitrepo.RepositoryFormatKnit3()
 
 
2009
    def is_compatible(source, target):
 
 
2010
        return InterRepository._same_model(source, target)
 
 
2013
    def copy_content(self, revision_id=None):
 
 
2014
        """Make a complete copy of the content in self into destination.
 
 
2016
        This copies both the repository's revision data, and configuration information
 
 
2017
        such as the make_working_trees setting.
 
 
2019
        This is a destructive operation! Do not use it on existing 
 
 
2022
        :param revision_id: Only copy the content needed to construct
 
 
2023
                            revision_id and its parents.
 
 
2026
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2027
        except NotImplementedError:
 
 
2029
        # TODO: jam 20070210 This is fairly internal, so we should probably
 
 
2030
        #       just assert that revision_id is not unicode.
 
 
2031
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2032
        # but don't bother fetching if we have the needed data now.
 
 
2033
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
 
2034
            self.target.has_revision(revision_id)):
 
 
2036
        self.target.fetch(self.source, revision_id=revision_id)
 
 
2039
    def fetch(self, revision_id=None, pb=None):
 
 
2040
        """See InterRepository.fetch()."""
 
 
2041
        from bzrlib.fetch import GenericRepoFetcher
 
 
2042
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2043
               self.source, self.source._format, self.target, 
 
 
2044
               self.target._format)
 
 
2045
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2046
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2047
        f = GenericRepoFetcher(to_repository=self.target,
 
 
2048
                               from_repository=self.source,
 
 
2049
                               last_revision=revision_id,
 
 
2051
        return f.count_copied, f.failed_revisions
 
 
2054
class InterWeaveRepo(InterSameDataRepository):
 
 
2055
    """Optimised code paths between Weave based repositories.
 
 
2057
    This should be in bzrlib/repofmt/weaverepo.py but we have not yet
 
 
2058
    implemented lazy inter-object optimisation.
 
 
2062
    def _get_repo_format_to_test(self):
 
 
2063
        from bzrlib.repofmt import weaverepo
 
 
2064
        return weaverepo.RepositoryFormat7()
 
 
2067
    def is_compatible(source, target):
 
 
2068
        """Be compatible with known Weave formats.
 
 
2070
        We don't test for the stores being of specific types because that
 
 
2071
        could lead to confusing results, and there is no need to be 
 
 
2074
        from bzrlib.repofmt.weaverepo import (
 
 
2080
            return (isinstance(source._format, (RepositoryFormat5,
 
 
2082
                                                RepositoryFormat7)) and
 
 
2083
                    isinstance(target._format, (RepositoryFormat5,
 
 
2085
                                                RepositoryFormat7)))
 
 
2086
        except AttributeError:
 
 
2090
    def copy_content(self, revision_id=None):
 
 
2091
        """See InterRepository.copy_content()."""
 
 
2092
        # weave specific optimised path:
 
 
2093
        # TODO: jam 20070210 Internal, should be an assert, not translate
 
 
2094
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2096
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2097
        except NotImplementedError:
 
 
2099
        # FIXME do not peek!
 
 
2100
        if self.source.control_files._transport.listable():
 
 
2101
            pb = ui.ui_factory.nested_progress_bar()
 
 
2103
                self.target.weave_store.copy_all_ids(
 
 
2104
                    self.source.weave_store,
 
 
2106
                    from_transaction=self.source.get_transaction(),
 
 
2107
                    to_transaction=self.target.get_transaction())
 
 
2108
                pb.update('copying inventory', 0, 1)
 
 
2109
                self.target.control_weaves.copy_multi(
 
 
2110
                    self.source.control_weaves, ['inventory'],
 
 
2111
                    from_transaction=self.source.get_transaction(),
 
 
2112
                    to_transaction=self.target.get_transaction())
 
 
2113
                self.target._revision_store.text_store.copy_all_ids(
 
 
2114
                    self.source._revision_store.text_store,
 
 
2119
            self.target.fetch(self.source, revision_id=revision_id)
 
 
2122
    def fetch(self, revision_id=None, pb=None):
 
 
2123
        """See InterRepository.fetch()."""
 
 
2124
        from bzrlib.fetch import GenericRepoFetcher
 
 
2125
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2126
               self.source, self.source._format, self.target, self.target._format)
 
 
2127
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2128
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2129
        f = GenericRepoFetcher(to_repository=self.target,
 
 
2130
                               from_repository=self.source,
 
 
2131
                               last_revision=revision_id,
 
 
2133
        return f.count_copied, f.failed_revisions
 
 
2136
    def missing_revision_ids(self, revision_id=None):
 
 
2137
        """See InterRepository.missing_revision_ids()."""
 
 
2138
        # we want all revisions to satisfy revision_id in source.
 
 
2139
        # but we don't want to stat every file here and there.
 
 
2140
        # we want then, all revisions other needs to satisfy revision_id 
 
 
2141
        # checked, but not those that we have locally.
 
 
2142
        # so the first thing is to get a subset of the revisions to 
 
 
2143
        # satisfy revision_id in source, and then eliminate those that
 
 
2144
        # we do already have. 
 
 
2145
        # this is slow on high latency connection to self, but as as this
 
 
2146
        # disk format scales terribly for push anyway due to rewriting 
 
 
2147
        # inventory.weave, this is considered acceptable.
 
 
2149
        if revision_id is not None:
 
 
2150
            source_ids = self.source.get_ancestry(revision_id)
 
 
2151
            assert source_ids[0] is None
 
 
2154
            source_ids = self.source._all_possible_ids()
 
 
2155
        source_ids_set = set(source_ids)
 
 
2156
        # source_ids is the worst possible case we may need to pull.
 
 
2157
        # now we want to filter source_ids against what we actually
 
 
2158
        # have in target, but don't try to check for existence where we know
 
 
2159
        # we do not have a revision as that would be pointless.
 
 
2160
        target_ids = set(self.target._all_possible_ids())
 
 
2161
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
 
2162
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
 
2163
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
 
2164
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
 
2165
        if revision_id is not None:
 
 
2166
            # we used get_ancestry to determine source_ids then we are assured all
 
 
2167
            # revisions referenced are present as they are installed in topological order.
 
 
2168
            # and the tip revision was validated by get_ancestry.
 
 
2169
            return required_topo_revisions
 
 
2171
            # if we just grabbed the possibly available ids, then 
 
 
2172
            # we only have an estimate of whats available and need to validate
 
 
2173
            # that against the revision records.
 
 
2174
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
 
2177
class InterKnitRepo(InterSameDataRepository):
 
 
2178
    """Optimised code paths between Knit based repositories."""
 
 
2181
    def _get_repo_format_to_test(self):
 
 
2182
        from bzrlib.repofmt import knitrepo
 
 
2183
        return knitrepo.RepositoryFormatKnit1()
 
 
2186
    def is_compatible(source, target):
 
 
2187
        """Be compatible with known Knit formats.
 
 
2189
        We don't test for the stores being of specific types because that
 
 
2190
        could lead to confusing results, and there is no need to be 
 
 
2193
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit
 
 
2195
            are_knits = (isinstance(source._format, RepositoryFormatKnit) and
 
 
2196
                isinstance(target._format, RepositoryFormatKnit))
 
 
2197
        except AttributeError:
 
 
2199
        return are_knits and InterRepository._same_model(source, target)
 
 
2202
    def fetch(self, revision_id=None, pb=None):
 
 
2203
        """See InterRepository.fetch()."""
 
 
2204
        from bzrlib.fetch import KnitRepoFetcher
 
 
2205
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2206
               self.source, self.source._format, self.target, self.target._format)
 
 
2207
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2208
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2209
        f = KnitRepoFetcher(to_repository=self.target,
 
 
2210
                            from_repository=self.source,
 
 
2211
                            last_revision=revision_id,
 
 
2213
        return f.count_copied, f.failed_revisions
 
 
2216
    def missing_revision_ids(self, revision_id=None):
 
 
2217
        """See InterRepository.missing_revision_ids()."""
 
 
2218
        if revision_id is not None:
 
 
2219
            source_ids = self.source.get_ancestry(revision_id)
 
 
2220
            assert source_ids[0] is None
 
 
2223
            source_ids = self.source.all_revision_ids()
 
 
2224
        source_ids_set = set(source_ids)
 
 
2225
        # source_ids is the worst possible case we may need to pull.
 
 
2226
        # now we want to filter source_ids against what we actually
 
 
2227
        # have in target, but don't try to check for existence where we know
 
 
2228
        # we do not have a revision as that would be pointless.
 
 
2229
        target_ids = set(self.target.all_revision_ids())
 
 
2230
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
 
2231
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
 
2232
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
 
2233
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
 
2234
        if revision_id is not None:
 
 
2235
            # we used get_ancestry to determine source_ids then we are assured all
 
 
2236
            # revisions referenced are present as they are installed in topological order.
 
 
2237
            # and the tip revision was validated by get_ancestry.
 
 
2238
            return required_topo_revisions
 
 
2240
            # if we just grabbed the possibly available ids, then 
 
 
2241
            # we only have an estimate of whats available and need to validate
 
 
2242
            # that against the revision records.
 
 
2243
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
 
2246
class InterModel1and2(InterRepository):
 
 
2249
    def _get_repo_format_to_test(self):
 
 
2253
    def is_compatible(source, target):
 
 
2254
        if not source.supports_rich_root() and target.supports_rich_root():
 
 
2260
    def fetch(self, revision_id=None, pb=None):
 
 
2261
        """See InterRepository.fetch()."""
 
 
2262
        from bzrlib.fetch import Model1toKnit2Fetcher
 
 
2263
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2264
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2265
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
 
2266
                                 from_repository=self.source,
 
 
2267
                                 last_revision=revision_id,
 
 
2269
        return f.count_copied, f.failed_revisions
 
 
2272
    def copy_content(self, revision_id=None):
 
 
2273
        """Make a complete copy of the content in self into destination.
 
 
2275
        This is a destructive operation! Do not use it on existing 
 
 
2278
        :param revision_id: Only copy the content needed to construct
 
 
2279
                            revision_id and its parents.
 
 
2282
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2283
        except NotImplementedError:
 
 
2285
        # TODO: jam 20070210 Internal, assert, don't translate
 
 
2286
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2287
        # but don't bother fetching if we have the needed data now.
 
 
2288
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
 
2289
            self.target.has_revision(revision_id)):
 
 
2291
        self.target.fetch(self.source, revision_id=revision_id)
 
 
2294
class InterKnit1and2(InterKnitRepo):
 
 
2297
    def _get_repo_format_to_test(self):
 
 
2301
    def is_compatible(source, target):
 
 
2302
        """Be compatible with Knit1 source and Knit3 target"""
 
 
2303
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
 
2305
            from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
 
 
2306
                    RepositoryFormatKnit3
 
 
2307
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
 
 
2308
                    isinstance(target._format, (RepositoryFormatKnit3)))
 
 
2309
        except AttributeError:
 
 
2313
    def fetch(self, revision_id=None, pb=None):
 
 
2314
        """See InterRepository.fetch()."""
 
 
2315
        from bzrlib.fetch import Knit1to2Fetcher
 
 
2316
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2317
               self.source, self.source._format, self.target, 
 
 
2318
               self.target._format)
 
 
2319
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2320
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2321
        f = Knit1to2Fetcher(to_repository=self.target,
 
 
2322
                            from_repository=self.source,
 
 
2323
                            last_revision=revision_id,
 
 
2325
        return f.count_copied, f.failed_revisions
 
 
2328
class InterRemoteRepository(InterRepository):
 
 
2329
    """Code for converting between RemoteRepository objects.
 
 
2331
    This just gets an non-remote repository from the RemoteRepository, and calls
 
 
2332
    InterRepository.get again.
 
 
2335
    def __init__(self, source, target):
 
 
2336
        if isinstance(source, remote.RemoteRepository):
 
 
2337
            source._ensure_real()
 
 
2338
            real_source = source._real_repository
 
 
2340
            real_source = source
 
 
2341
        if isinstance(target, remote.RemoteRepository):
 
 
2342
            target._ensure_real()
 
 
2343
            real_target = target._real_repository
 
 
2345
            real_target = target
 
 
2346
        self.real_inter = InterRepository.get(real_source, real_target)
 
 
2349
    def is_compatible(source, target):
 
 
2350
        if isinstance(source, remote.RemoteRepository):
 
 
2352
        if isinstance(target, remote.RemoteRepository):
 
 
2356
    def copy_content(self, revision_id=None):
 
 
2357
        self.real_inter.copy_content(revision_id=revision_id)
 
 
2359
    def fetch(self, revision_id=None, pb=None):
 
 
2360
        self.real_inter.fetch(revision_id=revision_id, pb=pb)
 
 
2363
    def _get_repo_format_to_test(self):
 
 
2367
InterRepository.register_optimiser(InterSameDataRepository)
 
 
2368
InterRepository.register_optimiser(InterWeaveRepo)
 
 
2369
InterRepository.register_optimiser(InterKnitRepo)
 
 
2370
InterRepository.register_optimiser(InterModel1and2)
 
 
2371
InterRepository.register_optimiser(InterKnit1and2)
 
 
2372
InterRepository.register_optimiser(InterRemoteRepository)
 
 
2375
class CopyConverter(object):
 
 
2376
    """A repository conversion tool which just performs a copy of the content.
 
 
2378
    This is slow but quite reliable.
 
 
2381
    def __init__(self, target_format):
 
 
2382
        """Create a CopyConverter.
 
 
2384
        :param target_format: The format the resulting repository should be.
 
 
2386
        self.target_format = target_format
 
 
2388
    def convert(self, repo, pb):
 
 
2389
        """Perform the conversion of to_convert, giving feedback via pb.
 
 
2391
        :param to_convert: The disk object to convert.
 
 
2392
        :param pb: a progress bar to use for progress information.
 
 
2397
        # this is only useful with metadir layouts - separated repo content.
 
 
2398
        # trigger an assertion if not such
 
 
2399
        repo._format.get_format_string()
 
 
2400
        self.repo_dir = repo.bzrdir
 
 
2401
        self.step('Moving repository to repository.backup')
 
 
2402
        self.repo_dir.transport.move('repository', 'repository.backup')
 
 
2403
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
 
2404
        repo._format.check_conversion_target(self.target_format)
 
 
2405
        self.source_repo = repo._format.open(self.repo_dir,
 
 
2407
            _override_transport=backup_transport)
 
 
2408
        self.step('Creating new repository')
 
 
2409
        converted = self.target_format.initialize(self.repo_dir,
 
 
2410
                                                  self.source_repo.is_shared())
 
 
2411
        converted.lock_write()
 
 
2413
            self.step('Copying content into repository.')
 
 
2414
            self.source_repo.copy_content_into(converted)
 
 
2417
        self.step('Deleting old repository content.')
 
 
2418
        self.repo_dir.transport.delete_tree('repository.backup')
 
 
2419
        self.pb.note('repository converted')
 
 
2421
    def step(self, message):
 
 
2422
        """Update the pb by a step."""
 
 
2424
        self.pb.update(message, self.count, self.total)
 
 
2436
def _unescaper(match, _map=_unescape_map):
 
 
2437
    code = match.group(1)
 
 
2441
        if not code.startswith('#'):
 
 
2443
        return unichr(int(code[1:])).encode('utf8')
 
 
2449
def _unescape_xml(data):
 
 
2450
    """Unescape predefined XML entities in a string of data."""
 
 
2452
    if _unescape_re is None:
 
 
2453
        _unescape_re = re.compile('\&([^;]*);')
 
 
2454
    return _unescape_re.sub(_unescaper, data)