AzuraCast/src/Webhook/Connector/AbstractConnector.php

<?php

declare(strict_types=1);

namespace App\Webhook\Connector;

use App\Container\LoggerAwareTrait;
use App\Entity\Api\NowPlaying\NowPlaying;
use App\Entity\StationWebhook;
use App\Utilities;
use GuzzleHttp\Client;
use InvalidArgumentException;
use Psr\Http\Message\ResponseInterface;

abstract class AbstractConnector implements ConnectorInterface
{
    use LoggerAwareTrait;

    public function __construct(
        protected Client $httpClient
    ) {
    }

    /**
     * @inheritDoc
     */
    public function shouldDispatch(StationWebhook $webhook, array $triggers = []): bool
    {
        if (!$this->webhookShouldTrigger($webhook, $triggers)) {
            $this->logger->debug(
                sprintf(
                    'Webhook "%s" will not run for triggers: %s; skipping...',
                    $webhook->getName(),
                    implode(', ', $triggers)
                )
            );
            return false;
        }

        $rateLimitTime = $this->getRateLimitTime($webhook);
        if (null !== $rateLimitTime && !$webhook->checkRateLimit($rateLimitTime)) {
            $this->logger->notice(
                sprintf(
                    'Webhook "%s" has run less than %d seconds ago; skipping...',
                    $webhook->getName(),
                    $rateLimitTime
                )
            );
            return false;
        }

        return true;
    }

    /**
     * @param StationWebhook $webhook
     * @param array<string> $triggers
     *
     */
    protected function webhookShouldTrigger(StationWebhook $webhook, array $triggers = []): bool
    {
        if (!$webhook->hasTriggers()) {
            return true;
        }

        foreach ($triggers as $trigger) {
            if ($webhook->hasTrigger($trigger)) {
                return true;
            }
        }

        return false;
    }

    protected function getRateLimitTime(StationWebhook $webhook): ?int
    {
        return 10;
    }

    /**
     * Replace variables in the format {{ blah }} with the flattened contents of the NowPlaying API array.
     *
     * @param array $rawVars
     * @param NowPlaying $np
     *
     * @return array
     */
    public function replaceVariables(array $rawVars, NowPlaying $np): array
    {
        $values = Utilities\Arrays::flattenArray($np);
        $vars = [];

        foreach ($rawVars as $varKey => $varValue) {
            // Replaces {{ var.name }} with the flattened $values['var.name']
            $vars[$varKey] = preg_replace_callback(
                "/\{\{(\s*)([a-zA-Z\d\-_.]+)(\s*)}}/",
                static function ($matches) use ($values) {
                    $innerValue = strtolower(trim($matches[2]));
                    return $values[$innerValue] ?? '';
                },
                $varValue
            );
        }

        return $vars;
    }

    /**
     * Determine if a passed URL is valid and return it if so, or return null otherwise.
     *
     * @param string|null $urlString
     */
    protected function getValidUrl(?string $urlString = null): ?string
    {
        $uri = Utilities\Urls::tryParseUserUrl(
            $urlString,
            'Webhook'
        );

        if (null === $uri) {
            return null;
        }

        return (string)$uri;
    }

    protected function incompleteConfigException(StationWebhook $webhook): InvalidArgumentException
    {
        return new InvalidArgumentException(
            sprintf(
                'Webhook "%s" (type "%s") is missing necessary configuration. Skipping...',
                $webhook->getName(),
                $webhook->getType()->value
            ),
        );
    }

    protected function logHttpResponse(
        StationWebhook $webhook,
        ResponseInterface $response,
        mixed $requestBody = null
    ): void {
        if (204 !== $response->getStatusCode()) {
            $this->logger->error(
                sprintf(
                    'Webhook "%s" returned unsuccessful response code %d.',
                    $webhook->getName(),
                    $response->getStatusCode()
                )
            );
        }

        $debugLogInfo = [];
        if ($requestBody) {
            $debugLogInfo['message_sent'] = $requestBody;
        }
        $debugLogInfo['response_body'] = $response->getBody()->getContents();

        $this->logger->debug(
            sprintf(
                'Webhook "%s" returned response code %d',
                $webhook->getName(),
                $response->getStatusCode()
            ),
            $debugLogInfo
        );
    }
}