ProtectedPagesPager - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ProtectedPagesPager B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	309
Duplicated Lines	0.97 %

Coupling/Cohesion

Components	2
Dependencies	13

Importance

Changes

Metric	Value
dl	3
loc	309
rs	8.3396
c	0
b	0
f	0
wmc	44
lcom	2
cbo	13

9 Methods

Rating	Name	Duplication	Size	Complexity
B	preprocessResults()	0	28	6
C	getQueryInfo()	3	62	8
A	getTableClass()	0	3	1
A	getIndexField()	0	3	1
A	getDefaultSort()	0	3	1
A	isFieldSortable()	0	4	1
A	__construct()	0	17	2
A	getFieldNames()	0	19	3
D	formatValue()	0	133	21

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ProtectedPagesPager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ProtectedPagesPager, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Implements Special:Protectedpages
 *
 * 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 SpecialPage
 */

use MediaWiki\Linker\LinkRenderer;

/**
 * A special page that lists protected pages
 *
 * @ingroup SpecialPage
 */
class SpecialProtectedpages extends SpecialPage {
	protected $IdLevel = 'level';
	protected $IdType = 'type';

	public function __construct() {
		parent::__construct( 'Protectedpages' );
	}

	public function execute( $par ) {
		$this->setHeaders();
		$this->outputHeader();
		$this->getOutput()->addModuleStyles( 'mediawiki.special' );

		$request = $this->getRequest();
		$type = $request->getVal( $this->IdType );
		$level = $request->getVal( $this->IdLevel );
		$sizetype = $request->getVal( 'sizetype' );
		$size = $request->getIntOrNull( 'size' );
		$ns = $request->getIntOrNull( 'namespace' );
		$indefOnly = $request->getBool( 'indefonly' ) ? 1 : 0;
		$cascadeOnly = $request->getBool( 'cascadeonly' ) ? 1 : 0;
		$noRedirect = $request->getBool( 'noredirect' ) ? 1 : 0;

		$pager = new ProtectedPagesPager(
			$this,
			[],
			$type,
			$level,
			$ns,
			$sizetype,
			$size,
			$indefOnly,
			$cascadeOnly,
			$noRedirect,
			$this->getLinkRenderer()
		);

		$this->getOutput()->addHTML( $this->showOptions(
			$ns,
			$type,
			$level,
			$sizetype,
			$size,
			$indefOnly,
			$cascadeOnly,
			$noRedirect
		) );

		if ( $pager->getNumRows() ) {
			$this->getOutput()->addParserOutputContent( $pager->getFullOutput() );
		} else {
			$this->getOutput()->addWikiMsg( 'protectedpagesempty' );
		}
	}

	/**
	 * @param int $namespace
	 * @param string $type Restriction type
	 * @param string $level Restriction level
	 * @param string $sizetype "min" or "max"
	 * @param int $size
	 * @param bool $indefOnly Only indefinite protection
	 * @param bool $cascadeOnly Only cascading protection
	 * @param bool $noRedirect Don't show redirects
	 * @return string Input form
	 */
	protected function showOptions( $namespace, $type = 'edit', $level, $sizetype,
		$size, $indefOnly, $cascadeOnly, $noRedirect
	) {
		$title = $this->getPageTitle();

		return Xml::openElement( 'form', [ 'method' => 'get', 'action' => wfScript() ] ) .
			Xml::openElement( 'fieldset' ) .
			Xml::element( 'legend', [], $this->msg( 'protectedpages' )->text() ) .
			Html::hidden( 'title', $title->getPrefixedDBkey() ) . "\n" .
			$this->getNamespaceMenu( $namespace ) . "\n" .
			$this->getTypeMenu( $type ) . "\n" .
			$this->getLevelMenu( $level ) . "\n" .
			"<br />\n" .
			$this->getExpiryCheck( $indefOnly ) . "\n" .
			$this->getCascadeCheck( $cascadeOnly ) . "\n" .
			$this->getRedirectCheck( $noRedirect ) . "\n" .
			"<br />\n" .
			$this->getSizeLimit( $sizetype, $size ) . "\n" .
			Xml::submitButton( $this->msg( 'protectedpages-submit' )->text() ) . "\n" .
			Xml::closeElement( 'fieldset' ) .
			Xml::closeElement( 'form' );
	}

	/**
	 * Prepare the namespace filter drop-down; standard namespace
	 * selector, sans the MediaWiki namespace
	 *
	 * @param string|null $namespace Pre-select namespace
	 * @return string
	 */
	protected function getNamespaceMenu( $namespace = null ) {
		return Html::rawElement( 'span', [ 'class' => 'mw-input-with-label' ],
			Html::namespaceSelector(
				[
					'selected' => $namespace,
					'all' => '',
					'label' => $this->msg( 'namespace' )->text()
				], [
					'name' => 'namespace',
					'id' => 'namespace',
					'class' => 'namespaceselector',
				]
			)
		);
	}

	/**
	 * @param bool $indefOnly
	 * @return string Formatted HTML
	 */
	protected function getExpiryCheck( $indefOnly ) {
		return '<span class="mw-input-with-label">' . Xml::checkLabel(
			$this->msg( 'protectedpages-indef' )->text(),
			'indefonly',
			'indefonly',
			$indefOnly
		) . "</span>\n";
	}

	/**
	 * @param bool $cascadeOnly
	 * @return string Formatted HTML
	 */
	protected function getCascadeCheck( $cascadeOnly ) {
		return '<span class="mw-input-with-label">' . Xml::checkLabel(
			$this->msg( 'protectedpages-cascade' )->text(),
			'cascadeonly',
			'cascadeonly',
			$cascadeOnly
		) . "</span>\n";
	}

	/**
	 * @param bool $noRedirect
	 * @return string Formatted HTML
	 */
	protected function getRedirectCheck( $noRedirect ) {
		return '<span class="mw-input-with-label">' . Xml::checkLabel(
			$this->msg( 'protectedpages-noredirect' )->text(),
			'noredirect',
			'noredirect',
			$noRedirect
		) . "</span>\n";
	}

	/**
	 * @param string $sizetype "min" or "max"
	 * @param mixed $size
	 * @return string Formatted HTML
	 */
	protected function getSizeLimit( $sizetype, $size ) {
		$max = $sizetype === 'max';

		return '<span class="mw-input-with-label">' . Xml::radioLabel(
			$this->msg( 'minimum-size' )->text(),
			'sizetype',
			'min',
			'wpmin',
			!$max
		) .
			' ' .
			Xml::radioLabel(
				$this->msg( 'maximum-size' )->text(),
				'sizetype',
				'max',
				'wpmax',
				$max
			) .
			' ' .
			Xml::input( 'size', 9, $size, [ 'id' => 'wpsize' ] ) .
			' ' .
			Xml::label( $this->msg( 'pagesize' )->text(), 'wpsize' ) . "</span>\n";
	}

	/**
	 * Creates the input label of the restriction type
	 * @param string $pr_type Protection type
	 * @return string Formatted HTML
	 */
	protected function getTypeMenu( $pr_type ) {
		$m = []; // Temporary array
		$options = [];

		// First pass to load the log names
		foreach ( Title::getFilteredRestrictionTypes( true ) as $type ) {
			// Messages: restriction-edit, restriction-move, restriction-create, restriction-upload
			$text = $this->msg( "restriction-$type" )->text();
			$m[$text] = $type;
		}

		// Third pass generates sorted XHTML content
		foreach ( $m as $text => $type ) {
			$selected = ( $type == $pr_type );
			$options[] = Xml::option( $text, $type, $selected ) . "\n";
		}

		return '<span class="mw-input-with-label">' .
			Xml::label( $this->msg( 'restriction-type' )->text(), $this->IdType ) . ' ' .
			Xml::tags( 'select',
				[ 'id' => $this->IdType, 'name' => $this->IdType ],
				implode( "\n", $options ) ) . "</span>";
	}

	/**
	 * Creates the input label of the restriction level
	 * @param string $pr_level Protection level
	 * @return string Formatted HTML
	 */
	protected function getLevelMenu( $pr_level ) {
		// Temporary array
		$m = [ $this->msg( 'restriction-level-all' )->text() => 0 ];
		$options = [];

		// First pass to load the log names
		foreach ( $this->getConfig()->get( 'RestrictionLevels' ) as $type ) {
			// Messages used can be 'restriction-level-sysop' and 'restriction-level-autoconfirmed'
			if ( $type != '' && $type != '*' ) {
				$text = $this->msg( "restriction-level-$type" )->text();
				$m[$text] = $type;
			}
		}

		// Third pass generates sorted XHTML content
		foreach ( $m as $text => $type ) {
			$selected = ( $type == $pr_level );
			$options[] = Xml::option( $text, $type, $selected );
		}

		return '<span class="mw-input-with-label">' .
			Xml::label( $this->msg( 'restriction-level' )->text(), $this->IdLevel ) . ' ' .
			Xml::tags( 'select',
				[ 'id' => $this->IdLevel, 'name' => $this->IdLevel ],
				implode( "\n", $options ) ) . "</span>";
	}

	protected function getGroupName() {
		return 'maintenance';
	}
}

/**
 * @todo document
 * @ingroup Pager
 */
class ProtectedPagesPager extends TablePager {
	public $mForm, $mConds;

	private $type, $level, $namespace, $sizetype, $size, $indefonly, $cascadeonly, $noredirect;


	/**
	 * @var LinkRenderer
	 */
	private $linkRenderer;

	/**
	 * @param SpecialProtectedpages $form
	 * @param array $conds
	 * @param $type
	 * @param $level
	 * @param $namespace
	 * @param string $sizetype
	 * @param int $size
	 * @param bool $indefonly
	 * @param bool $cascadeonly
	 * @param bool $noredirect
	 * @param LinkRenderer $linkRenderer
	 */
	function __construct( $form, $conds = [], $type, $level, $namespace,
		$sizetype = '', $size = 0, $indefonly = false, $cascadeonly = false, $noredirect = false,
		LinkRenderer $linkRenderer
	) {
		$this->mForm = $form;
		$this->mConds = $conds;
		$this->type = ( $type ) ? $type : 'edit';
		$this->level = $level;
		$this->namespace = $namespace;
		$this->sizetype = $sizetype;
		$this->size = intval( $size );
		$this->indefonly = (bool)$indefonly;
		$this->cascadeonly = (bool)$cascadeonly;
		$this->noredirect = (bool)$noredirect;
		$this->linkRenderer = $linkRenderer;
		parent::__construct( $form->getContext() );
	}

	function preprocessResults( $result ) {
		# Do a link batch query
		$lb = new LinkBatch;
		$userids = [];

		foreach ( $result as $row ) {
			$lb->add( $row->page_namespace, $row->page_title );
			// field is nullable, maybe null on old protections
			if ( $row->log_user !== null ) {
				$userids[] = $row->log_user;
			}
		}

		// fill LinkBatch with user page and user talk
		if ( count( $userids ) ) {
			$userCache = UserCache::singleton();
			$userCache->doQuery( $userids, [], __METHOD__ );
			foreach ( $userids as $userid ) {
				$name = $userCache->getProp( $userid, 'name' );
				if ( $name !== false ) {
					$lb->add( NS_USER, $name );
					$lb->add( NS_USER_TALK, $name );
				}
			}
		}

		$lb->execute();
	}

	function getFieldNames() {
		static $headers = null;

		if ( $headers == [] ) {
			$headers = [
				'log_timestamp' => 'protectedpages-timestamp',
				'pr_page' => 'protectedpages-page',
				'pr_expiry' => 'protectedpages-expiry',
				'log_user' => 'protectedpages-performer',
				'pr_params' => 'protectedpages-params',
				'log_comment' => 'protectedpages-reason',
			];
			foreach ( $headers as $key => $val ) {
				$headers[$key] = $this->msg( $val )->text();
			}
		}

		return $headers;
	}

	/**
	 * @param string $field
	 * @param string $value
	 * @return string HTML
	 * @throws MWException
	 */
	function formatValue( $field, $value ) {
		/** @var $row object */
		$row = $this->mCurrentRow;

		switch ( $field ) {
			case 'log_timestamp':
				// when timestamp is null, this is a old protection row
				if ( $value === null ) {
					$formatted = Html::rawElement(
						'span',
						[ 'class' => 'mw-protectedpages-unknown' ],
						$this->msg( 'protectedpages-unknown-timestamp' )->escaped()
					);
				} else {
					$formatted = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
						$value, $this->getUser() ) );
				}
				break;

			case 'pr_page':
				$title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
				if ( !$title ) {
					$formatted = Html::element(
						'span',
						[ 'class' => 'mw-invalidtitle' ],
						Linker::getInvalidTitleDescription(
							$this->getContext(),
							$row->page_namespace,
							$row->page_title
						)
					);
				} else {
					$formatted = $this->linkRenderer->makeLink( $title );
				}
				if ( !is_null( $row->page_len ) ) {
					$formatted .= $this->getLanguage()->getDirMark() .
						' ' . Html::rawElement(
						'span',
						[ 'class' => 'mw-protectedpages-length' ],
						Linker::formatRevisionSize( $row->page_len )
					);
				}
				break;

			case 'pr_expiry':
				$formatted = htmlspecialchars( $this->getLanguage()->formatExpiry(
					$value, /* User preference timezone */true ) );
				$title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
				if ( $this->getUser()->isAllowed( 'protect' ) && $title ) {
					$changeProtection = $this->linkRenderer->makeKnownLink(
						$title,
						$this->msg( 'protect_change' )->text(),
						[],
						[ 'action' => 'unprotect' ]
					);
					$formatted .= ' ' . Html::rawElement(
						'span',
						[ 'class' => 'mw-protectedpages-actions' ],
						$this->msg( 'parentheses' )->rawParams( $changeProtection )->escaped()
					);
				}
				break;

			case 'log_user':
				// when timestamp is null, this is a old protection row
				if ( $row->log_timestamp === null ) {
					$formatted = Html::rawElement(
						'span',
						[ 'class' => 'mw-protectedpages-unknown' ],
						$this->msg( 'protectedpages-unknown-performer' )->escaped()
					);
				} else {
					$username = UserCache::singleton()->getProp( $value, 'name' );
					if ( LogEventsList::userCanBitfield(
						$row->log_deleted,
						LogPage::DELETED_USER,
						$this->getUser()
					) ) {
						if ( $username === false ) {
							$formatted = htmlspecialchars( $value );
						} else {
							$formatted = Linker::userLink( $value, $username )
								. Linker::userToolLinks( $value, $username );
						}
					} else {
						$formatted = $this->msg( 'rev-deleted-user' )->escaped();
					}
					if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) {
						$formatted = '<span class="history-deleted">' . $formatted . '</span>';
					}
				}
				break;

			case 'pr_params':
				$params = [];
				// Messages: restriction-level-sysop, restriction-level-autoconfirmed
				$params[] = $this->msg( 'restriction-level-' . $row->pr_level )->escaped();
				if ( $row->pr_cascade ) {
					$params[] = $this->msg( 'protect-summary-cascade' )->escaped();
				}
				$formatted = $this->getLanguage()->commaList( $params );
				break;

			case 'log_comment':
				// when timestamp is null, this is an old protection row
				if ( $row->log_timestamp === null ) {
					$formatted = Html::rawElement(
						'span',
						[ 'class' => 'mw-protectedpages-unknown' ],
						$this->msg( 'protectedpages-unknown-reason' )->escaped()
					);
				} else {
					if ( LogEventsList::userCanBitfield(
						$row->log_deleted,
						LogPage::DELETED_COMMENT,
						$this->getUser()
					) ) {
						$formatted = Linker::formatComment( $value !== null ? $value : '' );
					} else {
						$formatted = $this->msg( 'rev-deleted-comment' )->escaped();
					}
					if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) {
						$formatted = '<span class="history-deleted">' . $formatted . '</span>';
					}
				}
				break;

			default:
				throw new MWException( "Unknown field '$field'" );
		}

		return $formatted;
	}

	function getQueryInfo() {
		$conds = $this->mConds;
		$conds[] = 'pr_expiry > ' . $this->mDb->addQuotes( $this->mDb->timestamp() ) .
			' OR pr_expiry IS NULL';
		$conds[] = 'page_id=pr_page';
		$conds[] = 'pr_type=' . $this->mDb->addQuotes( $this->type );

		if ( $this->sizetype == 'min' ) {
			$conds[] = 'page_len>=' . $this->size;
		} elseif ( $this->sizetype == 'max' ) {
			$conds[] = 'page_len<=' . $this->size;
		}

		if ( $this->indefonly ) {
			$infinity = $this->mDb->addQuotes( $this->mDb->getInfinity() );
			$conds[] = "pr_expiry = $infinity OR pr_expiry IS NULL";
		}
		if ( $this->cascadeonly ) {
			$conds[] = 'pr_cascade = 1';
		}
		if ( $this->noredirect ) {
			$conds[] = 'page_is_redirect = 0';
		}

		if ( $this->level ) {
			$conds[] = 'pr_level=' . $this->mDb->addQuotes( $this->level );
		}
		if ( !is_null( $this->namespace ) ) {
			$conds[] = 'page_namespace=' . $this->mDb->addQuotes( $this->namespace );
		}

		return [
			'tables' => [ 'page', 'page_restrictions', 'log_search', 'logging' ],
			'fields' => [
				'pr_id',
				'page_namespace',
				'page_title',
				'page_len',
				'pr_type',
				'pr_level',
				'pr_expiry',
				'pr_cascade',
				'log_timestamp',
				'log_user',
				'log_comment',
				'log_deleted',
			],
			'conds' => $conds,
			'join_conds' => [
				'log_search' => [
					'LEFT JOIN', [
						'ls_field' => 'pr_id', 'ls_value = ' . $this->mDb->buildStringCast( 'pr_id' )
					]
				],
				'logging' => [
					'LEFT JOIN', [
						'ls_log_id = log_id'
					]
				]
			]
		];
	}

	protected function getTableClass() {
		return parent::getTableClass() . ' mw-protectedpages';
	}

	function getIndexField() {
		return 'pr_id';
	}

	function getDefaultSort() {
		return 'pr_id';
	}

	function isFieldSortable( $field ) {
		// no index for sorting exists
		return false;
	}
}


1		<?php
2		/**
3		* Implements Special:Protectedpages
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 SpecialPage
22		*/
23
24		use MediaWiki\Linker\LinkRenderer;
25
26		/**
27		* A special page that lists protected pages
28		*
29		* @ingroup SpecialPage
30		*/
31		class SpecialProtectedpages extends SpecialPage {
32		protected $IdLevel = 'level';
33		protected $IdType = 'type';
34
35		public function __construct() {
36		parent::__construct( 'Protectedpages' );
37		}
38
39		public function execute( $par ) {
40		$this->setHeaders();
41		$this->outputHeader();
42		$this->getOutput()->addModuleStyles( 'mediawiki.special' );
43
44		$request = $this->getRequest();
45		$type = $request->getVal( $this->IdType );
46		$level = $request->getVal( $this->IdLevel );
47		$sizetype = $request->getVal( 'sizetype' );
48		$size = $request->getIntOrNull( 'size' );
49		$ns = $request->getIntOrNull( 'namespace' );
50		$indefOnly = $request->getBool( 'indefonly' ) ? 1 : 0;
51		$cascadeOnly = $request->getBool( 'cascadeonly' ) ? 1 : 0;
52		$noRedirect = $request->getBool( 'noredirect' ) ? 1 : 0;
53
54		$pager = new ProtectedPagesPager(
55		$this,
56		[],
57		$type,
58		$level,
59		$ns,
60		$sizetype,
61		$size,
62		$indefOnly,
63		$cascadeOnly,
64		$noRedirect,
65		$this->getLinkRenderer()
66		);
67
68		$this->getOutput()->addHTML( $this->showOptions(
69		$ns,
70		$type,
71		$level,
72		$sizetype,
73		$size,
74		$indefOnly,
75		$cascadeOnly,
76		$noRedirect
77		) );
78
79		if ( $pager->getNumRows() ) {
80		$this->getOutput()->addParserOutputContent( $pager->getFullOutput() );
81		} else {
82		$this->getOutput()->addWikiMsg( 'protectedpagesempty' );
83		}
84		}
85
86		/**
87		* @param int $namespace
88		* @param string $type Restriction type
89		* @param string $level Restriction level
90		* @param string $sizetype "min" or "max"
91		* @param int $size
92		* @param bool $indefOnly Only indefinite protection
93		* @param bool $cascadeOnly Only cascading protection
94		* @param bool $noRedirect Don't show redirects
95		* @return string Input form
96		*/
97		protected function showOptions( $namespace, $type = 'edit', $level, $sizetype,
98		$size, $indefOnly, $cascadeOnly, $noRedirect
99		) {
100		$title = $this->getPageTitle();
101
102		return Xml::openElement( 'form', [ 'method' => 'get', 'action' => wfScript() ] ) .
103		Xml::openElement( 'fieldset' ) .
104		Xml::element( 'legend', [], $this->msg( 'protectedpages' )->text() ) .
105		Html::hidden( 'title', $title->getPrefixedDBkey() ) . "\n" .
106		$this->getNamespaceMenu( $namespace ) . "\n" .
107		$this->getTypeMenu( $type ) . "\n" .
108		$this->getLevelMenu( $level ) . "\n" .
109		"<br />\n" .
110		$this->getExpiryCheck( $indefOnly ) . "\n" .
111		$this->getCascadeCheck( $cascadeOnly ) . "\n" .
112		$this->getRedirectCheck( $noRedirect ) . "\n" .
113		"<br />\n" .
114		$this->getSizeLimit( $sizetype, $size ) . "\n" .
115		Xml::submitButton( $this->msg( 'protectedpages-submit' )->text() ) . "\n" .
116		Xml::closeElement( 'fieldset' ) .
117		Xml::closeElement( 'form' );
118		}
119
120		/**
121		* Prepare the namespace filter drop-down; standard namespace
122		* selector, sans the MediaWiki namespace
123		*
124		* @param string\|null $namespace Pre-select namespace
125		* @return string
126		*/
127		protected function getNamespaceMenu( $namespace = null ) {
128		return Html::rawElement( 'span', [ 'class' => 'mw-input-with-label' ],
129		Html::namespaceSelector(
130		[
131		'selected' => $namespace,
132		'all' => '',
133		'label' => $this->msg( 'namespace' )->text()
134		], [
135		'name' => 'namespace',
136		'id' => 'namespace',
137		'class' => 'namespaceselector',
138		]
139		)
140		);
141		}
142
143		/**
144		* @param bool $indefOnly
145		* @return string Formatted HTML
146		*/
147		protected function getExpiryCheck( $indefOnly ) {
148		return '<span class="mw-input-with-label">' . Xml::checkLabel(
149		$this->msg( 'protectedpages-indef' )->text(),
150		'indefonly',
151		'indefonly',
152		$indefOnly
153		) . "</span>\n";
154		}
155
156		/**
157		* @param bool $cascadeOnly
158		* @return string Formatted HTML
159		*/
160		protected function getCascadeCheck( $cascadeOnly ) {
161		return '<span class="mw-input-with-label">' . Xml::checkLabel(
162		$this->msg( 'protectedpages-cascade' )->text(),
163		'cascadeonly',
164		'cascadeonly',
165		$cascadeOnly
166		) . "</span>\n";
167		}
168
169		/**
170		* @param bool $noRedirect
171		* @return string Formatted HTML
172		*/
173		protected function getRedirectCheck( $noRedirect ) {
174		return '<span class="mw-input-with-label">' . Xml::checkLabel(
175		$this->msg( 'protectedpages-noredirect' )->text(),
176		'noredirect',
177		'noredirect',
178		$noRedirect
179		) . "</span>\n";
180		}
181
182		/**
183		* @param string $sizetype "min" or "max"
184		* @param mixed $size
185		* @return string Formatted HTML
186		*/
187		protected function getSizeLimit( $sizetype, $size ) {
188		$max = $sizetype === 'max';
189
190		return '<span class="mw-input-with-label">' . Xml::radioLabel(
191		$this->msg( 'minimum-size' )->text(),
192		'sizetype',
193		'min',
194		'wpmin',
195		!$max
196		) .
197		' ' .
198		Xml::radioLabel(
199		$this->msg( 'maximum-size' )->text(),
200		'sizetype',
201		'max',
202		'wpmax',
203		$max
204		) .
205		' ' .
206		Xml::input( 'size', 9, $size, [ 'id' => 'wpsize' ] ) .
207		' ' .
208		Xml::label( $this->msg( 'pagesize' )->text(), 'wpsize' ) . "</span>\n";
209		}
210
211		/**
212		* Creates the input label of the restriction type
213		* @param string $pr_type Protection type
214		* @return string Formatted HTML
215		*/
216		protected function getTypeMenu( $pr_type ) {
217		$m = []; // Temporary array
218		$options = [];
219
220		// First pass to load the log names
221		foreach ( Title::getFilteredRestrictionTypes( true ) as $type ) {
222		// Messages: restriction-edit, restriction-move, restriction-create, restriction-upload
223		$text = $this->msg( "restriction-$type" )->text();
224		$m[$text] = $type;
225		}
226
227		// Third pass generates sorted XHTML content
228		foreach ( $m as $text => $type ) {
229		$selected = ( $type == $pr_type );
230		$options[] = Xml::option( $text, $type, $selected ) . "\n";
231		}
232
233		return '<span class="mw-input-with-label">' .
234		Xml::label( $this->msg( 'restriction-type' )->text(), $this->IdType ) . ' ' .
235		Xml::tags( 'select',
236		[ 'id' => $this->IdType, 'name' => $this->IdType ],
237		implode( "\n", $options ) ) . "</span>";
238		}
239
240		/**
241		* Creates the input label of the restriction level
242		* @param string $pr_level Protection level
243		* @return string Formatted HTML
244		*/
245		protected function getLevelMenu( $pr_level ) {
246		// Temporary array
247		$m = [ $this->msg( 'restriction-level-all' )->text() => 0 ];
248		$options = [];
249
250		// First pass to load the log names
251	View Code Duplication	foreach ( $this->getConfig()->get( 'RestrictionLevels' ) as $type ) {
252		// Messages used can be 'restriction-level-sysop' and 'restriction-level-autoconfirmed'
253		if ( $type != '' && $type != '*' ) {
254		$text = $this->msg( "restriction-level-$type" )->text();
255		$m[$text] = $type;
256		}
257		}
258
259		// Third pass generates sorted XHTML content
260	View Code Duplication	foreach ( $m as $text => $type ) {
261		$selected = ( $type == $pr_level );
262		$options[] = Xml::option( $text, $type, $selected );
263		}
264
265		return '<span class="mw-input-with-label">' .
266		Xml::label( $this->msg( 'restriction-level' )->text(), $this->IdLevel ) . ' ' .
267		Xml::tags( 'select',
268		[ 'id' => $this->IdLevel, 'name' => $this->IdLevel ],
269		implode( "\n", $options ) ) . "</span>";
270		}
271
272		protected function getGroupName() {
273		return 'maintenance';
274		}
275		}
276
277		/**
278		* @todo document
279		* @ingroup Pager
280		*/
281		class ProtectedPagesPager extends TablePager {
282		public $mForm, $mConds;
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
283		private $type, $level, $namespace, $sizetype, $size, $indefonly, $cascadeonly, $noredirect;
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
284
285		/**
286		* @var LinkRenderer
287		*/
288		private $linkRenderer;
289
290		/**
291		* @param SpecialProtectedpages $form
292		* @param array $conds
293		* @param $type
294		* @param $level
295		* @param $namespace
296		* @param string $sizetype
297		* @param int $size
298		* @param bool $indefonly
299		* @param bool $cascadeonly
300		* @param bool $noredirect
301		* @param LinkRenderer $linkRenderer
302		*/
303		function __construct( $form, $conds = [], $type, $level, $namespace,
304		$sizetype = '', $size = 0, $indefonly = false, $cascadeonly = false, $noredirect = false,
305		LinkRenderer $linkRenderer
306		) {
307		$this->mForm = $form;
308		$this->mConds = $conds;
309		$this->type = ( $type ) ? $type : 'edit';
310		$this->level = $level;
311		$this->namespace = $namespace;
312		$this->sizetype = $sizetype;
313		$this->size = intval( $size );
314		$this->indefonly = (bool)$indefonly;
315		$this->cascadeonly = (bool)$cascadeonly;
316		$this->noredirect = (bool)$noredirect;
317		$this->linkRenderer = $linkRenderer;
318		parent::__construct( $form->getContext() );
319		}
320
321		function preprocessResults( $result ) {
322		# Do a link batch query
323		$lb = new LinkBatch;
324		$userids = [];
325
326		foreach ( $result as $row ) {
327		$lb->add( $row->page_namespace, $row->page_title );
328		// field is nullable, maybe null on old protections
329		if ( $row->log_user !== null ) {
330		$userids[] = $row->log_user;
331		}
332		}
333
334		// fill LinkBatch with user page and user talk
335		if ( count( $userids ) ) {
336		$userCache = UserCache::singleton();
337		$userCache->doQuery( $userids, [], __METHOD__ );
338		foreach ( $userids as $userid ) {
339		$name = $userCache->getProp( $userid, 'name' );
340		if ( $name !== false ) {
341		$lb->add( NS_USER, $name );
342		$lb->add( NS_USER_TALK, $name );
343		}
344		}
345		}
346
347		$lb->execute();
348		}
349
350		function getFieldNames() {
351		static $headers = null;
352
353		if ( $headers == [] ) {
354		$headers = [
355		'log_timestamp' => 'protectedpages-timestamp',
356		'pr_page' => 'protectedpages-page',
357		'pr_expiry' => 'protectedpages-expiry',
358		'log_user' => 'protectedpages-performer',
359		'pr_params' => 'protectedpages-params',
360		'log_comment' => 'protectedpages-reason',
361		];
362		foreach ( $headers as $key => $val ) {
363		$headers[$key] = $this->msg( $val )->text();
364		}
365		}
366
367		return $headers;
368		}
369
370		/**
371		* @param string $field
372		* @param string $value
373		* @return string HTML
374		* @throws MWException
375		*/
376		function formatValue( $field, $value ) {
377		/** @var $row object */
378		$row = $this->mCurrentRow;
379
380		switch ( $field ) {
381		case 'log_timestamp':
382		// when timestamp is null, this is a old protection row
383		if ( $value === null ) {
384		$formatted = Html::rawElement(
385		'span',
386		[ 'class' => 'mw-protectedpages-unknown' ],
387		$this->msg( 'protectedpages-unknown-timestamp' )->escaped()
388		);
389		} else {
390		$formatted = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
391		$value, $this->getUser() ) );
392		}
393		break;
394
395		case 'pr_page':
396		$title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
397		if ( !$title ) {
398		$formatted = Html::element(
399		'span',
400		[ 'class' => 'mw-invalidtitle' ],
401		Linker::getInvalidTitleDescription(
402		$this->getContext(),
403		$row->page_namespace,
404		$row->page_title
405		)
406		);
407		} else {
408		$formatted = $this->linkRenderer->makeLink( $title );
409		}
410		if ( !is_null( $row->page_len ) ) {
411		$formatted .= $this->getLanguage()->getDirMark() .
412		' ' . Html::rawElement(
413		'span',
414		[ 'class' => 'mw-protectedpages-length' ],
415		Linker::formatRevisionSize( $row->page_len )
416		);
417		}
418		break;
419
420		case 'pr_expiry':
421		$formatted = htmlspecialchars( $this->getLanguage()->formatExpiry(
422		$value, /* User preference timezone */true ) );
423		$title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
424		if ( $this->getUser()->isAllowed( 'protect' ) && $title ) {
425		$changeProtection = $this->linkRenderer->makeKnownLink(
426		$title,
427		$this->msg( 'protect_change' )->text(),
428		[],
429		[ 'action' => 'unprotect' ]
430		);
431		$formatted .= ' ' . Html::rawElement(
432		'span',
433		[ 'class' => 'mw-protectedpages-actions' ],
434		$this->msg( 'parentheses' )->rawParams( $changeProtection )->escaped()
435		);
436		}
437		break;
438
439		case 'log_user':
440		// when timestamp is null, this is a old protection row
441		if ( $row->log_timestamp === null ) {
442		$formatted = Html::rawElement(
443		'span',
444		[ 'class' => 'mw-protectedpages-unknown' ],
445		$this->msg( 'protectedpages-unknown-performer' )->escaped()
446		);
447		} else {
448		$username = UserCache::singleton()->getProp( $value, 'name' );
449		if ( LogEventsList::userCanBitfield(
450		$row->log_deleted,
451		LogPage::DELETED_USER,
452		$this->getUser()
453		) ) {
454		if ( $username === false ) {
455		$formatted = htmlspecialchars( $value );
456		} else {
457		$formatted = Linker::userLink( $value, $username )
458		. Linker::userToolLinks( $value, $username );
459		}
460		} else {
461		$formatted = $this->msg( 'rev-deleted-user' )->escaped();
462		}
463		if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) {
464		$formatted = '<span class="history-deleted">' . $formatted . '</span>';
465		}
466		}
467		break;
468
469		case 'pr_params':
470		$params = [];
471		// Messages: restriction-level-sysop, restriction-level-autoconfirmed
472		$params[] = $this->msg( 'restriction-level-' . $row->pr_level )->escaped();
473		if ( $row->pr_cascade ) {
474		$params[] = $this->msg( 'protect-summary-cascade' )->escaped();
475		}
476		$formatted = $this->getLanguage()->commaList( $params );
477		break;
478
479		case 'log_comment':
480		// when timestamp is null, this is an old protection row
481		if ( $row->log_timestamp === null ) {
482		$formatted = Html::rawElement(
483		'span',
484		[ 'class' => 'mw-protectedpages-unknown' ],
485		$this->msg( 'protectedpages-unknown-reason' )->escaped()
486		);
487		} else {
488		if ( LogEventsList::userCanBitfield(
489		$row->log_deleted,
490		LogPage::DELETED_COMMENT,
491		$this->getUser()
492		) ) {
493		$formatted = Linker::formatComment( $value !== null ? $value : '' );
494		} else {
495		$formatted = $this->msg( 'rev-deleted-comment' )->escaped();
496		}
497		if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) {
498		$formatted = '<span class="history-deleted">' . $formatted . '</span>';
499		}
500		}
501		break;
502
503		default:
504		throw new MWException( "Unknown field '$field'" );
505		}
506
507		return $formatted;
508		}
509
510		function getQueryInfo() {
511		$conds = $this->mConds;
512		$conds[] = 'pr_expiry > ' . $this->mDb->addQuotes( $this->mDb->timestamp() ) .
513		' OR pr_expiry IS NULL';
514		$conds[] = 'page_id=pr_page';
515		$conds[] = 'pr_type=' . $this->mDb->addQuotes( $this->type );
516
517		if ( $this->sizetype == 'min' ) {
518		$conds[] = 'page_len>=' . $this->size;
519		} elseif ( $this->sizetype == 'max' ) {
520		$conds[] = 'page_len<=' . $this->size;
521		}
522
523		if ( $this->indefonly ) {
524		$infinity = $this->mDb->addQuotes( $this->mDb->getInfinity() );
525		$conds[] = "pr_expiry = $infinity OR pr_expiry IS NULL";
526		}
527		if ( $this->cascadeonly ) {
528		$conds[] = 'pr_cascade = 1';
529		}
530		if ( $this->noredirect ) {
531		$conds[] = 'page_is_redirect = 0';
532		}
533
534		if ( $this->level ) {
535		$conds[] = 'pr_level=' . $this->mDb->addQuotes( $this->level );
536		}
537	View Code Duplication	if ( !is_null( $this->namespace ) ) {
538		$conds[] = 'page_namespace=' . $this->mDb->addQuotes( $this->namespace );
539		}
540
541		return [
542		'tables' => [ 'page', 'page_restrictions', 'log_search', 'logging' ],
543		'fields' => [
544		'pr_id',
545		'page_namespace',
546		'page_title',
547		'page_len',
548		'pr_type',
549		'pr_level',
550		'pr_expiry',
551		'pr_cascade',
552		'log_timestamp',
553		'log_user',
554		'log_comment',
555		'log_deleted',
556		],
557		'conds' => $conds,
558		'join_conds' => [
559		'log_search' => [
560		'LEFT JOIN', [
561		'ls_field' => 'pr_id', 'ls_value = ' . $this->mDb->buildStringCast( 'pr_id' )
562		]
563		],
564		'logging' => [
565		'LEFT JOIN', [
566		'ls_log_id = log_id'
567		]
568		]
569		]
570		];
571		}
572
573		protected function getTableClass() {
574		return parent::getTableClass() . ' mw-protectedpages';
575		}
576
577		function getIndexField() {
578		return 'pr_id';
579		}
580
581		function getDefaultSort() {
582		return 'pr_id';
583		}
584
585		function isFieldSortable( $field ) {
586		// no index for sorting exists
587		return false;
588		}
589		}
590

wikimedia / mediawiki

ProtectedPagesPager B last analyzed 2016-11-13 17:42 UTC