Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 7
CRAP
0.00% covered (danger)
0.00%
0 / 84
SqliteMaintenance
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 7
420
0.00% covered (danger)
0.00%
0 / 81
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 10
 getDbType
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 execute
0.00% covered (danger)
0.00%
0 / 1
42
0.00% covered (danger)
0.00%
0 / 20
 vacuum
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 14
 integrityCheck
0.00% covered (danger)
0.00%
0 / 1
20
0.00% covered (danger)
0.00%
0 / 10
 backup
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 13
 checkSyntax
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 12
<?php
/**
 * Performs some operations specific to SQLite database backend.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Maintenance
 */
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\DatabaseSqlite;
require_once __DIR__ . '/Maintenance.php';
/**
 * Maintenance script that performs some operations specific to SQLite database backend.
 *
 * @ingroup Maintenance
 */
class SqliteMaintenance extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Performs some operations specific to SQLite database backend' );
        $this->addOption(
            'vacuum',
            'Clean up database by removing deleted pages. Decreases database file size'
        );
        $this->addOption( 'integrity', 'Check database for integrity' );
        $this->addOption( 'backup-to', 'Backup database to the given file', false, true );
        $this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
    }
    /**
     * While we use database connection, this simple lie prevents useless --dbpass and
     * --dbuser options from appearing in help message for this script.
     *
     * @return int DB constant
     */
    public function getDbType() {
        return Maintenance::DB_NONE;
    }
    public function execute() {
        // Should work even if we use a non-SQLite database
        if ( $this->hasOption( 'check-syntax' ) ) {
            $this->checkSyntax();
            return;
        }
        $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
        $dbw = $lb->getConnection( DB_MASTER );
        if ( !( $dbw instanceof DatabaseSqlite ) ) {
            $this->error( "This maintenance script requires a SQLite database.\n" );
            return;
        }
        if ( $this->hasOption( 'vacuum' ) ) {
            $this->vacuum( $dbw );
        }
        if ( $this->hasOption( 'integrity' ) ) {
            $this->integrityCheck( $dbw );
        }
        if ( $this->hasOption( 'backup-to' ) ) {
            $this->backup( $dbw, $this->getOption( 'backup-to' ) );
        }
    }
    private function vacuum( DatabaseSqlite $dbw ) {
        $prevSize = filesize( $dbw->getDbFilePath() );
        if ( $prevSize == 0 ) {
            $this->fatalError( "Can't vacuum an empty database.\n" );
        }
        $this->output( 'VACUUM: ' );
        if ( $dbw->query( 'VACUUM', __METHOD__ ) ) {
            clearstatcache();
            $newSize = filesize( $dbw->getDbFilePath() );
            $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
                $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
        } else {
            $this->output( 'Error\n' );
        }
    }
    private function integrityCheck( DatabaseSqlite $dbw ) {
        $this->output( "Performing database integrity checks:\n" );
        $res = $dbw->query( 'PRAGMA integrity_check', __METHOD__ );
        if ( !$res || $res->numRows() == 0 ) {
            $this->error( "Error: integrity check query returned nothing.\n" );
            return;
        }
        foreach ( $res as $row ) {
            $this->output( $row->integrity_check );
        }
    }
    private function backup( DatabaseSqlite $dbw, $fileName ) {
        $this->output( "Backing up database:\n   Locking..." );
        $dbw->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
        $ourFile = $dbw->getDbFilePath();
        $this->output( "   Copying database file $ourFile to $fileName... " );
        Wikimedia\suppressWarnings();
        if ( !copy( $ourFile, $fileName ) ) {
            $err = error_get_last();
            $this->error( "      {$err['message']}" );
        }
        Wikimedia\restoreWarnings();
        $this->output( "   Releasing lock...\n" );
        $dbw->query( 'COMMIT TRANSACTION', __METHOD__ );
    }
    private function checkSyntax() {
        if ( !Sqlite::isPresent() ) {
            $this->error( "Error: SQLite support not found\n" );
        }
        $files = [ $this->getOption( 'check-syntax' ) ];
        $files = array_merge( $files, $this->mArgs );
        $result = Sqlite::checkSqlSyntax( $files );
        if ( $result === true ) {
            $this->output( "SQL syntax check: no errors detected.\n" );
        } else {
            $this->error( "Error: $result\n" );
        }
    }
}
$maintClass = SqliteMaintenance::class;
require_once RUN_MAINTENANCE_IF_MAIN;