Derive from GlModelViewer
Signed-off-by: Justin Georgi <justin.georgi@gmail.com>
This commit is contained in:
5
composer.json
Normal file
5
composer.json
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"require": {
|
||||||
|
"devium/toml": "*"
|
||||||
|
}
|
||||||
|
}
|
||||||
21
extension.json
Normal file
21
extension.json
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"name": "AnatImageViewer",
|
||||||
|
"author": "Justin Georgi",
|
||||||
|
"url": "https://gitea.azgeorgis.net/jgeorgi/AnatImageViewer",
|
||||||
|
"description": "This extension allows the creation of .an pages in the Files namespace which will be annotated images.",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"license-name": "MIT",
|
||||||
|
"type": "media",
|
||||||
|
"manifest_version": 1,
|
||||||
|
"AutoloadNamespaces": {
|
||||||
|
"MediaWiki\\Extension\\AnatImageViewer\\": "includes/"
|
||||||
|
},
|
||||||
|
"MediaHandlers": {
|
||||||
|
"image/annotation": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHandler"
|
||||||
|
},
|
||||||
|
"Hooks": {
|
||||||
|
"MimeMagicInit": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHooks::onMimeMagicInit",
|
||||||
|
"MimeMagicImproveFromExtension": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHooks::onMimeMagicImproveFromExtension",
|
||||||
|
"ParserFirstCallInit": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHooks::onParserFirstCallInit"
|
||||||
|
}
|
||||||
|
}
|
||||||
63
includes/AnatImageHandler.php
Normal file
63
includes/AnatImageHandler.php
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
<?php
|
||||||
|
namespace MediaWiki\Extension\AnatImageViewer;
|
||||||
|
|
||||||
|
use ImageHandler;
|
||||||
|
use BitmapMetadataHandler;
|
||||||
|
use Html;
|
||||||
|
|
||||||
|
class AnatImageHandler extends ImageHandler {
|
||||||
|
private const ANNOT_VERSION = '0.1';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Model cannot be displayed directly in a browser but can be rendered.
|
||||||
|
*
|
||||||
|
* @param File $file
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function mustRender( $file ) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Model can be rendered.
|
||||||
|
*
|
||||||
|
* @param File $file
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function canRender( $file ) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a MediaTransformOutput object representing the transformed output.
|
||||||
|
*
|
||||||
|
* @param File $image
|
||||||
|
* @param string $dstPath Filesystem destination path
|
||||||
|
* @param string $dstUrl Destination URL to use in output HTML
|
||||||
|
* @param array $params Arbitrary set of parameters validated by $this->validateParam()
|
||||||
|
* @param int $flags A bitfield, may contain self::TRANSFORM_LATER
|
||||||
|
* @return MediaTransformOutput
|
||||||
|
*/
|
||||||
|
public function doTransform($image, $dstPath, $dstUrl, $params, $flags = 0) {
|
||||||
|
return new AnatImageTransformOutput($image, $params);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
77
includes/AnatImageHooks.php
Normal file
77
includes/AnatImageHooks.php
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
<?php
|
||||||
|
namespace MediaWiki\Extension\AnatImageViewer;
|
||||||
|
|
||||||
|
use MediaWiki\MediaWikiServices;
|
||||||
|
use RequestContext;
|
||||||
|
use Html;
|
||||||
|
use ParserOutput;
|
||||||
|
|
||||||
|
class AnatImageHooks {
|
||||||
|
/**
|
||||||
|
* MWHook: Add an (fake) mime types to MimeMagic
|
||||||
|
*
|
||||||
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/MimeMagicInit
|
||||||
|
*
|
||||||
|
* @param MimeAnalyzer $mime Instance of MW MimeAnalyzer object
|
||||||
|
*/
|
||||||
|
public static function onMimeMagicInit($mime) {
|
||||||
|
$mime->addExtraTypes('image/annotation an');
|
||||||
|
$mime->addExtraInfo('image/annotation [METAIMAGE]');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MWHook: Make sure that an files (fake) get the proper mime assignement on upload
|
||||||
|
*
|
||||||
|
* @see https://www.mediawiki.org/wiki/Manual:Hooks/MimeMagicImproveFromExtension
|
||||||
|
*
|
||||||
|
* @param MimeAnalyzer $mimeAnalyzer Instance of MW MimeAnalyzer object
|
||||||
|
* @param string $ext extention of upload file
|
||||||
|
* @param string &$mime current assigned mime type
|
||||||
|
*/
|
||||||
|
public static function onMimeMagicImproveFromExtension( $mimeAnalyzer, $ext, &$mime ) {
|
||||||
|
if ( $mime !== 'image/annotation' && in_array( $ext, ['an'] ) ) {
|
||||||
|
$mime = 'image/annotation';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MWHook: Called when the parser initializes for the first time
|
||||||
|
*
|
||||||
|
* @param Parser $parser: Parser object being initialized
|
||||||
|
*/
|
||||||
|
static function onParserFirstCallInit( $parser ) {
|
||||||
|
$parser->setHook('anconfig', array( __CLASS__, 'renderConfigTag'));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Render the config toml in a <pre> tag
|
||||||
|
*
|
||||||
|
* @param $input The text inside the custom tag
|
||||||
|
* @param array $args Any attributes given in the tag
|
||||||
|
* @param Parser $parser The parser object
|
||||||
|
* @param PPFrame $frame The parent frame calling the parser
|
||||||
|
* @return string HTML string of output
|
||||||
|
*/
|
||||||
|
static function renderConfigTag( $input, array $args, $parser, $frame ) {
|
||||||
|
return '<pre anconfig>' . $input . '</pre>';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
124
includes/AnatImageTransformOutput.php
Normal file
124
includes/AnatImageTransformOutput.php
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
<?php
|
||||||
|
namespace MediaWiki\Extension\AnatImageViewer;
|
||||||
|
|
||||||
|
require_once __DIR__ . '/../vendor/autoload.php';
|
||||||
|
|
||||||
|
use Devium\Toml\Toml;
|
||||||
|
use MediaWiki\MediaWikiServices;
|
||||||
|
use MediaTransformOutput;
|
||||||
|
use ConfigFactory;
|
||||||
|
use RequestContext;
|
||||||
|
use Html;
|
||||||
|
|
||||||
|
class AnatImageTransformOutput extends MediaTransformOutput {
|
||||||
|
/**
|
||||||
|
* Main Constructor
|
||||||
|
*
|
||||||
|
* @access public
|
||||||
|
* @param File $file
|
||||||
|
* @param array $parameters Parameters for constructing HTML.
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function __construct($file, $parameters) {
|
||||||
|
$this->file = $file;
|
||||||
|
$this->parameters = $parameters;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetch HTML for this transform output
|
||||||
|
*
|
||||||
|
* @access public
|
||||||
|
* @param array $options Associative array of options. Boolean options
|
||||||
|
* should be indicated with a value of true for true, and false or
|
||||||
|
* absent for false.
|
||||||
|
* alt Alternate text or caption
|
||||||
|
* desc-link Boolean, show a description link
|
||||||
|
* file-link Boolean, show a file download link
|
||||||
|
* custom-url-link Custom URL to link to
|
||||||
|
* custom-title-link Custom Title object to link to
|
||||||
|
* valign vertical-align property, if the output is an inline element
|
||||||
|
* img-class Class applied to the "<img>" tag, if there is such a tag
|
||||||
|
* preview Boolean, render is being called from a preview page
|
||||||
|
*
|
||||||
|
* @return string HTML
|
||||||
|
*/
|
||||||
|
public function toHtml($options = []) {
|
||||||
|
$descriptText = $this->file->getDescriptionText();
|
||||||
|
preg_match('/<pre anconfig.*?>([\S\s]*?)<\/pre>/',$descriptText,$annotDescript);
|
||||||
|
$metadata = toml_decode($annotDescript[1], true);
|
||||||
|
|
||||||
|
if (isset($metadata['baseImage'])) {
|
||||||
|
$baseImage = MediaWikiServices::getInstance()->getRepoGroup()->findFile(`File:` . $metadata['baseImage']);
|
||||||
|
} else {
|
||||||
|
$baseImage = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return self::buildSvg($metadata,$baseImage);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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
|
||||||
|
* @param string $baseImageUrl The full url pointing to the base image to annotate
|
||||||
|
* @param array $frameParams The additional user defined parameters for the viewer such as hotspot and view classes
|
||||||
|
* @return string Html string of the complete model-viewer element inside a div container
|
||||||
|
*/
|
||||||
|
private function buildSvg($metadata, $baseImage) {
|
||||||
|
//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);
|
||||||
|
}
|
||||||
|
$mainConfig = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
|
||||||
|
$context = RequestContext::getMain();
|
||||||
|
|
||||||
|
//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'
|
||||||
|
);
|
||||||
|
|
||||||
|
return Html::rawElement('svg', $attrSvg, $elBaseImg);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user