3 * Implements Special:Protectedpages
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.
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.
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
21 * @ingroup SpecialPage
25 * A special page that lists protected pages
27 * @ingroup SpecialPage
29 class SpecialProtectedpages
extends SpecialPage
{
31 protected $IdLevel = 'level';
32 protected $IdType = 'type';
34 public function __construct() {
35 parent
::__construct( 'Protectedpages' );
38 public function execute( $par ) {
39 global $wgOut, $wgRequest;
42 $this->outputHeader();
44 // Purge expired entries on one in every 10 queries
45 if( !mt_rand( 0, 10 ) ) {
46 Title
::purgeExpiredRestrictions();
49 $type = $wgRequest->getVal( $this->IdType
);
50 $level = $wgRequest->getVal( $this->IdLevel
);
51 $sizetype = $wgRequest->getVal( 'sizetype' );
52 $size = $wgRequest->getIntOrNull( 'size' );
53 $NS = $wgRequest->getIntOrNull( 'namespace' );
54 $indefOnly = $wgRequest->getBool( 'indefonly' ) ?
1 : 0;
55 $cascadeOnly = $wgRequest->getBool('cascadeonly') ?
1 : 0;
57 $pager = new ProtectedPagesPager( $this, array(), $type, $level, $NS, $sizetype, $size, $indefOnly, $cascadeOnly );
59 $wgOut->addHTML( $this->showOptions( $NS, $type, $level, $sizetype, $size, $indefOnly, $cascadeOnly ) );
61 if( $pager->getNumRows() ) {
62 $s = $pager->getNavigationBar();
66 $s .= $pager->getNavigationBar();
68 $s = '<p>' . wfMsgHtml( 'protectedpagesempty' ) . '</p>';
70 $wgOut->addHTML( $s );
74 * Callback function to output a restriction
75 * @param $row object Protected title
76 * @return string Formatted <li> element
78 public function formatRow( $row ) {
79 global $wgUser, $wgLang, $wgContLang;
81 wfProfileIn( __METHOD__
);
85 if( is_null( $skin ) )
86 $skin = $wgUser->getSkin();
88 $title = Title
::makeTitleSafe( $row->page_namespace
, $row->page_title
);
89 $link = $skin->link( $title );
91 $description_items = array ();
93 $protType = wfMsgHtml( 'restriction-level-' . $row->pr_level
);
95 $description_items[] = $protType;
97 if( $row->pr_cascade
) {
98 $description_items[] = wfMsg( 'protect-summary-cascade' );
103 if( $row->pr_expiry
!= 'infinity' && strlen($row->pr_expiry
) ) {
104 $expiry = Block
::decodeExpiry( $row->pr_expiry
);
106 $expiry_description = wfMsg( 'protect-expiring' , $wgLang->timeanddate( $expiry ) ,
107 $wgLang->date( $expiry ) , $wgLang->time( $expiry ) );
109 $description_items[] = htmlspecialchars($expiry_description);
112 if(!is_null($size = $row->page_len
)) {
113 $stxt = $wgContLang->getDirMark() . ' ' . $skin->formatRevisionSize( $size );
116 # Show a link to the change protection form for allowed users otherwise a link to the protection log
117 if( $wgUser->isAllowed( 'protect' ) ) {
118 $changeProtection = ' (' . $skin->linkKnown(
120 wfMsgHtml( 'protect_change' ),
122 array( 'action' => 'unprotect' )
125 $ltitle = SpecialPage
::getTitleFor( 'Log' );
126 $changeProtection = ' (' . $skin->linkKnown(
128 wfMsgHtml( 'protectlogpage' ),
132 'page' => $title->getPrefixedText()
137 wfProfileOut( __METHOD__
);
139 return Html
::rawElement(
142 wfSpecialList( $link . $stxt, $wgLang->commaList( $description_items ) ) . $changeProtection ) . "\n";
146 * @param $namespace Integer
147 * @param $type String: restriction type
148 * @param $level String: restriction level
149 * @param $sizetype String: "min" or "max"
150 * @param $size Integer
151 * @param $indefOnly Boolean: only indefinie protection
152 * @param $cascadeOnly Boolean: only cascading protection
153 * @return String: input form
155 protected function showOptions( $namespace, $type='edit', $level, $sizetype, $size, $indefOnly, $cascadeOnly ) {
157 $title = SpecialPage
::getTitleFor( 'Protectedpages' );
158 return Xml
::openElement( 'form', array( 'method' => 'get', 'action' => $wgScript ) ) .
159 Xml
::openElement( 'fieldset' ) .
160 Xml
::element( 'legend', array(), wfMsg( 'protectedpages' ) ) .
161 Html
::hidden( 'title', $title->getPrefixedDBkey() ) . "\n" .
162 $this->getNamespaceMenu( $namespace ) . " \n" .
163 $this->getTypeMenu( $type ) . " \n" .
164 $this->getLevelMenu( $level ) . " \n" .
165 "<br /><span style='white-space: nowrap'>" .
166 $this->getExpiryCheck( $indefOnly ) . " \n" .
167 $this->getCascadeCheck( $cascadeOnly ) . " \n" .
168 "</span><br /><span style='white-space: nowrap'>" .
169 $this->getSizeLimit( $sizetype, $size ) . " \n" .
171 " " . Xml
::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" .
172 Xml
::closeElement( 'fieldset' ) .
173 Xml
::closeElement( 'form' );
177 * Prepare the namespace filter drop-down; standard namespace
178 * selector, sans the MediaWiki namespace
180 * @param $namespace Mixed: pre-select namespace
183 protected function getNamespaceMenu( $namespace = null ) {
184 return "<span style='white-space: nowrap'>" .
185 Xml
::label( wfMsg( 'namespace' ), 'namespace' ) . ' '
186 . Xml
::namespaceSelector( $namespace, '' ) . "</span>";
190 * @return string Formatted HTML
192 protected function getExpiryCheck( $indefOnly ) {
194 Xml
::checkLabel( wfMsg('protectedpages-indef'), 'indefonly', 'indefonly', $indefOnly ) . "\n";
198 * @return string Formatted HTML
200 protected function getCascadeCheck( $cascadeOnly ) {
202 Xml
::checkLabel( wfMsg('protectedpages-cascade'), 'cascadeonly', 'cascadeonly', $cascadeOnly ) . "\n";
206 * @return string Formatted HTML
208 protected function getSizeLimit( $sizetype, $size ) {
209 $max = $sizetype === 'max';
212 Xml
::radioLabel( wfMsg('minimum-size'), 'sizetype', 'min', 'wpmin', !$max ) .
214 Xml
::radioLabel( wfMsg('maximum-size'), 'sizetype', 'max', 'wpmax', $max ) .
216 Xml
::input( 'size', 9, $size, array( 'id' => 'wpsize' ) ) .
218 Xml
::label( wfMsg('pagesize'), 'wpsize' );
222 * Creates the input label of the restriction type
223 * @param $pr_type string Protection type
224 * @return string Formatted HTML
226 protected function getTypeMenu( $pr_type ) {
227 $m = array(); // Temporary array
230 // First pass to load the log names
231 foreach( Title
::getFilteredRestrictionTypes( true ) as $type ) {
232 $text = wfMsg("restriction-$type");
236 // Third pass generates sorted XHTML content
237 foreach( $m as $text => $type ) {
238 $selected = ($type == $pr_type );
239 $options[] = Xml
::option( $text, $type, $selected ) . "\n";
242 return "<span style='white-space: nowrap'>" .
243 Xml
::label( wfMsg('restriction-type') , $this->IdType
) . ' ' .
245 array( 'id' => $this->IdType
, 'name' => $this->IdType
),
246 implode( "\n", $options ) ) . "</span>";
250 * Creates the input label of the restriction level
251 * @param $pr_level string Protection level
252 * @return string Formatted HTML
254 protected function getLevelMenu( $pr_level ) {
255 global $wgRestrictionLevels;
257 $m = array( wfMsg('restriction-level-all') => 0 ); // Temporary array
260 // First pass to load the log names
261 foreach( $wgRestrictionLevels as $type ) {
262 // Messages used can be 'restriction-level-sysop' and 'restriction-level-autoconfirmed'
263 if( $type !='' && $type !='*') {
264 $text = wfMsg("restriction-level-$type");
269 // Third pass generates sorted XHTML content
270 foreach( $m as $text => $type ) {
271 $selected = ($type == $pr_level );
272 $options[] = Xml
::option( $text, $type, $selected );
275 return "<span style='white-space: nowrap'>" .
276 Xml
::label( wfMsg( 'restriction-level' ) , $this->IdLevel
) . ' ' .
278 array( 'id' => $this->IdLevel
, 'name' => $this->IdLevel
),
279 implode( "\n", $options ) ) . "</span>";
287 class ProtectedPagesPager
extends AlphabeticPager
{
288 public $mForm, $mConds;
289 private $type, $level, $namespace, $sizetype, $size, $indefonly;
291 function __construct( $form, $conds = array(), $type, $level, $namespace, $sizetype='', $size=0,
292 $indefonly = false, $cascadeonly = false )
294 $this->mForm
= $form;
295 $this->mConds
= $conds;
296 $this->type
= ( $type ) ?
$type : 'edit';
297 $this->level
= $level;
298 $this->namespace = $namespace;
299 $this->sizetype
= $sizetype;
300 $this->size
= intval($size);
301 $this->indefonly
= (bool)$indefonly;
302 $this->cascadeonly
= (bool)$cascadeonly;
303 parent
::__construct();
306 function getStartBody() {
307 # Do a link batch query
309 foreach ( $this->mResult
as $row ) {
310 $lb->add( $row->page_namespace
, $row->page_title
);
316 function formatRow( $row ) {
317 return $this->mForm
->formatRow( $row );
320 function getQueryInfo() {
321 $conds = $this->mConds
;
322 $conds[] = '(pr_expiry>' . $this->mDb
->addQuotes( $this->mDb
->timestamp() ) .
323 'OR pr_expiry IS NULL)';
324 $conds[] = 'page_id=pr_page';
325 $conds[] = 'pr_type=' . $this->mDb
->addQuotes( $this->type
);
327 if( $this->sizetype
=='min' ) {
328 $conds[] = 'page_len>=' . $this->size
;
329 } else if( $this->sizetype
=='max' ) {
330 $conds[] = 'page_len<=' . $this->size
;
333 if( $this->indefonly
) {
334 $conds[] = "pr_expiry = 'infinity' OR pr_expiry IS NULL";
336 if( $this->cascadeonly
) {
337 $conds[] = "pr_cascade = '1'";
341 $conds[] = 'pr_level=' . $this->mDb
->addQuotes( $this->level
);
342 if( !is_null($this->namespace) )
343 $conds[] = 'page_namespace=' . $this->mDb
->addQuotes( $this->namespace );
345 'tables' => array( 'page_restrictions', 'page' ),
346 'fields' => 'pr_id,page_namespace,page_title,page_len,pr_type,pr_level,pr_expiry,pr_cascade',
351 function getIndexField() {