Localisation updates from http://translatewiki.net.
[mediawiki.git] / maintenance / sqlite.php
blob8a785245ac9195bf1a5f31f99e381c0c710e6723
1 <?php
2 /**
3 * Performs some operations specific to SQLite database backend.
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.
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.
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
20 * @file
21 * @ingroup Maintenance
24 require_once __DIR__ . '/Maintenance.php';
26 /**
27 * Maintenance script that performs some operations specific to SQLite database backend.
29 * @ingroup Maintenance
31 class SqliteMaintenance extends Maintenance {
32 public function __construct() {
33 parent::__construct();
34 $this->mDescription = "Performs some operations specific to SQLite database backend";
35 $this->addOption( 'vacuum', 'Clean up database by removing deleted pages. Decreases database file size' );
36 $this->addOption( 'integrity', 'Check database for integrity' );
37 $this->addOption( 'backup-to', 'Backup database to the given file', false, true );
38 $this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
41 /**
42 * While we use database connection, this simple lie prevents useless --dbpass and
43 * --dbuser options from appearing in help message for this script.
45 * @return int DB constant
47 public function getDbType() {
48 return Maintenance::DB_NONE;
51 public function execute() {
52 // Should work even if we use a non-SQLite database
53 if ( $this->hasOption( 'check-syntax' ) ) {
54 $this->checkSyntax();
55 return;
58 $this->db = wfGetDB( DB_MASTER );
60 if ( $this->db->getType() != 'sqlite' ) {
61 $this->error( "This maintenance script requires a SQLite database.\n" );
62 return;
65 if ( $this->hasOption( 'vacuum' ) ) {
66 $this->vacuum();
69 if ( $this->hasOption( 'integrity' ) ) {
70 $this->integrityCheck();
73 if ( $this->hasOption( 'backup-to' ) ) {
74 $this->backup( $this->getOption( 'backup-to' ) );
78 private function vacuum() {
79 $prevSize = filesize( $this->db->mDatabaseFile );
80 if ( $prevSize == 0 ) {
81 $this->error( "Can't vacuum an empty database.\n", true );
84 $this->output( 'VACUUM: ' );
85 if ( $this->db->query( 'VACUUM' ) ) {
86 clearstatcache();
87 $newSize = filesize( $this->db->mDatabaseFile );
88 $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
89 $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
90 } else {
91 $this->output( 'Error\n' );
95 private function integrityCheck() {
96 $this->output( "Performing database integrity checks:\n" );
97 $res = $this->db->query( 'PRAGMA integrity_check' );
99 if ( !$res || $res->numRows() == 0 ) {
100 $this->error( "Error: integrity check query returned nothing.\n" );
101 return;
104 foreach ( $res as $row ) {
105 $this->output( $row->integrity_check );
109 private function backup( $fileName ) {
110 $this->output( "Backing up database:\n Locking..." );
111 $this->db->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
112 $ourFile = $this->db->mDatabaseFile;
113 $this->output( " Copying database file $ourFile to $fileName... " );
114 wfSuppressWarnings( false );
115 if ( !copy( $ourFile, $fileName ) ) {
116 $err = error_get_last();
117 $this->error( " {$err['message']}" );
119 wfSuppressWarnings( true );
120 $this->output( " Releasing lock...\n" );
121 $this->db->query( 'COMMIT TRANSACTION', __METHOD__ );
124 private function checkSyntax() {
125 if ( !Sqlite::IsPresent() ) {
126 $this->error( "Error: SQLite support not found\n" );
128 $files = array( $this->getOption( 'check-syntax' ) );
129 $files += $this->mArgs;
130 $result = Sqlite::checkSqlSyntax( $files );
131 if ( $result === true ) {
132 $this->output( "SQL syntax check: no errors detected.\n" );
133 } else {
134 $this->error( "Error: $result\n" );
139 $maintClass = "SqliteMaintenance";
140 require_once RUN_MAINTENANCE_IF_MAIN;