Accessor for LinksUpdate's parser output

[lhc/web/wiklou.git] / includes / media / DjVu.php

diff --git a/includes/media/DjVu.php b/includes/media/DjVu.php
index 66e954d..6e6505c 100644 (file)
--- a/includes/media/DjVu.php
+++ b/includes/media/DjVu.php
@@ -1,13 +1,21 @@
 <?php
 /**
+ * Handler for DjVu images
+ *
  * @file
  * @ingroup Media
  */
- 
+
 /**
+ * Handler for DjVu images
+ *
  * @ingroup Media
  */
 class DjVuHandler extends ImageHandler {
+
+       /**
+        * @return bool
+        */
        function isEnabled() {
                global $wgDjvuRenderer, $wgDjvuDump, $wgDjvuToXML;
                if ( !$wgDjvuRenderer || ( !$wgDjvuDump && !$wgDjvuToXML ) ) {
@@ -18,9 +26,25 @@ class DjVuHandler extends ImageHandler {
                }
        }
 
-       function mustRender( $file ) { return true; }
-       function isMultiPage( $file ) { return true; }
+       /**
+        * @param $file
+        * @return bool
+        */
+       function mustRender( $file ) {
+               return true;
+       }
+
+       /**
+        * @param $file
+        * @return bool
+        */
+       function isMultiPage( $file ) {
+               return true;
+       }
 
+       /**
+        * @return array
+        */
        function getParamMap() {
                return array(
                        'img_width' => 'width',
@@ -28,6 +52,11 @@ class DjVuHandler extends ImageHandler {
                );
        }
 
+       /**
+        * @param $name
+        * @param $value
+        * @return bool
+        */
        function validateParam( $name, $value ) {
                if ( in_array( $name, array( 'width', 'height', 'page' ) ) ) {
                        if ( $value <= 0 ) {
@@ -40,6 +69,10 @@ class DjVuHandler extends ImageHandler {
                }
        }
 
+       /**
+        * @param $params
+        * @return bool|string
+        */
        function makeParamString( $params ) {
                $page = isset( $params['page'] ) ? $params['page'] : 1;
                if ( !isset( $params['width'] ) ) {
@@ -48,6 +81,10 @@ class DjVuHandler extends ImageHandler {
                return "page{$page}-{$params['width']}px";
        }
 
+       /**
+        * @param $str
+        * @return array|bool
+        */
        function parseParamString( $str ) {
                $m = false;
                if ( preg_match( '/^page(\d+)-(\d+)px$/', $str, $m ) ) {
@@ -57,6 +94,10 @@ class DjVuHandler extends ImageHandler {
                }
        }
 
+       /**
+        * @param $params
+        * @return array
+        */
        function getScriptParams( $params ) {
                return array(
                        'width' => $params['width'],
@@ -64,6 +105,14 @@ class DjVuHandler extends ImageHandler {
                );
        }
 
+       /**
+        * @param $image File
+        * @param  $dstPath
+        * @param  $dstUrl
+        * @param  $params
+        * @param int $flags
+        * @return MediaTransformError|ThumbnailImage|TransformParameterError
+        */
        function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
                global $wgDjvuRenderer, $wgDjvuPostProcessor;
 
@@ -71,7 +120,9 @@ class DjVuHandler extends ImageHandler {
                // normaliseParams will inevitably give.
                $xml = $image->getMetadata();
                if ( !$xml ) {
-                       return new MediaTransformError( 'thumbnail_error', @$params['width'], @$params['height'],
+                       $width = isset( $params['width'] ) ? $params['width'] : 0;
+                       $height = isset( $params['height'] ) ? $params['height'] : 0;
+                       return new MediaTransformError( 'thumbnail_error', $width, $height,
                                wfMsg( 'djvu_no_xml' ) );
                }
 
@@ -80,7 +131,7 @@ class DjVuHandler extends ImageHandler {
                }
                $width = $params['width'];
                $height = $params['height'];
-               $srcPath = $image->getPath();
+               $srcPath = $image->getLocalRefPath();
                $page = $params['page'];
                if ( $page > $this->pageCount( $image ) ) {
                        return new MediaTransformError( 'thumbnail_error', $width, $height, wfMsg( 'djvu_page_error' ) );
@@ -90,13 +141,14 @@ class DjVuHandler extends ImageHandler {
                        return new ThumbnailImage( $image, $dstUrl, $width, $height, $dstPath, $page );
                }
 
-               if ( !wfMkdirParents( dirname( $dstPath ) ) ) {
+               if ( !wfMkdirParents( dirname( $dstPath ), null, __METHOD__ ) ) {
                        return new MediaTransformError( 'thumbnail_error', $width, $height, wfMsg( 'thumbnail_dest_directory' ) );
                }
 
                # Use a subshell (brackets) to aggregate stderr from both pipeline commands
                # before redirecting it to the overall stdout. This works in both Linux and Windows XP.
-               $cmd = '(' . wfEscapeShellArg( $wgDjvuRenderer ) . " -format=ppm -page={$page} -size={$width}x{$height} " .
+               $cmd = '(' . wfEscapeShellArg( $wgDjvuRenderer ) . " -format=ppm -page={$page}" .
+                       " -size={$params['physicalWidth']}x{$params['physicalHeight']} " .
                        wfEscapeShellArg( $srcPath );
                if ( $wgDjvuPostProcessor ) {
                        $cmd .= " | {$wgDjvuPostProcessor}";
@@ -104,6 +156,7 @@ class DjVuHandler extends ImageHandler {
                $cmd .= ' > ' . wfEscapeShellArg($dstPath) . ') 2>&1';
                wfProfileIn( 'ddjvu' );
                wfDebug( __METHOD__.": $cmd\n" );
+               $retval = '';
                $err = wfShellExec( $cmd, $retval );
                wfProfileOut( 'ddjvu' );
 
@@ -120,6 +173,8 @@ class DjVuHandler extends ImageHandler {
 
        /**
         * Cache an instance of DjVuImage in an Image object, return that instance
+        *
+        * @return DjVuImage
         */
        function getDjVuImage( $image, $path ) {
                if ( !$image ) {
@@ -134,8 +189,9 @@ class DjVuHandler extends ImageHandler {
 
        /**
         * Cache a document tree for the DjVu XML metadata
+        * @param $image File
         */
-       function getMetaTree( $image ) {
+       function getMetaTree( $image , $gettext = false ) {
                if ( isset( $image->dejaMetaTree ) ) {
                        return $image->dejaMetaTree;
                }
@@ -149,22 +205,39 @@ class DjVuHandler extends ImageHandler {
 
                wfSuppressWarnings();
                try {
-                       $image->dejaMetaTree = new SimpleXMLElement( $metadata );
-               } catch( Exception $e ) {
-                       wfDebug( "Bogus multipage XML metadata on '$image->name'\n" );
                        // Set to false rather than null to avoid further attempts
                        $image->dejaMetaTree = false;
+                       $image->djvuTextTree = false;
+                       $tree = new SimpleXMLElement( $metadata );
+                       if( $tree->getName() == 'mw-djvu' ) {
+                               foreach($tree->children() as $b){
+                                       if( $b->getName() == 'DjVuTxt' ) {
+                                               $image->djvuTextTree = $b;
+                                       }
+                                       elseif ( $b->getName() == 'DjVuXML' ) {
+                                               $image->dejaMetaTree = $b;
+                                       }
+                               }
+                       } else {
+                               $image->dejaMetaTree = $tree;
+                       }
+               } catch( Exception $e ) {
+                       wfDebug( "Bogus multipage XML metadata on '{$image->getName()}'\n" );
                }
                wfRestoreWarnings();
                wfProfileOut( __METHOD__ );
-               return $image->dejaMetaTree;
+               if( $gettext ) {
+                       return $image->djvuTextTree;
+               } else {
+                       return $image->dejaMetaTree;
+               }
        }
 
        function getImageSize( $image, $path ) {
                return $this->getDjVuImage( $image, $path )->getImageSize();
        }
 
-       function getThumbType( $ext, $mime ) {
+       function getThumbType( $ext, $mime, $params = null ) {
                global $wgDjvuOutputExtension;
                static $mime;
                if ( !isset( $mime ) ) {
@@ -211,4 +284,21 @@ class DjVuHandler extends ImageHandler {
                        return false;
                }
        }
+
+       function getPageText( $image, $page ){
+               $tree = $this->getMetaTree( $image, true );
+               if ( !$tree ) {
+                       return false;
+               }
+
+               $o = $tree->BODY[0]->PAGE[$page-1];
+               if ( $o ) {
+                       $txt = $o['value'];
+                       return $txt;
+               } else {
+                       return false;
+               }
+
+       }
+
 }