~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 bzrlib.ui

from bzrlib.trace import note, warning

def _update_store_entry(obj, obj_id, branch, store_name, store):

    """This is just a meta-function, which handles both revision entries

    and inventory entries.

    """

    from bzrlib.trace import mutter

    import tempfile, os, errno

    from osutils import rename

    obj_tmp = tempfile.TemporaryFile()

    obj.write_xml(obj_tmp)

    obj_tmp.seek(0)

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

        dir=branch.controlfilename(store_name))

    os.close(tmpfd)

    try:

        orig_obj_path = branch.controlfilename([store_name, obj_id+'.gz'])

        # Remove the old entry out of the way

        rename(orig_obj_path, tmp_path)

        try:

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

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

            store.add(obj_tmp, obj_id) # Add the new one

            os.remove(tmp_path) # Remove the old name

            mutter('    Updated %s entry {%s}' % (store_name, obj_id))

        except:

            # On any exception, restore the old entry

            rename(tmp_path, orig_obj_path)

            raise

    finally:

        if os.path.exists(tmp_path):

            # Unfortunately, the next command might throw

            # an exception, which will mask a previous exception.

            os.remove(tmp_path)

        obj_tmp.close()

def _update_revision_entry(rev, branch):

    """After updating the values in a revision, make sure to

    write out the data, but try to do it in an atomic manner.

    :param rev:    The Revision object to store

    :param branch: The Branch object where this Revision is to be stored.

    """

    _update_store_entry(rev, rev.revision_id, branch,

            'revision-store', branch.revision_store)

def _update_inventory_entry(inv, inv_id, branch):

    """When an inventory has been modified (such as by adding a unique tree root)

    this atomically re-generates the file.

    :param inv:     The Inventory

    :param inv_id:  The inventory id for this inventory

    :param branch:  The Branch where this entry will be stored.

    """

    _update_store_entry(inv, inv_id, branch,

            'inventory-store', branch.inventory_store)

def check(branch):

    """Run consistency checks on a branch.

    TODO: Also check non-mainline revisions mentioned as parents.

    TODO: Check for extra files in the control directory.

    """

    from bzrlib.trace import mutter

    from bzrlib.errors import BzrCheckError, NoSuchRevision

    from bzrlib.osutils import fingerprint_file

    from bzrlib.inventory import ROOT_ID

    from bzrlib.branch import gen_root_id

    branch.lock_read()

    try:

        last_rev_id = None

        missing_inventory_sha_cnt = 0

        missing_revision_sha_cnt = 0

        missing_revision_cnt = 0

        history = branch.revision_history()

        revno = 0

        revcount = len(history)

        mismatch_inv_id = []

        # for all texts checked, text_id -> sha1

        checked_texts = {}

        progress = bzrlib.ui.ui_factory.progress_bar()

        for rev_id in history:

            revno += 1

            progress.update('checking revision', revno, revcount)

            # mutter('    revision {%s}' % rev_id)

            rev = branch.get_revision(rev_id)

            if rev.revision_id != rev_id:

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

                                    % rev_id)

            # check the previous history entry is a parent of this entry

            if rev.parents:

                if last_rev_id is None:

                    raise BzrCheckError("revision {%s} has %d parents, but is the "

                                        "start of the branch"

                                        % (rev_id, len(rev.parents)))

                for prr in rev.parents:

                    if prr.revision_id == last_rev_id:

                        break

                else:

                    raise BzrCheckError("previous revision {%s} not listed among "

                                        "parents of {%s}"

                                        % (last_rev_id, rev_id))

                for prr in rev.parents:

                    if prr.revision_sha1 is None:

                        missing_revision_sha_cnt += 1

                        continue

                    prid = prr.revision_id

                    try:

                        actual_sha = branch.get_revision_sha1(prid)

                    except NoSuchRevision:

                        missing_revision_cnt += 1

                        mutter("parent {%s} of {%s} not present in store",

                               prid, rev_id)

                        continue

                    if prr.revision_sha1 != actual_sha:

                        raise BzrCheckError("mismatched revision sha1 for "

                                            "parent {%s} of {%s}: %s vs %s"

                                            % (prid, rev_id,

                                               prr.revision_sha1, actual_sha))

            elif last_rev_id:

                raise BzrCheckError("revision {%s} has no parents listed but preceded "

                                    "by {%s}"

                                    % (rev_id, last_rev_id))

            if rev.inventory_id != rev_id:

                mismatch_inv_id.append(rev_id)

            ## TODO: Check all the required fields are present on the revision.

            if rev.inventory_sha1:

                inv_sha1 = branch.get_inventory_sha1(rev.inventory_id)

                if inv_sha1 != rev.inventory_sha1:

                    raise BzrCheckError('Inventory sha1 hash doesn\'t match'

                        ' value in revision {%s}' % rev_id)

            else:

                missing_inventory_sha_cnt += 1

                mutter("no inventory_sha1 on revision {%s}" % rev_id)

            inv = branch.get_inventory(rev.inventory_id)

            seen_ids = {}

            seen_names = {}

            ## p('revision %d/%d file ids' % (revno, revcount))

            for file_id in inv:

                if file_id in seen_ids:

                    raise BzrCheckError('duplicated file_id {%s} '

                                        'in inventory for revision {%s}'

                                        % (file_id, rev_id))

                seen_ids[file_id] = True

            i = 0

            for file_id in inv:

                i += 1

                if i & 31 == 0:

                    progress.tick()

                ie = inv[file_id]

                if ie.parent_id != None:

                    if ie.parent_id not in seen_ids:

                        raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'

                                % (ie.parent_id, rev_id))

                if ie.kind == 'file':

                    if ie.text_id in checked_texts:

                        fp = checked_texts[ie.text_id]

                    else:

                        if not ie.text_id in branch.text_store:

                            raise BzrCheckError('text {%s} not in text_store' % ie.text_id)

                        tf = branch.text_store[ie.text_id]

                        fp = fingerprint_file(tf)

                        checked_texts[ie.text_id] = fp

                    if ie.text_size != fp['size']:

                        raise BzrCheckError('text {%s} wrong size' % ie.text_id)

                    if ie.text_sha1 != fp['sha1']:

                        raise BzrCheckError('text {%s} wrong sha1' % ie.text_id)

                elif ie.kind == 'directory':

                    if ie.text_sha1 != None or ie.text_size != None or ie.text_id != None:

                        raise BzrCheckError('directory {%s} has text in revision {%s}'

                                % (file_id, rev_id))

            progress.tick()

            for path, ie in inv.iter_entries():

                if path in seen_names:

                    raise BzrCheckError('duplicated path %s '

                                        'in inventory for revision {%s}'

                                        % (path, rev_id))

            seen_names[path] = True

            last_rev_id = rev_id

    finally:

        branch.unlock()

    progress.clear()

    note('checked %d revisions, %d file texts' % (revcount, len(checked_texts)))

    if missing_inventory_sha_cnt:

        note('%d revisions are missing inventory_sha1' % missing_inventory_sha_cnt)

    if missing_revision_sha_cnt:

        note('%d parent links are missing revision_sha1' % missing_revision_sha_cnt)

    if missing_revision_cnt:

        note('%d revisions are mentioned but not present' % missing_revision_cnt)

    if missing_revision_cnt:

        print '%d revisions are mentioned but not present' % missing_revision_cnt

    # stub this out for now because the main bzr branch has references

    # to revisions that aren't present in the store -- mbp 20050804

#    if (missing_inventory_sha_cnt

#        or missing_revision_sha_cnt):

#        print '  (use "bzr upgrade" to fix them)'

    if mismatch_inv_id:

        warning('%d revisions have mismatched inventory ids:' % len(mismatch_inv_id))

        for rev_id in mismatch_inv_id:

            warning('  %s', rev_id)