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.
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.
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
25 use MediaWiki\MediaWikiServices
;
26 use Wikimedia\Rdbms\IResultWrapper
;
27 use Wikimedia\Rdbms\FakeResultWrapper
;
29 class ImageListPager
extends TablePager
{
31 protected $mFieldNames = null;
33 // Subclasses should override buildQueryConds instead of using $mQueryConds variable.
34 protected $mQueryConds = [];
36 protected $mUserName = null;
43 protected $mUser = null;
45 protected $mSearch = '';
47 protected $mIncluding = false;
49 protected $mShowAll = false;
51 protected $mTableName = 'image';
53 function __construct( IContextSource
$context, $userName = null, $search = '',
54 $including = false, $showAll = false
56 $this->setContext( $context );
57 $this->mIncluding
= $including;
58 $this->mShowAll
= $showAll;
60 if ( $userName !== null && $userName !== '' ) {
61 $nt = Title
::makeTitleSafe( NS_USER
, $userName );
62 if ( is_null( $nt ) ) {
63 $this->outputUserDoesNotExist( $userName );
65 $this->mUserName
= $nt->getText();
66 $user = User
::newFromName( $this->mUserName
, false );
70 if ( !$user ||
( $user->isAnon() && !User
::isIP( $user->getName() ) ) ) {
71 $this->outputUserDoesNotExist( $userName );
76 if ( $search !== '' && !$this->getConfig()->get( 'MiserMode' ) ) {
77 $this->mSearch
= $search;
78 $nt = Title
::newFromText( $this->mSearch
);
81 $dbr = wfGetDB( DB_REPLICA
);
82 $this->mQueryConds
[] = 'LOWER(img_name)' .
83 $dbr->buildLike( $dbr->anyString(),
84 strtolower( $nt->getDBkey() ), $dbr->anyString() );
89 if ( $this->getRequest()->getText( 'sort', 'img_date' ) == 'img_date' ) {
90 $this->mDefaultDirection
= IndexPager
::DIR_DESCENDING
;
92 $this->mDefaultDirection
= IndexPager
::DIR_ASCENDING
;
95 $this->mDefaultDirection
= IndexPager
::DIR_DESCENDING
;
98 parent
::__construct( $context );
102 * Get the user relevant to the ImageList
106 function getRelevantUser() {
111 * Add a message to the output stating that the user doesn't exist
113 * @param string $userName Unescaped user name
115 protected function outputUserDoesNotExist( $userName ) {
116 $this->getOutput()->wrapWikiMsg(
117 "<div class=\"mw-userpage-userdoesnotexist error\">\n$1\n</div>",
119 'listfiles-userdoesnotexist',
120 wfEscapeWikiText( $userName ),
126 * Build the where clause of the query.
128 * Replaces the older mQueryConds member variable.
129 * @param string $table Either "image" or "oldimage"
130 * @return array The query conditions.
132 protected function buildQueryConds( $table ) {
133 $prefix = $table === 'image' ?
'img' : 'oi';
136 if ( !is_null( $this->mUserName
) ) {
137 // getQueryInfoReal() should have handled the tables and joins.
138 $dbr = wfGetDB( DB_REPLICA
);
139 $actorWhere = ActorMigration
::newMigration()->getWhere(
142 User
::newFromName( $this->mUserName
, false )
144 $conds[] = $actorWhere['conds'];
147 if ( $this->mSearch
!== '' ) {
148 $nt = Title
::newFromText( $this->mSearch
);
150 $dbr = wfGetDB( DB_REPLICA
);
151 $conds[] = 'LOWER(' . $prefix . '_name)' .
152 $dbr->buildLike( $dbr->anyString(),
153 strtolower( $nt->getDBkey() ), $dbr->anyString() );
157 if ( $table === 'oldimage' ) {
158 // Don't want to deal with revdel.
159 // Future fixme: Show partial information as appropriate.
160 // Would have to be careful about filtering by username when username is deleted.
161 $conds['oi_deleted'] = 0;
164 // Add mQueryConds in case anyone was subclassing and using the old variable.
165 return $conds +
$this->mQueryConds
;
171 function getFieldNames() {
172 if ( !$this->mFieldNames
) {
173 $this->mFieldNames
= [
174 'img_timestamp' => $this->msg( 'listfiles_date' )->text(),
175 'img_name' => $this->msg( 'listfiles_name' )->text(),
176 'thumb' => $this->msg( 'listfiles_thumb' )->text(),
177 'img_size' => $this->msg( 'listfiles_size' )->text(),
179 if ( is_null( $this->mUserName
) ) {
180 // Do not show username if filtering by username
181 $this->mFieldNames
['img_user_text'] = $this->msg( 'listfiles_user' )->text();
183 // img_description down here, in order so that its still after the username field.
184 $this->mFieldNames
['img_description'] = $this->msg( 'listfiles_description' )->text();
186 if ( !$this->getConfig()->get( 'MiserMode' ) && !$this->mShowAll
) {
187 $this->mFieldNames
['count'] = $this->msg( 'listfiles_count' )->text();
189 if ( $this->mShowAll
) {
190 $this->mFieldNames
['top'] = $this->msg( 'listfiles-latestversion' )->text();
194 return $this->mFieldNames
;
197 function isFieldSortable( $field ) {
198 if ( $this->mIncluding
) {
201 $sortable = [ 'img_timestamp', 'img_name', 'img_size' ];
202 /* For reference, the indicies we can use for sorting are:
203 * On the image table: img_user_timestamp/img_usertext_timestamp/img_actor_timestamp,
204 * img_size, img_timestamp
205 * On oldimage: oi_usertext_timestamp/oi_actor_timestamp, oi_name_timestamp
207 * In particular that means we cannot sort by timestamp when not filtering
208 * by user and including old images in the results. Which is sad.
210 if ( $this->getConfig()->get( 'MiserMode' ) && !is_null( $this->mUserName
) ) {
211 // If we're sorting by user, the index only supports sorting by time.
212 if ( $field === 'img_timestamp' ) {
217 } elseif ( $this->getConfig()->get( 'MiserMode' )
218 && $this->mShowAll
/* && mUserName === null */
220 // no oi_timestamp index, so only alphabetical sorting in this case.
221 if ( $field === 'img_name' ) {
228 return in_array( $field, $sortable );
231 function getQueryInfo() {
232 // Hacky Hacky Hacky - I want to get query info
233 // for two different tables, without reimplementing
235 $qi = $this->getQueryInfoReal( $this->mTableName
);
241 * Actually get the query info.
243 * This is to allow displaying both stuff from image and oldimage table.
245 * This is a bit hacky.
247 * @param string $table Either 'image' or 'oldimage'
248 * @return array Query info
250 protected function getQueryInfoReal( $table ) {
251 $prefix = $table === 'oldimage' ?
'oi' : 'img';
253 $tables = [ $table ];
254 $fields = $this->getFieldNames();
255 unset( $fields['img_description'] );
256 unset( $fields['img_user_text'] );
257 $fields = array_keys( $fields );
259 if ( $table === 'oldimage' ) {
260 foreach ( $fields as $id => &$field ) {
261 if ( substr( $field, 0, 4 ) !== 'img_' ) {
264 $field = $prefix . substr( $field, 3 ) . ' AS ' . $field;
266 $fields[array_search( 'top', $fields )] = "'no' AS top";
268 if ( $this->mShowAll
) {
269 $fields[array_search( 'top', $fields )] = "'yes' AS top";
272 $fields[array_search( 'thumb', $fields )] = $prefix . '_name AS thumb';
274 $options = $join_conds = [];
277 $commentQuery = CommentStore
::getStore()->getJoin( $prefix . '_description' );
278 $tables +
= $commentQuery['tables'];
279 $fields +
= $commentQuery['fields'];
280 $join_conds +
= $commentQuery['joins'];
281 $fields['description_field'] = "'{$prefix}_description'";
284 $actorQuery = ActorMigration
::newMigration()->getJoin( $prefix . '_user' );
285 $tables +
= $actorQuery['tables'];
286 $join_conds +
= $actorQuery['joins'];
287 $fields['img_user'] = $actorQuery['fields'][$prefix . '_user'];
288 $fields['img_user_text'] = $actorQuery['fields'][$prefix . '_user_text'];
289 $fields['img_actor'] = $actorQuery['fields'][$prefix . '_actor'];
291 # Depends on $wgMiserMode
292 # Will also not happen if mShowAll is true.
293 if ( isset( $this->mFieldNames
['count'] ) ) {
294 $tables[] = 'oldimage';
296 # Need to rewrite this one
297 foreach ( $fields as &$field ) {
298 if ( $field == 'count' ) {
299 $field = 'COUNT(oi_archive_name) AS count';
304 $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
305 $options = [ 'GROUP BY' => array_merge( [ $fields['img_user'] ], $columnlist ) ];
306 $join_conds['oldimage'] = [ 'LEFT JOIN', 'oi_name = img_name' ];
312 'conds' => $this->buildQueryConds( $table ),
313 'options' => $options,
314 'join_conds' => $join_conds
319 * Override reallyDoQuery to mix together two queries.
321 * @note $asc is named $descending in IndexPager base class. However
322 * it is true when the order is ascending, and false when the order
323 * is descending, so I renamed it to $asc here.
328 * @throws MWException
330 function reallyDoQuery( $offset, $limit, $asc ) {
331 $prevTableName = $this->mTableName
;
332 $this->mTableName
= 'image';
333 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
334 $this->buildQueryInfo( $offset, $limit, $asc );
335 $imageRes = $this->mDb
->select( $tables, $fields, $conds, $fname, $options, $join_conds );
336 $this->mTableName
= $prevTableName;
338 if ( !$this->mShowAll
) {
342 $this->mTableName
= 'oldimage';
345 $oldIndex = $this->mIndexField
;
346 if ( substr( $this->mIndexField
, 0, 4 ) !== 'img_' ) {
347 throw new MWException( "Expected to be sorting on an image table field" );
349 $this->mIndexField
= 'oi_' . substr( $this->mIndexField
, 4 );
351 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
352 $this->buildQueryInfo( $offset, $limit, $asc );
353 $oldimageRes = $this->mDb
->select( $tables, $fields, $conds, $fname, $options, $join_conds );
355 $this->mTableName
= $prevTableName;
356 $this->mIndexField
= $oldIndex;
358 return $this->combineResult( $imageRes, $oldimageRes, $limit, $asc );
362 * Combine results from 2 tables.
364 * Note: This will throw away some results
366 * @param IResultWrapper $res1
367 * @param IResultWrapper $res2
369 * @param bool $ascending See note about $asc in $this->reallyDoQuery
370 * @return FakeResultWrapper $res1 and $res2 combined
372 protected function combineResult( $res1, $res2, $limit, $ascending ) {
375 $topRes1 = $res1->next();
376 $topRes2 = $res2->next();
378 for ( $i = 0; $i < $limit && $topRes1 && $topRes2; $i++
) {
379 if ( strcmp( $topRes1->{$this->mIndexField
}, $topRes2->{$this->mIndexField
} ) > 0 ) {
381 $resultArray[] = $topRes1;
382 $topRes1 = $res1->next();
384 $resultArray[] = $topRes2;
385 $topRes2 = $res2->next();
389 $resultArray[] = $topRes2;
390 $topRes2 = $res2->next();
392 $resultArray[] = $topRes1;
393 $topRes1 = $res1->next();
398 for ( ; $i < $limit && $topRes1; $i++
) {
399 $resultArray[] = $topRes1;
400 $topRes1 = $res1->next();
403 for ( ; $i < $limit && $topRes2; $i++
) {
404 $resultArray[] = $topRes2;
405 $topRes2 = $res2->next();
408 return new FakeResultWrapper( $resultArray );
411 function getDefaultSort() {
412 if ( $this->mShowAll
&& $this->getConfig()->get( 'MiserMode' ) && is_null( $this->mUserName
) ) {
413 // Unfortunately no index on oi_timestamp.
416 return 'img_timestamp';
420 function doBatchLookups() {
422 $this->mResult
->seek( 0 );
423 foreach ( $this->mResult
as $row ) {
424 $userIds[] = $row->img_user
;
426 # Do a link batch query for names and userpages
427 UserCache
::singleton()->doQuery( $userIds, [ 'userpage' ], __METHOD__
);
431 * @param string $field
432 * @param string $value
433 * @return Message|string|int The return type depends on the value of $field:
435 * - img_timestamp: string
437 * - img_user_text: string
439 * - img_description: string
442 * @throws MWException
444 function formatValue( $field, $value ) {
445 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
448 $opt = [ 'time' => wfTimestamp( TS_MW
, $this->mCurrentRow
->img_timestamp
) ];
449 $file = RepoGroup
::singleton()->getLocalRepo()->findFile( $value, $opt );
450 // If statement for paranoia
452 $thumb = $file->transform( [ 'width' => 180, 'height' => 360 ] );
454 return $thumb->toHtml( [ 'desc-link' => true ] );
456 return wfMessage( 'thumbnail_error', '' )->escaped();
459 return htmlspecialchars( $value );
461 case 'img_timestamp':
462 // We may want to make this a link to the "old" version when displaying old files
463 return htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) );
465 static $imgfile = null;
466 if ( $imgfile === null ) {
467 $imgfile = $this->msg( 'imgfile' )->text();
470 // Weird files can maybe exist? T24227
471 $filePage = Title
::makeTitleSafe( NS_FILE
, $value );
473 $link = $linkRenderer->makeKnownLink(
477 $download = Xml
::element( 'a',
478 [ 'href' => wfLocalFile( $filePage )->getUrl() ],
481 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
483 // Add delete links if allowed
484 // From https://github.com/Wikia/app/pull/3859
485 if ( $filePage->userCan( 'delete', $this->getUser() ) ) {
486 $deleteMsg = $this->msg( 'listfiles-delete' )->text();
488 $delete = $linkRenderer->makeKnownLink(
489 $filePage, $deleteMsg, [], [ 'action' => 'delete' ]
491 $delete = $this->msg( 'parentheses' )->rawParams( $delete )->escaped();
493 return "$link $download $delete";
496 return "$link $download";
498 return htmlspecialchars( $value );
500 case 'img_user_text':
501 if ( $this->mCurrentRow
->img_user
) {
502 $name = User
::whoIs( $this->mCurrentRow
->img_user
);
503 $link = $linkRenderer->makeLink(
504 Title
::makeTitle( NS_USER
, $name ),
508 $link = htmlspecialchars( $value );
513 return htmlspecialchars( $this->getLanguage()->formatSize( $value ) );
514 case 'img_description':
515 $field = $this->mCurrentRow
->description_field
;
516 $value = CommentStore
::getStore()->getComment( $field, $this->mCurrentRow
)->text
;
517 return Linker
::formatComment( $value );
519 return $this->getLanguage()->formatNum( intval( $value ) +
1 );
521 // Messages: listfiles-latestversion-yes, listfiles-latestversion-no
522 return $this->msg( 'listfiles-latestversion-' . $value );
524 throw new MWException( "Unknown field '$field'" );
533 'label-message' => 'table_pager_limit_label',
534 'options' => $this->getLimitSelectList(),
535 'default' => $this->mLimit
,
538 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
539 $fields['ilsearch'] = [
541 'name' => 'ilsearch',
542 'id' => 'mw-ilsearch',
543 'label-message' => 'listfiles_search_for',
544 'default' => $this->mSearch
,
546 'maxlength' => '255',
550 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
554 'id' => 'mw-listfiles-user',
555 'label-message' => 'username',
556 'default' => $this->mUserName
,
558 'maxlength' => '255',
559 'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
562 $fields['ilshowall'] = [
564 'name' => 'ilshowall',
565 'id' => 'mw-listfiles-show-all',
566 'label-message' => 'listfiles-show-all',
567 'default' => $this->mShowAll
,
570 $query = $this->getRequest()->getQueryValues();
571 unset( $query['title'] );
572 unset( $query['limit'] );
573 unset( $query['ilsearch'] );
574 unset( $query['ilshowall'] );
575 unset( $query['user'] );
577 $form = new HTMLForm( $fields, $this->getContext() );
579 $form->setMethod( 'get' );
580 $form->setTitle( $this->getTitle() );
581 $form->setId( 'mw-listfiles-form' );
582 $form->setWrapperLegendMsg( 'listfiles' );
583 $form->setSubmitTextMsg( 'table_pager_limit_submit' );
584 $form->addHiddenFields( $query );
586 $form->prepareForm();
587 $form->displayForm( '' );
590 protected function getTableClass() {
591 return parent
::getTableClass() . ' listfiles';
594 protected function getNavClass() {
595 return parent
::getNavClass() . ' listfiles_nav';
598 protected function getSortHeaderClass() {
599 return parent
::getSortHeaderClass() . ' listfiles_sort';
602 function getPagingQueries() {
603 $queries = parent
::getPagingQueries();
604 if ( !is_null( $this->mUserName
) ) {
605 # Append the username to the query string
606 foreach ( $queries as &$query ) {
607 if ( $query !== false ) {
608 $query['user'] = $this->mUserName
;
616 function getDefaultQuery() {
617 $queries = parent
::getDefaultQuery();
618 if ( !isset( $queries['user'] ) && !is_null( $this->mUserName
) ) {
619 $queries['user'] = $this->mUserName
;
625 function getTitle() {
626 return SpecialPage
::getTitleFor( 'Listfiles' );