Skip to content

oembedHelper #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skerbis merged 1 commit into from
Sep 28, 2024
Merged

oembedHelper #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 68 additions & 32 deletions lib/video.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<?php

namespace FriendsOfRedaxo\VidStack;

use rex_escape;
use rex_path;
use rex_url;

class Video {
class Video
{
private readonly string $source;
private string $title;
private array $attributes = [];
Expand All @@ -15,7 +17,8 @@ class Video {
private string $lang;
private static array $translations = [];

public function __construct(string $source, string $title = '', string $lang = 'de') {
public function __construct(string $source, string $title = '', string $lang = 'de')
{
$this->source = $source;
$this->title = $title;
$this->lang = $lang;
Expand All @@ -27,7 +30,8 @@ private static function getTranslationsFile(): string
return rex_path::addon('vidstack', 'lang/translations.php');
}

private function loadTranslations(): void {
private function loadTranslations(): void
{
if (empty(self::$translations)) {
$file = self::getTranslationsFile();
if (file_exists($file)) {
Expand All @@ -38,30 +42,35 @@ private function loadTranslations(): void {
}
}

private function getText(string $key): string {
private function getText(string $key): string
{
return self::$translations[$this->lang][$key] ?? "[[{$key}]]";
}

public function setAttributes(array $attributes): void {
public function setAttributes(array $attributes): void
{
$this->attributes = $attributes;
}

public function setA11yContent(string $description, string $alternativeUrl = ''): void {
public function setA11yContent(string $description, string $alternativeUrl = ''): void
{
$alternativeUrl = $alternativeUrl ?: $this->getAlternativeUrl();

$this->a11yContent = "<div class=\"video-description\">"
. "<p>" . rex_escape($this->getText('video_description')) . ": " . rex_escape($description) . "</p></div>"
. "<div class=\"alternative-links\">"
. "<p>" . rex_escape($this->getText('video_alternative_view')) . ": <a href=\"" . rex_escape($alternativeUrl) . "\">"
. "<p>" . rex_escape($this->getText('video_alternative_view')) . ": <a href=\"" . rex_escape($alternativeUrl) . "\">"
. rex_escape($this->getText('video_open_alternative_view')) . "</a></p>"
. "</div>";
}

public function setThumbnails(string $thumbnailsUrl): void {
public function setThumbnails(string $thumbnailsUrl): void
{
$this->thumbnails = $thumbnailsUrl;
}

public function addSubtitle(string $src, string $kind, string $label, string $lang, bool $default = false): void {
public function addSubtitle(string $src, string $kind, string $label, string $lang, bool $default = false): void
{
$this->subtitles[] = [
'src' => $src,
'kind' => $kind,
Expand All @@ -71,18 +80,21 @@ public function addSubtitle(string $src, string $kind, string $label, string $la
];
}

private function getSourceUrl(): string {
private function getSourceUrl(): string
{
if (filter_var($this->source, FILTER_VALIDATE_URL)) {
return $this->source;
}
return rex_url::media($this->source);
}

private function getAlternativeUrl(): string {
private function getAlternativeUrl(): string
{
return $this->getSourceUrl();
}

private function getVideoInfo(): array {
private function getVideoInfo(): array
{
$youtubePattern = '%(?:youtube(?:-nocookie)?\.com/(?:[^/]+/.+/|(?:v|e(?:mbed)?)/|.*[?&]v=|shorts/)|youtu\.be/)([^"&?/ ]{11})%i';
if (preg_match($youtubePattern, $this->source, $match)) {
return ['platform' => 'youtube', 'id' => $match[1]];
Expand All @@ -94,32 +106,33 @@ private function getVideoInfo(): array {
return ['platform' => 'default', 'id' => ''];
}

public function generateFull(): string {
public function generateFull(): string
{
$videoInfo = $this->getVideoInfo();
$attributesString = $this->generateAttributesString();
$titleAttr = $this->title ? " title=\"" . rex_escape($this->title) . "\"" : '';

$code = "<div class=\"video-container\" role=\"region\" aria-label=\"" . rex_escape($this->getText('a11y_video_player')) . "\">";

if ($videoInfo['platform'] !== 'default') {
$consentTextKey = "consent_text_{$videoInfo['platform']}";
$consentText = $this->getText($consentTextKey);
if ($consentText === "[[{$consentTextKey}]]") {
$consentText = $this->getText('consent_text_default');
}

$code .= $this->generateConsentPlaceholder($consentText, $videoInfo['platform'], $videoInfo['id']);
}

$code .= "<media-player{$titleAttr}{$attributesString}";

if ($videoInfo['platform'] !== 'default') {
$code .= " data-video-platform=\"" . rex_escape($videoInfo['platform']) . "\" data-video-id=\"" . rex_escape($videoInfo['id']) . "\""
. " aria-label=\"" . rex_escape($this->getText('a11y_video_from')) . " " . rex_escape($videoInfo['platform']) . "\"";
. " aria-label=\"" . rex_escape($this->getText('a11y_video_from')) . " " . rex_escape($videoInfo['platform']) . "\"";
} else {
$code .= " src=\"" . rex_escape($this->getSourceUrl()) . "\"";
}

$code .= " role=\"application\"" . ($videoInfo['platform'] !== 'default' ? " style=\"display:none;\"" : "") . ">";
$code .= "<media-provider></media-provider>";
foreach ($this->subtitles as $subtitle) {
Expand All @@ -128,18 +141,19 @@ public function generateFull(): string {
}
$code .= "<media-video-layout" . ($this->thumbnails ? " thumbnails=\"" . rex_escape($this->thumbnails) . "\"" : "") . "></media-video-layout>";
$code .= "</media-player>";

if ($this->a11yContent) {
$code .= "<div class=\"a11y-content\" role=\"complementary\" aria-label=\"" . rex_escape($this->getText('a11y_additional_information')) . "\">"
. $this->a11yContent
. "</div>";
. $this->a11yContent
. "</div>";
}

$code .= "</div>";
return $code;
}

public function generate(): string {
public function generate(): string
{
$attributesString = $this->generateAttributesString();
$titleAttr = $this->title ? " title=\"" . rex_escape($this->title) . "\"" : '';
$sourceUrl = $this->getSourceUrl();
Expand All @@ -154,18 +168,40 @@ public function generate(): string {
return $code;
}

private function generateAttributesString(): string {
return array_reduce(array_keys($this->attributes), function($carry, $key) {
private function generateAttributesString(): string
{
return array_reduce(array_keys($this->attributes), function ($carry, $key) {
$value = $this->attributes[$key];
return $carry . (is_bool($value) ? ($value ? " " . rex_escape($key) : '') : " " . rex_escape($key) . "=\"" . rex_escape($value) . "\"");
}, '');
}

private function generateConsentPlaceholder(string $consentText, string $platform, string $videoId): string {
private function generateConsentPlaceholder(string $consentText, string $platform, string $videoId): string
{
$buttonText = $this->getText('Load Video');
return "<div class=\"consent-placeholder\" aria-hidden=\"true\" data-platform=\"" . rex_escape($platform) . "\" data-video-id=\"" . rex_escape($videoId) . "\" style=\"aspect-ratio: 16/9;\">"
. "<p>" . rex_escape($consentText) . "</p>"
. "<button type=\"button\" class=\"consent-button\">" . rex_escape($buttonText) . "</button>"
. "</div>";
. "<p>" . rex_escape($consentText) . "</p>"
. "<button type=\"button\" class=\"consent-button\">" . rex_escape($buttonText) . "</button>"
. "</div>";
}
public static function videoOembedHelper(): void
{
rex_extension::register('OUTPUT_FILTER', static function (rex_extension_point $ep) {
$content = $ep->getSubject();
return self::parseOembedTags($content);
}, rex_extension::LATE);
}

public static function parseOembedTags(string $content): string
{
return preg_replace_callback('/<oembed url="(.+?)"><\/oembed>/is', static function ($match) {
$video = new self($match[1]);
$video->setAttributes([
'crossorigin' => '',
'playsinline' => true,
'controls' => true
]);
return $video->generateFull();
}, $content);
}
}