unil-lettres / dilps-tiresias

server/Application/Model/Card.php

<?php

declare(strict_types=1);

namespace Application\Model;

use Application\Api\FileException;
use Application\Api\Input\Operator\CardYearRangeOperatorType;
use Application\Api\Input\Operator\DatingYearRangeOperatorType;
use Application\Api\Input\Operator\LocalityOrInstitutionLocalityOperatorType;
use Application\Api\Input\Operator\LocationOperatorType;
use Application\Api\Input\Operator\NameOrExpandedNameOperatorType;
use Application\Api\Input\Sorting\Artists;
use Application\Api\Input\Sorting\Domains;
use Application\Api\Input\Sorting\InstitutionLocality;
use Application\Enum\CardVisibility;
use Application\Enum\Site;
use Application\Repository\CardRepository;
use Application\Service\DatingRule;
use Application\Service\ImageResizer;
use Application\Traits\CardSimpleProperties;
use Application\Traits\HasAddress;
use Application\Traits\HasCode;
use Application\Traits\HasFileSize;
use Application\Traits\HasImage;
use Application\Traits\HasInstitution;
use Application\Traits\HasParentInterface;
use Application\Traits\HasRichTextName;
use Application\Traits\HasSite;
use Application\Traits\HasSiteInterface;
use Application\Traits\HasYearRange;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection as DoctrineCollection;
use Doctrine\ORM\Mapping as ORM;
use Ecodev\Felix\Api\Exception;
use Ecodev\Felix\Model\Image;
use Ecodev\Felix\Utility;
use GraphQL\Doctrine\Attribute as API;
use Imagine\Filter\Basic\Autorotate;
use Imagine\Image\ImageInterface;
use Imagine\Image\ImagineInterface;
use InvalidArgumentException;
use Psr\Http\Message\UploadedFileInterface;
use Throwable;

/**
 * A card containing an image and some information about it.
 */
#[ORM\Index(name: 'card_name_idx', columns: ['name'])]
#[ORM\Index(name: 'card_plain_name_idx', columns: ['plain_name'])]
#[ORM\Index(name: 'card_locality_idx', columns: ['locality'])]
#[ORM\Index(name: 'card_area_idx', columns: ['area'])]
#[ORM\Index(
    name: 'FULLTEXT__CARD_CUSTOM_SEARCH',
    flags: ['fulltext'],
    fields: [
        'dating',
        'cachedArtistNames',
        'addition',
        'expandedName',
        'material',
        'techniqueAuthor',
        'objectReference',
        'corpus',
        'street',
        'locality',
        'code',
        'name',
    ],
)]
#[ORM\Index(name: 'FULLTEXT__CARD_LOCALITY', flags: ['fulltext'], fields: ['locality'])]
#[ORM\Index(name: 'FULLTEXT__CARD_NAMES', flags: ['fulltext'], fields: ['name', 'expandedName'])]
#[ORM\UniqueConstraint(name: 'unique_code', columns: ['code', 'site'])]
#[API\Filter(field: 'nameOrExpandedName', operator: NameOrExpandedNameOperatorType::class, type: 'string')]
#[API\Filter(field: 'localityOrInstitutionLocality', operator: LocalityOrInstitutionLocalityOperatorType::class, type: 'string')]
#[API\Filter(field: 'datingYearRange', operator: DatingYearRangeOperatorType::class, type: 'int')]
#[API\Filter(field: 'cardYearRange', operator: CardYearRangeOperatorType::class, type: 'int')]
#[API\Filter(field: 'custom', operator: LocationOperatorType::class, type: 'string')]
#[API\Sorting(Artists::class)]
#[API\Sorting(Domains::class)]
#[API\Sorting(InstitutionLocality::class)]
#[API\Sorting(\Application\Api\Input\Sorting\DocumentType::class)]
#[ORM\HasLifecycleCallbacks]
#[ORM\Entity(CardRepository::class)]
class Card extends AbstractModel implements HasSiteInterface, Image
{
    use CardSimpleProperties;
    use HasAddress;
    use HasCode;
    use HasFileSize;
    use HasImage {
        setFile as traitSetFile;
    }
    use HasInstitution;
    use HasRichTextName;
    use HasSite;
    use HasYearRange;

    private const IMAGE_PATH = 'data/images/';

    #[ORM\Column(type: 'enum', options: ['default' => CardVisibility::Private])]
    private CardVisibility $visibility = CardVisibility::Private;

    #[ORM\Column(type: 'integer')]
    private int $width = 0;

    #[ORM\Column(type: 'integer')]
    private int $height = 0;

    #[ORM\Column(type: 'string', options: ['default' => ''])]
    private string $dating = '';

    /**
     * This is a form of cache of all artist names whose only purpose is to be able
     * to search on artists more easily. It is automatically maintained via DB triggers.
     */
    #[API\Exclude]
    #[ORM\Column(type: 'text', options: ['default' => ''])]
    private string $cachedArtistNames = '';

    /**
     * @var DoctrineCollection<Collection>
     */
    #[ORM\ManyToMany(targetEntity: Collection::class)]
    private DoctrineCollection $collections;

    /**
     * @var DoctrineCollection<Artist>
     */
    #[ORM\ManyToMany(targetEntity: Artist::class)]
    private DoctrineCollection $artists;

    /**
     * @var DoctrineCollection<AntiqueName>
     */
    #[ORM\ManyToMany(targetEntity: AntiqueName::class)]
    private DoctrineCollection $antiqueNames;

    /**
     * @var DoctrineCollection<Tag>
     */
    #[ORM\ManyToMany(targetEntity: Tag::class)]
    private DoctrineCollection $tags;

    /**
     * @var DoctrineCollection<Dating>
     */
    #[ORM\OneToMany(targetEntity: Dating::class, mappedBy: 'card')]
    private DoctrineCollection $datings;

    #[ORM\JoinColumn(onDelete: 'SET NULL')]
    #[ORM\ManyToOne(targetEntity: self::class)]
    private ?Card $original = null;

    #[ORM\JoinColumn(onDelete: 'SET NULL')]
    #[ORM\ManyToOne(targetEntity: DocumentType::class)]
    private ?DocumentType $documentType = null;

    /**
     * @var DoctrineCollection<Domain>
     */
    #[ORM\ManyToMany(targetEntity: Domain::class)]
    private DoctrineCollection $domains;

    /**
     * @var DoctrineCollection<Period>
     */
    #[ORM\ManyToMany(targetEntity: Period::class)]
    private DoctrineCollection $periods;

    /**
     * @var DoctrineCollection<Material>
     */
    #[ORM\ManyToMany(targetEntity: Material::class)]
    private DoctrineCollection $materials;

    /**
     * @var DoctrineCollection<Card>
     */
    #[ORM\ManyToMany(targetEntity: self::class)]
    private DoctrineCollection $cards;

    /**
     * There is actually 0 to 1 change, never more. And this is
     * enforced by DB unique constraints on the mapping side.
     *
     * @var DoctrineCollection<Change>
     */
    #[ORM\OneToMany(targetEntity: Change::class, mappedBy: 'suggestion')]
    private DoctrineCollection $changes;

    #[ORM\Column(type: 'string', length: 191, options: ['default' => ''])]
    private string $documentSize = '';

    #[ORM\Column(name: 'legacy_id', type: 'integer', nullable: true)]
    private ?int $legacyId = null;

    public function __construct(string $name = '')
    {
        $this->setName($name);

        $this->changes = new ArrayCollection();
        $this->collections = new ArrayCollection();
        $this->artists = new ArrayCollection();
        $this->antiqueNames = new ArrayCollection();
        $this->tags = new ArrayCollection();
        $this->datings = new ArrayCollection();
        $this->cards = new ArrayCollection();
        $this->domains = new ArrayCollection();
        $this->periods = new ArrayCollection();
        $this->materials = new ArrayCollection();
    }

    /**
     * Return whether this is publicly available to everybody, or only member, or only owner.
     */
    public function getVisibility(): CardVisibility
    {
        return $this->visibility;
    }

    /**
     * Set whether this is publicly available to everybody, or only member, or only owner.
     */
    public function setVisibility(CardVisibility $visibility): void
    {
        if ($this->visibility === $visibility) {
            return;
        }

        $user = User::getCurrent();
        if ($visibility === CardVisibility::Public && $user->getRole() !== User::ROLE_ADMINISTRATOR) {
            throw new Exception('Only administrator can make a card public');
        }

        $this->visibility = $visibility;
    }

    /**
     * Get collections this card belongs to.
     */
    public function getCollections(): DoctrineCollection
    {
        return $this->collections;
    }

    /**
     * Get the card dating.
     *
     * This is a free form string that will be parsed to **try** and extract
     * some actual date range of dates. Any string is valid, but some parseable
     * values would typically be:
     *
     * - (1620-1652)
     * - 01.05.1917
     * - XIIIe siècle
     * - 1927
     * - c. 1100
     * - Fin du XIIe siècle
     */
    public function getDating(): string
    {
        return $this->dating;
    }

    /**
     * Set the card dating.
     *
     * This is a free form string that will be parsed to **try** and extract
     * some actual date range of dates. Any string is valid, but some parseable
     * values would typically be:
     *
     * - (1620-1652)
     * - 01.05.1917
     * - XIIIe siècle
     * - 1927
     * - c. 1100
     * - Fin du XIIe siècle
     */
    public function setDating(string $dating): void
    {
        if ($dating === $this->dating) {
            return;
        }
        $this->dating = $dating;

        $this->computeDatings();
    }

    /**
     * Return the automatically computed dating periods.
     */
    public function getDatings(): DoctrineCollection
    {
        return $this->datings;
    }

    /**
     * Set all artists at once by their names.
     *
     * Non-existing artists will be created automatically.
     *
     * @param null|string[] $artistNames
     */
    public function setArtists(?array $artistNames): void
    {
        if (null === $artistNames) {

The condition null === $artistNames is always false.

            return;
        }

        $artistRepository = _em()->getRepository(Artist::class);
        $newArtists = $artistRepository->getOrCreateByNames($artistNames, $this->getSite());

        $oldIds = Utility::modelToId($this->artists->toArray());
        sort($oldIds);

        $newIds = Utility::modelToId($newArtists);
        sort($newIds);

        if ($oldIds === $newIds && !in_array(null, $oldIds, true) && !in_array(null, $newIds, true)) {
            return;
        }

        $this->artists->clear();
        foreach ($newArtists as $a) {
            $this->artists->add($a);
        }
    }

    /**
     * Set all materials at once.
     *
     * @param null|string[] $materials
     */
    #[API\Input(type: '?ID[]')]
    public function setMaterials(?array $materials): void
    {
        if (null === $materials) {

The condition null === $materials is always false.

            return;
        }

        $this->setEntireCollection($materials, $this->materials, Material::class);
        $this->addEntireHierarchy($this->materials);
    }

    /**
     * Set all antiqueNames at once.
     *
     * @param null|string[] $antiqueNames
     */
    #[API\Input(type: '?ID[]')]
    public function setAntiqueNames(?array $antiqueNames): void
    {
        if (null === $antiqueNames) {

The condition null === $antiqueNames is always false.

            return;
        }

        $this->setEntireCollection($antiqueNames, $this->antiqueNames, AntiqueName::class);
    }

    /**
     * Set all domains at once.
     *
     * @param null|string[] $domains
     */
    #[API\Input(type: '?ID[]')]
    public function setDomains(?array $domains): void
    {
        if (null === $domains) {

The condition null === $domains is always false.

            return;
        }

        $this->setEntireCollection($domains, $this->domains, Domain::class);
    }

    /**
     * Set all periods at once.
     *
     * @param null|string[] $periods
     */
    #[API\Input(type: '?ID[]')]
    public function setPeriods(?array $periods): void
    {
        if (null === $periods) {

The condition null === $periods is always false.

            return;
        }

        $this->setEntireCollection($periods, $this->periods, Period::class);
    }

    /**
     * Set all tags at once.
     *
     * @param null|string[] $tags
     */
    #[API\Input(type: '?ID[]')]
    public function setTags(?array $tags): void
    {
        if (null === $tags) {

The condition null === $tags is always false.

            return;
        }

        $this->setEntireCollection($tags, $this->tags, Tag::class);
        $this->addEntireHierarchy($this->tags);
    }

    private function setEntireCollection(array $ids, DoctrineCollection $collection, string $class): void
    {
        $oldIds = Utility::modelToId($collection->toArray());
        sort($oldIds);

        sort($ids);

        if ($oldIds === $ids && !in_array(null, $oldIds, true) && !in_array(null, $ids, true)) {
            return;
        }

        $repository = _em()->getRepository($class);
        $objects = $repository->findBy([
            'id' => $ids,
            'site' => $this->getSite(),
        ]);

        $collection->clear();
        foreach ($objects as $object) {
            $collection->add($object);
        }
    }

    /**
     * Get artists.
     */
    public function getArtists(): DoctrineCollection
    {
        return $this->artists;
    }

    /**
     * Get antiqueNames.
     */
    public function getAntiqueNames(): DoctrineCollection
    {
        return $this->antiqueNames;
    }

    /**
     * Add tag.
     */
    public function addTag(Tag $tag): void
    {
        if (!$this->tags->contains($tag)) {
            $this->tags[] = $tag;
        }
        $this->addEntireHierarchy($this->tags);
    }

    /**
     * Remove tag.
     */
    public function removeTag(Tag $tag): void
    {
        $this->tags->removeElement($tag);
        $this->addEntireHierarchy($this->tags);
    }

    /**
     * Get tags.
     */
    public function getTags(): DoctrineCollection
    {
        return $this->tags;
    }

    /**
     * The original card if this is a suggestion.
     */
    public function getOriginal(): ?self
    {
        return $this->original;
    }

    /**
     * Defines this card as suggestion for the $original.
     */
    public function setOriginal(?self $original): void
    {
        $this->original = $original;
    }

    public function getDocumentType(): ?DocumentType
    {
        return $this->documentType;
    }

    public function setDocumentType(?DocumentType $documentType): void
    {
        $this->documentType = $documentType;
    }

    /**
     * Get domains.
     */
    public function getDomains(): DoctrineCollection
    {
        return $this->domains;
    }

    /**
     * Add Domain.
     */
    public function addDomain(Domain $domain): void
    {
        if (!$this->domains->contains($domain)) {
            $this->domains[] = $domain;
        }
    }

    /**
     * Get periods.
     */
    public function getPeriods(): DoctrineCollection
    {
        return $this->periods;
    }

    /**
     * Add Period.
     */
    public function addPeriod(Period $period): void
    {
        if (!$this->periods->contains($period)) {
            $this->periods[] = $period;
        }
    }

    /**
     * Remove Period.
     */
    public function removePeriod(Period $period): void
    {
        $this->periods->removeElement($period);
    }

    /**
     * Get materials.
     */
    public function getMaterials(): DoctrineCollection
    {
        return $this->materials;
    }

    /**
     * Add Material.
     */
    public function addMaterial(Material $material): void
    {
        if (!$this->materials->contains($material)) {
            $this->materials[] = $material;
        }

        $this->addEntireHierarchy($this->materials);
    }

    /**
     * Remove Material.
     */
    public function removeMaterial(Material $material): void
    {
        $this->materials->removeElement($material);
        $this->addEntireHierarchy($this->materials);
    }

    /**
     * Add this card into the given collection.
     */
    public function addCollection(Collection $collection): void
    {
        if (!$this->collections->contains($collection)) {
            $this->collections->add($collection);
        }

        // If we are new and don't have a code yet, set one automatically
        if (!$this->getId() && !$this->getCode() && $this->canUpdateCode()) {

The expression $this->getId() of type integer|null is loosely compared to false; this is ambiguous if the integer can be 0. You might want to explicitly use === null instead.

            /** @var CardRepository $userRepository */
            $userRepository = _em()->getRepository(self::class);
            $code = $userRepository->getNextCodeAvailable($collection);
            $this->setCode($code);
        }
    }

    /**
     * Remove this card from given collection.
     */
    public function removeCollection(Collection $collection): void
    {
        $this->collections->removeElement($collection);
    }

    /**
     * Notify the Card that a Dating was added.
     * This should only be called by Dating::setCard().
     */
    public function datingAdded(Dating $dating): void
    {
        $this->datings->add($dating);
    }

    /**
     * Notify the Card that a Dating was removed.
     * This should only be called by Dating::setCard().
     */
    public function datingRemoved(Dating $dating): void
    {
        $this->datings->removeElement($dating);
    }

    /**
     * Get image width.
     */
    public function getWidth(): int
    {
        return $this->width;
    }

    /**
     * Set image width.
     */
    #[API\Exclude]
    public function setWidth(int $width): void
    {
        $this->width = $width;
    }

    /**
     * Get image height.
     */
    public function getHeight(): int
    {
        return $this->height;
    }

    /**
     * Set image height.
     */
    #[API\Exclude]
    public function setHeight(int $height): void
    {
        $this->height = $height;
    }

    /**
     * Set the image file.
     */
    #[API\Input(type: '?GraphQL\Upload\UploadType')]
    public function setFile(UploadedFileInterface $file): void
    {
        global $container;

        $this->traitSetFile($file);

        try {
            /** @var ImagineInterface $imagine */
            $imagine = $container->get(ImagineInterface::class);
            $image = $imagine->open($this->getPath());

            $this->autorotate($image);
            $this->readFileInfo($image);
        } catch (Throwable $e) {
            throw new FileException($file, $e);
        }

        // Create most used thumbnails.
        $imageResizer = $container->get(ImageResizer::class);
        foreach ([300, 2000] as $maxHeight) {
            $imageResizer->resize($this, $maxHeight, true);
        }
    }

    /**
     * Get legacy id.
     */
    public function getLegacyId(): ?int
    {
        return $this->legacyId;
    }

    /**
     * Set legacy id.
     */
    #[API\Exclude]
    public function setLegacyId(int $legacyId): void
    {
        $this->legacyId = $legacyId;
    }

    /**
     * Try to auto-rotate image if EXIF says it's rotated.
     * If the size of the resulting file exceed the autorized upload filesize
     * configured for the server (php's upload_max_filesize), do nothing.
     *
     * More informations about EXIF orientation here:
     * https://www.daveperrett.com/articles/2012/07/28/exif-orientation-handling-is-a-ghetto/
     */
    private function autorotate(ImageInterface $image): void
    {
        $autorotate = new Autorotate();

        // Check if the image is EXIF oriented.
        if (!empty($autorotate->getTransformations($image))) {
            $autorotate->apply($image);

            // Save the rotate image to a temporary file to check its size.
            $tempFile = tempnam('data/tmp/', 'rotated-image');
            $image->save($tempFile);
            $maxSize = ini_parse_quantity(ini_get('upload_max_filesize'));

The function ini_parse_quantity was not found. Maybe you did not declare it correctly or list all dependencies?

            $newSize = filesize($tempFile);
            unlink($tempFile);

            // We only rotate if the size of the rotated file do not exceed the
            // authorized upload filesize configured for the server.
            if ($newSize < $maxSize) {
                $image->save($this->getPath());
            }
        }
    }

    /**
     * Read dimension and size from file on disk.
     */
    private function readFileInfo(ImageInterface $image): void
    {
        // Ensure that we read fresh stats from disk.
        clearstatcache(true, $this->getPath());

        $size = $image->getSize();

        $this->setWidth($size->getWidth());
        $this->setHeight($size->getHeight());
        $this->setFileSize(filesize($this->getPath()));
    }

    private function computeDatings(): void
    {
        $rule = new DatingRule();

        // Delete all existing
        foreach ($this->datings as $d) {
            _em()->remove($d);
        }
        $this->datings->clear();

        // Add new one
        $datings = $rule->compute($this->dating);
        foreach ($datings as $d) {
            _em()->persist($d);
            $d->setCard($this);
        }
    }

    /**
     * Copy most of this card data into the given card.
     */
    public function copyInto(self $original): void
    {
        // Trigger loading of proxy
        $original->getName();

        $blacklist = [
            'id',
            'visibility',
            'code',
            '__initializer__',
            '__cloner__',
            '__isInitialized__',
        ];

        if (!$this->hasImage()) {
            $blacklist[] = 'filename';
            $blacklist[] = 'width';
            $blacklist[] = 'height';
            $blacklist[] = 'fileSize';
        }

        // Copy scalars
        foreach ($this as $property => $value) {
            if (in_array($property, $blacklist, true)) {
                continue;
            }

            if (is_scalar($value) || $value === null) {
                $original->$property = $value;
            }
        }

        // Copy a few collection and entities
        $original->artists = clone $this->artists;
        $original->tags = clone $this->tags;
        $original->materials = clone $this->materials;
        $original->domains = clone $this->domains;
        $original->periods = clone $this->periods;
        $original->computeDatings();
        $original->institution = $this->institution;
        $original->country = $this->country;
        $original->documentType = $this->documentType;

        // Copy file on disk
        if ($this->filename) {
            $original->generateUniqueFilename($this->filename);
            copy($this->getPath(), $original->getPath());
        }
    }

    /**
     * Get related cards.
     */
    public function getCards(): DoctrineCollection
    {
        return $this->cards;
    }

    /**
     * Add related card.
     */
    public function addCard(self $card): void
    {
        if ($card === $this) {
            throw new InvalidArgumentException('A card cannot be related to itself');
        }

        if (!$this->cards->contains($card)) {
            $this->cards[] = $card;
        }

        if (!$card->getCards()->contains($this)) {
            $card->getCards()->add($this);
        }
    }

    /**
     * Remove related card.
     */
    public function removeCard(self $card): void
    {
        $this->cards->removeElement($card);
        $card->getCards()->removeElement($this);
    }

    /**
     * Return the change this card is a suggestion for, if any.
     */
    public function getChange(): ?Change
    {
        return $this->changes->first() ?: null;
    }

    /**
     * Notify the Card that it was added to a Change.
     * This should only be called by Change::addCard().
     */
    public function changeAdded(?Change $change): void
    {
        $this->changes->clear();
        if ($change) {
            $this->changes->add($change);
        }
    }

    /**
     * Set documentSize.
     */
    public function setDocumentSize(string $documentSize): void
    {
        $this->documentSize = $documentSize;
    }

    /**
     * Get documentSize.
     */
    public function getDocumentSize(): string
    {
        return $this->documentSize;
    }

    public function setIsbn(string $isbn): void
    {
        // Field is readonly and can only be emptied (Dilps only).
        if ($this->getSite() === Site::Dilps && $isbn !== '') {
            return;
        }

        $this->isbn = $isbn;
    }

    /**
     * Ensure that the entire hierarchy is added, but also make sure that
     * a non-leaf tag is added without one of his leaf.
     */
    private function addEntireHierarchy(DoctrineCollection $collection): void
    {
        $objects = $collection->toArray();
        $collection->clear();

        /** @var HasParentInterface $object */
        foreach ($objects as $object) {
            if ($object->hasChildren()) {
                continue;
            }

            $collection->add($object);

            foreach ($object->getParentHierarchy() as $parent) {
                if (!$collection->contains($parent)) {
                    $collection->add($parent);
                }
            }
        }
    }
}