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

TitleCleanup::processRow() C
last analyzed 2016-11-13 17:42 UTC

↳ Parent: TitleCleanup

Complexity

Conditions	8
Paths	4

Size

Total Lines	29
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	22
nc	4
nop	1
dl	0
loc	29
rs	5.3846
c	0
b	0
f	0

<?php

/**
 * Clean up broken, unparseable titles.
 *
 * Copyright © 2005 Brion Vibber <[email protected]>
 * 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 Brion Vibber <brion at pobox.com>
 * @ingroup Maintenance
 */

require_once __DIR__ . '/cleanupTable.inc';

/**
 * Maintenance script to clean up broken, unparseable titles.
 *
 * @ingroup Maintenance
 */
class TitleCleanup extends TableCleanup {
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Script to clean up broken, unparseable titles' );
	}

	/**
	 * @param object $row
	 */
	protected function processRow( $row ) {
		global $wgContLang;
		$display = Title::makeName( $row->page_namespace, $row->page_title );
		$verified = $wgContLang->normalize( $display );
		$title = Title::newFromText( $verified );

		if ( !is_null( $title )
			&& $title->canExist()
			&& $title->getNamespace() == $row->page_namespace
			&& $title->getDBkey() === $row->page_title
		) {
			$this->progress( 0 ); // all is fine

			return;
		}

		if ( $row->page_namespace == NS_FILE && $this->fileExists( $row->page_title ) ) {
			$this->output( "file $row->page_title needs cleanup, please run cleanupImages.php.\n" );
			$this->progress( 0 );
		} elseif ( is_null( $title ) ) {
			$this->output( "page $row->page_id ($display) is illegal.\n" );
			$this->moveIllegalPage( $row );
			$this->progress( 1 );
		} else {
			$this->output( "page $row->page_id ($display) doesn't match self.\n" );
			$this->moveInconsistentPage( $row, $title );
			$this->progress( 1 );
		}
	}

	/**
	 * @param string $name
	 * @return bool
	 */
	protected function fileExists( $name ) {
		// XXX: Doesn't actually check for file existence, just presence of image record.
		// This is reasonable, since cleanupImages.php only iterates over the image table.
		$dbr = $this->getDB( DB_REPLICA );
		$row = $dbr->selectRow( 'image', [ 'img_name' ], [ 'img_name' => $name ], __METHOD__ );

		return $row !== false;
	}

	/**
	 * @param object $row
	 */
	protected function moveIllegalPage( $row ) {
		$legal = 'A-Za-z0-9_/\\\\-';
		$legalized = preg_replace_callback( "!([^$legal])!",
			[ $this, 'hexChar' ],
			$row->page_title );
		if ( $legalized == '.' ) {
			$legalized = '(dot)';
		}
		if ( $legalized == '_' ) {
			$legalized = '(space)';
		}
		$legalized = 'Broken/' . $legalized;

		$title = Title::newFromText( $legalized );
		if ( is_null( $title ) ) {
			$clean = 'Broken/id:' . $row->page_id;
			$this->output( "Couldn't legalize; form '$legalized' still invalid; using '$clean'\n" );
			$title = Title::newFromText( $clean );
		} elseif ( $title->exists() ) {
			$clean = 'Broken/id:' . $row->page_id;
			$this->output( "Legalized for '$legalized' exists; using '$clean'\n" );
			$title = Title::newFromText( $clean );
		}

		$dest = $title->getDBkey();
		if ( $this->dryrun ) {
			$this->output( "DRY RUN: would rename $row->page_id ($row->page_namespace," .
				"'$row->page_title') to ($row->page_namespace,'$dest')\n" );
		} else {
			$this->output( "renaming $row->page_id ($row->page_namespace," .
				"'$row->page_title') to ($row->page_namespace,'$dest')\n" );
			$dbw = $this->getDB( DB_MASTER );
			$dbw->update( 'page',
				[ 'page_title' => $dest ],
				[ 'page_id' => $row->page_id ],
				__METHOD__ );
		}
	}

	/**
	 * @param object $row
	 * @param Title $title
	 */
	protected function moveInconsistentPage( $row, $title ) {
		if ( $title->exists() || $title->getInterwiki() || !$title->canExist() ) {
			if ( $title->getInterwiki() || !$title->canExist() ) {
				$prior = $title->getPrefixedDBkey();
			} else {
				$prior = $title->getDBkey();
			}

			# Old cleanupTitles could move articles there. See bug 23147.
			$ns = $row->page_namespace;
			if ( $ns < 0 ) {
				$ns = 0;
			}

			# Namespace which no longer exists. Put the page in the main namespace
			# since we don't have any idea of the old namespace name. See bug 68501.
			if ( !MWNamespace::exists( $ns ) ) {
				$ns = 0;
			}

			$clean = 'Broken/' . $prior;
			$verified = Title::makeTitleSafe( $ns, $clean );
			if ( !$verified || $verified->exists() ) {
				$blah = "Broken/id:" . $row->page_id;
				$this->output( "Couldn't legalize; form '$clean' exists; using '$blah'\n" );
				$verified = Title::makeTitleSafe( $ns, $blah );
			}
			$title = $verified;
		}
		if ( is_null( $title ) ) {
			$this->error( "Something awry; empty title.", true );
		}
		$ns = $title->getNamespace();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
		$dest = $title->getDBkey();

		if ( $this->dryrun ) {
			$this->output( "DRY RUN: would rename $row->page_id ($row->page_namespace," .
				"'$row->page_title') to ($ns,'$dest')\n" );
		} else {
			$this->output( "renaming $row->page_id ($row->page_namespace," .
				"'$row->page_title') to ($ns,'$dest')\n" );
			$dbw = $this->getDB( DB_MASTER );
			$dbw->update( 'page',
				[
					'page_namespace' => $ns,
					'page_title' => $dest
				],
				[ 'page_id' => $row->page_id ],
				__METHOD__ );
			LinkCache::singleton()->clear();
		}
	}
}

$maintClass = "TitleCleanup";
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 35 and the first side effect is on line 28. 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		* Clean up broken, unparseable titles.
4		*
5		* Copyright © 2005 Brion Vibber <[email protected]>
6		* https://www.mediawiki.org/
7		*
8		* This program is free software; you can redistribute it and/or modify
9		* it under the terms of the GNU General Public License as published by
10		* the Free Software Foundation; either version 2 of the License, or
11		* (at your option) any later version.
12		*
13		* This program is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU General Public License for more details.
17		*
18		* You should have received a copy of the GNU General Public License along
19		* with this program; if not, write to the Free Software Foundation, Inc.,
20		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21		* http://www.gnu.org/copyleft/gpl.html
22		*
23		* @file
24		* @author Brion Vibber <brion at pobox.com>
25		* @ingroup Maintenance
26		*/
27
28		require_once __DIR__ . '/cleanupTable.inc';
29
30		/**
31		* Maintenance script to clean up broken, unparseable titles.
32		*
33		* @ingroup Maintenance
34		*/
35		class TitleCleanup extends TableCleanup {
36		public function __construct() {
37		parent::__construct();
38		$this->addDescription( 'Script to clean up broken, unparseable titles' );
39		}
40
41		/**
42		* @param object $row
43		*/
44		protected function processRow( $row ) {
45		global $wgContLang;
46		$display = Title::makeName( $row->page_namespace, $row->page_title );
47		$verified = $wgContLang->normalize( $display );
48		$title = Title::newFromText( $verified );
49
50		if ( !is_null( $title )
51		&& $title->canExist()
52		&& $title->getNamespace() == $row->page_namespace
53		&& $title->getDBkey() === $row->page_title
54		) {
55		$this->progress( 0 ); // all is fine
56
57		return;
58		}
59
60		if ( $row->page_namespace == NS_FILE && $this->fileExists( $row->page_title ) ) {
61		$this->output( "file $row->page_title needs cleanup, please run cleanupImages.php.\n" );
62		$this->progress( 0 );
63		} elseif ( is_null( $title ) ) {
64		$this->output( "page $row->page_id ($display) is illegal.\n" );
65		$this->moveIllegalPage( $row );
66		$this->progress( 1 );
67		} else {
68		$this->output( "page $row->page_id ($display) doesn't match self.\n" );
69		$this->moveInconsistentPage( $row, $title );
70		$this->progress( 1 );
71		}
72		}
73
74		/**
75		* @param string $name
76		* @return bool
77		*/
78		protected function fileExists( $name ) {
79		// XXX: Doesn't actually check for file existence, just presence of image record.
80		// This is reasonable, since cleanupImages.php only iterates over the image table.
81		$dbr = $this->getDB( DB_REPLICA );
82		$row = $dbr->selectRow( 'image', [ 'img_name' ], [ 'img_name' => $name ], __METHOD__ );
83
84		return $row !== false;
85		}
86
87		/**
88		* @param object $row
89		*/
90		protected function moveIllegalPage( $row ) {
91		$legal = 'A-Za-z0-9_/\\\\-';
92		$legalized = preg_replace_callback( "!([^$legal])!",
93		[ $this, 'hexChar' ],
94		$row->page_title );
95		if ( $legalized == '.' ) {
96		$legalized = '(dot)';
97		}
98		if ( $legalized == '_' ) {
99		$legalized = '(space)';
100		}
101		$legalized = 'Broken/' . $legalized;
102
103		$title = Title::newFromText( $legalized );
104		if ( is_null( $title ) ) {
105		$clean = 'Broken/id:' . $row->page_id;
106		$this->output( "Couldn't legalize; form '$legalized' still invalid; using '$clean'\n" );
107		$title = Title::newFromText( $clean );
108		} elseif ( $title->exists() ) {
109		$clean = 'Broken/id:' . $row->page_id;
110		$this->output( "Legalized for '$legalized' exists; using '$clean'\n" );
111		$title = Title::newFromText( $clean );
112		}
113
114		$dest = $title->getDBkey();
115		if ( $this->dryrun ) {
116		$this->output( "DRY RUN: would rename $row->page_id ($row->page_namespace," .
117		"'$row->page_title') to ($row->page_namespace,'$dest')\n" );
118	View Code Duplication	} else {
119		$this->output( "renaming $row->page_id ($row->page_namespace," .
120		"'$row->page_title') to ($row->page_namespace,'$dest')\n" );
121		$dbw = $this->getDB( DB_MASTER );
122		$dbw->update( 'page',
123		[ 'page_title' => $dest ],
124		[ 'page_id' => $row->page_id ],
125		__METHOD__ );
126		}
127		}
128
129		/**
130		* @param object $row
131		* @param Title $title
132		*/
133		protected function moveInconsistentPage( $row, $title ) {
134		if ( $title->exists() \|\| $title->getInterwiki() \|\| !$title->canExist() ) {
135		if ( $title->getInterwiki() \|\| !$title->canExist() ) {
136		$prior = $title->getPrefixedDBkey();
137		} else {
138		$prior = $title->getDBkey();
139		}
140
141		# Old cleanupTitles could move articles there. See bug 23147.
142		$ns = $row->page_namespace;
143		if ( $ns < 0 ) {
144		$ns = 0;
145		}
146
147		# Namespace which no longer exists. Put the page in the main namespace
148		# since we don't have any idea of the old namespace name. See bug 68501.
149		if ( !MWNamespace::exists( $ns ) ) {
150		$ns = 0;
151		}
152
153		$clean = 'Broken/' . $prior;
154		$verified = Title::makeTitleSafe( $ns, $clean );
155		if ( !$verified \|\| $verified->exists() ) {
156		$blah = "Broken/id:" . $row->page_id;
157		$this->output( "Couldn't legalize; form '$clean' exists; using '$blah'\n" );
158		$verified = Title::makeTitleSafe( $ns, $blah );
159		}
160		$title = $verified;
161		}
162		if ( is_null( $title ) ) {
163		$this->error( "Something awry; empty title.", true );
164		}
165		$ns = $title->getNamespace();
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$title` is not always an object, but can also be of type `null`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
166		$dest = $title->getDBkey();
167
168		if ( $this->dryrun ) {
169		$this->output( "DRY RUN: would rename $row->page_id ($row->page_namespace," .
170		"'$row->page_title') to ($ns,'$dest')\n" );
171	View Code Duplication	} else {
172		$this->output( "renaming $row->page_id ($row->page_namespace," .
173		"'$row->page_title') to ($ns,'$dest')\n" );
174		$dbw = $this->getDB( DB_MASTER );
175		$dbw->update( 'page',
176		[
177		'page_namespace' => $ns,
178		'page_title' => $dest
179		],
180		[ 'page_id' => $row->page_id ],
181		__METHOD__ );
182		LinkCache::singleton()->clear();
183		}
184		}
185		}
186
187		$maintClass = "TitleCleanup";
188		require_once RUN_MAINTENANCE_IF_MAIN;
189

wikimedia / mediawiki

TitleCleanup::processRow() C last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TitleCleanup::processRow() C
last analyzed 2016-11-13 17:42 UTC