Merge branch 'release/v3.0.6'

Author: octfx

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Request a new feature / enhancement
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Detailed Description
+<!--- Provide a detailed description of the change or addition you are proposing -->
+
+## Context
+<!--- Why is this change important to you? How would you use it? -->
+<!--- How can it benefit other users? -->
+
+## Possible Implementation
+<!--- Not obligatory, but suggest an idea for implementing addition or change -->
+

README.md

@@ -78,7 +78,7 @@ To specify the start and end timestamps in the media use the start and end param
 
 	[[File:Example.mp4|start=2|end=6]]
 
-Additionally a cover image can be set for video files by specifying a `cover=` key.
+Additionally, a cover image can be set for video files by specifying a `cover=` key.
 
 	[[File:Example.mp4|start=2|end=6|cover=File:LocalFile.png]]
 
@@ -124,6 +124,23 @@ However, if needed optional arguments may be left blank by not putting anything
 
 * `{{#ev:service|id|||description}}`
 
+Alternatively each parameter can be used in any order as a named parameter. The following parameter are available:
+* `id`
+* `dimensions`
+* `alignment`
+* `description`
+* `container`
+* `urlArgs`
+* `autoResize`
+* `vAlignment`
+* `width`
+* `height`
+* `cover`
+* `title`
+
+**Do note** mixing named and unnamed parameters will require you to add all unnamed parameters (and blanks) in the previously mentioned order.  
+E.g. using named id and unnamed description `{{#ev:service||||This is the Description|id=abc}}`/ `{{#ev:service|id=abc|||This is the Description}}`
+
 ## Examples
 
 ### Example #1
@@ -159,6 +176,21 @@ Using the service name as a parser tag
 
     <youtube>https://www.youtube.com/watch?v=eAORm-8b1Eg</youtube>
 
+### Example #5
+Using a local file as an embed thumbnail
+
+    {{#ev:youtube|pSsYTj9kCHE|thumbnail=File:LocalFile.jpg}}
+
+### Example #6
+Using a local file as an embed thumbnail and specifying a title
+
+    {{#ev:youtube|pSsYTj9kCHE|cover=File:LocalFile.jpg|title=Title of the Embed}}
+
+### Example #7
+Using named parameters
+
+    {{#ev:youtube|id=pSsYTj9kCHE|dimensions=320x320}}
+
 ## Supported Services
 
 As of version 3.x, EmbedVideo supports embedding video content from the following services:
@@ -176,6 +208,9 @@ As of version 3.x, EmbedVideo supports embedding video content from the followin
 | [YouTube](http://www.youtube.com/)                       | `youtubeplaylist` - Playlists                                                         | PLY0KbDiiFYeNgQkjujixr7qD-FS8qecoP                                                    | https://www.youtube.com/embed/?listType=playlist&list=PLY0KbDiiFYeNgQkjujixr7qD-FS8qecoP                       |
 | [YouTube](http://www.youtube.com/)                       | `youtubevideolist` - Video List                                                       | pSsYTj9kCHE - urlargs=playlist=pSsYTj9kCHE,pSsYTj9kCHE                                | https://www.youtube.com/embed/pSsYTj9kCHE?playlist=pSsYTj9kCHE,pSsYTj9kCHE                                     |
 
+### New Services
+New services can be requested by using the following [link](https://github.com/StarCitizenWiki/mediawiki-extensions-EmbedVideo/issues/new?assignees=&labels=enhancement&template=embed-service-request.md&title=Embed+Service+Request%3A+Service+Name) or clicking `New Issue`.
+
 # Configuration Settings
 
 | Variable                             | Default Value    | Description                                                                                                                                             |

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "starcitizenwiki/embedvideo",
-	"version": "3.0.5",
+	"version": "3.0.6",
 	"type": "mediawiki-extension",
 	"description": "Adds a parser function embedding video from popular sources.",
 	"license": "MIT",

extension.json

@@ -1,6 +1,6 @@
 {
 	"name": "EmbedVideo",
-	"version": "3.0.5",
+	"version": "3.0.6",
 	"author": [
 		"Jim R. Wilson",
 		"Andrew Whitworth",

i18n/zh-hant.json

@@ -0,0 +1,32 @@
+{
+	"@metadata": {
+		"authors": [
+			"Kly"
+		]
+	},
+	"embedvideo-description": "此分叉版本添加可用於內嵌來自熱門來源的影片之解析功能。",
+	"embedvideo-consent-text": "點擊載入內容",
+	"embedvideo-error-missingparams": "EmbedVideo 缺少一個必要的參數。",
+	"embedvideo-error-service": "EmbedVideo 無法識別影片服務「$1」。",
+	"embedvideo-error-id": "EmbedVideo 接收到用於服務「$1」的錯誤 ID「$2」。",
+	"embedvideo-error-width": "EmbedVideo 接收到錯誤的寬度參數「$1」。",
+	"embedvideo-error-height": "EmbedVideo 接收到錯誤的高度參數「$1」。",
+	"embedvideo-error-alignment": "給予了 EmbedVideo 調準參數「$1」一個無效的值。有效值為「left」、「center」、「right」、或是「inline」。",
+	"embedvideo-error-valignment": "給予了 EmbedVideo 直向調準參數「$1」一個無效的值。有效值為「top」、「middle」、「bottom」、或是「baseline」。",
+	"embedvideo-error-urlargs": "EmbedVideo 接收到包含異常資料或是引數為空白的 URL 引數清單。",
+	"embedvideo-error-unknown": "EmbedVideo 在嘗試產生影片內嵌區塊時發生未知錯誤。（$1）",
+	"embedvideo-error-evp_deprecated": "#evp 解析函式在 EmbedVideo 2.0 已棄用。請將您的解析函式標籤轉換成 #ev。",
+	"embedvideo-error-container": "提供給「container」的參數無效。",
+	"embedvideo-video-long-desc": "$1，編解碼器 $2，長度 $3，$4 x $5 像素，總體 $6",
+	"embedvideo-audio-long-desc": "$1，編解碼器 $2，長度 $3，總體 $4",
+	"embedvideo-error-cantdecode_evu": "無法解析來自 $1 的影片",
+	"apihelp-embedvideo-summary": "取得給予指定參數所產生的影片內嵌代碼。",
+	"apihelp-embedvideo-param-service": "服務名稱（youtube、twitch、等等）",
+	"apihelp-embedvideo-param-id": "用於該服務的影片 ID",
+	"apihelp-embedvideo-param-dimensions": "數字寬度（100）或是寬 x 高（100 x 100）",
+	"apihelp-embedvideo-param-alignment": "影片調準",
+	"apihelp-embedvideo-param-description": "影片描述",
+	"apihelp-embedvideo-param-container": "接受影格，或留下空白",
+	"apihelp-embedvideo-param-urlargs": "在影片 URL 裡的額外引數（用於部分服務）",
+	"apihelp-embedvideo-param-autoresize": "自動調整影片大小？（true 或 false）"
+}

includes/EmbedService/AbstractEmbedService.php

@@ -6,7 +6,11 @@
 
 use Config;
 use InvalidArgumentException;
+use MediaTransformOutput;
 use MediaWiki\MediaWikiServices;
+use RuntimeException;
+use ThumbnailImage;
+use Title;
 
 abstract class AbstractEmbedService {
 	/**
@@ -62,6 +66,18 @@ abstract class AbstractEmbedService {
 	 */
 	protected $urlArgs = [];
 
+	/**
+	 * @var ThumbnailImage|MediaTransformOutput|null
+	 */
+	protected $localThumb;
+
+	/**
+	 * Local title for this embed
+	 *
+	 * @var string|null
+	 */
+	protected $title;
+
 	/**
 	 * Config object
 	 *
@@ -331,4 +347,53 @@ public function addIframeAttribute( string $key, $value ): void {
 	public function getIframeAttributes(): array {
 		return array_merge( $this->iframeAttributes, $this->additionalIframeAttributes );
 	}
+
+	/**
+	 * Set a local filename to be used as the thumbnail for this embed
+	 *
+	 * @param string $localFileName
+	 * @throws InvalidArgumentException When the local file was not found
+	 * @throws RuntimeException When the local file could not be transformed
+	 */
+	public function setLocalThumb( string $localFileName ): void {
+		$title = Title::newFromText( $localFileName, NS_FILE );
+
+		if ( $title !== null && $title->exists() ) {
+			$coverFile = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title );
+			$transform = $coverFile->transform( [ 'width' => $this->getWidth() ] );
+
+			if ( $transform === false ) {
+				throw new RuntimeException( sprintf( 'Could not transform file "%s".', $coverFile->getHashPath() ) );
+			}
+
+			$this->localThumb = $transform;
+		} else {
+			throw new InvalidArgumentException( sprintf( 'Local file "%s" not found.', $localFileName ) );
+		}
+	}
+
+	/**
+	 * @return ThumbnailImage|MediaTransformOutput|null
+	 */
+	public function getLocalThumb() {
+		return $this->localThumb;
+	}
+
+	/**
+	 * This title takes precedence over any external fetching
+	 *
+	 * @param string|null $title
+	 */
+	public function setTitle( ?string $title ): void {
+		if ( ( $title ?? '' ) !== '' ) {
+			$this->title = $title;
+		}
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public function getTitle(): ?string {
+		return $this->title;
+	}
 }

includes/EmbedService/EmbedHtmlFormatter.php

@@ -5,6 +5,7 @@
 namespace MediaWiki\Extension\EmbedVideo\EmbedService;
 
 use ConfigException;
+use Exception;
 use MediaWiki\Extension\EmbedVideo\OEmbed;
 use MediaWiki\MediaWikiServices;
 use UnexpectedValueException;
@@ -48,4 +49,42 @@ public static function toHtml( AbstractEmbedService $service ): string {
 
 		return sprintf( '<iframe %s></iframe>', implode( ' ', $out ) );
 	}
+
+	/**
+	 * Generates the html used for embed thumbnails
+	 *
+	 * @param AbstractEmbedService $service
+	 * @return string The final html (can be empty on error or missing data)
+	 */
+	public static function makeThumbHtml( AbstractEmbedService $service ): string {
+		if ( $service->getLocalThumb() === null ) {
+			return "";
+		}
+
+		try {
+			$url = wfExpandUrl( $service->getLocalThumb()->getUrl() );
+
+			return <<<HTML
+<picture class="embedvideo-consent__thumbnail"><!--
+	--><img src="{$url}" loading="lazy" class="embedvideo-consent__thumbnail__image" alt="Thumbnail for {$service->getTitle()}"/><!--
+--></picture>
+HTML;
+		} catch ( Exception $e ) {
+			return "";
+		}
+	}
+
+	/**
+	 * Generates the html used for embed titles
+	 *
+	 * @param AbstractEmbedService $service
+	 * @return string The final html (can be empty on error or missing data)
+	 */
+	public static function makeTitleHtml( AbstractEmbedService $service ): string {
+		if ( $service->getTitle() === null ) {
+			return "";
+		}
+
+		return sprintf( '<div class="embedvideo-consent__title">%s</div>', $service->getTitle() );
+	}
 }

includes/EmbedVideo.php

@@ -15,6 +15,7 @@
 use Message;
 use Parser;
 use PPFrame;
+use RuntimeException;
 
 class EmbedVideo {
 	/**
@@ -204,6 +205,8 @@ private function parseArgs( array $args, bool $fromTag ): array {
 			'vAlignment' => '',
 			'width' => null,
 			'height' => null,
+			'cover' => null,
+			'title' => null,
 		];
 
 		if ( $fromTag === true ) {
@@ -285,6 +288,8 @@ private function init(): void {
 			'description' => $description,
 			'urlArgs' => $urlArgs,
 			'vAlignment' => $vAlignment,
+			'cover' => $cover,
+			'title' => $title,
 		] = $this->args;
 
 		// I am not using $parser->parseWidthParam() since it can not handle height only.  Example: x100
@@ -327,6 +332,16 @@ private function init(): void {
 		if ( !$this->setVerticalAlignment( $vAlignment ) ) {
 			throw new InvalidArgumentException( $this->error( 'valignment', $vAlignment )[0] );
 		}
+
+		if ( !empty( $cover ?? '' ) ) {
+			try {
+			$this->service->setLocalThumb( $cover );
+			} catch ( InvalidArgumentException | RuntimeException $e ) {
+				wfLogWarning( $e->getMessage() );
+			}
+		}
+
+		$this->service->setTitle( $title );
 	}
 
 	/**
@@ -407,6 +422,8 @@ private function setVerticalAlignment( $vAlignment ): bool {
 	 * Generate the HTML necessary to embed the video with the given alignment
 	 * and text description
 	 *
+	 * TODO: Move into HtmlFormatter
+	 *
 	 * @private
 	 * @param string    [Optional] Horizontal Alignment
 	 * @param string    [Optional] Description
@@ -444,9 +461,13 @@ private function generateWrapperHTML( $html, $addClass = null, string $service =
 
 		$consentClickContainer = '';
 		if ( !( $this->service instanceof OEmbedServiceInterface ) && $this->config->get( 'EmbedVideoRequireConsent' ) ) {
+			$titleHtml = EmbedHtmlFormatter::makeTitleHtml( $this->service );
 			$consentClickContainer = sprintf(
-				'<div class="embedvideo-consent"><div class="embedvideo-consent__overlay"><div class="embedvideo-consent__message">%s</div></div></div>',
-				( new Message( 'embedvideo-consent-text' ) )->text()
+				'<div class="embedvideo-consent"><div class="embedvideo-consent__overlay%s">%s<div class="embedvideo-consent__message">%s</div></div>%s</div>',
+				$titleHtml !== '' ? ' embedvideo-consent__overlay--hastitle' : '',
+				$titleHtml,
+				( new Message( 'embedvideo-consent-text' ) )->text(),
+				EmbedHtmlFormatter::makeThumbHtml( $this->service )
 			);
 		}
 

resources/ext.embedVideo.consent.js

@@ -42,7 +42,7 @@
 				return result.json();
 			})
 			.then(json => {
-				if (typeof json.thumbnail_url === 'undefined') {
+				if (typeof json.thumbnail_url === 'undefined' || parent.querySelectorAll('.embedvideo-consent__thumbnail').length > 0) {
 					return;
 				}