2018-03-24 18:39:13 +00:00
|
|
|
<?php
|
2020-02-09 14:45:36 +00:00
|
|
|
/**
|
|
|
|
* @copyright Copyright (C) 2020, Friendica
|
|
|
|
*
|
|
|
|
* @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/>.
|
|
|
|
*
|
|
|
|
*/
|
2018-03-24 18:39:13 +00:00
|
|
|
|
|
|
|
namespace Friendica\Core;
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
use Dice\Dice;
|
2019-05-02 21:17:35 +00:00
|
|
|
use Friendica;
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
/**
|
|
|
|
* Description of Console
|
|
|
|
*/
|
|
|
|
class Console extends \Asika\SimpleConsole\Console
|
|
|
|
{
|
|
|
|
// Disables the default help handling
|
|
|
|
protected $helpOptions = [];
|
|
|
|
protected $customHelpOptions = ['h', 'help', '?'];
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
/**
|
|
|
|
* @var Dice The DI library
|
|
|
|
*/
|
|
|
|
protected $dice;
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
protected function getHelp()
|
|
|
|
{
|
|
|
|
$help = <<<HELP
|
|
|
|
Usage: bin/console [--version] [-h|--help|-?] <command> [<args>] [-v]
|
|
|
|
|
|
|
|
Commands:
|
2018-09-26 02:59:22 +00:00
|
|
|
cache Manage node cache
|
2018-03-24 18:39:13 +00:00
|
|
|
config Edit site config
|
|
|
|
createdoxygen Generate Doxygen headers
|
|
|
|
dbstructure Do database updates
|
|
|
|
docbloxerrorchecker Check the file tree for DocBlox errors
|
|
|
|
extract Generate translation string file for the Friendica project (deprecated)
|
|
|
|
globalcommunityblock Block remote profile from interacting with this node
|
|
|
|
globalcommunitysilence Silence remote profile from global community page
|
2018-04-23 05:33:47 +00:00
|
|
|
archivecontact Archive a contact when you know that it isn't existing anymore
|
2018-03-24 18:39:13 +00:00
|
|
|
help Show help about a command, e.g (bin/console help config)
|
2018-04-18 12:21:40 +00:00
|
|
|
autoinstall Starts automatic installation of friendica based on values from htconfig.php
|
2019-08-13 19:20:41 +00:00
|
|
|
lock Edit site locks
|
2018-03-24 18:39:13 +00:00
|
|
|
maintenance Set maintenance mode for this node
|
2020-02-20 22:08:19 +00:00
|
|
|
user User management
|
2018-03-24 18:39:13 +00:00
|
|
|
php2po Generate a messages.po file from a strings.php file
|
|
|
|
po2php Generate a strings.php file from a messages.po file
|
|
|
|
typo Checks for parse errors in Friendica files
|
2018-08-10 21:20:25 +00:00
|
|
|
postupdate Execute pending post update scripts (can last days)
|
2019-04-20 14:40:27 +00:00
|
|
|
serverblock Manage blocked servers
|
2018-11-29 11:57:57 +00:00
|
|
|
storage Manage storage backend
|
2018-03-24 18:39:13 +00:00
|
|
|
|
|
|
|
Options:
|
|
|
|
-h|--help|-? Show help information
|
|
|
|
-v Show more debug information.
|
|
|
|
HELP;
|
|
|
|
return $help;
|
|
|
|
}
|
|
|
|
|
2019-04-20 14:40:27 +00:00
|
|
|
protected $subConsoles = [
|
2019-05-02 21:17:35 +00:00
|
|
|
'cache' => Friendica\Console\Cache::class,
|
|
|
|
'config' => Friendica\Console\Config::class,
|
|
|
|
'createdoxygen' => Friendica\Console\CreateDoxygen::class,
|
|
|
|
'docbloxerrorchecker' => Friendica\Console\DocBloxErrorChecker::class,
|
|
|
|
'dbstructure' => Friendica\Console\DatabaseStructure::class,
|
|
|
|
'extract' => Friendica\Console\Extract::class,
|
|
|
|
'globalcommunityblock' => Friendica\Console\GlobalCommunityBlock::class,
|
|
|
|
'globalcommunitysilence' => Friendica\Console\GlobalCommunitySilence::class,
|
|
|
|
'archivecontact' => Friendica\Console\ArchiveContact::class,
|
|
|
|
'autoinstall' => Friendica\Console\AutomaticInstallation::class,
|
2019-08-13 19:20:41 +00:00
|
|
|
'lock' => Friendica\Console\Lock::class,
|
2019-05-02 21:17:35 +00:00
|
|
|
'maintenance' => Friendica\Console\Maintenance::class,
|
2020-02-20 22:08:19 +00:00
|
|
|
'user' => Friendica\Console\User::class,
|
2019-05-02 21:17:35 +00:00
|
|
|
'php2po' => Friendica\Console\PhpToPo::class,
|
|
|
|
'po2php' => Friendica\Console\PoToPhp::class,
|
|
|
|
'typo' => Friendica\Console\Typo::class,
|
|
|
|
'postupdate' => Friendica\Console\PostUpdate::class,
|
|
|
|
'serverblock' => Friendica\Console\ServerBlock::class,
|
|
|
|
'storage' => Friendica\Console\Storage::class,
|
2019-04-20 14:40:27 +00:00
|
|
|
];
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
/**
|
|
|
|
* CliInput Friendica constructor.
|
|
|
|
*
|
|
|
|
* @param Dice $dice The DI library
|
|
|
|
* @param array $argv
|
|
|
|
*/
|
|
|
|
public function __construct(Dice $dice, array $argv = null)
|
|
|
|
{
|
|
|
|
parent::__construct($argv);
|
|
|
|
|
|
|
|
$this->dice = $dice;
|
|
|
|
}
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
protected function doExecute()
|
|
|
|
{
|
|
|
|
if ($this->getOption('v')) {
|
|
|
|
$this->out('Executable: ' . $this->executable);
|
|
|
|
$this->out('Arguments: ' . var_export($this->args, true));
|
|
|
|
$this->out('Options: ' . var_export($this->options, true));
|
|
|
|
}
|
|
|
|
|
|
|
|
$subHelp = false;
|
|
|
|
$command = null;
|
|
|
|
|
|
|
|
if ($this->getOption('version')) {
|
|
|
|
$this->out('Friendica Console version ' . FRIENDICA_VERSION);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
} elseif ((count($this->options) === 0 || $this->getOption($this->customHelpOptions) === true || $this->getOption($this->customHelpOptions) === 1) && count($this->args) === 0
|
|
|
|
) {
|
|
|
|
} elseif (count($this->args) >= 2 && $this->getArgument(0) == 'help') {
|
|
|
|
$command = $this->getArgument(1);
|
|
|
|
$subHelp = true;
|
|
|
|
array_shift($this->args);
|
|
|
|
array_shift($this->args);
|
|
|
|
} elseif (count($this->args) >= 1) {
|
|
|
|
$command = $this->getArgument(0);
|
|
|
|
array_shift($this->args);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (is_null($command)) {
|
|
|
|
$this->out($this->getHelp());
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
$console = $this->getSubConsole($command);
|
|
|
|
|
|
|
|
if ($subHelp) {
|
|
|
|
$console->setOption($this->customHelpOptions, true);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $console->execute();
|
|
|
|
}
|
|
|
|
|
|
|
|
private function getSubConsole($command)
|
|
|
|
{
|
|
|
|
if ($this->getOption('v')) {
|
|
|
|
$this->out('Command: ' . $command);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!isset($this->subConsoles[$command])) {
|
|
|
|
throw new \Asika\SimpleConsole\CommandArgsException('Command ' . $command . ' doesn\'t exist');
|
|
|
|
}
|
|
|
|
|
|
|
|
$subargs = $this->args;
|
|
|
|
array_unshift($subargs, $this->executable);
|
|
|
|
|
|
|
|
$className = $this->subConsoles[$command];
|
|
|
|
|
2019-12-15 22:28:01 +00:00
|
|
|
Friendica\DI::init($this->dice);
|
2019-07-28 20:06:33 +00:00
|
|
|
|
2019-01-21 21:51:59 +00:00
|
|
|
/** @var Console $subconsole */
|
2019-07-28 20:06:33 +00:00
|
|
|
$subconsole = $this->dice->create($className, [$subargs]);
|
2018-03-24 18:39:13 +00:00
|
|
|
|
|
|
|
foreach ($this->options as $name => $value) {
|
|
|
|
$subconsole->setOption($name, $value);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $subconsole;
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|