includes/specials/SpecialProtectedtitles.php

   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  */
  29 class SpecialProtectedtitles extends SpecialPage {
  30         protected $IdLevel = 'level';
  31         protected $IdType = 'type';
  32
  33         public function __construct() {
  34                 parent::__construct( 'Protectedtitles' );
  35         }
  36
  37         function execute( $par ) {
  38                 $this->setHeaders();
  39                 $this->outputHeader();
  40
  41                 // Purge expired entries on one in every 10 queries
  42                 if ( !mt_rand( 0, 10 ) ) {
  43                         Title::purgeExpiredRestrictions();
  44                 }
  45
  46                 $request = $this->getRequest();
  47                 $type = $request->getVal( $this->IdType );
  48                 $level = $request->getVal( $this->IdLevel );
  49                 $sizetype = $request->getVal( 'sizetype' );
  50                 $size = $request->getIntOrNull( 'size' );
  51                 $NS = $request->getIntOrNull( 'namespace' );
  52
  53                 $pager = new ProtectedTitlesPager( $this, array(), $type, $level, $NS, $sizetype, $size );
  54
  55                 $this->getOutput()->addHTML( $this->showOptions( $NS, $type, $level ) );
  56
  57                 if ( $pager->getNumRows() ) {
  58                         $this->getOutput()->addHTML(
  59                                 $pager->getNavigationBar() .
  60                                         '<ul>' . $pager->getBody() . '</ul>' .
  61                                         $pager->getNavigationBar()
  62                         );
  63                 } else {
  64                         $this->getOutput()->addWikiMsg( 'protectedtitlesempty' );
  65                 }
  66         }
  67
  68         /**
  69          * Callback function to output a restriction
  70          *
  71          * @param object $row Database row
  72          * @return string
  73          */
  74         function formatRow( $row ) {
  75                 wfProfileIn( __METHOD__ );
  76
  77                 static $infinity = null;
  78
  79                 if ( is_null( $infinity ) ) {
  80                         $infinity = wfGetDB( DB_SLAVE )->getInfinity();
  81                 }
  82
  83                 $title = Title::makeTitleSafe( $row->pt_namespace, $row->pt_title );
  84                 if ( !$title ) {
  85                         wfProfileOut( __METHOD__ );
  86
  87                         return Html::rawElement(
  88                                 'li',
  89                                 array(),
  90                                 Html::element(
  91                                         'span',
  92                                         array( 'class' => 'mw-invalidtitle' ),
  93                                         Linker::getInvalidTitleDescription(
  94                                                 $this->getContext(),
  95                                                 $row->pt_namespace,
  96                                                 $row->pt_title
  97                                         )
  98                                 )
  99                         ) . "\n";
 100                 }
 101
 102                 $link = Linker::link( $title );
 103                 $description_items = array();
 104                 $protType = $this->msg( 'restriction-level-' . $row->pt_create_perm )->escaped();
 105                 $description_items[] = $protType;
 106                 $lang = $this->getLanguage();
 107                 $expiry = strlen( $row->pt_expiry ) ?
 108                         $lang->formatExpiry( $row->pt_expiry, TS_MW ) :
 109                         $infinity;
 110
 111                 if ( $expiry != $infinity ) {
 112                         $user = $this->getUser();
 113                         $description_items[] = $this->msg(
 114                                 'protect-expiring-local',
 115                                 $lang->userTimeAndDate( $expiry, $user ),
 116                                 $lang->userDate( $expiry, $user ),
 117                                 $lang->userTime( $expiry, $user )
 118                         )->escaped();
 119                 }
 120
 121                 wfProfileOut( __METHOD__ );
 122
 123                 // @todo i18n: This should use a comma separator instead of a hard coded comma, right?
 124                 return '<li>' . $lang->specialList( $link, implode( $description_items, ', ' ) ) . "</li>\n";
 125         }
 126
 127         /**
 128          * @param $namespace Integer:
 129          * @param $type string
 130          * @param $level string
 131          * @return string
 132          * @private
 133          */
 134         function showOptions( $namespace, $type = 'edit', $level ) {
 135                 global $wgScript;
 136                 $action = htmlspecialchars( $wgScript );
 137                 $title = $this->getTitle();
 138                 $special = htmlspecialchars( $title->getPrefixedDBkey() );
 139
 140                 return "<form action=\"$action\" method=\"get\">\n" .
 141                         '<fieldset>' .
 142                         Xml::element( 'legend', array(), $this->msg( 'protectedtitles' )->text() ) .
 143                         Html::hidden( 'title', $special ) . "&#160;\n" .
 144                         $this->getNamespaceMenu( $namespace ) . "&#160;\n" .
 145                         $this->getLevelMenu( $level ) . "&#160;\n" .
 146                         "&#160;" . Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "\n" .
 147                         "</fieldset></form>";
 148         }
 149
 150         /**
 151          * Prepare the namespace filter drop-down; standard namespace
 152          * selector, sans the MediaWiki namespace
 153          *
 154          * @param $namespace Mixed: pre-select namespace
 155          * @return string
 156          */
 157         function getNamespaceMenu( $namespace = null ) {
 158                 return Html::namespaceSelector(
 159                         array(
 160                                 'selected' => $namespace,
 161                                 'all' => '',
 162                                 'label' => $this->msg( 'namespace' )->text()
 163                         ), array(
 164                                 'name' => 'namespace',
 165                                 'id' => 'namespace',
 166                                 'class' => 'namespaceselector',
 167                         )
 168                 );
 169         }
 170
 171         /**
 172          * @param string $pr_level Determines which option is selected as default
 173          * @return string Formatted HTML
 174          * @private
 175          */
 176         function getLevelMenu( $pr_level ) {
 177                 global $wgRestrictionLevels;
 178
 179                 // Temporary array
 180                 $m = array( $this->msg( 'restriction-level-all' )->text() => 0 );
 181                 $options = array();
 182
 183                 // First pass to load the log names
 184                 foreach ( $wgRestrictionLevels as $type ) {
 185                         if ( $type != '' && $type != '*' ) {
 186                                 $text = $this->msg( "restriction-level-$type" )->text();
 187                                 $m[$text] = $type;
 188                         }
 189                 }
 190
 191                 // Is there only one level (aside from "all")?
 192                 if ( count( $m ) <= 2 ) {
 193                         return '';
 194                 }
 195                 // Third pass generates sorted XHTML content
 196                 foreach ( $m as $text => $type ) {
 197                         $selected = ( $type == $pr_level );
 198                         $options[] = Xml::option( $text, $type, $selected );
 199                 }
 200
 201                 return Xml::label( $this->msg( 'restriction-level' )->text(), $this->IdLevel ) . '&#160;' .
 202                         Xml::tags( 'select',
 203                                 array( 'id' => $this->IdLevel, 'name' => $this->IdLevel ),
 204                                 implode( "\n", $options ) );
 205         }
 206
 207         protected function getGroupName() {
 208                 return 'maintenance';
 209         }
 210 }
 211
 212 /**
 213  * @todo document
 214  * @ingroup Pager
 215  */
 216 class ProtectedTitlesPager extends AlphabeticPager {
 217         public $mForm, $mConds;
 218
 219         function __construct( $form, $conds = array(), $type, $level, $namespace,
 220                 $sizetype = '', $size = 0
 221         ) {
 222                 $this->mForm = $form;
 223                 $this->mConds = $conds;
 224                 $this->level = $level;
 225                 $this->namespace = $namespace;
 226                 $this->size = intval( $size );
 227                 parent::__construct( $form->getContext() );
 228         }
 229
 230         function getStartBody() {
 231                 wfProfileIn( __METHOD__ );
 232                 # Do a link batch query
 233                 $this->mResult->seek( 0 );
 234                 $lb = new LinkBatch;
 235
 236                 foreach ( $this->mResult as $row ) {
 237                         $lb->add( $row->pt_namespace, $row->pt_title );
 238                 }
 239
 240                 $lb->execute();
 241                 wfProfileOut( __METHOD__ );
 242
 243                 return '';
 244         }
 245
 246         /**
 247          * @return Title
 248          */
 249         function getTitle() {
 250                 return $this->mForm->getTitle();
 251         }
 252
 253         function formatRow( $row ) {
 254                 return $this->mForm->formatRow( $row );
 255         }
 256
 257         /**
 258          * @return array
 259          */
 260         function getQueryInfo() {
 261                 $conds = $this->mConds;
 262                 $conds[] = 'pt_expiry>' . $this->mDb->addQuotes( $this->mDb->timestamp() );
 263                 if ( $this->level ) {
 264                         $conds['pt_create_perm'] = $this->level;
 265                 }
 266
 267                 if ( !is_null( $this->namespace ) ) {
 268                         $conds[] = 'pt_namespace=' . $this->mDb->addQuotes( $this->namespace );
 269                 }
 270
 271                 return array(
 272                         'tables' => 'protected_titles',
 273                         'fields' => array( 'pt_namespace', 'pt_title', 'pt_create_perm',
 274                                 'pt_expiry', 'pt_timestamp' ),
 275                         'conds' => $conds
 276                 );
 277         }
 278
 279         function getIndexField() {
 280                 return 'pt_timestamp';
 281         }
 282 }