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