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                         $s = $pager->getNavigationBar();
  60                         $s .= "<ul>" .
  61                                 $pager->getBody() .
  62                                 "</ul>";
  63                         $s .= $pager->getNavigationBar();
  64                 } else {
  65                         $s = '<p>' . wfMsgHtml( 'protectedtitlesempty' ) . '</p>';
  66                 }
  67                 $this->getOutput()->addHTML( $s );
  68         }
  69
  70         /**
  71          * Callback function to output a restriction
  72          *
  73          * @return string
  74          */
  75         function formatRow( $row ) {
  76                 wfProfileIn( __METHOD__ );
  77
  78                 static $infinity = null;
  79
  80                 if( is_null( $infinity ) ){
  81                         $infinity = wfGetDB( DB_SLAVE )->getInfinity();
  82                 }
  83
  84                 $title = Title::makeTitleSafe( $row->pt_namespace, $row->pt_title );
  85                 $link = Linker::link( $title );
  86
  87                 $description_items = array ();
  88
  89                 $protType = wfMsgHtml( 'restriction-level-' . $row->pt_create_perm );
  90
  91                 $description_items[] = $protType;
  92
  93                 $expiry = strlen( $row->pt_expiry ) ? $lang->formatExpiry( $row->pt_expiry, TS_MW ) : $infinity;
  94                 if( $expiry != $infinity ) {
  95                         $expiry_description = wfMsg(
  96                                 'protect-expiring-local',
  97                                 $lang->timeanddate( $expiry, true ),
  98                                 $lang->date( $expiry, true ),
  99                                 $lang->time( $expiry, true )
 100                         );
 101
 102                         $description_items[] = htmlspecialchars($expiry_description);
 103                 }
 104
 105                 wfProfileOut( __METHOD__ );
 106
 107                 return '<li>' . wfSpecialList( $link, implode( $description_items, ', ' ) ) . "</li>\n";
 108         }
 109
 110         /**
 111          * @param $namespace Integer:
 112          * @param $type string
 113          * @param $level string
 114          * @private
 115          */
 116         function showOptions( $namespace, $type='edit', $level ) {
 117                 global $wgScript;
 118                 $action = htmlspecialchars( $wgScript );
 119                 $title = $this->getTitle();
 120                 $special = htmlspecialchars( $title->getPrefixedDBkey() );
 121                 return "<form action=\"$action\" method=\"get\">\n" .
 122                         '<fieldset>' .
 123                         Xml::element( 'legend', array(), wfMsg( 'protectedtitles' ) ) .
 124                         Html::hidden( 'title', $special ) . "&#160;\n" .
 125                         $this->getNamespaceMenu( $namespace ) . "&#160;\n" .
 126                         $this->getLevelMenu( $level ) . "&#160;\n" .
 127                         "&#160;" . Xml::submitButton( wfMsg( 'allpagessubmit' ) ) . "\n" .
 128                         "</fieldset></form>";
 129         }
 130
 131         /**
 132          * Prepare the namespace filter drop-down; standard namespace
 133          * selector, sans the MediaWiki namespace
 134          *
 135          * @param $namespace Mixed: pre-select namespace
 136          * @return string
 137          */
 138         function getNamespaceMenu( $namespace = null ) {
 139                 return Xml::label( wfMsg( 'namespace' ), 'namespace' )
 140                         . '&#160;'
 141                         . Xml::namespaceSelector( $namespace, '' );
 142         }
 143
 144         /**
 145          * @return string Formatted HTML
 146          * @private
 147          */
 148         function getLevelMenu( $pr_level ) {
 149                 global $wgRestrictionLevels;
 150
 151                 $m = array( wfMsg('restriction-level-all') => 0 ); // Temporary array
 152                 $options = array();
 153
 154                 // First pass to load the log names
 155                 foreach( $wgRestrictionLevels as $type ) {
 156                         if ( $type !='' && $type !='*') {
 157                                 $text = wfMsg("restriction-level-$type");
 158                                 $m[$text] = $type;
 159                         }
 160                 }
 161                 // Is there only one level (aside from "all")?
 162                 if( count($m) <= 2 ) {
 163                         return '';
 164                 }
 165                 // Third pass generates sorted XHTML content
 166                 foreach( $m as $text => $type ) {
 167                         $selected = ($type == $pr_level );
 168                         $options[] = Xml::option( $text, $type, $selected );
 169                 }
 170
 171                 return
 172                         Xml::label( wfMsg('restriction-level') , $this->IdLevel ) . '&#160;' .
 173                         Xml::tags( 'select',
 174                                 array( 'id' => $this->IdLevel, 'name' => $this->IdLevel ),
 175                                 implode( "\n", $options ) );
 176         }
 177 }
 178
 179 /**
 180  * @todo document
 181  * @ingroup Pager
 182  */
 183 class ProtectedTitlesPager extends AlphabeticPager {
 184         public $mForm, $mConds;
 185
 186         function __construct( $form, $conds = array(), $type, $level, $namespace, $sizetype='', $size=0 ) {
 187                 $this->mForm = $form;
 188                 $this->mConds = $conds;
 189                 $this->level = $level;
 190                 $this->namespace = $namespace;
 191                 $this->size = intval($size);
 192                 parent::__construct( $form->getContext() );
 193         }
 194
 195         function getStartBody() {
 196                 wfProfileIn( __METHOD__ );
 197                 # Do a link batch query
 198                 $this->mResult->seek( 0 );
 199                 $lb = new LinkBatch;
 200
 201                 foreach ( $this->mResult as $row ) {
 202                         $lb->add( $row->pt_namespace, $row->pt_title );
 203                 }
 204
 205                 $lb->execute();
 206                 wfProfileOut( __METHOD__ );
 207                 return '';
 208         }
 209
 210         function getTitle() {
 211                 return SpecialPage::getTitleFor( 'Protectedtitles' );
 212         }
 213
 214         function formatRow( $row ) {
 215                 return $this->mForm->formatRow( $row );
 216         }
 217
 218         function getQueryInfo() {
 219                 $conds = $this->mConds;
 220                 $conds[] = 'pt_expiry>' . $this->mDb->addQuotes( $this->mDb->timestamp() );
 221                 if( $this->level )
 222                         $conds['pt_create_perm'] = $this->level;
 223                 if( !is_null($this->namespace) )
 224                         $conds[] = 'pt_namespace=' . $this->mDb->addQuotes( $this->namespace );
 225                 return array(
 226                         'tables' => 'protected_titles',
 227                         'fields' => 'pt_namespace,pt_title,pt_create_perm,pt_expiry,pt_timestamp',
 228                         'conds' => $conds
 229                 );
 230         }
 231
 232         function getIndexField() {
 233                 return 'pt_timestamp';
 234         }
 235 }
 236