MDL-60094 administration: Add CLI script to kill all sessions
[moodle.git] / admin / cli / kill_all_sessions.php
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/>.
17 /**
18  * CLI script to kill all user sessions without asking for confirmation.
19  *
20  * @package    core
21  * @subpackage cli
22  * @copyright  2017 Alexander Bias <alexander.bias@uni-ulm.de>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 define('CLI_SCRIPT', true);
28 require(__DIR__.'/../../config.php');
29 require_once($CFG->libdir.'/clilib.php');
31 list($options, $unrecognized) = cli_get_params(array('help' => false), array('h' => 'help'));
33 if ($unrecognized) {
34     $unrecognized = implode("\n  ", $unrecognized);
35     cli_error(get_string('cliunknowoption', 'admin', $unrecognized), 2);
36 }
38 if ($options['help']) {
39     $help =
40 "Kill all Moodle sessions
42 Options:
43 -h, --help            Print out this help
45 Example:
46 \$sudo -u www-data /usr/bin/php admin/cli/kill_all_sessions.php
47 ";
49     echo $help;
50     exit(0);
51 }
53 \core\session\manager::kill_all_sessions();
55 exit(0);