jgeorgi/AnatImageViewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Create basic content function

Browse Source 
Signed-off-by: Justin Georgi <justin.georgi@gmail.com>
This commit is contained in:
Justin Georgi
2026-05-17 11:16:19 -07:00
parent cbf305dd05
commit d39458d53b
6 changed files with 115 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
extension.json
View File

@@ -1,8 +1,8 @@
{
"name": "AnatImageViewer",
"name": "AnnotatedImages",
"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.",
"description": "This extension allows the creation of pages in the Annotation namespace which will create annotated images.",
"version": "0.0.1",
"license-name": "MIT",
"type": "media",
@@ -12,23 +12,27 @@
"id": 2218,
"constant": "NS_AV_ANNOT",
"name": "Annotation",
"protection": "annotations-edit"
},
"protection": "annotations-edit",
"subpages": false,
"content": true,
"defaultcontentmodel": "annotation"
},
{
"id": 2219,
"constant": "NS_AV_ANNOT_TALK",
"name": "Annotation_talk"
}
"name": "Annotation_talk",
"subpages": true,
"content": false,
"defaultcontentmodel": "wikitext"
}
],
"callback": "MediaWiki\\Extension\\AnatImageViewer\\AnnotationHooks::registrationCallback",
"AutoloadNamespaces": {
"MediaWiki\\Extension\\AnatImageViewer\\": "includes/"
},
"MediaHandlers": {
"image/annotation": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHandler"
"ContentHandlers": {
"annotation": "MediaWiki\\Extension\\AnatImageViewer\\AnnotationHandler"
},
"Hooks": {
"MimeMagicInit": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHooks::onMimeMagicInit",
"MimeMagicImproveFromExtension": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHooks::onMimeMagicImproveFromExtension",
"ParserFirstCallInit": "MediaWiki\\Extension\\AnatImageViewer\\AnatImageHooks::onParserFirstCallInit"
}
}

63
includes/AnatImageHandler.php
View File

@@ -1,63 +0,0 @@
<?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
View File

@@ -1,77 +0,0 @@
<?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;
}
}

32
includes/AnnotationContent.php Normal file
View File

@@ -0,0 +1,32 @@
<?php
namespace MediaWiki\Extension\AnatImageViewer;
use TextContent;
class AnnotationContent extends TextContent {
public function __construct( $modelId = 'annotation' ) {
parent::__construct( $modelId );
}
/*
public function getTextForSearchIndex() {
}
public function getWikitextForTransclusion() {
}
public function getTextForSummary( $maxLength = 250 ) {
}
public function getSize() {
}
public function copy() {
}
*/
public function isCountable( $hasLinks = null ) {
return false;
}
}

76
includes/AnatImageTransformOutput.php → includes/AnnotationHandler.php
View File

@@ -1,61 +1,55 @@
<?php
namespace MediaWiki\Extension\AnatImageViewer;
require_once __DIR__ . '/../vendor/autoload.php';
use Devium\Toml\Toml;
use MediaWiki\MediaWikiServices;
use MediaTransformOutput;
use Content;
use TextContentHandler;
use MediaWiki\Content\Renderer\ContentParseParams;
use ParserOutput;
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;
self::console_log($parameters, true);
class AnnotationHandler extends TextContentHandler {
private const ANNOT_VERSION = '0.1';
public function __construct( $modelId = 'annotation' ) {
parent::__construct( $modelId, [ CONTENT_FORMAT_TEXT ] );
}
/**
* 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);
/*
public function serializeContent( Content $content, $format = null ) {
}
public function unserializeContent( $blob, $format = null ) {
}
*/
public function makeEmptyContent() {
return new AnnotationContent();
}
public function supportsDirectEditing() {
return true;
}
protected function fillParserOutput( Content $content, ContentParseParams $cpoParams, ParserOutput &$output ) {
// define $html somewhere
// e.g. $output->setText( $html );
self::console_log($content, true);
$metadata = toml_decode($content->getNativeData(), true);
if (isset($metadata['baseImage'])) {
$baseImage = MediaWikiServices::getInstance()->getRepoGroup()->findFile(`File:` . $metadata['baseImage']);
$baseImage = MediaWikiServices::getInstance()->getRepoGroup()->findFile('File:' . $metadata['baseImage']);
} else {
$baseImage = false;
}
return self::buildSvg($metadata,$baseImage);
}
$output->setText( self::buildSvg($metadata,$baseImage) );
}
/**
* Build annotated SVG from TOML metadata

33
includes/AnnotationHooks.php Normal file
View File

@@ -0,0 +1,33 @@
<?php
namespace MediaWiki\Extension\AnatImageViewer;
use MediaWiki\MediaWikiServices;
use RequestContext;
use Html;
use ParserOutput;
class AnnotationHooks {
public static function registrationCallback() {
// Must match the name used in the 'ContentHandlers' section of extension.json
define( 'CONTENT_MODEL_ANNOTATION', 'annotation' );
}
/**
* 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;
}
}