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

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

↳ Parent: UpdateSearchIndex

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

/**
 * Periodic off-peak updating of the search index.
 *
 * Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
 * Where START is the starting timestamp
 * END is the ending timestamp
 * POSFILE is a file to load timestamps from and save them to, searchUpdate.WIKI_ID.pos by default
 * LOCKTIME is how long the searchindex and revision tables will be locked for
 * -q means quiet
 *
 * 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 for periodic off-peak updating of the search index.
 *
 * @ingroup Maintenance
 */
class UpdateSearchIndex extends Maintenance {

	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Script for periodic off-peak updating of the search index' );
		$this->addOption( 's', 'starting timestamp', false, true );
		$this->addOption( 'e', 'Ending timestamp', false, true );
		$this->addOption(
			'p',
			'File for saving/loading timestamps, searchUpdate.WIKI_ID.pos by default',
			false,
			true
		);
		$this->addOption(
			'l',
			'How long the searchindex and revision tables will be locked for',
			false,
			true
		);
	}

	public function getDbType() {
		return Maintenance::DB_ADMIN;
	}

	public function execute() {
		$posFile = $this->getOption( 'p', 'searchUpdate.' . wfWikiID() . '.pos' );
		$end = $this->getOption( 'e', wfTimestampNow() );
		if ( $this->hasOption( 's' ) ) {
			$start = $this->getOption( 's' );
		} elseif ( is_readable( 'searchUpdate.pos' ) ) {
			# B/c to the old position file name which was hardcoded
			# We can safely delete the file when we're done though.
			$start = file_get_contents( 'searchUpdate.pos' );
			unlink( 'searchUpdate.pos' );
		} elseif ( is_readable( $posFile ) ) {
			$start = file_get_contents( $posFile );
		} else {
			$start = wfTimestamp( TS_MW, time() - 86400 );
		}
		$lockTime = $this->getOption( 'l', 20 );

		$this->doUpdateSearchIndex( $start, $end, $lockTime );
		if ( is_writable( dirname( realpath( $posFile ) ) ) ) {
			$file = fopen( $posFile, 'w' );
			if ( $file !== false ) {
				fwrite( $file, $end );
				fclose( $file );
			} else {
				$this->error( "*** Couldn't write to the $posFile!\n" );
			}
		} else {
			$this->error( "*** Couldn't write to the $posFile!\n" );
		}
	}

	private function doUpdateSearchIndex( $start, $end, $maxLockTime ) {
		global $wgDisableSearchUpdate;

		$wgDisableSearchUpdate = false;

		$dbw = $this->getDB( DB_MASTER );
		$recentchanges = $dbw->tableName( 'recentchanges' );

		$this->output( "Updating searchindex between $start and $end\n" );

		# Select entries from recentchanges which are on top and between the specified times
		$start = $dbw->timestamp( $start );
		$end = $dbw->timestamp( $end );

		$page = $dbw->tableName( 'page' );
		$sql = "SELECT rc_cur_id FROM $recentchanges
			JOIN $page ON rc_cur_id=page_id AND rc_this_oldid=page_latest
			WHERE rc_type != " . RC_LOG . " AND rc_timestamp BETWEEN '$start' AND '$end'";
		$res = $dbw->query( $sql, __METHOD__ );

		$this->updateSearchIndex( $maxLockTime, [ $this, 'searchIndexUpdateCallback' ], $dbw, $res );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$this->output( "Done\n" );
	}

	public function searchIndexUpdateCallback( $dbw, $row ) {
		$this->updateSearchIndexForPage( $dbw, $row->rc_cur_id );
	}
}

$maintClass = "UpdateSearchIndex";
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 38 and the first side effect is on line 31. 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			* Periodic off-peak updating of the search index.
4			*
5			* Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
6			* Where START is the starting timestamp
7			* END is the ending timestamp
8			* POSFILE is a file to load timestamps from and save them to, searchUpdate.WIKI_ID.pos by default
9			* LOCKTIME is how long the searchindex and revision tables will be locked for
10			* -q means quiet
11			*
12			* This program is free software; you can redistribute it and/or modify
13			* it under the terms of the GNU General Public License as published by
14			* the Free Software Foundation; either version 2 of the License, or
15			* (at your option) any later version.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU General Public License for more details.
21			*
22			* You should have received a copy of the GNU General Public License along
23			* with this program; if not, write to the Free Software Foundation, Inc.,
24			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25			* http://www.gnu.org/copyleft/gpl.html
26			*
27			* @file
28			* @ingroup Maintenance
29			*/
30
31			require_once __DIR__ . '/Maintenance.php';
32
33			/**
34			* Maintenance script for periodic off-peak updating of the search index.
35			*
36			* @ingroup Maintenance
37			*/
38			class UpdateSearchIndex extends Maintenance {
39
40			public function __construct() {
41			parent::__construct();
42			$this->addDescription( 'Script for periodic off-peak updating of the search index' );
43			$this->addOption( 's', 'starting timestamp', false, true );
44			$this->addOption( 'e', 'Ending timestamp', false, true );
45			$this->addOption(
46			'p',
47			'File for saving/loading timestamps, searchUpdate.WIKI_ID.pos by default',
48			false,
49			true
50			);
51			$this->addOption(
52			'l',
53			'How long the searchindex and revision tables will be locked for',
54			false,
55			true
56			);
57			}
58
59			public function getDbType() {
60			return Maintenance::DB_ADMIN;
61			}
62
63			public function execute() {
64			$posFile = $this->getOption( 'p', 'searchUpdate.' . wfWikiID() . '.pos' );
65			$end = $this->getOption( 'e', wfTimestampNow() );
66			if ( $this->hasOption( 's' ) ) {
67			$start = $this->getOption( 's' );
68			} elseif ( is_readable( 'searchUpdate.pos' ) ) {
69			# B/c to the old position file name which was hardcoded
70			# We can safely delete the file when we're done though.
71			$start = file_get_contents( 'searchUpdate.pos' );
72			unlink( 'searchUpdate.pos' );
73			} elseif ( is_readable( $posFile ) ) {
74			$start = file_get_contents( $posFile );
75			} else {
76			$start = wfTimestamp( TS_MW, time() - 86400 );
77			}
78			$lockTime = $this->getOption( 'l', 20 );
79
80			$this->doUpdateSearchIndex( $start, $end, $lockTime );
81			if ( is_writable( dirname( realpath( $posFile ) ) ) ) {
82			$file = fopen( $posFile, 'w' );
83			if ( $file !== false ) {
84			fwrite( $file, $end );
85			fclose( $file );
86			} else {
87			$this->error( "*** Couldn't write to the $posFile!\n" );
88			}
89			} else {
90			$this->error( "*** Couldn't write to the $posFile!\n" );
91			}
92			}
93
94			private function doUpdateSearchIndex( $start, $end, $maxLockTime ) {
95			global $wgDisableSearchUpdate;
96
97			$wgDisableSearchUpdate = false;
98
99			$dbw = $this->getDB( DB_MASTER );
100			$recentchanges = $dbw->tableName( 'recentchanges' );
101
102			$this->output( "Updating searchindex between $start and $end\n" );
103
104			# Select entries from recentchanges which are on top and between the specified times
105			$start = $dbw->timestamp( $start );
106			$end = $dbw->timestamp( $end );
107
108			$page = $dbw->tableName( 'page' );
109			$sql = "SELECT rc_cur_id FROM $recentchanges
110			JOIN $page ON rc_cur_id=page_id AND rc_this_oldid=page_latest
111			WHERE rc_type != " . RC_LOG . " AND rc_timestamp BETWEEN '$start' AND '$end'";
112			$res = $dbw->query( $sql, __METHOD__ );
113
114			$this->updateSearchIndex( $maxLockTime, [ $this, 'searchIndexUpdateCallback' ], $dbw, $res );
			0 ignored issues – show Bug introduced 2016-09-29 17:29 UTC by Report Bug Copy Issue Report It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `99` can be `null`; however, `Maintenance::updateSearchIndex()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
115
116			$this->output( "Done\n" );
117			}
118
119			public function searchIndexUpdateCallback( $dbw, $row ) {
120			$this->updateSearchIndexForPage( $dbw, $row->rc_cur_id );
121			}
122			}
123
124			$maintClass = "UpdateSearchIndex";
125			require_once RUN_MAINTENANCE_IF_MAIN;
126

wikimedia / mediawiki

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

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

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