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
{
34 function isEnabled() {
35 global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML;
36 if ( !$wgDjvuRenderer ||
( !$wgDjvuDump && !$wgDjvuToXML ) ) {
37 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' ) ) ) {
91 function makeParamString( $params ) {
92 $page = isset( $params['page'] ) ?
$params['page'] : 1;
93 if ( !isset( $params['width'] ) ) {
96 return "page{$page}-{$params['width']}px";
103 function parseParamString( $str ) {
105 if ( preg_match( '/^page(\d+)-(\d+)px$/', $str, $m ) ) {
106 return array( 'width' => $m[2], 'page' => $m[1] );
116 function getScriptParams( $params ) {
118 'width' => $params['width'],
119 'page' => $params['page'],
129 * @return MediaTransformError|ThumbnailImage|TransformParameterError
131 function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
132 global $wgDjvuRenderer, $wgDjvuPostProcessor;
134 // Fetch XML and check it, to give a more informative error message than the one which
135 // normaliseParams will inevitably give.
136 $xml = $image->getMetadata();
138 $width = isset( $params['width'] ) ?
$params['width'] : 0;
139 $height = isset( $params['height'] ) ?
$params['height'] : 0;
140 return new MediaTransformError( 'thumbnail_error', $width, $height,
141 wfMessage( 'djvu_no_xml' )->text() );
144 if ( !$this->normaliseParams( $image, $params ) ) {
145 return new TransformParameterError( $params );
147 $width = $params['width'];
148 $height = $params['height'];
149 $page = $params['page'];
150 if ( $page > $this->pageCount( $image ) ) {
151 return new MediaTransformError(
155 wfMessage( 'djvu_page_error' )->text()
159 if ( $flags & self
::TRANSFORM_LATER
) {
160 return new ThumbnailImage( $image, $dstUrl, $width, $height, $dstPath, $page );
163 if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__
) ) {
164 return new MediaTransformError(
168 wfMessage( 'thumbnail_dest_directory' )->text()
172 $srcPath = $image->getLocalRefPath();
173 # Use a subshell (brackets) to aggregate stderr from both pipeline commands
174 # before redirecting it to the overall stdout. This works in both Linux and Windows XP.
175 $cmd = '(' . wfEscapeShellArg( $wgDjvuRenderer ) . " -format=ppm -page={$page}" .
176 " -size={$params['physicalWidth']}x{$params['physicalHeight']} " .
177 wfEscapeShellArg( $srcPath );
178 if ( $wgDjvuPostProcessor ) {
179 $cmd .= " | {$wgDjvuPostProcessor}";
181 $cmd .= ' > ' . wfEscapeShellArg($dstPath) . ') 2>&1';
182 wfProfileIn( 'ddjvu' );
183 wfDebug( __METHOD__
.": $cmd\n" );
185 $err = wfShellExec( $cmd, $retval );
186 wfProfileOut( 'ddjvu' );
188 $removed = $this->removeBadFile( $dstPath, $retval );
189 if ( $retval != 0 ||
$removed ) {
190 wfDebugLog( 'thumbnail',
191 sprintf( 'thumbnail failed on %s: error %d "%s" from "%s"',
192 wfHostname(), $retval, trim($err), $cmd ) );
193 return new MediaTransformError( 'thumbnail_error', $width, $height, $err );
195 return new ThumbnailImage( $image, $dstUrl, $width, $height, $dstPath, $page );
200 * Cache an instance of DjVuImage in an Image object, return that instance
204 function getDjVuImage( $image, $path ) {
206 $deja = new DjVuImage( $path );
207 } elseif ( !isset( $image->dejaImage
) ) {
208 $deja = $image->dejaImage
= new DjVuImage( $path );
210 $deja = $image->dejaImage
;
216 * Cache a document tree for the DjVu XML metadata
218 * @param $gettext Boolean: DOCUMENT (Default: false)
221 function getMetaTree( $image , $gettext = false ) {
222 if ( isset( $image->dejaMetaTree
) ) {
223 return $image->dejaMetaTree
;
226 $metadata = $image->getMetadata();
227 if ( !$this->isMetadataValid( $image, $metadata ) ) {
228 wfDebug( "DjVu XML metadata is invalid or missing, should have been fixed in upgradeRow\n" );
231 wfProfileIn( __METHOD__
);
233 wfSuppressWarnings();
235 // Set to false rather than null to avoid further attempts
236 $image->dejaMetaTree
= false;
237 $image->djvuTextTree
= false;
238 $tree = new SimpleXMLElement( $metadata );
239 if( $tree->getName() == 'mw-djvu' ) {
240 foreach($tree->children() as $b){
241 if( $b->getName() == 'DjVuTxt' ) {
242 $image->djvuTextTree
= $b;
244 elseif ( $b->getName() == 'DjVuXML' ) {
245 $image->dejaMetaTree
= $b;
249 $image->dejaMetaTree
= $tree;
251 } catch( Exception
$e ) {
252 wfDebug( "Bogus multipage XML metadata on '{$image->getName()}'\n" );
255 wfProfileOut( __METHOD__
);
257 return $image->djvuTextTree
;
259 return $image->dejaMetaTree
;
263 function getImageSize( $image, $path ) {
264 return $this->getDjVuImage( $image, $path )->getImageSize();
267 function getThumbType( $ext, $mime, $params = null ) {
268 global $wgDjvuOutputExtension;
270 if ( !isset( $mime ) ) {
271 $magic = MimeMagic
::singleton();
272 $mime = $magic->guessTypesForExtension( $wgDjvuOutputExtension );
274 return array( $wgDjvuOutputExtension, $mime );
277 function getMetadata( $image, $path ) {
278 wfDebug( "Getting DjVu metadata for $path\n" );
279 return $this->getDjVuImage( $image, $path )->retrieveMetaData();
282 function getMetadataType( $image ) {
286 function isMetadataValid( $image, $metadata ) {
287 return !empty( $metadata ) && $metadata != serialize(array());
290 function pageCount( $image ) {
291 $tree = $this->getMetaTree( $image );
295 return count( $tree->xpath( '//OBJECT' ) );
298 function getPageDimensions( $image, $page ) {
299 $tree = $this->getMetaTree( $image );
304 $o = $tree->BODY
[0]->OBJECT[$page-1];
307 'width' => intval( $o['width'] ),
308 'height' => intval( $o['height'] )
315 function getPageText( $image, $page ){
316 $tree = $this->getMetaTree( $image, true );
321 $o = $tree->BODY
[0]->PAGE
[$page-1];