silverstripe-framework/src/View/Shortcodes/EmbedShortcodeProvider.php

310 lines
9.6 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\View\Shortcodes;
use Embed\Http\DispatcherInterface;
2020-08-12 02:14:05 +02:00
use Psr\SimpleCache\CacheInterface;
use Psr\SimpleCache\InvalidArgumentException;
use SilverStripe\Core\Convert;
2020-08-12 02:14:05 +02:00
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\View\ArrayData;
use SilverStripe\View\Embed\Embeddable;
use SilverStripe\View\Embed\EmbedResource;
use SilverStripe\View\HTML;
use SilverStripe\View\Parsers\ShortcodeHandler;
use Embed\Adapters\Adapter;
use Embed\Exceptions\InvalidUrlException;
use SilverStripe\View\Parsers\ShortcodeParser;
use SilverStripe\Control\Director;
/**
* Provider for the [embed] shortcode tag used by the embedding service
* in the HTML Editor field.
* Provides the html needed for the frontend and the editor field itself.
*/
class EmbedShortcodeProvider implements ShortcodeHandler
{
2016-11-29 00:31:16 +01:00
/**
* Gets the list of shortcodes provided by this handler
*
* @return mixed
*/
public static function get_shortcodes()
{
return ['embed'];
2016-11-29 00:31:16 +01:00
}
2016-11-29 00:31:16 +01:00
/**
* Embed shortcode parser from Oembed. This is a temporary workaround.
* Oembed class has been replaced with the Embed external service.
*
* @param array $arguments
* @param string $content
* @param ShortcodeParser $parser
* @param string $shortcode
2016-11-29 00:31:16 +01:00
* @param array $extra
*
* @return string
*/
public static function handle_shortcode($arguments, $content, $parser, $shortcode, $extra = [])
2016-11-29 00:31:16 +01:00
{
// Get service URL
if (!empty($content)) {
$serviceURL = $content;
} elseif (!empty($arguments['url'])) {
$serviceURL = $arguments['url'];
2016-11-29 00:31:16 +01:00
} else {
return '';
}
2020-08-12 02:14:05 +02:00
// Try to use cached result
$cache = static::getCache();
$key = static::deriveCacheKey($serviceURL);
try {
if ($cache->has($key)) {
return $cache->get($key);
}
} catch (InvalidArgumentException $e) {
}
// See https://github.com/oscarotero/Embed#example-with-all-options for service arguments
$serviceArguments = [];
if (!empty($arguments['width'])) {
$serviceArguments['min_image_width'] = $arguments['width'];
}
if (!empty($arguments['height'])) {
$serviceArguments['min_image_height'] = $arguments['height'];
}
/** @var EmbedResource $embed */
$embed = Injector::inst()->create(Embeddable::class, $serviceURL);
if (!empty($serviceArguments)) {
$embed->setOptions(array_merge($serviceArguments, (array) $embed->getOptions()));
}
// Allow resolver to be mocked
$dispatcher = null;
if (isset($extra['resolver'])) {
$dispatcher = Injector::inst()->create(
$extra['resolver']['class'],
$serviceURL,
$extra['resolver']['config']
);
} elseif (Injector::inst()->has(DispatcherInterface::class)) {
$dispatcher = Injector::inst()->get(DispatcherInterface::class);
}
2018-07-13 17:44:23 +02:00
if ($dispatcher) {
$embed->setDispatcher($dispatcher);
}
// Process embed
try {
$embed = $embed->getEmbed();
} catch (InvalidUrlException $e) {
$message = (Director::isDev())
? $e->getMessage()
: _t(__CLASS__ . '.INVALID_URL', 'There was a problem loading the media.');
$attr = [
'class' => 'ss-media-exception embed'
];
$result = HTML::createTag(
'div',
$attr,
HTML::createTag('p', [], $message)
);
return $result;
}
// Convert embed object into HTML
if ($embed && $embed instanceof Adapter) {
$result = static::embedForTemplate($embed, $arguments);
2016-11-29 00:31:16 +01:00
}
// Fallback to link to service
2020-08-12 02:14:05 +02:00
if (!$result) {
$result = static::linkEmbed($arguments, $serviceURL, $serviceURL);
}
// Cache result
if ($result) {
try {
$cache->set($key, $result);
} catch (InvalidArgumentException $e) {
}
}
return $result;
2016-11-29 00:31:16 +01:00
}
2016-11-29 00:31:16 +01:00
/**
* @param Adapter $embed
* @param array $arguments Additional shortcode params
2016-11-29 00:31:16 +01:00
* @return string
*/
public static function embedForTemplate($embed, $arguments)
2016-11-29 00:31:16 +01:00
{
switch ($embed->getType()) {
2016-11-29 00:31:16 +01:00
case 'video':
case 'rich':
// Attempt to inherit width (but leave height auto)
if (empty($arguments['width']) && $embed->getWidth()) {
$arguments['width'] = $embed->getWidth();
2016-11-29 00:31:16 +01:00
}
return static::videoEmbed($arguments, $embed->getCode());
2016-11-29 00:31:16 +01:00
case 'link':
return static::linkEmbed($arguments, $embed->getUrl(), $embed->getTitle());
2016-11-29 00:31:16 +01:00
case 'photo':
return static::photoEmbed($arguments, $embed->getUrl());
default:
return null;
}
}
/**
* Build video embed tag
*
* @param array $arguments
* @param string $content Raw HTML content
* @return string
*/
protected static function videoEmbed($arguments, $content)
{
// Ensure outer div has given width (but leave height auto)
if (!empty($arguments['width'])) {
$arguments['style'] = 'width: ' . intval($arguments['width']) . 'px;';
2016-11-29 00:31:16 +01:00
}
// override iframe dimension attributes provided by webservice with ones specified in shortcode arguments
foreach (['width', 'height'] as $attr) {
if (!($value = $arguments[$attr] ?? false)) {
continue;
}
foreach (['"', "'"] as $quote) {
$rx = "/(<iframe .*?)$attr=$quote([0-9]+)$quote([^>]+>)/";
$content = preg_replace($rx, "$1{$attr}={$quote}{$value}{$quote}$3", $content);
}
}
$data = [
'Arguments' => $arguments,
'Attributes' => static::buildAttributeListFromArguments($arguments, ['width', 'height', 'url', 'caption']),
'Content' => DBField::create_field('HTMLFragment', $content)
];
return ArrayData::create($data)->renderWith(self::class . '_video')->forTemplate();
}
/**
* Build <a> embed tag
*
* @param array $arguments
* @param string $href
* @param string $title Default title
* @return string
*/
protected static function linkEmbed($arguments, $href, $title)
{
$data = [
'Arguments' => $arguments,
'Attributes' => static::buildAttributeListFromArguments($arguments, ['width', 'height', 'url', 'caption']),
'Href' => $href,
'Title' => !empty($arguments['caption']) ? ($arguments['caption']) : $title
];
return ArrayData::create($data)->renderWith(self::class . '_link')->forTemplate();
}
/**
* Build img embed tag
*
* @param array $arguments
* @param string $src
* @return string
*/
protected static function photoEmbed($arguments, $src)
{
$data = [
'Arguments' => $arguments,
'Attributes' => static::buildAttributeListFromArguments($arguments, ['url']),
'Src' => $src
];
return ArrayData::create($data)->renderWith(self::class . '_photo')->forTemplate();
}
/**
* Build a list of HTML attributes from embed arguments - used to preserve backward compatibility
*
* @deprecated 4.5.0 Use {$Arguments.name} directly in shortcode templates to access argument values
* @param array $arguments List of embed arguments
* @param array $exclude List of attribute names to exclude from the resulting list
* @return ArrayList
*/
private static function buildAttributeListFromArguments(array $arguments, array $exclude = []): ArrayList
{
$attributes = ArrayList::create();
foreach ($arguments as $key => $value) {
if (in_array($key, $exclude)) {
continue;
}
$attributes->push(ArrayData::create([
'Name' => $key,
'Value' => Convert::raw2att($value)
]));
}
return $attributes;
2016-11-29 00:31:16 +01:00
}
2020-08-12 02:14:05 +02:00
/**
* @param ShortcodeParser $parser
* @param string $content
*/
public static function flushCachedShortcodes(ShortcodeParser $parser, string $content): void
{
$cache = static::getCache();
$tags = $parser->extractTags($content);
foreach ($tags as $tag) {
if (!isset($tag['open']) || $tag['open'] != 'embed') {
continue;
}
$url = $tag['content'] ?? $tag['attrs']['url'] ?? null;
if (!$url) {
continue;
}
$key = static::deriveCacheKey($url);
try {
if (!$cache->has($key)) {
continue;
}
$cache->delete($key);
} catch (InvalidArgumentException $e) {
continue;
}
}
}
/**
* @return CacheInterface
*/
private static function getCache(): CacheInterface
{
return Injector::inst()->get(CacheInterface::class . '.EmbedShortcodeProvider');
}
/**
* @param string $url
* @return string
*/
private static function deriveCacheKey(string $url): string
{
$key = 'embed-shortcode-' . preg_replace('/[^a-zA-Z0-9\-]/', '', $url);
return $key;
}
}