domain-watchdog/src/Entity/Domain.php

<?php

namespace App\Entity;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\QueryParameter;
use App\Config\EventAction;
use App\Exception\MalformedDomainException;
use App\Repository\DomainRepository;
use App\Service\RDAPService;
use App\State\AutoRegisterDomainProvider;
use App\State\FindDomainCollectionFromEntityProvider;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\DBAL\Types\Types;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Attribute\Groups;
use Symfony\Component\Serializer\Attribute\SerializedName;

#[ORM\Entity(repositoryClass: DomainRepository::class)]
#[ApiResource(
    operations: [
        new GetCollection(
            uriTemplate: '/domains',
            openapiContext: [
                'summary' => 'Reverse Domain lookup',
                'description' => 'This experimental endpoint allows listing domain names that meet a strict condition.',
            ],
            normalizationContext: [
                'groups' => [
                    'domain:list',
                    'tld:list',
                    'event:list',
                    'event:list',
                ],
            ],
            provider: FindDomainCollectionFromEntityProvider::class,
            parameters: [
                'registrant' => new QueryParameter(
                    description: 'The exact name of the registrant contact (case insensitive)',
                    required: false
                ),
                'administrative' => new QueryParameter(
                    description: 'The exact name of the administrative contact (case insensitive)',
                    required: false
                ),
            ]
        ),
        new Get(
            uriTemplate: '/domains/{ldhName}', // Do not delete this line, otherwise Symfony interprets the TLD of the domain name as a return type
            openapiContext: [
                'summary' => 'Searching for a Domain',
                'description' => 'This endpoint allows you to perform an RDAP lookup. The query is sent to the relevant registry. When the RDAP response is received, the domain name information is stored in a database for historical and cache purposes.',
            ],
            normalizationContext: [
                'groups' => [
                    'domain:item',
                    'event:list',
                    'domain-entity:entity',
                    'nameserver-entity:nameserver',
                    'nameserver-entity:entity',
                    'tld:item',
                    'ds:list',
                ],
            ],
            parameters: [
                'forced' => new QueryParameter(schema: ['type' => 'boolean'], description: 'Force an RDAP request. If an update is already in progress, this parameter is ignored and the stored domain is returned.', required: false),
            ],
        ),
    ],
    provider: AutoRegisterDomainProvider::class,
)]
class Domain
{
    #[ORM\Id]
    #[ORM\Column(length: 255)]
    #[Groups(['domain:item', 'domain:list', 'watchlist:item', 'watchlist:list'])]
    private ?string $ldhName = null;

    #[ORM\Column(length: 255, nullable: true)]
    #[Groups(['domain:item', 'domain:list', 'watchlist:item'])]
    private ?string $handle = null;

    /**
     * @var Collection<int, DomainEvent>
     */
    #[ORM\OneToMany(targetEntity: DomainEvent::class, mappedBy: 'domain', cascade: ['persist'], orphanRemoval: true)]
    #[Groups(['domain:item', 'domain:list', 'watchlist:list'])]
    #[ApiProperty(
        openapiContext: [
            'type' => 'array',
        ]
    )]
    private Collection $events;

    /**
     * @var Collection<int, DomainEntity>
     */
    #[ORM\OneToMany(targetEntity: DomainEntity::class, mappedBy: 'domain', cascade: ['persist'], orphanRemoval: true)]
    #[Groups(['domain:item', 'watchlist:item'])]
    #[SerializedName('entities')]
    private Collection $domainEntities;

    #[ORM\Column(type: Types::JSON, nullable: true)]
    #[Groups(['domain:item', 'domain:list', 'watchlist:item', 'watchlist:list'])]
    private array $status = [];

    /**
     * @var Collection<int, Watchlist>
     */
    #[ORM\ManyToMany(targetEntity: Watchlist::class, mappedBy: 'domains', cascade: ['persist'])]
    private Collection $watchlists;

    /**
     * @var Collection<int, Nameserver>
     */
    #[ORM\ManyToMany(targetEntity: Nameserver::class, inversedBy: 'domains', cascade: ['persist'])]
    #[ORM\JoinTable(name: 'domain_nameservers',
        joinColumns: [new ORM\JoinColumn(name: 'domain_ldh_name', referencedColumnName: 'ldh_name')],
        inverseJoinColumns: [new ORM\JoinColumn(name: 'nameserver_ldh_name', referencedColumnName: 'ldh_name')]
    )]
    #[Groups(['domain:item', 'watchlist:item'])]
    private Collection $nameservers;

    #[ORM\Column(type: Types::DATE_IMMUTABLE)]
    private ?\DateTimeImmutable $createdAt;

    #[ORM\Column(type: Types::DATETIME_IMMUTABLE)]
    #[Groups(['domain:item', 'domain:list'])]
    private ?\DateTimeImmutable $updatedAt;

    #[ORM\ManyToOne]
    #[ORM\JoinColumn(referencedColumnName: 'tld', nullable: false)]
    #[Groups(['domain:item', 'domain:list'])]
    private ?Tld $tld = null;

    #[ORM\Column(nullable: false)]
    #[Groups(['domain:item', 'domain:list', 'watchlist:item', 'watchlist:list'])]
    private ?bool $deleted;

    #[Groups(['domain:item'])]
    private ?RdapServer $rdapServer;

    /**
     * @var Collection<int, DomainStatus>
     */
    #[ORM\OneToMany(targetEntity: DomainStatus::class, mappedBy: 'domain', orphanRemoval: true)]
    #[Groups(['domain:item'])]
    #[SerializedName('oldStatus')]
    private Collection $domainStatuses;

    #[ORM\Column(nullable: false, options: ['default' => false])]
    #[Groups(['domain:item', 'domain:list'])]
    private bool $delegationSigned = false;

    /**
     * @var Collection<int, DnsKey>
     */
    #[ORM\OneToMany(targetEntity: DnsKey::class, mappedBy: 'domain', orphanRemoval: true)]
    #[Groups(['domain:item'])]
    private Collection $dnsKey;

    private ?int $expiresInDays;

    /**
     * @var Collection<int, DomainPurchase>
     */
    #[ORM\OneToMany(targetEntity: DomainPurchase::class, mappedBy: 'domain', orphanRemoval: true)]
    private Collection $domainPurchases;

    private const IMPORTANT_EVENTS = [EventAction::Deletion->value, EventAction::Expiration->value];
    private const IMPORTANT_STATUS = [
        'redemption period',
        'pending delete',
        'pending create',
        'pending renew',
        'pending restore',
        'pending transfer',
        'pending update',
        'add period',
    ];

    public function __construct()
    {
        $this->events = new ArrayCollection();
        $this->domainEntities = new ArrayCollection();
        $this->watchlists = new ArrayCollection();
        $this->nameservers = new ArrayCollection();
        $this->updatedAt = new \DateTimeImmutable('now');
        $this->createdAt = $this->updatedAt;
        $this->deleted = false;
        $this->domainStatuses = new ArrayCollection();
        $this->dnsKey = new ArrayCollection();
        $this->domainPurchases = new ArrayCollection();
    }

    public function getLdhName(): ?string
    {
        return $this->ldhName;
    }

    /**
     * @throws MalformedDomainException
     */
    public function setLdhName(string $ldhName): static
    {
        $this->ldhName = RDAPService::convertToIdn($ldhName);

        return $this;
    }

    public function getHandle(): ?string
    {
        return $this->handle;
    }

    public function setHandle(string $handle): static
    {
        $this->handle = $handle;

        return $this;
    }

    /**
     * @return Collection<int, DomainEvent>
     */
    public function getEvents(): Collection
    {
        return $this->events;
    }

    public function addEvent(DomainEvent $event): static
    {
        if (!$this->events->contains($event)) {
            $this->events->add($event);
            $event->setDomain($this);
        }

        return $this;
    }

    public function removeEvent(DomainEvent $event): static
    {
        if ($this->events->removeElement($event)) {
            // set the owning side to null (unless already changed)
            if ($event->getDomain() === $this) {
                $event->setDomain(null);
            }
        }

        return $this;
    }

    /**
     * @return Collection<int, DomainEntity>
     */
    public function getDomainEntities(): Collection
    {
        return $this->domainEntities;
    }

    public function addDomainEntity(DomainEntity $domainEntity): static
    {
        if (!$this->domainEntities->contains($domainEntity)) {
            $this->domainEntities->add($domainEntity);
            $domainEntity->setDomain($this);
        }

        return $this;
    }

    public function removeDomainEntity(DomainEntity $domainEntity): static
    {
        if ($this->domainEntities->removeElement($domainEntity)) {
            // set the owning side to null (unless already changed)
            if ($domainEntity->getDomain() === $this) {
                $domainEntity->setDomain(null);
            }
        }

        return $this;
    }

    public function getStatus(): array
    {
        return $this->status;
    }

    public function setStatus(array $status): static
    {
        $this->status = $status;

        return $this;
    }

    /**
     * @return Collection<int, Watchlist>
     */
    public function getWatchlists(): Collection
    {
        return $this->watchlists;
    }

    public function addWatchlists(Watchlist $watchlist): static
    {
        if (!$this->watchlists->contains($watchlist)) {
            $this->watchlists->add($watchlist);
            $watchlist->addDomain($this);
        }

        return $this;
    }

    public function removeWatchlists(Watchlist $watchlist): static
    {
        if ($this->watchlists->removeElement($watchlist)) {
            $watchlist->removeDomain($this);
        }

        return $this;
    }

    /**
     * @return Collection<int, Nameserver>
     */
    public function getNameservers(): Collection
    {
        return $this->nameservers;
    }

    public function addNameserver(Nameserver $nameserver): static
    {
        if (!$this->nameservers->contains($nameserver)) {
            $this->nameservers->add($nameserver);
        }

        return $this;
    }

    public function removeNameserver(Nameserver $nameserver): static
    {
        $this->nameservers->removeElement($nameserver);

        return $this;
    }

    public function getUpdatedAt(): ?\DateTimeImmutable
    {
        return $this->updatedAt;
    }

    #[ORM\PrePersist]
    #[ORM\PreUpdate]
    public function updateTimestamps(): static
    {
        $this->setUpdatedAt(new \DateTimeImmutable('now'));
        if (null === $this->getCreatedAt()) {
            $this->setCreatedAt($this->getUpdatedAt());
        }

        return $this;
    }

    public function setUpdatedAt(?\DateTimeImmutable $updatedAt): void
    {
        $this->updatedAt = $updatedAt;
    }

    public function getCreatedAt(): ?\DateTimeImmutable
    {
        return $this->createdAt;
    }

    private function setCreatedAt(?\DateTimeImmutable $createdAt): void
    {
        $this->createdAt = $createdAt;
    }

    public function getTld(): ?Tld
    {
        return $this->tld;
    }

    public function setTld(?Tld $tld): static
    {
        $this->tld = $tld;

        return $this;
    }

    public function getDeleted(): ?bool
    {
        return $this->deleted;
    }

    public function setDeleted(?bool $deleted): static
    {
        $this->deleted = $deleted;

        return $this;
    }

    /**
     * Determines if a domain name needs special attention.
     * These domain names are those whose last event was expiration or deletion.
     *
     * @throws \Exception
     */
    public function isToBeWatchClosely(): bool
    {
        $status = $this->getStatus();
        if ((!empty($status) && count(array_intersect($status, self::IMPORTANT_STATUS))) || $this->getDeleted()) {
            return true;
        }

        /** @var DomainEvent[] $events */
        $events = $this->getEvents()
            ->filter(fn (DomainEvent $e) => !$e->getDeleted() && $e->getDate() <= new \DateTimeImmutable('now'))
            ->toArray();

        usort($events, fn (DomainEvent $e1, DomainEvent $e2) => $e2->getDate() <=> $e1->getDate());

        return !empty($events) && in_array($events[0]->getAction(), self::IMPORTANT_EVENTS);
    }

    /**
     * @return Collection<int, DomainStatus>
     */
    public function getDomainStatuses(): Collection
    {
        return $this->domainStatuses;
    }

    public function addDomainStatus(DomainStatus $domainStatus): static
    {
        if (!$this->domainStatuses->contains($domainStatus)) {
            $this->domainStatuses->add($domainStatus);
            $domainStatus->setDomain($this);
        }

        return $this;
    }

    public function removeDomainStatus(DomainStatus $domainStatus): static
    {
        if ($this->domainStatuses->removeElement($domainStatus)) {
            // set the owning side to null (unless already changed)
            if ($domainStatus->getDomain() === $this) {
                $domainStatus->setDomain(null);
            }
        }

        return $this;
    }

    public function getRdapServer(): ?RdapServer
    {
        return $this->rdapServer;
    }

    public function setRdapServer(?RdapServer $rdapServer): static
    {
        $this->rdapServer = $rdapServer;

        return $this;
    }

    public function isDelegationSigned(): ?bool
    {
        return $this->delegationSigned;
    }

    public function setDelegationSigned(bool $delegationSigned): static
    {
        $this->delegationSigned = $delegationSigned;

        return $this;
    }

    public function isRedemptionPeriod(): bool
    {
        return in_array('redemption period', $this->getStatus());
    }

    public function isPendingDelete(): bool
    {
        return in_array('pending delete', $this->getStatus()) && !in_array('redemption period', $this->getStatus());
    }

    /**
     * @return Collection<int, DnsKey>
     */
    public function getDnsKey(): Collection
    {
        return $this->dnsKey;
    }

    public function addDnsKey(DnsKey $dnsKey): static
    {
        if (!$this->dnsKey->contains($dnsKey)) {
            $this->dnsKey->add($dnsKey);
            $dnsKey->setDomain($this);
        }

        return $this;
    }

    public function removeDnsKey(DnsKey $dnsKey): static
    {
        if ($this->dnsKey->removeElement($dnsKey)) {
            // set the owning side to null (unless already changed)
            if ($dnsKey->getDomain() === $this) {
                $dnsKey->setDomain(null);
            }
        }

        return $this;
    }

    #[Groups(['domain:item', 'domain:list'])]
    public function getExpiresInDays(): ?int
    {
        return $this->expiresInDays;
    }

    public function setExpiresInDays(?int $expiresInDays): static
    {
        $this->expiresInDays = $expiresInDays;

        return $this;
    }

    /**
     * @return Collection<int, DomainPurchase>
     */
    public function getDomainPurchases(): Collection
    {
        return $this->domainPurchases;
    }

    public function addDomainPurchase(DomainPurchase $domainPurchase): static
    {
        if (!$this->domainPurchases->contains($domainPurchase)) {
            $this->domainPurchases->add($domainPurchase);
            $domainPurchase->setDomain($this);
        }

        return $this;
    }

    public function removeDomainPurchase(DomainPurchase $domainPurchase): static
    {
        if ($this->domainPurchases->removeElement($domainPurchase)) {
            // set the owning side to null (unless already changed)
            if ($domainPurchase->getDomain() === $this) {
                $domainPurchase->setDomain(null);
            }
        }

        return $this;
    }

    #[Groups(['domain:item', 'domain:list'])]
    public function getPurchaseCount(): ?int
    {
        return $this->domainPurchases->count();
    }
}