Worker::setState() - Code Metrics - Inspection of "Critical fix in MPM" - kakserpom/phpdaemon - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( f51a4d...4d827b )

by Vasily
created 2020-05-27 17:52 UTC
Worker::setState() B

↳ Parent: Worker
Complexity

Conditions	6
Paths	10
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
nc	10
nop	1
dl	0
loc	23
rs	8.9297
c	0
b	0
f	0
<?php
namespace PHPDaemon\Thread;

use PHPDaemon\Cache\CappedStorageHits;
use PHPDaemon\Core\AppInstance;
use PHPDaemon\Core\Daemon;
use PHPDaemon\Core\Debug;
use PHPDaemon\Core\EventLoop;
use PHPDaemon\Core\Timer;
use PHPDaemon\FS\FileSystem;

/**
 * Implementation of the worker thread
 *
 * @package Core
 *
 * @author  Vasily Zorin <[email protected]>
 */
class Worker extends Generic
{

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

    /**
     * Reload?
     * @var boolean
     */
    public $reload = false;

    protected $graceful = false;

    /**
     * Reload delay
     * @var integer
     */
    protected $reloadDelay = 2;

    /**
     * Reloaded?
     * @var boolean
     */
    public $reloaded = false;

    /**
     * Time of last activity
     * @var integer
     */
    public $timeLastActivity = 0;

    /**
     * Last time of auto reload
     * @var integer
     */
    protected $autoReloadLast = 0;

    /**
     * State
     * @var integer
     */
    public $state = 0;

    /**
     * Request counter
     * @var integer
     */
    public $reqCounter = 0;

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

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

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

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

    /**
     * Connection
     * @var Connection
     */
    public $connection;

    /**
     * Counter GC
     * @var integer
     */
    public $counterGC = 0;


    /** @var \PHPDaemon\IPCManager\IPCManager */
    public $IPCManager;

    public $lambdaCache;

    /**
     * Runtime of Worker process.
     * @return void
     */
    protected function run()
    {
        $this->lambdaCache = new CappedStorageHits;
        $this->lambdaCache->setMaxCacheSize(Daemon::$config->lambdacachemaxsize->value);
        $this->lambdaCache->setCapWindow(Daemon::$config->lambdacachecapwindow->value);

        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');
        $this->autoReloadLast = time();
        $this->reloadDelay = Daemon::$config->mpmdelay->value + 2;
        $this->setState(Daemon::WSTATE_PREINIT);

        if (Daemon::$config->autogc->value > 0) {
            gc_enable();
            gc_collect_cycles();
        } else {
            gc_disable();
        }

        if (Daemon::$runworkerMode) {
            if (!Daemon::$config->verbosetty->value) {

                fclose(STDIN);
                fclose(STDOUT);
                fclose(STDERR);
            }

            Daemon::$appResolver->preload(true);
        }

        $this->prepareSystemEnv();
        $this->overrideNativeFuncs();

        $this->setState(Daemon::WSTATE_INIT);
        $this->registerEventSignals();

        FileSystem::init();
        FileSystem::initEvent();
        Daemon::openLogs();

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

        Daemon::$appResolver->preload();

        foreach (Daemon::$appInstances as $app) {
            foreach ($app as $appInstance) {
                if (!$appInstance->ready) {
                    $appInstance->ready = true;
                    $appInstance->onReady();
                }
            }
        }

        $this->setState(Daemon::WSTATE_IDLE);

        Timer::add(function ($event) {

            if (!Daemon::$runworkerMode) {
                if ($this->IPCManager) {
                    $this->IPCManager->ensureConnection();
                }
            }

            $this->breakMainLoopCheck();
            if (Daemon::checkAutoGC()) {
                EventLoop::$instance->interrupt(function () {
                    gc_collect_cycles();
                });
            }

            $event->timeout();
        }, 1e6 * 1, 'breakMainLoopCheck');
        if (Daemon::$config->autoreload->value > 0) {
            Timer::add(function ($event) {
                static $n = 0;
                $list = get_included_files();
                $s = sizeof($list);
                if ($s > $n) {
                    $slice = array_map('realpath', array_slice($list, $n));
                    Daemon::$process->IPCManager->sendPacket(['op' => 'addIncludedFiles', 'files' => $slice]);
                    $n = $s;
                }
                $event->timeout();
            }, 1e6 * Daemon::$config->autoreload->value, 'watchIncludedFiles');
        }
        EventLoop::$instance->run();
        $this->shutdown();
    }

    /**
     * Override a standard PHP function
     * @param string $local e.g. isUploadedFile
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $real e.g. is_uploaded_file
     */
    protected function override($camelCase, $real)
    {
        runkit_function_rename($real, $real . '_native');
        runkit_function_rename('PHPDaemon\\Thread\\' . $camelCase, $real);
    }

    /**
     * Overrides native PHP functions.
     * @return void
     */
    protected function overrideNativeFuncs()
    {
        if (Daemon::supported(Daemon::SUPPORT_RUNKIT_INTERNAL_MODIFY)) {
            function define($k, $v)
            {
                if (defined($k)) {
                    runkit_constant_redefine($k, $v);
                } else {
                    runkit_constant_add($k, $v);
                }
            }

            $this->override('define', 'define');

            function header(...$args)

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->header(...$args);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }

            $this->override('header', 'header');

            function isUploadedFile(...$args)

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->isUploadedFile(...$args);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }

            $this->override('isUploadedFile', 'is_uploaded_file');

            function moveUploadedFile(...$args)

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->moveUploadedFile(...$args);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }

            $this->override('moveUploadedFile', 'move_uploaded_file');

            function headersSent(&$file = null, &$line = null)

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->headers_sent($file, $line);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }

            //$this->override('headersSent', 'headers_sent); // Commented out due to a runkit bug

            function headersList()

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->headers_list();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }

            $this->override('headersList', 'headers_list');

            function setcookie(...$args)

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->setcookie(...$args);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }

            $this->override('setcookie', 'setcookie');

            /**
             * @param callable $cb
             */
            function registerShutdownFunction($cb)

            {
                if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) {
                    return false;
                }
                return Daemon::$context->registerShutdownFunction($cb);
            }

            $this->override('registerShutdownFunction', 'register_shutdown_function');

            runkit_function_copy('create_function', 'create_function_native');
            runkit_function_redefine('create_function', '$arg,$body',
                'return \PHPDaemon\Core\Daemon::$process->createFunction($arg,$body);');
        }
    }

    /**
     * Creates anonymous function (old-fashioned) like create_function()
     * @return void
     */
    public function createFunction($args, $body, $ttl = null)
    {
        $key = $args . "\x00" . $body;
        if (($f = $this->lambdaCache->getValue($key)) !== null) {
            return $f;
        }
        $f = eval('return function(' . $args . '){' . $body . '};');
        if ($ttl === null && Daemon::$config->lambdacachettl->value) {
            $ttl = Daemon::$config->lambdacachettl->value;
        }
        $this->lambdaCache->put($key, $f, $ttl);
        return $f;
    }

    /**
     * Setup settings on start.
     * @return void
     */
    protected function prepareSystemEnv()
    {
        proc_nice(Daemon::$config->workerpriority->value);

        register_shutdown_function(function () {
            $this->shutdown(true);
        });

        $this->setTitle(
            Daemon::$runName . ': worker 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);
        }

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

                Daemon::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);
            }
            $flushCache = true;
        }

        if (isset(Daemon::$config->group->value)) {
            if ($sg === false) {
                Daemon::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;
}
                Daemon::log('Couldn\'t change group to \'' . Daemon::$config->group->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));
                exit(0);
            }
            $flushCache = true;
        }

        if (isset(Daemon::$config->user->value)) {
            if ($su === false) {
                Daemon::log('Couldn\'t change user to \'' . Daemon::$config->user->value . '\', user not found. You must replace config-variable \'user\' with existing username.');
                exit(0);
            } else {
                posix_initgroups($su['name'], $su['gid']);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
                if ($su['uid'] != posix_getuid() && !posix_setuid($su['uid'])) {
                    Daemon::log('Couldn\'t change user to \'' . Daemon::$config->user->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));
                    exit(0);
                }
            }
            $flushCache = true;
        }
        if ($flushCache) {
            clearstatcache(true);
        }
        if (Daemon::$config->cwd->value !== '.') {
            if (!@chdir(Daemon::$config->cwd->value)) {

                Daemon::log('Couldn\'t change directory to \'' . Daemon::$config->cwd->value . '.');
            }
            clearstatcache(true);
        }
    }

    /**
     * Log something
     * @param string - Message.
     * @param string $message
     * @return void
     */
    public function log($message)
    {
        Daemon::log('W#' . $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);
            }
        }
    }

    /**
     * Check if we should break main loop
     * @return void
     */
    protected function breakMainLoopCheck()
    {
        $time = microtime(true);

        if ($this->terminated || $this->breakMainLoop) {
            EventLoop::$instance->stop();
            return;
        }

        if ($this->shutdown) {
            EventLoop::$instance->stop();
            return;
        }

        if ($this->reload) {
            return;
        }

        if (Daemon::$config->maxmemoryusage->value > 0
            && (memory_get_usage(true) > Daemon::$config->maxmemoryusage->value)
        ) {
            $this->log('\'maxmemory\' exceed. Graceful shutdown.');

            $this->gracefulRestart();
        }

        if (Daemon::$config->maxrequests->value > 0
            && ($this->reqCounter >= Daemon::$config->maxrequests->value)
        ) {
            $this->log('\'max-requests\' exceed. Graceful shutdown.');

            $this->gracefulRestart();
        }

        if (Daemon::$config->maxidle->value
            && $this->timeLastActivity && ($time - $this->timeLastActivity > Daemon::$config->maxidle->value)
        ) {
            $this->log('\'maxworkeridle\' exceed. Graceful shutdown.');

            $this->gracefulRestart();
        }

        if ($this->update === true) {
            $this->update = false;
            $this->update();
        }
    }

    /**
     * Graceful restart
     * @return void
     */
    public function gracefulRestart()

    {
        $this->graceful = true;
        $this->reload = true;
        Timer::add(function () {
            EventLoop::$instance->stop();
        }, $this->reloadDelay * 1e6);
        $this->setState($this->state);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Graceful stop
     * @return void
     */
    public function gracefulStop()

    {
        $this->graceful = true;
        Timer::add(function () {
            EventLoop::$instance->stop();
        }, $this->reloadDelay * 1e6);
        $this->setState($this->state);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Asks the running applications the whether we can go to shutdown current (old) worker.
     * @return boolean - Ready?
     */
    protected function appInstancesReloadReady()
    {
        $ready = true;

        foreach (Daemon::$appInstances as $k => $app) {
            foreach ($app as $name => $appInstance) {
                if (!$appInstance->handleStatus($this->graceful ? AppInstance::EVENT_GRACEFUL_SHUTDOWN : AppInstance::EVENT_SHUTDOWN)) {
                    $this->log(__METHOD__ . ': waiting for ' . $k . ':' . $name);
                    $ready = false;
                }
            }
        }
        return $ready;
    }

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

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

        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) {
            $this->setState(Daemon::WSTATE_SHUTDOWN);
            exit(0);
        }

        $this->reloadReady = $this->appInstancesReloadReady();
        Timer::remove('breakMainLoopCheck');

        Timer::add(function ($event) {
            $self = Daemon::$process;

            $self->reloadReady = $self->appInstancesReloadReady();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

            if ($self->reload === true) {
                $self->reloadReady = $self->reloadReady && (microtime(true) > $self->reloadTime);
            }
            if (!$self->reloadReady) {
                $event->timeout();
            } else {
                EventLoop::$instance->stop();
            }
        }, 1e6, 'checkReloadReady');
        while (!$this->reloadReady) {
            EventLoop::$instance->run();
        }
        FileSystem::waitAllEvents(); // ensure that all I/O events completed before suicide
        posix_kill(getmypid(), SIGKILL);
        exit(0); // R.I.P.
    }

    /**
     * Set current status of worker
     * @param int Constant
     * @return boolean Success.
     */
    public function setState($int)
    {
        if (Daemon::$compatMode) {
            return true;
        }
        if (!$this->id) {
            return false;
        }

        if (Daemon::$config->logworkersetstate->value) {
            $this->log('state is ' . Daemon::$wstateRev[$int]);
        }

        $this->state = $int;


        if ($this->reload) {
            $int += 100;
        }
        if (Daemon::$shm_wstate !== null) {
            Daemon::$shm_wstate->write(chr($int), $this->id - 1);
        }
        return true;
    }

    /**
     * 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->graceful = false;
        EventLoop::$instance->stop();
    }

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

        parent::sigquit();
    }

    /**
     * Handler of the SIGHUP (reload config) signal in worker process.
     * @return void
     */
    protected 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
     */
    protected 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
     */
    protected function sigusr2()
    {
        if (Daemon::$config->logsignals->value) {
            $this->log('caught SIGUSR2 (graceful shutdown for update).');
        }

        $this->gracefulRestart();
    }

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

        $this->gracefulStop();
    }

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

    /**
     * Handler of the SIGPIPE signal in worker process.
     * @return void
     */
    protected function sigpipe()
    {
    }

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

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

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

    /**
     * Called (in master) when process is terminated
     * @return void
     */
    public function onTerminated()
    {
        $this->setState(Daemon::WSTATE_SHUTDOWN);
    }

    /**
     * Destructor of worker thread.
     * @return void
     */
    public function __destruct()
    {
        if (posix_getpid() === $this->pid) {
            $this->setState(Daemon::WSTATE_SHUTDOWN);
        }
    }
}

Push — master ( f51a4d...4d827b )

Worker::setState() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			namespace PHPDaemon\Thread;
3
4			use PHPDaemon\Cache\CappedStorageHits;
5			use PHPDaemon\Core\AppInstance;
6			use PHPDaemon\Core\Daemon;
7			use PHPDaemon\Core\Debug;
8			use PHPDaemon\Core\EventLoop;
9			use PHPDaemon\Core\Timer;
10			use PHPDaemon\FS\FileSystem;
11
12			/**
13			* Implementation of the worker thread
14			*
15			* @package Core
16			*
17			* @author Vasily Zorin <[email protected]>
18			*/
19			class Worker extends Generic
20			{
21
22			/**
23			* Update?
24			* @var boolean
25			*/
26			public $update = false;
27
28			/**
29			* Reload?
30			* @var boolean
31			*/
32			public $reload = false;
33
34			protected $graceful = false;
35
36			/**
37			* Reload delay
38			* @var integer
39			*/
40			protected $reloadDelay = 2;
kakserpom / phpdaemon

Push — master ( f51a4d...4d827b )

Worker::setState() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
