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 public 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 ),
143 // oldimage doesn't have an index on oi_user, while image does. Set $useId accordingly.
146 $conds[] = $actorWhere['conds'];
149 if ( $this->mSearch
!== '' ) {
150 $nt = Title
::newFromText( $this->mSearch
);
152 $dbr = wfGetDB( DB_REPLICA
);
153 $conds[] = 'LOWER(' . $prefix . '_name)' .
154 $dbr->buildLike( $dbr->anyString(),
155 strtolower( $nt->getDBkey() ), $dbr->anyString() );
159 if ( $table === 'oldimage' ) {
160 // Don't want to deal with revdel.
161 // Future fixme: Show partial information as appropriate.
162 // Would have to be careful about filtering by username when username is deleted.
163 $conds['oi_deleted'] = 0;
166 // Add mQueryConds in case anyone was subclassing and using the old variable.
167 return $conds +
$this->mQueryConds
;
171 * The array keys (but not the array values) are used in sql. Phan
172 * gets confused by this, so mark this method as being ok for sql in general.
173 * @return-taint onlysafefor_sql
176 function getFieldNames() {
177 if ( !$this->mFieldNames
) {
178 $this->mFieldNames
= [
179 'img_timestamp' => $this->msg( 'listfiles_date' )->text(),
180 'img_name' => $this->msg( 'listfiles_name' )->text(),
181 'thumb' => $this->msg( 'listfiles_thumb' )->text(),
182 'img_size' => $this->msg( 'listfiles_size' )->text(),
184 if ( is_null( $this->mUserName
) ) {
185 // Do not show username if filtering by username
186 $this->mFieldNames
['img_user_text'] = $this->msg( 'listfiles_user' )->text();
188 // img_description down here, in order so that its still after the username field.
189 $this->mFieldNames
['img_description'] = $this->msg( 'listfiles_description' )->text();
191 if ( !$this->getConfig()->get( 'MiserMode' ) && !$this->mShowAll
) {
192 $this->mFieldNames
['count'] = $this->msg( 'listfiles_count' )->text();
194 if ( $this->mShowAll
) {
195 $this->mFieldNames
['top'] = $this->msg( 'listfiles-latestversion' )->text();
199 return $this->mFieldNames
;
202 function isFieldSortable( $field ) {
203 if ( $this->mIncluding
) {
206 $sortable = [ 'img_timestamp', 'img_name', 'img_size' ];
207 /* For reference, the indicies we can use for sorting are:
208 * On the image table: img_user_timestamp/img_usertext_timestamp/img_actor_timestamp,
209 * img_size, img_timestamp
210 * On oldimage: oi_usertext_timestamp/oi_actor_timestamp, oi_name_timestamp
212 * In particular that means we cannot sort by timestamp when not filtering
213 * by user and including old images in the results. Which is sad.
215 if ( $this->getConfig()->get( 'MiserMode' ) && !is_null( $this->mUserName
) ) {
216 // If we're sorting by user, the index only supports sorting by time.
217 if ( $field === 'img_timestamp' ) {
222 } elseif ( $this->getConfig()->get( 'MiserMode' )
223 && $this->mShowAll
/* && mUserName === null */
225 // no oi_timestamp index, so only alphabetical sorting in this case.
226 if ( $field === 'img_name' ) {
233 return in_array( $field, $sortable );
236 function getQueryInfo() {
237 // Hacky Hacky Hacky - I want to get query info
238 // for two different tables, without reimplementing
240 $qi = $this->getQueryInfoReal( $this->mTableName
);
246 * Actually get the query info.
248 * This is to allow displaying both stuff from image and oldimage table.
250 * This is a bit hacky.
252 * @param string $table Either 'image' or 'oldimage'
253 * @return array Query info
255 protected function getQueryInfoReal( $table ) {
256 $prefix = $table === 'oldimage' ?
'oi' : 'img';
258 $tables = [ $table ];
259 $fields = $this->getFieldNames();
260 unset( $fields['img_description'] );
261 unset( $fields['img_user_text'] );
262 $fields = array_keys( $fields );
264 if ( $table === 'oldimage' ) {
265 foreach ( $fields as $id => &$field ) {
266 if ( substr( $field, 0, 4 ) !== 'img_' ) {
269 $field = $prefix . substr( $field, 3 ) . ' AS ' . $field;
271 $fields[array_search( 'top', $fields )] = "'no' AS top";
273 if ( $this->mShowAll
) {
274 $fields[array_search( 'top', $fields )] = "'yes' AS top";
277 $fields[array_search( 'thumb', $fields )] = $prefix . '_name AS thumb';
279 $options = $join_conds = [];
282 $commentQuery = CommentStore
::getStore()->getJoin( $prefix . '_description' );
283 $tables +
= $commentQuery['tables'];
284 $fields +
= $commentQuery['fields'];
285 $join_conds +
= $commentQuery['joins'];
286 $fields['description_field'] = "'{$prefix}_description'";
289 $actorQuery = ActorMigration
::newMigration()->getJoin( $prefix . '_user' );
290 $tables +
= $actorQuery['tables'];
291 $join_conds +
= $actorQuery['joins'];
292 $fields['img_user'] = $actorQuery['fields'][$prefix . '_user'];
293 $fields['img_user_text'] = $actorQuery['fields'][$prefix . '_user_text'];
294 $fields['img_actor'] = $actorQuery['fields'][$prefix . '_actor'];
296 # Depends on $wgMiserMode
297 # Will also not happen if mShowAll is true.
298 if ( isset( $this->mFieldNames
['count'] ) ) {
299 $tables[] = 'oldimage';
301 # Need to rewrite this one
302 foreach ( $fields as &$field ) {
303 if ( $field == 'count' ) {
304 $field = 'COUNT(oi_archive_name) AS count';
309 $columnlist = preg_grep( '/^img/', array_keys( $this->getFieldNames() ) );
310 $options = [ 'GROUP BY' => array_merge( [ $fields['img_user'] ], $columnlist ) ];
311 $join_conds['oldimage'] = [ 'LEFT JOIN', 'oi_name = img_name' ];
317 'conds' => $this->buildQueryConds( $table ),
318 'options' => $options,
319 'join_conds' => $join_conds
324 * Override reallyDoQuery to mix together two queries.
326 * @note $asc is named $descending in IndexPager base class. However
327 * it is true when the order is ascending, and false when the order
328 * is descending, so I renamed it to $asc here.
333 * @throws MWException
335 function reallyDoQuery( $offset, $limit, $asc ) {
336 $prevTableName = $this->mTableName
;
337 $this->mTableName
= 'image';
338 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
339 $this->buildQueryInfo( $offset, $limit, $asc );
340 $imageRes = $this->mDb
->select( $tables, $fields, $conds, $fname, $options, $join_conds );
341 $this->mTableName
= $prevTableName;
343 if ( !$this->mShowAll
) {
347 $this->mTableName
= 'oldimage';
350 $oldIndex = $this->mIndexField
;
351 if ( substr( $this->mIndexField
, 0, 4 ) !== 'img_' ) {
352 throw new MWException( "Expected to be sorting on an image table field" );
354 $this->mIndexField
= 'oi_' . substr( $this->mIndexField
, 4 );
356 list( $tables, $fields, $conds, $fname, $options, $join_conds ) =
357 $this->buildQueryInfo( $offset, $limit, $asc );
358 $oldimageRes = $this->mDb
->select( $tables, $fields, $conds, $fname, $options, $join_conds );
360 $this->mTableName
= $prevTableName;
361 $this->mIndexField
= $oldIndex;
363 return $this->combineResult( $imageRes, $oldimageRes, $limit, $asc );
367 * Combine results from 2 tables.
369 * Note: This will throw away some results
371 * @param IResultWrapper $res1
372 * @param IResultWrapper $res2
374 * @param bool $ascending See note about $asc in $this->reallyDoQuery
375 * @return FakeResultWrapper $res1 and $res2 combined
377 protected function combineResult( $res1, $res2, $limit, $ascending ) {
380 $topRes1 = $res1->next();
381 $topRes2 = $res2->next();
383 for ( $i = 0; $i < $limit && $topRes1 && $topRes2; $i++
) {
384 if ( strcmp( $topRes1->{$this->mIndexField
}, $topRes2->{$this->mIndexField
} ) > 0 ) {
386 $resultArray[] = $topRes1;
387 $topRes1 = $res1->next();
389 $resultArray[] = $topRes2;
390 $topRes2 = $res2->next();
394 $resultArray[] = $topRes2;
395 $topRes2 = $res2->next();
397 $resultArray[] = $topRes1;
398 $topRes1 = $res1->next();
403 for ( ; $i < $limit && $topRes1; $i++
) {
404 $resultArray[] = $topRes1;
405 $topRes1 = $res1->next();
408 for ( ; $i < $limit && $topRes2; $i++
) {
409 $resultArray[] = $topRes2;
410 $topRes2 = $res2->next();
413 return new FakeResultWrapper( $resultArray );
416 function getDefaultSort() {
417 if ( $this->mShowAll
&& $this->getConfig()->get( 'MiserMode' ) && is_null( $this->mUserName
) ) {
418 // Unfortunately no index on oi_timestamp.
421 return 'img_timestamp';
425 protected function doBatchLookups() {
427 $this->mResult
->seek( 0 );
428 foreach ( $this->mResult
as $row ) {
429 $userIds[] = $row->img_user
;
431 # Do a link batch query for names and userpages
432 UserCache
::singleton()->doQuery( $userIds, [ 'userpage' ], __METHOD__
);
436 * @param string $field
437 * @param string $value
438 * @return Message|string|int The return type depends on the value of $field:
440 * - img_timestamp: string
442 * - img_user_text: string
444 * - img_description: string
447 * @throws MWException
449 function formatValue( $field, $value ) {
450 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
453 $opt = [ 'time' => wfTimestamp( TS_MW
, $this->mCurrentRow
->img_timestamp
) ];
454 $file = RepoGroup
::singleton()->getLocalRepo()->findFile( $value, $opt );
455 // If statement for paranoia
457 $thumb = $file->transform( [ 'width' => 180, 'height' => 360 ] );
459 return $thumb->toHtml( [ 'desc-link' => true ] );
461 return $this->msg( 'thumbnail_error', '' )->escaped();
464 return htmlspecialchars( $value );
466 case 'img_timestamp':
467 // We may want to make this a link to the "old" version when displaying old files
468 return htmlspecialchars( $this->getLanguage()->userTimeAndDate( $value, $this->getUser() ) );
470 static $imgfile = null;
471 if ( $imgfile === null ) {
472 $imgfile = $this->msg( 'imgfile' )->text();
475 // Weird files can maybe exist? T24227
476 $filePage = Title
::makeTitleSafe( NS_FILE
, $value );
478 $link = $linkRenderer->makeKnownLink(
482 $download = Xml
::element( 'a',
483 [ 'href' => wfLocalFile( $filePage )->getUrl() ],
486 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
488 // Add delete links if allowed
489 // From https://github.com/Wikia/app/pull/3859
490 if ( $filePage->userCan( 'delete', $this->getUser() ) ) {
491 $deleteMsg = $this->msg( 'listfiles-delete' )->text();
493 $delete = $linkRenderer->makeKnownLink(
494 $filePage, $deleteMsg, [], [ 'action' => 'delete' ]
496 $delete = $this->msg( 'parentheses' )->rawParams( $delete )->escaped();
498 return "$link $download $delete";
501 return "$link $download";
503 return htmlspecialchars( $value );
505 case 'img_user_text':
506 if ( $this->mCurrentRow
->img_user
) {
507 $name = User
::whoIs( $this->mCurrentRow
->img_user
);
508 $link = $linkRenderer->makeLink(
509 Title
::makeTitle( NS_USER
, $name ),
513 $link = htmlspecialchars( $value );
518 return htmlspecialchars( $this->getLanguage()->formatSize( $value ) );
519 case 'img_description':
520 $field = $this->mCurrentRow
->description_field
;
521 $value = CommentStore
::getStore()->getComment( $field, $this->mCurrentRow
)->text
;
522 return Linker
::formatComment( $value );
524 return $this->getLanguage()->formatNum( intval( $value ) +
1 );
526 // Messages: listfiles-latestversion-yes, listfiles-latestversion-no
527 return $this->msg( 'listfiles-latestversion-' . $value );
529 throw new MWException( "Unknown field '$field'" );
534 $formDescriptor = [];
535 $formDescriptor['limit'] = [
538 'label-message' => 'table_pager_limit_label',
539 'options' => $this->getLimitSelectList(),
540 'default' => $this->mLimit
,
543 if ( !$this->getConfig()->get( 'MiserMode' ) ) {
544 $formDescriptor['ilsearch'] = [
546 'name' => 'ilsearch',
547 'id' => 'mw-ilsearch',
548 'label-message' => 'listfiles_search_for',
549 'default' => $this->mSearch
,
551 'maxlength' => '255',
555 $formDescriptor['user'] = [
558 'id' => 'mw-listfiles-user',
559 'label-message' => 'username',
560 'default' => $this->mUserName
,
562 'maxlength' => '255',
565 $formDescriptor['ilshowall'] = [
567 'name' => 'ilshowall',
568 'id' => 'mw-listfiles-show-all',
569 'label-message' => 'listfiles-show-all',
570 'default' => $this->mShowAll
,
573 $query = $this->getRequest()->getQueryValues();
574 unset( $query['title'] );
575 unset( $query['limit'] );
576 unset( $query['ilsearch'] );
577 unset( $query['ilshowall'] );
578 unset( $query['user'] );
580 $htmlForm = HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() );
583 ->setId( 'mw-listfiles-form' )
584 ->setTitle( $this->getTitle() )
585 ->setSubmitTextMsg( 'table_pager_limit_submit' )
586 ->setWrapperLegendMsg( 'listfiles' )
587 ->addHiddenFields( $query )
592 protected function getTableClass() {
593 return parent
::getTableClass() . ' listfiles';
596 protected function getNavClass() {
597 return parent
::getNavClass() . ' listfiles_nav';
600 protected function getSortHeaderClass() {
601 return parent
::getSortHeaderClass() . ' listfiles_sort';
604 function getPagingQueries() {
605 $queries = parent
::getPagingQueries();
606 if ( !is_null( $this->mUserName
) ) {
607 # Append the username to the query string
608 foreach ( $queries as &$query ) {
609 if ( $query !== false ) {
610 $query['user'] = $this->mUserName
;
618 function getDefaultQuery() {
619 $queries = parent
::getDefaultQuery();
620 if ( !isset( $queries['user'] ) && !is_null( $this->mUserName
) ) {
621 $queries['user'] = $this->mUserName
;
627 function getTitle() {
628 return SpecialPage
::getTitleFor( 'Listfiles' );