UIDatabase::testGetIdoDb() - Code Metrics - Inspection of "Update UIDatabase.php" - patrickpr/trapdirector - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 6228a9...3cc130 )

by Patrick
created 2020-02-12 19:46 UTC
UIDatabase::testGetIdoDb() A

↳ Parent: UIDatabase
Complexity

Conditions	6
Paths	7
Size

Total Lines	35
Code Lines	16
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	6
eloc	16
c	1
b	0
f	0
nc	7
nop	0
dl	0
loc	35
rs	9.1111
<?php

use Icinga\Module\Trapdirector\TrapsController;
use Icinga\Data\Db\DbConnection as IcingaDbConnection;

/**
 * Exception for Database test
 *
 * @license GPL
 * @author Patrick Proy
 * @package trapdirector
 * @subpackage UI
 *
 */
class DBException extends Exception
{
    /** @var array $returnArray */
    private $returnArray;
    
    /**
     * Buil DBException
     * @param array $retarray
     * @param string $message
     * @param int $code
     * @param Exception $previous
     */
    public function __construct(array $retarray, string $message = null, int $code = 0, Exception $previous = null)
    {
        parent::__construct($message,$code,$previous);
        $this->returnArray = $retarray;
    }
    
    /**
     * Get exception array
     * @return array
     */
    public function getArray()
    {
        return $this->returnArray;
    }
}

/**
 * Database functions for user interface
 * 
 * @license GPL
 * @author Patrick Proy
 * @package trapdirector
 * @subpackage UI
 *
 */
class UIDatabase
{
    
    /** @var TrapsController $trapController TrapController 'parent' class */
    protected  $trapController;
    
    /** @var Zend_Db_Adapter_Abstract $trapDB Trap Database*/
    protected $trapDB;
 
    /** @var Zend_Db_Adapter_Abstract $trapDB Icinga IDO database*/
    protected $idoDB;
    
    /** @var array $testResult */
    protected $testResult;
    
    /**
     * 
     * @param TrapsController $trapCtrl
     */
    function __construct(TrapsController $trapCtrl)
    {
        $this->trapController=$trapCtrl;
    }
    
    /**
     * Test if database version >= min database version
     * 
     * @param \Zend_Db_Adapter_Abstract $dbConn
     * @param int $min Minimum version
     * @param bool $test Test mode
     * @param string $DBname Name of DB
     * @return bool true if OK, false if version < min version
     * @throws Exception if error and test = true
     */
    protected function testDbVersion($dbAdapter,int $min,bool $test, string $DBname)
    {
        try
        {
            $query = $dbAdapter->select()
            ->from($this->trapController->getModuleConfig()->getDbConfigTableName(),'value')
            ->where('name=\'db_version\'');
            $version=$dbAdapter->fetchRow($query);
            if ( ($version == null) || ! property_exists($version,'value') )
            {
                if ($test === true) 
                {
                    $this->testResult = array(4,$DBname);
                    return false;
                }
                $this->trapController->redirectNow('trapdirector/settings?dberror=4');
                return false;
            }
            if ($version->value < $min)
            {
                if ($test === true) 
                {
                    $this->testResult = array(5,$version->value,$min);
                    return false;
                }
                $this->trapController->redirectNow('trapdirector/settings?dberror=5');
                return false;
            }
        }
        catch (Exception $e)
        {
            if ($test === true) 
            {
                $this->testResult = array(3,$DBname,$e->getMessage());
                return false;
            }
            $this->trapController->redirectNow('trapdirector/settings?dberror=4');
            return false;
        }
        return true;
    }
    
    /**	Get Database connexion
     *	@param $DBname string DB name in resource.ini_ge
     *	@param $test bool if set to true, returns error code and not database
     *	@param $test_version bool if set to flase, does not test database version of trapDB
     *  @throws DBException if test = true and error
     *	@return Zend_Db_Adapter_Abstract|null : if test=false, returns DB connexion, else array(error_num,message) or null on error.
     */
    protected function getDbByName($DBname , $test = false , $test_version = true)
    {
        try
        {
            $dbconn = IcingaDbConnection::fromResourceName($DBname);
        }
        catch (Exception $e)
        {
            if ($test === true) 
            {
                throw new DBException(array(2,$DBname));
            }
            $this->trapController->redirectNow('trapdirector/settings?dberror=2');
            return null;
        }

        try
        {
            $dbAdapter=$dbconn->getDbAdapter();
            
        }
        catch (Exception $e)
        {
            if ($test === true)
            {
                throw new DBException(array(3,$DBname,$e->getMessage()));
            }
            $this->trapController->redirectNow('trapdirector/settings?dberror=3');
            return null;
        }
        
        if ($test_version == true) {
            $testRet=$this->testDbVersion($dbAdapter, $this->trapController->getModuleConfig()->getDbMinVersion(), $test, $DBname);
            if ($testRet !== true) 
            {
                throw new DBException($this->testResult);
            }
        }
 
        return $dbAdapter;
    }

    /**
     * Get Trap database
     * @param boolean $test
     * @return Zend_Db_Adapter_Abstract|array|null : if test=false, returns DB connexion, else array(error_num,message) or null on error.
     */
    public function getDb()
    {
        if ( $this->trapDB != null ) return $this->trapDB;
        
        $dbresource=$this->trapController->Config()->get('config', 'database');
        
        if ( ! $dbresource )
        {
            $this->trapController->redirectNow('trapdirector/settings?dberror=1');
            return null;
        }

        try {
            $this->trapDB = $this->getDbByName($dbresource,false,true);
        } catch (DBException $e) {
            return null; // Should not happen as test = false
        }
        
        return $this->trapDB;
    }

    /**
     * Test Trap database
     * @param boolean $test
     * @throws DBException on error.
     * @return Zend_Db_Adapter_Abstract|array|null : if test=false, returns DB connexion, else array(error_num,message) or null on error.
     */
    public function testGetDb()
    {       
        $dbresource=$this->trapController->Config()->get('config', 'database');
        
        if ( ! $dbresource )
        {
                throw new DBException(array(1,''));
        }
        
        $this->trapDB = $this->getDbByName($dbresource,true,true);       
        return;
    }
    
    /**
     * Get IDO Database 
     * @param boolean $test
     * @return Zend_Db_Adapter_Abstract|NULL  returns DB connexion or null on error.
     */
    public function getIdoDb($test=false)
    {
        if ($this->idoDB != null && $test === false) return $this->idoDB;
        // TODO : get ido database directly from icingaweb2 config -> (or not if using only API)
        $dbresource=$this->trapController->Config()->get('config', 'IDOdatabase');;
        
        if ( ! $dbresource )
        {
            $this->redirectNow('trapdirector/settings?idodberror=1');
                   redirectNow('trapdirector/settings?idodberror=1');
            return null;
        }
        
        try
        {
            $dbconn = IcingaDbConnection::fromResourceName($dbresource);
        }
        catch (Exception $e)
        {
            $this->redirectNow('trapdirector/settings?idodberror=2');
            return null;
        }

        $this->idoDB = $dbconn->getDbAdapter();
        return $this->idoDB;
    }

    /**
     * Get IDO Database
     * @param boolean $test
     * @throws DBException on error
     */
    public function testGetIdoDb()
    {
        // TODO : get ido database directly from icingaweb2 config -> (or not if using only API)
        $dbresource=$this->trapController->Config()->get('config', 'IDOdatabase');;
        
        if ( ! $dbresource )
        {
            throw new DBException(array(1,'No database in config.ini'));
        }
        
        try
        {
            $dbconn = IcingaDbConnection::fromResourceName($dbresource);
        }
        catch (Exception $e)
        {
            throw new DBException( array(2,"Database $dbresource does not exists in IcingaWeb2") );
        }
               
        try
        {
            $query = $dbconn->select()
            ->from('icinga_dbversion',array('version'));
            $version=$dbconn->fetchRow($query);
            if ( ($version == null) || ! property_exists($version,'version') )
            {
                throw new DBException( array(4,"$dbresource does not look like an IDO database"));
            }
        }
        catch (Exception $e)
        {
            throw new DBException( array(3,"Error connecting to $dbresource : " . $e->getMessage()));
        }
        
        return;
    }
    
}
patrickpr / trapdirector

Push — master ( 6228a9...3cc130 )

UIDatabase::testGetIdoDb() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
