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

RefreshImageMetadata::setupParameters() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: RefreshImageMetadata

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	8
nc	4
nop	2
dl	0
loc	13
rs	9.2
c	0
b	0
f	0

<?php

/**
 * Refresh image metadata fields. See also rebuildImages.php
 *
 * Usage: php refreshImageMetadata.php
 *
 * Copyright © 2011 Brian Wolff
 * https://www.mediawiki.org/
 *
 * 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
 * @author Brian Wolff
 * @ingroup Maintenance
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script to refresh image metadata fields.
 *
 * @ingroup Maintenance
 */
class RefreshImageMetadata extends Maintenance {

	/**
	 * @var Database
	 */
	protected $dbw;

	function __construct() {
		parent::__construct();

		$this->addDescription( 'Script to update image metadata records' );
		$this->setBatchSize( 200 );

		$this->addOption(
			'force',
			'Reload metadata from file even if the metadata looks ok',
			false,
			false,
			'f'
		);
		$this->addOption(
			'broken-only',
			'Only fix really broken records, leave old but still compatible records alone.'
		);
		$this->addOption(
			'verbose',
			'Output extra information about each upgraded/non-upgraded file.',
			false,
			false,
			'v'
		);
		$this->addOption( 'start', 'Name of file to start with', false, true );
		$this->addOption( 'end', 'Name of file to end with', false, true );

		$this->addOption(
			'mediatype',
			'Only refresh files with this media type, e.g. BITMAP, UNKNOWN etc.',
			false,
			true
		);
		$this->addOption(
			'mime',
			"Only refresh files with this MIME type. Can accept wild-card 'image/*'. "
				. "Potentially inefficient unless 'mediatype' is also specified",
			false,
			true
		);
		$this->addOption(
			'metadata-contains',
			'(Inefficient!) Only refresh files where the img_metadata field '
				. 'contains this string. Can be used if its known a specific '
				. 'property was being extracted incorrectly.',
			false,
			true
		);
	}

	public function execute() {
		$force = $this->hasOption( 'force' );
		$brokenOnly = $this->hasOption( 'broken-only' );
		$verbose = $this->hasOption( 'verbose' );
		$start = $this->getOption( 'start', false );
		$this->setupParameters( $force, $brokenOnly );

		$upgraded = 0;
		$leftAlone = 0;
		$error = 0;

		$dbw = $this->getDB( DB_MASTER );
		if ( $this->mBatchSize <= 0 ) {
			$this->error( "Batch size is too low...", 12 );
		}

		$repo = RepoGroup::singleton()->getLocalRepo();
		$conds = $this->getConditions( $dbw );
/** @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);
    }
}

		// For the WHERE img_name > 'foo' condition that comes after doing a batch
		$conds2 = [];
		if ( $start !== false ) {
			$conds2[] = 'img_name >= ' . $dbw->addQuotes( $start );
		}

		$options = [
			'LIMIT' => $this->mBatchSize,
			'ORDER BY' => 'img_name ASC',
		];

		do {
			$res = $dbw->select(
				'image',
				'*',
				array_merge( $conds, $conds2 ),
				__METHOD__,
				$options
			);

			if ( $res->numRows() > 0 ) {
				$row1 = $res->current();
				$this->output( "Processing next {$this->mBatchSize} rows starting with {$row1->img_name}.\n" );
				$res->rewind();
			} else {
				$this->error( "No images to process.", 4 );
			}

			foreach ( $res as $row ) {
				// LocalFile will upgrade immediately here if obsolete
				$file = $repo->newFileFromRow( $row );
				if ( $file->getUpgraded() ) {
					// File was upgraded.
					$upgraded++;
					$newLength = strlen( $file->getMetadata() );
					$oldLength = strlen( $row->img_metadata );
					if ( $newLength < $oldLength - 5 ) {
						// If after updating, the metadata is smaller then
						// what it was before, that's probably not a good thing
						// because we extract more data with time, not less.
						// Thus this probably indicates an error of some sort,
						// or at the very least is suspicious. Have the - 5 just
						// to weed out any inconsequential changes.
						$error++;
						$this->output( "Warning: File:{$row->img_name} used to have " .
							"$oldLength bytes of metadata but now has $newLength bytes.\n" );
					} elseif ( $verbose ) {
						$this->output( "Refreshed File:{$row->img_name}.\n" );
					}
				} else {
					$leftAlone++;
					if ( $force ) {
						$file->upgradeRow();
						$newLength = strlen( $file->getMetadata() );
						$oldLength = strlen( $row->img_metadata );
						if ( $newLength < $oldLength - 5 ) {
							$error++;
							$this->output( "Warning: File:{$row->img_name} used to have " .
								"$oldLength bytes of metadata but now has $newLength bytes. (forced)\n" );
						}
						if ( $verbose ) {
							$this->output( "Forcibly refreshed File:{$row->img_name}.\n" );
						}
					} else {
						if ( $verbose ) {
							$this->output( "Skipping File:{$row->img_name}.\n" );
						}
					}
				}
			}
			$conds2 = [ 'img_name > ' . $dbw->addQuotes( $row->img_name ) ];
foreach ($a as $b) {
}

// $b is defined here only if $a has elements, for example if $a is array()
// then $b would not be defined here. To avoid that, we recommend to set a
// default value for $b.


// Better
$b = 0; // or whatever default makes sense in your context
foreach ($a as $b) {
}

// $b is now guaranteed to be defined here.
			wfWaitForSlaves();

		} while ( $res->numRows() === $this->mBatchSize );

		$total = $upgraded + $leftAlone;
		if ( $force ) {
			$this->output( "\nFinished refreshing file metadata for $total files. "
				. "$upgraded needed to be refreshed, $leftAlone did not need to "
				. "be but were refreshed anyways, and $error refreshes were suspicious.\n" );
		} else {
			$this->output( "\nFinished refreshing file metadata for $total files. "
				. "$upgraded were refreshed, $leftAlone were already up to date, "
				. "and $error refreshes were suspicious.\n" );
		}
	}

	/**
	 * @param Database $dbw
	 * @return array
	 */
	function getConditions( $dbw ) {
		$conds = [];

		$end = $this->getOption( 'end', false );
		$mime = $this->getOption( 'mime', false );
		$mediatype = $this->getOption( 'mediatype', false );
		$like = $this->getOption( 'metadata-contains', false );

		if ( $end !== false ) {
			$conds[] = 'img_name <= ' . $dbw->addQuotes( $end );
		}
		if ( $mime !== false ) {
			list( $major, $minor ) = File::splitMime( $mime );
			$conds['img_major_mime'] = $major;
			if ( $minor !== '*' ) {
				$conds['img_minor_mime'] = $minor;
			}
		}
		if ( $mediatype !== false ) {
			$conds['img_media_type'] = $mediatype;
		}
		if ( $like ) {
			$conds[] = 'img_metadata ' . $dbw->buildLike( $dbw->anyString(), $like, $dbw->anyString() );
		}

		return $conds;
	}

	/**
	 * @param bool $force
	 * @param bool $brokenOnly
	 */
	function setupParameters( $force, $brokenOnly ) {
		global $wgUpdateCompatibleMetadata;

		if ( $brokenOnly ) {
			$wgUpdateCompatibleMetadata = false;
		} else {
			$wgUpdateCompatibleMetadata = true;
		}

		if ( $brokenOnly && $force ) {
			$this->error( 'Cannot use --broken-only and --force together. ', 2 );
		}
	}
}

$maintClass = 'RefreshImageMetadata';
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 37 and the first side effect is on line 30. 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		* Refresh image metadata fields. See also rebuildImages.php
4		*
5		* Usage: php refreshImageMetadata.php
6		*
7		* Copyright © 2011 Brian Wolff
8		* https://www.mediawiki.org/
9		*
10		* This program is free software; you can redistribute it and/or modify
11		* it under the terms of the GNU General Public License as published by
12		* the Free Software Foundation; either version 2 of the License, or
13		* (at your option) any later version.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU General Public License for more details.
19		*
20		* You should have received a copy of the GNU General Public License along
21		* with this program; if not, write to the Free Software Foundation, Inc.,
22		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23		* http://www.gnu.org/copyleft/gpl.html
24		*
25		* @file
26		* @author Brian Wolff
27		* @ingroup Maintenance
28		*/
29
30		require_once __DIR__ . '/Maintenance.php';
31
32		/**
33		* Maintenance script to refresh image metadata fields.
34		*
35		* @ingroup Maintenance
36		*/
37		class RefreshImageMetadata extends Maintenance {
38
39		/**
40		* @var Database
41		*/
42		protected $dbw;
43
44		function __construct() {
45		parent::__construct();
46
47		$this->addDescription( 'Script to update image metadata records' );
48		$this->setBatchSize( 200 );
49
50		$this->addOption(
51		'force',
52		'Reload metadata from file even if the metadata looks ok',
53		false,
54		false,
55		'f'
56		);
57		$this->addOption(
58		'broken-only',
59		'Only fix really broken records, leave old but still compatible records alone.'
60		);
61		$this->addOption(
62		'verbose',
63		'Output extra information about each upgraded/non-upgraded file.',
64		false,
65		false,
66		'v'
67		);
68		$this->addOption( 'start', 'Name of file to start with', false, true );
69		$this->addOption( 'end', 'Name of file to end with', false, true );
70
71		$this->addOption(
72		'mediatype',
73		'Only refresh files with this media type, e.g. BITMAP, UNKNOWN etc.',
74		false,
75		true
76		);
77		$this->addOption(
78		'mime',
79		"Only refresh files with this MIME type. Can accept wild-card 'image/*'. "
80		. "Potentially inefficient unless 'mediatype' is also specified",
81		false,
82		true
83		);
84		$this->addOption(
85		'metadata-contains',
86		'(Inefficient!) Only refresh files where the img_metadata field '
87		. 'contains this string. Can be used if its known a specific '
88		. 'property was being extracted incorrectly.',
89		false,
90		true
91		);
92		}
93
94		public function execute() {
95		$force = $this->hasOption( 'force' );
96		$brokenOnly = $this->hasOption( 'broken-only' );
97		$verbose = $this->hasOption( 'verbose' );
98		$start = $this->getOption( 'start', false );
99		$this->setupParameters( $force, $brokenOnly );
100
101		$upgraded = 0;
102		$leftAlone = 0;
103		$error = 0;
104
105		$dbw = $this->getDB( DB_MASTER );
106		if ( $this->mBatchSize <= 0 ) {
107		$this->error( "Batch size is too low...", 12 );
108		}
109
110		$repo = RepoGroup::singleton()->getLocalRepo();
111		$conds = $this->getConditions( $dbw );
		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 `105` can be `null`; however, `RefreshImageMetadata::getConditions()` 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...
112
113		// For the WHERE img_name > 'foo' condition that comes after doing a batch
114		$conds2 = [];
115		if ( $start !== false ) {
116		$conds2[] = 'img_name >= ' . $dbw->addQuotes( $start );
117		}
118
119		$options = [
120		'LIMIT' => $this->mBatchSize,
121		'ORDER BY' => 'img_name ASC',
122		];
123
124		do {
125		$res = $dbw->select(
126		'image',
127		'*',
128		array_merge( $conds, $conds2 ),
129		__METHOD__,
130		$options
131		);
132
133		if ( $res->numRows() > 0 ) {
134		$row1 = $res->current();
135		$this->output( "Processing next {$this->mBatchSize} rows starting with {$row1->img_name}.\n" );
136		$res->rewind();
137		} else {
138		$this->error( "No images to process.", 4 );
139		}
140
141		foreach ( $res as $row ) {
142		// LocalFile will upgrade immediately here if obsolete
143		$file = $repo->newFileFromRow( $row );
144		if ( $file->getUpgraded() ) {
145		// File was upgraded.
146		$upgraded++;
147		$newLength = strlen( $file->getMetadata() );
148		$oldLength = strlen( $row->img_metadata );
149	View Code Duplication	if ( $newLength < $oldLength - 5 ) {
150		// If after updating, the metadata is smaller then
151		// what it was before, that's probably not a good thing
152		// because we extract more data with time, not less.
153		// Thus this probably indicates an error of some sort,
154		// or at the very least is suspicious. Have the - 5 just
155		// to weed out any inconsequential changes.
156		$error++;
157		$this->output( "Warning: File:{$row->img_name} used to have " .
158		"$oldLength bytes of metadata but now has $newLength bytes.\n" );
159		} elseif ( $verbose ) {
160		$this->output( "Refreshed File:{$row->img_name}.\n" );
161		}
162		} else {
163		$leftAlone++;
164		if ( $force ) {
165		$file->upgradeRow();
166		$newLength = strlen( $file->getMetadata() );
167		$oldLength = strlen( $row->img_metadata );
168	View Code Duplication	if ( $newLength < $oldLength - 5 ) {
169		$error++;
170		$this->output( "Warning: File:{$row->img_name} used to have " .
171		"$oldLength bytes of metadata but now has $newLength bytes. (forced)\n" );
172		}
173		if ( $verbose ) {
174		$this->output( "Forcibly refreshed File:{$row->img_name}.\n" );
175		}
176		} else {
177		if ( $verbose ) {
178		$this->output( "Skipping File:{$row->img_name}.\n" );
179		}
180		}
181		}
182		}
183		$conds2 = [ 'img_name > ' . $dbw->addQuotes( $row->img_name ) ];
		0 ignored issues – show Bug introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report The variable `$row` seems to be defined by a `foreach` iteration on line `141`. Are you sure the iterator is never empty, otherwise this variable is not defined? It seems like you are relying on a variable being defined by an iteration: foreach ($a as $b) { } // $b is defined here only if $a has elements, for example if $a is array() // then $b would not be defined here. To avoid that, we recommend to set a // default value for $b. // Better $b = 0; // or whatever default makes sense in your context foreach ($a as $b) { } // $b is now guaranteed to be defined here. Loading history...
184		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...
185		} while ( $res->numRows() === $this->mBatchSize );
186
187		$total = $upgraded + $leftAlone;
188		if ( $force ) {
189		$this->output( "\nFinished refreshing file metadata for $total files. "
190		. "$upgraded needed to be refreshed, $leftAlone did not need to "
191		. "be but were refreshed anyways, and $error refreshes were suspicious.\n" );
192		} else {
193		$this->output( "\nFinished refreshing file metadata for $total files. "
194		. "$upgraded were refreshed, $leftAlone were already up to date, "
195		. "and $error refreshes were suspicious.\n" );
196		}
197		}
198
199		/**
200		* @param Database $dbw
201		* @return array
202		*/
203		function getConditions( $dbw ) {
204		$conds = [];
205
206		$end = $this->getOption( 'end', false );
207		$mime = $this->getOption( 'mime', false );
208		$mediatype = $this->getOption( 'mediatype', false );
209		$like = $this->getOption( 'metadata-contains', false );
210
211		if ( $end !== false ) {
212		$conds[] = 'img_name <= ' . $dbw->addQuotes( $end );
213		}
214		if ( $mime !== false ) {
215		list( $major, $minor ) = File::splitMime( $mime );
216		$conds['img_major_mime'] = $major;
217		if ( $minor !== '*' ) {
218		$conds['img_minor_mime'] = $minor;
219		}
220		}
221		if ( $mediatype !== false ) {
222		$conds['img_media_type'] = $mediatype;
223		}
224		if ( $like ) {
225		$conds[] = 'img_metadata ' . $dbw->buildLike( $dbw->anyString(), $like, $dbw->anyString() );
226		}
227
228		return $conds;
229		}
230
231		/**
232		* @param bool $force
233		* @param bool $brokenOnly
234		*/
235		function setupParameters( $force, $brokenOnly ) {
236		global $wgUpdateCompatibleMetadata;
237
238		if ( $brokenOnly ) {
239		$wgUpdateCompatibleMetadata = false;
240		} else {
241		$wgUpdateCompatibleMetadata = true;
242		}
243
244		if ( $brokenOnly && $force ) {
245		$this->error( 'Cannot use --broken-only and --force together. ', 2 );
246		}
247		}
248		}
249
250		$maintClass = 'RefreshImageMetadata';
251		require_once RUN_MAINTENANCE_IF_MAIN;
252

wikimedia / mediawiki

RefreshImageMetadata::setupParameters() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RefreshImageMetadata::setupParameters() A
last analyzed 2016-11-13 17:42 UTC