maintenance/sqlite.php

   1 <?php
   2 /**
   3  * Performs some operations specific to SQLite database backend.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 use MediaWiki\MediaWikiServices;
  25
  26 use Wikimedia\Rdbms\DatabaseSqlite;
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29
  30 /**
  31  * Maintenance script that performs some operations specific to SQLite database backend.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class SqliteMaintenance extends Maintenance {
  36         public function __construct() {
  37                 parent::__construct();
  38                 $this->addDescription( 'Performs some operations specific to SQLite database backend' );
  39                 $this->addOption(
  40                         'vacuum',
  41                         'Clean up database by removing deleted pages. Decreases database file size'
  42                 );
  43                 $this->addOption( 'integrity', 'Check database for integrity' );
  44                 $this->addOption( 'backup-to', 'Backup database to the given file', false, true );
  45                 $this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
  46         }
  47
  48         /**
  49          * While we use database connection, this simple lie prevents useless --dbpass and
  50          * --dbuser options from appearing in help message for this script.
  51          *
  52          * @return int DB constant
  53          */
  54         public function getDbType() {
  55                 return Maintenance::DB_NONE;
  56         }
  57
  58         public function execute() {
  59                 // Should work even if we use a non-SQLite database
  60                 if ( $this->hasOption( 'check-syntax' ) ) {
  61                         $this->checkSyntax();
  62
  63                         return;
  64                 }
  65
  66                 $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
  67                 $dbw = $lb->getConnection( DB_MASTER );
  68                 if ( !( $dbw instanceof DatabaseSqlite ) ) {
  69                         $this->error( "This maintenance script requires a SQLite database.\n" );
  70
  71                         return;
  72                 }
  73
  74                 if ( $this->hasOption( 'vacuum' ) ) {
  75                         $this->vacuum( $dbw );
  76                 }
  77
  78                 if ( $this->hasOption( 'integrity' ) ) {
  79                         $this->integrityCheck( $dbw );
  80                 }
  81
  82                 if ( $this->hasOption( 'backup-to' ) ) {
  83                         $this->backup( $dbw, $this->getOption( 'backup-to' ) );
  84                 }
  85         }
  86
  87         private function vacuum( DatabaseSqlite $dbw ) {
  88                 $prevSize = filesize( $dbw->getDbFilePath() );
  89                 if ( $prevSize == 0 ) {
  90                         $this->fatalError( "Can't vacuum an empty database.\n" );
  91                 }
  92
  93                 $this->output( 'VACUUM: ' );
  94                 if ( $dbw->query( 'VACUUM' ) ) {
  95                         clearstatcache();
  96                         $newSize = filesize( $dbw->getDbFilePath() );
  97                         $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
  98                                 $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
  99                 } else {
 100                         $this->output( 'Error\n' );
 101                 }
 102         }
 103
 104         private function integrityCheck( DatabaseSqlite $dbw ) {
 105                 $this->output( "Performing database integrity checks:\n" );
 106                 $res = $dbw->query( 'PRAGMA integrity_check' );
 107
 108                 if ( !$res || $res->numRows() == 0 ) {
 109                         $this->error( "Error: integrity check query returned nothing.\n" );
 110
 111                         return;
 112                 }
 113
 114                 foreach ( $res as $row ) {
 115                         $this->output( $row->integrity_check );
 116                 }
 117         }
 118
 119         private function backup( DatabaseSqlite $dbw, $fileName ) {
 120                 $this->output( "Backing up database:\n   Locking..." );
 121                 $dbw->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
 122                 $ourFile = $dbw->getDbFilePath();
 123                 $this->output( "   Copying database file $ourFile to $fileName... " );
 124                 Wikimedia\suppressWarnings();
 125                 if ( !copy( $ourFile, $fileName ) ) {
 126                         $err = error_get_last();
 127                         $this->error( "      {$err['message']}" );
 128                 }
 129                 Wikimedia\restoreWarnings();
 130                 $this->output( "   Releasing lock...\n" );
 131                 $dbw->query( 'COMMIT TRANSACTION', __METHOD__ );
 132         }
 133
 134         private function checkSyntax() {
 135                 if ( !Sqlite::isPresent() ) {
 136                         $this->error( "Error: SQLite support not found\n" );
 137                 }
 138                 $files = [ $this->getOption( 'check-syntax' ) ];
 139                 $files = array_merge( $files, $this->mArgs );
 140                 $result = Sqlite::checkSqlSyntax( $files );
 141                 if ( $result === true ) {
 142                         $this->output( "SQL syntax check: no errors detected.\n" );
 143                 } else {
 144                         $this->error( "Error: $result\n" );
 145                 }
 146         }
 147 }
 148
 149 $maintClass = SqliteMaintenance::class;
 150 require_once RUN_MAINTENANCE_IF_MAIN;