Intraface_Install - Code Metrics - intraface/intraface.dk - Measure and Improve Code Quality continuously with Scrutinizer

Intraface_Install B
last analyzed 2017-03-20 12:20 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	253
Duplicated Lines	25.3 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
dl	64
loc	253
rs	8.3999
c	0
b	0
f	0
wmc	46
lcom	1
cbo	10

12 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	14	6
A	dropDatabase()	15	15	4
C	createDatabaseSchema()	14	25	7
A	emptyDatabase()	15	15	4
A	createStartingValues()	7	14	4
B	resetServer()	0	28	4
B	deleteUploadDirectory()	13	13	5
B	grantModuleAccess()	0	30	4
A	loginUser()	0	11	1
B	runHelperFunction()	0	29	3
A	registerModules()	0	6	1
A	splitSql()	0	16	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Intraface_Install often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Intraface_Install, and based on these observations, apply Extract Interface, too.

<?php
class Intraface_Install
{
    /**
     * @var object database connection
     */
    private $db;

    /**
     * constructor. Checks if the script can be run. Connects to database.
     */
    function __construct()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!defined('SERVER_STATUS') OR SERVER_STATUS == 'PRODUCTION') {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            die('Can not be performed on PRODUCTION SERVER');

        } elseif (!empty($_SERVER['HTTP_HOST']) AND $_SERVER['HTTP_HOST'] == 'www.intraface.dk') {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            die('Can not be performed on www.intraface.dk');

        }

        $this->db = MDB2::singleton(DB_DSN);

        if (PEAR::isError($this->db)) {
            throw new Exception($this->db->getUserInfo());
        }
    }

    function dropDatabase()

    {
        $result = $this->db->query("SHOW TABLES FROM " . DB_NAME);
        if (PEAR::isError($result)) {
            throw new Exception($result->getUserInfo());
        }

        while ($line = $result->fetchRow(MDB2_FETCHMODE_ASSOC)) {
            $drop = $this->db->exec('DROP TABLE ' . $line['tables_in_' . DB_NAME]);
            if (PEAR::IsError($drop)) {
                throw new Exception($drop->getUserInfo());
            }
        }
        return true;
    }

    function createDatabaseSchema()
    {
        $sql_structure = file_get_contents(dirname(__FILE__) . '/database-structure.sql');
        $sql_arr = Intraface_Install::splitSql($sql_structure);

        foreach ($sql_arr as $sql) {
            if (empty($sql)) { continue; }
            $result = $this->db->exec($sql);
            if (PEAR::isError($result)) {
                throw new Exception($result->getUserInfo());
            }
        }

        $sql_structure = file_get_contents(dirname(__FILE__) . '/database-update.sql');
        $sql_arr = Intraface_Install::splitSql($sql_structure);

        foreach ($sql_arr as $sql) {
            if (empty($sql)) { continue; }
            $result = $this->db->exec($sql);
            if (PEAR::isError($result)) {
                throw new Exception($result->getUserInfo());
            }
        }
        return true;
    }

    function emptyDatabase()

    {
        $result = $this->db->query("SHOW TABLES FROM " . DB_NAME);
        if (PEAR::isError($result)) {
            throw new Exception($result->getUserInfo());
        }
        while ($line = $result->fetchRow(MDB2_FETCHMODE_ASSOC)) {
            $truncate = $this->db->exec('TRUNCATE TABLE ' . $line['Tables_in_'.DB_NAME]);
            if (PEAR::IsError($truncate)) {
                throw new Exception($truncate->getUserInfo());
            }
        }
        return true;

    }

    function createStartingValues()
    {
        $sql_values = file_get_contents(dirname(__FILE__) . '/database-values.sql');
        $sql_arr = Intraface_Install::splitSql($sql_values);

        foreach ($sql_arr as $sql) {
            if (empty($sql)) { continue; }
            $result = $this->db->exec($sql);
            if (PEAR::isError($result)) {
                throw new Exception($result->getUserInfo());
            }
        }
        return true;
    }

    function resetServer()
    {
        /*

        if (!$this->dropDatabase()) {
            throw new Exception('could not drop database');
        }
        if (!$this->createDatabaseSchema()) {
            throw new Exception('could not create schema');
        }
        */

        if (!$this->emptyDatabase()) {
            throw new Exception('could not empty database');
        }

        if (!$this->createStartingValues()) {
            throw new Exception('could not create values');
        }

        $this->deleteUploadDirectory(PATH_UPLOAD);

        if (!file_exists(PATH_UPLOAD)) {
            mkdir(PATH_UPLOAD);
        }

        return true;

    }

    function deleteUploadDirectory($f)

    {
        if ( is_dir( $f ) ){
            foreach ( scandir( $f ) as $item ){

                if ( !strcmp( $item, '.' ) || !strcmp( $item, '..' ) )
// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
                    continue;
                $this->deleteUploadDirectory( $f . "/" . $item );
            }
            rmdir( $f );
        } else{
            @unlink( $f );
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
    }

    /**
     * grants access to given modules
     */
    public function grantModuleAccess($modules)
    {
        $this->registerModules();
        $modules = explode(',', $modules);

        require_once 'Intraface/modules/intranetmaintenance/IntranetMaintenance.php';
        // The moduleaccess only goes for intranet_id 1
        $intranet = new IntranetMaintenance(1);
        require_once 'Intraface/modules/intranetmaintenance/UserMaintenance.php';
        $user = new UserMaintenance(1);
        $user->setIntranetAccess(1);

        require_once 'Intraface/modules/intranetmaintenance/ModuleMaintenance.php';
        foreach ($modules as $module_name) {
            $module = ModuleMaintenance::factory($module_name);

            if ($module->get('id') == 0) {
                throw new Exception('Invalid module '.$module_name);
            }
            $intranet->setModuleAccess($module->get('id'));
            $user->setModuleAccess($module->get('id'), 1);
            $sub_accesss = $module->get('sub_access');
            foreach ($sub_accesss as $sub_access) {
                $user->setSubAccess($module->get('id'), $sub_access['id'], 1);
            }
        }

        return true;

    }

    /**
     * login the user
     */
    function loginUser()
    {
        /* session_start(); */ // session_start is in reset_staging_server. Should only be one place.

        $adapter = new Intraface_Auth_User($this->db, session_id(), '[email protected]', 'startup');
        $auth = new Intraface_Auth(session_id());
        $user = $auth->authenticate($adapter);

        return $user;

    }

    /**
     * run helper functions
     */
    public function runHelperFunction($functions)
    {
        $functions = explode(',', $functions);

        // We create kernel so it can be used in the helper functions
        if (session_id() != '') {
            $kernel = new Intraface_Kernel(session_id());
        } else {
            $kernel = new Intraface_Kernel;
        }
        $kernel->user = new Intraface_User(1);
        $kernel->user->setIntranetId(1);
        $kernel->intranet = new Intraface_Intranet(1);
        $kernel->setting = new Intraface_Setting(1, 1);

        // adds the intranet_id to Doctrine!
        Intraface_Doctrine_Intranet::singleton(1);

        foreach ($functions AS $function) {

            $object_method = explode(':', trim($function));
            $object_method[0] = str_replace('/', '', $object_method[0]);
            $object_method[0] = str_replace('\\', '', $object_method[0]);

            require_once dirname(__FILE__) . '/Helper/'.$object_method[0].'.php';
            $object_name = 'Install_Helper_'.$object_method[0];
            $object = new $object_name($kernel, $this->db);
            $object->$object_method[1]();
        }
    }

    /**
     * register modules
     */
    private function registerModules()
    {
        require_once 'Intraface/modules/intranetmaintenance/ModuleMaintenance.php';
        $modulemaintenance = new ModuleMaintenance;
        $modulemaintenance->register();
    }

    /**
     * splits a mysql export into separate
     */
    static function splitSql($sql)
    {
        if (strpos($sql, "\r\n")) {
            $str_sep = "\r\n";
        } else {
            $str_sep = "\n";
        }
        if (substr($sql, 0, 2) == '--') {
            $sql = substr($sql, strpos($sql, $str_sep));
        }
        $sql = preg_replace($str_sep."/--[a-zA-Z0-9\/\:\`,. _-]*/", '', $sql);
        $parts = preg_split("/;( )*".$str_sep.'/', $sql);
        $parts = array_map('trim', $parts);
        return $parts;

    }
}


Intraface_Install B
last analyzed 2017-03-20 12:20 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

intraface / intraface.dk

Intraface_Install B last analyzed 2017-03-20 12:20 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like

Intraface_Install B
last analyzed 2017-03-20 12:20 UTC