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\ResultWrapper
;
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 $conds[$prefix . '_user_text'] = $this->mUserName
;
140 if ( $this->mSearch
!== '' ) {
141 $nt = Title
::newFromText( $this->mSearch
);
143 $dbr = wfGetDB( DB_REPLICA
);
144 $conds[] = 'LOWER(' . $prefix . '_name)' .
145 $dbr->buildLike( $dbr->anyString(),
146 strtolower( $nt->getDBkey() ), $dbr->anyString() );
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;
157 // Add mQueryConds in case anyone was subclassing and using the old variable.
158 return $conds +
$this->mQueryConds
;
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(),
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();
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();
179 if ( !$this->getConfig()->get( 'MiserMode' ) && !$this->mShowAll
) {
180 $this->mFieldNames
['count'] = $this->msg( 'listfiles_count' )->text();
182 if ( $this->mShowAll
) {
183 $this->mFieldNames
['top'] = $this->msg( 'listfiles-latestversion' )->text();
187 return $this->mFieldNames
;
190 function isFieldSortable( $field ) {
191 if ( $this->mIncluding
) {
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
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.
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' ) {
210 } elseif ( $this->getConfig()->get( 'MiserMode' )
211 && $this->mShowAll
/* && mUserName === null */
213 // no oi_timestamp index, so only alphabetical sorting in this case.
214 if ( $field === 'img_name' ) {
221 return in_array( $field, $sortable );
224 function getQueryInfo() {
225 // Hacky Hacky Hacky - I want to get query info
226 // for two different tables, without reimplementing
228 $qi = $this->getQueryInfoReal( $this->mTableName
);
234 * Actually get the query info.
236 * This is to allow displaying both stuff from image and oldimage table.
238 * This is a bit hacky.
240 * @param string $table Either 'image' or 'oldimage'
241 * @return array Query info
243 protected function getQueryInfoReal( $table ) {
244 $prefix = $table === 'oldimage' ?
'oi' : 'img';
246 $tables = [ $table ];
247 $fields = $this->getFieldNames();
248 unset( $fields['img_description'] );
249 $fields = array_keys( $fields );
251 if ( $table === 'oldimage' ) {
252 foreach ( $fields as $id => &$field ) {
253 if ( substr( $field, 0, 4 ) !== 'img_' ) {
256 $field = $prefix . substr( $field, 3 ) . ' AS ' . $field;
258 $fields[array_search( 'top', $fields )] = "'no' AS top";
260 if ( $this->mShowAll
) {
261 $fields[array_search( 'top', $fields )] = "'yes' AS top";
264 $fields[] = $prefix . '_user AS img_user';
265 $fields[array_search( 'thumb', $fields )] = $prefix . '_name AS thumb';
267 $options = $join_conds = [];
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'";
276 # Depends on $wgMiserMode
277 # Will also not happen if mShowAll is true.
278 if ( isset( $this->mFieldNames
['count'] ) ) {
279 $tables[] = 'oldimage';
281 # Need to rewrite this one
282 foreach ( $fields as &$field ) {
283 if ( $field == 'count' ) {
284 $field = 'COUNT(oi_archive_name) AS count';
289 $dbr = wfGetDB( DB_REPLICA
);
290 if ( $dbr->implicitGroupby() ) {
291 $options = [ 'GROUP BY' => 'img_name' ];
293 $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
294 $options = [ 'GROUP BY' => array_merge( [ 'img_user' ], $columnlist ) ];
296 $join_conds = [ 'oldimage' => [ 'LEFT JOIN', 'oi_name = img_name' ] ];
302 'conds' => $this->buildQueryConds( $table ),
303 'options' => $options,
304 'join_conds' => $join_conds
309 * Override reallyDoQuery to mix together two queries.
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.
318 * @throws MWException
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;
328 if ( !$this->mShowAll
) {
332 $this->mTableName
= 'oldimage';
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" );
339 $this->mIndexField
= 'oi_' . substr( $this->mIndexField
, 4 );
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 );
345 $this->mTableName
= $prevTableName;
346 $this->mIndexField
= $oldIndex;
348 return $this->combineResult( $imageRes, $oldimageRes, $limit, $asc );
352 * Combine results from 2 tables.
354 * Note: This will throw away some results
356 * @param ResultWrapper $res1
357 * @param ResultWrapper $res2
359 * @param bool $ascending See note about $asc in $this->reallyDoQuery
360 * @return FakeResultWrapper $res1 and $res2 combined
362 protected function combineResult( $res1, $res2, $limit, $ascending ) {
365 $topRes1 = $res1->next();
366 $topRes2 = $res2->next();
368 for ( $i = 0; $i < $limit && $topRes1 && $topRes2; $i++
) {
369 if ( strcmp( $topRes1->{$this->mIndexField
}, $topRes2->{$this->mIndexField
} ) > 0 ) {
371 $resultArray[] = $topRes1;
372 $topRes1 = $res1->next();
374 $resultArray[] = $topRes2;
375 $topRes2 = $res2->next();
379 $resultArray[] = $topRes2;
380 $topRes2 = $res2->next();
382 $resultArray[] = $topRes1;
383 $topRes1 = $res1->next();
388 // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
389 for ( ; $i < $limit && $topRes1; $i++
) {
390 // @codingStandardsIgnoreEnd
391 $resultArray[] = $topRes1;
392 $topRes1 = $res1->next();
395 // @codingStandardsIgnoreStart Squiz.WhiteSpace.SemicolonSpacing.Incorrect
396 for ( ; $i < $limit && $topRes2; $i++
) {
397 // @codingStandardsIgnoreEnd
398 $resultArray[] = $topRes2;
399 $topRes2 = $res2->next();
402 return new FakeResultWrapper( $resultArray );
405 function getDefaultSort() {
406 if ( $this->mShowAll
&& $this->getConfig()->get( 'MiserMode' ) && is_null( $this->mUserName
) ) {
407 // Unfortunately no index on oi_timestamp.
410 return 'img_timestamp';
414 function doBatchLookups() {
416 $this->mResult
->seek( 0 );
417 foreach ( $this->mResult
as $row ) {
418 $userIds[] = $row->img_user
;
420 # Do a link batch query for names and userpages
421 UserCache
::singleton()->doQuery( $userIds, [ 'userpage' ], __METHOD__
);
425 * @param string $field
426 * @param string $value
427 * @return Message|string|int The return type depends on the value of $field:
429 * - img_timestamp: string
431 * - img_user_text: string
433 * - img_description: string
436 * @throws MWException
438 function formatValue( $field, $value ) {
439 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
442 $opt = [ 'time' => wfTimestamp( TS_MW
, $this->mCurrentRow
->img_timestamp
) ];
443 $file = RepoGroup
::singleton()->getLocalRepo()->findFile( $value, $opt );
444 // If statement for paranoia
446 $thumb = $file->transform( [ 'width' => 180, 'height' => 360 ] );
448 return $thumb->toHtml( [ 'desc-link' => true ] );
450 return wfMessage( 'thumbnail_error', '' )->escaped();
453 return htmlspecialchars( $value );
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() ) );
459 static $imgfile = null;
460 if ( $imgfile === null ) {
461 $imgfile = $this->msg( 'imgfile' )->text();
464 // Weird files can maybe exist? T24227
465 $filePage = Title
::makeTitleSafe( NS_FILE
, $value );
467 $link = $linkRenderer->makeKnownLink(
471 $download = Xml
::element( 'a',
472 [ 'href' => wfLocalFile( $filePage )->getUrl() ],
475 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
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();
482 $delete = $linkRenderer->makeKnownLink(
483 $filePage, $deleteMsg, [], [ 'action' => 'delete' ]
485 $delete = $this->msg( 'parentheses' )->rawParams( $delete )->escaped();
487 return "$link $download $delete";
490 return "$link $download";
492 return htmlspecialchars( $value );
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 ),
502 $link = htmlspecialchars( $value );
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 );
513 return $this->getLanguage()->formatNum( intval( $value ) +
1 );
515 // Messages: listfiles-latestversion-yes, listfiles-latestversion-no
516 return $this->msg( 'listfiles-latestversion-' . $value );
518 throw new MWException( "Unknown field '$field'" );
527 'label-message' => 'table_pager_limit_label',
528 'options' => $this->getLimitSelectList(),
529 'default' => $this->mLimit
,
532 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
533 $fields['ilsearch'] = [
535 'name' => 'ilsearch',
536 'id' => 'mw-ilsearch',
537 'label-message' => 'listfiles_search_for',
538 'default' => $this->mSearch
,
540 'maxlength' => '255',
544 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
548 'id' => 'mw-listfiles-user',
549 'label-message' => 'username',
550 'default' => $this->mUserName
,
552 'maxlength' => '255',
553 'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
556 $fields['ilshowall'] = [
558 'name' => 'ilshowall',
559 'id' => 'mw-listfiles-show-all',
560 'label-message' => 'listfiles-show-all',
561 'default' => $this->mShowAll
,
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'] );
571 $form = new HTMLForm( $fields, $this->getContext() );
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 );
580 $form->prepareForm();
581 $form->displayForm( '' );
584 protected function getTableClass() {
585 return parent
::getTableClass() . ' listfiles';
588 protected function getNavClass() {
589 return parent
::getNavClass() . ' listfiles_nav';
592 protected function getSortHeaderClass() {
593 return parent
::getSortHeaderClass() . ' listfiles_sort';
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
;
610 function getDefaultQuery() {
611 $queries = parent
::getDefaultQuery();
612 if ( !isset( $queries['user'] ) && !is_null( $this->mUserName
) ) {
613 $queries['user'] = $this->mUserName
;
619 function getTitle() {
620 return SpecialPage
::getTitleFor( 'Listfiles' );