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

UpdateSpecialPages::doSpecialPageCacheUpdates() C
last analyzed 2016-11-13 17:42 UTC

↳ Parent: UpdateSpecialPages

Complexity

Conditions	8
Paths	8

Size

Total Lines	37
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	25
nc	8
nop	1
dl	0
loc	37
rs	5.3846
c	0
b	0
f	0

<?php

/**
 * Update for cached special pages.
 * Run this script periodically if you have miser mode enabled.
 *
 * 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 to update cached special pages.
 *
 * @ingroup Maintenance
 */
class UpdateSpecialPages extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addOption( 'list', 'List special page names' );
		$this->addOption( 'only', 'Only update "page"; case sensitive, ' .
			'check correct case by calling this script with --list. ' .
			'Ex: --only=BrokenRedirects', false, true );
		$this->addOption( 'override', 'Also update pages that have updates disabled' );
	}

	public function execute() {
		global $wgQueryCacheLimit, $wgDisableQueryPageUpdate;

		$dbw = $this->getDB( DB_MASTER );

		$this->doSpecialPageCacheUpdates( $dbw );

		foreach ( QueryPage::getPages() as $page ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			list( $class, $special ) = $page;
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
			$limit = isset( $page[2] ) ? $page[2] : null;

			# --list : just show the name of pages
			if ( $this->hasOption( 'list' ) ) {
				$this->output( "$special [QueryPage]\n" );
				continue;
			}

			if ( !$this->hasOption( 'override' )
				&& $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate )
			) {
				$this->output( sprintf( "%-30s [QueryPage] disabled\n", $special ) );
				continue;
			}

			$specialObj = SpecialPageFactory::getPage( $special );
			if ( !$specialObj ) {
				$this->output( "No such special page: $special\n" );
				exit;

			}
			if ( $specialObj instanceof QueryPage ) {
				$queryPage = $specialObj;
			} else {
				$class = get_class( $specialObj );
				$this->error( "$class is not an instance of QueryPage.\n", 1 );
				die;

			}

			if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $queryPage->getName() ) {
				$this->output( sprintf( '%-30s [QueryPage] ', $special ) );
				if ( $queryPage->isExpensive() ) {
					$t1 = microtime( true );
					# Do the query
					$num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
					$t2 = microtime( true );
					if ( $num === false ) {
						$this->output( "FAILED: database error\n" );
					} else {
						$this->output( "got $num rows in " );

						$elapsed = $t2 - $t1;
						$hours = intval( $elapsed / 3600 );
						$minutes = intval( $elapsed % 3600 / 60 );
						$seconds = $elapsed - $hours * 3600 - $minutes * 60;
						if ( $hours ) {
							$this->output( $hours . 'h ' );
						}
						if ( $minutes ) {
							$this->output( $minutes . 'm ' );
						}
						$this->output( sprintf( "%.2fs\n", $seconds ) );
					}
					# Reopen any connections that have closed
					if ( !wfGetLB()->pingAll() ) {

						$this->output( "\n" );
						do {
							$this->error( "Connection failed, reconnecting in 10 seconds..." );
							sleep( 10 );
						} while ( !wfGetLB()->pingAll() );

						$this->output( "Reconnected\n\n" );
					}
					# Wait for the replica DB to catch up
					wfWaitForSlaves();

				} else {
					$this->output( "cheap, skipped\n" );
				}
				if ( $this->hasOption( 'only' ) ) {
					break;
				}
			}
		}
	}

	public function doSpecialPageCacheUpdates( $dbw ) {
		global $wgSpecialPageCacheUpdates;

		foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
			# --list : just show the name of pages
			if ( $this->hasOption( 'list' ) ) {
				$this->output( "$special [callback]\n" );
				continue;
			}

			if ( !$this->hasOption( 'only' ) || $this->getOption( 'only' ) == $special ) {
				if ( !is_callable( $call ) ) {
					$this->error( "Uncallable function $call!" );
					continue;
				}
				$this->output( sprintf( '%-30s [callback] ', $special ) );
				$t1 = microtime( true );
				call_user_func( $call, $dbw );
				$t2 = microtime( true );

				$this->output( "completed in " );
				$elapsed = $t2 - $t1;
				$hours = intval( $elapsed / 3600 );
				$minutes = intval( $elapsed % 3600 / 60 );
				$seconds = $elapsed - $hours * 3600 - $minutes * 60;
				if ( $hours ) {
					$this->output( $hours . 'h ' );
				}
				if ( $minutes ) {
					$this->output( $minutes . 'm ' );
				}
				$this->output( sprintf( "%.2fs\n", $seconds ) );
				# Wait for the replica DB to catch up
				wfWaitForSlaves();

			}
		}
	}
}

$maintClass = "UpdateSpecialPages";
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 32 and the first side effect is on line 25. 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			* Update for cached special pages.
4			* Run this script periodically if you have miser mode enabled.
5			*
6			* This program is free software; you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 2 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License along
17			* with this program; if not, write to the Free Software Foundation, Inc.,
18			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19			* http://www.gnu.org/copyleft/gpl.html
20			*
21			* @file
22			* @ingroup Maintenance
23			*/
24
25			require_once __DIR__ . '/Maintenance.php';
26
27			/**
28			* Maintenance script to update cached special pages.
29			*
30			* @ingroup Maintenance
31			*/
32			class UpdateSpecialPages extends Maintenance {
33			public function __construct() {
34			parent::__construct();
35			$this->addOption( 'list', 'List special page names' );
36			$this->addOption( 'only', 'Only update "page"; case sensitive, ' .
37			'check correct case by calling this script with --list. ' .
38			'Ex: --only=BrokenRedirects', false, true );
39			$this->addOption( 'override', 'Also update pages that have updates disabled' );
40			}
41
42			public function execute() {
43			global $wgQueryCacheLimit, $wgDisableQueryPageUpdate;
44
45			$dbw = $this->getDB( DB_MASTER );
46
47			$this->doSpecialPageCacheUpdates( $dbw );
48
49			foreach ( QueryPage::getPages() as $page ) {
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `\QueryPage::getPages()` of type `array<integer,array<inte...\":\"string\"}>"}>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
50			list( $class, $special ) = $page;
			0 ignored issues – show Unused Code introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The assignment to `$class` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
51			$limit = isset( $page[2] ) ? $page[2] : null;
52
53			# --list : just show the name of pages
54			if ( $this->hasOption( 'list' ) ) {
55			$this->output( "$special [QueryPage]\n" );
56			continue;
57			}
58
59			if ( !$this->hasOption( 'override' )
60			&& $wgDisableQueryPageUpdate && in_array( $special, $wgDisableQueryPageUpdate )
61			) {
62			$this->output( sprintf( "%-30s [QueryPage] disabled\n", $special ) );
63			continue;
64			}
65
66			$specialObj = SpecialPageFactory::getPage( $special );
67			if ( !$specialObj ) {
68			$this->output( "No such special page: $special\n" );
69			exit;
			0 ignored issues – show Coding Style Compatibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `execute()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
70			}
71			if ( $specialObj instanceof QueryPage ) {
72			$queryPage = $specialObj;
73			} else {
74			$class = get_class( $specialObj );
75			$this->error( "$class is not an instance of QueryPage.\n", 1 );
76			die;
			0 ignored issues – show Coding Style Compatibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `execute()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
77			}
78
79			if ( !$this->hasOption( 'only' ) \|\| $this->getOption( 'only' ) == $queryPage->getName() ) {
80			$this->output( sprintf( '%-30s [QueryPage] ', $special ) );
81			if ( $queryPage->isExpensive() ) {
82			$t1 = microtime( true );
83			# Do the query
84			$num = $queryPage->recache( $limit === null ? $wgQueryCacheLimit : $limit );
85			$t2 = microtime( true );
86			if ( $num === false ) {
87			$this->output( "FAILED: database error\n" );
88			} else {
89			$this->output( "got $num rows in " );
90
91			$elapsed = $t2 - $t1;
92			$hours = intval( $elapsed / 3600 );
93			$minutes = intval( $elapsed % 3600 / 60 );
94			$seconds = $elapsed - $hours * 3600 - $minutes * 60;
95			if ( $hours ) {
96			$this->output( $hours . 'h ' );
97			}
98			if ( $minutes ) {
99			$this->output( $minutes . 'm ' );
100			}
101			$this->output( sprintf( "%.2fs\n", $seconds ) );
102			}
103			# Reopen any connections that have closed
104			if ( !wfGetLB()->pingAll() ) {
			0 ignored issues – show Deprecated Code introduced 2016-04-11 17:35 UTC by Report Bug Copy Issue Report The function `wfGetLB()` has been deprecated with message: since 1.27, use MediaWikiServices::getDBLoadBalancer() or MediaWikiServices::getDBLoadBalancerFactory() instead. This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
105			$this->output( "\n" );
106			do {
107			$this->error( "Connection failed, reconnecting in 10 seconds..." );
108			sleep( 10 );
109			} while ( !wfGetLB()->pingAll() );
			0 ignored issues – show Deprecated Code introduced 2016-04-11 17:35 UTC by Report Bug Copy Issue Report The function `wfGetLB()` has been deprecated with message: since 1.27, use MediaWikiServices::getDBLoadBalancer() or MediaWikiServices::getDBLoadBalancerFactory() instead. This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
110			$this->output( "Reconnected\n\n" );
111			}
112			# Wait for the replica DB to catch up
113			wfWaitForSlaves();
			0 ignored issues – show Deprecated Code introduced 2016-01-25 18:14 UTC by Report Bug Copy Issue Report The function `wfWaitForSlaves()` has been deprecated with message: since 1.27 Use LBFactory::waitForReplication This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
114			} else {
115			$this->output( "cheap, skipped\n" );
116			}
117			if ( $this->hasOption( 'only' ) ) {
118			break;
119			}
120			}
121			}
122			}
123
124			public function doSpecialPageCacheUpdates( $dbw ) {
125			global $wgSpecialPageCacheUpdates;
126
127			foreach ( $wgSpecialPageCacheUpdates as $special => $call ) {
128			# --list : just show the name of pages
129			if ( $this->hasOption( 'list' ) ) {
130			$this->output( "$special [callback]\n" );
131			continue;
132			}
133
134			if ( !$this->hasOption( 'only' ) \|\| $this->getOption( 'only' ) == $special ) {
135			if ( !is_callable( $call ) ) {
136			$this->error( "Uncallable function $call!" );
137			continue;
138			}
139			$this->output( sprintf( '%-30s [callback] ', $special ) );
140			$t1 = microtime( true );
141			call_user_func( $call, $dbw );
142			$t2 = microtime( true );
143
144			$this->output( "completed in " );
145			$elapsed = $t2 - $t1;
146			$hours = intval( $elapsed / 3600 );
147			$minutes = intval( $elapsed % 3600 / 60 );
148			$seconds = $elapsed - $hours * 3600 - $minutes * 60;
149			if ( $hours ) {
150			$this->output( $hours . 'h ' );
151			}
152			if ( $minutes ) {
153			$this->output( $minutes . 'm ' );
154			}
155			$this->output( sprintf( "%.2fs\n", $seconds ) );
156			# Wait for the replica DB to catch up
157			wfWaitForSlaves();
			0 ignored issues – show Deprecated Code introduced 2016-01-25 18:14 UTC by Report Bug Copy Issue Report The function `wfWaitForSlaves()` has been deprecated with message: since 1.27 Use LBFactory::waitForReplication This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
158			}
159			}
160			}
161			}
162
163			$maintClass = "UpdateSpecialPages";
164			require_once RUN_MAINTENANCE_IF_MAIN;
165

wikimedia / mediawiki

UpdateSpecialPages::doSpecialPageCacheUpdates() C last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UpdateSpecialPages::doSpecialPageCacheUpdates() C
last analyzed 2016-11-13 17:42 UTC