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                         $dbr = wfGetDB( DB_REPLICA );
 290                         if ( $dbr->implicitGroupby() ) {
 291                                 $options = [ 'GROUP BY' => 'img_name' ];
 292                         } else {
 293                                 $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
 294                                 $options = [ 'GROUP BY' => array_merge( [ 'img_user' ], $columnlist ) ];
 295                         }
 296                         $join_conds = [ 'oldimage' => [ 'LEFT JOIN', 'oi_name = img_name' ] ];
 297                 }
 298
 299                 return [
 300                         'tables' => $tables,
 301                         'fields' => $fields,
 302                         'conds' => $this->buildQueryConds( $table ),
 303                         'options' => $options,
 304                         'join_conds' => $join_conds
 305                 ];
 306         }
 307
 308         /**
 309          * Override reallyDoQuery to mix together two queries.
 310          *
 311          * @note $asc is named $descending in IndexPager base class. However
 312          *   it is true when the order is ascending, and false when the order
 313          *   is descending, so I renamed it to $asc here.
 314          * @param int $offset
 315          * @param int $limit
 316          * @param bool $asc
 317          * @return array
 318          * @throws MWException
 319          */
 320         function reallyDoQuery( $offset, $limit, $asc ) {
 321                 $prevTableName = $this->mTableName;
 322                 $this->mTableName = 'image';
 323                 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
 324                         $this->buildQueryInfo( $offset, $limit, $asc );
 325                 $imageRes = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
 326                 $this->mTableName = $prevTableName;
 327
 328                 if ( !$this->mShowAll ) {
 329                         return $imageRes;
 330                 }
 331
 332                 $this->mTableName = 'oldimage';
 333
 334                 # Hacky...
 335                 $oldIndex = $this->mIndexField;
 336                 if ( substr( $this->mIndexField, 0, 4 ) !== 'img_' ) {
 337                         throw new MWException( "Expected to be sorting on an image table field" );
 338                 }
 339                 $this->mIndexField = 'oi_' . substr( $this->mIndexField, 4 );
 340
 341                 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
 342                         $this->buildQueryInfo( $offset, $limit, $asc );
 343                 $oldimageRes = $this->mDb->select( $tables, $fields, $conds, $fname, $options, $join_conds );
 344
 345                 $this->mTableName = $prevTableName;
 346                 $this->mIndexField = $oldIndex;
 347
 348                 return $this->combineResult( $imageRes, $oldimageRes, $limit, $asc );
 349         }
 350
 351         /**
 352          * Combine results from 2 tables.
 353          *
 354          * Note: This will throw away some results
 355          *
 356          * @param ResultWrapper $res1
 357          * @param ResultWrapper $res2
 358          * @param int $limit
 359          * @param bool $ascending See note about $asc in $this->reallyDoQuery
 360          * @return FakeResultWrapper $res1 and $res2 combined
 361          */
 362         protected function combineResult( $res1, $res2, $limit, $ascending ) {
 363                 $res1->rewind();
 364                 $res2->rewind();
 365                 $topRes1 = $res1->next();
 366                 $topRes2 = $res2->next();
 367                 $resultArray = [];
 368                 for ( $i = 0; $i < $limit && $topRes1 && $topRes2; $i++ ) {
 369                         if ( strcmp( $topRes1->{$this->mIndexField}, $topRes2->{$this->mIndexField} ) > 0 ) {
 370                                 if ( !$ascending ) {
 371                                         $resultArray[] = $topRes1;
 372                                         $topRes1 = $res1->next();
 373                                 } else {
 374                                         $resultArray[] = $topRes2;
 375                                         $topRes2 = $res2->next();
 376                                 }
 377                         } else {
 378                                 if ( !$ascending ) {
 379                                         $resultArray[] = $topRes2;
 380                                         $topRes2 = $res2->next();
 381                                 } else {
 382                                         $resultArray[] = $topRes1;
 383                                         $topRes1 = $res1->next();
 384                                 }
 385                         }
 386                 }
 387
 388                 // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
 389                 for ( ; $i < $limit && $topRes1; $i++ ) {
 390                         // @codingStandardsIgnoreEnd
 391                         $resultArray[] = $topRes1;
 392                         $topRes1 = $res1->next();
 393                 }
 394
 395                 // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
 396                 for ( ; $i < $limit && $topRes2; $i++ ) {
 397                         // @codingStandardsIgnoreEnd
 398                         $resultArray[] = $topRes2;
 399                         $topRes2 = $res2->next();
 400                 }
 401
 402                 return new FakeResultWrapper( $resultArray );
 403         }
 404
 405         function getDefaultSort() {
 406                 if ( $this->mShowAll && $this->getConfig()->get( 'MiserMode' ) && is_null( $this->mUserName ) ) {
 407                         // Unfortunately no index on oi_timestamp.
 408                         return 'img_name';
 409                 } else {
 410                         return 'img_timestamp';
 411                 }
 412         }
 413
 414         function doBatchLookups() {
 415                 $userIds = [];
 416                 $this->mResult->seek( 0 );
 417                 foreach ( $this->mResult as $row ) {
 418                         $userIds[] = $row->img_user;
 419                 }
 420                 # Do a link batch query for names and userpages
 421                 UserCache::singleton()->doQuery( $userIds, [ 'userpage' ], __METHOD__ );
 422         }
 423
 424         /**
 425          * @param string $field
 426          * @param string $value
 427          * @return Message|string|int The return type depends on the value of $field:
 428          *   - thumb: string
 429          *   - img_timestamp: string
 430          *   - img_name: string
 431          *   - img_user_text: string
 432          *   - img_size: string
 433          *   - img_description: string
 434          *   - count: int
 435          *   - top: Message
 436          * @throws MWException
 437          */
 438         function formatValue( $field, $value ) {
 439                 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 440                 switch ( $field ) {
 441                         case 'thumb':
 442                                 $opt = [ 'time' => wfTimestamp( TS_MW, $this->mCurrentRow->img_timestamp ) ];
 443                                 $file = RepoGroup::singleton()->getLocalRepo()->findFile( $value, $opt );
 444                                 // If statement for paranoia
 445                                 if ( $file ) {
 446                                         $thumb = $file->transform( [ 'width' => 180, 'height' => 360 ] );
 447                                         if ( $thumb ) {
 448                                                 return $thumb->toHtml( [ 'desc-link' => true ] );
 449                                         } else {
 450                                                 return wfMessage( 'thumbnail_error', '' )->escaped();
 451                                         }
 452                                 } else {
 453                                         return htmlspecialchars( $value );
 454                                 }
 455                         case 'img_timestamp':
 456                                 // We may want to make this a link to the "old" version when displaying old files
 457                                 return htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) );
 458                         case 'img_name':
 459                                 static $imgfile = null;
 460                                 if ( $imgfile === null ) {
 461                                         $imgfile = $this->msg( 'imgfile' )->text();
 462                                 }
 463
 464                                 // Weird files can maybe exist? T24227
 465                                 $filePage = Title::makeTitleSafe( NS_FILE, $value );
 466                                 if ( $filePage ) {
 467                                         $link = $linkRenderer->makeKnownLink(
 468                                                 $filePage,
 469                                                 $filePage->getText()
 470                                         );
 471                                         $download = Xml::element( 'a',
 472                                                 [ 'href' => wfLocalFile( $filePage )->getUrl() ],
 473                                                 $imgfile
 474                                         );
 475                                         $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
 476
 477                                         // Add delete links if allowed
 478                                         // From https://github.com/Wikia/app/pull/3859
 479                                         if ( $filePage->userCan( 'delete', $this->getUser() ) ) {
 480                                                 $deleteMsg = $this->msg( 'listfiles-delete' )->text();
 481
 482                                                 $delete = $linkRenderer->makeKnownLink(
 483                                                         $filePage, $deleteMsg, [], [ 'action' => 'delete' ]
 484                                                 );
 485                                                 $delete = $this->msg( 'parentheses' )->rawParams( $delete )->escaped();
 486
 487                                                 return "$link $download $delete";
 488                                         }
 489
 490                                         return "$link $download";
 491                                 } else {
 492                                         return htmlspecialchars( $value );
 493                                 }
 494                         case 'img_user_text':
 495                                 if ( $this->mCurrentRow->img_user ) {
 496                                         $name = User::whoIs( $this->mCurrentRow->img_user );
 497                                         $link = $linkRenderer->makeLink(
 498                                                 Title::makeTitle( NS_USER, $name ),
 499                                                 $name
 500                                         );
 501                                 } else {
 502                                         $link = htmlspecialchars( $value );
 503                                 }
 504
 505                                 return $link;
 506                         case 'img_size':
 507                                 return htmlspecialchars( $this->getLanguage()->formatSize( $value ) );
 508                         case 'img_description':
 509                                 $field = $this->mCurrentRow->description_field;
 510                                 $value = CommentStore::newKey( $field )->getComment( $this->mCurrentRow )->text;
 511                                 return Linker::formatComment( $value );
 512                         case 'count':
 513                                 return $this->getLanguage()->formatNum( intval( $value ) + 1 );
 514                         case 'top':
 515                                 // Messages: listfiles-latestversion-yes, listfiles-latestversion-no
 516                                 return $this->msg( 'listfiles-latestversion-' . $value );
 517                         default:
 518                                 throw new MWException( "Unknown field '$field'" );
 519                 }
 520         }
 521
 522         function getForm() {
 523                 $fields = [];
 524                 $fields['limit'] = [
 525                         'type' => 'select',
 526                         'name' => 'limit',
 527                         'label-message' => 'table_pager_limit_label',
 528                         'options' => $this->getLimitSelectList(),
 529                         'default' => $this->mLimit,
 530                 ];
 531
 532                 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
 533                         $fields['ilsearch'] = [
 534                                 'type' => 'text',
 535                                 'name' => 'ilsearch',
 536                                 'id' => 'mw-ilsearch',
 537                                 'label-message' => 'listfiles_search_for',
 538                                 'default' => $this->mSearch,
 539                                 'size' => '40',
 540                                 'maxlength' => '255',
 541                         ];
 542                 }
 543
 544                 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
 545                 $fields['user'] = [
 546                         'type' => 'text',
 547                         'name' => 'user',
 548                         'id' => 'mw-listfiles-user',
 549                         'label-message' => 'username',
 550                         'default' => $this->mUserName,
 551                         'size' => '40',
 552                         'maxlength' => '255',
 553                         'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
 554                 ];
 555
 556                 $fields['ilshowall'] = [
 557                         'type' => 'check',
 558                         'name' => 'ilshowall',
 559                         'id' => 'mw-listfiles-show-all',
 560                         'label-message' => 'listfiles-show-all',
 561                         'default' => $this->mShowAll,
 562                 ];
 563
 564                 $query = $this->getRequest()->getQueryValues();
 565                 unset( $query['title'] );
 566                 unset( $query['limit'] );
 567                 unset( $query['ilsearch'] );
 568                 unset( $query['ilshowall'] );
 569                 unset( $query['user'] );
 570
 571                 $form = new HTMLForm( $fields, $this->getContext() );
 572
 573                 $form->setMethod( 'get' );
 574                 $form->setTitle( $this->getTitle() );
 575                 $form->setId( 'mw-listfiles-form' );
 576                 $form->setWrapperLegendMsg( 'listfiles' );
 577                 $form->setSubmitTextMsg( 'table_pager_limit_submit' );
 578                 $form->addHiddenFields( $query );
 579
 580                 $form->prepareForm();
 581                 $form->displayForm( '' );
 582         }
 583
 584         protected function getTableClass() {
 585                 return parent::getTableClass() . ' listfiles';
 586         }
 587
 588         protected function getNavClass() {
 589                 return parent::getNavClass() . ' listfiles_nav';
 590         }
 591
 592         protected function getSortHeaderClass() {
 593                 return parent::getSortHeaderClass() . ' listfiles_sort';
 594         }
 595
 596         function getPagingQueries() {
 597                 $queries = parent::getPagingQueries();
 598                 if ( !is_null( $this->mUserName ) ) {
 599                         # Append the username to the query string
 600                         foreach ( $queries as &$query ) {
 601                                 if ( $query !== false ) {
 602                                         $query['user'] = $this->mUserName;
 603                                 }
 604                         }
 605                 }
 606
 607                 return $queries;
 608         }
 609
 610         function getDefaultQuery() {
 611                 $queries = parent::getDefaultQuery();
 612                 if ( !isset( $queries['user'] ) && !is_null( $this->mUserName ) ) {
 613                         $queries['user'] = $this->mUserName;
 614                 }
 615
 616                 return $queries;
 617         }
 618
 619         function getTitle() {
 620                 return SpecialPage::getTitleFor( 'Listfiles' );
 621         }
 622 }