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 ( in_array( $name, array( 'width', 'height', 'page' ) ) ) {
88 * @param array $params
91 function makeParamString( $params ) {
92 $page = isset( $params['page'] ) ?
$params['page'] : 1;
93 if ( !isset( $params['width'] ) ) {
97 return "page{$page}-{$params['width']}px";
104 function parseParamString( $str ) {
106 if ( preg_match( '/^page(\d+)-(\d+)px$/', $str, $m ) ) {
107 return array( 'width' => $m[2], 'page' => $m[1] );
114 * @param array $params
117 function getScriptParams( $params ) {
119 'width' => $params['width'],
120 'page' => $params['page'],
126 * @param string $dstPath
127 * @param string $dstUrl
128 * @param array $params
130 * @return MediaTransformError|ThumbnailImage|TransformParameterError
132 function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
133 global $wgDjvuRenderer, $wgDjvuPostProcessor;
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();
139 $width = isset( $params['width'] ) ?
$params['width'] : 0;
140 $height = isset( $params['height'] ) ?
$params['height'] : 0;
142 return new MediaTransformError( 'thumbnail_error', $width, $height,
143 wfMessage( 'djvu_no_xml' )->text() );
146 if ( !$this->normaliseParams( $image, $params ) ) {
147 return new TransformParameterError( $params );
149 $width = $params['width'];
150 $height = $params['height'];
151 $page = $params['page'];
152 if ( $page > $this->pageCount( $image ) ) {
153 return new MediaTransformError(
157 wfMessage( 'djvu_page_error' )->text()
161 if ( $flags & self
::TRANSFORM_LATER
) {
168 return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
171 if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__
) ) {
172 return new MediaTransformError(
176 wfMessage( 'thumbnail_dest_directory' )->text()
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(
187 "-size={$params['physicalWidth']}x{$params['physicalHeight']}",
189 if ( $wgDjvuPostProcessor ) {
190 $cmd .= " | {$wgDjvuPostProcessor}";
192 $cmd .= ' > ' . wfEscapeShellArg( $dstPath ) . ') 2>&1';
193 wfProfileIn( 'ddjvu' );
194 wfDebug( __METHOD__
. ": $cmd\n" );
196 $err = wfShellExec( $cmd, $retval );
197 wfProfileOut( 'ddjvu' );
199 $removed = $this->removeBadFile( $dstPath, $retval );
200 if ( $retval != 0 ||
$removed ) {
201 $this->logErrorForExternalProcess( $retval, $err, $cmd );
202 return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
210 return new ThumbnailImage( $image, $dstUrl, $dstPath, $params );
215 * Cache an instance of DjVuImage in an Image object, return that instance
218 * @param string $path
221 function getDjVuImage( $image, $path ) {
223 $deja = new DjVuImage( $path );
224 } elseif ( !isset( $image->dejaImage
) ) {
225 $deja = $image->dejaImage
= new DjVuImage( $path );
227 $deja = $image->dejaImage
;
234 * Cache a document tree for the DjVu XML metadata
236 * @param bool $gettext DOCUMENT (Default: false)
237 * @return bool|SimpleXMLElement
239 function getMetaTree( $image, $gettext = false ) {
240 if ( $gettext && isset( $image->djvuTextTree
) ) {
241 return $image->djvuTextTree
;
243 if ( !$gettext && isset( $image->dejaMetaTree
) ) {
244 return $image->dejaMetaTree
;
247 $metadata = $image->getMetadata();
248 if ( !$this->isMetadataValid( $image, $metadata ) ) {
249 wfDebug( "DjVu XML metadata is invalid or missing, should have been fixed in upgradeRow\n" );
253 wfProfileIn( __METHOD__
);
255 wfSuppressWarnings();
257 // Set to false rather than null to avoid further attempts
258 $image->dejaMetaTree
= false;
259 $image->djvuTextTree
= false;
260 $tree = new SimpleXMLElement( $metadata );
261 if ( $tree->getName() == 'mw-djvu' ) {
262 /** @var SimpleXMLElement $b */
263 foreach ( $tree->children() as $b ) {
264 if ( $b->getName() == 'DjVuTxt' ) {
265 // @todo File::djvuTextTree and File::dejaMetaTree are declared
266 // dynamically. Add a public File::$data to facilitate this?
267 $image->djvuTextTree
= $b;
268 } elseif ( $b->getName() == 'DjVuXML' ) {
269 $image->dejaMetaTree
= $b;
273 $image->dejaMetaTree
= $tree;
275 } catch ( Exception
$e ) {
276 wfDebug( "Bogus multipage XML metadata on '{$image->getName()}'\n" );
279 wfProfileOut( __METHOD__
);
281 return $image->djvuTextTree
;
283 return $image->dejaMetaTree
;
289 * @param string $path
290 * @return bool|array False on failure
292 function getImageSize( $image, $path ) {
293 return $this->getDjVuImage( $image, $path )->getImageSize();
296 function getThumbType( $ext, $mime, $params = null ) {
297 global $wgDjvuOutputExtension;
299 if ( !isset( $mime ) ) {
300 $magic = MimeMagic
::singleton();
301 $mime = $magic->guessTypesForExtension( $wgDjvuOutputExtension );
304 return array( $wgDjvuOutputExtension, $mime );
307 function getMetadata( $image, $path ) {
308 wfDebug( "Getting DjVu metadata for $path\n" );
310 return $this->getDjVuImage( $image, $path )->retrieveMetaData();
313 function getMetadataType( $image ) {
317 function isMetadataValid( $image, $metadata ) {
318 return !empty( $metadata ) && $metadata != serialize( array() );
321 function pageCount( $image ) {
322 $tree = $this->getMetaTree( $image );
327 return count( $tree->xpath( '//OBJECT' ) );
330 function getPageDimensions( $image, $page ) {
331 $tree = $this->getMetaTree( $image );
336 $o = $tree->BODY
[0]->OBJECT[$page - 1];
339 'width' => intval( $o['width'] ),
340 'height' => intval( $o['height'] )
349 * @param int $page Page number to get information for
350 * @return bool|string Page text or false when no text found.
352 function getPageText( $image, $page ) {
353 $tree = $this->getMetaTree( $image, true );
358 $o = $tree->BODY
[0]->PAGE
[$page - 1];