MediaWiki  master
SpecialMediaStatistics.php
Go to the documentation of this file.
1 <?php
27 
32  protected $totalCount = 0, $totalBytes = 0;
33 
37  protected $totalPerType = 0;
38 
42  protected $totalSize = 0;
43 
44  function __construct( $name = 'MediaStatistics' ) {
45  parent::__construct( $name );
46  // Generally speaking there is only a small number of file types,
47  // so just show all of them.
48  $this->limit = 5000;
49  $this->shownavigation = false;
50  }
51 
52  public function isExpensive() {
53  return true;
54  }
55 
70  public function getQueryInfo() {
71  $dbr = wfGetDB( DB_REPLICA );
72  $fakeTitle = $dbr->buildConcat( [
73  'img_media_type',
74  $dbr->addQuotes( ';' ),
75  'img_major_mime',
76  $dbr->addQuotes( '/' ),
77  'img_minor_mime',
78  $dbr->addQuotes( ';' ),
79  'COUNT(*)',
80  $dbr->addQuotes( ';' ),
81  'SUM( img_size )'
82  ] );
83  return [
84  'tables' => [ 'image' ],
85  'fields' => [
86  'title' => $fakeTitle,
87  'namespace' => NS_MEDIA, /* needs to be something */
88  'value' => '1'
89  ],
90  'options' => [
91  'GROUP BY' => [
92  'img_media_type',
93  'img_major_mime',
94  'img_minor_mime',
95  ]
96  ]
97  ];
98  }
99 
107  function getOrderFields() {
108  return [ 'img_media_type', 'count(*)', 'img_major_mime', 'img_minor_mime' ];
109  }
110 
121  protected function outputResults( $out, $skin, $dbr, $res, $num, $offset ) {
122  $prevMediaType = null;
123  foreach ( $res as $row ) {
124  $mediaStats = $this->splitFakeTitle( $row->title );
125  if ( count( $mediaStats ) < 4 ) {
126  continue;
127  }
128  list( $mediaType, $mime, $totalCount, $totalBytes ) = $mediaStats;
129  if ( $prevMediaType !== $mediaType ) {
130  if ( $prevMediaType !== null ) {
131  // We're not at beginning, so we have to
132  // close the previous table.
133  $this->outputTableEnd();
134  }
135  $this->outputMediaType( $mediaType );
136  $this->totalPerType = 0;
137  $this->outputTableStart( $mediaType );
138  $prevMediaType = $mediaType;
139  }
140  $this->outputTableRow( $mime, intval( $totalCount ), intval( $totalBytes ) );
141  }
142  if ( $prevMediaType !== null ) {
143  $this->outputTableEnd();
144  // add total size of all files
145  $this->outputMediaType( 'total' );
146  $this->getOutput()->addWikiTextAsInterface(
147  $this->msg( 'mediastatistics-allbytes' )
148  ->numParams( $this->totalSize )
149  ->sizeParams( $this->totalSize )
150  ->text()
151  );
152  }
153  }
154 
158  protected function outputTableEnd() {
159  $this->getOutput()->addHTML( Html::closeElement( 'table' ) );
160  $this->getOutput()->addWikiTextAsInterface(
161  $this->msg( 'mediastatistics-bytespertype' )
162  ->numParams( $this->totalPerType )
163  ->sizeParams( $this->totalPerType )
164  ->numParams( $this->makePercentPretty( $this->totalPerType / $this->totalBytes ) )
165  ->text()
166  );
167  $this->totalSize += $this->totalPerType;
168  }
169 
177  protected function outputTableRow( $mime, $count, $bytes ) {
178  $mimeSearch = SpecialPage::getTitleFor( 'MIMEsearch', $mime );
179  $linkRenderer = $this->getLinkRenderer();
180  $row = Html::rawElement(
181  'td',
182  [],
183  $linkRenderer->makeLink( $mimeSearch, $mime )
184  );
185  $row .= Html::rawElement(
186  'td',
187  [],
188  $this->getExtensionList( $mime )
189  );
190  $row .= Html::rawElement(
191  'td',
192  // Make sure js sorts it in numeric order
193  [ 'data-sort-value' => $count ],
194  $this->msg( 'mediastatistics-nfiles' )
195  ->numParams( $count )
197  ->numParams( $this->makePercentPretty( $count / $this->totalCount ) )
198  ->parse()
199  );
200  $row .= Html::rawElement(
201  'td',
202  // Make sure js sorts it in numeric order
203  [ 'data-sort-value' => $bytes ],
204  $this->msg( 'mediastatistics-nbytes' )
205  ->numParams( $bytes )
206  ->sizeParams( $bytes )
208  ->numParams( $this->makePercentPretty( $bytes / $this->totalBytes ) )
209  ->parse()
210  );
211  $this->totalPerType += $bytes;
212  $this->getOutput()->addHTML( Html::rawElement( 'tr', [], $row ) );
213  }
214 
219  protected function makePercentPretty( $decimal ) {
220  $decimal *= 100;
221  // Always show three useful digits
222  if ( $decimal == 0 ) {
223  return '0';
224  }
225  if ( $decimal >= 100 ) {
226  return '100';
227  }
228  $percent = sprintf( "%." . max( 0, 2 - floor( log10( $decimal ) ) ) . "f", $decimal );
229  // Then remove any trailing 0's
230  return preg_replace( '/\.?0*$/', '', $percent );
231  }
232 
239  private function getExtensionList( $mime ) {
240  $exts = MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer()
241  ->getExtensionsForType( $mime );
242  if ( $exts === null ) {
243  return '';
244  }
245  $extArray = explode( ' ', $exts );
246  $extArray = array_unique( $extArray );
247  foreach ( $extArray as &$ext ) {
248  $ext = htmlspecialchars( '.' . $ext );
249  }
250 
251  return $this->getLanguage()->commaList( $extArray );
252  }
253 
260  protected function outputTableStart( $mediaType ) {
261  $this->getOutput()->addHTML(
263  'table',
264  [ 'class' => [
265  'mw-mediastats-table',
266  'mw-mediastats-table-' . strtolower( $mediaType ),
267  'sortable',
268  'wikitable'
269  ] ]
270  )
271  );
272  $this->getOutput()->addHTML( $this->getTableHeaderRow() );
273  }
274 
280  protected function getTableHeaderRow() {
281  $headers = [ 'mimetype', 'extensions', 'count', 'totalbytes' ];
282  $ths = '';
283  foreach ( $headers as $header ) {
284  $ths .= Html::rawElement(
285  'th',
286  [],
287  // for grep:
288  // mediastatistics-table-mimetype, mediastatistics-table-extensions
289  // tatistics-table-count, mediastatistics-table-totalbytes
290  $this->msg( 'mediastatistics-table-' . $header )->parse()
291  );
292  }
293  return Html::rawElement( 'tr', [], $ths );
294  }
295 
301  protected function outputMediaType( $mediaType ) {
302  $this->getOutput()->addHTML(
304  'h2',
305  [ 'class' => [
306  'mw-mediastats-mediatype',
307  'mw-mediastats-mediatype-' . strtolower( $mediaType )
308  ] ],
309  // for grep
310  // mediastatistics-header-unknown, mediastatistics-header-bitmap,
311  // mediastatistics-header-drawing, mediastatistics-header-audio,
312  // mediastatistics-header-video, mediastatistics-header-multimedia,
313  // mediastatistics-header-office, mediastatistics-header-text,
314  // mediastatistics-header-executable, mediastatistics-header-archive,
315  // mediastatistics-header-3d,
316  $this->msg( 'mediastatistics-header-' . strtolower( $mediaType ) )->text()
317  )
318  );
322  }
323 
330  private function splitFakeTitle( $fakeTitle ) {
331  return explode( ';', $fakeTitle, 4 );
332  }
333 
338  protected function getGroupName() {
339  return 'media';
340  }
341 
351  public function formatResult( $skin, $result ) {
352  throw new MWException( "unimplemented" );
353  }
354 
361  public function preprocessResults( $dbr, $res ) {
363  $this->totalCount = $this->totalBytes = 0;
364  foreach ( $res as $row ) {
365  $mediaStats = $this->splitFakeTitle( $row->title );
366  $this->totalCount += $mediaStats[2] ?? 0;
367  $this->totalBytes += $mediaStats[3] ?? 0;
368  }
369  $res->seek( 0 );
370  }
371 }
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:785
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:252
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
getTableHeaderRow()
Get (not output) the header row for the table.
formatResult( $skin, $result)
This method isn&#39;t used, since we override outputResults, but we need to implement since abstract in p...
getOutput()
Get the OutputPage being used for this instance.
static getInstance()
Returns the global default instance of the top level service locator.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
getExtensionList( $mime)
Given a mime type, return a comma separated list of allowed extensions.
getGroupName()
What group to put the page in.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1994
This is a class for doing query pages; since they&#39;re almost all the same, we factor out some of the f...
Definition: QueryPage.php:35
outputTableRow( $mime, $count, $bytes)
Output a row of the stats table.
getOrderFields()
How to sort the results.
if( $ext=='php'|| $ext=='php5') $mime
Definition: router.php:59
const NS_MEDIA
Definition: Defines.php:52
$res
Definition: database.txt:21
outputTableStart( $mediaType)
Output the start of the table.
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:310
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:40
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:1996
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
$header
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
outputTableEnd()
Output closing
outputResults( $out, $skin, $dbr, $res, $num, $offset)
Output the results of the query.
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
preprocessResults( $dbr, $res)
Initialize total values so we can figure out percentages later.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:276
splitFakeTitle( $fakeTitle)
parse the fake title format that this special page abuses querycache with.
const DB_REPLICA
Definition: defines.php:25
executeLBFromResultWrapper(IResultWrapper $res, $ns=null)
Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include title and ...
Definition: QueryPage.php:860
$ext
Definition: router.php:55
__construct( $name='MediaStatistics')
outputMediaType( $mediaType)
Output a header for a new media type section.
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66