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