MediaWiki  master
MediaTransformOutput.php
Go to the documentation of this file.
1 <?php
29 abstract class MediaTransformOutput {
33  public $responsiveUrls = [];
34 
36  protected $file;
37 
39  protected $width;
40 
42  protected $height;
43 
45  protected $url;
46 
48  protected $page;
49 
51  protected $path;
52 
54  protected $lang;
55 
57  protected $storagePath = false;
58 
62  public function getWidth() {
63  return $this->width;
64  }
65 
69  public function getHeight() {
70  return $this->height;
71  }
72 
76  public function getFile() {
77  return $this->file;
78  }
79 
85  public function getExtension() {
86  return $this->path ? FileBackend::extensionFromPath( $this->path ) : false;
87  }
88 
92  public function getUrl() {
93  return $this->url;
94  }
95 
99  public function getStoragePath() {
100  return $this->storagePath;
101  }
102 
107  public function setStoragePath( $storagePath ) {
108  $this->storagePath = $storagePath;
109  if ( $this->path === false ) {
110  $this->path = $storagePath;
111  }
112  }
113 
134  abstract public function toHtml( $options = [] );
135 
140  public function isError() {
141  return false;
142  }
143 
155  public function hasFile() {
156  // If TRANSFORM_LATER, $this->path will be false.
157  // Note: a null path means "use the source file".
158  return ( !$this->isError() && ( $this->path || $this->path === null ) );
159  }
160 
167  public function fileIsSource() {
168  return ( !$this->isError() && $this->path === null );
169  }
170 
177  public function getLocalCopyPath() {
178  if ( $this->isError() ) {
179  return false;
180  } elseif ( $this->path === null ) {
181  return $this->file->getLocalRefPath(); // assume thumb was not scaled
182  } elseif ( FileBackend::isStoragePath( $this->path ) ) {
183  $be = $this->file->getRepo()->getBackend();
184  // The temp file will be process cached by FileBackend
185  $fsFile = $be->getLocalReference( [ 'src' => $this->path ] );
186 
187  return $fsFile ? $fsFile->getPath() : false;
188  } else {
189  return $this->path; // may return false
190  }
191  }
192 
200  public function streamFileWithStatus( $headers = [] ) {
201  if ( !$this->path ) {
202  return Status::newFatal( 'backend-fail-stream', '<no path>' );
203  } elseif ( FileBackend::isStoragePath( $this->path ) ) {
204  $be = $this->file->getRepo()->getBackend();
205  return $be->streamFile( [ 'src' => $this->path, 'headers' => $headers ] );
206  } else { // FS-file
207  $success = StreamFile::stream( $this->getLocalCopyPath(), $headers );
208  return $success ? Status::newGood() : Status::newFatal( 'backend-fail-stream', $this->path );
209  }
210  }
211 
219  public function streamFile( $headers = [] ) {
220  return $this->streamFileWithStatus( $headers )->isOK();
221  }
222 
230  protected function linkWrap( $linkAttribs, $contents ) {
231  if ( $linkAttribs ) {
232  return Xml::tags( 'a', $linkAttribs, $contents );
233  } else {
234  return $contents;
235  }
236  }
237 
243  public function getDescLinkAttribs( $title = null, $params = [] ) {
244  if ( is_array( $params ) ) {
245  $query = $params;
246  } else {
247  $query = [];
248  }
249  if ( $this->page && $this->page !== 1 ) {
250  $query['page'] = $this->page;
251  }
252  if ( $this->lang ) {
253  $query['lang'] = $this->lang;
254  }
255 
256  if ( is_string( $params ) && $params !== '' ) {
257  $query = $params . '&' . wfArrayToCgi( $query );
258  }
259 
260  $attribs = [
261  'href' => $this->file->getTitle()->getLocalURL( $query ),
262  'class' => 'image',
263  ];
264  if ( $title ) {
265  $attribs['title'] = $title;
266  }
267 
268  return $attribs;
269  }
270 }
271 
290  function __construct( $file, $url, $path = false, $parameters = [] ) {
291  # Previous parameters:
292  # $file, $url, $width, $height, $path = false, $page = false
293 
294  $defaults = [
295  'page' => false,
296  'lang' => false
297  ];
298 
299  if ( is_array( $parameters ) ) {
300  $actualParams = $parameters + $defaults;
301  } else {
302  # Using old format, should convert. Later a warning could be added here.
303  $numArgs = func_num_args();
304  $actualParams = [
305  'width' => $path,
306  'height' => $parameters,
307  'page' => ( $numArgs > 5 ) ? func_get_arg( 5 ) : false
308  ] + $defaults;
309  $path = ( $numArgs > 4 ) ? func_get_arg( 4 ) : false;
310  }
311 
312  $this->file = $file;
313  $this->url = $url;
314  $this->path = $path;
315 
316  # These should be integers when they get here.
317  # If not, there's a bug somewhere. But let's at
318  # least produce valid HTML code regardless.
319  $this->width = round( $actualParams['width'] );
320  $this->height = round( $actualParams['height'] );
321 
322  $this->page = $actualParams['page'];
323  $this->lang = $actualParams['lang'];
324  }
325 
358  function toHtml( $options = [] ) {
359  if ( count( func_get_args() ) == 2 ) {
360  throw new MWException( __METHOD__ . ' called in the old style' );
361  }
362 
363  $alt = $options['alt'] ?? '';
364 
365  $query = $options['desc-query'] ?? '';
366 
367  $attribs = [
368  'alt' => $alt,
369  'src' => $this->url,
370  'decoding' => 'async',
371  ];
372 
373  if ( !empty( $options['custom-url-link'] ) ) {
374  $linkAttribs = [ 'href' => $options['custom-url-link'] ];
375  if ( !empty( $options['title'] ) ) {
376  $linkAttribs['title'] = $options['title'];
377  }
378  if ( !empty( $options['custom-target-link'] ) ) {
379  $linkAttribs['target'] = $options['custom-target-link'];
380  } elseif ( !empty( $options['parser-extlink-target'] ) ) {
381  $linkAttribs['target'] = $options['parser-extlink-target'];
382  }
383  if ( !empty( $options['parser-extlink-rel'] ) ) {
384  $linkAttribs['rel'] = $options['parser-extlink-rel'];
385  }
386  } elseif ( !empty( $options['custom-title-link'] ) ) {
388  $title = $options['custom-title-link'];
389  $linkAttribs = [
390  'href' => $title->getLinkURL(),
391  'title' => empty( $options['title'] ) ? $title->getFullText() : $options['title']
392  ];
393  } elseif ( !empty( $options['desc-link'] ) ) {
394  $linkAttribs = $this->getDescLinkAttribs(
395  empty( $options['title'] ) ? null : $options['title'],
396  $query
397  );
398  } elseif ( !empty( $options['file-link'] ) ) {
399  $linkAttribs = [ 'href' => $this->file->getUrl() ];
400  } else {
401  $linkAttribs = false;
402  if ( !empty( $options['title'] ) ) {
403  $attribs['title'] = $options['title'];
404  }
405  }
406 
407  if ( empty( $options['no-dimensions'] ) ) {
408  $attribs['width'] = $this->width;
409  $attribs['height'] = $this->height;
410  }
411  if ( !empty( $options['valign'] ) ) {
412  $attribs['style'] = "vertical-align: {$options['valign']}";
413  }
414  if ( !empty( $options['img-class'] ) ) {
415  $attribs['class'] = $options['img-class'];
416  }
417  if ( isset( $options['override-height'] ) ) {
418  $attribs['height'] = $options['override-height'];
419  }
420  if ( isset( $options['override-width'] ) ) {
421  $attribs['width'] = $options['override-width'];
422  }
423 
424  // Additional densities for responsive images, if specified.
425  // If any of these urls is the same as src url, it'll be excluded.
426  $responsiveUrls = array_diff( $this->responsiveUrls, [ $this->url ] );
427  if ( !empty( $responsiveUrls ) ) {
428  $attribs['srcset'] = Html::srcSet( $responsiveUrls );
429  }
430 
431  Hooks::run( 'ThumbnailBeforeProduceHTML', [ $this, &$attribs, &$linkAttribs ] );
432 
433  return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) );
434  }
435 }
436 
444  private $msg;
445 
446  function __construct( $msg, $width, $height /*, ... */ ) {
447  $args = array_slice( func_get_args(), 3 );
448  $this->msg = wfMessage( $msg )->params( $args );
449  $this->width = intval( $width );
450  $this->height = intval( $height );
451  $this->url = false;
452  $this->path = false;
453  }
454 
455  function toHtml( $options = [] ) {
456  return "<div class=\"MediaTransformError\" style=\"" .
457  "width: {$this->width}px; height: {$this->height}px; display:inline-block;\">" .
458  $this->getHtmlMsg() .
459  "</div>";
460  }
461 
462  function toText() {
463  return $this->msg->text();
464  }
465 
466  function getHtmlMsg() {
467  return $this->msg->escaped();
468  }
469 
470  function getMsg() {
471  return $this->msg;
472  }
473 
474  function isError() {
475  return true;
476  }
477 
478  function getHttpStatusCode() {
479  return 500;
480  }
481 }
482 
489  function __construct( $params ) {
490  parent::__construct( 'thumbnail_error',
491  max( $params['width'] ?? 0, 120 ),
492  max( $params['height'] ?? 0, 120 ),
493  wfMessage( 'thumbnail_invalid_params' )
494  );
495  }
496 
497  function getHttpStatusCode() {
498  return 400;
499  }
500 }
501 
509  function __construct( $params, $maxImageArea ) {
510  $msg = wfMessage( 'thumbnail_toobigimagearea' );
511  $msg->params(
512  $msg->getLanguage()->formatComputingNumbers( $maxImageArea, 1000, "size-$1pixel" )
513  );
514 
515  parent::__construct( 'thumbnail_error',
516  max( $params['width'] ?? 0, 120 ),
517  max( $params['height'] ?? 0, 120 ),
518  $msg
519  );
520  }
521 
522  function getHttpStatusCode() {
523  return 400;
524  }
525 }
getLocalCopyPath()
Get the path of a file system copy of the thumbnail.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1598
hasFile()
Check if an output thumbnail file actually exists.
$success
toHtml( $options=[])
Return HTML.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
bool string $path
Filesystem path to the thumb.
string $url
URL path to the thumb.
width
__construct( $params, $maxImageArea)
array $responsiveUrls
Associative array mapping optional supplementary image files from pixel density (eg 1...
bool string $storagePath
Permanent storage path.
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
target page
static isStoragePath( $path)
Check if a given path is a "mwstore://" path.
Base class for the output of MediaHandler::doTransform() and File::transform().
if( $line===false) $args
Definition: cdb.php:64
Shortcut class for parameter validation errors.
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e.g.
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:91
__construct( $file, $url, $path=false, $parameters=[])
Get a thumbnail object from a file and parameters.
toHtml( $options=[])
Fetch HTML for this transform output.
isError()
This will be overridden to return true in error classes.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Media transform output for images.
getDescLinkAttribs( $title=null, $params=[])
$params
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 & $options
Definition: hooks.txt:1995
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:132
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 and may include noclasses after processing & $attribs
Definition: hooks.txt:1995
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:935
linkWrap( $linkAttribs, $contents)
Wrap some XHTML text in an anchor tag with the given attributes.
bool string $lang
Language code, false if not set.
getExtension()
Get the final extension of the thumbnail.
streamFile( $headers=[])
Stream the file if there were no errors.
Shortcut class for parameter file size errors.
static srcSet(array $urls)
Generate a srcset attribute value.
Definition: Html.php:1070
static stream( $fname, $headers=[], $sendErrors=true, $optHeaders=[], $flags=0)
Stream a file to the browser, adding all the headings and fun stuff.
Definition: StreamFile.php:45
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
fileIsSource()
Check if the output thumbnail is the same as the source.
streamFileWithStatus( $headers=[])
Stream the file if there were no errors.
static element( $element, $attribs=null, $contents='', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:41
int $height
Image height.
__construct( $msg, $width, $height)
Basic media transform error class.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200