Completed
Push — EventLoopContainer ( c9a84d )
by Vasily
04:35
created

IPC::shutdown()   C

Complexity

Conditions 7
Paths 15

Size

Total Lines 31
Code Lines 18

Duplication

Lines 6
Ratio 19.35 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
cc 7
dl 6
loc 31
rs 6.7272
c 2
b 1
f 0
eloc 18
nc 15
nop 1
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 by
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?
40
     * @var boolean
41
     */
42
    public $update = false;
43
44
45
    /**
46
     * If true, we do not register signals automatically at start
47
     * @var boolean
48
     */
49
    protected $delayedSigReg = true;
50
51
    /**
52
     * Instances count
53
     * @var array
54
     */
55
    public $instancesCount = [];
56
57
    /**
58
     * File watcher
59
     * @var FileWatcher
60
     */
61
    public $fileWatcher;
62
63
    /**
64
     * If true, we do not register signals automatically at start
65
     * @var boolean
66
     */
67
    public $reload = false;
68
69
    /** @var */
70
    public $IPCManager;
71
72
    /**
73
     * Runtime of Worker process.
74
     * @return void
75
     */
76
    protected function run()
77
    {
78
        if (Daemon::$process instanceof Master) {
79
            Daemon::$process->unregisterSignals();
0 ignored issues
show
Bug introduced by
The method unregisterSignals() cannot be called from this context as it is declared protected in class PHPDaemon\Thread\Generic.

This check looks for access to methods that are not accessible from the current context.

If you need to make a method accessible to another context you can raise its visibility level in the defining class.

Loading history...
80
        }
81
        EventLoop::init();
82
        Daemon::$process = $this;
83
        if (Daemon::$logpointerAsync) {
84
            Daemon::$logpointerAsync->fd = null;
85
            Daemon::$logpointerAsync = null;
86
        }
87
        class_exists('Timer');
88
89
        if (Daemon::$config->autogc->value > 0) {
90
            gc_enable();
91
        } else {
92
            gc_disable();
93
        }
94
        $this->prepareSystemEnv();
95
        $this->registerEventSignals();
96
        FileSystem::init(); // re-init
97
        FileSystem::initEvent();
98
        Daemon::openLogs();
99
100
        $this->fileWatcher = new FileWatcher();
101
        $this->IPCManager = Daemon::$appResolver->getInstanceByAppName('\PHPDaemon\IPCManager\IPCManager');
102
        if (!$this->IPCManager) {
103
            $this->log('cannot instantiate IPCManager');
104
        }
105
106
        EventLoop::$instance->run();
107
    }
108
109
    /**
110
     * Setup settings on start.
111
     * @return void
112
     */
113
    protected function prepareSystemEnv()
114
    {
115
        proc_nice(Daemon::$config->ipcthreadpriority->value);
116
        register_shutdown_function([$this, 'shutdown']);
117
118
        $this->setTitle(
119
            Daemon::$runName . ': IPC process'
120
            . (Daemon::$config->pidfile->value !== Daemon::$config->defaultpidfile->value
121
                ? ' (' . Daemon::$config->pidfile->value . ')' : '')
122
        );
123
124
        if (isset(Daemon::$config->group->value)) {
125
            $sg = posix_getgrnam(Daemon::$config->group->value);
126
        }
127
128
        if (isset(Daemon::$config->user->value)) {
129
            $su = posix_getpwnam(Daemon::$config->user->value);
130
        }
131
132
        if (Daemon::$config->chroot->value !== '/') {
133 View Code Duplication
            if (posix_getuid() != 0) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
134
                $this->log('You must have the root privileges to change root.');
135
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method prepareSystemEnv() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
136
            } elseif (!chroot(Daemon::$config->chroot->value)) {
137
                Daemon::log('Couldn\'t change root to \'' . Daemon::$config->chroot->value . '\'.');
138
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method prepareSystemEnv() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
139
            }
140
        }
141
142 View Code Duplication
        if (isset(Daemon::$config->group->value)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
143
            if ($sg === false) {
144
                $this->log('Couldn\'t change group to \'' . Daemon::$config->group->value . '\'. You must replace config-variable \'group\' with existing group.');
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 163 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
145
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method prepareSystemEnv() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
146
            } elseif (($sg['gid'] != posix_getgid()) && (!posix_setgid($sg['gid']))) {
0 ignored issues
show
Bug introduced by
The variable $sg does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
147
                $this->log('Couldn\'t change group to \'' . Daemon::$config->group->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 175 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
148
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method prepareSystemEnv() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
149
            }
150
        }
151
152 View Code Duplication
        if (isset(Daemon::$config->user->value)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
153
            if ($su === false) {
154
                $this->log('Couldn\'t change user to \'' . Daemon::$config->user->value . '\', user not found. You must replace config-variable \'user\' with existing username.');
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 179 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
155
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method prepareSystemEnv() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
156
            } elseif (($su['uid'] != posix_getuid()) && (!posix_setuid($su['uid']))) {
0 ignored issues
show
Bug introduced by
The variable $su does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
157
                $this->log('Couldn\'t change user to \'' . Daemon::$config->user->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno));
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 173 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
158
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method prepareSystemEnv() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
159
            }
160
        }
161
162 View Code Duplication
        if (Daemon::$config->cwd->value !== '.') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
163
            if (!@chdir(Daemon::$config->cwd->value)) {
164
                $this->log('Couldn\'t change directory to \'' . Daemon::$config->cwd->value . '.');
165
            }
166
        }
167
    }
168
169
    /**
170
     * Log something
171
     * @param string - Message.
172
     * @param string $message
173
     * @return void
174
     */
175
    public function log($message)
176
    {
177
        Daemon::log('I#' . $this->pid . ' ' . $message);
178
    }
179
180
    /**
181
     * Reloads additional config-files on-the-fly.
182
     * @return void
183
     */
184
    protected function update()
185
    {
186
        FileSystem::updateConfig();
187
        foreach (Daemon::$appInstances as $app) {
188
            foreach ($app as $appInstance) {
189
                $appInstance->handleStatus(AppInstance::EVENT_CONFIG_UPDATED);
190
            }
191
        }
192
    }
193
194
    /**
195
     * Shutdown thread
196
     * @param boolean - Hard? If hard, we shouldn't wait for graceful shutdown of the running applications.
197
     * @return boolean|null - Ready?
198
     */
199
    public function shutdown($hard = false)
200
    {
201
        $error = error_get_last();
202 View Code Duplication
        if ($error) {
0 ignored issues
show
Bug Best Practice introduced by
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 check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
203
            if ($error['type'] === E_ERROR) {
204
                $this->log('crashed by error \'' . $error['message'] . '\' at ' . $error['file'] . ':' . $error['line']);
0 ignored issues
show
Coding Style introduced by
This line exceeds maximum limit of 120 characters; contains 121 characters

Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line.

Loading history...
205
            }
206
        }
207
208
        if (Daemon::$config->throwexceptiononshutdown->value) {
209
            throw new \Exception('event shutdown');
210
        }
211
212
        @ob_flush();
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
213
214
        if ($this->terminated === true) {
215
            if ($hard) {
216
                exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method shutdown() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
217
            }
218
219
            return;
220
        }
221
222
        $this->terminated = true;
223
        if ($hard) {
224
            exit(0);
0 ignored issues
show
Coding Style Compatibility introduced by
The method shutdown() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
225
        }
226
        FileSystem::waitAllEvents(); // ensure that all I/O events completed before suicide
227
        posix_kill(posix_getppid(), SIGCHLD); // praying to Master
228
        exit(0); // R.I.P.
0 ignored issues
show
Coding Style Compatibility introduced by
The method shutdown() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
229
    }
230
231
    /**
232
     * Handler of the SIGINT (hard shutdown) signal in worker process.
233
     * @return void
234
     */
235
    protected function sigint()
236
    {
237
        if (Daemon::$config->logsignals->value) {
238
            $this->log('caught SIGINT.');
239
        }
240
241
        $this->shutdown(true);
242
    }
243
244
    /**
245
     * Handler of the SIGTERM (graceful shutdown) signal in worker process.
246
     * @return void
247
     */
248
    protected function sigterm()
249
    {
250
        if (Daemon::$config->logsignals->value) {
251
            $this->log('caught SIGTERM.');
252
        }
253
254
        $this->shutdown();
255
    }
256
257
    /**
258
     * Handler of the SIGQUIT (graceful shutdown) signal in worker process.
259
     * @return void
260
     */
261
    public function sigquit()
262
    {
263
        if (Daemon::$config->logsignals->value) {
264
            $this->log('caught SIGQUIT.');
265
        }
266
267
        parent::sigquit();
268
    }
269
270
    /**
271
     * Handler of the SIGTSTP (graceful stop) signal in worker process.
272
     * @return void
273
     */
274
    protected function sigtstp()
275
    {
276
        if (Daemon::$config->logsignals->value) {
277
            $this->log('Caught SIGTSTP (graceful stop all workers).');
278
        }
279
280
        $this->shutdown();
281
    }
282
283
    /**
284
     * Handler of the SIGHUP (reload config) signal in worker process.
285
     * @return void
286
     */
287 View Code Duplication
    public function sighup()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
288
    {
289
        if (Daemon::$config->logsignals->value) {
290
            $this->log('caught SIGHUP (reload config).');
291
        }
292
293
        if (isset(Daemon::$config->configfile->value)) {
294
            Daemon::loadConfig(Daemon::$config->configfile->value);
295
        }
296
297
        $this->update = true;
298
    }
299
300
    /**
301
     * Handler of the SIGUSR1 (re-open log-file) signal in worker process.
302
     * @return void
303
     */
304
    public function sigusr1()
305
    {
306
        if (Daemon::$config->logsignals->value) {
307
            $this->log('caught SIGUSR1 (re-open log-file).');
308
        }
309
310
        Daemon::openLogs();
311
    }
312
313
    /**
314
     * Handler of the SIGUSR2 (graceful shutdown for update) signal in worker process.
315
     * @return void
316
     */
317
    public function sigusr2()
318
    {
319
        if (Daemon::$config->logsignals->value) {
320
            $this->log('caught SIGUSR2 (graceful shutdown for update).');
321
        }
322
    }
323
324
    /**
325
     * Handler of the SIGTTIN signal in worker process.
326
     * @return void
327
     */
328
    public function sigttin()
329
    {
330
    }
331
332
    /**
333
     * Handler of the SIGXSFZ signal in worker process.
334
     * @return void
335
     */
336
    public function sigxfsz()
337
    {
338
        $this->log('SIGXFSZ.');
339
    }
340
341
    /**
342
     * Handler of non-known signals.
343
     * @return void
344
     */
345 View Code Duplication
    public function sigunknown($signo)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
346
    {
347
        if (isset(Generic::$signals[$signo])) {
348
            $sig = Generic::$signals[$signo];
349
        } else {
350
            $sig = 'UNKNOWN';
351
        }
352
353
        $this->log('caught signal #' . $signo . ' (' . $sig . ').');
354
    }
355
}
356