sanity_check.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2014 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Dao\FolderDao;
use Fossology\Lib\Data\Clearing\ClearingEventTypes;
use Fossology\Lib\Data\DecisionScopes;
use Fossology\Lib\Data\DecisionTypes;
use Fossology\Lib\Data\UploadStatus;
use Fossology\Lib\Db\DbManager;
 
class SanityChecker
{
  protected $dbManager;
  protected $verbose;
  protected $errors = 0;
  
  function __construct(&$dbManager,$verbose)
  {
    $this->dbManager = $dbManager;
    $this->verbose = $verbose;
  }
 
  public function check()
  {
    $this->checkDecisionScopes();
    $this->checkUploadStatus();
    $this->checkLicenseEventTypes();
    $this->checkExistsTable('license_candidate');
    $folderDao = new FolderDao($this->dbManager, $GLOBALS['container']->get('dao.user'), $GLOBALS['container']->get('dao.upload'));
    $folderDao->ensureTopLevelFolder();
    
    return $this->errors;
  }
 
  private function checkDecisionScopes()
  {
    $decScopes = new DecisionScopes();
    $scopeMap = $decScopes->getMap();
    $this->errors += $this->checkDatabaseEnum($tablename = 'clearing_decision', 'scope', $scopeMap);
    $decTypes = new DecisionTypes();
    $typeMap = $decTypes->getExtendedMap();
    $this->errors += $this->checkDatabaseEnum($tablename = 'clearing_decision', 'decision_type', $typeMap);
  }
 
  private function checkUploadStatus()
  {
    $uploadStatus = new UploadStatus();
    $statusMap = $uploadStatus->getMap();
    $this->errors += $this->checkDatabaseEnum($tablename = 'upload_clearing', 'status_fk', $statusMap);
  }
 
  private function checkLicenseEventTypes()
  {
    $licenseEventTypes = new ClearingEventTypes();
    $map = $licenseEventTypes->getMap();
    $this->errors += $this->checkDatabaseEnum($tablename='clearing_event', 'type_fk', $map);
  }
  
  private function checkDatabaseEnum($tablename,$columnname,$map)
  {
    $errors = 0;
    $stmt = __METHOD__.".$tablename.$columnname";
    $sql = "SELECT $columnname,count(*) FROM $tablename GROUP BY $columnname";
    $this->dbManager->prepare($stmt,$sql);
    $res = $this->dbManager->execute($stmt);
    while($row = $this->dbManager->fetchArray($res))
    {
      if(!array_key_exists($row[$columnname], $map))
      {
        echo "(-) found invalid $columnname '".$row[$columnname]."' in table '$tablename'\n";
        $errors++;
      }
      else if($this->verbose)
      {
        echo "(+) found valid $columnname '".$row[$columnname]."' in table '$tablename'\n";
      }
    }
    $this->dbManager->freeResult($res);
    return $errors;
  }
  
  private function checkExistsTable($tableName)
  {
    $error = intval(!$this->dbManager->existsTable($tableName));
    if($error){
      echo "(-) table $tableName does not exists";
    }
    else if($this->verbose)
    {
      echo "(+) table $tableName exists";
    }
    $this->errors += $error;
  }
}