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

PurgeParserCache::showProgress() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: PurgeParserCache

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	2
nop	1
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Remove old objects from the parser cache.
 * This only works when the parser cache is in an SQL database.
 *
 * 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 __DIR__ . '/Maintenance.php';

/**
 * Maintenance script to remove old objects from the parser cache.
 *
 * @ingroup Maintenance
 */
class PurgeParserCache extends Maintenance {
	public $lastProgress;

	function __construct() {
		parent::__construct();
		$this->addDescription( "Remove old objects from the parser cache. " .
			"This only works when the parser cache is in an SQL database." );
		$this->addOption( 'expiredate', 'Delete objects expiring before this date.', false, true );
		$this->addOption(
			'age',
			'Delete objects created more than this many seconds ago, assuming $wgParserCacheExpireTime ' .
				'has been consistent.',
			false, true );
	}

	function execute() {
		$inputDate = $this->getOption( 'expiredate' );
		$inputAge = $this->getOption( 'age' );
		if ( $inputDate !== null ) {
			$date = wfTimestamp( TS_MW, strtotime( $inputDate ) );
		} elseif ( $inputAge !== null ) {
			global $wgParserCacheExpireTime;
			$date = wfTimestamp( TS_MW, time() + $wgParserCacheExpireTime - intval( $inputAge ) );
		} else {
			$this->error( "Must specify either --expiredate or --age", 1 );
		}

		$english = Language::factory( 'en' );
		$this->output( "Deleting objects expiring before " . $english->timeanddate( $date ) . "\n" );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

		$pc = wfGetParserCacheStorage();
		$success = $pc->deleteObjectsExpiringBefore( $date, [ $this, 'showProgress' ] );

		if ( !$success ) {
			$this->error( "\nCannot purge this kind of parser cache.", 1 );
		}
		$this->showProgress( 100 );
		$this->output( "\nDone\n" );
	}

	function showProgress( $percent ) {
		$percentString = sprintf( "%.2f", $percent );
		if ( $percentString === $this->lastProgress ) {
			return;
		}
		$this->lastProgress = $percentString;

		$stars = floor( $percent / 2 );
		$this->output( '[' . str_repeat( '*', $stars ) . str_repeat( '.', 50 - $stars ) . '] ' .
			"$percentString%\r" );
	}
}

$maintClass = 'PurgeParserCache';
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			* Remove old objects from the parser cache.
4			* This only works when the parser cache is in an SQL database.
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 __DIR__ . '/Maintenance.php';
26
27			/**
28			* Maintenance script to remove old objects from the parser cache.
29			*
30			* @ingroup Maintenance
31			*/
32			class PurgeParserCache extends Maintenance {
33			public $lastProgress;
34
35			function __construct() {
36			parent::__construct();
37			$this->addDescription( "Remove old objects from the parser cache. " .
38			"This only works when the parser cache is in an SQL database." );
39			$this->addOption( 'expiredate', 'Delete objects expiring before this date.', false, true );
40			$this->addOption(
41			'age',
42			'Delete objects created more than this many seconds ago, assuming $wgParserCacheExpireTime ' .
43			'has been consistent.',
44			false, true );
45			}
46
47			function execute() {
48			$inputDate = $this->getOption( 'expiredate' );
49			$inputAge = $this->getOption( 'age' );
50			if ( $inputDate !== null ) {
51			$date = wfTimestamp( TS_MW, strtotime( $inputDate ) );
52			} elseif ( $inputAge !== null ) {
53			global $wgParserCacheExpireTime;
54			$date = wfTimestamp( TS_MW, time() + $wgParserCacheExpireTime - intval( $inputAge ) );
55			} else {
56			$this->error( "Must specify either --expiredate or --age", 1 );
57			}
58
59			$english = Language::factory( 'en' );
60			$this->output( "Deleting objects expiring before " . $english->timeanddate( $date ) . "\n" );
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The variable `$date` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$date` can also be of type `false`; however, `Language::timeanddate()` does only seem to accept `string`, did you maybe forget to handle an error condition? Loading history...
61
62			$pc = wfGetParserCacheStorage();
63			$success = $pc->deleteObjectsExpiringBefore( $date, [ $this, 'showProgress' ] );
			0 ignored issues – show Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$date` can also be of type `false`; however, `BagOStuff::deleteObjectsExpiringBefore()` does only seem to accept `string`, did you maybe forget to handle an error condition? Loading history...
64			if ( !$success ) {
65			$this->error( "\nCannot purge this kind of parser cache.", 1 );
66			}
67			$this->showProgress( 100 );
68			$this->output( "\nDone\n" );
69			}
70
71			function showProgress( $percent ) {
72			$percentString = sprintf( "%.2f", $percent );
73			if ( $percentString === $this->lastProgress ) {
74			return;
75			}
76			$this->lastProgress = $percentString;
77
78			$stars = floor( $percent / 2 );
79			$this->output( '[' . str_repeat( '*', $stars ) . str_repeat( '.', 50 - $stars ) . '] ' .
80			"$percentString%\r" );
81			}
82			}
83
84			$maintClass = 'PurgeParserCache';
85			require_once RUN_MAINTENANCE_IF_MAIN;
86

wikimedia / mediawiki

PurgeParserCache::showProgress() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

PurgeParserCache::showProgress() A
last analyzed 2016-11-13 17:42 UTC