includes/specials/pagers/ImageListPager.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Pager
  20  */
  21
  22 /**
  23  * @ingroup Pager
  24  */
  25 use MediaWiki\MediaWikiServices;
  26 use Wikimedia\Rdbms\ResultWrapper;
  27 use Wikimedia\Rdbms\FakeResultWrapper;
  28
  29 class ImageListPager extends TablePager {
  30
  31         protected $mFieldNames = null;
  32
  33         // Subclasses should override buildQueryConds instead of using $mQueryConds variable.
  34         protected $mQueryConds = [];
  35
  36         protected $mUserName = null;
  37
  38         /**
  39          * The relevant user
  40          *
  41          * @var User|null
  42          */
  43         protected $mUser = null;
  44
  45         protected $mSearch = '';
  46
  47         protected $mIncluding = false;
  48
  49         protected $mShowAll = false;
  50
  51         protected $mTableName = 'image';
  52
  53         function __construct( IContextSource $context, $userName = null, $search = '',
  54                 $including = false, $showAll = false
  55         ) {
  56                 $this->setContext( $context );
  57                 $this->mIncluding = $including;
  58                 $this->mShowAll = $showAll;
  59
  60                 if ( $userName !== null && $userName !== '' ) {
  61                         $nt = Title::makeTitleSafe( NS_USER, $userName );
  62                         if ( is_null( $nt ) ) {
  63                                 $this->outputUserDoesNotExist( $userName );
  64                         } else {
  65                                 $this->mUserName = $nt->getText();
  66                                 $user = User::newFromName( $this->mUserName, false );
  67                                 if ( $user ) {
  68                                         $this->mUser = $user;
  69                                 }
  70                                 if ( !$user || ( $user->isAnon() && !User::isIP( $user->getName() ) ) ) {
  71                                         $this->outputUserDoesNotExist( $userName );
  72                                 }
  73                         }
  74                 }
  75
  76                 if ( $search !== '' && !$this->getConfig()->get( 'MiserMode' ) ) {
  77                         $this->mSearch = $search;
  78                         $nt = Title::newFromText( $this->mSearch );
  79
  80                         if ( $nt ) {
  81                                 $dbr = wfGetDB( DB_REPLICA );
  82                                 $this->mQueryConds[] = 'LOWER(img_name)' .
  83                                         $dbr->buildLike( $dbr->anyString(),
  84                                                 strtolower( $nt->getDBkey() ), $dbr->anyString() );
  85                         }
  86                 }
  87
  88                 if ( !$including ) {
  89                         if ( $this->getRequest()->getText( 'sort', 'img_date' ) == 'img_date' ) {
  90                                 $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
  91                         } else {
  92                                 $this->mDefaultDirection = IndexPager::DIR_ASCENDING;
  93                         }
  94                 } else {
  95                         $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
  96                 }
  97
  98                 parent::__construct( $context );
  99         }
 100
 101         /**
 102          * Get the user relevant to the ImageList
 103          *
 104          * @return User|null
 105          */
 106         function getRelevantUser() {
 107                 return $this->mUser;
 108         }
 109
 110         /**
 111          * Add a message to the output stating that the user doesn't exist
 112          *
 113          * @param string $userName Unescaped user name
 114          */
 115         protected function outputUserDoesNotExist( $userName ) {
 116                 $this->getOutput()->wrapWikiMsg(
 117                         "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
 118                         [
 119                                 'listfiles-userdoesnotexist',
 120                                 wfEscapeWikiText( $userName ),
 121                         ]
 122                 );
 123         }
 124
 125         /**
 126          * Build the where clause of the query.
 127          *
 128          * Replaces the older mQueryConds member variable.
 129          * @param string $table Either "image" or "oldimage"
 130          * @return array The query conditions.
 131          */
 132         protected function buildQueryConds( $table ) {
 133                 $prefix = $table === 'image' ? 'img' : 'oi';
 134                 $conds = [];
 135
 136                 if ( !is_null( $this->mUserName ) ) {
 137                         $conds[$prefix . '_user_text'] = $this->mUserName;
 138                 }
 139
 140                 if ( $this->mSearch !== '' ) {
 141                         $nt = Title::newFromText( $this->mSearch );
 142                         if ( $nt ) {
 143                                 $dbr = wfGetDB( DB_REPLICA );
 144                                 $conds[] = 'LOWER(' . $prefix . '_name)' .
 145                                         $dbr->buildLike( $dbr->anyString(),
 146                                                 strtolower( $nt->getDBkey() ), $dbr->anyString() );
 147                         }
 148                 }
 149
 150                 if ( $table === 'oldimage' ) {
 151                         // Don't want to deal with revdel.
 152                         // Future fixme: Show partial information as appropriate.
 153                         // Would have to be careful about filtering by username when username is deleted.
 154                         $conds['oi_deleted'] = 0;
 155                 }
 156
 157                 // Add mQueryConds in case anyone was subclassing and using the old variable.
 158                 return $conds + $this->mQueryConds;
 159         }
 160
 161         /**
 162          * @return array
 163          */
 164         function getFieldNames() {
 165                 if ( !$this->mFieldNames ) {
 166                         $this->mFieldNames = [
 167                                 'img_timestamp' => $this->msg( 'listfiles_date' )->text(),
 168                                 'img_name' => $this->msg( 'listfiles_name' )->text(),
 169                                 'thumb' => $this->msg( 'listfiles_thumb' )->text(),
 170                                 'img_size' => $this->msg( 'listfiles_size' )->text(),
 171                         ];
 172                         if ( is_null( $this->mUserName ) ) {
 173                                 // Do not show username if filtering by username
 174                                 $this->mFieldNames['img_user_text'] = $this->msg( 'listfiles_user' )->text();
 175                         }
 176                         // img_description down here, in order so that its still after the username field.
 177                         $this->mFieldNames['img_description'] = $this->msg( 'listfiles_description' )->text();
 178
 179                         if ( !$this->getConfig()->get( 'MiserMode' ) && !$this->mShowAll ) {
 180                                 $this->mFieldNames['count'] = $this->msg( 'listfiles_count' )->text();
 181                         }
 182                         if ( $this->mShowAll ) {
 183                                 $this->mFieldNames['top'] = $this->msg( 'listfiles-latestversion' )->text();
 184                         }
 185                 }
 186
 187                 return $this->mFieldNames;
 188         }
 189
 190         function isFieldSortable( $field ) {
 191                 if ( $this->mIncluding ) {
 192                         return false;
 193                 }
 194                 $sortable = [ 'img_timestamp', 'img_name', 'img_size' ];
 195                 /* For reference, the indicies we can use for sorting are:
 196                  * On the image table: img_user_timestamp, img_usertext_timestamp,
 197                  * img_size, img_timestamp
 198                  * On oldimage: oi_usertext_timestamp, oi_name_timestamp
 199                  *
 200                  * In particular that means we cannot sort by timestamp when not filtering
 201                  * by user and including old images in the results. Which is sad.
 202                  */
 203                 if ( $this->getConfig()->get( 'MiserMode' ) && !is_null( $this->mUserName ) ) {
 204                         // If we're sorting by user, the index only supports sorting by time.
 205                         if ( $field === 'img_timestamp' ) {
 206                                 return true;
 207                         } else {
 208                                 return false;
 209                         }
 210                 } elseif ( $this->getConfig()->get( 'MiserMode' )
 211                         && $this->mShowAll /* && mUserName === null */
 212                 ) {
 213                         // no oi_timestamp index, so only alphabetical sorting in this case.
 214                         if ( $field === 'img_name' ) {
 215                                 return true;
 216                         } else {
 217                                 return false;
 218                         }
 219                 }
 220
 221                 return in_array( $field, $sortable );
 222         }
 223
 224         function getQueryInfo() {
 225                 // Hacky Hacky Hacky - I want to get query info
 226                 // for two different tables, without reimplementing
 227                 // the pager class.
 228                 $qi = $this->getQueryInfoReal( $this->mTableName );
 229
 230                 return $qi;
 231         }
 232
 233         /**
 234          * Actually get the query info.
 235          *
 236          * This is to allow displaying both stuff from image and oldimage table.
 237          *
 238          * This is a bit hacky.
 239          *
 240          * @param string $table Either 'image' or 'oldimage'
 241          * @return array Query info
 242          */
 243         protected function getQueryInfoReal( $table ) {
 244                 $prefix = $table === 'oldimage' ? 'oi' : 'img';
 245
 246                 $tables = [ $table ];
 247                 $fields = $this->getFieldNames();
 248                 unset( $fields['img_description'] );
 249                 $fields = array_keys( $fields );
 250
 251                 if ( $table === 'oldimage' ) {
 252                         foreach ( $fields as $id => &$field ) {
 253                                 if ( substr( $field, 0, 4 ) !== 'img_' ) {
 254                                         continue;
 255                                 }
 256                                 $field = $prefix . substr( $field, 3 ) . ' AS ' . $field;
 257                         }
 258                         $fields[array_search( 'top', $fields )] = "'no' AS top";
 259                 } else {
 260                         if ( $this->mShowAll ) {
 261                                 $fields[array_search( 'top', $fields )] = "'yes' AS top";
 262                         }
 263                 }
 264                 $fields[] = $prefix . '_user AS img_user';
 265                 $fields[array_search( 'thumb', $fields )] = $prefix . '_name AS thumb';
 266
 267                 $options = $join_conds = [];
 268
 269                 # Description field
 270                 $commentQuery = CommentStore::newKey( $prefix . '_description' )->getJoin();
 271                 $tables += $commentQuery['tables'];
 272                 $fields += $commentQuery['fields'];
 273                 $join_conds += $commentQuery['joins'];
 274                 $fields['description_field'] = "'{$prefix}_description'";
 275
 276                 # Depends on $wgMiserMode
 277                 # Will also not happen if mShowAll is true.
 278                 if ( isset( $this->mFieldNames['count'] ) ) {
 279                         $tables[] = 'oldimage';
 280
 281                         # Need to rewrite this one
 282                         foreach ( $fields as &$field ) {
 283                                 if ( $field == 'count' ) {
 284                                         $field = 'COUNT(oi_archive_name) AS count';
 285                                 }
 286                         }
 287                         unset( $field );
 288
 289                         $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
 290                         $options = [ 'GROUP BY' => array_merge( [ 'img_user' ], $columnlist ) ];
 291                         $join_conds['oldimage'] = [ 'LEFT JOIN', 'oi_name = img_name' ];
 292                 }
 293
 294                 return [
 295                         'tables' => $tables,
 296                         'fields' => $fields,
 297                         'conds' => $this->buildQueryConds( $table ),
 298                         'options' => $options,
 299                         'join_conds' => $join_conds
 300                 ];
 301         }
 302
 303         /**
 304          * Override reallyDoQuery to mix together two queries.
 305          *
 306          * @note $asc is named $descending in IndexPager base class. However
 307          *   it is true when the order is ascending, and false when the order
 308          *   is descending, so I renamed it to $asc here.
 309          * @param int $offset
 310          * @param int $limit
 311          * @param bool $asc
 312          * @return array
 313          * @throws MWException
 314          */
 315         function reallyDoQuery( $offset, $limit, $asc ) {
 316                 $prevTableName = $this->mTableName;
 317                 $this->mTableName = 'image';
 318                 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
 319                         $this->buildQueryInfo( $offset, $limit, $asc );
 320                 $imageRes = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
 321                 $this->mTableName = $prevTableName;
 322
 323                 if ( !$this->mShowAll ) {
 324                         return $imageRes;
 325                 }
 326
 327                 $this->mTableName = 'oldimage';
 328
 329                 # Hacky...
 330                 $oldIndex = $this->mIndexField;
 331                 if ( substr( $this->mIndexField, 0, 4 ) !== 'img_' ) {
 332                         throw new MWException( "Expected to be sorting on an image table field" );
 333                 }
 334                 $this->mIndexField = 'oi_' . substr( $this->mIndexField, 4 );
 335
 336                 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
 337                         $this->buildQueryInfo( $offset, $limit, $asc );
 338                 $oldimageRes = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
 339
 340                 $this->mTableName = $prevTableName;
 341                 $this->mIndexField = $oldIndex;
 342
 343                 return $this->combineResult( $imageRes, $oldimageRes, $limit, $asc );
 344         }
 345
 346         /**
 347          * Combine results from 2 tables.
 348          *
 349          * Note: This will throw away some results
 350          *
 351          * @param ResultWrapper $res1
 352          * @param ResultWrapper $res2
 353          * @param int $limit
 354          * @param bool $ascending See note about $asc in $this->reallyDoQuery
 355          * @return FakeResultWrapper $res1 and $res2 combined
 356          */
 357         protected function combineResult( $res1, $res2, $limit, $ascending ) {
 358                 $res1->rewind();
 359                 $res2->rewind();
 360                 $topRes1 = $res1->next();
 361                 $topRes2 = $res2->next();
 362                 $resultArray = [];
 363                 for ( $i = 0; $i < $limit && $topRes1 && $topRes2; $i++ ) {
 364                         if ( strcmp( $topRes1->{$this->mIndexField}, $topRes2->{$this->mIndexField} ) > 0 ) {
 365                                 if ( !$ascending ) {
 366                                         $resultArray[] = $topRes1;
 367                                         $topRes1 = $res1->next();
 368                                 } else {
 369                                         $resultArray[] = $topRes2;
 370                                         $topRes2 = $res2->next();
 371                                 }
 372                         } else {
 373                                 if ( !$ascending ) {
 374                                         $resultArray[] = $topRes2;
 375                                         $topRes2 = $res2->next();
 376                                 } else {
 377                                         $resultArray[] = $topRes1;
 378                                         $topRes1 = $res1->next();
 379                                 }
 380                         }
 381                 }
 382
 383                 // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
 384                 for ( ; $i < $limit && $topRes1; $i++ ) {
 385                         // @codingStandardsIgnoreEnd
 386                         $resultArray[] = $topRes1;
 387                         $topRes1 = $res1->next();
 388                 }
 389
 390                 // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
 391                 for ( ; $i < $limit && $topRes2; $i++ ) {
 392                         // @codingStandardsIgnoreEnd
 393                         $resultArray[] = $topRes2;
 394                         $topRes2 = $res2->next();
 395                 }
 396
 397                 return new FakeResultWrapper( $resultArray );
 398         }
 399
 400         function getDefaultSort() {
 401                 if ( $this->mShowAll && $this->getConfig()->get( 'MiserMode' ) && is_null( $this->mUserName ) ) {
 402                         // Unfortunately no index on oi_timestamp.
 403                         return 'img_name';
 404                 } else {
 405                         return 'img_timestamp';
 406                 }
 407         }
 408
 409         function doBatchLookups() {
 410                 $userIds = [];
 411                 $this->mResult->seek( 0 );
 412                 foreach ( $this->mResult as $row ) {
 413                         $userIds[] = $row->img_user;
 414                 }
 415                 # Do a link batch query for names and userpages
 416                 UserCache::singleton()->doQuery( $userIds, [ 'userpage' ], __METHOD__ );
 417         }
 418
 419         /**
 420          * @param string $field
 421          * @param string $value
 422          * @return Message|string|int The return type depends on the value of $field:
 423          *   - thumb: string
 424          *   - img_timestamp: string
 425          *   - img_name: string
 426          *   - img_user_text: string
 427          *   - img_size: string
 428          *   - img_description: string
 429          *   - count: int
 430          *   - top: Message
 431          * @throws MWException
 432          */
 433         function formatValue( $field, $value ) {
 434                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 435                 switch ( $field ) {
 436                         case 'thumb':
 437                                 $opt = [ 'time' => wfTimestamp( TS_MW, $this->mCurrentRow->img_timestamp ) ];
 438                                 $file = RepoGroup::singleton()->getLocalRepo()->findFile( $value, $opt );
 439                                 // If statement for paranoia
 440                                 if ( $file ) {
 441                                         $thumb = $file->transform( [ 'width' => 180, 'height' => 360 ] );
 442                                         if ( $thumb ) {
 443                                                 return $thumb->toHtml( [ 'desc-link' => true ] );
 444                                         } else {
 445                                                 return wfMessage( 'thumbnail_error', '' )->escaped();
 446                                         }
 447                                 } else {
 448                                         return htmlspecialchars( $value );
 449                                 }
 450                         case 'img_timestamp':
 451                                 // We may want to make this a link to the "old" version when displaying old files
 452                                 return htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) );
 453                         case 'img_name':
 454                                 static $imgfile = null;
 455                                 if ( $imgfile === null ) {
 456                                         $imgfile = $this->msg( 'imgfile' )->text();
 457                                 }
 458
 459                                 // Weird files can maybe exist? T24227
 460                                 $filePage = Title::makeTitleSafe( NS_FILE, $value );
 461                                 if ( $filePage ) {
 462                                         $link = $linkRenderer->makeKnownLink(
 463                                                 $filePage,
 464                                                 $filePage->getText()
 465                                         );
 466                                         $download = Xml::element( 'a',
 467                                                 [ 'href' => wfLocalFile( $filePage )->getUrl() ],
 468                                                 $imgfile
 469                                         );
 470                                         $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
 471
 472                                         // Add delete links if allowed
 473                                         // From https://github.com/Wikia/app/pull/3859
 474                                         if ( $filePage->userCan( 'delete', $this->getUser() ) ) {
 475                                                 $deleteMsg = $this->msg( 'listfiles-delete' )->text();
 476
 477                                                 $delete = $linkRenderer->makeKnownLink(
 478                                                         $filePage, $deleteMsg, [], [ 'action' => 'delete' ]
 479                                                 );
 480                                                 $delete = $this->msg( 'parentheses' )->rawParams( $delete )->escaped();
 481
 482                                                 return "$link $download $delete";
 483                                         }
 484
 485                                         return "$link $download";
 486                                 } else {
 487                                         return htmlspecialchars( $value );
 488                                 }
 489                         case 'img_user_text':
 490                                 if ( $this->mCurrentRow->img_user ) {
 491                                         $name = User::whoIs( $this->mCurrentRow->img_user );
 492                                         $link = $linkRenderer->makeLink(
 493                                                 Title::makeTitle( NS_USER, $name ),
 494                                                 $name
 495                                         );
 496                                 } else {
 497                                         $link = htmlspecialchars( $value );
 498                                 }
 499
 500                                 return $link;
 501                         case 'img_size':
 502                                 return htmlspecialchars( $this->getLanguage()->formatSize( $value ) );
 503                         case 'img_description':
 504                                 $field = $this->mCurrentRow->description_field;
 505                                 $value = CommentStore::newKey( $field )->getComment( $this->mCurrentRow )->text;
 506                                 return Linker::formatComment( $value );
 507                         case 'count':
 508                                 return $this->getLanguage()->formatNum( intval( $value ) + 1 );
 509                         case 'top':
 510                                 // Messages: listfiles-latestversion-yes, listfiles-latestversion-no
 511                                 return $this->msg( 'listfiles-latestversion-' . $value );
 512                         default:
 513                                 throw new MWException( "Unknown field '$field'" );
 514                 }
 515         }
 516
 517         function getForm() {
 518                 $fields = [];
 519                 $fields['limit'] = [
 520                         'type' => 'select',
 521                         'name' => 'limit',
 522                         'label-message' => 'table_pager_limit_label',
 523                         'options' => $this->getLimitSelectList(),
 524                         'default' => $this->mLimit,
 525                 ];
 526
 527                 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
 528                         $fields['ilsearch'] = [
 529                                 'type' => 'text',
 530                                 'name' => 'ilsearch',
 531                                 'id' => 'mw-ilsearch',
 532                                 'label-message' => 'listfiles_search_for',
 533                                 'default' => $this->mSearch,
 534                                 'size' => '40',
 535                                 'maxlength' => '255',
 536                         ];
 537                 }
 538
 539                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 540                 $fields['user'] = [
 541                         'type' => 'text',
 542                         'name' => 'user',
 543                         'id' => 'mw-listfiles-user',
 544                         'label-message' => 'username',
 545                         'default' => $this->mUserName,
 546                         'size' => '40',
 547                         'maxlength' => '255',
 548                         'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
 549                 ];
 550
 551                 $fields['ilshowall'] = [
 552                         'type' => 'check',
 553                         'name' => 'ilshowall',
 554                         'id' => 'mw-listfiles-show-all',
 555                         'label-message' => 'listfiles-show-all',
 556                         'default' => $this->mShowAll,
 557                 ];
 558
 559                 $query = $this->getRequest()->getQueryValues();
 560                 unset( $query['title'] );
 561                 unset( $query['limit'] );
 562                 unset( $query['ilsearch'] );
 563                 unset( $query['ilshowall'] );
 564                 unset( $query['user'] );
 565
 566                 $form = new HTMLForm( $fields, $this->getContext() );
 567
 568                 $form->setMethod( 'get' );
 569                 $form->setTitle( $this->getTitle() );
 570                 $form->setId( 'mw-listfiles-form' );
 571                 $form->setWrapperLegendMsg( 'listfiles' );
 572                 $form->setSubmitTextMsg( 'table_pager_limit_submit' );
 573                 $form->addHiddenFields( $query );
 574
 575                 $form->prepareForm();
 576                 $form->displayForm( '' );
 577         }
 578
 579         protected function getTableClass() {
 580                 return parent::getTableClass() . ' listfiles';
 581         }
 582
 583         protected function getNavClass() {
 584                 return parent::getNavClass() . ' listfiles_nav';
 585         }
 586
 587         protected function getSortHeaderClass() {
 588                 return parent::getSortHeaderClass() . ' listfiles_sort';
 589         }
 590
 591         function getPagingQueries() {
 592                 $queries = parent::getPagingQueries();
 593                 if ( !is_null( $this->mUserName ) ) {
 594                         # Append the username to the query string
 595                         foreach ( $queries as &$query ) {
 596                                 if ( $query !== false ) {
 597                                         $query['user'] = $this->mUserName;
 598                                 }
 599                         }
 600                 }
 601
 602                 return $queries;
 603         }
 604
 605         function getDefaultQuery() {
 606                 $queries = parent::getDefaultQuery();
 607                 if ( !isset( $queries['user'] ) && !is_null( $this->mUserName ) ) {
 608                         $queries['user'] = $this->mUserName;
 609                 }
 610
 611                 return $queries;
 612         }
 613
 614         function getTitle() {
 615                 return SpecialPage::getTitleFor( 'Listfiles' );
 616         }
 617 }