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
 
 
74
    def __init__(self, repository, parents, config, timestamp=None, 
 
 
75
                 timezone=None, committer=None, revprops=None, 
 
 
77
        """Initiate a CommitBuilder.
 
 
79
        :param repository: Repository to commit to.
 
 
80
        :param parents: Revision ids of the parents of the new revision.
 
 
81
        :param config: Configuration to use.
 
 
82
        :param timestamp: Optional timestamp recorded for commit.
 
 
83
        :param timezone: Optional timezone for timestamp.
 
 
84
        :param committer: Optional committer to set for commit.
 
 
85
        :param revprops: Optional dictionary of revision properties.
 
 
86
        :param revision_id: Optional revision id.
 
 
91
            self._committer = self._config.username()
 
 
93
            assert isinstance(committer, basestring), type(committer)
 
 
94
            self._committer = committer
 
 
96
        self.new_inventory = Inventory(None)
 
 
97
        self._new_revision_id = osutils.safe_revision_id(revision_id)
 
 
98
        self.parents = parents
 
 
99
        self.repository = repository
 
 
102
        if revprops is not None:
 
 
103
            self._revprops.update(revprops)
 
 
105
        if timestamp is None:
 
 
106
            timestamp = time.time()
 
 
107
        # Restrict resolution to 1ms
 
 
108
        self._timestamp = round(timestamp, 3)
 
 
111
            self._timezone = osutils.local_time_offset()
 
 
113
            self._timezone = int(timezone)
 
 
115
        self._generate_revision_if_needed()
 
 
117
    def commit(self, message):
 
 
118
        """Make the actual commit.
 
 
120
        :return: The revision id of the recorded revision.
 
 
122
        rev = _mod_revision.Revision(
 
 
123
                       timestamp=self._timestamp,
 
 
124
                       timezone=self._timezone,
 
 
125
                       committer=self._committer,
 
 
127
                       inventory_sha1=self.inv_sha1,
 
 
128
                       revision_id=self._new_revision_id,
 
 
129
                       properties=self._revprops)
 
 
130
        rev.parent_ids = self.parents
 
 
131
        self.repository.add_revision(self._new_revision_id, rev,
 
 
132
            self.new_inventory, self._config)
 
 
133
        self.repository.commit_write_group()
 
 
134
        return self._new_revision_id
 
 
137
        """Abort the commit that is being built.
 
 
139
        self.repository.abort_write_group()
 
 
141
    def revision_tree(self):
 
 
142
        """Return the tree that was just committed.
 
 
144
        After calling commit() this can be called to get a RevisionTree
 
 
145
        representing the newly committed tree. This is preferred to
 
 
146
        calling Repository.revision_tree() because that may require
 
 
147
        deserializing the inventory, while we already have a copy in
 
 
150
        return RevisionTree(self.repository, self.new_inventory,
 
 
151
                            self._new_revision_id)
 
 
153
    def finish_inventory(self):
 
 
154
        """Tell the builder that the inventory is finished."""
 
 
155
        if self.new_inventory.root is None:
 
 
156
            symbol_versioning.warn('Root entry should be supplied to'
 
 
157
                ' record_entry_contents, as of bzr 0.10.',
 
 
158
                 DeprecationWarning, stacklevel=2)
 
 
159
            self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
 
 
160
        self.new_inventory.revision_id = self._new_revision_id
 
 
161
        self.inv_sha1 = self.repository.add_inventory(
 
 
162
            self._new_revision_id,
 
 
167
    def _gen_revision_id(self):
 
 
168
        """Return new revision-id."""
 
 
169
        return generate_ids.gen_revision_id(self._config.username(),
 
 
172
    def _generate_revision_if_needed(self):
 
 
173
        """Create a revision id if None was supplied.
 
 
175
        If the repository can not support user-specified revision ids
 
 
176
        they should override this function and raise CannotSetRevisionId
 
 
177
        if _new_revision_id is not None.
 
 
179
        :raises: CannotSetRevisionId
 
 
181
        if self._new_revision_id is None:
 
 
182
            self._new_revision_id = self._gen_revision_id()
 
 
183
            self.random_revid = True
 
 
185
            self.random_revid = False
 
 
187
    def _check_root(self, ie, parent_invs, tree):
 
 
188
        """Helper for record_entry_contents.
 
 
190
        :param ie: An entry being added.
 
 
191
        :param parent_invs: The inventories of the parent revisions of the
 
 
193
        :param tree: The tree that is being committed.
 
 
195
        if ie.parent_id is not None:
 
 
196
            # if ie is not root, add a root automatically.
 
 
197
            symbol_versioning.warn('Root entry should be supplied to'
 
 
198
                ' record_entry_contents, as of bzr 0.10.',
 
 
199
                 DeprecationWarning, stacklevel=2)
 
 
200
            self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
 
 
203
            # In this revision format, root entries have no knit or weave When
 
 
204
            # serializing out to disk and back in root.revision is always
 
 
206
            ie.revision = self._new_revision_id
 
 
208
    def record_entry_contents(self, ie, parent_invs, path, tree):
 
 
209
        """Record the content of ie from tree into the commit if needed.
 
 
211
        Side effect: sets ie.revision when unchanged
 
 
213
        :param ie: An inventory entry present in the commit.
 
 
214
        :param parent_invs: The inventories of the parent revisions of the
 
 
216
        :param path: The path the entry is at in the tree.
 
 
217
        :param tree: The tree which contains this entry and should be used to 
 
 
220
        if self.new_inventory.root is None:
 
 
221
            self._check_root(ie, parent_invs, tree)
 
 
222
        self.new_inventory.add(ie)
 
 
224
        # ie.revision is always None if the InventoryEntry is considered
 
 
225
        # for committing. ie.snapshot will record the correct revision 
 
 
226
        # which may be the sole parent if it is untouched.
 
 
227
        if ie.revision is not None:
 
 
230
        parent_candiate_entries = ie.parent_candidates(parent_invs)
 
 
231
        heads = self.repository.get_graph().heads(parent_candiate_entries.keys())
 
 
232
        # XXX: Note that this is unordered - and this is tolerable because 
 
 
233
        # the previous code was also unordered.
 
 
234
        previous_entries = dict((head, parent_candiate_entries[head]) for head
 
 
236
        # we are creating a new revision for ie in the history store and
 
 
238
        ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
 
 
240
    def modified_directory(self, file_id, file_parents):
 
 
241
        """Record the presence of a symbolic link.
 
 
243
        :param file_id: The file_id of the link to record.
 
 
244
        :param file_parents: The per-file parent revision ids.
 
 
246
        self._add_text_to_weave(file_id, [], file_parents.keys())
 
 
248
    def modified_reference(self, file_id, file_parents):
 
 
249
        """Record the modification of a reference.
 
 
251
        :param file_id: The file_id of the link to record.
 
 
252
        :param file_parents: The per-file parent revision ids.
 
 
254
        self._add_text_to_weave(file_id, [], file_parents.keys())
 
 
256
    def modified_file_text(self, file_id, file_parents,
 
 
257
                           get_content_byte_lines, text_sha1=None,
 
 
259
        """Record the text of file file_id
 
 
261
        :param file_id: The file_id of the file to record the text of.
 
 
262
        :param file_parents: The per-file parent revision ids.
 
 
263
        :param get_content_byte_lines: A callable which will return the byte
 
 
265
        :param text_sha1: Optional SHA1 of the file contents.
 
 
266
        :param text_size: Optional size of the file contents.
 
 
268
        # mutter('storing text of file {%s} in revision {%s} into %r',
 
 
269
        #        file_id, self._new_revision_id, self.repository.weave_store)
 
 
270
        # special case to avoid diffing on renames or 
 
 
272
        if (len(file_parents) == 1
 
 
273
            and text_sha1 == file_parents.values()[0].text_sha1
 
 
274
            and text_size == file_parents.values()[0].text_size):
 
 
275
            previous_ie = file_parents.values()[0]
 
 
276
            versionedfile = self.repository.weave_store.get_weave(file_id,
 
 
277
                self.repository.get_transaction())
 
 
278
            versionedfile.clone_text(self._new_revision_id,
 
 
279
                previous_ie.revision, file_parents.keys())
 
 
280
            return text_sha1, text_size
 
 
282
            new_lines = get_content_byte_lines()
 
 
283
            return self._add_text_to_weave(file_id, new_lines,
 
 
286
    def modified_link(self, file_id, file_parents, link_target):
 
 
287
        """Record the presence of a symbolic link.
 
 
289
        :param file_id: The file_id of the link to record.
 
 
290
        :param file_parents: The per-file parent revision ids.
 
 
291
        :param link_target: Target location of this link.
 
 
293
        self._add_text_to_weave(file_id, [], file_parents.keys())
 
 
295
    def _add_text_to_weave(self, file_id, new_lines, parents):
 
 
296
        versionedfile = self.repository.weave_store.get_weave_or_empty(
 
 
297
            file_id, self.repository.get_transaction())
 
 
298
        # Don't change this to add_lines - add_lines_with_ghosts is cheaper
 
 
299
        # than add_lines, and allows committing when a parent is ghosted for
 
 
301
        # Note: as we read the content directly from the tree, we know its not
 
 
302
        # been turned into unicode or badly split - but a broken tree
 
 
303
        # implementation could give us bad output from readlines() so this is
 
 
304
        # not a guarantee of safety. What would be better is always checking
 
 
305
        # the content during test suite execution. RBC 20070912
 
 
306
        result = versionedfile.add_lines_with_ghosts(
 
 
307
            self._new_revision_id, parents, new_lines,
 
 
308
            random_id=self.random_revid, check_content=False)[0:2]
 
 
309
        versionedfile.clear_cache()
 
 
313
class RootCommitBuilder(CommitBuilder):
 
 
314
    """This commitbuilder actually records the root id"""
 
 
316
    def _check_root(self, ie, parent_invs, tree):
 
 
317
        """Helper for record_entry_contents.
 
 
319
        :param ie: An entry being added.
 
 
320
        :param parent_invs: The inventories of the parent revisions of the
 
 
322
        :param tree: The tree that is being committed.
 
 
324
        # ie must be root for this builder
 
 
325
        assert ie.parent_id is None
 
 
328
######################################################################
 
 
331
class Repository(object):
 
 
332
    """Repository holding history for one or more branches.
 
 
334
    The repository holds and retrieves historical information including
 
 
335
    revisions and file history.  It's normally accessed only by the Branch,
 
 
336
    which views a particular line of development through that history.
 
 
338
    The Repository builds on top of Stores and a Transport, which respectively 
 
 
339
    describe the disk data format and the way of accessing the (possibly 
 
 
343
    # What class to use for a CommitBuilder. Often its simpler to change this
 
 
344
    # in a Repository class subclass rather than to override
 
 
345
    # get_commit_builder.
 
 
346
    _commit_builder_class = CommitBuilder
 
 
347
    # The search regex used by xml based repositories to determine what things
 
 
348
    # where changed in a single commit.
 
 
349
    _file_ids_altered_regex = lazy_regex.lazy_compile(
 
 
350
        r'file_id="(?P<file_id>[^"]+)"'
 
 
351
        r'.* revision="(?P<revision_id>[^"]+)"'
 
 
354
    def abort_write_group(self):
 
 
355
        """Commit the contents accrued within the current write group.
 
 
357
        :seealso: start_write_group.
 
 
359
        if self._write_group is not self.get_transaction():
 
 
360
            # has an unlock or relock occured ?
 
 
361
            raise errors.BzrError('mismatched lock context and write group.')
 
 
362
        self._abort_write_group()
 
 
363
        self._write_group = None
 
 
365
    def _abort_write_group(self):
 
 
366
        """Template method for per-repository write group cleanup.
 
 
368
        This is called during abort before the write group is considered to be 
 
 
369
        finished and should cleanup any internal state accrued during the write
 
 
370
        group. There is no requirement that data handed to the repository be
 
 
371
        *not* made available - this is not a rollback - but neither should any
 
 
372
        attempt be made to ensure that data added is fully commited. Abort is
 
 
373
        invoked when an error has occured so futher disk or network operations
 
 
374
        may not be possible or may error and if possible should not be
 
 
379
    def add_inventory(self, revision_id, inv, parents):
 
 
380
        """Add the inventory inv to the repository as revision_id.
 
 
382
        :param parents: The revision ids of the parents that revision_id
 
 
383
                        is known to have and are in the repository already.
 
 
385
        returns the sha1 of the serialized inventory.
 
 
387
        revision_id = osutils.safe_revision_id(revision_id)
 
 
388
        _mod_revision.check_not_reserved_id(revision_id)
 
 
389
        assert inv.revision_id is None or inv.revision_id == revision_id, \
 
 
390
            "Mismatch between inventory revision" \
 
 
391
            " id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
 
 
392
        assert inv.root is not None
 
 
393
        inv_lines = self._serialise_inventory_to_lines(inv)
 
 
394
        inv_vf = self.get_inventory_weave()
 
 
395
        return self._inventory_add_lines(inv_vf, revision_id, parents,
 
 
396
            inv_lines, check_content=False)
 
 
398
    def _inventory_add_lines(self, inv_vf, revision_id, parents, lines,
 
 
400
        """Store lines in inv_vf and return the sha1 of the inventory."""
 
 
402
        for parent in parents:
 
 
404
                final_parents.append(parent)
 
 
405
        return inv_vf.add_lines(revision_id, final_parents, lines,
 
 
406
            check_content=check_content)[0]
 
 
409
    def add_revision(self, revision_id, rev, inv=None, config=None):
 
 
410
        """Add rev to the revision store as revision_id.
 
 
412
        :param revision_id: the revision id to use.
 
 
413
        :param rev: The revision object.
 
 
414
        :param inv: The inventory for the revision. if None, it will be looked
 
 
415
                    up in the inventory storer
 
 
416
        :param config: If None no digital signature will be created.
 
 
417
                       If supplied its signature_needed method will be used
 
 
418
                       to determine if a signature should be made.
 
 
420
        revision_id = osutils.safe_revision_id(revision_id)
 
 
421
        # TODO: jam 20070210 Shouldn't we check rev.revision_id and
 
 
423
        _mod_revision.check_not_reserved_id(revision_id)
 
 
424
        if config is not None and config.signature_needed():
 
 
426
                inv = self.get_inventory(revision_id)
 
 
427
            plaintext = Testament(rev, inv).as_short_text()
 
 
428
            self.store_revision_signature(
 
 
429
                gpg.GPGStrategy(config), plaintext, revision_id)
 
 
430
        if not revision_id in self.get_inventory_weave():
 
 
432
                raise errors.WeaveRevisionNotPresent(revision_id,
 
 
433
                                                     self.get_inventory_weave())
 
 
435
                # yes, this is not suitable for adding with ghosts.
 
 
436
                self.add_inventory(revision_id, inv, rev.parent_ids)
 
 
437
        self._revision_store.add_revision(rev, self.get_transaction())
 
 
439
    def _add_revision_text(self, revision_id, text):
 
 
440
        revision = self._revision_store._serializer.read_revision_from_string(
 
 
442
        self._revision_store._add_revision(revision, StringIO(text),
 
 
443
                                           self.get_transaction())
 
 
446
    def _all_possible_ids(self):
 
 
447
        """Return all the possible revisions that we could find."""
 
 
448
        return self.get_inventory_weave().versions()
 
 
450
    def all_revision_ids(self):
 
 
451
        """Returns a list of all the revision ids in the repository. 
 
 
453
        This is deprecated because code should generally work on the graph
 
 
454
        reachable from a particular revision, and ignore any other revisions
 
 
455
        that might be present.  There is no direct replacement method.
 
 
457
        return self._all_revision_ids()
 
 
460
    def _all_revision_ids(self):
 
 
461
        """Returns a list of all the revision ids in the repository. 
 
 
463
        These are in as much topological order as the underlying store can 
 
 
464
        present: for weaves ghosts may lead to a lack of correctness until
 
 
465
        the reweave updates the parents list.
 
 
467
        if self._revision_store.text_store.listable():
 
 
468
            return self._revision_store.all_revision_ids(self.get_transaction())
 
 
469
        result = self._all_possible_ids()
 
 
470
        # TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
 
 
471
        #       ids. (It should, since _revision_store's API should change to
 
 
472
        #       return utf8 revision_ids)
 
 
473
        return self._eliminate_revisions_not_present(result)
 
 
475
    def break_lock(self):
 
 
476
        """Break a lock if one is present from another instance.
 
 
478
        Uses the ui factory to ask for confirmation if the lock may be from
 
 
481
        self.control_files.break_lock()
 
 
484
    def _eliminate_revisions_not_present(self, revision_ids):
 
 
485
        """Check every revision id in revision_ids to see if we have it.
 
 
487
        Returns a set of the present revisions.
 
 
490
        for id in revision_ids:
 
 
491
            if self.has_revision(id):
 
 
496
    def create(a_bzrdir):
 
 
497
        """Construct the current default format repository in a_bzrdir."""
 
 
498
        return RepositoryFormat.get_default_format().initialize(a_bzrdir)
 
 
500
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
 
501
        """instantiate a Repository.
 
 
503
        :param _format: The format of the repository on disk.
 
 
504
        :param a_bzrdir: The BzrDir of the repository.
 
 
506
        In the future we will have a single api for all stores for
 
 
507
        getting file texts, inventories and revisions, then
 
 
508
        this construct will accept instances of those things.
 
 
510
        super(Repository, self).__init__()
 
 
511
        self._format = _format
 
 
512
        # the following are part of the public API for Repository:
 
 
513
        self.bzrdir = a_bzrdir
 
 
514
        self.control_files = control_files
 
 
515
        self._revision_store = _revision_store
 
 
516
        # backwards compatibility
 
 
517
        self.weave_store = text_store
 
 
519
        self._reconcile_does_inventory_gc = True
 
 
520
        # not right yet - should be more semantically clear ? 
 
 
522
        self.control_store = control_store
 
 
523
        self.control_weaves = control_store
 
 
524
        # TODO: make sure to construct the right store classes, etc, depending
 
 
525
        # on whether escaping is required.
 
 
526
        self._warn_if_deprecated()
 
 
527
        self._write_group = None
 
 
530
        return '%s(%r)' % (self.__class__.__name__, 
 
 
531
                           self.bzrdir.transport.base)
 
 
533
    def has_same_location(self, other):
 
 
534
        """Returns a boolean indicating if this repository is at the same
 
 
535
        location as another repository.
 
 
537
        This might return False even when two repository objects are accessing
 
 
538
        the same physical repository via different URLs.
 
 
540
        if self.__class__ is not other.__class__:
 
 
542
        return (self.control_files._transport.base ==
 
 
543
                other.control_files._transport.base)
 
 
545
    def is_in_write_group(self):
 
 
546
        """Return True if there is an open write group.
 
 
548
        :seealso: start_write_group.
 
 
550
        return self._write_group is not None
 
 
553
        return self.control_files.is_locked()
 
 
555
    def lock_write(self, token=None):
 
 
556
        """Lock this repository for writing.
 
 
558
        This causes caching within the repository obejct to start accumlating
 
 
559
        data during reads, and allows a 'write_group' to be obtained. Write
 
 
560
        groups must be used for actual data insertion.
 
 
562
        :param token: if this is already locked, then lock_write will fail
 
 
563
            unless the token matches the existing lock.
 
 
564
        :returns: a token if this instance supports tokens, otherwise None.
 
 
565
        :raises TokenLockingNotSupported: when a token is given but this
 
 
566
            instance doesn't support using token locks.
 
 
567
        :raises MismatchedToken: if the specified token doesn't match the token
 
 
568
            of the existing lock.
 
 
569
        :seealso: start_write_group.
 
 
571
        A token should be passed in if you know that you have locked the object
 
 
572
        some other way, and need to synchronise this object's state with that
 
 
575
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
 
577
        result = self.control_files.lock_write(token=token)
 
 
582
        self.control_files.lock_read()
 
 
585
    def get_physical_lock_status(self):
 
 
586
        return self.control_files.get_physical_lock_status()
 
 
588
    def leave_lock_in_place(self):
 
 
589
        """Tell this repository not to release the physical lock when this
 
 
592
        If lock_write doesn't return a token, then this method is not supported.
 
 
594
        self.control_files.leave_in_place()
 
 
596
    def dont_leave_lock_in_place(self):
 
 
597
        """Tell this repository to release the physical lock when this
 
 
598
        object is unlocked, even if it didn't originally acquire it.
 
 
600
        If lock_write doesn't return a token, then this method is not supported.
 
 
602
        self.control_files.dont_leave_in_place()
 
 
605
    def gather_stats(self, revid=None, committers=None):
 
 
606
        """Gather statistics from a revision id.
 
 
608
        :param revid: The revision id to gather statistics from, if None, then
 
 
609
            no revision specific statistics are gathered.
 
 
610
        :param committers: Optional parameter controlling whether to grab
 
 
611
            a count of committers from the revision specific statistics.
 
 
612
        :return: A dictionary of statistics. Currently this contains:
 
 
613
            committers: The number of committers if requested.
 
 
614
            firstrev: A tuple with timestamp, timezone for the penultimate left
 
 
615
                most ancestor of revid, if revid is not the NULL_REVISION.
 
 
616
            latestrev: A tuple with timestamp, timezone for revid, if revid is
 
 
617
                not the NULL_REVISION.
 
 
618
            revisions: The total revision count in the repository.
 
 
619
            size: An estimate disk size of the repository in bytes.
 
 
622
        if revid and committers:
 
 
623
            result['committers'] = 0
 
 
624
        if revid and revid != _mod_revision.NULL_REVISION:
 
 
626
                all_committers = set()
 
 
627
            revisions = self.get_ancestry(revid)
 
 
628
            # pop the leading None
 
 
630
            first_revision = None
 
 
632
                # ignore the revisions in the middle - just grab first and last
 
 
633
                revisions = revisions[0], revisions[-1]
 
 
634
            for revision in self.get_revisions(revisions):
 
 
635
                if not first_revision:
 
 
636
                    first_revision = revision
 
 
638
                    all_committers.add(revision.committer)
 
 
639
            last_revision = revision
 
 
641
                result['committers'] = len(all_committers)
 
 
642
            result['firstrev'] = (first_revision.timestamp,
 
 
643
                first_revision.timezone)
 
 
644
            result['latestrev'] = (last_revision.timestamp,
 
 
645
                last_revision.timezone)
 
 
647
        # now gather global repository information
 
 
648
        if self.bzrdir.root_transport.listable():
 
 
649
            c, t = self._revision_store.total_size(self.get_transaction())
 
 
650
            result['revisions'] = c
 
 
655
    def missing_revision_ids(self, other, revision_id=None):
 
 
656
        """Return the revision ids that other has that this does not.
 
 
658
        These are returned in topological order.
 
 
660
        revision_id: only return revision ids included by revision_id.
 
 
662
        revision_id = osutils.safe_revision_id(revision_id)
 
 
663
        return InterRepository.get(other, self).missing_revision_ids(revision_id)
 
 
667
        """Open the repository rooted at base.
 
 
669
        For instance, if the repository is at URL/.bzr/repository,
 
 
670
        Repository.open(URL) -> a Repository instance.
 
 
672
        control = bzrdir.BzrDir.open(base)
 
 
673
        return control.open_repository()
 
 
675
    def copy_content_into(self, destination, revision_id=None):
 
 
676
        """Make a complete copy of the content in self into destination.
 
 
678
        This is a destructive operation! Do not use it on existing 
 
 
681
        revision_id = osutils.safe_revision_id(revision_id)
 
 
682
        return InterRepository.get(self, destination).copy_content(revision_id)
 
 
684
    def commit_write_group(self):
 
 
685
        """Commit the contents accrued within the current write group.
 
 
687
        :seealso: start_write_group.
 
 
689
        if self._write_group is not self.get_transaction():
 
 
690
            # has an unlock or relock occured ?
 
 
691
            raise errors.BzrError('mismatched lock context and write group.')
 
 
692
        self._commit_write_group()
 
 
693
        self._write_group = None
 
 
695
    def _commit_write_group(self):
 
 
696
        """Template method for per-repository write group cleanup.
 
 
698
        This is called before the write group is considered to be 
 
 
699
        finished and should ensure that all data handed to the repository
 
 
700
        for writing during the write group is safely committed (to the 
 
 
701
        extent possible considering file system caching etc).
 
 
704
    def fetch(self, source, revision_id=None, pb=None):
 
 
705
        """Fetch the content required to construct revision_id from source.
 
 
707
        If revision_id is None all content is copied.
 
 
709
        revision_id = osutils.safe_revision_id(revision_id)
 
 
710
        inter = InterRepository.get(source, self)
 
 
712
            return inter.fetch(revision_id=revision_id, pb=pb)
 
 
713
        except NotImplementedError:
 
 
714
            raise errors.IncompatibleRepositories(source, self)
 
 
716
    def create_bundle(self, target, base, fileobj, format=None):
 
 
717
        return serializer.write_bundle(self, target, base, fileobj, format)
 
 
719
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
 
720
                           timezone=None, committer=None, revprops=None,
 
 
722
        """Obtain a CommitBuilder for this repository.
 
 
724
        :param branch: Branch to commit to.
 
 
725
        :param parents: Revision ids of the parents of the new revision.
 
 
726
        :param config: Configuration to use.
 
 
727
        :param timestamp: Optional timestamp recorded for commit.
 
 
728
        :param timezone: Optional timezone for timestamp.
 
 
729
        :param committer: Optional committer to set for commit.
 
 
730
        :param revprops: Optional dictionary of revision properties.
 
 
731
        :param revision_id: Optional revision id.
 
 
733
        revision_id = osutils.safe_revision_id(revision_id)
 
 
734
        result = self._commit_builder_class(self, parents, config,
 
 
735
            timestamp, timezone, committer, revprops, revision_id)
 
 
736
        self.start_write_group()
 
 
740
        if (self.control_files._lock_count == 1 and
 
 
741
            self.control_files._lock_mode == 'w'):
 
 
742
            if self._write_group is not None:
 
 
743
                raise errors.BzrError(
 
 
744
                    'Must end write groups before releasing write locks.')
 
 
745
        self.control_files.unlock()
 
 
748
    def clone(self, a_bzrdir, revision_id=None):
 
 
749
        """Clone this repository into a_bzrdir using the current format.
 
 
751
        Currently no check is made that the format of this repository and
 
 
752
        the bzrdir format are compatible. FIXME RBC 20060201.
 
 
754
        :return: The newly created destination repository.
 
 
756
        # TODO: deprecate after 0.16; cloning this with all its settings is
 
 
757
        # probably not very useful -- mbp 20070423
 
 
758
        dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
 
 
759
        self.copy_content_into(dest_repo, revision_id)
 
 
762
    def start_write_group(self):
 
 
763
        """Start a write group in the repository.
 
 
765
        Write groups are used by repositories which do not have a 1:1 mapping
 
 
766
        between file ids and backend store to manage the insertion of data from
 
 
767
        both fetch and commit operations.
 
 
769
        A write lock is required around the start_write_group/commit_write_group
 
 
770
        for the support of lock-requiring repository formats.
 
 
772
        One can only insert data into a repository inside a write group.
 
 
776
        if not self.is_locked() or self.control_files._lock_mode != 'w':
 
 
777
            raise errors.NotWriteLocked(self)
 
 
778
        if self._write_group:
 
 
779
            raise errors.BzrError('already in a write group')
 
 
780
        self._start_write_group()
 
 
781
        # so we can detect unlock/relock - the write group is now entered.
 
 
782
        self._write_group = self.get_transaction()
 
 
784
    def _start_write_group(self):
 
 
785
        """Template method for per-repository write group startup.
 
 
787
        This is called before the write group is considered to be 
 
 
792
    def sprout(self, to_bzrdir, revision_id=None):
 
 
793
        """Create a descendent repository for new development.
 
 
795
        Unlike clone, this does not copy the settings of the repository.
 
 
797
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
 
798
        dest_repo.fetch(self, revision_id=revision_id)
 
 
801
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
 
802
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
 
803
            # use target default format.
 
 
804
            dest_repo = a_bzrdir.create_repository()
 
 
806
            # Most control formats need the repository to be specifically
 
 
807
            # created, but on some old all-in-one formats it's not needed
 
 
809
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
 
810
            except errors.UninitializableFormat:
 
 
811
                dest_repo = a_bzrdir.open_repository()
 
 
815
    def has_revision(self, revision_id):
 
 
816
        """True if this repository has a copy of the revision."""
 
 
817
        if 'evil' in debug.debug_flags:
 
 
818
            mutter_callsite(2, "has_revision is a LBYL symptom.")
 
 
819
        revision_id = osutils.safe_revision_id(revision_id)
 
 
820
        return self._revision_store.has_revision_id(revision_id,
 
 
821
                                                    self.get_transaction())
 
 
824
    def get_revision_reconcile(self, revision_id):
 
 
825
        """'reconcile' helper routine that allows access to a revision always.
 
 
827
        This variant of get_revision does not cross check the weave graph
 
 
828
        against the revision one as get_revision does: but it should only
 
 
829
        be used by reconcile, or reconcile-alike commands that are correcting
 
 
830
        or testing the revision graph.
 
 
832
        if not revision_id or not isinstance(revision_id, basestring):
 
 
833
            raise errors.InvalidRevisionId(revision_id=revision_id,
 
 
835
        return self.get_revisions([revision_id])[0]
 
 
838
    def get_revisions(self, revision_ids):
 
 
839
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
 
840
        revs = self._revision_store.get_revisions(revision_ids,
 
 
841
                                                  self.get_transaction())
 
 
843
            assert not isinstance(rev.revision_id, unicode)
 
 
844
            for parent_id in rev.parent_ids:
 
 
845
                assert not isinstance(parent_id, unicode)
 
 
849
    def get_revision_xml(self, revision_id):
 
 
850
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
 
851
        #       would have already do it.
 
 
852
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
 
853
        revision_id = osutils.safe_revision_id(revision_id)
 
 
854
        rev = self.get_revision(revision_id)
 
 
856
        # the current serializer..
 
 
857
        self._revision_store._serializer.write_revision(rev, rev_tmp)
 
 
859
        return rev_tmp.getvalue()
 
 
862
    def get_revision(self, revision_id):
 
 
863
        """Return the Revision object for a named revision"""
 
 
864
        # TODO: jam 20070210 get_revision_reconcile should do this for us
 
 
865
        revision_id = osutils.safe_revision_id(revision_id)
 
 
866
        r = self.get_revision_reconcile(revision_id)
 
 
867
        # weave corruption can lead to absent revision markers that should be
 
 
869
        # the following test is reasonably cheap (it needs a single weave read)
 
 
870
        # and the weave is cached in read transactions. In write transactions
 
 
871
        # it is not cached but typically we only read a small number of
 
 
872
        # revisions. For knits when they are introduced we will probably want
 
 
873
        # to ensure that caching write transactions are in use.
 
 
874
        inv = self.get_inventory_weave()
 
 
875
        self._check_revision_parents(r, inv)
 
 
879
    def get_deltas_for_revisions(self, revisions):
 
 
880
        """Produce a generator of revision deltas.
 
 
882
        Note that the input is a sequence of REVISIONS, not revision_ids.
 
 
883
        Trees will be held in memory until the generator exits.
 
 
884
        Each delta is relative to the revision's lefthand predecessor.
 
 
886
        required_trees = set()
 
 
887
        for revision in revisions:
 
 
888
            required_trees.add(revision.revision_id)
 
 
889
            required_trees.update(revision.parent_ids[:1])
 
 
890
        trees = dict((t.get_revision_id(), t) for 
 
 
891
                     t in self.revision_trees(required_trees))
 
 
892
        for revision in revisions:
 
 
893
            if not revision.parent_ids:
 
 
894
                old_tree = self.revision_tree(None)
 
 
896
                old_tree = trees[revision.parent_ids[0]]
 
 
897
            yield trees[revision.revision_id].changes_from(old_tree)
 
 
900
    def get_revision_delta(self, revision_id):
 
 
901
        """Return the delta for one revision.
 
 
903
        The delta is relative to the left-hand predecessor of the
 
 
906
        r = self.get_revision(revision_id)
 
 
907
        return list(self.get_deltas_for_revisions([r]))[0]
 
 
909
    def _check_revision_parents(self, revision, inventory):
 
 
910
        """Private to Repository and Fetch.
 
 
912
        This checks the parentage of revision in an inventory weave for 
 
 
913
        consistency and is only applicable to inventory-weave-for-ancestry
 
 
914
        using repository formats & fetchers.
 
 
916
        weave_parents = inventory.get_parents(revision.revision_id)
 
 
917
        weave_names = inventory.versions()
 
 
918
        for parent_id in revision.parent_ids:
 
 
919
            if parent_id in weave_names:
 
 
920
                # this parent must not be a ghost.
 
 
921
                if not parent_id in weave_parents:
 
 
923
                    raise errors.CorruptRepository(self)
 
 
926
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
 
927
        revision_id = osutils.safe_revision_id(revision_id)
 
 
928
        signature = gpg_strategy.sign(plaintext)
 
 
929
        self._revision_store.add_revision_signature_text(revision_id,
 
 
931
                                                         self.get_transaction())
 
 
933
    def fileids_altered_by_revision_ids(self, revision_ids):
 
 
934
        """Find the file ids and versions affected by revisions.
 
 
936
        :param revisions: an iterable containing revision ids.
 
 
937
        :return: a dictionary mapping altered file-ids to an iterable of
 
 
938
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
939
        altered it listed explicitly.
 
 
941
        assert self._serializer.support_altered_by_hack, \
 
 
942
            ("fileids_altered_by_revision_ids only supported for branches " 
 
 
943
             "which store inventory as unnested xml, not on %r" % self)
 
 
944
        selected_revision_ids = set(osutils.safe_revision_id(r)
 
 
945
                                    for r in revision_ids)
 
 
946
        w = self.get_inventory_weave()
 
 
949
        # this code needs to read every new line in every inventory for the
 
 
950
        # inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
 
 
951
        # not present in one of those inventories is unnecessary but not 
 
 
952
        # harmful because we are filtering by the revision id marker in the
 
 
953
        # inventory lines : we only select file ids altered in one of those  
 
 
954
        # revisions. We don't need to see all lines in the inventory because
 
 
955
        # only those added in an inventory in rev X can contain a revision=X
 
 
957
        unescape_revid_cache = {}
 
 
958
        unescape_fileid_cache = {}
 
 
960
        # jam 20061218 In a big fetch, this handles hundreds of thousands
 
 
961
        # of lines, so it has had a lot of inlining and optimizing done.
 
 
962
        # Sorry that it is a little bit messy.
 
 
963
        # Move several functions to be local variables, since this is a long
 
 
965
        search = self._file_ids_altered_regex.search
 
 
966
        unescape = _unescape_xml
 
 
967
        setdefault = result.setdefault
 
 
968
        pb = ui.ui_factory.nested_progress_bar()
 
 
970
            for line in w.iter_lines_added_or_present_in_versions(
 
 
971
                                        selected_revision_ids, pb=pb):
 
 
975
                # One call to match.group() returning multiple items is quite a
 
 
976
                # bit faster than 2 calls to match.group() each returning 1
 
 
977
                file_id, revision_id = match.group('file_id', 'revision_id')
 
 
979
                # Inlining the cache lookups helps a lot when you make 170,000
 
 
980
                # lines and 350k ids, versus 8.4 unique ids.
 
 
981
                # Using a cache helps in 2 ways:
 
 
982
                #   1) Avoids unnecessary decoding calls
 
 
983
                #   2) Re-uses cached strings, which helps in future set and
 
 
985
                # (2) is enough that removing encoding entirely along with
 
 
986
                # the cache (so we are using plain strings) results in no
 
 
987
                # performance improvement.
 
 
989
                    revision_id = unescape_revid_cache[revision_id]
 
 
991
                    unescaped = unescape(revision_id)
 
 
992
                    unescape_revid_cache[revision_id] = unescaped
 
 
993
                    revision_id = unescaped
 
 
995
                if revision_id in selected_revision_ids:
 
 
997
                        file_id = unescape_fileid_cache[file_id]
 
 
999
                        unescaped = unescape(file_id)
 
 
1000
                        unescape_fileid_cache[file_id] = unescaped
 
 
1002
                    setdefault(file_id, set()).add(revision_id)
 
 
1007
    def iter_files_bytes(self, desired_files):
 
 
1008
        """Iterate through file versions.
 
 
1010
        Files will not necessarily be returned in the order they occur in
 
 
1011
        desired_files.  No specific order is guaranteed.
 
 
1013
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
 
1014
        value supplied by the caller as part of desired_files.  It should
 
 
1015
        uniquely identify the file version in the caller's context.  (Examples:
 
 
1016
        an index number or a TreeTransform trans_id.)
 
 
1018
        bytes_iterator is an iterable of bytestrings for the file.  The
 
 
1019
        kind of iterable and length of the bytestrings are unspecified, but for
 
 
1020
        this implementation, it is a list of lines produced by
 
 
1021
        VersionedFile.get_lines().
 
 
1023
        :param desired_files: a list of (file_id, revision_id, identifier)
 
 
1026
        transaction = self.get_transaction()
 
 
1027
        for file_id, revision_id, callable_data in desired_files:
 
 
1029
                weave = self.weave_store.get_weave(file_id, transaction)
 
 
1030
            except errors.NoSuchFile:
 
 
1031
                raise errors.NoSuchIdInRepository(self, file_id)
 
 
1032
            yield callable_data, weave.get_lines(revision_id)
 
 
1034
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
 
1035
        """Get an iterable listing the keys of all the data introduced by a set
 
 
1038
        The keys will be ordered so that the corresponding items can be safely
 
 
1039
        fetched and inserted in that order.
 
 
1041
        :returns: An iterable producing tuples of (knit-kind, file-id,
 
 
1042
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
 
 
1043
            'revisions'.  file-id is None unless knit-kind is 'file'.
 
 
1045
        # XXX: it's a bit weird to control the inventory weave caching in this
 
 
1046
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
 
 
1047
        # maybe this generator should explicitly have the contract that it
 
 
1048
        # should not be iterated until the previously yielded item has been
 
 
1050
        inv_w = self.get_inventory_weave()
 
 
1051
        inv_w.enable_cache()
 
 
1053
        # file ids that changed
 
 
1054
        file_ids = self.fileids_altered_by_revision_ids(revision_ids)
 
 
1056
        num_file_ids = len(file_ids)
 
 
1057
        for file_id, altered_versions in file_ids.iteritems():
 
 
1058
            if _files_pb is not None:
 
 
1059
                _files_pb.update("fetch texts", count, num_file_ids)
 
 
1061
            yield ("file", file_id, altered_versions)
 
 
1062
        # We're done with the files_pb.  Note that it finished by the caller,
 
 
1063
        # just as it was created by the caller.
 
 
1067
        yield ("inventory", None, revision_ids)
 
 
1071
        revisions_with_signatures = set()
 
 
1072
        for rev_id in revision_ids:
 
 
1074
                self.get_signature_text(rev_id)
 
 
1075
            except errors.NoSuchRevision:
 
 
1079
                revisions_with_signatures.add(rev_id)
 
 
1080
        yield ("signatures", None, revisions_with_signatures)
 
 
1083
        yield ("revisions", None, revision_ids)
 
 
1086
    def get_inventory_weave(self):
 
 
1087
        return self.control_weaves.get_weave('inventory',
 
 
1088
            self.get_transaction())
 
 
1091
    def get_inventory(self, revision_id):
 
 
1092
        """Get Inventory object by hash."""
 
 
1093
        # TODO: jam 20070210 Technically we don't need to sanitize, since all
 
 
1094
        #       called functions must sanitize.
 
 
1095
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1096
        return self.deserialise_inventory(
 
 
1097
            revision_id, self.get_inventory_xml(revision_id))
 
 
1099
    def deserialise_inventory(self, revision_id, xml):
 
 
1100
        """Transform the xml into an inventory object. 
 
 
1102
        :param revision_id: The expected revision id of the inventory.
 
 
1103
        :param xml: A serialised inventory.
 
 
1105
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1106
        result = self._serializer.read_inventory_from_string(xml)
 
 
1107
        result.root.revision = revision_id
 
 
1110
    def serialise_inventory(self, inv):
 
 
1111
        return self._serializer.write_inventory_to_string(inv)
 
 
1113
    def _serialise_inventory_to_lines(self, inv):
 
 
1114
        return self._serializer.write_inventory_to_lines(inv)
 
 
1116
    def get_serializer_format(self):
 
 
1117
        return self._serializer.format_num
 
 
1120
    def get_inventory_xml(self, revision_id):
 
 
1121
        """Get inventory XML as a file object."""
 
 
1122
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1124
            assert isinstance(revision_id, str), type(revision_id)
 
 
1125
            iw = self.get_inventory_weave()
 
 
1126
            return iw.get_text(revision_id)
 
 
1128
            raise errors.HistoryMissing(self, 'inventory', revision_id)
 
 
1131
    def get_inventory_sha1(self, revision_id):
 
 
1132
        """Return the sha1 hash of the inventory entry
 
 
1134
        # TODO: jam 20070210 Shouldn't this be deprecated / removed?
 
 
1135
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1136
        return self.get_revision(revision_id).inventory_sha1
 
 
1139
    def get_revision_graph(self, revision_id=None):
 
 
1140
        """Return a dictionary containing the revision graph.
 
 
1142
        :param revision_id: The revision_id to get a graph from. If None, then
 
 
1143
        the entire revision graph is returned. This is a deprecated mode of
 
 
1144
        operation and will be removed in the future.
 
 
1145
        :return: a dictionary of revision_id->revision_parents_list.
 
 
1147
        if 'evil' in debug.debug_flags:
 
 
1149
                "get_revision_graph scales with size of history.")
 
 
1150
        # special case NULL_REVISION
 
 
1151
        if revision_id == _mod_revision.NULL_REVISION:
 
 
1153
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1154
        a_weave = self.get_inventory_weave()
 
 
1155
        all_revisions = self._eliminate_revisions_not_present(
 
 
1157
        entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for 
 
 
1158
                             node in all_revisions])
 
 
1159
        if revision_id is None:
 
 
1161
        elif revision_id not in entire_graph:
 
 
1162
            raise errors.NoSuchRevision(self, revision_id)
 
 
1164
            # add what can be reached from revision_id
 
 
1166
            pending = set([revision_id])
 
 
1167
            while len(pending) > 0:
 
 
1168
                node = pending.pop()
 
 
1169
                result[node] = entire_graph[node]
 
 
1170
                for revision_id in result[node]:
 
 
1171
                    if revision_id not in result:
 
 
1172
                        pending.add(revision_id)
 
 
1176
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
 
1177
        """Return a graph of the revisions with ghosts marked as applicable.
 
 
1179
        :param revision_ids: an iterable of revisions to graph or None for all.
 
 
1180
        :return: a Graph object with the graph reachable from revision_ids.
 
 
1182
        if 'evil' in debug.debug_flags:
 
 
1184
                "get_revision_graph_with_ghosts scales with size of history.")
 
 
1185
        result = deprecated_graph.Graph()
 
 
1186
        if not revision_ids:
 
 
1187
            pending = set(self.all_revision_ids())
 
 
1190
            pending = set(osutils.safe_revision_id(r) for r in revision_ids)
 
 
1191
            # special case NULL_REVISION
 
 
1192
            if _mod_revision.NULL_REVISION in pending:
 
 
1193
                pending.remove(_mod_revision.NULL_REVISION)
 
 
1194
            required = set(pending)
 
 
1197
            revision_id = pending.pop()
 
 
1199
                rev = self.get_revision(revision_id)
 
 
1200
            except errors.NoSuchRevision:
 
 
1201
                if revision_id in required:
 
 
1204
                result.add_ghost(revision_id)
 
 
1206
            for parent_id in rev.parent_ids:
 
 
1207
                # is this queued or done ?
 
 
1208
                if (parent_id not in pending and
 
 
1209
                    parent_id not in done):
 
 
1211
                    pending.add(parent_id)
 
 
1212
            result.add_node(revision_id, rev.parent_ids)
 
 
1213
            done.add(revision_id)
 
 
1216
    def _get_history_vf(self):
 
 
1217
        """Get a versionedfile whose history graph reflects all revisions.
 
 
1219
        For weave repositories, this is the inventory weave.
 
 
1221
        return self.get_inventory_weave()
 
 
1223
    def iter_reverse_revision_history(self, revision_id):
 
 
1224
        """Iterate backwards through revision ids in the lefthand history
 
 
1226
        :param revision_id: The revision id to start with.  All its lefthand
 
 
1227
            ancestors will be traversed.
 
 
1229
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1230
        if revision_id in (None, _mod_revision.NULL_REVISION):
 
 
1232
        next_id = revision_id
 
 
1233
        versionedfile = self._get_history_vf()
 
 
1236
            parents = versionedfile.get_parents(next_id)
 
 
1237
            if len(parents) == 0:
 
 
1240
                next_id = parents[0]
 
 
1243
    def get_revision_inventory(self, revision_id):
 
 
1244
        """Return inventory of a past revision."""
 
 
1245
        # TODO: Unify this with get_inventory()
 
 
1246
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
 
1247
        # must be the same as its revision, so this is trivial.
 
 
1248
        if revision_id is None:
 
 
1249
            # This does not make sense: if there is no revision,
 
 
1250
            # then it is the current tree inventory surely ?!
 
 
1251
            # and thus get_root_id() is something that looks at the last
 
 
1252
            # commit on the branch, and the get_root_id is an inventory check.
 
 
1253
            raise NotImplementedError
 
 
1254
            # return Inventory(self.get_root_id())
 
 
1256
            return self.get_inventory(revision_id)
 
 
1259
    def is_shared(self):
 
 
1260
        """Return True if this repository is flagged as a shared repository."""
 
 
1261
        raise NotImplementedError(self.is_shared)
 
 
1264
    def reconcile(self, other=None, thorough=False):
 
 
1265
        """Reconcile this repository."""
 
 
1266
        from bzrlib.reconcile import RepoReconciler
 
 
1267
        reconciler = RepoReconciler(self, thorough=thorough)
 
 
1268
        reconciler.reconcile()
 
 
1271
    def _refresh_data(self):
 
 
1272
        """Helper called from lock_* to ensure coherency with disk.
 
 
1274
        The default implementation does nothing; it is however possible
 
 
1275
        for repositories to maintain loaded indices across multiple locks
 
 
1276
        by checking inside their implementation of this method to see
 
 
1277
        whether their indices are still valid. This depends of course on
 
 
1278
        the disk format being validatable in this manner.
 
 
1282
    def revision_tree(self, revision_id):
 
 
1283
        """Return Tree for a revision on this branch.
 
 
1285
        `revision_id` may be None for the empty tree revision.
 
 
1287
        # TODO: refactor this to use an existing revision object
 
 
1288
        # so we don't need to read it in twice.
 
 
1289
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
 
1290
            return RevisionTree(self, Inventory(root_id=None), 
 
 
1291
                                _mod_revision.NULL_REVISION)
 
 
1293
            revision_id = osutils.safe_revision_id(revision_id)
 
 
1294
            inv = self.get_revision_inventory(revision_id)
 
 
1295
            return RevisionTree(self, inv, revision_id)
 
 
1298
    def revision_trees(self, revision_ids):
 
 
1299
        """Return Tree for a revision on this branch.
 
 
1301
        `revision_id` may not be None or 'null:'"""
 
 
1302
        assert None not in revision_ids
 
 
1303
        assert _mod_revision.NULL_REVISION not in revision_ids
 
 
1304
        texts = self.get_inventory_weave().get_texts(revision_ids)
 
 
1305
        for text, revision_id in zip(texts, revision_ids):
 
 
1306
            inv = self.deserialise_inventory(revision_id, text)
 
 
1307
            yield RevisionTree(self, inv, revision_id)
 
 
1310
    def get_ancestry(self, revision_id, topo_sorted=True):
 
 
1311
        """Return a list of revision-ids integrated by a revision.
 
 
1313
        The first element of the list is always None, indicating the origin 
 
 
1314
        revision.  This might change when we have history horizons, or 
 
 
1315
        perhaps we should have a new API.
 
 
1317
        This is topologically sorted.
 
 
1319
        if _mod_revision.is_null(revision_id):
 
 
1321
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1322
        if not self.has_revision(revision_id):
 
 
1323
            raise errors.NoSuchRevision(self, revision_id)
 
 
1324
        w = self.get_inventory_weave()
 
 
1325
        candidates = w.get_ancestry(revision_id, topo_sorted)
 
 
1326
        return [None] + candidates # self._eliminate_revisions_not_present(candidates)
 
 
1329
        """Compress the data within the repository.
 
 
1331
        This operation only makes sense for some repository types. For other
 
 
1332
        types it should be a no-op that just returns.
 
 
1334
        This stub method does not require a lock, but subclasses should use
 
 
1335
        @needs_write_lock as this is a long running call its reasonable to 
 
 
1336
        implicitly lock for the user.
 
 
1340
    def print_file(self, file, revision_id):
 
 
1341
        """Print `file` to stdout.
 
 
1343
        FIXME RBC 20060125 as John Meinel points out this is a bad api
 
 
1344
        - it writes to stdout, it assumes that that is valid etc. Fix
 
 
1345
        by creating a new more flexible convenience function.
 
 
1347
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1348
        tree = self.revision_tree(revision_id)
 
 
1349
        # use inventory as it was in that revision
 
 
1350
        file_id = tree.inventory.path2id(file)
 
 
1352
            # TODO: jam 20060427 Write a test for this code path
 
 
1353
            #       it had a bug in it, and was raising the wrong
 
 
1355
            raise errors.BzrError("%r is not present in revision %s" % (file, revision_id))
 
 
1356
        tree.print_file(file_id)
 
 
1358
    def get_transaction(self):
 
 
1359
        return self.control_files.get_transaction()
 
 
1361
    def revision_parents(self, revision_id):
 
 
1362
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1363
        return self.get_inventory_weave().parent_names(revision_id)
 
 
1365
    def get_parents(self, revision_ids):
 
 
1366
        """See StackedParentsProvider.get_parents"""
 
 
1368
        for revision_id in revision_ids:
 
 
1369
            if revision_id == _mod_revision.NULL_REVISION:
 
 
1373
                    parents = self.get_revision(revision_id).parent_ids
 
 
1374
                except errors.NoSuchRevision:
 
 
1377
                    if len(parents) == 0:
 
 
1378
                        parents = [_mod_revision.NULL_REVISION]
 
 
1379
            parents_list.append(parents)
 
 
1382
    def _make_parents_provider(self):
 
 
1385
    def get_graph(self, other_repository=None):
 
 
1386
        """Return the graph walker for this repository format"""
 
 
1387
        parents_provider = self._make_parents_provider()
 
 
1388
        if (other_repository is not None and
 
 
1389
            other_repository.bzrdir.transport.base !=
 
 
1390
            self.bzrdir.transport.base):
 
 
1391
            parents_provider = graph._StackedParentsProvider(
 
 
1392
                [parents_provider, other_repository._make_parents_provider()])
 
 
1393
        return graph.Graph(parents_provider)
 
 
1396
    def set_make_working_trees(self, new_value):
 
 
1397
        """Set the policy flag for making working trees when creating branches.
 
 
1399
        This only applies to branches that use this repository.
 
 
1401
        The default is 'True'.
 
 
1402
        :param new_value: True to restore the default, False to disable making
 
 
1405
        raise NotImplementedError(self.set_make_working_trees)
 
 
1407
    def make_working_trees(self):
 
 
1408
        """Returns the policy for making working trees on new branches."""
 
 
1409
        raise NotImplementedError(self.make_working_trees)
 
 
1412
    def sign_revision(self, revision_id, gpg_strategy):
 
 
1413
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1414
        plaintext = Testament.from_revision(self, revision_id).as_short_text()
 
 
1415
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
 
 
1418
    def has_signature_for_revision_id(self, revision_id):
 
 
1419
        """Query for a revision signature for revision_id in the repository."""
 
 
1420
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1421
        return self._revision_store.has_signature(revision_id,
 
 
1422
                                                  self.get_transaction())
 
 
1425
    def get_signature_text(self, revision_id):
 
 
1426
        """Return the text for a signature."""
 
 
1427
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1428
        return self._revision_store.get_signature_text(revision_id,
 
 
1429
                                                       self.get_transaction())
 
 
1432
    def check(self, revision_ids):
 
 
1433
        """Check consistency of all history of given revision_ids.
 
 
1435
        Different repository implementations should override _check().
 
 
1437
        :param revision_ids: A non-empty list of revision_ids whose ancestry
 
 
1438
             will be checked.  Typically the last revision_id of a branch.
 
 
1440
        if not revision_ids:
 
 
1441
            raise ValueError("revision_ids must be non-empty in %s.check" 
 
 
1443
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
 
1444
        return self._check(revision_ids)
 
 
1446
    def _check(self, revision_ids):
 
 
1447
        result = check.Check(self)
 
 
1451
    def _warn_if_deprecated(self):
 
 
1452
        global _deprecation_warning_done
 
 
1453
        if _deprecation_warning_done:
 
 
1455
        _deprecation_warning_done = True
 
 
1456
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
 
1457
                % (self._format, self.bzrdir.transport.base))
 
 
1459
    def supports_rich_root(self):
 
 
1460
        return self._format.rich_root_data
 
 
1462
    def _check_ascii_revisionid(self, revision_id, method):
 
 
1463
        """Private helper for ascii-only repositories."""
 
 
1464
        # weave repositories refuse to store revisionids that are non-ascii.
 
 
1465
        if revision_id is not None:
 
 
1466
            # weaves require ascii revision ids.
 
 
1467
            if isinstance(revision_id, unicode):
 
 
1469
                    revision_id.encode('ascii')
 
 
1470
                except UnicodeEncodeError:
 
 
1471
                    raise errors.NonAsciiRevisionId(method, self)
 
 
1474
                    revision_id.decode('ascii')
 
 
1475
                except UnicodeDecodeError:
 
 
1476
                    raise errors.NonAsciiRevisionId(method, self)
 
 
1480
# remove these delegates a while after bzr 0.15
 
 
1481
def __make_delegated(name, from_module):
 
 
1482
    def _deprecated_repository_forwarder():
 
 
1483
        symbol_versioning.warn('%s moved to %s in bzr 0.15'
 
 
1484
            % (name, from_module),
 
 
1487
        m = __import__(from_module, globals(), locals(), [name])
 
 
1489
            return getattr(m, name)
 
 
1490
        except AttributeError:
 
 
1491
            raise AttributeError('module %s has no name %s'
 
 
1493
    globals()[name] = _deprecated_repository_forwarder
 
 
1496
        'AllInOneRepository',
 
 
1497
        'WeaveMetaDirRepository',
 
 
1498
        'PreSplitOutRepositoryFormat',
 
 
1499
        'RepositoryFormat4',
 
 
1500
        'RepositoryFormat5',
 
 
1501
        'RepositoryFormat6',
 
 
1502
        'RepositoryFormat7',
 
 
1504
    __make_delegated(_name, 'bzrlib.repofmt.weaverepo')
 
 
1508
        'RepositoryFormatKnit',
 
 
1509
        'RepositoryFormatKnit1',
 
 
1511
    __make_delegated(_name, 'bzrlib.repofmt.knitrepo')
 
 
1514
def install_revision(repository, rev, revision_tree):
 
 
1515
    """Install all revision data into a repository."""
 
 
1516
    present_parents = []
 
 
1518
    for p_id in rev.parent_ids:
 
 
1519
        if repository.has_revision(p_id):
 
 
1520
            present_parents.append(p_id)
 
 
1521
            parent_trees[p_id] = repository.revision_tree(p_id)
 
 
1523
            parent_trees[p_id] = repository.revision_tree(None)
 
 
1525
    inv = revision_tree.inventory
 
 
1526
    entries = inv.iter_entries()
 
 
1527
    # backwards compatibility hack: skip the root id.
 
 
1528
    if not repository.supports_rich_root():
 
 
1529
        path, root = entries.next()
 
 
1530
        if root.revision != rev.revision_id:
 
 
1531
            raise errors.IncompatibleRevision(repr(repository))
 
 
1532
    # Add the texts that are not already present
 
 
1533
    for path, ie in entries:
 
 
1534
        w = repository.weave_store.get_weave_or_empty(ie.file_id,
 
 
1535
                repository.get_transaction())
 
 
1536
        if ie.revision not in w:
 
 
1538
            # FIXME: TODO: The following loop *may* be overlapping/duplicate
 
 
1539
            # with InventoryEntry.find_previous_heads(). if it is, then there
 
 
1540
            # is a latent bug here where the parents may have ancestors of each
 
 
1542
            for revision, tree in parent_trees.iteritems():
 
 
1543
                if ie.file_id not in tree:
 
 
1545
                parent_id = tree.inventory[ie.file_id].revision
 
 
1546
                if parent_id in text_parents:
 
 
1548
                text_parents.append(parent_id)
 
 
1550
            vfile = repository.weave_store.get_weave_or_empty(ie.file_id, 
 
 
1551
                repository.get_transaction())
 
 
1552
            lines = revision_tree.get_file(ie.file_id).readlines()
 
 
1553
            vfile.add_lines(rev.revision_id, text_parents, lines)
 
 
1555
        # install the inventory
 
 
1556
        repository.add_inventory(rev.revision_id, inv, present_parents)
 
 
1557
    except errors.RevisionAlreadyPresent:
 
 
1559
    repository.add_revision(rev.revision_id, rev, inv)
 
 
1562
class MetaDirRepository(Repository):
 
 
1563
    """Repositories in the new meta-dir layout."""
 
 
1565
    def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
 
 
1566
        super(MetaDirRepository, self).__init__(_format,
 
 
1572
        dir_mode = self.control_files._dir_mode
 
 
1573
        file_mode = self.control_files._file_mode
 
 
1576
    def is_shared(self):
 
 
1577
        """Return True if this repository is flagged as a shared repository."""
 
 
1578
        return self.control_files._transport.has('shared-storage')
 
 
1581
    def set_make_working_trees(self, new_value):
 
 
1582
        """Set the policy flag for making working trees when creating branches.
 
 
1584
        This only applies to branches that use this repository.
 
 
1586
        The default is 'True'.
 
 
1587
        :param new_value: True to restore the default, False to disable making
 
 
1592
                self.control_files._transport.delete('no-working-trees')
 
 
1593
            except errors.NoSuchFile:
 
 
1596
            self.control_files.put_utf8('no-working-trees', '')
 
 
1598
    def make_working_trees(self):
 
 
1599
        """Returns the policy for making working trees on new branches."""
 
 
1600
        return not self.control_files._transport.has('no-working-trees')
 
 
1603
class RepositoryFormatRegistry(registry.Registry):
 
 
1604
    """Registry of RepositoryFormats.
 
 
1607
    def get(self, format_string):
 
 
1608
        r = registry.Registry.get(self, format_string)
 
 
1614
format_registry = RepositoryFormatRegistry()
 
 
1615
"""Registry of formats, indexed by their identifying format string.
 
 
1617
This can contain either format instances themselves, or classes/factories that
 
 
1618
can be called to obtain one.
 
 
1622
#####################################################################
 
 
1623
# Repository Formats
 
 
1625
class RepositoryFormat(object):
 
 
1626
    """A repository format.
 
 
1628
    Formats provide three things:
 
 
1629
     * An initialization routine to construct repository data on disk.
 
 
1630
     * a format string which is used when the BzrDir supports versioned
 
 
1632
     * an open routine which returns a Repository instance.
 
 
1634
    Formats are placed in an dict by their format string for reference 
 
 
1635
    during opening. These should be subclasses of RepositoryFormat
 
 
1638
    Once a format is deprecated, just deprecate the initialize and open
 
 
1639
    methods on the format class. Do not deprecate the object, as the 
 
 
1640
    object will be created every system load.
 
 
1642
    Common instance attributes:
 
 
1643
    _matchingbzrdir - the bzrdir format that the repository format was
 
 
1644
    originally written to work with. This can be used if manually
 
 
1645
    constructing a bzrdir and repository, or more commonly for test suite
 
 
1650
        return "<%s>" % self.__class__.__name__
 
 
1652
    def __eq__(self, other):
 
 
1653
        # format objects are generally stateless
 
 
1654
        return isinstance(other, self.__class__)
 
 
1656
    def __ne__(self, other):
 
 
1657
        return not self == other
 
 
1660
    def find_format(klass, a_bzrdir):
 
 
1661
        """Return the format for the repository object in a_bzrdir.
 
 
1663
        This is used by bzr native formats that have a "format" file in
 
 
1664
        the repository.  Other methods may be used by different types of 
 
 
1668
            transport = a_bzrdir.get_repository_transport(None)
 
 
1669
            format_string = transport.get("format").read()
 
 
1670
            return format_registry.get(format_string)
 
 
1671
        except errors.NoSuchFile:
 
 
1672
            raise errors.NoRepositoryPresent(a_bzrdir)
 
 
1674
            raise errors.UnknownFormatError(format=format_string)
 
 
1677
    def register_format(klass, format):
 
 
1678
        format_registry.register(format.get_format_string(), format)
 
 
1681
    def unregister_format(klass, format):
 
 
1682
        format_registry.remove(format.get_format_string())
 
 
1685
    def get_default_format(klass):
 
 
1686
        """Return the current default format."""
 
 
1687
        from bzrlib import bzrdir
 
 
1688
        return bzrdir.format_registry.make_bzrdir('default').repository_format
 
 
1690
    def _get_control_store(self, repo_transport, control_files):
 
 
1691
        """Return the control store for this repository."""
 
 
1692
        raise NotImplementedError(self._get_control_store)
 
 
1694
    def get_format_string(self):
 
 
1695
        """Return the ASCII format string that identifies this format.
 
 
1697
        Note that in pre format ?? repositories the format string is 
 
 
1698
        not permitted nor written to disk.
 
 
1700
        raise NotImplementedError(self.get_format_string)
 
 
1702
    def get_format_description(self):
 
 
1703
        """Return the short description for this format."""
 
 
1704
        raise NotImplementedError(self.get_format_description)
 
 
1706
    def _get_revision_store(self, repo_transport, control_files):
 
 
1707
        """Return the revision store object for this a_bzrdir."""
 
 
1708
        raise NotImplementedError(self._get_revision_store)
 
 
1710
    def _get_text_rev_store(self,
 
 
1717
        """Common logic for getting a revision store for a repository.
 
 
1719
        see self._get_revision_store for the subclass-overridable method to 
 
 
1720
        get the store for a repository.
 
 
1722
        from bzrlib.store.revision.text import TextRevisionStore
 
 
1723
        dir_mode = control_files._dir_mode
 
 
1724
        file_mode = control_files._file_mode
 
 
1725
        text_store = TextStore(transport.clone(name),
 
 
1727
                              compressed=compressed,
 
 
1729
                              file_mode=file_mode)
 
 
1730
        _revision_store = TextRevisionStore(text_store, serializer)
 
 
1731
        return _revision_store
 
 
1733
    # TODO: this shouldn't be in the base class, it's specific to things that
 
 
1734
    # use weaves or knits -- mbp 20070207
 
 
1735
    def _get_versioned_file_store(self,
 
 
1740
                                  versionedfile_class=None,
 
 
1741
                                  versionedfile_kwargs={},
 
 
1743
        if versionedfile_class is None:
 
 
1744
            versionedfile_class = self._versionedfile_class
 
 
1745
        weave_transport = control_files._transport.clone(name)
 
 
1746
        dir_mode = control_files._dir_mode
 
 
1747
        file_mode = control_files._file_mode
 
 
1748
        return VersionedFileStore(weave_transport, prefixed=prefixed,
 
 
1750
                                  file_mode=file_mode,
 
 
1751
                                  versionedfile_class=versionedfile_class,
 
 
1752
                                  versionedfile_kwargs=versionedfile_kwargs,
 
 
1755
    def initialize(self, a_bzrdir, shared=False):
 
 
1756
        """Initialize a repository of this format in a_bzrdir.
 
 
1758
        :param a_bzrdir: The bzrdir to put the new repository in it.
 
 
1759
        :param shared: The repository should be initialized as a sharable one.
 
 
1760
        :returns: The new repository object.
 
 
1762
        This may raise UninitializableFormat if shared repository are not
 
 
1763
        compatible the a_bzrdir.
 
 
1765
        raise NotImplementedError(self.initialize)
 
 
1767
    def is_supported(self):
 
 
1768
        """Is this format supported?
 
 
1770
        Supported formats must be initializable and openable.
 
 
1771
        Unsupported formats may not support initialization or committing or 
 
 
1772
        some other features depending on the reason for not being supported.
 
 
1776
    def check_conversion_target(self, target_format):
 
 
1777
        raise NotImplementedError(self.check_conversion_target)
 
 
1779
    def open(self, a_bzrdir, _found=False):
 
 
1780
        """Return an instance of this format for the bzrdir a_bzrdir.
 
 
1782
        _found is a private parameter, do not use it.
 
 
1784
        raise NotImplementedError(self.open)
 
 
1787
class MetaDirRepositoryFormat(RepositoryFormat):
 
 
1788
    """Common base class for the new repositories using the metadir layout."""
 
 
1790
    rich_root_data = False
 
 
1791
    supports_tree_reference = False
 
 
1792
    _matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
 
1795
        super(MetaDirRepositoryFormat, self).__init__()
 
 
1797
    def _create_control_files(self, a_bzrdir):
 
 
1798
        """Create the required files and the initial control_files object."""
 
 
1799
        # FIXME: RBC 20060125 don't peek under the covers
 
 
1800
        # NB: no need to escape relative paths that are url safe.
 
 
1801
        repository_transport = a_bzrdir.get_repository_transport(self)
 
 
1802
        control_files = lockable_files.LockableFiles(repository_transport,
 
 
1803
                                'lock', lockdir.LockDir)
 
 
1804
        control_files.create_lock()
 
 
1805
        return control_files
 
 
1807
    def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
 
 
1808
        """Upload the initial blank content."""
 
 
1809
        control_files = self._create_control_files(a_bzrdir)
 
 
1810
        control_files.lock_write()
 
 
1812
            control_files._transport.mkdir_multi(dirs,
 
 
1813
                    mode=control_files._dir_mode)
 
 
1814
            for file, content in files:
 
 
1815
                control_files.put(file, content)
 
 
1816
            for file, content in utf8_files:
 
 
1817
                control_files.put_utf8(file, content)
 
 
1819
                control_files.put_utf8('shared-storage', '')
 
 
1821
            control_files.unlock()
 
 
1824
# formats which have no format string are not discoverable
 
 
1825
# and not independently creatable, so are not registered.  They're 
 
 
1826
# all in bzrlib.repofmt.weaverepo now.  When an instance of one of these is
 
 
1827
# needed, it's constructed directly by the BzrDir.  Non-native formats where
 
 
1828
# the repository is not separately opened are similar.
 
 
1830
format_registry.register_lazy(
 
 
1831
    'Bazaar-NG Repository format 7',
 
 
1832
    'bzrlib.repofmt.weaverepo',
 
 
1835
# KEEP in sync with bzrdir.format_registry default, which controls the overall
 
 
1836
# default control directory format
 
 
1838
format_registry.register_lazy(
 
 
1839
    'Bazaar-NG Knit Repository Format 1',
 
 
1840
    'bzrlib.repofmt.knitrepo',
 
 
1841
    'RepositoryFormatKnit1',
 
 
1843
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
 
 
1845
format_registry.register_lazy(
 
 
1846
    'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
 
 
1847
    'bzrlib.repofmt.knitrepo',
 
 
1848
    'RepositoryFormatKnit3',
 
 
1852
class InterRepository(InterObject):
 
 
1853
    """This class represents operations taking place between two repositories.
 
 
1855
    Its instances have methods like copy_content and fetch, and contain
 
 
1856
    references to the source and target repositories these operations can be 
 
 
1859
    Often we will provide convenience methods on 'repository' which carry out
 
 
1860
    operations with another repository - they will always forward to
 
 
1861
    InterRepository.get(other).method_name(parameters).
 
 
1865
    """The available optimised InterRepository types."""
 
 
1867
    def copy_content(self, revision_id=None):
 
 
1868
        raise NotImplementedError(self.copy_content)
 
 
1870
    def fetch(self, revision_id=None, pb=None):
 
 
1871
        """Fetch the content required to construct revision_id.
 
 
1873
        The content is copied from self.source to self.target.
 
 
1875
        :param revision_id: if None all content is copied, if NULL_REVISION no
 
 
1877
        :param pb: optional progress bar to use for progress reports. If not
 
 
1878
                   provided a default one will be created.
 
 
1880
        Returns the copied revision count and the failed revisions in a tuple:
 
 
1883
        raise NotImplementedError(self.fetch)
 
 
1886
    def missing_revision_ids(self, revision_id=None):
 
 
1887
        """Return the revision ids that source has that target does not.
 
 
1889
        These are returned in topological order.
 
 
1891
        :param revision_id: only return revision ids included by this
 
 
1894
        # generic, possibly worst case, slow code path.
 
 
1895
        target_ids = set(self.target.all_revision_ids())
 
 
1896
        if revision_id is not None:
 
 
1897
            # TODO: jam 20070210 InterRepository is internal enough that it
 
 
1898
            #       should assume revision_ids are already utf-8
 
 
1899
            revision_id = osutils.safe_revision_id(revision_id)
 
 
1900
            source_ids = self.source.get_ancestry(revision_id)
 
 
1901
            assert source_ids[0] is None
 
 
1904
            source_ids = self.source.all_revision_ids()
 
 
1905
        result_set = set(source_ids).difference(target_ids)
 
 
1906
        # this may look like a no-op: its not. It preserves the ordering
 
 
1907
        # other_ids had while only returning the members from other_ids
 
 
1908
        # that we've decided we need.
 
 
1909
        return [rev_id for rev_id in source_ids if rev_id in result_set]
 
 
1912
class InterSameDataRepository(InterRepository):
 
 
1913
    """Code for converting between repositories that represent the same data.
 
 
1915
    Data format and model must match for this to work.
 
 
1919
    def _get_repo_format_to_test(self):
 
 
1920
        """Repository format for testing with.
 
 
1922
        InterSameData can pull from subtree to subtree and from non-subtree to
 
 
1923
        non-subtree, so we test this with the richest repository format.
 
 
1925
        from bzrlib.repofmt import knitrepo
 
 
1926
        return knitrepo.RepositoryFormatKnit3()
 
 
1929
    def is_compatible(source, target):
 
 
1930
        if source.supports_rich_root() != target.supports_rich_root():
 
 
1932
        if source._serializer != target._serializer:
 
 
1937
    def copy_content(self, revision_id=None):
 
 
1938
        """Make a complete copy of the content in self into destination.
 
 
1940
        This copies both the repository's revision data, and configuration information
 
 
1941
        such as the make_working_trees setting.
 
 
1943
        This is a destructive operation! Do not use it on existing 
 
 
1946
        :param revision_id: Only copy the content needed to construct
 
 
1947
                            revision_id and its parents.
 
 
1950
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
1951
        except NotImplementedError:
 
 
1953
        # TODO: jam 20070210 This is fairly internal, so we should probably
 
 
1954
        #       just assert that revision_id is not unicode.
 
 
1955
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1956
        # but don't bother fetching if we have the needed data now.
 
 
1957
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
 
1958
            self.target.has_revision(revision_id)):
 
 
1960
        self.target.fetch(self.source, revision_id=revision_id)
 
 
1963
    def fetch(self, revision_id=None, pb=None):
 
 
1964
        """See InterRepository.fetch()."""
 
 
1965
        from bzrlib.fetch import GenericRepoFetcher
 
 
1966
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
1967
               self.source, self.source._format, self.target, 
 
 
1968
               self.target._format)
 
 
1969
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
1970
        revision_id = osutils.safe_revision_id(revision_id)
 
 
1971
        f = GenericRepoFetcher(to_repository=self.target,
 
 
1972
                               from_repository=self.source,
 
 
1973
                               last_revision=revision_id,
 
 
1975
        return f.count_copied, f.failed_revisions
 
 
1978
class InterWeaveRepo(InterSameDataRepository):
 
 
1979
    """Optimised code paths between Weave based repositories."""
 
 
1982
    def _get_repo_format_to_test(self):
 
 
1983
        from bzrlib.repofmt import weaverepo
 
 
1984
        return weaverepo.RepositoryFormat7()
 
 
1987
    def is_compatible(source, target):
 
 
1988
        """Be compatible with known Weave formats.
 
 
1990
        We don't test for the stores being of specific types because that
 
 
1991
        could lead to confusing results, and there is no need to be 
 
 
1994
        from bzrlib.repofmt.weaverepo import (
 
 
2000
            return (isinstance(source._format, (RepositoryFormat5,
 
 
2002
                                                RepositoryFormat7)) and
 
 
2003
                    isinstance(target._format, (RepositoryFormat5,
 
 
2005
                                                RepositoryFormat7)))
 
 
2006
        except AttributeError:
 
 
2010
    def copy_content(self, revision_id=None):
 
 
2011
        """See InterRepository.copy_content()."""
 
 
2012
        # weave specific optimised path:
 
 
2013
        # TODO: jam 20070210 Internal, should be an assert, not translate
 
 
2014
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2016
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2017
        except NotImplementedError:
 
 
2019
        # FIXME do not peek!
 
 
2020
        if self.source.control_files._transport.listable():
 
 
2021
            pb = ui.ui_factory.nested_progress_bar()
 
 
2023
                self.target.weave_store.copy_all_ids(
 
 
2024
                    self.source.weave_store,
 
 
2026
                    from_transaction=self.source.get_transaction(),
 
 
2027
                    to_transaction=self.target.get_transaction())
 
 
2028
                pb.update('copying inventory', 0, 1)
 
 
2029
                self.target.control_weaves.copy_multi(
 
 
2030
                    self.source.control_weaves, ['inventory'],
 
 
2031
                    from_transaction=self.source.get_transaction(),
 
 
2032
                    to_transaction=self.target.get_transaction())
 
 
2033
                self.target._revision_store.text_store.copy_all_ids(
 
 
2034
                    self.source._revision_store.text_store,
 
 
2039
            self.target.fetch(self.source, revision_id=revision_id)
 
 
2042
    def fetch(self, revision_id=None, pb=None):
 
 
2043
        """See InterRepository.fetch()."""
 
 
2044
        from bzrlib.fetch import GenericRepoFetcher
 
 
2045
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2046
               self.source, self.source._format, self.target, self.target._format)
 
 
2047
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2048
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2049
        f = GenericRepoFetcher(to_repository=self.target,
 
 
2050
                               from_repository=self.source,
 
 
2051
                               last_revision=revision_id,
 
 
2053
        return f.count_copied, f.failed_revisions
 
 
2056
    def missing_revision_ids(self, revision_id=None):
 
 
2057
        """See InterRepository.missing_revision_ids()."""
 
 
2058
        # we want all revisions to satisfy revision_id in source.
 
 
2059
        # but we don't want to stat every file here and there.
 
 
2060
        # we want then, all revisions other needs to satisfy revision_id 
 
 
2061
        # checked, but not those that we have locally.
 
 
2062
        # so the first thing is to get a subset of the revisions to 
 
 
2063
        # satisfy revision_id in source, and then eliminate those that
 
 
2064
        # we do already have. 
 
 
2065
        # this is slow on high latency connection to self, but as as this
 
 
2066
        # disk format scales terribly for push anyway due to rewriting 
 
 
2067
        # inventory.weave, this is considered acceptable.
 
 
2069
        if revision_id is not None:
 
 
2070
            source_ids = self.source.get_ancestry(revision_id)
 
 
2071
            assert source_ids[0] is None
 
 
2074
            source_ids = self.source._all_possible_ids()
 
 
2075
        source_ids_set = set(source_ids)
 
 
2076
        # source_ids is the worst possible case we may need to pull.
 
 
2077
        # now we want to filter source_ids against what we actually
 
 
2078
        # have in target, but don't try to check for existence where we know
 
 
2079
        # we do not have a revision as that would be pointless.
 
 
2080
        target_ids = set(self.target._all_possible_ids())
 
 
2081
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
 
2082
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
 
2083
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
 
2084
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
 
2085
        if revision_id is not None:
 
 
2086
            # we used get_ancestry to determine source_ids then we are assured all
 
 
2087
            # revisions referenced are present as they are installed in topological order.
 
 
2088
            # and the tip revision was validated by get_ancestry.
 
 
2089
            return required_topo_revisions
 
 
2091
            # if we just grabbed the possibly available ids, then 
 
 
2092
            # we only have an estimate of whats available and need to validate
 
 
2093
            # that against the revision records.
 
 
2094
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
 
2097
class InterKnitRepo(InterSameDataRepository):
 
 
2098
    """Optimised code paths between Knit based repositories."""
 
 
2101
    def _get_repo_format_to_test(self):
 
 
2102
        from bzrlib.repofmt import knitrepo
 
 
2103
        return knitrepo.RepositoryFormatKnit1()
 
 
2106
    def is_compatible(source, target):
 
 
2107
        """Be compatible with known Knit formats.
 
 
2109
        We don't test for the stores being of specific types because that
 
 
2110
        could lead to confusing results, and there is no need to be 
 
 
2113
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1
 
 
2115
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
 
 
2116
                    isinstance(target._format, (RepositoryFormatKnit1)))
 
 
2117
        except AttributeError:
 
 
2121
    def fetch(self, revision_id=None, pb=None):
 
 
2122
        """See InterRepository.fetch()."""
 
 
2123
        from bzrlib.fetch import KnitRepoFetcher
 
 
2124
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2125
               self.source, self.source._format, self.target, self.target._format)
 
 
2126
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2127
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2128
        f = KnitRepoFetcher(to_repository=self.target,
 
 
2129
                            from_repository=self.source,
 
 
2130
                            last_revision=revision_id,
 
 
2132
        return f.count_copied, f.failed_revisions
 
 
2135
    def missing_revision_ids(self, revision_id=None):
 
 
2136
        """See InterRepository.missing_revision_ids()."""
 
 
2137
        if revision_id is not None:
 
 
2138
            source_ids = self.source.get_ancestry(revision_id)
 
 
2139
            assert source_ids[0] is None
 
 
2142
            source_ids = self.source._all_possible_ids()
 
 
2143
        source_ids_set = set(source_ids)
 
 
2144
        # source_ids is the worst possible case we may need to pull.
 
 
2145
        # now we want to filter source_ids against what we actually
 
 
2146
        # have in target, but don't try to check for existence where we know
 
 
2147
        # we do not have a revision as that would be pointless.
 
 
2148
        target_ids = set(self.target._all_possible_ids())
 
 
2149
        possibly_present_revisions = target_ids.intersection(source_ids_set)
 
 
2150
        actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
 
 
2151
        required_revisions = source_ids_set.difference(actually_present_revisions)
 
 
2152
        required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
 
 
2153
        if revision_id is not None:
 
 
2154
            # we used get_ancestry to determine source_ids then we are assured all
 
 
2155
            # revisions referenced are present as they are installed in topological order.
 
 
2156
            # and the tip revision was validated by get_ancestry.
 
 
2157
            return required_topo_revisions
 
 
2159
            # if we just grabbed the possibly available ids, then 
 
 
2160
            # we only have an estimate of whats available and need to validate
 
 
2161
            # that against the revision records.
 
 
2162
            return self.source._eliminate_revisions_not_present(required_topo_revisions)
 
 
2165
class InterModel1and2(InterRepository):
 
 
2168
    def _get_repo_format_to_test(self):
 
 
2172
    def is_compatible(source, target):
 
 
2173
        if not source.supports_rich_root() and target.supports_rich_root():
 
 
2179
    def fetch(self, revision_id=None, pb=None):
 
 
2180
        """See InterRepository.fetch()."""
 
 
2181
        from bzrlib.fetch import Model1toKnit2Fetcher
 
 
2182
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2183
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2184
        f = Model1toKnit2Fetcher(to_repository=self.target,
 
 
2185
                                 from_repository=self.source,
 
 
2186
                                 last_revision=revision_id,
 
 
2188
        return f.count_copied, f.failed_revisions
 
 
2191
    def copy_content(self, revision_id=None):
 
 
2192
        """Make a complete copy of the content in self into destination.
 
 
2194
        This is a destructive operation! Do not use it on existing 
 
 
2197
        :param revision_id: Only copy the content needed to construct
 
 
2198
                            revision_id and its parents.
 
 
2201
            self.target.set_make_working_trees(self.source.make_working_trees())
 
 
2202
        except NotImplementedError:
 
 
2204
        # TODO: jam 20070210 Internal, assert, don't translate
 
 
2205
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2206
        # but don't bother fetching if we have the needed data now.
 
 
2207
        if (revision_id not in (None, _mod_revision.NULL_REVISION) and 
 
 
2208
            self.target.has_revision(revision_id)):
 
 
2210
        self.target.fetch(self.source, revision_id=revision_id)
 
 
2213
class InterKnit1and2(InterKnitRepo):
 
 
2216
    def _get_repo_format_to_test(self):
 
 
2220
    def is_compatible(source, target):
 
 
2221
        """Be compatible with Knit1 source and Knit3 target"""
 
 
2222
        from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
 
 
2224
            from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
 
 
2225
                    RepositoryFormatKnit3
 
 
2226
            return (isinstance(source._format, (RepositoryFormatKnit1)) and
 
 
2227
                    isinstance(target._format, (RepositoryFormatKnit3)))
 
 
2228
        except AttributeError:
 
 
2232
    def fetch(self, revision_id=None, pb=None):
 
 
2233
        """See InterRepository.fetch()."""
 
 
2234
        from bzrlib.fetch import Knit1to2Fetcher
 
 
2235
        mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
 
 
2236
               self.source, self.source._format, self.target, 
 
 
2237
               self.target._format)
 
 
2238
        # TODO: jam 20070210 This should be an assert, not a translate
 
 
2239
        revision_id = osutils.safe_revision_id(revision_id)
 
 
2240
        f = Knit1to2Fetcher(to_repository=self.target,
 
 
2241
                            from_repository=self.source,
 
 
2242
                            last_revision=revision_id,
 
 
2244
        return f.count_copied, f.failed_revisions
 
 
2247
class InterRemoteRepository(InterRepository):
 
 
2248
    """Code for converting between RemoteRepository objects.
 
 
2250
    This just gets an non-remote repository from the RemoteRepository, and calls
 
 
2251
    InterRepository.get again.
 
 
2254
    def __init__(self, source, target):
 
 
2255
        if isinstance(source, remote.RemoteRepository):
 
 
2256
            source._ensure_real()
 
 
2257
            real_source = source._real_repository
 
 
2259
            real_source = source
 
 
2260
        if isinstance(target, remote.RemoteRepository):
 
 
2261
            target._ensure_real()
 
 
2262
            real_target = target._real_repository
 
 
2264
            real_target = target
 
 
2265
        self.real_inter = InterRepository.get(real_source, real_target)
 
 
2268
    def is_compatible(source, target):
 
 
2269
        if isinstance(source, remote.RemoteRepository):
 
 
2271
        if isinstance(target, remote.RemoteRepository):
 
 
2275
    def copy_content(self, revision_id=None):
 
 
2276
        self.real_inter.copy_content(revision_id=revision_id)
 
 
2278
    def fetch(self, revision_id=None, pb=None):
 
 
2279
        self.real_inter.fetch(revision_id=revision_id, pb=pb)
 
 
2282
    def _get_repo_format_to_test(self):
 
 
2286
InterRepository.register_optimiser(InterSameDataRepository)
 
 
2287
InterRepository.register_optimiser(InterWeaveRepo)
 
 
2288
InterRepository.register_optimiser(InterKnitRepo)
 
 
2289
InterRepository.register_optimiser(InterModel1and2)
 
 
2290
InterRepository.register_optimiser(InterKnit1and2)
 
 
2291
InterRepository.register_optimiser(InterRemoteRepository)
 
 
2294
class CopyConverter(object):
 
 
2295
    """A repository conversion tool which just performs a copy of the content.
 
 
2297
    This is slow but quite reliable.
 
 
2300
    def __init__(self, target_format):
 
 
2301
        """Create a CopyConverter.
 
 
2303
        :param target_format: The format the resulting repository should be.
 
 
2305
        self.target_format = target_format
 
 
2307
    def convert(self, repo, pb):
 
 
2308
        """Perform the conversion of to_convert, giving feedback via pb.
 
 
2310
        :param to_convert: The disk object to convert.
 
 
2311
        :param pb: a progress bar to use for progress information.
 
 
2316
        # this is only useful with metadir layouts - separated repo content.
 
 
2317
        # trigger an assertion if not such
 
 
2318
        repo._format.get_format_string()
 
 
2319
        self.repo_dir = repo.bzrdir
 
 
2320
        self.step('Moving repository to repository.backup')
 
 
2321
        self.repo_dir.transport.move('repository', 'repository.backup')
 
 
2322
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
 
 
2323
        repo._format.check_conversion_target(self.target_format)
 
 
2324
        self.source_repo = repo._format.open(self.repo_dir,
 
 
2326
            _override_transport=backup_transport)
 
 
2327
        self.step('Creating new repository')
 
 
2328
        converted = self.target_format.initialize(self.repo_dir,
 
 
2329
                                                  self.source_repo.is_shared())
 
 
2330
        converted.lock_write()
 
 
2332
            self.step('Copying content into repository.')
 
 
2333
            self.source_repo.copy_content_into(converted)
 
 
2336
        self.step('Deleting old repository content.')
 
 
2337
        self.repo_dir.transport.delete_tree('repository.backup')
 
 
2338
        self.pb.note('repository converted')
 
 
2340
    def step(self, message):
 
 
2341
        """Update the pb by a step."""
 
 
2343
        self.pb.update(message, self.count, self.total)
 
 
2355
def _unescaper(match, _map=_unescape_map):
 
 
2356
    code = match.group(1)
 
 
2360
        if not code.startswith('#'):
 
 
2362
        return unichr(int(code[1:])).encode('utf8')
 
 
2368
def _unescape_xml(data):
 
 
2369
    """Unescape predefined XML entities in a string of data."""
 
 
2371
    if _unescape_re is None:
 
 
2372
        _unescape_re = re.compile('\&([^;]*);')
 
 
2373
    return _unescape_re.sub(_unescaper, data)