~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2004, 2005 by Martin Pool

# Copyright (C) 2005 by Canonical Ltd

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import tempfile, os, errno

import bzrlib.errors

import bzrlib.progress

from bzrlib.xml import serializer_v4

def upgrade(branch):

    """

    Upgrade branch to current format.

    This causes objects to be rewritten into the current format.

    If they change, their SHA-1 will of course change, which might

    break any later signatures, or backreferences that check the

    SHA-1.

    TODO: Check non-mainline revisions.

    """

    import sys

    from bzrlib.trace import mutter

    from bzrlib.errors import BzrCheckError

    import bzrlib.ui

    branch.lock_write()

    pb = bzrlib.ui.ui_factory.progress_bar()

    try:

        last_rev_id = None

        history = branch.revision_history()

        revno = 0

        revcount = len(history)

        updated_revisions = []

        # Set to True in the case that the previous revision entry

        # was updated, since this will affect future revision entries

        updated_previous_revision = False

        for rev_id in history:

            revno += 1

            pb.update('upgrading revision', revno, revcount)

            rev = branch.get_revision(rev_id)

            if rev.revision_id != rev_id:

                raise BzrCheckError('wrong internal revision id in revision {%s}'

                                    % rev_id)

            last_rev_id = rev_id

            # if set to true, revision must be written out

            updated = False

            if rev.inventory_sha1 is None:

                rev.inventory_sha1 = branch.get_inventory_sha1(rev.inventory_id)

                updated = True

                mutter("  set inventory_sha1 on {%s}" % rev_id)

            for prr in rev.parents:

                try:

                    actual_sha1 = branch.get_revision_sha1(prr.revision_id)

                except bzrlib.errors.NoSuchRevision:

                    mutter("parent {%s} of {%s} not present in branch; skipped"

                           % (prr.revision_id, rev_id))

                    continue

                if actual_sha1 != prr.revision_sha1:

                    mutter("parent {%s} of {%s} sha1 mismatch: "

                           "%s vs %s; fixed"

                           % (prr.revision_id, rev_id,

                              actual_sha1, prr.revision_sha1))

                    prr.revision_sha1 = actual_sha1

                    updated = True

            if updated:

                updated_previous_revision = True

                # We had to update this revision entries hashes

                # Now we need to write out a new value

                # This is a little bit invasive, since we are *rewriting* a

                # revision entry. I'm not supremely happy about it, but

                # there should be *some* way of making old entries have

                # the full meta information.

                rev_tmp = tempfile.TemporaryFile()

                serializer_v4.write_revision(rev, rev_tmp)

                rev_tmp.seek(0)

                tmpfd, tmp_path = tempfile.mkstemp(prefix=rev_id, suffix='.gz',

                    dir=branch.controlfilename('revision-store'))

                os.close(tmpfd)

                def special_rename(p1, p2):

                    if sys.platform == 'win32':

                        try:

                            os.remove(p2)

                        except OSError, e:

                            if e.errno != errno.ENOENT:

                                raise

                    os.rename(p1, p2)

                try:

                    # TODO: We may need to handle the case where the old revision

                    # entry was not compressed (and thus did not end with .gz)

                    # Remove the old revision entry out of the way

                    rev_path = branch.controlfilename(['revision-store', rev_id+'.gz'])

                    special_rename(rev_path, tmp_path)

                    branch.revision_store.add(rev_tmp, rev_id) # Add the new one

                    os.remove(tmp_path) # Remove the old name

                    mutter('    Updated revision entry {%s}' % rev_id)

                except:

                    # On any exception, restore the old entry

                    special_rename(tmp_path, rev_path)

                    raise

                rev_tmp.close()

                updated_revisions.append(rev_id)

            else:

                updated_previous_revision = False

    finally:

        branch.unlock()

    pb.clear()

    if updated_revisions:

        print '%d revisions updated to current format' % len(updated_revisions)