includes/MediaTransformOutput.php

   1 <?php
   2 /**
   3  * @file
   4  * @ingroup Media
   5  */
   6
   7 /**
   8  * Base class for the output of MediaHandler::doTransform() and File::transform().
   9  *
  10  * @ingroup Media
  11  */
  12 abstract class MediaTransformOutput {
  13         var $file, $width, $height, $url, $page, $path;
  14
  15         /**
  16          * Get the width of the output box
  17          */
  18         function getWidth() {
  19                 return $this->width;
  20         }
  21
  22         /**
  23          * Get the height of the output box
  24          */
  25         function getHeight() {
  26                 return $this->height;
  27         }
  28
  29         /**
  30          * @return string The thumbnail URL
  31          */
  32         function getUrl() {
  33                 return $this->url;
  34         }
  35
  36         /**
  37          * @return string Destination file path (local filesystem)
  38          */
  39         function getPath() {
  40                 return $this->path;
  41         }
  42
  43         /**
  44          * Fetch HTML for this transform output
  45          *
  46          * @param array $options Associative array of options. Boolean options
  47          *     should be indicated with a value of true for true, and false or
  48          *     absent for false.
  49          *
  50          *     alt          Alternate text or caption
  51          *     desc-link    Boolean, show a description link
  52          *     file-link    Boolean, show a file download link
  53          *     custom-url-link    Custom URL to link to
  54          *     custom-title-link  Custom Title object to link to
  55          *     valign       vertical-align property, if the output is an inline element
  56          *     img-class    Class applied to the <img> tag, if there is such a tag
  57          *
  58          * For images, desc-link and file-link are implemented as a click-through. For
  59          * sounds and videos, they may be displayed in other ways.
  60          *
  61          * @return string
  62          */
  63         abstract function toHtml( $options = array() );
  64
  65         /**
  66          * This will be overridden to return true in error classes
  67          */
  68         function isError() {
  69                 return false;
  70         }
  71
  72         /**
  73          * Wrap some XHTML text in an anchor tag with the given attributes
  74          */
  75         protected function linkWrap( $linkAttribs, $contents ) {
  76                 if ( $linkAttribs ) {
  77                         return Xml::tags( 'a', $linkAttribs, $contents );
  78                 } else {
  79                         return $contents;
  80                 }
  81         }
  82
  83         function getDescLinkAttribs( $alt = false, $params = '' ) {
  84                 $query = $this->page ? ( 'page=' . urlencode( $this->page ) ) : '';
  85                 if( $params ) {
  86                         $query .= $query ? '&'.$params : $params;
  87                 }
  88                 $title = $this->file->getTitle();
  89                 return array(
  90                         'href' => $this->file->getTitle()->getLocalURL( $query ),
  91                         'class' => 'image',
  92                         'title' => $alt
  93                 );
  94         }
  95 }
  96
  97
  98 /**
  99  * Media transform output for images
 100  *
 101  * @ingroup Media
 102  */
 103 class ThumbnailImage extends MediaTransformOutput {
 104         /**
 105          * @param string $path Filesystem path to the thumb
 106          * @param string $url URL path to the thumb
 107          * @private
 108          */
 109         function ThumbnailImage( $file, $url, $width, $height, $path = false, $page = false ) {
 110                 $this->file = $file;
 111                 $this->url = $url;
 112                 # These should be integers when they get here.
 113                 # If not, there's a bug somewhere.  But let's at
 114                 # least produce valid HTML code regardless.
 115                 $this->width = round( $width );
 116                 $this->height = round( $height );
 117                 $this->path = $path;
 118                 $this->page = $page;
 119         }
 120
 121         /**
 122          * Return HTML <img ... /> tag for the thumbnail, will include
 123          * width and height attributes and a blank alt text (as required).
 124          *
 125          * @param array $options Associative array of options. Boolean options
 126          *     should be indicated with a value of true for true, and false or
 127          *     absent for false.
 128          *
 129          *     alt          HTML alt attribute
 130          *     title        HTML title attribute
 131          *     desc-link    Boolean, show a description link
 132          *     file-link    Boolean, show a file download link
 133          *     valign       vertical-align property, if the output is an inline element
 134          *     img-class    Class applied to the <img> tag, if there is such a tag
 135          *     desc-query   String, description link query params
 136          *     custom-url-link    Custom URL to link to
 137          *     custom-title-link  Custom Title object to link to
 138          *
 139          * For images, desc-link and file-link are implemented as a click-through. For
 140          * sounds and videos, they may be displayed in other ways.
 141          *
 142          * @return string
 143          * @public
 144          */
 145         function toHtml( $options = array() ) {
 146                 if ( count( func_get_args() ) == 2 ) {
 147                         throw new MWException( __METHOD__ .' called in the old style' );
 148                 }
 149
 150                 $alt = empty( $options['alt'] ) ? '' : $options['alt'];
 151                 # Note: if title is empty and alt is not, make the title empty, don't
 152                 # use alt; only use alt if title is not set
 153                 $title = !isset( $options['title'] ) ? $alt : $options['title'];
 154                 $query = empty($options['desc-query'])  ? '' : $options['desc-query'];
 155
 156                 if ( !empty( $options['custom-url-link'] ) ) {
 157                         $linkAttribs = array( 'href' => $options['custom-url-link'] );
 158                         if ( $alt ) {
 159                                 $linkAttribs['title'] = $alt;
 160                         }
 161                 } elseif ( !empty( $options['custom-title-link'] ) ) {
 162                         $title = $options['custom-title-link'];
 163                         $linkAttribs = array( 'href' => $title->getLinkUrl(),
 164                                         'title' => $alt );
 165                 } elseif ( !empty( $options['desc-link'] ) ) {
 166                         $linkAttribs = $this->getDescLinkAttribs( $title, $query );
 167                 } elseif ( !empty( $options['file-link'] ) ) {
 168                         $linkAttribs = array( 'href' => $this->file->getURL() );
 169                 } else {
 170                         $linkAttribs = false;
 171                 }
 172
 173                 $attribs = array(
 174                         'alt' => $alt,
 175                         'src' => $this->url,
 176                         'width' => $this->width,
 177                         'height' => $this->height,
 178                 );
 179                 if ( !empty( $options['valign'] ) ) {
 180                         $attribs['style'] = "vertical-align: {$options['valign']}";
 181                 }
 182                 if ( !empty( $options['img-class'] ) ) {
 183                         $attribs['class'] = $options['img-class'];
 184                 }
 185                 return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) );
 186         }
 187
 188 }
 189
 190 /**
 191  * Basic media transform error class
 192  *
 193  * @ingroup Media
 194  */
 195 class MediaTransformError extends MediaTransformOutput {
 196         var $htmlMsg, $textMsg, $width, $height, $url, $path;
 197
 198         function __construct( $msg, $width, $height /*, ... */ ) {
 199                 $args = array_slice( func_get_args(), 3 );
 200                 $htmlArgs = array_map( 'htmlspecialchars', $args );
 201                 $htmlArgs = array_map( 'nl2br', $htmlArgs );
 202
 203                 $this->htmlMsg = wfMsgReplaceArgs( htmlspecialchars( wfMsgGetKey( $msg, true ) ), $htmlArgs );
 204                 $this->textMsg = wfMsgReal( $msg, $args );
 205                 $this->width = intval( $width );
 206                 $this->height = intval( $height );
 207                 $this->url = false;
 208                 $this->path = false;
 209         }
 210
 211         function toHtml( $options = array() ) {
 212                 return "<table class=\"MediaTransformError\" style=\"" .
 213                         "width: {$this->width}px; height: {$this->height}px;\"><tr><td>" .
 214                         $this->htmlMsg .
 215                         "</td></tr></table>";
 216         }
 217
 218         function toText() {
 219                 return $this->textMsg;
 220         }
 221
 222         function getHtmlMsg() {
 223                 return $this->htmlMsg;
 224         }
 225
 226         function isError() {
 227                 return true;
 228         }
 229 }
 230
 231 /**
 232  * Shortcut class for parameter validation errors
 233  *
 234  * @ingroup Media
 235  */
 236 class TransformParameterError extends MediaTransformError {
 237         function __construct( $params ) {
 238                 parent::__construct( 'thumbnail_error',
 239                         max( isset( $params['width']  ) ? $params['width']  : 0, 180 ),
 240                         max( isset( $params['height'] ) ? $params['height'] : 0, 180 ),
 241                         wfMsg( 'thumbnail_invalid_params' ) );
 242         }
 243 }