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:
Complex classes like Worker 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 Worker, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
19 | class Worker extends Generic { |
||
20 | |||
21 | /** |
||
22 | * Update? |
||
23 | * @var boolean |
||
24 | */ |
||
25 | public $update = false; |
||
26 | |||
27 | /** |
||
28 | * Reload? |
||
29 | * @var boolean |
||
30 | */ |
||
31 | public $reload = false; |
||
32 | |||
33 | protected $graceful = false; |
||
34 | |||
35 | /** |
||
36 | * Reload time |
||
37 | * @var integer |
||
38 | */ |
||
39 | protected $reloadTime = 0; |
||
40 | |||
41 | /** |
||
42 | * Reload delay |
||
43 | * @var integer |
||
44 | */ |
||
45 | protected $reloadDelay = 2; |
||
46 | |||
47 | /** |
||
48 | * Reloaded? |
||
49 | * @var boolean |
||
50 | */ |
||
51 | public $reloaded = false; |
||
52 | |||
53 | /** |
||
54 | * Time of last activity |
||
55 | * @var integer |
||
56 | */ |
||
57 | public $timeLastActivity = 0; |
||
58 | |||
59 | /** |
||
60 | * Last time of auto reload |
||
61 | * @var integer |
||
62 | */ |
||
63 | protected $autoReloadLast = 0; |
||
64 | |||
65 | /** |
||
66 | * Event base |
||
67 | * @var EventBase |
||
68 | */ |
||
69 | public $eventBase; |
||
70 | |||
71 | /** |
||
72 | * DNS base |
||
73 | * @var EventDnsBase |
||
74 | */ |
||
75 | public $dnsBase; |
||
76 | |||
77 | /** |
||
78 | * State |
||
79 | * @var integer |
||
80 | */ |
||
81 | public $state = 0; |
||
82 | |||
83 | /** |
||
84 | * Request counter |
||
85 | * @var integer |
||
86 | */ |
||
87 | public $reqCounter = 0; |
||
88 | |||
89 | /** |
||
90 | * Break main loop? |
||
91 | * @var boolean |
||
92 | */ |
||
93 | public $breakMainLoop = false; |
||
94 | |||
95 | /** |
||
96 | * Reload ready? |
||
97 | * @var boolean |
||
98 | */ |
||
99 | public $reloadReady = false; |
||
100 | |||
101 | /** |
||
102 | * If true, we do not register signals automatically at start |
||
103 | * @var boolean |
||
104 | */ |
||
105 | protected $delayedSigReg = false; |
||
106 | |||
107 | /** |
||
108 | * Instances count |
||
109 | * @var array |
||
110 | */ |
||
111 | public $instancesCount = []; |
||
112 | |||
113 | /** |
||
114 | * Connection |
||
115 | * @var Connection |
||
116 | */ |
||
117 | public $connection; |
||
118 | |||
119 | /** |
||
120 | * Counter GC |
||
121 | * @var integer |
||
122 | */ |
||
123 | public $counterGC = 0; |
||
124 | |||
125 | /** |
||
126 | * Stack of callbacks to execute |
||
127 | * @var \PHPDaemon\Structures\StackCallbacks |
||
128 | */ |
||
129 | public $callbacks; |
||
130 | |||
131 | /** @var \PHPDaemon\IPCManager\IPCManager */ |
||
132 | public $IPCManager; |
||
133 | |||
134 | public $lambdaCache; |
||
135 | |||
136 | /** |
||
137 | * Runtime of Worker process. |
||
138 | * @return void |
||
139 | */ |
||
140 | protected function run() { |
||
259 | |||
260 | /** |
||
261 | * @param string $f |
||
262 | */ |
||
263 | protected function override($f) { |
||
267 | |||
268 | /** |
||
269 | * Overrides native PHP functions. |
||
270 | * @return void |
||
271 | */ |
||
272 | protected function overrideNativeFuncs() { |
||
273 | if (Daemon::supported(Daemon::SUPPORT_RUNKIT_INTERNAL_MODIFY)) { |
||
274 | |||
275 | function define($k, $v) { |
||
276 | if (defined($k)) { |
||
277 | runkit_constant_redefine($k, $v); |
||
278 | } else { |
||
279 | runkit_constant_add($k, $v); |
||
280 | } |
||
281 | } |
||
282 | $this->override('define'); |
||
283 | |||
284 | function header() { |
||
285 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
286 | return false; |
||
287 | } |
||
288 | return Daemon::$context->header(...func_get_args()); |
||
289 | } |
||
290 | $this->override('header'); |
||
291 | |||
292 | function is_uploaded_file() { |
||
293 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
294 | return false; |
||
295 | } |
||
296 | return Daemon::$context->isUploadedFile(...func_get_args()); |
||
297 | } |
||
298 | $this->override('is_uploaded_file'); |
||
299 | |||
300 | function move_uploaded_file() { |
||
301 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
302 | return false; |
||
303 | } |
||
304 | return Daemon::$context->moveUploadedFile(...func_get_args()); |
||
305 | } |
||
306 | $this->override('move_uploaded_file'); |
||
307 | |||
308 | function headers_sent(&$file = null, &$line = null) { |
||
309 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
310 | return false; |
||
311 | } |
||
312 | return Daemon::$context->headers_sent($file, $line); |
||
313 | } |
||
314 | |||
315 | //$this->override('headers_sent'); |
||
316 | |||
317 | function headers_list() { |
||
318 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
319 | return false; |
||
320 | } |
||
321 | return Daemon::$context->headers_list(); |
||
322 | } |
||
323 | $this->override('headers_list'); |
||
324 | |||
325 | function setcookie() { |
||
326 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
327 | return false; |
||
328 | } |
||
329 | return Daemon::$context->setcookie(...func_get_args()); |
||
330 | } |
||
331 | $this->override('setcookie'); |
||
332 | |||
333 | /** |
||
334 | * @param callable $cb |
||
335 | */ |
||
336 | function register_shutdown_function($cb) { |
||
337 | if (!Daemon::$context instanceof \PHPDaemon\Request\Generic) { |
||
338 | return false; |
||
339 | } |
||
340 | return Daemon::$context->registerShutdownFunction($cb); |
||
341 | } |
||
342 | $this->override('register_shutdown_function'); |
||
343 | |||
344 | runkit_function_copy('create_function', 'create_function_native'); |
||
345 | runkit_function_redefine('create_function', '$arg,$body', 'return \PHPDaemon\Core\Daemon::$process->createFunction($arg,$body);'); |
||
346 | } |
||
347 | } |
||
348 | |||
349 | /** |
||
350 | * Creates anonymous function (old-fashioned) like create_function() |
||
351 | * @return void |
||
352 | */ |
||
353 | public function createFunction($args, $body, $ttl = null) { |
||
365 | |||
366 | /** |
||
367 | * Setup settings on start. |
||
368 | * @return void |
||
369 | */ |
||
370 | protected function prepareSystemEnv() { |
||
371 | proc_nice(Daemon::$config->workerpriority->value); |
||
372 | |||
373 | register_shutdown_function(function () { |
||
374 | $this->shutdown(true); |
||
375 | }); |
||
376 | |||
377 | $this->setTitle( |
||
378 | Daemon::$runName . ': worker process' |
||
379 | . (Daemon::$config->pidfile->value !== Daemon::$config->defaultpidfile->value |
||
380 | ? ' (' . Daemon::$config->pidfile->value . ')' : '') |
||
381 | ); |
||
382 | |||
383 | if (isset(Daemon::$config->group->value)) { |
||
384 | $sg = posix_getgrnam(Daemon::$config->group->value); |
||
385 | } |
||
386 | |||
387 | if (isset(Daemon::$config->user->value)) { |
||
388 | $su = posix_getpwnam(Daemon::$config->user->value); |
||
389 | } |
||
390 | |||
391 | $flushCache = false; |
||
392 | if (Daemon::$config->chroot->value !== '/') { |
||
393 | View Code Duplication | if (posix_getuid() != 0) { |
|
394 | Daemon::log('You must have the root privileges to change root.'); |
||
395 | exit(0); |
||
396 | } |
||
397 | elseif (!chroot(Daemon::$config->chroot->value)) { |
||
398 | Daemon::log('Couldn\'t change root to \'' . Daemon::$config->chroot->value . '\'.'); |
||
399 | exit(0); |
||
400 | } |
||
401 | $flushCache = true; |
||
402 | } |
||
403 | |||
404 | View Code Duplication | if (isset(Daemon::$config->group->value)) { |
|
405 | if ($sg === FALSE) { |
||
406 | Daemon::log('Couldn\'t change group to \'' . Daemon::$config->group->value . '\'. You must replace config-variable \'group\' with existing group.'); |
||
407 | exit(0); |
||
408 | } |
||
409 | elseif ( |
||
410 | ($sg['gid'] != posix_getgid()) |
||
411 | && (!posix_setgid($sg['gid'])) |
||
412 | ) { |
||
413 | Daemon::log('Couldn\'t change group to \'' . Daemon::$config->group->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno)); |
||
414 | exit(0); |
||
415 | } |
||
416 | $flushCache = true; |
||
417 | } |
||
418 | |||
419 | View Code Duplication | if (isset(Daemon::$config->user->value)) { |
|
420 | if ($su === FALSE) { |
||
421 | Daemon::log('Couldn\'t change user to \'' . Daemon::$config->user->value . '\', user not found. You must replace config-variable \'user\' with existing username.'); |
||
422 | exit(0); |
||
423 | } |
||
424 | elseif ( |
||
425 | ($su['uid'] != posix_getuid()) |
||
426 | && (!posix_setuid($su['uid'])) |
||
427 | ) { |
||
428 | Daemon::log('Couldn\'t change user to \'' . Daemon::$config->user->value . "'. Error (" . ($errno = posix_get_last_error()) . '): ' . posix_strerror($errno)); |
||
429 | exit(0); |
||
430 | } |
||
431 | $flushCache = true; |
||
432 | } |
||
433 | if ($flushCache) { |
||
434 | clearstatcache(true); |
||
435 | } |
||
436 | if (Daemon::$config->cwd->value !== '.') { |
||
437 | View Code Duplication | if (!@chdir(Daemon::$config->cwd->value)) { |
|
438 | Daemon::log('Couldn\'t change directory to \'' . Daemon::$config->cwd->value . '.'); |
||
439 | } |
||
440 | clearstatcache(true); |
||
441 | } |
||
442 | } |
||
443 | |||
444 | /** |
||
445 | * Log something |
||
446 | * @param string - Message. |
||
447 | * @param string $message |
||
448 | * @return void |
||
449 | */ |
||
450 | public function log($message) { |
||
453 | |||
454 | /** |
||
455 | * Reloads additional config-files on-the-fly. |
||
456 | * @return void |
||
457 | */ |
||
458 | protected function update() { |
||
459 | FileSystem::updateConfig(); |
||
460 | foreach (Daemon::$appInstances as $app) { |
||
461 | foreach ($app as $appInstance) { |
||
462 | $appInstance->handleStatus(AppInstance::EVENT_CONFIG_UPDATED); |
||
463 | } |
||
464 | } |
||
465 | } |
||
466 | |||
467 | /** |
||
468 | * Check if we should break main loop |
||
469 | * @return void |
||
470 | */ |
||
471 | protected function breakMainLoopCheck() { |
||
472 | $time = microtime(true); |
||
473 | |||
474 | if ($this->terminated || $this->breakMainLoop) { |
||
475 | return; |
||
476 | } |
||
477 | |||
478 | if ($this->shutdown) { |
||
479 | $this->breakMainLoop = true; |
||
480 | return; |
||
481 | } |
||
482 | |||
483 | if ($this->reload) { |
||
484 | if ($time > $this->reloadTime) { |
||
485 | $this->breakMainLoop = true; |
||
486 | } |
||
487 | return; |
||
488 | } |
||
489 | |||
490 | if ( |
||
491 | (Daemon::$config->maxmemoryusage->value > 0) |
||
492 | && (memory_get_usage(true) > Daemon::$config->maxmemoryusage->value) |
||
493 | ) { |
||
494 | $this->log('\'maxmemory\' exceed. Graceful shutdown.'); |
||
495 | |||
496 | $this->gracefulRestart(); |
||
497 | } |
||
498 | |||
499 | if ( |
||
500 | (Daemon::$config->maxrequests->value > 0) |
||
501 | && ($this->reqCounter >= Daemon::$config->maxrequests->value) |
||
502 | ) { |
||
503 | $this->log('\'max-requests\' exceed. Graceful shutdown.'); |
||
504 | |||
505 | $this->gracefulRestart(); |
||
506 | } |
||
507 | |||
508 | if ( |
||
509 | Daemon::$config->maxidle->value |
||
510 | && $this->timeLastActivity |
||
511 | && ($time - $this->timeLastActivity > Daemon::$config->maxidle->value) |
||
512 | ) { |
||
513 | $this->log('\'maxworkeridle\' exceed. Graceful shutdown.'); |
||
514 | |||
515 | $this->gracefulRestart(); |
||
516 | } |
||
517 | |||
518 | if ($this->update === true) { |
||
519 | $this->update = false; |
||
520 | $this->update(); |
||
521 | } |
||
522 | } |
||
523 | |||
524 | /** |
||
525 | * Graceful restart |
||
526 | * @return void |
||
527 | */ |
||
528 | View Code Duplication | public function gracefulRestart() { |
|
529 | $this->reload = true; |
||
530 | $this->graceful = true; |
||
531 | $this->reloadTime = microtime(true) + $this->reloadDelay; |
||
532 | $this->setState($this->state); |
||
533 | } |
||
534 | |||
535 | /** |
||
536 | * Graceful stop |
||
537 | * @return void |
||
538 | */ |
||
539 | View Code Duplication | public function gracefulStop() { |
|
540 | $this->breakMainLoop = true; |
||
541 | $this->graceful = true; |
||
542 | $this->reloadTime = microtime(true) + $this->reloadDelay; |
||
543 | $this->setState($this->state); |
||
544 | } |
||
545 | |||
546 | /** |
||
547 | * Asks the running applications the whether we can go to shutdown current (old) worker. |
||
548 | * @return boolean - Ready? |
||
549 | */ |
||
550 | protected function appInstancesReloadReady() { |
||
551 | $ready = true; |
||
552 | |||
553 | foreach (Daemon::$appInstances as $k => $app) { |
||
554 | foreach ($app as $name => $appInstance) { |
||
555 | if (!$appInstance->handleStatus($this->graceful ? AppInstance::EVENT_GRACEFUL_SHUTDOWN : AppInstance::EVENT_SHUTDOWN)) { |
||
556 | $this->log(__METHOD__ . ': waiting for ' . $k . ':' . $name); |
||
557 | $ready = false; |
||
558 | } |
||
559 | } |
||
560 | } |
||
561 | return $ready; |
||
562 | } |
||
563 | |||
564 | /** |
||
565 | * Shutdown this worker |
||
566 | * @param boolean Hard? If hard, we shouldn't wait for graceful shutdown of the running applications. |
||
567 | * @return boolean|null Ready? |
||
568 | */ |
||
569 | protected function shutdown($hard = false) { |
||
570 | $error = error_get_last(); |
||
571 | View Code Duplication | if ($error) { |
|
572 | if ($error['type'] === E_ERROR) { |
||
573 | Daemon::log('W#' . $this->pid . ' crashed by error \'' . $error['message'] . '\' at ' . $error['file'] . ':' . $error['line']); |
||
574 | } |
||
575 | |||
576 | } |
||
577 | if (Daemon::$config->logevents->value) { |
||
578 | $this->log('event shutdown(' . ($hard ? 'HARD' : '') . ') invoked.'); |
||
579 | } |
||
580 | |||
581 | if (Daemon::$config->throwexceptiononshutdown->value) { |
||
582 | throw new \Exception('event shutdown'); |
||
583 | } |
||
584 | |||
585 | @ob_flush(); |
||
586 | |||
587 | if ($this->terminated === true) { |
||
588 | if ($hard) { |
||
589 | exit(0); |
||
590 | } |
||
591 | |||
592 | return; |
||
593 | } |
||
594 | |||
595 | $this->terminated = true; |
||
596 | |||
597 | if ($hard) { |
||
598 | $this->setState(Daemon::WSTATE_SHUTDOWN); |
||
599 | exit(0); |
||
600 | } |
||
601 | |||
602 | $this->reloadReady = $this->appInstancesReloadReady(); |
||
603 | |||
604 | if ($this->reload && $this->graceful) { |
||
605 | $this->reloadReady = $this->reloadReady && (microtime(TRUE) > $this->reloadTime); |
||
606 | } |
||
607 | |||
608 | if (Daemon::$config->logevents->value) { |
||
609 | $this->log('reloadReady = ' . Debug::dump($this->reloadReady)); |
||
610 | } |
||
611 | |||
612 | Timer::remove('breakMainLoopCheck'); |
||
613 | |||
614 | Timer::add(function ($event) { |
||
615 | $self = Daemon::$process; |
||
616 | |||
617 | $self->reloadReady = $self->appInstancesReloadReady(); |
||
618 | |||
619 | if ($self->reload === TRUE) { |
||
620 | $self->reloadReady = $self->reloadReady && (microtime(TRUE) > $self->reloadTime); |
||
621 | } |
||
622 | if (!$self->reloadReady) { |
||
623 | $event->timeout(); |
||
624 | } |
||
625 | else { |
||
626 | $self->eventBase->exit(); |
||
627 | } |
||
628 | }, 1e6, 'checkReloadReady'); |
||
629 | while (!$this->reloadReady) { |
||
630 | $this->eventBase->loop(); |
||
631 | } |
||
632 | FileSystem::waitAllEvents(); // ensure that all I/O events completed before suicide |
||
633 | exit(0); // R.I.P. |
||
634 | } |
||
635 | |||
636 | /** |
||
637 | * Set current status of worker |
||
638 | * @param int Constant |
||
639 | * @return boolean Success. |
||
640 | */ |
||
641 | public function setState($int) { |
||
642 | if (Daemon::$compatMode) { |
||
643 | return true; |
||
644 | } |
||
645 | if (!$this->id) { |
||
646 | return false; |
||
647 | } |
||
648 | |||
649 | if (Daemon::$config->logworkersetstate->value) { |
||
650 | $this->log('state is ' . Daemon::$wstateRev[$int]); |
||
651 | } |
||
652 | |||
653 | $this->state = $int; |
||
654 | |||
655 | if ($this->reload) { |
||
656 | $int += 100; |
||
657 | } |
||
658 | Daemon::$shm_wstate->write(chr($int), $this->id - 1); |
||
659 | return true; |
||
660 | } |
||
661 | |||
662 | /** |
||
663 | * Handler of the SIGINT (hard shutdown) signal in worker process. |
||
664 | * @return void |
||
665 | */ |
||
666 | protected function sigint() { |
||
667 | if (Daemon::$config->logsignals->value) { |
||
668 | $this->log('caught SIGINT.'); |
||
669 | } |
||
670 | |||
671 | $this->shutdown(TRUE); |
||
672 | } |
||
673 | |||
674 | /** |
||
675 | * Handler of the SIGTERM (graceful shutdown) signal in worker process. |
||
676 | * @return void |
||
677 | */ |
||
678 | protected function sigterm() { |
||
679 | if (Daemon::$config->logsignals->value) { |
||
680 | $this->log('caught SIGTERM.'); |
||
681 | } |
||
682 | |||
683 | $this->graceful = false; |
||
684 | $this->breakMainLoop = true; |
||
685 | $this->eventBase->exit(); |
||
686 | } |
||
687 | |||
688 | /** |
||
689 | * Handler of the SIGQUIT (graceful shutdown) signal in worker process. |
||
690 | * @return void |
||
691 | */ |
||
692 | protected function sigquit() { |
||
693 | if (Daemon::$config->logsignals->value) { |
||
694 | $this->log('caught SIGQUIT.'); |
||
695 | } |
||
696 | |||
697 | parent::sigquit(); |
||
698 | } |
||
699 | |||
700 | /** |
||
701 | * Handler of the SIGHUP (reload config) signal in worker process. |
||
702 | * @return void |
||
703 | */ |
||
704 | View Code Duplication | protected function sighup() { |
|
705 | if (Daemon::$config->logsignals->value) { |
||
706 | $this->log('caught SIGHUP (reload config).'); |
||
707 | } |
||
708 | |||
709 | if (isset(Daemon::$config->configfile->value)) { |
||
710 | Daemon::loadConfig(Daemon::$config->configfile->value); |
||
711 | } |
||
712 | |||
713 | $this->update = true; |
||
714 | } |
||
715 | |||
716 | /** |
||
717 | * Handler of the SIGUSR1 (re-open log-file) signal in worker process. |
||
718 | * @return void |
||
719 | */ |
||
720 | protected function sigusr1() { |
||
721 | if (Daemon::$config->logsignals->value) { |
||
722 | $this->log('caught SIGUSR1 (re-open log-file).'); |
||
723 | } |
||
724 | |||
725 | Daemon::openLogs(); |
||
726 | } |
||
727 | |||
728 | /** |
||
729 | * Handler of the SIGUSR2 (graceful shutdown for update) signal in worker process. |
||
730 | * @return void |
||
731 | */ |
||
732 | protected function sigusr2() { |
||
733 | if (Daemon::$config->logsignals->value) { |
||
734 | $this->log('caught SIGUSR2 (graceful shutdown for update).'); |
||
735 | } |
||
736 | |||
737 | $this->gracefulRestart(); |
||
738 | } |
||
739 | |||
740 | /** |
||
741 | * Handler of the SIGTSTP (graceful stop) signal in worker process. |
||
742 | * @return void |
||
743 | */ |
||
744 | protected function sigtstp() { |
||
745 | if (Daemon::$config->logsignals->value) { |
||
746 | $this->log('caught SIGTSTP (graceful stop).'); |
||
747 | } |
||
748 | |||
749 | $this->gracefulStop(); |
||
750 | } |
||
751 | |||
752 | /** |
||
753 | * Handler of the SIGTTIN signal in worker process. |
||
754 | * @return void |
||
755 | */ |
||
756 | protected function sigttin() { |
||
758 | |||
759 | /** |
||
760 | * Handler of the SIGPIPE signal in worker process. |
||
761 | * @return void |
||
762 | */ |
||
763 | protected function sigpipe() { |
||
765 | |||
766 | /** |
||
767 | * Handler of non-known signals. |
||
768 | * @return void |
||
769 | */ |
||
770 | View Code Duplication | protected function sigunknown($signo) { |
|
771 | if (isset(Generic::$signals[$signo])) { |
||
772 | $sig = Generic::$signals[$signo]; |
||
773 | } |
||
774 | else { |
||
775 | $sig = 'UNKNOWN'; |
||
776 | } |
||
777 | |||
778 | $this->log('caught signal #' . $signo . ' (' . $sig . ').'); |
||
779 | } |
||
780 | |||
781 | /** |
||
782 | * Called (in master) when process is terminated |
||
783 | * @return void |
||
784 | */ |
||
785 | public function onTerminated() { |
||
788 | |||
789 | /** |
||
790 | * Destructor of worker thread. |
||
791 | * @return void |
||
792 | */ |
||
793 | public function __destruct() { |
||
794 | if (posix_getpid() === $this->pid) { |
||
795 | $this->setState(Daemon::WSTATE_SHUTDOWN); |
||
796 | } |
||
797 | } |
||
798 | } |
||
799 |
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.