~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

# TODO: Check ancestries are correct for every revision: includes

# every committed so far, and in a reasonable order.

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

# TODO: Check for extra files in the control directory.

# TODO: Check revision, inventory and entry objects have all 

# required fields.

# TODO: Get every revision in the revision-store even if they're not

# referenced by history and make sure they're all valid.

import bzrlib.ui

from bzrlib.trace import note, warning

from bzrlib.osutils import rename, sha_string, fingerprint_file

from bzrlib.trace import mutter

from bzrlib.errors import BzrCheckError, NoSuchRevision

from bzrlib.inventory import ROOT_ID

class Check(object):

    """Check a branch"""

    def __init__(self, branch):

        self.branch = branch

        self.checked_text_cnt = 0

        self.checked_rev_cnt = 0

        self.ghosts = []

        self.repeated_text_cnt = 0

        self.missing_parent_links = {}

        self.missing_inventory_sha_cnt = 0

        self.missing_revision_cnt = 0

        # maps (file-id, version) -> sha1

        self.checked_texts = {}

    def check(self):

        self.branch.lock_read()

        self.progress = bzrlib.ui.ui_factory.progress_bar()

        try:

            self.progress.update('retrieving inventory', 0, 0)

            # do not put in init, as it should be done with progess,

            # and inside the lock.

            self.inventory_weave = self.branch._get_inventory_weave()

            self.history = self.branch.revision_history()

            if not len(self.history):

                # nothing to see here

                return

            self.plan_revisions()

            revno = 0

            while revno < len(self.planned_revisions):

                rev_id = self.planned_revisions[revno]

                self.progress.update('checking revision', revno,

                                     len(self.planned_revisions))

                revno += 1

                self.check_one_rev(rev_id)

        finally:

            self.progress.clear()

            self.branch.unlock()

    def plan_revisions(self):

        if not self.branch.revision_store.listable():

            self.planned_revisions = self.branch.get_ancestry(self.history[-1])

            self.planned_revisions.remove(None)

            # FIXME progress bars should support this more nicely.

            self.progress.clear()

            print ("Checking reachable history -"

                   " for a complete check use a local branch.")

            return

        self.planned_revisions = set(self.branch.revision_store)

        inventoried = set(self.inventory_weave.names())

        awol = self.planned_revisions - inventoried

        if len(awol) > 0:

            raise BzrCheckError('Stored revisions missing from inventory'

                '{%s}' % ','.join([f for f in awol]))

        self.planned_revisions = list(self.planned_revisions)

    def report_results(self, verbose):

        note('checked branch %s format %d',

             self.branch.base, 

             self.branch._branch_format)

        note('%6d revisions', self.checked_rev_cnt)

        note('%6d unique file texts', self.checked_text_cnt)

        note('%6d repeated file texts', self.repeated_text_cnt)

        if self.missing_inventory_sha_cnt:

            note('%6d revisions are missing inventory_sha1',

                 self.missing_inventory_sha_cnt)

        if self.missing_revision_cnt:

            note('%6d revisions are mentioned but not present',

                 self.missing_revision_cnt)

        if len(self.ghosts):

            note('%6d ghost revisions', len(self.ghosts))

            if verbose:

                for ghost in self.ghosts:

                    note('      %s', ghost)

        if len(self.missing_parent_links):

            note('%6d revisions missing parents in ancestry', 

                 len(self.missing_parent_links))

            if verbose:

                for link, linkers in self.missing_parent_links.items():

                    note('      %s should be in the ancestry for:', link)

                    for linker in linkers:

                        note('       * %s', linker)

    def check_one_rev(self, rev_id):

        """Check one revision.

        rev_id - the one to check

        last_rev_id - the previous one on the mainline, if any.

        """

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

        branch = self.branch

        try:

            rev_history_position = self.history.index(rev_id)

        except ValueError:

            rev_history_position = None

        last_rev_id = None

        if rev_history_position:

            rev = branch.get_revision(rev_id)

            if rev_history_position > 0:

                last_rev_id = self.history[rev_history_position - 1]

        else:

            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.parent_ids:

            if last_rev_id is not None:

                for parent_id in rev.parent_ids:

                    if parent_id == last_rev_id:

                        break

                else:

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

                                        "parents of {%s}"

                                        % (last_rev_id, rev_id))

            for parent in rev.parent_ids:

                if not parent in self.planned_revisions:

                    missing_links = self.missing_parent_links.get(parent, [])

                    missing_links.append(rev_id)

                    self.missing_parent_links[parent] = missing_links

                    # list based so somewhat slow,

                    # TODO have a planned_revisions list and set.

                    if self.branch.has_revision(parent):

                        missing_ancestry = self.branch.get_ancestry(parent)

                        for missing in missing_ancestry:

                            if (missing is not None 

                                and missing not in self.planned_revisions):

                                self.planned_revisions.append(missing)

                    else:

                        self.ghosts.append(rev_id)

        elif last_rev_id:

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

                                "but preceded by {%s}"

                                % (rev_id, last_rev_id))

        if rev.inventory_sha1:

            inv_sha1 = branch.get_inventory_sha1(rev_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)

        self._check_revision_tree(rev_id)

        self.checked_rev_cnt += 1

    def _check_revision_tree(self, rev_id):

        tree = self.branch.revision_tree(rev_id)

        inv = tree.inventory

        seen_ids = {}

        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

        for file_id in inv:

            ie = inv[file_id]

            ie.check(self, rev_id, inv, tree)

        seen_names = {}

        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

def check(branch, verbose):

    """Run consistency checks on a branch."""

    checker = Check(branch)

    checker.check()

    checker.report_results(verbose)