* Image:Foo.jpg | 100px | picture of a foo
*
* rect 0 0 50 50 [[Foo type A]]
* circle 50 50 20 [[Foo type B]]
*
* desc bottom-left
*
*
* Coordinates are relative to the source image, not the thumbnail.
*/
namespace MediaWiki\Extension\ImageMap;
use ConfigFactory;
use DOMDocument;
use DOMElement;
use DOMXPath;
use MediaWiki\MediaWikiServices;
use OutputPage;
use Parser;
use Sanitizer;
use Title;
use Wikimedia\AtEase\AtEase;
use Xml;
class ImageMap {
private const TOP_RIGHT = 0;
private const BOTTOM_RIGHT = 1;
private const BOTTOM_LEFT = 2;
private const TOP_LEFT = 3;
private const NONE = 4;
/**
* @param Parser $parser
*/
public static function onParserFirstCallInit( Parser $parser ) {
$parser->setHook( 'imagemap', [ self::class, 'render' ] );
}
/**
* @param string $input
* @param array $params
* @param Parser $parser
* @return string HTML (Image map, or error message)
*/
public static function render( $input, $params, Parser $parser ) {
global $wgUrlProtocols, $wgNoFollowLinks;
$config = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
$enableLegacyMediaDOM = $config->get( 'ParserEnableLegacyMediaDOM' );
$lines = explode( "\n", $input );
$first = true;
$scale = 1;
$imageNode = null;
$domDoc = null;
$thumbWidth = 0;
$thumbHeight = 0;
$imageTitle = null;
$mapHTML = '';
$links = [];
$explicitNone = false;
// Define canonical desc types to allow i18n of 'imagemap_desc_types'
$descTypesCanonical = 'top-right, bottom-right, bottom-left, top-left, none';
$descType = self::BOTTOM_RIGHT;
$defaultLinkAttribs = false;
$realmap = true;
$extLinks = [];
$services = MediaWikiServices::getInstance();
$repoGroup = $services->getRepoGroup();
$badFileLookup = $services->getBadFileLookup();
foreach ( $lines as $lineNum => $line ) {
$lineNum++;
$externLink = false;
$line = trim( $line );
if ( $line === '' || $line[0] === '#' ) {
continue;
}
if ( $first ) {
$first = false;
// The first line should have an image specification on it
// Extract it and render the HTML
$bits = explode( '|', $line, 2 );
$image = $bits[0];
$options = $bits[1] ?? '';
$imageTitle = Title::newFromText( $image );
if ( !$imageTitle || !$imageTitle->inNamespace( NS_FILE ) ) {
return self::error( 'imagemap_no_image' );
}
if ( $badFileLookup->isBadFile( $imageTitle->getDBkey(), $parser->getTitle() ) ) {
return self::error( 'imagemap_bad_image' );
}
// Parse the options so we can use links and the like in the caption
$parsedOptions = $options === '' ? '' : $parser->recursiveTagParse( $options );
if ( !$enableLegacyMediaDOM ) {
$explicitNone = preg_match( '/(^|\|)none(\||$)/D', $parsedOptions );
if ( !$explicitNone ) {
$parsedOptions .= '|none';
}
}
$imageHTML = $parser->makeImage( $imageTitle, $parsedOptions );
$parser->replaceLinkHolders( $imageHTML );
$imageHTML = $parser->getStripState()->unstripBoth( $imageHTML );
$imageHTML = Sanitizer::normalizeCharReferences( $imageHTML );
$domDoc = new DOMDocument();
AtEase::suppressWarnings();
$ok = $domDoc->loadXML( $imageHTML );
AtEase::restoreWarnings();
if ( !$ok ) {
return self::error( 'imagemap_invalid_image' );
}
$xpath = new DOMXPath( $domDoc );
$imgs = $xpath->query( '//img' );
if ( !$imgs->length ) {
return self::error( 'imagemap_invalid_image' );
}
$imageNode = $imgs->item( 0 );
$thumbWidth = $imageNode->getAttribute( 'width' );
$thumbHeight = $imageNode->getAttribute( 'height' );
$imageObj = $repoGroup->findFile( $imageTitle );
if ( !$imageObj || !$imageObj->exists() ) {
return self::error( 'imagemap_invalid_image' );
}
// Add the linear dimensions to avoid inaccuracy in the scale
// factor when one is much larger than the other
// (sx+sy)/(x+y) = s
$denominator = $imageObj->getWidth() + $imageObj->getHeight();
$numerator = $thumbWidth + $thumbHeight;
if ( $denominator <= 0 || $numerator <= 0 ) {
return self::error( 'imagemap_invalid_image' );
}
$scale = $numerator / $denominator;
continue;
}
// Handle desc spec
$cmd = strtok( $line, " \t" );
if ( $cmd === 'desc' ) {
$typesText = wfMessage( 'imagemap_desc_types' )->inContentLanguage()->text();
if ( $descTypesCanonical !== $typesText ) {
// i18n desc types exists
$typesText = $descTypesCanonical . ', ' . $typesText;
}
$types = array_map( 'trim', explode( ',', $typesText ) );
$type = trim( strtok( '' ) ?: '' );
$descType = array_search( $type, $types );
if ( $descType > 4 ) {
// A localized descType is used. Subtract 5 to reach the canonical desc type.
$descType -= 5;
}
// <0? In theory never, but paranoia...
if ( $descType === false || $descType < 0 ) {
return self::error( 'imagemap_invalid_desc', $typesText );
}
continue;
}
$title = false;
$alt = '';
// Find the link
$link = trim( strstr( $line, '[' ) );
$m = [];
if ( preg_match( '/^ \[\[ ([^|]*+) \| ([^\]]*+) \]\] \w* $ /x', $link, $m ) ) {
$title = Title::newFromText( $m[1] );
$alt = trim( $m[2] );
} elseif ( preg_match( '/^ \[\[ ([^\]]*+) \]\] \w* $ /x', $link, $m ) ) {
$title = Title::newFromText( $m[1] );
if ( $title === null ) {
return self::error( 'imagemap_invalid_title', $lineNum );
}
$alt = $title->getFullText();
} elseif ( in_array( substr( $link, 1, strpos( $link, '//' ) + 1 ), $wgUrlProtocols )
|| in_array( substr( $link, 1, strpos( $link, ':' ) ), $wgUrlProtocols )
) {
if ( preg_match( '/^ \[ ([^\s]*+) \s ([^\]]*+) \] \w* $ /x', $link, $m ) ) {
$title = $m[1];
$alt = trim( $m[2] );
$externLink = true;
} elseif ( preg_match( '/^ \[ ([^\]]*+) \] \w* $ /x', $link, $m ) ) {
$title = $alt = trim( $m[1] );
$externLink = true;
}
} else {
return self::error( 'imagemap_no_link', $lineNum );
}
if ( !$title ) {
return self::error( 'imagemap_invalid_title', $lineNum );
}
$shapeSpec = substr( $line, 0, -strlen( $link ) );
// Tokenize shape spec
$shape = strtok( $shapeSpec, " \t" );
switch ( $shape ) {
case 'default':
$coords = [];
break;
case 'rect':
$coords = self::tokenizeCoords( $lineNum, 4 );
if ( !is_array( $coords ) ) {
return $coords;
}
break;
case 'circle':
$coords = self::tokenizeCoords( $lineNum, 3 );
if ( !is_array( $coords ) ) {
return $coords;
}
break;
case 'poly':
$coords = self::tokenizeCoords( $lineNum, 1, true );
if ( !is_array( $coords ) ) {
return $coords;
}
if ( count( $coords ) % 2 !== 0 ) {
return self::error( 'imagemap_poly_odd', $lineNum );
}
break;
default:
return self::error( 'imagemap_unrecognised_shape', $lineNum );
}
// Scale the coords using the size of the source image
foreach ( $coords as $i => $c ) {
$coords[$i] = (int)round( $c * $scale );
}
// Construct the area tag
$attribs = [];
if ( $externLink ) {
$attribs['href'] = $title;
$attribs['class'] = 'plainlinks';
if ( $wgNoFollowLinks ) {
$attribs['rel'] = 'nofollow';
}
} elseif ( $title->getFragment() !== '' && $title->getPrefixedDBkey() === '' ) {
// XXX: kluge to handle [[#Fragment]] links, should really fix getLocalURL()
// in Title.php to return an empty string in this case
$attribs['href'] = $title->getFragmentForURL();
} else {
$attribs['href'] = $title->getLocalURL() . $title->getFragmentForURL();
}
if ( $shape !== 'default' ) {
$attribs['shape'] = $shape;
}
if ( $coords ) {
$attribs['coords'] = implode( ',', $coords );
}
if ( $alt !== '' ) {
if ( $shape !== 'default' ) {
$attribs['alt'] = $alt;
}
$attribs['title'] = $alt;
}
if ( $shape === 'default' ) {
$defaultLinkAttribs = $attribs;
} else {
// @phan-suppress-next-line SecurityCheck-DoubleEscaped
$mapHTML .= Xml::element( 'area', $attribs ) . "\n";
}
if ( $externLink ) {
$extLinks[] = $title;
} else {
$links[] = $title;
}
}
if ( $first || !$imageNode || !$domDoc ) {
return self::error( 'imagemap_no_image' );
}
if ( $mapHTML === '' ) {
// no areas defined, default only. It's not a real imagemap, so we do not need some tags
$realmap = false;
}
if ( $realmap ) {
// Construct the map
// Add a hash of the map HTML to avoid breaking cached HTML fragments that are
// later joined together on the one page (T18471).
// The only way these hashes can clash is if the map is identical, in which
// case it wouldn't matter that the "wrong" map was used.
$mapName = 'ImageMap_' . substr( md5( $mapHTML ), 0, 16 );
$mapHTML = "\n";
// Alter the image tag
$imageNode->setAttribute( 'usemap', "#$mapName" );
}
if ( $mapHTML !== '' ) {
$mapDoc = new DOMDocument();
$mapDoc->loadXML( $mapHTML );
$mapNode = $domDoc->importNode( $mapDoc->documentElement, true );
}
$div = null;
if ( $enableLegacyMediaDOM ) {
// Add a surrounding div, remove the default link to the description page
$anchor = $imageNode->parentNode;
$parent = $anchor->parentNode;
// Handle cases where there are no anchors, like `|link=`
if ( $anchor instanceof DOMDocument ) {
$parent = $anchor;
$anchor = $imageNode;
}
$div = $parent->insertBefore( new DOMElement( 'div' ), $anchor );
$div->setAttribute( 'class', 'noresize' );
if ( $defaultLinkAttribs ) {
$defaultAnchor = $div->appendChild( new DOMElement( 'a' ) );
foreach ( $defaultLinkAttribs as $name => $value ) {
$defaultAnchor->setAttribute( $name, $value );
}
$imageParent = $defaultAnchor;
} else {
$imageParent = $div;
}
// Add the map HTML to the div
// We used to add it before the div, but that made tidy unhappy
if ( isset( $mapNode ) ) {
$div->appendChild( $mapNode );
}
$imageParent->appendChild( $imageNode->cloneNode( true ) );
$parent->removeChild( $anchor );
} else {
$anchor = $imageNode->parentNode;
$wrapper = $anchor->parentNode;
$classes = $wrapper->getAttribute( 'class' );
// For T22030
$classes .= ( $classes ? ' ' : '' ) . 'noresize';
// Remove that class if it was only added while forcing a block
if ( !$explicitNone ) {
$classes = trim( preg_replace( '/ ?mw-halign-none/', '', $classes ) );
}
$wrapper->setAttribute( 'class', $classes );
if ( $defaultLinkAttribs ) {
$imageParent = $wrapper->ownerDocument->createElement( 'a' );
foreach ( $defaultLinkAttribs as $name => $value ) {
$imageParent->setAttribute( $name, $value );
}
} else {
$imageParent = new DOMElement( 'span' );
}
$wrapper->insertBefore( $imageParent, $anchor );
if ( isset( $mapNode ) ) {
$wrapper->insertBefore( $mapNode, $anchor );
}
$imageParent->appendChild( $imageNode->cloneNode( true ) );
$wrapper->removeChild( $anchor );
}
// Determine whether a "magnify" link is present
$xpath = new DOMXPath( $domDoc );
$magnify = $xpath->query( '//div[@class="magnify"]' );
if ( $enableLegacyMediaDOM && !$magnify->length && $descType !== self::NONE ) {
// Add image description link
if ( $descType === self::TOP_LEFT || $descType === self::BOTTOM_LEFT ) {
$marginLeft = 0;
} else {
$marginLeft = $thumbWidth - 20;
}
if ( $descType === self::TOP_LEFT || $descType === self::TOP_RIGHT ) {
$marginTop = -$thumbHeight;
// 1px hack for IE, to stop it poking out the top
$marginTop += 1;
} else {
$marginTop = -20;
}
$div->setAttribute( 'style', "height: {$thumbHeight}px; width: {$thumbWidth}px; " );
$descWrapper = $div->appendChild( new DOMElement( 'div' ) );
$descWrapper->setAttribute( 'style',
"margin-left: {$marginLeft}px; " .
"margin-top: {$marginTop}px; " .
"text-align: left;"
);
$descAnchor = $descWrapper->appendChild( new DOMElement( 'a' ) );
$descAnchor->setAttribute( 'href', $imageTitle->getLocalURL() );
$descAnchor->setAttribute(
'title',
wfMessage( 'imagemap_description' )->inContentLanguage()->text()
);
$descImg = $descAnchor->appendChild( new DOMElement( 'img' ) );
$descImg->setAttribute(
'alt',
wfMessage( 'imagemap_description' )->inContentLanguage()->text()
);
$url = $config->get( 'ExtensionAssetsPath' ) . '/ImageMap/resources/desc-20.png';
$descImg->setAttribute(
'src',
OutputPage::transformResourcePath( $config, $url )
);
$descImg->setAttribute( 'style', 'border: none;' );
}
// Output the result
// We use saveXML() not saveHTML() because then we get XHTML-compliant output.
// The disadvantage is that we have to strip out the DTD
$output = preg_replace( '/<\?xml[^?]*\?>/', '', $domDoc->saveXML( null, LIBXML_NOEMPTYTAG ) );
// Register links
foreach ( $links as $title ) {
if ( $title->isExternal() || $title->getNamespace() === NS_SPECIAL ) {
// Don't register special or interwiki links...
} elseif ( $title->getNamespace() === NS_MEDIA ) {
// Regular Media: links are recorded as image usages
$parser->getOutput()->addImage( $title->getDBkey() );
} else {
// Plain ol' link
$parser->getOutput()->addLink( $title );
}
}
foreach ( $extLinks as $title ) {
$parser->getOutput()->addExternalLink( $title );
}
// Armour output against broken parser
$output = str_replace( "\n", '', $output );
return $output;
}
/**
* @param int|string $lineNum Line number, for error reporting
* @param int $minCount Minimum token count
* @param bool $allowNegative
* @return array|string String with error (HTML), or array of coordinates
*/
private static function tokenizeCoords( $lineNum, $minCount = 0, $allowNegative = false ) {
$coords = [];
$coord = strtok( " \t" );
while ( $coord !== false ) {
if ( !is_numeric( $coord ) || $coord > 1e9 || ( !$allowNegative && $coord < 0 ) ) {
return self::error( 'imagemap_invalid_coord', $lineNum );
}
$coords[] = $coord;
$coord = strtok( " \t" );
}
if ( count( $coords ) < $minCount ) {
// TODO: Should this also check there aren't too many coords?
return self::error( 'imagemap_missing_coord', $lineNum );
}
return $coords;
}
/**
* @param string $name
* @param string|int|bool $line
* @return string HTML
*/
private static function error( $name, $line = false ) {
return '' . wfMessage( $name, $line )->parse() . '
';
}
}