| 1 |
efrain |
1 |
<?php
|
|
|
2 |
// This file is part of Moodle - http://moodle.org/
|
|
|
3 |
//
|
|
|
4 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
5 |
// it under the terms of the GNU General Public License as published by
|
|
|
6 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
7 |
// (at your option) any later version.
|
|
|
8 |
//
|
|
|
9 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
10 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
11 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
12 |
// GNU General Public License for more details.
|
|
|
13 |
//
|
|
|
14 |
// You should have received a copy of the GNU General Public License
|
|
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
16 |
|
|
|
17 |
/**
|
|
|
18 |
* CLI script shutdown helper class.
|
|
|
19 |
*
|
|
|
20 |
* @package core
|
|
|
21 |
* @copyright 2019 Brendan Heywood <brendan@catalyst-au.net>
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
|
|
|
25 |
namespace core\local\cli;
|
|
|
26 |
|
|
|
27 |
defined('MOODLE_INTERNAL') || die();
|
|
|
28 |
|
|
|
29 |
/**
|
|
|
30 |
* CLI script shutdown helper class.
|
|
|
31 |
*
|
|
|
32 |
* @package core
|
|
|
33 |
* @copyright 2019 Brendan Heywood <brendan@catalyst-au.net>
|
|
|
34 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
35 |
*/
|
|
|
36 |
class shutdown {
|
|
|
37 |
|
|
|
38 |
/** @var bool Should we exit gracefully at the next opportunity? */
|
|
|
39 |
protected static $cligracefulexit = false;
|
|
|
40 |
|
|
|
41 |
/**
|
|
|
42 |
* Declares that this CLI script can gracefully handle signals
|
|
|
43 |
*
|
|
|
44 |
* @return void
|
|
|
45 |
*/
|
|
|
46 |
public static function script_supports_graceful_exit(): void {
|
|
|
47 |
\core_shutdown_manager::register_signal_handler('\core\local\cli\shutdown::signal_handler');
|
|
|
48 |
}
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Should we gracefully exit?
|
|
|
52 |
*
|
|
|
53 |
* @return bool true if we should gracefully exit
|
|
|
54 |
*/
|
|
|
55 |
public static function should_gracefully_exit(): bool {
|
|
|
56 |
return self::$cligracefulexit;
|
|
|
57 |
}
|
|
|
58 |
|
|
|
59 |
/**
|
|
|
60 |
* Handle the signal
|
|
|
61 |
*
|
|
|
62 |
* The first signal flags a graceful exit. If a second signal is received
|
|
|
63 |
* then it immediately exits.
|
|
|
64 |
*
|
|
|
65 |
* @param int $signo The signal number
|
|
|
66 |
* @return bool true if we should exit
|
|
|
67 |
*/
|
|
|
68 |
public static function signal_handler(int $signo): bool {
|
|
|
69 |
|
|
|
70 |
if (self::$cligracefulexit) {
|
|
|
71 |
cli_heading(get_string('cliexitnow', 'admin'));
|
|
|
72 |
return true;
|
|
|
73 |
}
|
|
|
74 |
|
|
|
75 |
cli_heading(get_string('cliexitgraceful', 'admin'));
|
|
|
76 |
self::$cligracefulexit = true;
|
|
|
77 |
return false;
|
|
|
78 |
}
|
|
|
79 |
|
|
|
80 |
}
|
|
|
81 |
|