3 * Implements Special:MIMESearch
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
22 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
25 use MediaWiki\MediaWikiServices
;
28 * Searches the database for files of the requested MIME type, comparing this with the
29 * 'img_major_mime' and 'img_minor_mime' fields in the image table.
30 * @ingroup SpecialPage
32 class MIMEsearchPage
extends QueryPage
{
33 protected $major, $minor, $mime;
35 function __construct( $name = 'MIMEsearch' ) {
36 parent
::__construct( $name );
39 public function isExpensive() {
43 function isSyndicated() {
47 function isCacheable() {
51 function linkParameters() {
52 return [ 'mime' => "{$this->major}/{$this->minor}" ];
55 public function getQueryInfo() {
57 if ( $this->minor
!== '*' ) {
58 // Allow wildcard searching
59 $minorType['img_minor_mime'] = $this->minor
;
61 $imgQuery = LocalFile
::getQueryInfo();
63 'tables' => $imgQuery['tables'],
65 'namespace' => NS_FILE
,
66 'title' => 'img_name',
67 // Still have a value field just in case,
68 // but it isn't actually used for sorting.
69 'value' => 'img_name',
73 'img_user_text' => $imgQuery['fields']['img_user_text'],
77 'img_major_mime' => $this->major
,
78 // This is in order to trigger using
79 // the img_media_mime index in "range" mode.
80 // @todo how is order defined? use MimeAnalyzer::getMediaTypes?
95 'join_conds' => $imgQuery['joins'],
102 * The index is on (img_media_type, img_major_mime, img_minor_mime)
103 * which unfortunately doesn't have img_name at the end for sorting.
104 * So tell db to sort it however it wishes (Its not super important
105 * that this report gives results in a logical order). As an aditional
106 * note, mysql seems to by default order things by img_name ASC, which
107 * is what we ideally want, so everything works out fine anyhow.
110 function getOrderFields() {
115 * Generate and output the form
117 function getPageHeader() {
120 'type' => 'combobox',
121 'options' => $this->getSuggestionsForTypes(),
123 'label-message' => 'mimetype',
125 'default' => $this->mime
,
129 HTMLForm
::factory( 'ooui', $formDescriptor, $this->getContext() )
130 ->setSubmitTextMsg( 'ilsubmit' )
131 ->setAction( $this->getPageTitle()->getLocalURL() )
134 ->displayForm( false );
137 protected function getSuggestionsForTypes() {
138 $dbr = wfGetDB( DB_REPLICA
);
141 $result = $dbr->select(
143 // We ignore img_media_type, but using it in the query is needed for MySQL to choose a
144 // sensible execution plan
145 [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ],
148 [ 'GROUP BY' => [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ] ]
150 foreach ( $result as $row ) {
151 $major = $row->img_major_mime
;
152 $minor = $row->img_minor_mime
;
153 $suggestions[ "$major/$minor" ] = "$major/$minor";
154 if ( $lastMajor === $major ) {
155 // If there are at least two with the same major mime type, also include the wildcard
156 $suggestions[ "$major/*" ] = "$major/*";
160 ksort( $suggestions );
164 public function execute( $par ) {
165 $this->mime
= $par ?
: $this->getRequest()->getText( 'mime' );
166 $this->mime
= trim( $this->mime
);
167 list( $this->major
, $this->minor
) = File
::splitMime( $this->mime
);
169 if ( $this->major
== '' ||
$this->minor
== '' ||
$this->minor
== 'unknown' ||
170 !self
::isValidType( $this->major
)
173 $this->outputHeader();
174 $this->getPageHeader();
178 parent
::execute( $par );
183 * @param object $result Result row
186 function formatResult( $skin, $result ) {
187 $linkRenderer = $this->getLinkRenderer();
188 $nt = Title
::makeTitle( $result->namespace, $result->title
);
189 $text = MediaWikiServices
::getInstance()->getContentLanguage()
190 ->convert( htmlspecialchars( $nt->getText() ) );
191 $plink = $linkRenderer->makeLink(
192 Title
::newFromText( $nt->getPrefixedText() ),
193 new HtmlArmor( $text )
196 $download = Linker
::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
197 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
198 $lang = $this->getLanguage();
199 $bytes = htmlspecialchars( $lang->formatSize( $result->img_size
) );
200 $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width
,
201 $result->img_height
)->escaped();
202 $user = $linkRenderer->makeLink(
203 Title
::makeTitle( NS_USER
, $result->img_user_text
),
204 $result->img_user_text
207 $time = $lang->userTimeAndDate( $result->img_timestamp
, $this->getUser() );
208 $time = htmlspecialchars( $time );
210 return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
214 * @param string $type
217 protected static function isValidType( $type ) {
218 // From maintenance/tables.sql => img_major_mime
232 return in_array( $type, $types );
235 public function preprocessResults( $db, $res ) {
236 $this->executeLBFromResultWrapper( $res );
239 protected function getGroupName() {