src/Console/DatabaseStructure.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   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\Console;
  23
  24 use Friendica\Core\Config\Cache;
  25 use Friendica\Core\Update;
  26 use Friendica\Database\Database;
  27 use Friendica\Database\DBStructure;
  28 use RuntimeException;
  29
  30 /**
  31  * Performs database updates from the command line
  32  */
  33 class DatabaseStructure extends \Asika\SimpleConsole\Console
  34 {
  35         protected $helpOptions = ['h', 'help', '?'];
  36
  37         /**
  38          * @var Database
  39          */
  40         private $dba;
  41         /**
  42          * @var Cache
  43          */
  44         private $configCache;
  45
  46         protected function getHelp()
  47         {
  48                 $help = <<<HELP
  49 console dbstructure - Performs database updates
  50 Usage
  51         bin/console dbstructure <command> [-h|--help|-?] |-f|--force] [-v]
  52
  53 Commands
  54         dryrun   Show database update schema queries without running them
  55         update   Update database schema
  56         dumpsql  Dump database schema
  57         toinnodb Convert all tables from MyISAM or InnoDB in the Antelope file format to InnoDB in the Barracuda file format
  58         initial  Set needed initial values in the tables
  59         version  Set the database to a given number
  60
  61 Options
  62     -h|--help|-?       Show help information
  63     -v                 Show more debug information.
  64     -f|--force         Force the update command (Even if the database structure matches)
  65     -o|--override      Override running or stalling updates
  66 HELP;
  67                 return $help;
  68         }
  69
  70         public function __construct(Database $dba, Cache $configCache, $argv = null)
  71         {
  72                 parent::__construct($argv);
  73
  74                 $this->dba = $dba;
  75                 $this->configCache = $configCache;
  76         }
  77
  78         protected function doExecute()
  79         {
  80                 if ($this->getOption('v')) {
  81                         $this->out('Class: ' . __CLASS__);
  82                         $this->out('Arguments: ' . var_export($this->args, true));
  83                         $this->out('Options: ' . var_export($this->options, true));
  84                 }
  85
  86                 if (count($this->args) == 0) {
  87                         $this->out($this->getHelp());
  88                         return 0;
  89                 }
  90
  91                 if ((count($this->args) > 1) && ($this->getArgument(0) != 'version')) {
  92                         throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments');
  93                 } elseif ((count($this->args) != 2) && ($this->getArgument(0) == 'version')) {
  94                         throw new \Asika\SimpleConsole\CommandArgsException('This command needs two arguments');
  95                 }
  96
  97                 if (!$this->dba->isConnected()) {
  98                         throw new RuntimeException('Unable to connect to database');
  99                 }
 100
 101                 $basePath = $this->configCache->get('system', 'basepath');
 102
 103                 switch ($this->getArgument(0)) {
 104                         case "dryrun":
 105                                 $output = DBStructure::update($basePath, true, false);
 106                                 break;
 107                         case "update":
 108                                 $force    = $this->getOption(['f', 'force'], false);
 109                                 $override = $this->getOption(['o', 'override'], false);
 110                                 $output = Update::run($basePath, $force, $override,true, false);
 111                                 break;
 112                         case "dumpsql":
 113                                 ob_start();
 114                                 DBStructure::printStructure($basePath);
 115                                 $output = ob_get_clean();
 116                                 break;
 117                         case "toinnodb":
 118                                 ob_start();
 119                                 DBStructure::convertToInnoDB();
 120                                 $output = ob_get_clean();
 121                                 break;
 122                         case "version":
 123                                 ob_start();
 124                                 DBStructure::setDatabaseVersion($this->getArgument(1));
 125                                 $output = ob_get_clean();
 126                                 break;
 127                         case "initial":
 128                                 ob_start();
 129                                 DBStructure::checkInitialValues(true);
 130                                 $output = ob_get_clean();
 131                                 break;
 132                         default:
 133                                 $output = 'Unknown command: ' . $this->getArgument(0);
 134                 }
 135
 136                 $this->out($output);
 137
 138                 return 0;
 139         }
 140 }