gnu-social/plugins/Embed/Entity/AttachmentEmbed.php

<?php

declare(strict_types = 1);
// {{{ License

// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

// }}}

/**
 * OembedPlugin implementation for GNU social
 *
 * @package   GNUsocial
 *
 * @author    Stephen Paul Weber
 * @author    Mikael Nordfeldth
 * @author    Diogo Cordeiro <diogo@fc.up.pt>
 * @copyright 2019 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

namespace Plugin\Embed\Entity;

use App\Core\DB;
use App\Core\Entity;
use Component\Attachment\Entity\Attachment;
use DateTimeInterface;

/**
 * Table Definition for attachment_embed
 *
 * @author Hugo Sales <hugo@hsal.es>
 * @copyright 2019, 2021 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */
class AttachmentEmbed extends Entity
{
    // {{{ Autocode
    // @codeCoverageIgnoreStart
    private int $link_id;
    private int $attachment_id;
    private ?string $provider_name = null;
    private ?string $provider_url  = null;
    private ?string $title         = null;
    private ?string $description   = null;
    private ?string $author_name   = null;
    private ?string $author_url    = null;
    private ?string $thumbnail_url = null;
    private DateTimeInterface $modified;

    public function setLinkId(int $link_id): self
    {
        $this->link_id = $link_id;
        return $this;
    }

    public function getLinkId(): int
    {
        return $this->link_id;
    }

    public function setAttachmentId(int $attachment_id): self
    {
        $this->attachment_id = $attachment_id;
        return $this;
    }

    public function getAttachmentId(): int
    {
        return $this->attachment_id;
    }

    public function setProviderName(?string $provider_name): self
    {
        $this->provider_name = $provider_name;
        return $this;
    }

    public function getProviderName(): ?string
    {
        return $this->provider_name;
    }

    public function setProviderUrl(?string $provider_url): self
    {
        $this->provider_url = $provider_url;
        return $this;
    }

    public function getProviderUrl(): ?string
    {
        return $this->provider_url;
    }

    public function setTitle(?string $title): self
    {
        $this->title = $title;
        return $this;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setDescription(?string $description): self
    {
        $this->description = $description;
        return $this;
    }

    public function getDescription(): ?string
    {
        return $this->description;
    }

    public function setAuthorName(?string $author_name): self
    {
        $this->author_name = $author_name;
        return $this;
    }

    public function getAuthorName(): ?string
    {
        return $this->author_name;
    }

    public function setAuthorUrl(?string $author_url): self
    {
        $this->author_url = $author_url;
        return $this;
    }

    public function getAuthorUrl(): ?string
    {
        return $this->author_url;
    }

    public function setThumbnailUrl(?string $thumbnail_url): self
    {
        $this->thumbnail_url = $thumbnail_url;
        return $this;
    }

    public function getThumbnailUrl(): ?string
    {
        return $this->thumbnail_url;
    }

    public function setModified(DateTimeInterface $modified): self
    {
        $this->modified = $modified;
        return $this;
    }

    public function getModified(): DateTimeInterface
    {
        return $this->modified;
    }

    // @codeCoverageIgnoreEnd
    // }}} Autocode

    /**
     * Generate the Embed thumbnail HTML attributes
     *
     * @return mixed[] ['class' => string, 'has_attachment' => bool, 'height' => int|null, 'width' => int|null]
     */
    public function getImageHTMLAttributes(): array
    {
        $attr       = ['class' => 'u-photo embed'];
        $attachment = DB::find('attachment', ['id' => $this->getAttachmentId()]);
        $thumbnail  = $attachment->getThumbnail('medium');
        if (\is_null($attachment) || \is_null($attachment->getWidth()) || \is_null($attachment->getHeight())) {
            $attr['has_attachment'] = false;
        } elseif (!\is_null($thumbnail)) {
            $attr['has_attachment'] = true;
            $attr['width']          = $thumbnail->getWidth();
            $attr['height']         = $thumbnail->getHeight();
        }
        return $attr;
    }

    public static function schemaDef(): array
    {
        return [
            'name'   => 'attachment_embed',
            'fields' => [
                'link_id'       => ['type' => 'int', 'not null' => true, 'description' => 'Embed for that URL/file'],
                'attachment_id' => ['type' => 'int', 'not null' => true, 'description' => 'Attachment relation, used to show previews'],
                'provider_name' => ['type' => 'text', 'description' => 'Name of this Embed provider'],
                'provider_url'  => ['type' => 'text', 'description' => 'URL of this Embed provider'],
                'title'         => ['type' => 'text', 'description' => 'Title of Embed resource when available'],
                'description'   => ['type' => 'text', 'description' => 'Description of Embed resource when available'],
                'author_name'   => ['type' => 'text', 'description' => 'Author name for this Embed resource'],
                'author_url'    => ['type' => 'text', 'description' => 'Author URL for this Embed resource'],
                'thumbnail_url' => ['type' => 'text', 'description' => 'URL for this Embed resource when applicable (image)'],
                'modified'      => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'],
            ],
            'primary key'  => ['link_id'],
            'foreign keys' => [
                'attachment_embed_link_id_fkey'       => ['link', ['link_id' => 'id']],
                'attachment_embed_attachment_id_fkey' => ['attachment', ['attachment_id' => 'id']],
            ],
        ];
    }
}