GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[Embed] Fix some bugs and change AttachmentEmbed::url to ::media_url

Browse Source
This commit is contained in:
Diogo Peralta Cordeiro 2021-05-01 22:45:47 +01:00 committed by Hugo Sales
parent c9090e6cee
commit 1c9f807595
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
3 changed files with 100 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
plugins/Embed/Embed.php
View File

@ -45,7 +45,6 @@ use App\Core\Log;
use App\Core\Modules\Plugin; use App\Core\Modules\Plugin;
use App\Core\Router\RouteLoader; use App\Core\Router\RouteLoader;
use App\Core\Router\Router; use App\Core\Router\Router;
use App\Core\Security;
use App\Entity\Attachment; use App\Entity\Attachment;
use App\Entity\AttachmentThumbnail; use App\Entity\AttachmentThumbnail;
use App\Util\Common; use App\Util\Common;
@ -81,11 +80,11 @@ class Embed extends Plugin
* *
* @param $m URLMapper the router that was initialized. * @param $m URLMapper the router that was initialized.
* *
* @return bool true if successful, the exception object if it isn't.
* @throws Exception * @throws Exception
* *
* @return void true if successful, the exception object if it isn't.
*/ */
public function onAddRoute(RouteLoader $m) public function onAddRoute(RouteLoader $m): bool
{ {
$m->connect('oembed', 'main/oembed', Controller\Embed::class); $m->connect('oembed', 'main/oembed', Controller\Embed::class);
$m->connect('embed', 'main/embed', Controller\Embed::class); $m->connect('embed', 'main/embed', Controller\Embed::class);
@ -113,7 +112,7 @@ class Embed extends Plugin
'type' => "application/{$format}+oembed", 'type' => "application/{$format}+oembed",
'href' => Router::url('embed', ['format' => $format, 'url' => $url]), 'href' => Router::url('embed', ['format' => $format, 'url' => $url]),
'title' => 'oEmbed', 'title' => 'oEmbed',
], ]; ],];
} }
} }
return Event::next; return Event::next;
@ -128,16 +127,11 @@ class Embed extends Plugin
* *
* @return bool success * @return bool success
*/ */
public function onAttachmentStoreNew(Attachment $attachment) public function onAttachmentStoreNew(Attachment $attachment): bool
{ {
try { try {
DB::findOneBy('attachment_embed', ['attachment_id' => $attachment->getId()]); DB::findOneBy('attachment_embed', ['attachment_id' => $attachment->getId()]);
} catch (NotFoundException) { } catch (NotFoundException) {
} catch (DuplicateFoundException) {
Log::warning("Strangely, an attachment_embed object exists for new file {$attachment->getID()}");
return Event::next;
}
if ($attachment->hasRemoteUrl() && $attachment->hasMimetype()) { if ($attachment->hasRemoteUrl() && $attachment->hasMimetype()) {
$mimetype = $attachment->getMimetype(); $mimetype = $attachment->getMimetype();
if (Formatting::startsWith($mimetype, 'text/html') || Formatting::startsWith($mimetype, 'application/xhtml+xml')) { if (Formatting::startsWith($mimetype, 'text/html') || Formatting::startsWith($mimetype, 'application/xhtml+xml')) {
@ -148,10 +142,12 @@ class Embed extends Plugin
DB::flush(); DB::flush();
} catch (Exception $e) { } catch (Exception $e) {
Log::warning($e); Log::warning($e);
return Event::next;
} }
} }
} }
} catch (DuplicateFoundException) {
Log::warning("Strangely, an attachment_embed object exists for new file {$attachment->getID()}");
}
return Event::next; return Event::next;
} }
@ -179,7 +175,7 @@ class Embed extends Plugin
'title' => $embed->getTitle(), 'title' => $embed->getTitle(),
'width' => $embed->getWidth(), 'width' => $embed->getWidth(),
'height' => $embed->getHeight(), 'height' => $embed->getHeight(),
'url' => $embed->getUrl(), 'url' => $embed->getMediaUrl(),
]; ];
return Event::stop; return Event::stop;
@ -192,7 +188,7 @@ class Embed extends Plugin
{ {
try { try {
$embed = Cache::get('attachment-embed-' . $attachment->getId(), $embed = Cache::get('attachment-embed-' . $attachment->getId(),
fn () => DB::findOneBy('attachment_embed', ['attachment_id' => $attachment->getId()])); fn() => DB::findOneBy('attachment_embed', ['attachment_id' => $attachment->getId()]));
} catch (DuplicateFoundException $e) { } catch (DuplicateFoundException $e) {
Log::waring($e); Log::waring($e);
return Event::next; return Event::next;
@ -213,7 +209,7 @@ class Embed extends Plugin
<img class="u-photo embed" width="{{attributes['width']}}" height="{{attributes['height']}}" src="{{attributes['src']}}" /> <img class="u-photo embed" width="{{attributes['width']}}" height="{{attributes['height']}}" src="{{attributes['src']}}" />
{% endif %} {% endif %}
<h5 class="p-name embed"> <h5 class="p-name embed">
<a class="u-url" href="{{embed.getUrl()}}">{{embed.getTitle() | escape}}</a> <a class="u-url" href="{{attachment.getRemoteUrl()}}">{{embed.getTitle() | escape}}</a>
</h5> </h5>
<div class="p-author embed"> <div class="p-author embed">
{% if embed.getAuthorName() is not null %} {% if embed.getAuthorName() is not null %}
@ -240,17 +236,19 @@ class Embed extends Plugin
{{ embed.getHtml() | escape }} {{ embed.getHtml() | escape }}
</div> </div>
</article> </article>
END, ['embed' => $embed, 'attributes' => $attributes]); END, ['embed' => $embed, 'attributes' => $attributes, 'attachment' => $attachment]);
return Event::stop; return Event::stop;
} }
/** /**
* @return bool false on no check made, provider name on success
* @return string|false on no check made, provider name on success
*
* @throws ServerException if check is made but fails * @throws ServerException if check is made but fails
* *
* @return bool false on no check made, provider name on success
*/ */
protected function checkAllowlist(string $url) protected function checkAllowlist(string $url): string|bool
{ {
if ($this->check_allowlist ?? false) { if ($this->check_allowlist ?? false) {
return false; // indicates "no check made" return false; // indicates "no check made"
@ -272,9 +270,9 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
* reliable enough for our purposes. * reliable enough for our purposes.
* *
* @param string $url * @param string $url
* @param array $headers - if we already made a request * @param array|null $headers - if we already made a request
* *
* @return bool|string the file size if it succeeds, false otherwise. * @return int|null the file size if it succeeds, false otherwise.
*/ */
private function getRemoteFileSize(string $url, ?array $headers = null): ?int private function getRemoteFileSize(string $url, ?array $headers = null): ?int
{ {
@ -304,7 +302,7 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
* *
* @return bool true if the remote URL is an image, or false otherwise. * @return bool true if the remote URL is an image, or false otherwise.
*/ */
private function isRemoteImage(string $url, ?array $headers = null): ?int private function isRemoteImage(string $url, ?array $headers = null): bool
{ {
try { try {
if ($headers === null) { if ($headers === null) {
@ -318,7 +316,7 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
} }
return !empty($headers['content-type']) && GSFile::mimetypeMajor($headers['content-type'][0]) === 'image'; return !empty($headers['content-type']) && GSFile::mimetypeMajor($headers['content-type'][0]) === 'image';
} catch (Exception $e) { } catch (Exception $e) {
Loog::error($e); Log::error($e);
return false; return false;
} }
} }
@ -327,10 +325,9 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
* Validate that $imgData is a valid image, place it in it's folder and resize * Validate that $imgData is a valid image, place it in it's folder and resize
* *
* @param $imgData - The image data to validate * @param $imgData - The image data to validate
* @param null|string $url - The url where the image came from, to fetch metadata
* @param null|array $headers - The headers possible previous request to $url * @param null|array $headers - The headers possible previous request to $url
*/ */
protected function validateAndWriteImage($imgData, string $url, array $headers): array protected function validateAndWriteImage($imgData, ?array $headers = null): array
{ {
$file = new TemporaryFile(); $file = new TemporaryFile();
$file->write($imgData); $file->write($imgData);
@ -345,7 +342,7 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
unset($file); unset($file);
if (array_key_exists('content-disposition', $headers) && preg_match('/^.+; filename="(.+?)"$/', $headers['content-disposition'][0], $matches) === 1) { if (!is_null($headers) && array_key_exists('content-disposition', $headers) && preg_match('/^.+; filename="(.+?)"$/', $headers['content-disposition'][0], $matches) === 1) {
$original_name = $matches[1]; $original_name = $matches[1];
} }
@ -354,31 +351,33 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
/** /**
* Create and store a thumbnail representation of a remote image * Create and store a thumbnail representation of a remote image
*
* @param Attachment $attachment
* @param string $media_url URL for the actual media representation
* @return array|bool
*/ */
protected function storeRemoteThumbnail(Attachment $attachment): array | bool protected function storeRemoteThumbnail(Attachment $attachment, string $media_url): array|bool
{ {
if ($attachment->hasFilename() && file_exists($attachment->getPath())) { if ($attachment->hasFilename() && file_exists($attachment->getPath())) {
throw new AlreadyFulfilledException(_m('A thumbnail seems to already exist for remote file with id=={id}', ['id' => $attachment->getId()])); throw new AlreadyFulfilledException(_m('A thumbnail seems to already exist for remote file with id=={id}', ['id' => $attachment->getId()]));
} }
$url = $attachment->getRemoteUrl(); if (Formatting::startsWith($media_url, 'file://')) {
$filename = Formatting::removePrefix($media_url, 'file://');
if (Formatting::startsWith($url, 'file://')) {
$filename = Formatting::removePrefix($url, 'file://');
$info = getimagesize($filename); $info = getimagesize($filename);
$filename = basename($filename); $filename = basename($filename);
$width = $info[0]; $width = $info[0];
$height = $info[1]; $height = $info[1];
} else { } else {
$this->checkAllowlist($url); $this->checkAllowlist($media_url);
$head = HTTPClient::head($url); $head = HTTPClient::head($media_url);
$headers = $head->getHeaders(); $headers = $head->getHeaders();
$headers = array_change_key_case($headers, CASE_LOWER); $headers = array_change_key_case($headers, CASE_LOWER);
try { try {
$is_image = $this->isRemoteImage($url, $headers); $is_image = $this->isRemoteImage($media_url, $headers);
if ($is_image == true) { if ($is_image == true) {
$file_size = $this->getRemoteFileSize($url, $headers); $file_size = $this->getRemoteFileSize($media_url, $headers);
$max_size = Common::config('attachments', 'file_quota'); $max_size = Common::config('attachments', 'file_quota');
if (($file_size != false) && ($file_size > $max_size)) { if (($file_size != false) && ($file_size > $max_size)) {
throw new \Exception("Wanted to store remote thumbnail of size {$file_size} but the upload limit is {$max_size} so we aborted."); throw new \Exception("Wanted to store remote thumbnail of size {$file_size} but the upload limit is {$max_size} so we aborted.");
@ -392,11 +391,12 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
} }
// First we download the file to memory and test whether it's actually an image file // First we download the file to memory and test whether it's actually an image file
Log::debug('Downloading remote thumbnail for file id==' . $attachment->getId() . " with thumbnail URL: {$url}"); Log::debug('Downloading remote thumbnail for file id==' . $attachment->getId() . " with thumbnail URL: {$media_url}");
try { try {
$imgData = HTTPClient::get($url)->getContent(); $imgData = HTTPClient::get($media_url)->getContent();
if (isset($imgData)) { if (isset($imgData)) {
[$filepath, $width, $height, $original_name, $mimetype] = $this->validateAndWriteImage($imgData, $url, $headers); [$filepath, $width, $height, $original_name, $mimetype] = $this->validateAndWriteImage($imgData, $headers);
} else { } else {
throw new UnsupportedMediaException(_m('HTTPClient returned an empty result')); throw new UnsupportedMediaException(_m('HTTPClient returned an empty result'));
} }
@ -422,11 +422,8 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
* Throws exceptions on failure. * Throws exceptions on failure.
* *
* @param string $url * @param string $url
* * @param Attachment $attachment
* @throws EmbedHelper_BadHtmlException * @return array
* @throws HTTP_Request2_Exception
*
* @return object
*/ */
public function getEmbed(string $url, Attachment $attachment): array public function getEmbed(string $url, Attachment $attachment): array
{ {
@ -437,29 +434,30 @@ END, ['embed' => $embed, 'attributes' => $attributes]);
$embed = new LibEmbed(); $embed = new LibEmbed();
$info = $embed->get($url); $info = $embed->get($url);
$metadata['title'] = $info->title; $metadata['title'] = $info->title;
$metadata['html'] = Security::sanitize($info->description); $metadata['html'] = $info->description;
$metadata['url'] = $info->url;
$metadata['author_name'] = $info->authorName; $metadata['author_name'] = $info->authorName;
$metadata['author_url'] = $info->authorUrl; $metadata['author_url'] = $info->authorUrl;
$metadata['provider_name'] = $info->providerName; $metadata['provider_name'] = $info->providerName;
$metadata['provider_url'] = $info->providerUrl; $metadata['provider_url'] = $info->providerUrl;
if (!is_null($info->image)) { if (!is_null($info->image)) {
if (Formatting::startsWith($info->image, 'data')) { $image_url = (string)$info->image;
if (Formatting::startsWith($image_url, 'data')) {
// Inline image // Inline image
$imgData = base64_decode(substr($info->image, stripos($info->image, 'base64,') + 7)); $imgData = base64_decode(substr($info->image, stripos($info->image, 'base64,') + 7));
[$filepath, $width, $height, $original_name, $mimetype] = $this->validateAndWriteImage($imgData); [$filepath, $width, $height, $original_name, $mimetype] = $this->validateAndWriteImage($imgData);
} else { } else {
$attachment->setRemoteUrl((string) $info->image); [$filepath, $width, $height, $original_name, $mimetype] = $this->storeRemoteThumbnail($attachment, $image_url);
[$filepath, $width, $height, $original_name, $mimetype] = $this->storeRemoteThumbnail($attachment);
} }
$metadata['width'] = $width; $metadata['width'] = $width;
$metadata['height'] = $height; $metadata['height'] = $height;
$metadata['mimetype'] = $mimetype; $metadata['mimetype'] = $mimetype;
$metadata['media_url'] = $image_url;
$metadata['filename'] = Formatting::removePrefix($filepath, Common::config('storage', 'dir')); $metadata['filename'] = Formatting::removePrefix($filepath, Common::config('storage', 'dir'));
} }
} catch (Exception $e) { } catch (Exception $e) {
Log::info("Failed to find Embed data for {$url} with 'oscarotero/Embed', got exception: " . get_class($e)); Log::info("Failed to find Embed data for {$url} with 'oscarotero/Embed', got exception: " . $e);
} }
$metadata = self::normalize($metadata); $metadata = self::normalize($metadata);

22
plugins/Embed/Entity/AttachmentEmbed.php
View File

@ -59,7 +59,7 @@ class AttachmentEmbed extends Entity
private ?string $title; private ?string $title;
private ?string $author_name; private ?string $author_name;
private ?string $author_url; private ?string $author_url;
private ?string $url; private ?string $media_url;
private \DateTimeInterface $modified; private \DateTimeInterface $modified;
public function setAttachmentId(int $attachment_id): self public function setAttachmentId(int $attachment_id): self
@ -183,15 +183,15 @@ class AttachmentEmbed extends Entity
return $this->author_url; return $this->author_url;
} }
public function setUrl(?string $url): self public function setMediaUrl(?string $media_url): self
{ {
$this->url = $url; $this->media_url = $media_url;
return $this; return $this;
} }
public function getUrl(): ?string public function getMediaUrl(): ?string
{ {
return $this->url; return $this->media_url;
} }
public function setModified(DateTimeInterface $modified): self public function setModified(DateTimeInterface $modified): self
@ -244,18 +244,18 @@ class AttachmentEmbed extends Entity
return [ return [
'name' => 'attachment_embed', 'name' => 'attachment_embed',
'fields' => [ 'fields' => [
'attachment_id' => ['type' => 'int', 'not null' => true, 'description' => 'oEmbed for that URL/file'], 'attachment_id' => ['type' => 'int', 'not null' => true, 'description' => 'Embed for that URL/file'],
'mimetype' => ['type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'], 'mimetype' => ['type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'],
'filename' => ['type' => 'varchar', 'length' => 191, 'description' => 'file name of resource when available'], 'filename' => ['type' => 'varchar', 'length' => 191, 'description' => 'file name of resource when available'],
'provider' => ['type' => 'text', 'description' => 'name of this oEmbed provider'], 'provider' => ['type' => 'text', 'description' => 'name of this oEmbed provider'],
'provider_url' => ['type' => 'text', 'description' => 'URL of this oEmbed provider'], 'provider_url' => ['type' => 'text', 'description' => 'URL of this oEmbed provider'],
'width' => ['type' => 'int', 'description' => 'width of oEmbed resource when available'], 'width' => ['type' => 'int', 'description' => 'width of oEmbed resource when available'],
'height' => ['type' => 'int', 'description' => 'height of oEmbed resource when available'], 'height' => ['type' => 'int', 'description' => 'height of oEmbed resource when available'],
'html' => ['type' => 'text', 'description' => 'html representation of this oEmbed resource when applicable'], 'html' => ['type' => 'text', 'description' => 'html representation of this Embed resource when applicable'],
'title' => ['type' => 'text', 'description' => 'title of oEmbed resource when available'], 'title' => ['type' => 'text', 'description' => 'title of Embed resource when available'],
'author_name' => ['type' => 'text', 'description' => 'author name for this oEmbed resource'], 'author_name' => ['type' => 'text', 'description' => 'author name for this Embed resource'],
'author_url' => ['type' => 'text', 'description' => 'author URL for this oEmbed resource'], 'author_url' => ['type' => 'text', 'description' => 'author URL for this Embed resource'],
'url' => ['type' => 'text', 'description' => 'URL for this oEmbed resource when applicable (photo, link)'], 'media_url' => ['type' => 'text', 'description' => 'URL for this Embed resource when applicable (photo, link)'],
'modified' => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'], 'modified' => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'],
], ],
'primary key' => ['attachment_id'], 'primary key' => ['attachment_id'],

4
src/Core/GSFile.php
View File

@ -48,7 +48,7 @@ class GSFile
// The following properly gets the mimetype with `file` or other // The following properly gets the mimetype with `file` or other
// available methods, so should be safe // available methods, so should be safe
$mimetype = $sfile->getMimeType(); $mimetype = $sfile->getMimeType();
Event::handle('AttachmentValidation', [&$sfile, &$mimetype, &$title]); Event::handle('AttachmentValidation', [&$sfile, &$mimetype, &$title, &$width, &$height]);
$attachment = Attachment::create([ $attachment = Attachment::create([
'file_hash' => $hash, 'file_hash' => $hash,
'gsactor_id' => $actor_id, 'gsactor_id' => $actor_id,
@ -57,6 +57,8 @@ class GSFile
'filename' => $hash, 'filename' => $hash,
'is_local' => $is_local, 'is_local' => $is_local,
'size' => $sfile->getSize(), 'size' => $sfile->getSize(),
'width' => $width,
'height' => $height,
]); ]);
$sfile->move($dest_dir, $hash); $sfile->move($dest_dir, $hash);
DB::persist($attachment); DB::persist($attachment);