Type check the APC value in LoadBalancer::doWait()
[mediawiki.git] / includes / specials / SpecialMIMEsearch.php
blob52cb30a1bcdc43a9b61c9ef8f2fafd4e29475a14
1 <?php
2 /**
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
20 * @file
21 * @ingroup SpecialPage
22 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
25 /**
26 * Searches the database for files of the requested MIME type, comparing this with the
27 * 'img_major_mime' and 'img_minor_mime' fields in the image table.
28 * @ingroup SpecialPage
30 class MIMEsearchPage extends QueryPage {
31 protected $major, $minor, $mime;
33 function __construct( $name = 'MIMEsearch' ) {
34 parent::__construct( $name );
37 public function isExpensive() {
38 return false;
41 function isSyndicated() {
42 return false;
45 function isCacheable() {
46 return false;
49 function linkParameters() {
50 return [ 'mime' => "{$this->major}/{$this->minor}" ];
53 public function getQueryInfo() {
54 $minorType = [];
55 if ( $this->minor !== '*' ) {
56 // Allow wildcard searching
57 $minorType['img_minor_mime'] = $this->minor;
59 $qi = [
60 'tables' => [ 'image' ],
61 'fields' => [
62 'namespace' => NS_FILE,
63 'title' => 'img_name',
64 // Still have a value field just in case,
65 // but it isn't actually used for sorting.
66 'value' => 'img_name',
67 'img_size',
68 'img_width',
69 'img_height',
70 'img_user_text',
71 'img_timestamp'
73 'conds' => [
74 'img_major_mime' => $this->major,
75 // This is in order to trigger using
76 // the img_media_mime index in "range" mode.
77 'img_media_type' => [
78 MEDIATYPE_BITMAP,
79 MEDIATYPE_DRAWING,
80 MEDIATYPE_AUDIO,
81 MEDIATYPE_VIDEO,
82 MEDIATYPE_MULTIMEDIA,
83 MEDIATYPE_UNKNOWN,
84 MEDIATYPE_OFFICE,
85 MEDIATYPE_TEXT,
86 MEDIATYPE_EXECUTABLE,
87 MEDIATYPE_ARCHIVE,
89 ] + $minorType,
92 return $qi;
95 /**
96 * The index is on (img_media_type, img_major_mime, img_minor_mime)
97 * which unfortunately doesn't have img_name at the end for sorting.
98 * So tell db to sort it however it wishes (Its not super important
99 * that this report gives results in a logical order). As an aditional
100 * note, mysql seems to by default order things by img_name ASC, which
101 * is what we ideally want, so everything works out fine anyhow.
102 * @return array
104 function getOrderFields() {
105 return [];
109 * Generate and output the form
111 function getPageHeader() {
112 $formDescriptor = [
113 'mime' => [
114 'type' => 'combobox',
115 'options' => $this->getSuggestionsForTypes(),
116 'name' => 'mime',
117 'label-message' => 'mimetype',
118 'required' => true,
119 'default' => $this->mime,
123 HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
124 ->setSubmitTextMsg( 'ilsubmit' )
125 ->setAction( $this->getPageTitle()->getLocalURL() )
126 ->setMethod( 'get' )
127 ->prepareForm()
128 ->displayForm( false );
131 protected function getSuggestionsForTypes() {
132 $dbr = wfGetDB( DB_REPLICA );
133 $lastMajor = null;
134 $suggestions = [];
135 $result = $dbr->select(
136 [ 'image' ],
137 // We ignore img_media_type, but using it in the query is needed for MySQL to choose a
138 // sensible execution plan
139 [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ],
141 __METHOD__,
142 [ 'GROUP BY' => [ 'img_media_type', 'img_major_mime', 'img_minor_mime' ] ]
144 foreach ( $result as $row ) {
145 $major = $row->img_major_mime;
146 $minor = $row->img_minor_mime;
147 $suggestions[ "$major/$minor" ] = "$major/$minor";
148 if ( $lastMajor === $major ) {
149 // If there are at least two with the same major mime type, also include the wildcard
150 $suggestions[ "$major/*" ] = "$major/*";
152 $lastMajor = $major;
154 ksort( $suggestions );
155 return $suggestions;
158 public function execute( $par ) {
159 $this->mime = $par ? $par : $this->getRequest()->getText( 'mime' );
160 $this->mime = trim( $this->mime );
161 list( $this->major, $this->minor ) = File::splitMime( $this->mime );
163 if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
164 !self::isValidType( $this->major )
166 $this->setHeaders();
167 $this->outputHeader();
168 $this->getPageHeader();
169 return;
172 parent::execute( $par );
176 * @param Skin $skin
177 * @param object $result Result row
178 * @return string
180 function formatResult( $skin, $result ) {
181 global $wgContLang;
183 $linkRenderer = $this->getLinkRenderer();
184 $nt = Title::makeTitle( $result->namespace, $result->title );
185 $text = $wgContLang->convert( $nt->getText() );
186 $plink = $linkRenderer->makeLink(
187 Title::newFromText( $nt->getPrefixedText() ),
188 $text
191 $download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
192 $download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
193 $lang = $this->getLanguage();
194 $bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
195 $dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
196 $result->img_height )->escaped();
197 $user = $linkRenderer->makeLink(
198 Title::makeTitle( NS_USER, $result->img_user_text ),
199 $result->img_user_text
202 $time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
203 $time = htmlspecialchars( $time );
205 return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
209 * @param string $type
210 * @return bool
212 protected static function isValidType( $type ) {
213 // From maintenance/tables.sql => img_major_mime
214 $types = [
215 'unknown',
216 'application',
217 'audio',
218 'image',
219 'text',
220 'video',
221 'message',
222 'model',
223 'multipart',
224 'chemical'
227 return in_array( $type, $types );
230 public function preprocessResults( $db, $res ) {
231 $this->executeLBFromResultWrapper( $res );
234 protected function getGroupName() {
235 return 'media';