friendica/src/Console/Maintenance.php

129 lines
3.2 KiB
PHP

<?php
/**
* @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Console;
use Friendica\App;
use Friendica\Core\Config\Capability\IManageConfigValues;
/**
* Sets maintenance mode for this node
*/
class Maintenance extends \Asika\SimpleConsole\Console
{
protected $helpOptions = ['h', 'help', '?'];
/**
* @var App\Mode
*/
private $appMode;
/**
* @var IManageConfigValues
*/
private $config;
protected function getHelp()
{
$help = <<<HELP
console maintenance - Sets maintenance mode for this node
Usage
bin/console maintenance <enable> [<reason>] [-h|--help|-?] [-v]
Description
<enable> cen be either 0 or 1 to disabled or enable the maintenance mode on this node.
<reason> is a quote-enclosed string with the optional reason for the maintenance mode.
Examples
bin/console maintenance 1
Enables the maintenance mode without setting a reason message
bin/console maintenance 1 "SSL certification update"
Enables the maintenance mode with setting a reason message
bin/console maintenance 0
Disables the maintenance mode
Options
-h|--help|-? Show help information
-v Show more debug information.
HELP;
return $help;
}
public function __construct(App\Mode $appMode, IManageConfigValues $config, $argv = null)
{
parent::__construct($argv);
$this->appMode = $appMode;
$this->config = $config;
}
protected function doExecute(): int
{
if ($this->getOption('v')) {
$this->out('Class: ' . __CLASS__);
$this->out('Arguments: ' . var_export($this->args, true));
$this->out('Options: ' . var_export($this->options, true));
}
if (count($this->args) == 0) {
$this->out($this->getHelp());
return 0;
}
if (count($this->args) > 2) {
throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments');
}
if ($this->appMode->isInstall()) {
throw new \RuntimeException('Database isn\'t ready or populated yet');
}
$enabled = intval($this->getArgument(0));
$this->config->set('system', 'maintenance', $enabled);
$reason = $this->getArgument(1);
if ($enabled && $this->getArgument(1)) {
$this->config->set('system', 'maintenance_reason', $this->getArgument(1));
} else {
$this->config->set('system', 'maintenance_reason', '');
}
if ($enabled) {
$mode_str = "maintenance mode";
} else {
$mode_str = "normal mode";
}
$this->out('System set in ' . $mode_str);
if ($enabled && $reason != '') {
$this->out('Maintenance reason: ' . $reason);
}
return 0;
}
}