src/Core/Console.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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         movetoavatarcache      Move cached avatars to the file based avatar cache
  63         user                   User management
  64         php2po                 Generate a messages.po file from a strings.php file
  65         po2php                 Generate a strings.php file from a messages.po file
  66         typo                   Checks for parse errors in Friendica files
  67         postupdate             Execute pending post update scripts (can last days)
  68         serverblock            Manage blocked servers
  69         storage                Manage storage backend
  70         relay                  Manage ActivityPub relay servers
  71
  72 Options:
  73         -h|--help|-? Show help information
  74         -v           Show more debug information.
  75 HELP;
  76                 return $help;
  77         }
  78
  79         protected $subConsoles = [
  80                 'addon'                  => Friendica\Console\Addon::class,
  81                 'archivecontact'         => Friendica\Console\ArchiveContact::class,
  82                 'autoinstall'            => Friendica\Console\AutomaticInstallation::class,
  83                 'cache'                  => Friendica\Console\Cache::class,
  84                 'config'                 => Friendica\Console\Config::class,
  85                 'contact'                => Friendica\Console\Contact::class,
  86                 'createdoxygen'          => Friendica\Console\CreateDoxygen::class,
  87                 'docbloxerrorchecker'    => Friendica\Console\DocBloxErrorChecker::class,
  88                 'dbstructure'            => Friendica\Console\DatabaseStructure::class,
  89                 'extract'                => Friendica\Console\Extract::class,
  90                 'fixapdeliveryworkertaskparameters' => Friendica\Console\FixAPDeliveryWorkerTaskParameters::class,
  91                 'globalcommunityblock'   => Friendica\Console\GlobalCommunityBlock::class,
  92                 'globalcommunitysilence' => Friendica\Console\GlobalCommunitySilence::class,
  93                 'lock'                   => Friendica\Console\Lock::class,
  94                 'maintenance'            => Friendica\Console\Maintenance::class,
  95                 'movetoavatarcache'      => Friendica\Console\MoveToAvatarCache::class,
  96                 'php2po'                 => Friendica\Console\PhpToPo::class,
  97                 'postupdate'             => Friendica\Console\PostUpdate::class,
  98                 'po2php'                 => Friendica\Console\PoToPhp::class,
  99                 'relay'                  => Friendica\Console\Relay::class,
 100                 'serverblock'            => Friendica\Console\ServerBlock::class,
 101                 'storage'                => Friendica\Console\Storage::class,
 102                 'test'                   => Friendica\Console\Test::class,
 103                 'typo'                   => Friendica\Console\Typo::class,
 104                 'user'                   => Friendica\Console\User::class,
 105         ];
 106
 107         /**
 108          * CliInput Friendica constructor.
 109          *
 110          * @param Dice $dice The DI library
 111          * @param array $argv
 112          */
 113         public function __construct(Dice $dice, array $argv = null)
 114         {
 115                 parent::__construct($argv);
 116
 117                 $this->dice = $dice;
 118         }
 119
 120         protected function doExecute()
 121         {
 122                 if ($this->getOption('v')) {
 123                         $this->out('Executable: ' . $this->executable);
 124                         $this->out('Arguments: ' . var_export($this->args, true));
 125                         $this->out('Options: ' . var_export($this->options, true));
 126                 }
 127
 128                 $subHelp = false;
 129                 $command = null;
 130
 131                 if ($this->getOption('version')) {
 132                         $this->out('Friendica Console version ' . FRIENDICA_VERSION);
 133
 134                         return 0;
 135                 } elseif ((count($this->options) === 0 || $this->getOption($this->customHelpOptions) === true || $this->getOption($this->customHelpOptions) === 1) && count($this->args) === 0
 136                 ) {
 137                 } elseif (count($this->args) >= 2 && $this->getArgument(0) == 'help') {
 138                         $command = $this->getArgument(1);
 139                         $subHelp = true;
 140                         array_shift($this->args);
 141                         array_shift($this->args);
 142                 } elseif (count($this->args) >= 1) {
 143                         $command = $this->getArgument(0);
 144                         array_shift($this->args);
 145                 }
 146
 147                 if (is_null($command)) {
 148                         $this->out($this->getHelp());
 149                         return 0;
 150                 }
 151
 152                 $console = $this->getSubConsole($command);
 153
 154                 if ($subHelp) {
 155                         $console->setOption($this->customHelpOptions, true);
 156                 }
 157
 158                 return $console->execute();
 159         }
 160
 161         private function getSubConsole($command)
 162         {
 163                 if ($this->getOption('v')) {
 164                         $this->out('Command: ' . $command);
 165                 }
 166
 167                 if (!isset($this->subConsoles[$command])) {
 168                         throw new \Asika\SimpleConsole\CommandArgsException('Command ' . $command . ' doesn\'t exist');
 169                 }
 170
 171                 $subargs = $this->args;
 172                 array_unshift($subargs, $this->executable);
 173
 174                 $className = $this->subConsoles[$command];
 175
 176                 Friendica\DI::init($this->dice);
 177
 178                 Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
 179
 180                 /** @var Console $subconsole */
 181                 $subconsole = $this->dice->create($className, [$subargs]);
 182
 183                 foreach ($this->options as $name => $value) {
 184                         $subconsole->setOption($name, $value);
 185                 }
 186
 187                 return $subconsole;
 188         }
 189
 190 }