Issues in rebuildFileCache.php (master) - Issues in master - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Issues (4122)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

maintenance/rebuildFileCache.php (4 issues)

Labels

Severity

Minor 4

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * Build file cache for content pages
 *
 * 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 builds file cache for content pages.
 *
 * @ingroup Maintenance
 */
class RebuildFileCache extends Maintenance {
	private $enabled = true;

	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Build file cache for content pages' );
		$this->addOption( 'start', 'Page_id to start from', false, true );
		$this->addOption( 'end', 'Page_id to end on', false, true );
		$this->addOption( 'overwrite', 'Refresh page cache' );
		$this->setBatchSize( 100 );
	}

	public function finalSetup() {
		global $wgDebugToolbar, $wgUseFileCache, $wgReadOnly;

		$this->enabled = $wgUseFileCache;
		// Script will handle capturing output and saving it itself
		$wgUseFileCache = false;
		// Debug toolbar makes content uncacheable so we disable it.
		// Has to be done before Setup.php initialize MWDebug
		$wgDebugToolbar = false;
		//  Avoid DB writes (like enotif/counters)
		$wgReadOnly = 'Building cache'; // avoid DB writes (like enotif/counters)

		parent::finalSetup();
	}

	public function execute() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		global $wgRequestTime;

		if ( !$this->enabled ) {
			$this->error( "Nothing to do -- \$wgUseFileCache is disabled.", true );
		}

		$start = $this->getOption( 'start', "0" );
		if ( !ctype_digit( $start ) ) {
			$this->error( "Invalid value for start parameter.", true );
		}
		$start = intval( $start );

		$end = $this->getOption( 'end', "0" );
		if ( !ctype_digit( $end ) ) {
			$this->error( "Invalid value for end parameter.", true );
		}
		$end = intval( $end );

		$this->output( "Building content page file cache from page {$start}!\n" );

		$dbr = $this->getDB( DB_REPLICA );
		$overwrite = $this->getOption( 'overwrite', false );
		$start = ( $start > 0 )
			? $start
			: $dbr->selectField( 'page', 'MIN(page_id)', false, __METHOD__ );
		$end = ( $end > 0 )
			? $end
			: $dbr->selectField( 'page', 'MAX(page_id)', false, __METHOD__ );
		if ( !$start ) {
			$this->error( "Nothing to do.", true );
		}

		$_SERVER['HTTP_ACCEPT_ENCODING'] = 'bgzip'; // hack, no real client

		# Do remaining chunk
		$end += $this->mBatchSize - 1;
		$blockStart = $start;
		$blockEnd = $start + $this->mBatchSize - 1;

		$dbw = $this->getDB( DB_MASTER );
		// Go through each page and save the output
		while ( $blockEnd <= $end ) {
			// Get the pages
			$res = $dbr->select( 'page',
				[ 'page_namespace', 'page_title', 'page_id' ],
				[ 'page_namespace' => MWNamespace::getContentNamespaces(),
					"page_id BETWEEN $blockStart AND $blockEnd" ],
				__METHOD__,
				[ 'ORDER BY' => 'page_id ASC', 'USE INDEX' => 'PRIMARY' ]
			);

			$this->beginTransaction( $dbw, __METHOD__ ); // for any changes
/** @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);
    }
}
			foreach ( $res as $row ) {
				$rebuilt = false;

				$title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
				if ( null == $title ) {
					$this->output( "Page {$row->page_id} has bad title\n" );
					continue; // broken title?
				}

				$context = new RequestContext();
				$context->setTitle( $title );
				$article = Article::newFromTitle( $title, $context );
				$context->setWikiPage( $article->getPage() );

				// If the article is cacheable, then load it
				if ( $article->isFileCacheable( HTMLFileCache::MODE_REBUILD ) ) {
					$viewCache = new HTMLFileCache( $title, 'view' );
					$historyCache = new HTMLFileCache( $title, 'history' );
					if ( $viewCache->isCacheGood() && $historyCache->isCacheGood() ) {
						if ( $overwrite ) {
							$rebuilt = true;
						} else {
							$this->output( "Page '$title' (id {$row->page_id}) already cached\n" );
							continue; // done already!
						}
					}

					MediaWiki\suppressWarnings(); // header notices
					// Cache ?action=view
					$wgRequestTime = microtime( true ); # bug 22852
					ob_start();
					$article->view();
					$context->getOutput()->output();
					$context->getOutput()->clearHTML();
					$viewHtml = ob_get_clean();
					$viewCache->saveToFileCache( $viewHtml );
					// Cache ?action=history
					$wgRequestTime = microtime( true ); # bug 22852
					ob_start();
					Action::factory( 'history', $article, $context )->show();
					$context->getOutput()->output();
					$context->getOutput()->clearHTML();
					$historyHtml = ob_get_clean();
					$historyCache->saveToFileCache( $historyHtml );
					MediaWiki\restoreWarnings();

					if ( $rebuilt ) {
						$this->output( "Re-cached page '$title' (id {$row->page_id})..." );
					} else {
						$this->output( "Cached page '$title' (id {$row->page_id})..." );
					}
					$this->output( "[view: " . strlen( $viewHtml ) . " bytes; " .
						"history: " . strlen( $historyHtml ) . " bytes]\n" );
				} else {
					$this->output( "Page '$title' (id {$row->page_id}) not cacheable\n" );
				}
			}
			$this->commitTransaction( $dbw, __METHOD__ ); // commit any changes (just for sanity)
/** @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);
    }
}

			$blockStart += $this->mBatchSize;
			$blockEnd += $this->mBatchSize;
		}
		$this->output( "Done!\n" );
	}
}

$maintClass = "RebuildFileCache";
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 Show Similar Issues like this 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		* Build file cache for content pages
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 builds file cache for content pages.
28		*
29		* @ingroup Maintenance
30		*/
31		class RebuildFileCache extends Maintenance {
32		private $enabled = true;
33
34	View Code Duplication	public function __construct() {
35		parent::__construct();
36		$this->addDescription( 'Build file cache for content pages' );
37		$this->addOption( 'start', 'Page_id to start from', false, true );
38		$this->addOption( 'end', 'Page_id to end on', false, true );
39		$this->addOption( 'overwrite', 'Refresh page cache' );
40		$this->setBatchSize( 100 );
41		}
42
43		public function finalSetup() {
44		global $wgDebugToolbar, $wgUseFileCache, $wgReadOnly;
45
46		$this->enabled = $wgUseFileCache;
47		// Script will handle capturing output and saving it itself
48		$wgUseFileCache = false;
49		// Debug toolbar makes content uncacheable so we disable it.
50		// Has to be done before Setup.php initialize MWDebug
51		$wgDebugToolbar = false;
52		// Avoid DB writes (like enotif/counters)
53		$wgReadOnly = 'Building cache'; // avoid DB writes (like enotif/counters)
54
55		parent::finalSetup();
56		}
57
58		public function execute() {
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Show Similar Issues like this `execute` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
59		global $wgRequestTime;
60
61		if ( !$this->enabled ) {
62		$this->error( "Nothing to do -- \$wgUseFileCache is disabled.", true );
63		}
64
65		$start = $this->getOption( 'start', "0" );
66		if ( !ctype_digit( $start ) ) {
67		$this->error( "Invalid value for start parameter.", true );
68		}
69		$start = intval( $start );
70
71		$end = $this->getOption( 'end', "0" );
72		if ( !ctype_digit( $end ) ) {
73		$this->error( "Invalid value for end parameter.", true );
74		}
75		$end = intval( $end );
76
77		$this->output( "Building content page file cache from page {$start}!\n" );
78
79		$dbr = $this->getDB( DB_REPLICA );
80		$overwrite = $this->getOption( 'overwrite', false );
81		$start = ( $start > 0 )
82		? $start
83		: $dbr->selectField( 'page', 'MIN(page_id)', false, __METHOD__ );
84		$end = ( $end > 0 )
85		? $end
86		: $dbr->selectField( 'page', 'MAX(page_id)', false, __METHOD__ );
87		if ( !$start ) {
88		$this->error( "Nothing to do.", true );
89		}
90
91		$_SERVER['HTTP_ACCEPT_ENCODING'] = 'bgzip'; // hack, no real client
92
93		# Do remaining chunk
94		$end += $this->mBatchSize - 1;
95		$blockStart = $start;
96		$blockEnd = $start + $this->mBatchSize - 1;
97
98		$dbw = $this->getDB( DB_MASTER );
99		// Go through each page and save the output
100		while ( $blockEnd <= $end ) {
101		// Get the pages
102		$res = $dbr->select( 'page',
103		[ 'page_namespace', 'page_title', 'page_id' ],
104		[ 'page_namespace' => MWNamespace::getContentNamespaces(),
105		"page_id BETWEEN $blockStart AND $blockEnd" ],
106		__METHOD__,
107		[ 'ORDER BY' => 'page_id ASC', 'USE INDEX' => 'PRIMARY' ]
108		);
109
110		$this->beginTransaction( $dbw, __METHOD__ ); // for any changes
		0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `98` can be `null`; however, `Maintenance::beginTransaction()` 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...
111		foreach ( $res as $row ) {
112		$rebuilt = false;
113
114		$title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
115		if ( null == $title ) {
116		$this->output( "Page {$row->page_id} has bad title\n" );
117		continue; // broken title?
118		}
119
120		$context = new RequestContext();
121		$context->setTitle( $title );
122		$article = Article::newFromTitle( $title, $context );
123		$context->setWikiPage( $article->getPage() );
124
125		// If the article is cacheable, then load it
126		if ( $article->isFileCacheable( HTMLFileCache::MODE_REBUILD ) ) {
127		$viewCache = new HTMLFileCache( $title, 'view' );
128		$historyCache = new HTMLFileCache( $title, 'history' );
129		if ( $viewCache->isCacheGood() && $historyCache->isCacheGood() ) {
130		if ( $overwrite ) {
131		$rebuilt = true;
132		} else {
133		$this->output( "Page '$title' (id {$row->page_id}) already cached\n" );
134		continue; // done already!
135		}
136		}
137
138		MediaWiki\suppressWarnings(); // header notices
139		// Cache ?action=view
140		$wgRequestTime = microtime( true ); # bug 22852
141		ob_start();
142		$article->view();
143		$context->getOutput()->output();
144		$context->getOutput()->clearHTML();
145		$viewHtml = ob_get_clean();
146		$viewCache->saveToFileCache( $viewHtml );
147		// Cache ?action=history
148		$wgRequestTime = microtime( true ); # bug 22852
149		ob_start();
150		Action::factory( 'history', $article, $context )->show();
151		$context->getOutput()->output();
152		$context->getOutput()->clearHTML();
153		$historyHtml = ob_get_clean();
154		$historyCache->saveToFileCache( $historyHtml );
155		MediaWiki\restoreWarnings();
156
157		if ( $rebuilt ) {
158		$this->output( "Re-cached page '$title' (id {$row->page_id})..." );
159		} else {
160		$this->output( "Cached page '$title' (id {$row->page_id})..." );
161		}
162		$this->output( "[view: " . strlen( $viewHtml ) . " bytes; " .
163		"history: " . strlen( $historyHtml ) . " bytes]\n" );
164		} else {
165		$this->output( "Page '$title' (id {$row->page_id}) not cacheable\n" );
166		}
167		}
168		$this->commitTransaction( $dbw, __METHOD__ ); // commit any changes (just for sanity)
		0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `98` can be `null`; however, `Maintenance::commitTransaction()` 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...
169
170		$blockStart += $this->mBatchSize;
171		$blockEnd += $this->mBatchSize;
172		}
173		$this->output( "Done!\n" );
174		}
175		}
176
177		$maintClass = "RebuildFileCache";
178		require_once RUN_MAINTENANCE_IF_MAIN;
179

wikimedia / mediawiki

Issues (4122)

Security Analysis not enabled

maintenance/rebuildFileCache.php (4 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like