# Copyright (C) 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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. # TODO: Perhaps have a way to record errors other than by raising exceptions; # would perhaps be enough to accumulate exception objects in a list without # raising them. If there's more than one exception it'd be good to see them # all. from bzrlib import errors, osutils from bzrlib import repository as _mod_repository from bzrlib import revision from bzrlib.branch import Branch from bzrlib.bzrdir import BzrDir from bzrlib.errors import BzrCheckError from bzrlib.repository import Repository from bzrlib.symbol_versioning import deprecated_function, deprecated_in from bzrlib.trace import log_error, note import bzrlib.ui from bzrlib.workingtree import WorkingTree class Check(object): """Check a repository""" # The Check object interacts with InventoryEntry.check, etc. def __init__(self, repository): self.repository = repository 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; used by InventoryFile._check self.checked_texts = {} self.checked_weaves = set() self.unreferenced_versions = set() self.inconsistent_parents = [] self.rich_roots = repository.supports_rich_root() self.text_key_references = {} def check(self): self.repository.lock_read() self.progress = bzrlib.ui.ui_factory.nested_progress_bar() try: self.progress.update('retrieving inventory', 0, 2) # do not put in init, as it should be done with progess, # and inside the lock. self.inventory_weave = self.repository.inventories self.progress.update('checking revision graph', 1) self.check_revision_graph() 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) # check_weaves is done after the revision scan so that # revision index is known to be valid. self.check_weaves() finally: self.progress.finished() self.repository.unlock() def check_revision_graph(self): if not self.repository.revision_graph_can_have_wrong_parents(): # This check is not necessary. self.revs_with_bad_parents_in_index = None return bad_revisions = self.repository._find_inconsistent_revision_parents() self.revs_with_bad_parents_in_index = list(bad_revisions) def plan_revisions(self): repository = self.repository self.planned_revisions = repository.all_revision_ids() self.progress.clear() inventoried = set(key[-1] for key in self.inventory_weave.keys()) awol = set(self.planned_revisions) - inventoried if len(awol) > 0: raise BzrCheckError('Stored revisions missing from inventory' '{%s}' % ','.join([f for f in awol])) def report_results(self, verbose): note('checked repository %s format %s', self.repository.bzrdir.root_transport, self.repository._format) note('%6d revisions', self.checked_rev_cnt) note('%6d file-ids', len(self.checked_weaves)) note('%6d unique file texts', self.checked_text_cnt) note('%6d repeated file texts', self.repeated_text_cnt) note('%6d unreferenced text versions', len(self.unreferenced_versions)) 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) if verbose: for file_id, revision_id in self.unreferenced_versions: log_error('unreferenced version: {%s} in %s', revision_id, file_id) if len(self.inconsistent_parents): note('%6d inconsistent parents', len(self.inconsistent_parents)) if verbose: for info in self.inconsistent_parents: revision_id, file_id, found_parents, correct_parents = info note(' * %s version %s has parents %r ' 'but should have %r' % (file_id, revision_id, found_parents, correct_parents)) if self.revs_with_bad_parents_in_index: note('%6d revisions have incorrect parents in the revision index', len(self.revs_with_bad_parents_in_index)) if verbose: for item in self.revs_with_bad_parents_in_index: revision_id, index_parents, actual_parents = item note( ' %s has wrong parents in index: ' '%r should be %r', revision_id, index_parents, actual_parents) def check_one_rev(self, rev_id): """Check one revision. rev_id - the one to check """ rev = self.repository.get_revision(rev_id) if rev.revision_id != rev_id: raise BzrCheckError('wrong internal revision id in revision {%s}' % rev_id) for parent in rev.parent_ids: if not parent in self.planned_revisions: # rev has a parent we didn't know about. 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.repository.has_revision(parent): missing_ancestry = self.repository.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) if rev.inventory_sha1: # Loopback - this is currently circular logic as the # knit get_inventory_sha1 call returns rev.inventory_sha1. # Repository.py's get_inventory_sha1 should instead return # inventories.get_record_stream([(revid,)]).next().sha1 or # similar. inv_sha1 = self.repository.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) self._check_revision_tree(rev_id) self.checked_rev_cnt += 1 def check_weaves(self): """Check all the weaves we can get our hands on. """ weave_ids = [] self.progress.update('checking inventory', 0, 2) self.inventory_weave.check(progress_bar=self.progress) self.progress.update('checking text storage', 1, 2) self.repository.texts.check(progress_bar=self.progress) weave_checker = self.repository._get_versioned_file_checker( text_key_references=self.text_key_references) result = weave_checker.check_file_version_parents( self.repository.texts, progress_bar=self.progress) self.checked_weaves = weave_checker.file_ids bad_parents, unused_versions = result bad_parents = bad_parents.items() for text_key, (stored_parents, correct_parents) in bad_parents: # XXX not ready for id join/split operations. weave_id = text_key[0] revision_id = text_key[-1] weave_parents = tuple([parent[-1] for parent in stored_parents]) correct_parents = tuple([parent[-1] for parent in correct_parents]) self.inconsistent_parents.append( (revision_id, weave_id, weave_parents, correct_parents)) self.unreferenced_versions.update(unused_versions) def _check_revision_tree(self, rev_id): tree = self.repository.revision_tree(rev_id) inv = tree.inventory seen_ids = set() seen_names = set() for path, ie in inv.iter_entries(): self._add_entry_to_text_key_references(inv, ie) file_id = ie.file_id if file_id in seen_ids: raise BzrCheckError('duplicated file_id {%s} ' 'in inventory for revision {%s}' % (file_id, rev_id)) seen_ids.add(file_id) ie.check(self, rev_id, inv, tree) if path in seen_names: raise BzrCheckError('duplicated path %s ' 'in inventory for revision {%s}' % (path, rev_id)) seen_names.add(path) def _add_entry_to_text_key_references(self, inv, entry): if not self.rich_roots and entry == inv.root: return key = (entry.file_id, entry.revision) self.text_key_references.setdefault(key, False) if entry.revision == inv.revision_id: self.text_key_references[key] = True @deprecated_function(deprecated_in((1,6,0))) def check(branch, verbose): """Run consistency checks on a branch. Results are reported through logging. Deprecated in 1.6. Please use check_branch instead. :raise BzrCheckError: if there's a consistency error. """ check_branch(branch, verbose) def check_branch(branch, verbose): """Run consistency checks on a branch. Results are reported through logging. :raise BzrCheckError: if there's a consistency error. """ branch.lock_read() try: branch_result = branch.check() finally: branch.unlock() branch_result.report_results(verbose) def check_dwim(path, verbose, do_branch=False, do_repo=False, do_tree=False): try: tree, branch, repo, relpath = \ BzrDir.open_containing_tree_branch_or_repository(path) except errors.NotBranchError: tree = branch = repo = None if do_tree: if tree is not None: note("Checking working tree at '%s'." % (tree.bzrdir.root_transport.base,)) tree._check() else: log_error("No working tree found at specified location.") if branch is not None: # We have a branch if repo is None: # The branch is in a shared repository repo = branch.repository branches = [branch] elif repo is not None: branches = repo.find_branches(using=True) if repo is not None: repo.lock_read() try: if do_repo: note("Checking repository at '%s'." % (repo.bzrdir.root_transport.base,)) result = repo.check() result.report_results(verbose) if do_branch: if branches == []: log_error("No branch found at specified location.") else: for branch in branches: note("Checking branch at '%s'." % (branch.bzrdir.root_transport.base,)) check_branch(branch, verbose) finally: repo.unlock() else: if do_branch: log_error("No branch found at specified location.") if do_repo: log_error("No repository found at specified location.")