PHPDaemon\Thread\IPC

Complexity

Total Complexity

54

Size/Duplication

Total Lines	341
Duplicated Lines	19.35 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	4
Bugs	1	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
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
B	run()	0	32	5
C	prepareSystemEnv()	39	55	17

<?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 <maintainer@daemon.io>
 */
// @TODO: respawning IPCThread on unexpected failures

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

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();

The method unregisterSignals() cannot be called from this context as it is declared protected in class PHPDaemon\Thread\Generic.

        }
        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');
        }

        EventLoop::$instance->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 code seems to be duplicated across your project.

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

The method prepareSystemEnv() contains an exit expression.

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

The method prepareSystemEnv() contains an exit expression.

            }
        }

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

This code seems to be duplicated across your project.

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

This line exceeds maximum limit of 120 characters; contains 163 characters

                exit(0);

The method prepareSystemEnv() contains an exit expression.

            } elseif (($sg['gid'] != posix_getgid()) && (!posix_setgid($sg['gid']))) {

The variable $sg does not seem to be defined for all execution paths leading up to this point.

                $this->log('Couldn\'t change group to \'' . Daemon::$config->group->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));

This line exceeds maximum limit of 120 characters; contains 175 characters

                exit(0);

The method prepareSystemEnv() contains an exit expression.

            }
        }

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

This code seems to be duplicated across your project.

            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.');

This line exceeds maximum limit of 120 characters; contains 179 characters

                exit(0);

The method prepareSystemEnv() contains an exit expression.

            } elseif (($su['uid'] != posix_getuid()) && (!posix_setuid($su['uid']))) {

The variable $su does not seem to be defined for all execution paths leading up to this point.

                $this->log('Couldn\'t change user to \'' . Daemon::$config->user->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));

This line exceeds maximum limit of 120 characters; contains 173 characters

                exit(0);

The method prepareSystemEnv() contains an exit expression.

            }
        }

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

This code seems to be duplicated across your project.

            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) {

The expression $error of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This code seems to be duplicated across your project.

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

This line exceeds maximum limit of 120 characters; contains 121 characters

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

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

        @ob_flush();

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

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

The method shutdown() contains an exit expression.

            }

            return;
        }

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

The method shutdown() contains an exit expression.

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

The method shutdown() contains an exit expression.

    }

    /**
     * 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()

This method seems to be duplicated in your project.

    {
        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)

This method seems to be duplicated in your project.

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

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