SqliteMaintenance::getDbType() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

SqliteMaintenance::getDbType() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: SqliteMaintenance

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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
 */

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;
		}

		$this->db = $this->getDB( DB_MASTER );
class MyClass { }

$x = new MyClass();
$x->foo = true;

		if ( $this->db->getType() != 'sqlite' ) {
			$this->error( "This maintenance script requires a SQLite database.\n" );

			return;
		}

		if ( $this->hasOption( 'vacuum' ) ) {
			$this->vacuum();
		}

		if ( $this->hasOption( 'integrity' ) ) {
			$this->integrityCheck();
		}

		if ( $this->hasOption( 'backup-to' ) ) {
			$this->backup( $this->getOption( 'backup-to' ) );
		}
	}

	private function vacuum() {
		$prevSize = filesize( $this->db->getDbFilePath() );
		if ( $prevSize == 0 ) {
			$this->error( "Can't vacuum an empty database.\n", true );
		}

		$this->output( 'VACUUM: ' );
		if ( $this->db->query( 'VACUUM' ) ) {
			clearstatcache();
			$newSize = filesize( $this->db->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() {
		$this->output( "Performing database integrity checks:\n" );
		$res = $this->db->query( 'PRAGMA integrity_check' );

		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( $fileName ) {
		$this->output( "Backing up database:\n   Locking..." );
		$this->db->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
		$ourFile = $this->db->getDbFilePath();
		$this->output( "   Copying database file $ourFile to $fileName... " );
		MediaWiki\suppressWarnings( false );
		if ( !copy( $ourFile, $fileName ) ) {
			$err = error_get_last();
			$this->error( "      {$err['message']}" );
		}
		MediaWiki\suppressWarnings( true );
		$this->output( "   Releasing lock...\n" );
		$this->db->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";
require_once RUN_MAINTENANCE_IF_MAIN;


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 31 and the first side effect is on line 24. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
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			require_once __DIR__ . '/Maintenance.php';
25
26			/**
27			* Maintenance script that performs some operations specific to SQLite database backend.
28			*
29			* @ingroup Maintenance
30			*/
31			class SqliteMaintenance extends Maintenance {
32			public function __construct() {
33			parent::__construct();
34			$this->addDescription( 'Performs some operations specific to SQLite database backend' );
35			$this->addOption(
36			'vacuum',
37			'Clean up database by removing deleted pages. Decreases database file size'
38			);
39			$this->addOption( 'integrity', 'Check database for integrity' );
40			$this->addOption( 'backup-to', 'Backup database to the given file', false, true );
41			$this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
42			}
43
44			/**
45			* While we use database connection, this simple lie prevents useless --dbpass and
46			* --dbuser options from appearing in help message for this script.
47			*
48			* @return int DB constant
49			*/
50			public function getDbType() {
51			return Maintenance::DB_NONE;
52			}
53
54			public function execute() {
55			// Should work even if we use a non-SQLite database
56			if ( $this->hasOption( 'check-syntax' ) ) {
57			$this->checkSyntax();
58
59			return;
60			}
61
62			$this->db = $this->getDB( DB_MASTER );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `db` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
63
64			if ( $this->db->getType() != 'sqlite' ) {
65			$this->error( "This maintenance script requires a SQLite database.\n" );
66
67			return;
68			}
69
70			if ( $this->hasOption( 'vacuum' ) ) {
71			$this->vacuum();
72			}
73
74			if ( $this->hasOption( 'integrity' ) ) {
75			$this->integrityCheck();
76			}
77
78			if ( $this->hasOption( 'backup-to' ) ) {
79			$this->backup( $this->getOption( 'backup-to' ) );
80			}
81			}
82
83			private function vacuum() {
84			$prevSize = filesize( $this->db->getDbFilePath() );
85			if ( $prevSize == 0 ) {
86			$this->error( "Can't vacuum an empty database.\n", true );
87			}
88
89			$this->output( 'VACUUM: ' );
90			if ( $this->db->query( 'VACUUM' ) ) {
91			clearstatcache();
92			$newSize = filesize( $this->db->getDbFilePath() );
93			$this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
94			$prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
95			} else {
96			$this->output( 'Error\n' );
97			}
98			}
99
100			private function integrityCheck() {
101			$this->output( "Performing database integrity checks:\n" );
102			$res = $this->db->query( 'PRAGMA integrity_check' );
103
104			if ( !$res \|\| $res->numRows() == 0 ) {
105			$this->error( "Error: integrity check query returned nothing.\n" );
106
107			return;
108			}
109
110			foreach ( $res as $row ) {
111			$this->output( $row->integrity_check );
112			}
113			}
114
115			private function backup( $fileName ) {
116			$this->output( "Backing up database:\n Locking..." );
117			$this->db->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
118			$ourFile = $this->db->getDbFilePath();
119			$this->output( " Copying database file $ourFile to $fileName... " );
120			MediaWiki\suppressWarnings( false );
121			if ( !copy( $ourFile, $fileName ) ) {
122			$err = error_get_last();
123			$this->error( " {$err['message']}" );
124			}
125			MediaWiki\suppressWarnings( true );
126			$this->output( " Releasing lock...\n" );
127			$this->db->query( 'COMMIT TRANSACTION', __METHOD__ );
128			}
129
130			private function checkSyntax() {
131			if ( !Sqlite::isPresent() ) {
132			$this->error( "Error: SQLite support not found\n" );
133			}
134			$files = [ $this->getOption( 'check-syntax' ) ];
135			$files = array_merge( $files, $this->mArgs );
136			$result = Sqlite::checkSqlSyntax( $files );
137			if ( $result === true ) {
138			$this->output( "SQL syntax check: no errors detected.\n" );
139			} else {
140			$this->error( "Error: $result\n" );
141			}
142			}
143			}
144
145			$maintClass = "SqliteMaintenance";
146			require_once RUN_MAINTENANCE_IF_MAIN;
147

wikimedia / mediawiki

SqliteMaintenance::getDbType() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SqliteMaintenance::getDbType() A
last analyzed 2016-11-13 17:42 UTC