IPC - Code Metrics - Inspection of "EventLoop" - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — class-eventloop ( 51113e...323d1b )

by Vasily

created 2016-05-18 00:34 UTC

IPC B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	341
Duplicated Lines	19.35 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	66
loc	341
rs	7.0642
wmc	54
lcom	1
cbo	8

15 Methods

Rating	Name	Duplication	Size	Complexity
B	run()	0	32	5
C	prepareSystemEnv()	39	55	17
A	log()	0	4	1
A	update()	0	9	3
D	shutdown()	6	34	9
A	sigint()	0	8	2
A	sigterm()	0	8	2
A	sigquit()	0	8	2
A	sigtstp()	0	8	2
A	sighup()	11	12	3
A	sigusr1()	0	8	2
A	sigusr2()	0	6	2
A	sigttin()	0	3	1
A	sigxfsz()	0	4	1
A	sigunknown()	10	10	2

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 IPC 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 IPC, and based on these observations, apply Extract Interface, too.

<?php
namespace PHPDaemon\Thread;

use PHPDaemon\Core\AppInstance;
use PHPDaemon\Core\Daemon;
use PHPDaemon\Core\EventLoop;
use PHPDaemon\FS\FileSystem;
use PHPDaemon\FS\FileWatcher;

/**
 * Implementation of the IPC thread
 *
 * @package Core
 *
 * @author  Vasily Zorin <[email protected]>
 */
// @TODO: respawning IPCThread on unexpected failures

class IPC extends Generic
{
    /**
     * Event base
     * @var EventLoop
     */
    public $loop;

    /**
     * Break main loop?
     * @var boolean
     */
    protected $breakMainLoop = false;

    /**
     * Reload ready?
     * @var boolean
     */
    protected $reloadReady = false;

    /**
     * Update?
     * @var boolean
     */
    public $update = false;


    /**
     * If true, we do not register signals automatically at start
     * @var boolean
     */
    protected $delayedSigReg = true;

    /**
     * Instances count
     * @var array
     */
    public $instancesCount = [];

    /**
     * File watcher
     * @var FileWatcher
     */
    public $fileWatcher;

    /**
     * If true, we do not register signals automatically at start
     * @var boolean
     */
    public $reload = false;

    /** @var */
    public $IPCManager;

    /**
     * Runtime of Worker process.
     * @return void
     */
    protected function run()
    {
        if (Daemon::$process instanceof Master) {
            Daemon::$process->unregisterSignals();

        }
        EventLoop::init();
        Daemon::$process = $this;
        if (Daemon::$logpointerAsync) {
            Daemon::$logpointerAsync->fd = null;
            Daemon::$logpointerAsync     = null;
        }
        class_exists('Timer');

        if (Daemon::$config->autogc->value > 0) {
            gc_enable();
        } else {
            gc_disable();
        }
        $this->prepareSystemEnv();
        $this->registerEventSignals();
        FileSystem::init(); // re-init
        FileSystem::initEvent();
        Daemon::openLogs();

        $this->fileWatcher = new FileWatcher();
        $this->IPCManager  = Daemon::$appResolver->getInstanceByAppName('\PHPDaemon\IPCManager\IPCManager');
        if (!$this->IPCManager) {
            $this->log('cannot instantiate IPCManager');
        }

        $this->loop->run();
    }

    /**
     * Setup settings on start.
     * @return void
     */
    protected function prepareSystemEnv()
    {
        proc_nice(Daemon::$config->ipcthreadpriority->value);
        register_shutdown_function([$this, 'shutdown']);

        $this->setTitle(
            Daemon::$runName . ': IPC process'
            . (Daemon::$config->pidfile->value !== Daemon::$config->defaultpidfile->value
                    ? ' (' . Daemon::$config->pidfile->value . ')' : '')
        );

        if (isset(Daemon::$config->group->value)) {
            $sg = posix_getgrnam(Daemon::$config->group->value);
        }

        if (isset(Daemon::$config->user->value)) {
            $su = posix_getpwnam(Daemon::$config->user->value);
        }

        if (Daemon::$config->chroot->value !== '/') {
            if (posix_getuid() != 0) {

                $this->log('You must have the root privileges to change root.');
                exit(0);

            } elseif (!chroot(Daemon::$config->chroot->value)) {
                Daemon::log('Couldn\'t change root to \'' . Daemon::$config->chroot->value . '\'.');
                exit(0);

            }
        }

        if (isset(Daemon::$config->group->value)) {

            if ($sg === false) {
                $this->log('Couldn\'t change group to \'' . Daemon::$config->group->value . '\'. You must replace config-variable \'group\' with existing group.');

                exit(0);

            } elseif (($sg['gid'] != posix_getgid())  && (!posix_setgid($sg['gid']))) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                $this->log('Couldn\'t change group to \'' . Daemon::$config->group->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));

                exit(0);

            }
        }

        if (isset(Daemon::$config->user->value)) {

            if ($su === false) {
                $this->log('Couldn\'t change user to \'' . Daemon::$config->user->value . '\', user not found. You must replace config-variable \'user\' with existing username.');

                exit(0);

            } elseif (($su['uid'] != posix_getuid()) && (!posix_setuid($su['uid']))) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                $this->log('Couldn\'t change user to \'' . Daemon::$config->user->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));

                exit(0);

            }
        }

        if (Daemon::$config->cwd->value !== '.') {

            if (!@chdir(Daemon::$config->cwd->value)) {
                $this->log('Couldn\'t change directory to \'' . Daemon::$config->cwd->value . '.');
            }
        }
    }

    /**
     * Log something
     * @param string - Message.
     * @param string $message
     * @return void
     */
    public function log($message)
    {
        Daemon::log('I#' . $this->pid . ' ' . $message);
    }

    /**
     * Reloads additional config-files on-the-fly.
     * @return void
     */
    protected function update()
    {
        FileSystem::updateConfig();
        foreach (Daemon::$appInstances as $app) {
            foreach ($app as $appInstance) {
                $appInstance->handleStatus(AppInstance::EVENT_CONFIG_UPDATED);
            }
        }
    }

    /**
     * Shutdown thread
     * @param boolean - Hard? If hard, we shouldn't wait for graceful shutdown of the running applications.
     * @return boolean|null - Ready?
     */
    public function shutdown($hard = false)
    {
        $error = error_get_last();
        if ($error) {

            if ($error['type'] === E_ERROR) {
                $this->log('crashed by error \'' . $error['message'] . '\' at ' . $error['file'] . ':' . $error['line']);

            }
        }
        if (Daemon::$config->logevents->value) {
            $this->log('event shutdown(' . ($hard ? 'HARD' : '') . ') invoked.');
        }

        if (Daemon::$config->throwexceptiononshutdown->value) {
            throw new \Exception('event shutdown');
        }

        @ob_flush();
// For example instead of
@mkdir($dir);

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

        if ($this->terminated === true) {
            if ($hard) {
                exit(0);

            }

            return;
        }

        $this->terminated = true;
        if ($hard) {
            exit(0);

        }
        FileSystem::waitAllEvents(); // ensure that all I/O events completed before suicide
        posix_kill(posix_getppid(), SIGCHLD); // praying to Master
        exit(0); // R.I.P.

    }

    /**
     * Handler of the SIGINT (hard shutdown) signal in worker process.
     * @return void
     */
    protected function sigint()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGINT.');
        }

        $this->shutdown(true);
    }

    /**
     * Handler of the SIGTERM (graceful shutdown) signal in worker process.
     * @return void
     */
    protected function sigterm()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGTERM.');
        }

        $this->shutdown();
    }

    /**
     * Handler of the SIGQUIT (graceful shutdown) signal in worker process.
     * @return void
     */
    public function sigquit()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGQUIT.');
        }

        parent::sigquit();
    }

    /**
     * Handler of the SIGTSTP (graceful stop) signal in worker process.
     * @return void
     */
    protected function sigtstp()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('Caught SIGTSTP (graceful stop all workers).');
        }

        $this->shutdown();
    }

    /**
     * Handler of the SIGHUP (reload config) signal in worker process.
     * @return void
     */
    public function sighup()

    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGHUP (reload config).');
        }

        if (isset(Daemon::$config->configfile->value)) {
            Daemon::loadConfig(Daemon::$config->configfile->value);
        }

        $this->update = true;
    }

    /**
     * Handler of the SIGUSR1 (re-open log-file) signal in worker process.
     * @return void
     */
    public function sigusr1()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGUSR1 (re-open log-file).');
        }

        Daemon::openLogs();
    }

    /**
     * Handler of the SIGUSR2 (graceful shutdown for update) signal in worker process.
     * @return void
     */
    public function sigusr2()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGUSR2 (graceful shutdown for update).');
        }
    }

    /**
     * Handler of the SIGTTIN signal in worker process.
     * @return void
     */
    public function sigttin()
    {
    }

    /**
     * Handler of the SIGXSFZ signal in worker process.
     * @return void
     */
    public function sigxfsz()
    {
        $this->log('SIGXFSZ.');
    }

    /**
     * Handler of non-known signals.
     * @return void
     */
    public function sigunknown($signo)

    {
        if (isset(Generic::$signals[$signo])) {
            $sig = Generic::$signals[$signo];
        } else {
            $sig = 'UNKNOWN';
        }

        $this->log('caught signal #' . $signo . ' (' . $sig . ').');
    }
}


Push — class-eventloop ( 51113e...323d1b )

IPC B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

1			<?php
2			namespace PHPDaemon\Thread;
3
4			use PHPDaemon\Core\AppInstance;
5			use PHPDaemon\Core\Daemon;
6			use PHPDaemon\Core\EventLoop;
7			use PHPDaemon\FS\FileSystem;
8			use PHPDaemon\FS\FileWatcher;
9
10			/**
11			* Implementation of the IPC thread
12			*
13			* @package Core
14			*
15			* @author Vasily Zorin <[email protected]>
16			*/
17			// @TODO: respawning IPCThread on unexpected failures
			0 ignored issues – show Coding Style Best Practice introduced 2015-12-06 14:42 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
18			class IPC extends Generic
19			{
20			/**
21			* Event base
22			* @var EventLoop
23			*/
24			public $loop;
25
26			/**
27			* Break main loop?
28			* @var boolean
29			*/
30			protected $breakMainLoop = false;
31
32			/**
33			* Reload ready?
34			* @var boolean
35			*/
36			protected $reloadReady = false;
37
38			/**
39			* Update?

kakserpom / phpdaemon

Push — class-eventloop ( 51113e...323d1b )

IPC B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like