includes/media/DjVu.php

   1 <?php
   2 /**
   3  * Handler for DjVu images.
   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  * Handler for DjVu images
  26  *
  27  * @ingroup Media
  28  */
  29 class DjVuHandler extends ImageHandler {
  30         /**
  31          * @return bool
  32          */
  33         function isEnabled() {
  34                 global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML;
  35                 if ( !$wgDjvuRenderer || ( !$wgDjvuDump && !$wgDjvuToXML ) ) {
  36                         wfDebug( "DjVu is disabled, please set \$wgDjvuRenderer and \$wgDjvuDump\n" );
  37
  38                         return false;
  39                 } else {
  40                         return true;
  41                 }
  42         }
  43
  44         /**
  45          * @param File $file
  46          * @return bool
  47          */
  48         function mustRender( $file ) {
  49                 return true;
  50         }
  51
  52         /**
  53          * @param File $file
  54          * @return bool
  55          */
  56         function isMultiPage( $file ) {
  57                 return true;
  58         }
  59
  60         /**
  61          * @return array
  62          */
  63         function getParamMap() {
  64                 return array(
  65                         'img_width' => 'width',
  66                         'img_page' => 'page',
  67                 );
  68         }
  69
  70         /**
  71          * @param string $name
  72          * @param mixed $value
  73          * @return bool
  74          */
  75         function validateParam( $name, $value ) {
  76                 if ( in_array( $name, array( 'width', 'height', 'page' ) ) ) {
  77                         if ( $value <= 0 ) {
  78                                 return false;
  79                         } else {
  80                                 return true;
  81                         }
  82                 } else {
  83                         return false;
  84                 }
  85         }
  86
  87         /**
  88          * @param array $params
  89          * @return bool|string
  90          */
  91         function makeParamString( $params ) {
  92                 $page = isset( $params['page'] ) ? $params['page'] : 1;
  93                 if ( !isset( $params['width'] ) ) {
  94                         return false;
  95                 }
  96
  97                 return "page{$page}-{$params['width']}px";
  98         }
  99
 100         /**
 101          * @param string $str
 102          * @return array|bool
 103          */
 104         function parseParamString( $str ) {
 105                 $m = false;
 106                 if ( preg_match( '/^page(\d+)-(\d+)px$/', $str, $m ) ) {
 107                         return array( 'width' => $m[2], 'page' => $m[1] );
 108                 } else {
 109                         return false;
 110                 }
 111         }
 112
 113         /**
 114          * @param array $params
 115          * @return array
 116          */
 117         function getScriptParams( $params ) {
 118                 return array(
 119                         'width' => $params['width'],
 120                         'page' => $params['page'],
 121                 );
 122         }
 123
 124         /**
 125          * @param File $image
 126          * @param string $dstPath
 127          * @param string $dstUrl
 128          * @param array $params
 129          * @param int $flags
 130          * @return MediaTransformError|ThumbnailImage|TransformParameterError
 131          */
 132         function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
 133                 global $wgDjvuRenderer, $wgDjvuPostProcessor;
 134
 135                 // Fetch XML and check it, to give a more informative error message than the one which
 136                 // normaliseParams will inevitably give.
 137                 $xml = $image->getMetadata();
 138                 if ( !$xml ) {
 139                         $width = isset( $params['width'] ) ? $params['width'] : 0;
 140                         $height = isset( $params['height'] ) ? $params['height'] : 0;
 141
 142                         return new MediaTransformError( 'thumbnail_error', $width, $height,
 143                                 wfMessage( 'djvu_no_xml' )->text() );
 144                 }
 145
 146                 if ( !$this->normaliseParams( $image, $params ) ) {
 147                         return new TransformParameterError( $params );
 148                 }
 149                 $width = $params['width'];
 150                 $height = $params['height'];
 151                 $page = $params['page'];
 152                 if ( $page > $this->pageCount( $image ) ) {
 153                         return new MediaTransformError(
 154                                 'thumbnail_error',
 155                                 $width,
 156                                 $height,
 157                                 wfMessage( 'djvu_page_error' )->text()
 158                         );
 159                 }
 160
 161                 if ( $flags & self::TRANSFORM_LATER ) {
 162                         $params = array(
 163                                 'width' => $width,
 164                                 'height' => $height,
 165                                 'page' => $page
 166                         );
 167
 168                         return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
 169                 }
 170
 171                 if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__ ) ) {
 172                         return new MediaTransformError(
 173                                 'thumbnail_error',
 174                                 $width,
 175                                 $height,
 176                                 wfMessage( 'thumbnail_dest_directory' )->text()
 177                         );
 178                 }
 179
 180                 $srcPath = $image->getLocalRefPath();
 181                 # Use a subshell (brackets) to aggregate stderr from both pipeline commands
 182                 # before redirecting it to the overall stdout. This works in both Linux and Windows XP.
 183                 $cmd = '(' . wfEscapeShellArg( $wgDjvuRenderer ) . " -format=ppm -page={$page}" .
 184                         " -size={$params['physicalWidth']}x{$params['physicalHeight']} " .
 185                         wfEscapeShellArg( $srcPath );
 186                 if ( $wgDjvuPostProcessor ) {
 187                         $cmd .= " | {$wgDjvuPostProcessor}";
 188                 }
 189                 $cmd .= ' > ' . wfEscapeShellArg( $dstPath ) . ') 2>&1';
 190                 wfProfileIn( 'ddjvu' );
 191                 wfDebug( __METHOD__ . ": $cmd\n" );
 192                 $retval = '';
 193                 $err = wfShellExec( $cmd, $retval );
 194                 wfProfileOut( 'ddjvu' );
 195
 196                 $removed = $this->removeBadFile( $dstPath, $retval );
 197                 if ( $retval != 0 || $removed ) {
 198                         $this->logErrorForExternalProcess( $retval, $err, $cmd );
 199                         return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
 200                 } else {
 201                         $params = array(
 202                                 'width' => $width,
 203                                 'height' => $height,
 204                                 'page' => $page
 205                         );
 206
 207                         return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
 208                 }
 209         }
 210
 211         /**
 212          * Cache an instance of DjVuImage in an Image object, return that instance
 213          *
 214          * @param File $image
 215          * @param string $path
 216          * @return DjVuImage
 217          */
 218         function getDjVuImage( $image, $path ) {
 219                 if ( !$image ) {
 220                         $deja = new DjVuImage( $path );
 221                 } elseif ( !isset( $image->dejaImage ) ) {
 222                         $deja = $image->dejaImage = new DjVuImage( $path );
 223                 } else {
 224                         $deja = $image->dejaImage;
 225                 }
 226
 227                 return $deja;
 228         }
 229
 230         /**
 231          * Cache a document tree for the DjVu XML metadata
 232          * @param File $image
 233          * @param bool $gettext DOCUMENT (Default: false)
 234          * @return bool|SimpleXMLElement
 235          */
 236         function getMetaTree( $image, $gettext = false ) {
 237                 if ( $gettext && isset( $image->djvuTextTree ) ) {
 238                         return $image->djvuTextTree;
 239                 }
 240                 if ( !$gettext && isset( $image->dejaMetaTree ) ) {
 241                         return $image->dejaMetaTree;
 242                 }
 243
 244                 $metadata = $image->getMetadata();
 245                 if ( !$this->isMetadataValid( $image, $metadata ) ) {
 246                         wfDebug( "DjVu XML metadata is invalid or missing, should have been fixed in upgradeRow\n" );
 247
 248                         return false;
 249                 }
 250                 wfProfileIn( __METHOD__ );
 251
 252                 wfSuppressWarnings();
 253                 try {
 254                         // Set to false rather than null to avoid further attempts
 255                         $image->dejaMetaTree = false;
 256                         $image->djvuTextTree = false;
 257                         $tree = new SimpleXMLElement( $metadata );
 258                         if ( $tree->getName() == 'mw-djvu' ) {
 259                                 /** @var SimpleXMLElement $b */
 260                                 foreach ( $tree->children() as $b ) {
 261                                         if ( $b->getName() == 'DjVuTxt' ) {
 262                                                 // @todo File::djvuTextTree and File::dejaMetaTree are declared
 263                                                 // dynamically. Add a public File::$data to facilitate this?
 264                                                 $image->djvuTextTree = $b;
 265                                         } elseif ( $b->getName() == 'DjVuXML' ) {
 266                                                 $image->dejaMetaTree = $b;
 267                                         }
 268                                 }
 269                         } else {
 270                                 $image->dejaMetaTree = $tree;
 271                         }
 272                 } catch ( Exception $e ) {
 273                         wfDebug( "Bogus multipage XML metadata on '{$image->getName()}'\n" );
 274                 }
 275                 wfRestoreWarnings();
 276                 wfProfileOut( __METHOD__ );
 277                 if ( $gettext ) {
 278                         return $image->djvuTextTree;
 279                 } else {
 280                         return $image->dejaMetaTree;
 281                 }
 282         }
 283
 284         /**
 285          * @param File $image
 286          * @param string $path
 287          * @return bool|array False on failure
 288          */
 289         function getImageSize( $image, $path ) {
 290                 return $this->getDjVuImage( $image, $path )->getImageSize();
 291         }
 292
 293         function getThumbType( $ext, $mime, $params = null ) {
 294                 global $wgDjvuOutputExtension;
 295                 static $mime;
 296                 if ( !isset( $mime ) ) {
 297                         $magic = MimeMagic::singleton();
 298                         $mime = $magic->guessTypesForExtension( $wgDjvuOutputExtension );
 299                 }
 300
 301                 return array( $wgDjvuOutputExtension, $mime );
 302         }
 303
 304         function getMetadata( $image, $path ) {
 305                 wfDebug( "Getting DjVu metadata for $path\n" );
 306
 307                 return $this->getDjVuImage( $image, $path )->retrieveMetaData();
 308         }
 309
 310         function getMetadataType( $image ) {
 311                 return 'djvuxml';
 312         }
 313
 314         function isMetadataValid( $image, $metadata ) {
 315                 return !empty( $metadata ) && $metadata != serialize( array() );
 316         }
 317
 318         function pageCount( $image ) {
 319                 $tree = $this->getMetaTree( $image );
 320                 if ( !$tree ) {
 321                         return false;
 322                 }
 323
 324                 return count( $tree->xpath( '//OBJECT' ) );
 325         }
 326
 327         function getPageDimensions( $image, $page ) {
 328                 $tree = $this->getMetaTree( $image );
 329                 if ( !$tree ) {
 330                         return false;
 331                 }
 332
 333                 $o = $tree->BODY[0]->OBJECT[$page - 1];
 334                 if ( $o ) {
 335                         return array(
 336                                 'width' => intval( $o['width'] ),
 337                                 'height' => intval( $o['height'] )
 338                         );
 339                 } else {
 340                         return false;
 341                 }
 342         }
 343
 344         /**
 345          * @param File $image
 346          * @param int $page Page number to get information for
 347          * @return bool|string Page text or false when no text found.
 348          */
 349         function getPageText( $image, $page ) {
 350                 $tree = $this->getMetaTree( $image, true );
 351                 if ( !$tree ) {
 352                         return false;
 353                 }
 354
 355                 $o = $tree->BODY[0]->PAGE[$page - 1];
 356                 if ( $o ) {
 357                         $txt = $o['value'];
 358
 359                         return $txt;
 360                 } else {
 361                         return false;
 362                 }
 363         }
 364 }