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