Add Captcha Management System

src/Socialbox/Enums/Status/CaptchaStatus.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Socialbox\Enums\Status;
+
+enum CaptchaStatus : string
+{
+     case UNSOLVED = 'UNSOLVED';
+     case SOLVED = 'SOLVED';
+}

src/Socialbox/Managers/CaptchaManager.php

@@ -0,0 +1,188 @@
+<?php
+
+namespace Socialbox\Managers;
+
+use DateTime;
+use DateTimeInterface;
+use PDOException;
+use Socialbox\Classes\Database;
+use Socialbox\Classes\Utilities;
+use Socialbox\Enums\Status\CaptchaStatus;
+use Socialbox\Exceptions\DatabaseOperationException;
+use Socialbox\Objects\Database\CaptchaRecord;
+use Socialbox\Objects\Database\RegisteredPeerRecord;
+
+class CaptchaManager
+{
+    /**
+     * Creates a new captcha for the given peer UUID.
+     *
+     * @param string|RegisteredPeerRecord $peer_uuid The UUID of the peer to create the captcha for.
+     * @return string The answer to the captcha.
+     * @throws DatabaseOperationException If the operation fails.
+     */
+    private static function createCaptcha(string|RegisteredPeerRecord $peer_uuid): string
+    {
+        // If the peer_uuid is a RegisteredPeerRecord, get the UUID
+        if($peer_uuid instanceof RegisteredPeerRecord)
+        {
+            $peer_uuid = $peer_uuid->getUuid();
+        }
+
+        $answer = Utilities::randomString(6, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789');
+
+        if(!self::captchaExists($peer_uuid))
+        {
+            $statement = Database::getConnection()->prepare("INSERT INTO captcha_images (peer_uuid, answer) VALUES (?, ?)");
+            $statement->bindParam(1, $peer_uuid);
+            $statement->bindParam(2, $answer);
+
+            try
+            {
+                $statement->execute();
+            }
+            catch(PDOException $e)
+            {
+                throw new DatabaseOperationException('Failed to create a captcha in the database', $e);
+            }
+
+            return $answer;
+        }
+
+        $statement = Database::getConnection()->prepare("UPDATE captcha_images SET answer=?, status='UNSOLVED', created=NOW() WHERE peer_uuid=?");
+        $statement->bindParam(1, $answer);
+        $statement->bindParam(2, $peer_uuid);
+
+        try
+        {
+            $statement->execute();
+        }
+        catch(PDOException $e)
+        {
+            throw new DatabaseOperationException('Failed to update a captcha in the database', $e);
+        }
+
+        return $answer;
+    }
+
+    /**
+     * Answers a captcha for the given peer UUID.
+     *
+     * @param string|RegisteredPeerRecord $peer_uuid The UUID of the peer to answer the captcha for.
+     * @param string $answer The answer to the captcha.
+     * @return bool True if the answer is correct, false otherwise.
+     * @throws DatabaseOperationException If the operation fails.
+     */
+    public static function answerCaptcha(string|RegisteredPeerRecord $peer_uuid, string $answer): bool
+    {
+        if($peer_uuid instanceof RegisteredPeerRecord)
+        {
+            $peer_uuid = $peer_uuid->getUuid();
+        }
+
+        // Return false if the captcha does not exist
+        if(!self::captchaExists($peer_uuid))
+        {
+            return false;
+        }
+
+        $captcha = self::getCaptcha($peer_uuid);
+
+        // Return false if the captcha has already been solved
+        if($captcha->getStatus() === CaptchaStatus::SOLVED)
+        {
+            return false;
+        }
+
+        // Return false if the captcha is older than 5 minutes
+        if ($captcha->getCreated() instanceof DateTimeInterface && $captcha->getCreated()->diff(new DateTime())->i > 5)
+        {
+            return false;
+        }
+
+        // Verify the answer
+        if($captcha->getAnswer() !== $answer)
+        {
+            return false;
+        }
+
+        $statement = Database::getConnection()->prepare("UPDATE captcha_images SET status='SOLVED', answered=NOW() WHERE peer_uuid=?");
+        $statement->bindParam(1, $peer_uuid);
+
+        try
+        {
+            $statement->execute();
+        }
+        catch(PDOException $e)
+        {
+            throw new DatabaseOperationException('Failed to update a captcha in the database', $e);
+        }
+
+        return true;
+    }
+
+    /**
+     * Retrieves the captcha record for the given peer UUID.
+     *
+     * @param string|RegisteredPeerRecord $peer_uuid The UUID of the peer to retrieve the captcha for.
+     * @return CaptchaRecord The captcha record.
+     * @throws DatabaseOperationException If the operation fails.
+     */
+    public static function getCaptcha(string|RegisteredPeerRecord $peer_uuid): CaptchaRecord
+    {
+        // If the peer_uuid is a RegisteredPeerRecord, get the UUID
+        if($peer_uuid instanceof RegisteredPeerRecord)
+        {
+            $peer_uuid = $peer_uuid->getUuid();
+        }
+
+        try
+        {
+            $statement = Database::getConnection()->prepare("SELECT * FROM captcha_images WHERE peer_uuid=? LIMIT 1");
+            $statement->bindParam(1, $peer_uuid);
+            $statement->execute();
+            $result = $statement->fetch();
+        }
+        catch(PDOException $e)
+        {
+            throw new DatabaseOperationException('Failed to get a captcha from the database', $e);
+        }
+
+        if($result === false)
+        {
+            throw new DatabaseOperationException('The requested captcha does not exist');
+        }
+
+        return CaptchaRecord::fromArray($result);
+    }
+
+    /**
+     * Checks if a captcha exists for the given peer UUID.
+     *
+     * @param string|RegisteredPeerRecord $peer_uuid The UUID of the peer to check for a captcha.
+     * @return bool True if a captcha exists, false otherwise.
+     * @throws DatabaseOperationException If the operation fails.
+     */
+    private static function captchaExists(string|RegisteredPeerRecord $peer_uuid): bool
+    {
+        // If the peer_uuid is a RegisteredPeerRecord, get the UUID
+        if($peer_uuid instanceof RegisteredPeerRecord)
+        {
+            $peer_uuid = $peer_uuid->getUuid();
+        }
+
+        try
+        {
+            $statement = Database::getConnection()->prepare("SELECT COUNT(*) FROM captcha_images WHERE peer_uuid=?");
+            $statement->bindParam(1, $peer_uuid);
+            $statement->execute();
+            $result = $statement->fetchColumn();
+        }
+        catch(PDOException $e)
+        {
+            throw new DatabaseOperationException('Failed to check if a captcha exists in the database', $e);
+        }
+
+        return $result > 0;
+    }
+}

src/Socialbox/Objects/Database/CaptchaRecord.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Socialbox\Objects\Database;
+
+use DateTime;
+use Socialbox\Enums\Status\CaptchaStatus;
+use Socialbox\Interfaces\SerializableInterface;
+
+class CaptchaRecord implements SerializableInterface
+{
+    private string $uuid;
+    private string $peerUuid;
+    private CaptchaStatus $status;
+    private ?string $answer;
+    private ?DateTime $answered;
+    private DateTime $created;
+
+    public function __construct(array $data)
+    {
+        $this->uuid = (string)$data['uuid'];
+        $this->peerUuid = (string)$data['peer_uuid'];
+        $this->status = CaptchaStatus::tryFrom((string)$data['status']);
+        $this->answer = isset($data['answer']) ? (string)$data['answer'] : null;
+        $this->answered = isset($data['answered']) ? new DateTime((string)$data['answered']) : null;
+        $this->created = new DateTime((string)$data['created']);
+    }
+
+    public function getUuid(): string
+    {
+        return $this->uuid;
+    }
+
+    public function getPeerUuid(): string
+    {
+        return $this->peerUuid;
+    }
+
+    public function getStatus(): CaptchaStatus
+    {
+        return $this->status;
+    }
+
+    public function getAnswer(): ?string
+    {
+        return $this->answer;
+    }
+
+    public function getAnswered(): ?DateTime
+    {
+        return $this->answered;
+    }
+
+    public function getCreated(): DateTime
+    {
+        return $this->created;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public static function fromArray(array $data): object
+    {
+        return new self($data);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toArray(): array
+    {
+        return [
+            'uuid' => $this->uuid,
+            'peer_uuid' => $this->peerUuid,
+            'status' => $this->status->value,
+            'answer' => $this->answer,
+            'answered' => $this->answered?->format('Y-m-d H:i:s'),
+            'created' => $this->created->format('Y-m-d H:i:s')
+        ];
+    }
+}