includes/media/MediaTransformOutput.php

   1 <?php
   2 /**
   3  * Base class for the output of file transformation methods.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Media
  22  */
  23
  24 /**
  25  * Base class for the output of MediaHandler::doTransform() and File::transform().
  26  *
  27  * @ingroup Media
  28  */
  29 abstract class MediaTransformOutput {
  30         /**
  31          * @var File
  32          */
  33         var $file;
  34
  35         var $width, $height, $url, $page, $path;
  36
  37         /**
  38          * @var array Associative array mapping optional supplementary image files
  39          * from pixel density (eg 1.5 or 2) to additional URLs.
  40          */
  41         public $responsiveUrls = array();
  42
  43         protected $storagePath = false;
  44
  45         /**
  46          * @return integer Width of the output box
  47          */
  48         public function getWidth() {
  49                 return $this->width;
  50         }
  51
  52         /**
  53          * @return integer Height of the output box
  54          */
  55         public function getHeight() {
  56                 return $this->height;
  57         }
  58
  59         /**
  60          * Get the final extension of the thumbnail.
  61          * Returns false for scripted transformations.
  62          * @return string|false
  63          */
  64         public function getExtension() {
  65                 return $this->path ? FileBackend::extensionFromPath( $this->path ) : false;
  66         }
  67
  68         /**
  69          * @return string|false The thumbnail URL
  70          */
  71         public function getUrl() {
  72                 return $this->url;
  73         }
  74
  75         /**
  76          * @return string|bool The permanent thumbnail storage path
  77          */
  78         public function getStoragePath() {
  79                 return $this->storagePath;
  80         }
  81
  82         /**
  83          * @param $storagePath string The permanent storage path
  84          * @return void
  85          */
  86         public function setStoragePath( $storagePath ) {
  87                 $this->storagePath = $storagePath;
  88         }
  89
  90         /**
  91          * Fetch HTML for this transform output
  92          *
  93          * @param $options array Associative array of options. Boolean options
  94          *     should be indicated with a value of true for true, and false or
  95          *     absent for false.
  96          *
  97          *     alt          Alternate text or caption
  98          *     desc-link    Boolean, show a description link
  99          *     file-link    Boolean, show a file download link
 100          *     custom-url-link    Custom URL to link to
 101          *     custom-title-link  Custom Title object to link to
 102          *     valign       vertical-align property, if the output is an inline element
 103          *     img-class    Class applied to the "<img>" tag, if there is such a tag
 104          *
 105          * For images, desc-link and file-link are implemented as a click-through. For
 106          * sounds and videos, they may be displayed in other ways.
 107          *
 108          * @return string
 109          */
 110         abstract public function toHtml( $options = array() );
 111
 112         /**
 113          * This will be overridden to return true in error classes
 114          * @return bool
 115          */
 116         public function isError() {
 117                 return false;
 118         }
 119
 120         /**
 121          * Check if an output thumbnail file actually exists.
 122          * This will return false if there was an error, the
 123          * thumbnail is to be handled client-side only, or if
 124          * transformation was deferred via TRANSFORM_LATER.
 125          *
 126          * @return Bool
 127          */
 128         public function hasFile() {
 129                 // If TRANSFORM_LATER, $this->path will be false.
 130                 // Note: a null path means "use the source file".
 131                 return ( !$this->isError() && ( $this->path || $this->path === null ) );
 132         }
 133
 134         /**
 135          * Check if the output thumbnail is the same as the source.
 136          * This can occur if the requested width was bigger than the source.
 137          *
 138          * @return Bool
 139          */
 140         public function fileIsSource() {
 141                 return ( !$this->isError() && $this->path === null );
 142         }
 143
 144         /**
 145          * Get the path of a file system copy of the thumbnail.
 146          * Callers should never write to this path.
 147          *
 148          * @return string|bool Returns false if there isn't one
 149          */
 150         public function getLocalCopyPath() {
 151                 if ( $this->isError() ) {
 152                         return false;
 153                 } elseif ( $this->path === null ) {
 154                         return $this->file->getLocalRefPath();
 155                 } else {
 156                         return $this->path; // may return false
 157                 }
 158         }
 159
 160         /**
 161          * Stream the file if there were no errors
 162          *
 163          * @param $headers Array Additional HTTP headers to send on success
 164          * @return Bool success
 165          */
 166         public function streamFile( $headers = array() ) {
 167                 if ( !$this->path ) {
 168                         return false;
 169                 } elseif ( FileBackend::isStoragePath( $this->path ) ) {
 170                         $be = $this->file->getRepo()->getBackend();
 171                         return $be->streamFile( array( 'src' => $this->path, 'headers' => $headers ) )->isOK();
 172                 } else { // FS-file
 173                         return StreamFile::stream( $this->getLocalCopyPath(), $headers );
 174                 }
 175         }
 176
 177         /**
 178          * Wrap some XHTML text in an anchor tag with the given attributes
 179          *
 180          * @param $linkAttribs array
 181          * @param $contents string
 182          *
 183          * @return string
 184          */
 185         protected function linkWrap( $linkAttribs, $contents ) {
 186                 if ( $linkAttribs ) {
 187                         return Xml::tags( 'a', $linkAttribs, $contents );
 188                 } else {
 189                         return $contents;
 190                 }
 191         }
 192
 193         /**
 194          * @param $title string
 195          * @param $params array
 196          * @return array
 197          */
 198         public function getDescLinkAttribs( $title = null, $params = '' ) {
 199                 $query = '';
 200                 if ( $this->page && $this->page !== 1 ) {
 201                           $query = 'page=' . urlencode( $this->page );
 202                 }
 203                 if( $params ) {
 204                         $query .= $query ? '&'.$params : $params;
 205                 }
 206                 $attribs = array(
 207                         'href' => $this->file->getTitle()->getLocalURL( $query ),
 208                         'class' => 'image',
 209                 );
 210                 if ( $title ) {
 211                         $attribs['title'] = $title;
 212                 }
 213                 return $attribs;
 214         }
 215 }
 216
 217 /**
 218  * Media transform output for images
 219  *
 220  * @ingroup Media
 221  */
 222 class ThumbnailImage extends MediaTransformOutput {
 223         /**
 224          * Get a thumbnail object from a file and parameters.
 225          * If $path is set to null, the output file is treated as a source copy.
 226          * If $path is set to false, no output file will be created.
 227          * $parameters should include, as a minimum, (file) 'width' and 'height'.
 228          * It may also include a 'page' parameter for multipage files.
 229          *
 230          * @param $file File object
 231          * @param $url String: URL path to the thumb
 232          * @param $path String|bool|null: filesystem path to the thumb
 233          * @param $parameters Array: Associative array of parameters
 234          * @private
 235          */
 236         function __construct( $file, $url, $path = false, $parameters = array() ) {
 237                 # Previous parameters:
 238                 #   $file, $url, $width, $height, $path = false, $page = false
 239
 240                 if( is_array( $parameters ) ){
 241                         $defaults = array(
 242                                 'page' => false
 243                         );
 244                         $actualParams = $parameters + $defaults;
 245                 } else {
 246                         # Using old format, should convert. Later a warning could be added here.
 247                         $numArgs = func_num_args();
 248                         $actualParams = array(
 249                                 'width' => $path,
 250                                 'height' => $parameters,
 251                                 'page' => ( $numArgs > 5 ) ? func_get_arg( 5 ) : false
 252                         );
 253                         $path = ( $numArgs > 4 ) ? func_get_arg( 4 ) : false;
 254                 }
 255
 256                 $this->file = $file;
 257                 $this->url = $url;
 258                 $this->path = $path;
 259
 260                 # These should be integers when they get here.
 261                 # If not, there's a bug somewhere.  But let's at
 262                 # least produce valid HTML code regardless.
 263                 $this->width = round( $actualParams['width'] );
 264                 $this->height = round( $actualParams['height'] );
 265
 266                 $this->page = $actualParams['page'];
 267         }
 268
 269         /**
 270          * Return HTML <img ... /> tag for the thumbnail, will include
 271          * width and height attributes and a blank alt text (as required).
 272          *
 273          * @param $options array Associative array of options. Boolean options
 274          *     should be indicated with a value of true for true, and false or
 275          *     absent for false.
 276          *
 277          *     alt          HTML alt attribute
 278          *     title        HTML title attribute
 279          *     desc-link    Boolean, show a description link
 280          *     file-link    Boolean, show a file download link
 281          *     valign       vertical-align property, if the output is an inline element
 282          *     img-class    Class applied to the \<img\> tag, if there is such a tag
 283          *     desc-query   String, description link query params
 284          *     custom-url-link    Custom URL to link to
 285          *     custom-title-link  Custom Title object to link to
 286          *     custom target-link Value of the target attribute, for custom-target-link
 287          *     parser-extlink-*   Attributes added by parser for external links:
 288          *          parser-extlink-rel: add rel="nofollow"
 289          *          parser-extlink-target: link target, but overridden by custom-target-link
 290          *
 291          * For images, desc-link and file-link are implemented as a click-through. For
 292          * sounds and videos, they may be displayed in other ways.
 293          *
 294          * @throws MWException
 295          * @return string
 296          */
 297         function toHtml( $options = array() ) {
 298                 if ( count( func_get_args() ) == 2 ) {
 299                         throw new MWException( __METHOD__ .' called in the old style' );
 300                 }
 301
 302                 $alt = empty( $options['alt'] ) ? '' : $options['alt'];
 303
 304                 $query = empty( $options['desc-query'] )  ? '' : $options['desc-query'];
 305
 306                 if ( !empty( $options['custom-url-link'] ) ) {
 307                         $linkAttribs = array( 'href' => $options['custom-url-link'] );
 308                         if ( !empty( $options['title'] ) ) {
 309                                 $linkAttribs['title'] = $options['title'];
 310                         }
 311                         if ( !empty( $options['custom-target-link'] ) ) {
 312                                 $linkAttribs['target'] = $options['custom-target-link'];
 313                         } elseif ( !empty( $options['parser-extlink-target'] ) ) {
 314                                 $linkAttribs['target'] = $options['parser-extlink-target'];
 315                         }
 316                         if ( !empty( $options['parser-extlink-rel'] ) ) {
 317                                 $linkAttribs['rel'] = $options['parser-extlink-rel'];
 318                         }
 319                 } elseif ( !empty( $options['custom-title-link'] ) ) {
 320                         $title = $options['custom-title-link'];
 321                         $linkAttribs = array(
 322                                 'href' => $title->getLinkURL(),
 323                                 'title' => empty( $options['title'] ) ? $title->getFullText() : $options['title']
 324                         );
 325                 } elseif ( !empty( $options['desc-link'] ) ) {
 326                         $linkAttribs = $this->getDescLinkAttribs( empty( $options['title'] ) ? null : $options['title'], $query );
 327                 } elseif ( !empty( $options['file-link'] ) ) {
 328                         $linkAttribs = array( 'href' => $this->file->getURL() );
 329                 } else {
 330                         $linkAttribs = false;
 331                 }
 332
 333                 $attribs = array(
 334                         'alt' => $alt,
 335                         'src' => $this->url,
 336                         'width' => $this->width,
 337                         'height' => $this->height
 338                 );
 339                 if ( !empty( $options['valign'] ) ) {
 340                         $attribs['style'] = "vertical-align: {$options['valign']}";
 341                 }
 342                 if ( !empty( $options['img-class'] ) ) {
 343                         $attribs['class'] = $options['img-class'];
 344                 }
 345
 346                 // Additional densities for responsive images, if specified.
 347                 if ( !empty( $this->responsiveUrls ) ) {
 348                         $attribs['srcset'] = Html::srcSet( $this->responsiveUrls );
 349                 }
 350                 return $this->linkWrap( $linkAttribs, Xml::element( 'img', $attribs ) );
 351         }
 352
 353 }
 354
 355 /**
 356  * Basic media transform error class
 357  *
 358  * @ingroup Media
 359  */
 360 class MediaTransformError extends MediaTransformOutput {
 361         var $htmlMsg, $textMsg, $width, $height, $url, $path;
 362
 363         function __construct( $msg, $width, $height /*, ... */ ) {
 364                 $args = array_slice( func_get_args(), 3 );
 365                 $htmlArgs = array_map( 'htmlspecialchars', $args );
 366                 $htmlArgs = array_map( 'nl2br', $htmlArgs );
 367
 368                 $this->htmlMsg = wfMessage( $msg )->rawParams( $htmlArgs )->escaped();
 369                 $this->textMsg = wfMessage( $msg )->rawParams( $htmlArgs )->text();
 370                 $this->width = intval( $width );
 371                 $this->height = intval( $height );
 372                 $this->url = false;
 373                 $this->path = false;
 374         }
 375
 376         function toHtml( $options = array() ) {
 377                 return "<div class=\"MediaTransformError\" style=\"" .
 378                         "width: {$this->width}px; height: {$this->height}px; display:inline-block;\">" .
 379                         $this->htmlMsg .
 380                         "</div>";
 381         }
 382
 383         function toText() {
 384                 return $this->textMsg;
 385         }
 386
 387         function getHtmlMsg() {
 388                 return $this->htmlMsg;
 389         }
 390
 391         function isError() {
 392                 return true;
 393         }
 394 }
 395
 396 /**
 397  * Shortcut class for parameter validation errors
 398  *
 399  * @ingroup Media
 400  */
 401 class TransformParameterError extends MediaTransformError {
 402         function __construct( $params ) {
 403                 parent::__construct( 'thumbnail_error',
 404                         max( isset( $params['width']  ) ? $params['width']  : 0, 120 ),
 405                         max( isset( $params['height'] ) ? $params['height'] : 0, 120 ),
 406                         wfMessage( 'thumbnail_invalid_params' )->text() );
 407         }
 408 }