34 private const EXPENSIVE_SIZE_LIMIT = 10485760;
37 private const STATE_DJVU_IMAGE =
'djvuImage';
38 private const STATE_TEXT_TREE =
'djvuTextTree';
39 private const STATE_META_TREE =
'djvuMetaTree';
40 private const CACHE_VERSION =
'v2';
46 $djvuRenderer = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::DjvuRenderer );
47 $djvuDump = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::DjvuDump );
48 if ( !$djvuRenderer || !$djvuDump ) {
49 wfDebug(
"DjVu is disabled, please set \$wgDjvuRenderer and \$wgDjvuDump" );
70 return $file->getSize() > static::EXPENSIVE_SIZE_LIMIT;
86 'img_width' =>
'width',
97 if ( $name ===
'page' && trim( $value ) !== (
string)intval( $value ) ) {
102 return in_array( $name, [
'width',
'height',
'page' ] ) && $value > 0;
110 $page = $params[
'page'] ?? 1;
111 if ( !isset( $params[
'width'] ) ) {
115 return "page{$page}-{$params['width']}px";
124 if ( preg_match(
'/^page(\d+)-(\d+)px$/', $str, $m ) ) {
125 return [
'width' => $m[2],
'page' => $m[1] ];
136 'width' => $params[
'width'],
137 'page' => $params[
'page'],
149 public function doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 ) {
150 $djvuRenderer = MediaWikiServices::getInstance()->getMainConfig()->get( MainConfigNames::DjvuRenderer );
151 $djvuPostProcessor = MediaWikiServices::getInstance()->getMainConfig()
152 ->get( MainConfigNames::DjvuPostProcessor );
156 $width = $params[
'width'];
157 $height = $params[
'height'];
158 $page = $params[
'page'];
160 if ( $flags & self::TRANSFORM_LATER ) {
182 if ( $image->getSize() >= 1e7 ) {
185 'doWork' =>
static function () use ( $image ) {
186 return $image->getLocalRefPath();
192 $srcPath = $image->getLocalRefPath();
195 if ( $srcPath ===
false ) {
197 sprintf(
'Thumbnail failed on %s: could not get local copy of "%s"',
201 $params[
'width'], $params[
'height'],
206 # Use a subshell (brackets) to aggregate stderr from both pipeline commands
207 # before redirecting it to the overall stdout. This works in both Linux and Windows XP.
208 $cmd =
'(' . Shell::escape(
212 "-size={$params['physicalWidth']}x{$params['physicalHeight']}",
214 if ( $djvuPostProcessor ) {
215 $cmd .=
" | {$djvuPostProcessor}";
217 $cmd .=
' > ' . Shell::escape( $dstPath ) .
') 2>&1';
218 wfDebug( __METHOD__ .
": $cmd" );
223 if ( $retval !== 0 || $removed ) {
244 private function getDjVuImage( $state,
$path ) {
245 $deja = $state->getHandlerState( self::STATE_DJVU_IMAGE );
248 $state->setHandlerState( self::STATE_DJVU_IMAGE, $deja );
260 private function getMetadataInternal(
File $file, $gettext ) {
261 $itemNames = [
'error',
'_error',
'data' ];
263 $itemNames[] =
'text';
265 $unser =
$file->getMetadataItems( $itemNames );
267 if ( isset( $unser[
'error'] ) ) {
270 if ( isset( $unser[
'_error'] ) ) {
283 if ( $gettext && $image->getHandlerState( self::STATE_TEXT_TREE ) ) {
284 return $image->getHandlerState( self::STATE_TEXT_TREE );
286 if ( !$gettext && $image->getHandlerState( self::STATE_META_TREE ) ) {
287 return $image->getHandlerState( self::STATE_META_TREE );
290 $metadata = $this->getMetadataInternal( $image, $gettext );
296 unset( $metadata[
'text'] );
302 $djvuOutputExtension = MediaWikiServices::getInstance()->getMainConfig()
303 ->get( MainConfigNames::DjvuOutputExtension );
305 if ( !isset(
$mime ) ) {
306 $magic = MediaWikiServices::getInstance()->getMimeAnalyzer();
307 $mime = $magic->getMimeTypeFromExtensionOrNull( $djvuOutputExtension );
310 return [ $djvuOutputExtension,
$mime ];
314 wfDebug(
"Getting DjVu metadata for $path" );
316 $djvuImage = $this->getDjVuImage( $state,
$path );
317 $metadata = $djvuImage->retrieveMetaData();
318 if ( $metadata ===
false ) {
320 $metadata = [
'error' =>
'Error extracting metadata' ];
322 return [
'metadata' => $metadata ] + $djvuImage->getImageSize();
337 return $info ? $info[
'pageCount'] :
false;
344 if ( $info && isset( $info[
'dimensionsByPage'][$index] ) ) {
345 return $info[
'dimensionsByPage'][$index];
352 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
353 return $cache->getWithSetCallback(
354 $cache->makeKey(
'file-djvu',
'dimensions', self::CACHE_VERSION,
$file->getSha1() ),
355 $cache::TTL_INDEFINITE,
356 function () use (
$file ) {
360 [
'pcTTL' => $cache::TTL_INDEFINITE ]
375 if ( !isset( $metatree[
'data'] ) || !$metatree[
'data'] ) {
378 foreach ( $metatree[
'data'][
'pages'] as $page ) {
380 $dimsByPage[] =
false;
383 'width' => (int)$page[
'width'],
384 'height' => (
int)$page[
'height'],
389 'pageCount' => count( $metatree[
'data'][
'pages'] ),
390 'dimensionsByPage' => $dimsByPage
404 if ( isset( $tree[
'text'] ) && isset( $tree[
'text'][$page - 1] ) ) {
405 return $tree[
'text'][$page - 1];
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
wfHostname()
Get host name of the current machine, for use in error reporting.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
getDimensionInfoFromMetaTree( $metatree)
Given the metadata, returns dimension information about the document.
makeParamString( $params)
isExpensiveToThumbnail( $file)
True if creating thumbnails from the file is large or otherwise resource-intensive.
validateParam( $name, $value)
getDimensionInfo(File $file)
getScriptParams( $params)
doTransform( $image, $dstPath, $dstUrl, $params, $flags=0)
pageCount(File $image)
Page count for a multi-page document, false if unsupported or unknown.
getPageText(File $image, $page)
isFileMetadataValid( $image)
Check if the metadata is valid for this handler.
getSizeAndMetadata( $state, $path)
Get image size information and metadata array.
getPageDimensions(File $image, $page)
Get an associative array of page dimensions Currently "width" and "height" are understood,...
getMetadataType( $image)
Get a string describing the type of metadata, for display purposes.
getMetaTree( $image, $gettext=false)
Cache a document tree for the DjVu metadata.
getThumbType( $ext, $mime, $params=null)
Get the thumbnail extension and MIME type for a given source MIME type.
useSplitMetadata()
If this returns true, LocalFile may split metadata up and store its constituent items separately.
Support for detecting/validating DjVu image files and getting some basic file metadata (resolution et...
Implements some public methods and some protected utility functions which are required by multiple ch...
Media handler abstract base class for images.
normaliseParams( $image, &$params)
Changes the parameter array as necessary, ready for transformation.Should be idempotent....
A class containing constants representing the names of configuration variables.
Convenience class for dealing with PoolCounter using callbacks.
execute( $skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
Media transform output for images.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
if(!is_readable( $file)) $ext