3 * Handler for DjVu images.
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.
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.
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
25 * Handler for DjVu images
29 class DjVuHandler
extends ImageHandler
{
33 function isEnabled() {
34 global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML;
35 if ( !$wgDjvuRenderer ||
( !$wgDjvuDump && !$wgDjvuToXML ) ) {
36 wfDebug( "DjVu is disabled, please set \$wgDjvuRenderer and \$wgDjvuDump\n" );
48 function mustRender( $file ) {
56 function isMultiPage( $file ) {
63 function getParamMap() {
65 'img_width' => 'width',
75 function validateParam( $name, $value ) {
76 if ( $name === 'page' && trim( $value ) !== (string)intval( $value ) ) {
77 // Extra junk on the end of page, probably actually a caption
78 // e.g. [[File:Foo.djvu|thumb|Page 3 of the document shows foo]]
81 if ( in_array( $name, array( 'width', 'height', 'page' ) ) ) {
93 * @param array $params
96 function makeParamString( $params ) {
97 $page = isset( $params['page'] ) ?
$params['page'] : 1;
98 if ( !isset( $params['width'] ) ) {
102 return "page{$page}-{$params['width']}px";
109 function parseParamString( $str ) {
111 if ( preg_match( '/^page(\d+)-(\d+)px$/', $str, $m ) ) {
112 return array( 'width' => $m[2], 'page' => $m[1] );
119 * @param array $params
122 function getScriptParams( $params ) {
124 'width' => $params['width'],
125 'page' => $params['page'],
131 * @param string $dstPath
132 * @param string $dstUrl
133 * @param array $params
135 * @return MediaTransformError|ThumbnailImage|TransformParameterError
137 function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
138 global $wgDjvuRenderer, $wgDjvuPostProcessor;
140 if ( !$this->normaliseParams( $image, $params ) ) {
141 return new TransformParameterError( $params );
143 $width = $params['width'];
144 $height = $params['height'];
145 $page = $params['page'];
147 if ( $flags & self
::TRANSFORM_LATER
) {
154 return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
157 if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__
) ) {
158 return new MediaTransformError(
162 wfMessage( 'thumbnail_dest_directory' )->text()
166 // Get local copy source for shell scripts
167 // Thumbnail extraction is very inefficient for large files.
168 // Provide a way to pool count limit the number of downloaders.
169 if ( $image->getSize() >= 1e7
) { // 10MB
170 $work = new PoolCounterWorkViaCallback( 'GetLocalFileCopy', sha1( $image->getName() ),
172 'doWork' => function () use ( $image ) {
173 return $image->getLocalRefPath();
177 $srcPath = $work->execute();
179 $srcPath = $image->getLocalRefPath();
182 if ( $srcPath === false ) { // Failed to get local copy
183 wfDebugLog( 'thumbnail',
184 sprintf( 'Thumbnail failed on %s: could not get local copy of "%s"',
185 wfHostname(), $image->getName() ) );
187 return new MediaTransformError( 'thumbnail_error',
188 $params['width'], $params['height'],
189 wfMessage( 'filemissing' )->text()
193 # Use a subshell (brackets) to aggregate stderr from both pipeline commands
194 # before redirecting it to the overall stdout. This works in both Linux and Windows XP.
195 $cmd = '(' . wfEscapeShellArg(
199 "-size={$params['physicalWidth']}x{$params['physicalHeight']}",
201 if ( $wgDjvuPostProcessor ) {
202 $cmd .= " | {$wgDjvuPostProcessor}";
204 $cmd .= ' > ' . wfEscapeShellArg( $dstPath ) . ') 2>&1';
205 wfDebug( __METHOD__
. ": $cmd\n" );
207 $err = wfShellExec( $cmd, $retval );
209 $removed = $this->removeBadFile( $dstPath, $retval );
210 if ( $retval != 0 ||
$removed ) {
211 $this->logErrorForExternalProcess( $retval, $err, $cmd );
212 return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
220 return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
225 * Cache an instance of DjVuImage in an Image object, return that instance
228 * @param string $path
231 function getDjVuImage( $image, $path ) {
233 $deja = new DjVuImage( $path );
234 } elseif ( !isset( $image->dejaImage
) ) {
235 $deja = $image->dejaImage
= new DjVuImage( $path );
237 $deja = $image->dejaImage
;
244 * Get metadata, unserializing it if neccessary.
246 * @param File $file The DjVu file in question
247 * @return string XML metadata as a string.
248 * @throws MWException
250 private function getUnserializedMetadata( File
$file ) {
251 $metadata = $file->getMetadata();
252 if ( substr( $metadata, 0, 3 ) === '<?xml' ) {
253 // Old style. Not serialized but instead just a raw string of XML.
257 wfSuppressWarnings();
258 $unser = unserialize( $metadata );
260 if ( is_array( $unser ) ) {
261 if ( isset( $unser['error'] ) ) {
263 } elseif ( isset( $unser['xml'] ) ) {
264 return $unser['xml'];
266 // Should never ever reach here.
267 throw new MWException( "Error unserializing DjVu metadata." );
271 // unserialize failed. Guess it wasn't really serialized after all,
276 * Cache a document tree for the DjVu XML metadata
278 * @param bool $gettext DOCUMENT (Default: false)
279 * @return bool|SimpleXMLElement
281 function getMetaTree( $image, $gettext = false ) {
282 if ( $gettext && isset( $image->djvuTextTree
) ) {
283 return $image->djvuTextTree
;
285 if ( !$gettext && isset( $image->dejaMetaTree
) ) {
286 return $image->dejaMetaTree
;
289 $metadata = $this->getUnserializedMetadata( $image );
290 if ( !$this->isMetadataValid( $image, $metadata ) ) {
291 wfDebug( "DjVu XML metadata is invalid or missing, should have been fixed in upgradeRow\n" );
296 wfSuppressWarnings();
298 // Set to false rather than null to avoid further attempts
299 $image->dejaMetaTree
= false;
300 $image->djvuTextTree
= false;
301 $tree = new SimpleXMLElement( $metadata );
302 if ( $tree->getName() == 'mw-djvu' ) {
303 /** @var SimpleXMLElement $b */
304 foreach ( $tree->children() as $b ) {
305 if ( $b->getName() == 'DjVuTxt' ) {
306 // @todo File::djvuTextTree and File::dejaMetaTree are declared
307 // dynamically. Add a public File::$data to facilitate this?
308 $image->djvuTextTree
= $b;
309 } elseif ( $b->getName() == 'DjVuXML' ) {
310 $image->dejaMetaTree
= $b;
314 $image->dejaMetaTree
= $tree;
316 } catch ( Exception
$e ) {
317 wfDebug( "Bogus multipage XML metadata on '{$image->getName()}'\n" );
321 return $image->djvuTextTree
;
323 return $image->dejaMetaTree
;
329 * @param string $path
330 * @return bool|array False on failure
332 function getImageSize( $image, $path ) {
333 return $this->getDjVuImage( $image, $path )->getImageSize();
336 function getThumbType( $ext, $mime, $params = null ) {
337 global $wgDjvuOutputExtension;
339 if ( !isset( $mime ) ) {
340 $magic = MimeMagic
::singleton();
341 $mime = $magic->guessTypesForExtension( $wgDjvuOutputExtension );
344 return array( $wgDjvuOutputExtension, $mime );
347 function getMetadata( $image, $path ) {
348 wfDebug( "Getting DjVu metadata for $path\n" );
350 $xml = $this->getDjVuImage( $image, $path )->retrieveMetaData();
351 if ( $xml === false ) {
352 // Special value so that we don't repetitively try and decode a broken file.
353 return serialize( array( 'error' => 'Error extracting metadata' ) );
355 return serialize( array( 'xml' => $xml ) );
359 function getMetadataType( $image ) {
363 function isMetadataValid( $image, $metadata ) {
364 return !empty( $metadata ) && $metadata != serialize( array() );
367 function pageCount( $image ) {
368 $tree = $this->getMetaTree( $image );
373 return count( $tree->xpath( '//OBJECT' ) );
376 function getPageDimensions( $image, $page ) {
377 $tree = $this->getMetaTree( $image );
382 $o = $tree->BODY
[0]->OBJECT[$page - 1];
385 'width' => intval( $o['width'] ),
386 'height' => intval( $o['height'] )
395 * @param int $page Page number to get information for
396 * @return bool|string Page text or false when no text found.
398 function getPageText( $image, $page ) {
399 $tree = $this->getMetaTree( $image, true );
404 $o = $tree->BODY
[0]->PAGE
[$page - 1];