1<?php
2/**
3 * Implements Special:Protectedtitles
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/**
25 * A special page that list protected titles from creation
26 *
27 * @ingroup SpecialPage
28 */
29class SpecialProtectedtitles extends SpecialPage {
30	protected $IdLevel = 'level';
31	protected $IdType = 'type';
32
33	public function __construct() {
34		parent::__construct( 'Protectedtitles' );
35	}
36
37	public function execute( $par ) {
38		$this->setHeaders();
39		$this->outputHeader();
40		$this->addHelpLink( 'Help:Protected_pages' );
41
42		$request = $this->getRequest();
43		$type = $request->getVal( $this->IdType );
44		$level = $request->getVal( $this->IdLevel );
45		$sizetype = $request->getVal( 'sizetype' );
46		$size = $request->getIntOrNull( 'size' );
47		$NS = $request->getIntOrNull( 'namespace' );
48
49		$pager = new ProtectedTitlesPager( $this, [], $type, $level, $NS, $sizetype, $size );
50
51		$this->getOutput()->addHTML( $this->showOptions( $NS, $type, $level ) );
52
53		if ( $pager->getNumRows() ) {
54			$this->getOutput()->addHTML(
55				$pager->getNavigationBar() .
56					'<ul>' . $pager->getBody() . '</ul>' .
57					$pager->getNavigationBar()
58			);
59		} else {
60			$this->getOutput()->addWikiMsg( 'protectedtitlesempty' );
61		}
62	}
63
64	/**
65	 * Callback function to output a restriction
66	 *
67	 * @param object $row Database row
68	 * @return string
69	 */
70	public function formatRow( $row ) {
71		$title = Title::makeTitleSafe( $row->pt_namespace, $row->pt_title );
72		if ( !$title ) {
73			return Html::rawElement(
74				'li',
75				[],
76				Html::element(
77					'span',
78					[ 'class' => 'mw-invalidtitle' ],
79					Linker::getInvalidTitleDescription(
80						$this->getContext(),
81						$row->pt_namespace,
82						$row->pt_title
83					)
84				)
85			) . "\n";
86		}
87
88		$link = $this->getLinkRenderer()->makeLink( $title );
89		// Messages: restriction-level-sysop, restriction-level-autoconfirmed
90		$description = $this->msg( 'restriction-level-' . $row->pt_create_perm )->escaped();
91		$lang = $this->getLanguage();
92		$expiry = strlen( $row->pt_expiry ) ?
93			$lang->formatExpiry( $row->pt_expiry, TS_MW ) :
94			'infinity';
95
96		if ( $expiry !== 'infinity' ) {
97			$user = $this->getUser();
98			$description .= $this->msg( 'comma-separator' )->escaped() . $this->msg(
99				'protect-expiring-local',
100				$lang->userTimeAndDate( $expiry, $user ),
101				$lang->userDate( $expiry, $user ),
102				$lang->userTime( $expiry, $user )
103			)->escaped();
104		}
105
106		return '<li>' . $lang->specialList( $link, $description ) . "</li>\n";
107	}
108
109	/**
110	 * @param int $namespace
111	 * @param string $type
112	 * @param string $level
113	 * @return string
114	 * @internal
115	 */
116	private function showOptions( $namespace, $type, $level ) {
117		$formDescriptor = [
118			'namespace' => [
119				'class' => 'HTMLSelectNamespace',
120				'name' => 'namespace',
121				'id' => 'namespace',
122				'cssclass' => 'namespaceselector',
123				'all' => '',
124				'label' => $this->msg( 'namespace' )->text()
125			],
126			'levelmenu' => $this->getLevelMenu( $level )
127		];
128
129		$htmlForm = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() );
130		$htmlForm
131			->setMethod( 'get' )
132			->setWrapperLegendMsg( 'protectedtitles' )
133			->setSubmitText( $this->msg( 'protectedtitles-submit' )->text() );
134
135		return $htmlForm->prepareForm()->getHTML( false );
136	}
137
138	/**
139	 * @param string $pr_level Determines which option is selected as default
140	 * @return string|array
141	 * @internal
142	 */
143	private function getLevelMenu( $pr_level ) {
144		// Temporary array
145		$m = [ $this->msg( 'restriction-level-all' )->text() => 0 ];
146		$options = [];
147
148		// First pass to load the log names
149		foreach ( $this->getConfig()->get( 'RestrictionLevels' ) as $type ) {
150			if ( $type != '' && $type != '*' ) {
151				// Messages: restriction-level-sysop, restriction-level-autoconfirmed
152				$text = $this->msg( "restriction-level-$type" )->text();
153				$m[$text] = $type;
154			}
155		}
156
157		// Is there only one level (aside from "all")?
158		if ( count( $m ) <= 2 ) {
159			return '';
160		}
161		// Third pass generates sorted XHTML content
162		foreach ( $m as $text => $type ) {
163			$options[ $text ] = $type;
164		}
165
166		return [
167			'type' => 'select',
168			'options' => $options,
169			'label' => $this->msg( 'restriction-level' )->text(),
170			'name' => $this->IdLevel,
171			'id' => $this->IdLevel
172		];
173	}
174
175	protected function getGroupName() {
176		return 'maintenance';
177	}
178}
179