includes/specials/SpecialShortpages.php

   1 <?php
   2 /**
   3  * Implements Special:Shortpages
   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 use MediaWiki\MediaWikiServices;
  25 use Wikimedia\Rdbms\IResultWrapper;
  26 use Wikimedia\Rdbms\IDatabase;
  27
  28 /**
  29  * SpecialShortpages extends QueryPage. It is used to return the shortest
  30  * pages in the database.
  31  *
  32  * @ingroup SpecialPage
  33  */
  34 class ShortPagesPage extends QueryPage {
  35
  36         function __construct( $name = 'Shortpages' ) {
  37                 parent::__construct( $name );
  38         }
  39
  40         function isSyndicated() {
  41                 return false;
  42         }
  43
  44         public function getQueryInfo() {
  45                 $config = $this->getConfig();
  46                 $blacklist = $config->get( 'ShortPagesNamespaceBlacklist' );
  47                 $tables = [ 'page' ];
  48                 $conds = [
  49                         'page_namespace' => array_diff(
  50                                 MediaWikiServices::getInstance()->getNamespaceInfo()->getContentNamespaces(),
  51                                 $blacklist
  52                         ),
  53                         'page_is_redirect' => 0
  54                 ];
  55                 $joinConds = [];
  56                 $options = [ 'USE INDEX' => [ 'page' => 'page_redirect_namespace_len' ] ];
  57
  58                 // Allow extensions to modify the query
  59                 Hooks::run( 'ShortPagesQuery', [ &$tables, &$conds, &$joinConds, &$options ] );
  60
  61                 return [
  62                         'tables' => $tables,
  63                         'fields' => [
  64                                 'namespace' => 'page_namespace',
  65                                 'title' => 'page_title',
  66                                 'value' => 'page_len'
  67                         ],
  68                         'conds' => $conds,
  69                         'join_conds' => $joinConds,
  70                         'options' => $options
  71                 ];
  72         }
  73
  74         public function reallyDoQuery( $limit, $offset = false ) {
  75                 $fname = static::class . '::reallyDoQuery';
  76                 $dbr = $this->getRecacheDB();
  77                 $query = $this->getQueryInfo();
  78                 $order = $this->getOrderFields();
  79
  80                 if ( $this->sortDescending() ) {
  81                         foreach ( $order as &$field ) {
  82                                 $field .= ' DESC';
  83                         }
  84                 }
  85
  86                 $tables = isset( $query['tables'] ) ? (array)$query['tables'] : [];
  87                 $fields = isset( $query['fields'] ) ? (array)$query['fields'] : [];
  88                 $conds = isset( $query['conds'] ) ? (array)$query['conds'] : [];
  89                 $options = isset( $query['options'] ) ? (array)$query['options'] : [];
  90                 $join_conds = isset( $query['join_conds'] ) ? (array)$query['join_conds'] : [];
  91
  92                 if ( $limit !== false ) {
  93                         $options['LIMIT'] = intval( $limit );
  94                 }
  95
  96                 if ( $offset !== false ) {
  97                         $options['OFFSET'] = intval( $offset );
  98                 }
  99
 100                 $namespaces = $conds['page_namespace'];
 101                 if ( count( $namespaces ) === 1 ) {
 102                         $options['ORDER BY'] = $order;
 103                         $res = $dbr->select( $tables, $fields, $conds, $fname,
 104                                 $options, $join_conds
 105                         );
 106                 } else {
 107                         unset( $conds['page_namespace'] );
 108                         $options['INNER ORDER BY'] = $order;
 109                         $options['ORDER BY'] = [ 'value' . ( $this->sortDescending() ? ' DESC' : '' ) ];
 110                         $sql = $dbr->unionConditionPermutations(
 111                                 $tables,
 112                                 $fields,
 113                                 [ 'page_namespace' => $namespaces ],
 114                                 $conds,
 115                                 $fname,
 116                                 $options,
 117                                 $join_conds
 118                         );
 119                         $res = $dbr->query( $sql, $fname );
 120                 }
 121
 122                 return $res;
 123         }
 124
 125         function getOrderFields() {
 126                 return [ 'page_len' ];
 127         }
 128
 129         /**
 130          * @param IDatabase $db
 131          * @param IResultWrapper $res
 132          */
 133         function preprocessResults( $db, $res ) {
 134                 $this->executeLBFromResultWrapper( $res );
 135         }
 136
 137         function sortDescending() {
 138                 return false;
 139         }
 140
 141         /**
 142          * @param Skin $skin
 143          * @param object $result Result row
 144          * @return string
 145          */
 146         function formatResult( $skin, $result ) {
 147                 $dm = $this->getLanguage()->getDirMark();
 148
 149                 $title = Title::makeTitleSafe( $result->namespace, $result->title );
 150                 if ( !$title ) {
 151                         return Html::element( 'span', [ 'class' => 'mw-invalidtitle' ],
 152                                 Linker::getInvalidTitleDescription( $this->getContext(), $result->namespace, $result->title ) );
 153                 }
 154
 155                 $linkRenderer = $this->getLinkRenderer();
 156                 $hlink = $linkRenderer->makeKnownLink(
 157                         $title,
 158                         $this->msg( 'hist' )->text(),
 159                         [],
 160                         [ 'action' => 'history' ]
 161                 );
 162                 $hlinkInParentheses = $this->msg( 'parentheses' )->rawParams( $hlink )->escaped();
 163
 164                 if ( $this->isCached() ) {
 165                         $plink = $linkRenderer->makeLink( $title );
 166                         $exists = $title->exists();
 167                 } else {
 168                         $plink = $linkRenderer->makeKnownLink( $title );
 169                         $exists = true;
 170                 }
 171
 172                 $size = $this->msg( 'nbytes' )->numParams( $result->value )->escaped();
 173
 174                 return $exists
 175                         ? "${hlinkInParentheses} {$dm}{$plink} {$dm}[{$size}]"
 176                         : "<del>${hlinkInParentheses} {$dm}{$plink} {$dm}[{$size}]</del>";
 177         }
 178
 179         protected function getGroupName() {
 180                 return 'maintenance';
 181         }
 182 }