Files
AnatImageViewer/includes/AnnotationHandler.php
2026-05-22 20:46:59 -07:00

254 lines
9.3 KiB
PHP

<?php
namespace MediaWiki\Extension\AnatImageViewer;
require_once __DIR__ . '/../vendor/autoload.php';
use Devium\Toml\Toml;
use Devium\Toml\TomlError;
use MediaWiki\MediaWikiServices;
use Content;
use Title;
use CodeContentHandler;
use MediaWiki\Content\Renderer\ContentParseParams;
use ParserOutput;
use Html;
use IContextSource;
use MediaWiki\Content\ValidationParams;
use Status;
use UploadFromFile;
class AnnotationHandler extends CodeContentHandler {
private const ANNOT_VERSION = '0.1';
public function __construct(
$modelId = AnnotationContent::MODEL,
$formats = [ CONTENT_FORMAT_TEXT ]
) {
parent::__construct( $modelId, $formats );
}
protected function getContentClass() {
return AnnotationContent::class;
}
/**
* Only allow this content handler to be used in the Module namespace
* @param Title $title
* @return bool
*/
public function canBeUsedOn( Title $title ) {
if ( $title->getNamespace() !== NS_AV_ANNOT ) {
return false;
}
return parent::canBeUsedOn( $title );
}
public function supportsPreloadContent(): bool {
return true;
}
public function serializeContent( Content $content, $format = null ) {
return parent::serializeContent( $content, $format );
}
public function unserializeContent( $text, $format = null ) {
return new AnnotationContent( $text );
}
public function makeEmptyContent() {
return new AnnotationContent( '' );
}
protected function fillParserOutput( Content $content, ContentParseParams $cpoParams, ParserOutput &$output ) {
self::console_log('Fill Parser Output', true);
parent::fillParserOutput( $content, $cpoParams, $output );
try {
$metadata = toml_decode($content->getText(), true);
} catch (TomlError $e) {
$output->addWarningMsg( $e->getMessage() );
$output->setText( 'No image available' );
return;
}
$output->setText( self::buildSvg($metadata) );
}
/**
* Build annotated SVG from TOML metadata
*
* This takes in the metadata text from the file page (or the current editor)
* and produces the html string for the svg with base image and annotations.
*
* @param string $metadata The metadata object parsed from the text
* @return string Html string of the complete svg
*/
private function buildSvg($metadata) {
//Set SVG UID-ish for element IDs
$svgID = bin2hex(random_bytes(6));
//Check if the image to annotate has been set
if (isset($metadata['baseImage'])) {
$imageTitle = Title::makeTitleSafe( NS_FILE, $metadata['baseImage'] );
$baseImage = MediaWikiServices::getInstance()->getRepoGroup()->findFile($imageTitle);
} else {
$baseImage = false;
}
//Gather basic data
$elBaseImg = '';
$vbHeight = 100;
$vbWidth = 100;
if ($baseImage) {
$baseImageUrl = $baseImage->getFullUrl();
$baseHeight = $baseImage->getHeight();
$baseWidth = $baseImage->getWidth();
$baseAspect = $baseHeight / $baseWidth;
$vbWidth = 100 / sqrt($baseAspect);
$vbHeight = $baseAspect * $vbWidth;
$attrBase = array(
'class' => 'annot-base',
'preserveAspectRatio' => 'none',
'width' => $vbWidth,
'height' => $vbHeight,
'href' => $baseImageUrl
);
$elBaseImg = Html::rawElement('image', $attrBase);
}
//Render and return svg
$attrSvg = array(
'class' => 'annot-svg',
'version' => '1.1',
'viewBox' => "0 0 {$vbWidth} {$vbHeight}",
'xml:space' => 'preserve',
'xmlns' => 'http://www.w3.org/2000/svg',
'width' => $baseWidth,
'height' => $baseHeight,
'style' => 'width: 100%; height: auto;'
);
if (isset($metadata['annotation'])) {
$markers = [];
$maskCircles = [];
$leadLines = [];
foreach($metadata['annotation'] as $label => $annot) {
if (isset($annot['position'])) {
$attrMask = array(
'cx' => $annot['position']['0'],
'cy' => $annot['position']['1'],
'r' => '3.75',
'fill' => 'black'
);
$maskCirc = Html::rawElement('circle',$attrMask);
array_push($maskCircles,$maskCirc);
$markColor = isset($annot['color']) ? $annot['color'] : '#ff0000';
$attrMarkerCirc = array(
'cx' => $annot['position']['0'],
'cy' => $annot['position']['1'],
'r' => '3.75',
'style' => "fill-opacity: .35; stroke-linejoin: bevel; stroke-width: .3793; stroke: {$markColor};",
'fill' => (isset($annot['light']) && $annot['light']) ? 'white' : 'black'
);
$markCirc = Html::rawElement('circle',$attrMarkerCirc);
array_push($markers,$markCirc);
$attrMarkerText = array(
'x' => $annot['position']['0'],
'y' => $annot['position']['1'],
'style' => "fill: {$markColor}; font-size: 5px; stroke-linejoin: bevel; stroke-width: .6968; text-align: center; text-anchor: middle; transform: translateY(1.5px);"
);
$markText = Html::rawElement('text',$attrMarkerText, isset($annot['label']) ? $annot['label'] : $label );
array_push($markers,$markText);
if(isset($annot['leader'])) {
foreach($annot['leader'] as $line) {
$lineAttr = array(
'd' => sprintf('M%s %s %s %s',$annot['position']['0'], $annot['position']['1'], $line['0'], $line['1']),
'mask' => "url(#annotMask_{$svgID})",
'style' => "fill-opacity:.35; fill: {$markColor}; stroke-linejoin:bevel; stroke-width:.4; stroke: {$markColor};"
);
$lineText = Html::rawElement('path', $lineAttr);
array_push($leadLines, $lineText);
}
}
}
}
$attrMaskRect = array(
'width' => $vbWidth,
'height' => $vbHeight,
'fill' => 'white'
);
$maskRect = Html::rawElement('rect',$attrMaskRect);
$markMask = Html::rawElement('mask', array('id' => 'annotMask_' . $svgID), $maskRect . implode($maskCircles));
$svgDefs = Html::rawElement('defs',array(),$markMask);
}
return Html::rawElement('svg', $attrSvg, $svgDefs . $elBaseImg . implode($markers) . implode($leadLines) );
}
public function validateSave( Content $content, ValidationParams $validationParams ) {
self::console_log('Validate Save', true);
$tempDir = sys_get_temp_dir();
$status = Status::newGood();
try {
$tomlCheck = toml_decode($content->getText(), true);
} catch (TomlError $e) {
$status->fatal( 'content-failed-to-parse', 'SVG', "", $e->getMessage() );
return;
}
$svgText = self::buildSvg($tomlCheck);
$pageTitle = $validationParams->getPageIdentity()->__toString();
$tmpFileFactory = MediaWikiServices::getInstance()->getTempFSFileFactory();
$tmpFile = $tmpFileFactory->newTempFSFile( 'annotSvg_', 'svg' );
//$tmpFile = TempFSFile::factory( $pageTitle, 'svg' );
if ( !$tmpFile ) {
$status->fatal( 'svg-error-create-temp', 'Failed to create temp SVG' );
return;
}
$tmpPath = $tmpFile->getPath();
self::console_log($tmpPath, true);
$result = file_put_contents( $tmpPath, $svgText );
if ( $result === false ) {
$status->fatal( 'svg-error-write-temp', 'Failed to write SVG text' );
return;
}
$repoGroup = MediaWikiServices::getInstance()->getRepoGroup();
$localRepo = $repoGroup->getLocalRepo();
$targetTitleText = 'File:' . substr($pageTitle, 11) . '.svg';
$targetTitle = Title::newFromText($targetTitleText);
$newImage = new UploadFromFile();
$newImage->initializePathInfo( 'File:' . substr($pageTitle, 11) . '.svg', $tmpPath, filesize( $tmpPath ), true );
$newImage->performUpload('Generate annotation svg','Annotation image automatically generated from [[' . $pageTitle . ']]', false, \User::newSystemUser( 'MediaWiki default' ));
return $status;
}
/**
* Small helper function to display information on the browser console
*
* Usage:
* echo '<script>';
* self::console_log('logged string');
* echo '</script>';
*
* @param $data information to display
* @param bool $add_script_tags true to put information is inside complete script tag
*/
public static function console_log($data, $add_script_tags = false) {
$command = 'console.log('. json_encode($data, JSON_HEX_TAG).');';
if ($add_script_tags) {
$command = '<script>'. $command . '</script>';
}
echo $command;
}
}