src/Core/Console.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Dice\Dice;
  25 use Friendica;
  26
  27 /**
  28  * Description of Console
  29  */
  30 class Console extends \Asika\SimpleConsole\Console
  31 {
  32         // Disables the default help handling
  33         protected $helpOptions = [];
  34         protected $customHelpOptions = ['h', 'help', '?'];
  35
  36         /**
  37          * @var Dice The DI library
  38          */
  39         protected $dice;
  40
  41         protected function getHelp()
  42         {
  43                 $help = <<<HELP
  44 Usage: bin/console [--version] [-h|--help|-?] <command> [<args>] [-v]
  45
  46 Commands:
  47         addon                  Addon management
  48         cache                  Manage node cache
  49         config                 Edit site config
  50         contact                Contact management
  51         createdoxygen          Generate Doxygen headers
  52         dbstructure            Do database updates
  53         docbloxerrorchecker    Check the file tree for DocBlox errors
  54         extract                Generate translation string file for the Friendica project (deprecated)
  55         globalcommunityblock   Block remote profile from interacting with this node
  56         globalcommunitysilence Silence a profile from the global community page
  57         archivecontact         Archive a contact when you know that it isn't existing anymore
  58         help                   Show help about a command, e.g (bin/console help config)
  59         autoinstall            Starts automatic installation of friendica based on values from htconfig.php
  60         lock                   Edit site locks
  61         maintenance            Set maintenance mode for this node
  62         user                   User management
  63         php2po                 Generate a messages.po file from a strings.php file
  64         po2php                 Generate a strings.php file from a messages.po file
  65         typo                   Checks for parse errors in Friendica files
  66         postupdate             Execute pending post update scripts (can last days)
  67         serverblock            Manage blocked servers
  68         storage                Manage storage backend
  69         relay                  Manage ActivityPub relay servers
  70
  71 Options:
  72         -h|--help|-? Show help information
  73         -v           Show more debug information.
  74 HELP;
  75                 return $help;
  76         }
  77
  78         protected $subConsoles = [
  79                 'addon'                  => Friendica\Console\Addon::class,
  80                 'archivecontact'         => Friendica\Console\ArchiveContact::class,
  81                 'autoinstall'            => Friendica\Console\AutomaticInstallation::class,
  82                 'cache'                  => Friendica\Console\Cache::class,
  83                 'config'                 => Friendica\Console\Config::class,
  84                 'contact'                => Friendica\Console\Contact::class,
  85                 'createdoxygen'          => Friendica\Console\CreateDoxygen::class,
  86                 'docbloxerrorchecker'    => Friendica\Console\DocBloxErrorChecker::class,
  87                 'dbstructure'            => Friendica\Console\DatabaseStructure::class,
  88                 'extract'                => Friendica\Console\Extract::class,
  89                 'fixapdeliveryworkertaskparameters' => Friendica\Console\FixAPDeliveryWorkerTaskParameters::class,
  90                 'globalcommunityblock'   => Friendica\Console\GlobalCommunityBlock::class,
  91                 'globalcommunitysilence' => Friendica\Console\GlobalCommunitySilence::class,
  92                 'lock'                   => Friendica\Console\Lock::class,
  93                 'maintenance'            => Friendica\Console\Maintenance::class,
  94                 'php2po'                 => Friendica\Console\PhpToPo::class,
  95                 'postupdate'             => Friendica\Console\PostUpdate::class,
  96                 'po2php'                 => Friendica\Console\PoToPhp::class,
  97                 'relay'                  => Friendica\Console\Relay::class,
  98                 'serverblock'            => Friendica\Console\ServerBlock::class,
  99                 'storage'                => Friendica\Console\Storage::class,
 100                 'test'                   => Friendica\Console\Test::class,
 101                 'typo'                   => Friendica\Console\Typo::class,
 102                 'user'                   => Friendica\Console\User::class,
 103         ];
 104
 105         /**
 106          * CliInput Friendica constructor.
 107          *
 108          * @param Dice $dice The DI library
 109          * @param array $argv
 110          */
 111         public function __construct(Dice $dice, array $argv = null)
 112         {
 113                 parent::__construct($argv);
 114
 115                 $this->dice = $dice;
 116         }
 117
 118         protected function doExecute()
 119         {
 120                 if ($this->getOption('v')) {
 121                         $this->out('Executable: ' . $this->executable);
 122                         $this->out('Arguments: ' . var_export($this->args, true));
 123                         $this->out('Options: ' . var_export($this->options, true));
 124                 }
 125
 126                 $subHelp = false;
 127                 $command = null;
 128
 129                 if ($this->getOption('version')) {
 130                         $this->out('Friendica Console version ' . FRIENDICA_VERSION);
 131
 132                         return 0;
 133                 } elseif ((count($this->options) === 0 || $this->getOption($this->customHelpOptions) === true || $this->getOption($this->customHelpOptions) === 1) && count($this->args) === 0
 134                 ) {
 135                 } elseif (count($this->args) >= 2 && $this->getArgument(0) == 'help') {
 136                         $command = $this->getArgument(1);
 137                         $subHelp = true;
 138                         array_shift($this->args);
 139                         array_shift($this->args);
 140                 } elseif (count($this->args) >= 1) {
 141                         $command = $this->getArgument(0);
 142                         array_shift($this->args);
 143                 }
 144
 145                 if (is_null($command)) {
 146                         $this->out($this->getHelp());
 147                         return 0;
 148                 }
 149
 150                 $console = $this->getSubConsole($command);
 151
 152                 if ($subHelp) {
 153                         $console->setOption($this->customHelpOptions, true);
 154                 }
 155
 156                 return $console->execute();
 157         }
 158
 159         private function getSubConsole($command)
 160         {
 161                 if ($this->getOption('v')) {
 162                         $this->out('Command: ' . $command);
 163                 }
 164
 165                 if (!isset($this->subConsoles[$command])) {
 166                         throw new \Asika\SimpleConsole\CommandArgsException('Command ' . $command . ' doesn\'t exist');
 167                 }
 168
 169                 $subargs = $this->args;
 170                 array_unshift($subargs, $this->executable);
 171
 172                 $className = $this->subConsoles[$command];
 173
 174                 Friendica\DI::init($this->dice);
 175
 176                 Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
 177
 178                 /** @var Console $subconsole */
 179                 $subconsole = $this->dice->create($className, [$subargs]);
 180
 181                 foreach ($this->options as $name => $value) {
 182                         $subconsole->setOption($name, $value);
 183                 }
 184
 185                 return $subconsole;
 186         }
 187
 188 }