AzuraCast/src/Entity/Station.php

<?php

declare(strict_types=1);

namespace App\Entity;

use App\Entity\Interfaces\EntityGroupsInterface;
use App\Entity\Interfaces\IdentifiableEntityInterface;
use App\Environment;
use App\Normalizer\Attributes\DeepNormalize;
use App\Radio\Adapters;
use App\Utilities\File;
use App\Validator\Constraints as AppAssert;
use DateTimeZone;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use InvalidArgumentException;
use League\Flysystem\UnixVisibility\PortableVisibilityConverter;
use OpenApi\Annotations as OA;
use RuntimeException;
use Stringable;
use Symfony\Component\Serializer\Annotation as Serializer;
use Symfony\Component\Validator\Constraints as Assert;

/** @OA\Schema(type="object", schema="Station") */
#[
    ORM\Entity,
    ORM\Table(name: 'station'),
    ORM\Index(columns: ['short_name'], name: 'idx_short_name'),
    ORM\HasLifecycleCallbacks,
    Attributes\Auditable,
    AppAssert\StationPortChecker,
    AppAssert\UniqueEntity(fields: ['short_name'])
]
class Station implements Stringable, IdentifiableEntityInterface
{
    use Traits\HasAutoIncrementId;
    use Traits\TruncateStrings;

    // Taxonomical groups for permission-based serialization.
    public const GROUP_AUTOMATION = 'automation';

    /**
     * @OA\Property(
     *     description="The full display name of the station.",
     *     example="AzuraTest Radio"
     * )
     */
    #[ORM\Column(length: 100, nullable: false)]
    #[Assert\NotBlank]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected string $name = '';

    /**
     * @OA\Property(
     *     description="The URL-friendly name for the station, typically auto-generated from the full station name.",
     *     example="azuratest_radio"
     * )
     */
    #[ORM\Column(length: 100, nullable: false)]
    #[Assert\NotBlank]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected string $short_name = '';

    /**
     * @OA\Property(
     *     description="If set to 'false', prevents the station from broadcasting but leaves it in the database.",
     *     example=true
     * )
     */
    #[ORM\Column]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_ADMIN, EntityGroupsInterface::GROUP_ALL])]
    protected bool $is_enabled = true;

    /**
     * @OA\Property(
     *     description="The frontend adapter (icecast,shoutcast,remote,etc)",
     *     example="icecast"
     * )
     */
    #[ORM\Column(length: 100, nullable: true)]
    #[Assert\Choice(choices: [Adapters::FRONTEND_ICECAST, Adapters::FRONTEND_REMOTE, Adapters::FRONTEND_SHOUTCAST])]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $frontend_type = Adapters::FRONTEND_ICECAST;

    /**
     * @OA\Property(
     *     type="array",
     *     description="An array containing station-specific frontend configuration",
     *     @OA\Items()
     * )
     */
    #[ORM\Column(type: 'json', nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?array $frontend_config = null;

    /**
     * @OA\Property(
     *     description="The backend adapter (liquidsoap,etc)",
     *     example="liquidsoap"
     * )
     */
    #[ORM\Column(length: 100, nullable: true)]
    #[Assert\Choice(choices: [Adapters::BACKEND_LIQUIDSOAP, Adapters::BACKEND_NONE])]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $backend_type = Adapters::BACKEND_LIQUIDSOAP;

    /**
     * @OA\Property(
     *     type="array",
     *     description="An array containing station-specific backend configuration",
     *     @OA\Items()
     * )
     */
    #[ORM\Column(type: 'json', nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?array $backend_config = null;

    #[ORM\Column(length: 150, nullable: true)]
    #[Attributes\AuditIgnore]
    protected ?string $adapter_api_key = null;

    /** @OA\Property(example="A sample radio station.") */
    #[ORM\Column(type: 'text', nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $description = null;

    /** @OA\Property(example="https://demo.azuracast.com/") */
    #[ORM\Column(length: 255, nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $url = null;

    /** @OA\Property(example="Various") */
    #[ORM\Column(length: 150, nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $genre = null;

    /** @OA\Property(example="/var/azuracast/stations/azuratest_radio") */
    #[ORM\Column(length: 255, nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_ADMIN, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $radio_base_dir = null;

    #[ORM\Column(type: 'array', nullable: true)]
    #[Attributes\AuditIgnore]
    protected mixed $nowplaying;

    #[ORM\Column(nullable: true)]
    #[Attributes\AuditIgnore]
    protected ?int $nowplaying_timestamp = null;

    /** @OA\Property(type="array", @OA\Items()) */
    #[ORM\Column(type: 'json', nullable: true)]
    #[Serializer\Groups([self::GROUP_AUTOMATION, EntityGroupsInterface::GROUP_ALL])]
    protected ?array $automation_settings = null;

    #[ORM\Column(nullable: true)]
    #[Attributes\AuditIgnore]
    #[Serializer\Groups([self::GROUP_AUTOMATION, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $automation_timestamp = 0;

    /**
     * @OA\Property(
     *     description="Whether listeners can request songs to play on this station.",
     *     example=true
     * )
     */
    #[ORM\Column]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected bool $enable_requests = false;

    /** @OA\Property(example=5) */
    #[ORM\Column(nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $request_delay = 5;

    /** @OA\Property(example=15) */
    #[ORM\Column(nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $request_threshold = 15;

    /** @OA\Property(example=0) */
    #[ORM\Column(nullable: true, options: ['default' => 0])]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $disconnect_deactivate_streamer = 0;

    /**
     * @OA\Property(
     *     description="Whether streamers are allowed to broadcast to this station at all.",
     *     example=false
     * )
     */
    #[ORM\Column]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected bool $enable_streamers = false;

    /**
     * @OA\Property(
     *     description="Whether a streamer is currently active on the station.",
     *     example=false
     * )
     */
    #[ORM\Column]
    #[Attributes\AuditIgnore]
    protected bool $is_streamer_live = false;

    /**
     * @OA\Property(
     *     description="Whether this station is visible as a public page and in a now-playing API response.",
     *     example=true
     * )
     */
    #[ORM\Column]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected bool $enable_public_page = true;

    /**
     * @OA\Property(
     *     description="Whether this station has a public 'on-demand' streaming and download page.",
     *     example=true
     * )
     */
    #[ORM\Column]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected bool $enable_on_demand = false;

    /**
     * @OA\Property(
     *     description="Whether the 'on-demand' page offers download capability.",
     *     example=true
     * )
     */
    #[ORM\Column]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected bool $enable_on_demand_download = true;

    #[ORM\Column]
    #[Attributes\AuditIgnore]
    protected bool $needs_restart = false;

    #[ORM\Column]
    #[Attributes\AuditIgnore]
    protected bool $has_started = false;

    /**
     * @OA\Property(
     *     description="The number of 'last played' history items to show for a station in API responses.",
     *     example=5
     * )
     */
    #[ORM\Column(type: 'smallint')]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected int $api_history_items = 5;

    /**
     * @OA\Property(
     *     description="The time zone that station operations should take place in.",
     *     example="UTC"
     * )
     */
    #[ORM\Column(length: 100, nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $timezone = 'UTC';

    /**
     * @OA\Property(
     *     description="The station-specific default album artwork URL.",
     *     example="https://example.com/image.jpg"
     * )
     */
    #[ORM\Column(length: 255, nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_GENERAL, EntityGroupsInterface::GROUP_ALL])]
    protected ?string $default_album_art_url = null;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: SongHistory::class)]
    #[ORM\OrderBy(['timestamp_start' => 'desc'])]
    protected Collection $history;

    #[ORM\Column(nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_ADMIN, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $media_storage_location_id = null;

    #[ORM\ManyToOne]
    #[ORM\JoinColumn(
        name: 'media_storage_location_id',
        referencedColumnName: 'id',
        nullable: true,
        onDelete: 'SET NULL'
    )]
    #[DeepNormalize(true)]
    #[Serializer\MaxDepth(1)]
    protected ?StorageLocation $media_storage_location = null;

    #[ORM\Column(nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_ADMIN, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $recordings_storage_location_id = null;

    #[ORM\ManyToOne]
    #[ORM\JoinColumn(
        name: 'recordings_storage_location_id',
        referencedColumnName: 'id',
        nullable: true,
        onDelete: 'SET NULL'
    )]
    #[DeepNormalize(true)]
    #[Serializer\MaxDepth(1)]
    protected ?StorageLocation $recordings_storage_location = null;

    #[ORM\Column(nullable: true)]
    #[Serializer\Groups([EntityGroupsInterface::GROUP_ADMIN, EntityGroupsInterface::GROUP_ALL])]
    protected ?int $podcasts_storage_location_id = null;

    #[ORM\ManyToOne]
    #[ORM\JoinColumn(
        name: 'podcasts_storage_location_id',
        referencedColumnName: 'id',
        nullable: true,
        onDelete: 'SET NULL'
    )]
    #[DeepNormalize(true)]
    #[Serializer\MaxDepth(1)]
    protected ?StorageLocation $podcasts_storage_location = null;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: StationStreamer::class)]
    protected Collection $streamers;

    #[ORM\Column(nullable: true)]
    protected ?int $current_streamer_id = null;

    #[ORM\ManyToOne]
    #[ORM\JoinColumn(name: 'current_streamer_id', referencedColumnName: 'id', nullable: true, onDelete: 'SET NULL')]
    protected ?StationStreamer $current_streamer = null;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: RolePermission::class)]
    protected Collection $permissions;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: StationPlaylist::class)]
    #[ORM\OrderBy(['type' => 'ASC', 'weight' => 'DESC'])]
    protected Collection $playlists;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: StationMount::class)]
    protected Collection $mounts;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: StationRemote::class)]
    protected Collection $remotes;

    #[ORM\OneToMany(
        mappedBy: 'station',
        targetEntity: StationWebhook::class,
        cascade: ['persist'],
        fetch: 'EXTRA_LAZY'
    )]
    protected Collection $webhooks;

    #[ORM\OneToMany(mappedBy: 'station', targetEntity: SftpUser::class)]
    protected Collection $sftp_users;

    public function __construct()
    {
        $this->history = new ArrayCollection();
        $this->playlists = new ArrayCollection();
        $this->mounts = new ArrayCollection();
        $this->remotes = new ArrayCollection();
        $this->webhooks = new ArrayCollection();
        $this->streamers = new ArrayCollection();
        $this->sftp_users = new ArrayCollection();
    }

    public function getName(): ?string
    {
        return $this->name;
    }

    public function setName(string $name): void
    {
        $this->name = $this->truncateString($name, 100);

        if (empty($this->short_name) && !empty($name)) {
            $this->setShortName(self::getStationShortName($name));
        }
    }

    public function getShortName(): string
    {
        return (!empty($this->short_name))
            ? $this->short_name
            : self::getStationShortName($this->name);
    }

    public function setShortName(string $shortName): void
    {
        $shortName = trim($shortName);
        if (empty($shortName)) {
            $shortName = $this->name;
        }

        $shortName = self::getStationShortName($shortName);
        $this->short_name = $this->truncateString($shortName, 100);
    }

    public static function getStationShortName(string $str): string
    {
        return File::sanitizeFileName($str);
    }

    public function setIsEnabled(bool $is_enabled): void
    {
        $this->is_enabled = $is_enabled;
    }

    public function getFrontendType(): ?string
    {
        return $this->frontend_type;
    }

    public function setFrontendType(?string $frontend_type = null): void
    {
        $this->frontend_type = $frontend_type;
    }

    public function getFrontendConfig(): StationFrontendConfiguration
    {
        return new StationFrontendConfiguration((array)$this->frontend_config);
    }

    /**
     * @param array|StationFrontendConfiguration $frontend_config
     * @param bool $force_overwrite
     */
    public function setFrontendConfig(
        StationFrontendConfiguration|array $frontend_config,
        bool $force_overwrite = false
    ): void {
        if (!($frontend_config instanceof StationFrontendConfiguration)) {
            $config = new StationFrontendConfiguration(
                ($force_overwrite) ? [] : (array)$this->frontend_config,
            );

            foreach ($frontend_config as $key => $val) {
                $config->set($key, $val);
            }

            $frontend_config = $config;
        }

        $config = $frontend_config->toArray();

        if ($this->frontend_config != $config) {
            $this->setNeedsRestart(true);
        }

        $this->frontend_config = $config;
    }

    public function getBackendType(): ?string
    {
        return $this->backend_type;
    }

    public function setBackendType(string $backend_type = null): void
    {
        $this->backend_type = $backend_type;
    }

    /**
     * Whether the station uses AzuraCast to directly manage the AutoDJ or lets the backend handle it.
     */
    public function useManualAutoDJ(): bool
    {
        return $this->getBackendConfig()->useManualAutoDj();
    }

    public function getBackendConfig(): StationBackendConfiguration
    {
        return new StationBackendConfiguration((array)$this->backend_config);
    }

    /**
     * @param array|StationBackendConfiguration $backend_config
     * @param bool $force_overwrite
     */
    public function setBackendConfig(
        StationBackendConfiguration|array $backend_config,
        bool $force_overwrite = false
    ): void {
        if (!($backend_config instanceof StationBackendConfiguration)) {
            $config = new StationBackendConfiguration(
                ($force_overwrite) ? [] : (array)$this->backend_config
            );

            foreach ($backend_config as $key => $val) {
                $config->set($key, $val);
            }

            $backend_config = $config;
        }

        $config = $backend_config->toArray();

        if ($this->backend_config != $config) {
            $this->setNeedsRestart(true);
        }

        $this->backend_config = $config;
    }

    public function getAdapterApiKey(): ?string
    {
        return $this->adapter_api_key;
    }

    /**
     * Generate a random new adapter API key.
     */
    public function generateAdapterApiKey(): void
    {
        $this->adapter_api_key = bin2hex(random_bytes(50));
    }

    /**
     * Authenticate the supplied adapter API key.
     *
     * @param string $api_key
     */
    public function validateAdapterApiKey(string $api_key): bool
    {
        return hash_equals($api_key, $this->adapter_api_key ?? '');
    }

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

    public function setDescription(string $description = null): void
    {
        $this->description = $description;
    }

    public function getUrl(): ?string
    {
        return $this->url;
    }

    public function setUrl(string $url = null): void
    {
        $this->url = $this->truncateNullableString($url);
    }

    public function getGenre(): ?string
    {
        return $this->genre;
    }

    public function setGenre(?string $genre): void
    {
        $this->genre = $this->truncateNullableString($genre, 150);
    }

    public function getRadioBaseDir(): string
    {
        if (null === $this->radio_base_dir) {
            $this->setRadioBaseDir();
        }

        return (string)$this->radio_base_dir;
    }

    public function setRadioBaseDir(?string $newDir = null): void
    {
        $newDir = $this->truncateNullableString(trim($newDir ?? ''));

        if (empty($newDir)) {
            $stationsBaseDir = Environment::getInstance()->getStationDirectory();
            $newDir = $stationsBaseDir . '/' . $this->getShortName();
        }

        $this->radio_base_dir = $newDir;
    }

    public function ensureDirectoriesExist(): void
    {
        // Flysystem adapters will automatically create the main directory.
        $this->ensureDirectoryExists($this->getRadioBaseDir());
        $this->ensureDirectoryExists($this->getRadioPlaylistsDir());
        $this->ensureDirectoryExists($this->getRadioConfigDir());
        $this->ensureDirectoryExists($this->getRadioTempDir());

        if (null === $this->media_storage_location) {
            $storageLocation = new StorageLocation(
                StorageLocation::TYPE_STATION_MEDIA,
                StorageLocation::ADAPTER_LOCAL
            );

            $mediaPath = $this->getRadioBaseDir() . '/media';
            $this->ensureDirectoryExists($mediaPath);
            $storageLocation->setPath($mediaPath);

            $this->media_storage_location = $storageLocation;
        }

        if (null === $this->recordings_storage_location) {
            $storageLocation = new StorageLocation(
                StorageLocation::TYPE_STATION_RECORDINGS,
                StorageLocation::ADAPTER_LOCAL
            );

            $recordingsPath = $this->getRadioBaseDir() . '/recordings';
            $this->ensureDirectoryExists($recordingsPath);
            $storageLocation->setPath($recordingsPath);

            $this->recordings_storage_location = $storageLocation;
        }

        if (null === $this->podcasts_storage_location) {
            $storageLocation = new StorageLocation(
                StorageLocation::TYPE_STATION_PODCASTS,
                StorageLocation::ADAPTER_LOCAL
            );

            $podcastsPath = $this->getRadioBaseDir() . '/podcasts';
            $this->ensureDirectoryExists($podcastsPath);
            $storageLocation->setPath($podcastsPath);

            $this->podcasts_storage_location = $storageLocation;
        }
    }

    protected function ensureDirectoryExists(string $dirname): void
    {
        if (is_dir($dirname)) {
            return;
        }

        $visibility = (new PortableVisibilityConverter())->defaultForDirectories();
        if (!mkdir($dirname, $visibility, true) && !is_dir($dirname)) {
            throw new RuntimeException(sprintf('Directory "%s" was not created', $dirname));
        }

        clearstatcache(false, $dirname);
    }

    public function getRadioPlaylistsDir(): string
    {
        return $this->radio_base_dir . '/playlists';
    }

    public function getRadioConfigDir(): string
    {
        return $this->radio_base_dir . '/config';
    }

    public function getRadioTempDir(): string
    {
        return $this->radio_base_dir . '/temp';
    }

    public function getNowplaying(): ?Api\NowPlaying\NowPlaying
    {
        if ($this->nowplaying instanceof Api\NowPlaying\NowPlaying) {
            return $this->nowplaying;
        }
        return null;
    }

    public function setNowplaying(?Api\NowPlaying\NowPlaying $nowplaying = null): void
    {
        $this->nowplaying = $nowplaying;

        if (null !== $nowplaying) {
            $this->nowplaying_timestamp = time();
        }
    }

    public function getNowplayingTimestamp(): int
    {
        return (int)$this->nowplaying_timestamp;
    }

    public function setNowPlayingTimestamp(int $nowplaying_timestamp): void
    {
        $this->nowplaying_timestamp = $nowplaying_timestamp;
    }

    /**
     * @return mixed[]|null
     */
    public function getAutomationSettings(): ?array
    {
        return $this->automation_settings;
    }

    public function setAutomationSettings(array $automation_settings = null): void
    {
        $this->automation_settings = $automation_settings;
    }

    public function getAutomationTimestamp(): ?int
    {
        return $this->automation_timestamp;
    }

    public function setAutomationTimestamp(int $automation_timestamp = null): void
    {
        $this->automation_timestamp = $automation_timestamp;
    }

    public function getEnableRequests(): bool
    {
        return $this->enable_requests;
    }

    public function setEnableRequests(bool $enable_requests): void
    {
        $this->enable_requests = $enable_requests;
    }

    public function getRequestDelay(): ?int
    {
        return $this->request_delay;
    }

    public function setRequestDelay(int $request_delay = null): void
    {
        $this->request_delay = $request_delay;
    }

    public function getRequestThreshold(): ?int
    {
        return $this->request_threshold;
    }

    public function setRequestThreshold(int $request_threshold = null): void
    {
        $this->request_threshold = $request_threshold;
    }

    public function getDisconnectDeactivateStreamer(): ?int
    {
        return $this->disconnect_deactivate_streamer;
    }

    public function setDisconnectDeactivateStreamer(?int $disconnect_deactivate_streamer): void
    {
        $this->disconnect_deactivate_streamer = $disconnect_deactivate_streamer;
    }

    public function getEnableStreamers(): bool
    {
        return $this->enable_streamers;
    }

    public function setEnableStreamers(bool $enable_streamers): void
    {
        if ($this->enable_streamers !== $enable_streamers) {
            $this->setNeedsRestart(true);
        }

        $this->enable_streamers = $enable_streamers;
    }

    public function getIsStreamerLive(): bool
    {
        return $this->is_streamer_live;
    }

    public function setIsStreamerLive(bool $is_streamer_live): void
    {
        $this->is_streamer_live = $is_streamer_live;
    }

    public function getEnablePublicPage(): bool
    {
        return $this->enable_public_page && $this->getIsEnabled();
    }

    public function setEnablePublicPage(bool $enable_public_page): void
    {
        $this->enable_public_page = $enable_public_page;
    }

    public function getEnableOnDemand(): bool
    {
        return $this->enable_on_demand;
    }

    public function setEnableOnDemand(bool $enable_on_demand): void
    {
        $this->enable_on_demand = $enable_on_demand;
    }

    public function getEnableOnDemandDownload(): bool
    {
        return $this->enable_on_demand_download;
    }

    public function setEnableOnDemandDownload(bool $enable_on_demand_download): void
    {
        $this->enable_on_demand_download = $enable_on_demand_download;
    }

    public function getIsEnabled(): bool
    {
        return $this->is_enabled;
    }

    public function getNeedsRestart(): bool
    {
        return $this->needs_restart;
    }

    public function setNeedsRestart(bool $needs_restart): void
    {
        $this->needs_restart = $needs_restart;
    }

    public function getHasStarted(): bool
    {
        return $this->has_started;
    }

    public function setHasStarted(bool $has_started): void
    {
        $this->has_started = $has_started;
    }

    public function getApiHistoryItems(): int
    {
        return $this->api_history_items ?? 5;
    }

    public function setApiHistoryItems(int $api_history_items): void
    {
        $this->api_history_items = $api_history_items;
    }

    public function getTimezone(): string
    {
        if (!empty($this->timezone)) {
            return $this->timezone;
        }

        return 'UTC';
    }

    public function getTimezoneObject(): DateTimeZone
    {
        return new DateTimeZone($this->getTimezone());
    }

    public function setTimezone(?string $timezone): void
    {
        $this->timezone = $timezone;
    }

    public function getDefaultAlbumArtUrl(): ?string
    {
        return $this->default_album_art_url;
    }

    /**
     * @param string|null $default_album_art_url
     */
    public function setDefaultAlbumArtUrl(?string $default_album_art_url): void
    {
        $this->default_album_art_url = $default_album_art_url;
    }

    /**
     * @return Collection<SongHistory>
     */
    public function getHistory(): Collection
    {
        return $this->history;
    }

    /**
     * @return Collection<StationStreamer>
     */
    public function getStreamers(): Collection
    {
        return $this->streamers;
    }

    public function getCurrentStreamer(): ?StationStreamer
    {
        return $this->current_streamer;
    }

    public function setCurrentStreamer(?StationStreamer $current_streamer = null): void
    {
        if (null !== $this->current_streamer || null !== $current_streamer) {
            $this->current_streamer = $current_streamer;
        }
    }

    public function getMediaStorageLocationId(): ?int
    {
        return $this->media_storage_location_id;
    }

    public function setMediaStorageLocationId(?int $media_storage_location_id): void
    {
        $this->media_storage_location_id = $media_storage_location_id;
    }

    public function getMediaStorageLocation(): StorageLocation
    {
        if (null === $this->media_storage_location) {
            throw new \RuntimeException('Media storage location has not been configured yet.');
        }

        return $this->media_storage_location;
    }

    public function setMediaStorageLocation(StorageLocation $storageLocation): void
    {
        if (StorageLocation::TYPE_STATION_MEDIA !== $storageLocation->getType()) {
            throw new InvalidArgumentException('Storage location must be for station media.');
        }

        $this->media_storage_location = $storageLocation;
    }

    public function getRecordingsStorageLocationId(): ?int
    {
        return $this->recordings_storage_location_id;
    }

    public function setRecordingsStorageLocationId(?int $recordings_storage_location_id): void
    {
        $this->recordings_storage_location_id = $recordings_storage_location_id;
    }

    public function getRecordingsStorageLocation(): StorageLocation
    {
        if (null === $this->recordings_storage_location) {
            throw new \RuntimeException('Recordings storage location has not been configured yet.');
        }

        return $this->recordings_storage_location;
    }

    public function setRecordingsStorageLocation(StorageLocation $storageLocation): void
    {
        if (StorageLocation::TYPE_STATION_RECORDINGS !== $storageLocation->getType()) {
            throw new InvalidArgumentException('Storage location must be for station live recordings.');
        }

        $this->recordings_storage_location = $storageLocation;
    }

    public function getPodcastsStorageLocationId(): ?int
    {
        return $this->podcasts_storage_location_id;
    }

    public function setPodcastsStorageLocationId(?int $podcasts_storage_location_id): void
    {
        $this->podcasts_storage_location_id = $podcasts_storage_location_id;
    }

    public function getPodcastsStorageLocation(): StorageLocation
    {
        if (null === $this->podcasts_storage_location) {
            throw new \RuntimeException('Podcasts storage location has not been configured yet.');
        }

        return $this->podcasts_storage_location;
    }

    public function setPodcastsStorageLocation(StorageLocation $storageLocation): void
    {
        if (StorageLocation::TYPE_STATION_PODCASTS !== $storageLocation->getType()) {
            throw new InvalidArgumentException('Storage location must be for station podcasts.');
        }

        $this->podcasts_storage_location = $storageLocation;
    }

    /** @return StorageLocation[] */
    public function getAllStorageLocations(): array
    {
        return [
            $this->getMediaStorageLocation(),
            $this->getRecordingsStorageLocation(),
            $this->getPodcastsStorageLocation(),
        ];
    }

    public static function getStorageLocationTypes(): array
    {
        return [
            'media_storage_location'      => StorageLocation::TYPE_STATION_MEDIA,
            'recordings_storage_location' => StorageLocation::TYPE_STATION_RECORDINGS,
            'podcasts_storage_location'   => StorageLocation::TYPE_STATION_PODCASTS,
        ];
    }

    /**
     * @return Collection<RolePermission>
     */
    public function getPermissions(): Collection
    {
        return $this->permissions;
    }

    /**
     * @return Collection<StationMedia>
     */
    public function getMedia(): Collection
    {
        return $this->getMediaStorageLocation()->getMedia();
    }

    /**
     * @return Collection<StationPlaylist>
     */
    public function getPlaylists(): Collection
    {
        return $this->playlists;
    }

    /**
     * @return Collection<StationMount>
     */
    public function getMounts(): Collection
    {
        return $this->mounts;
    }

    /**
     * @return Collection<StationRemote>
     */
    public function getRemotes(): Collection
    {
        return $this->remotes;
    }

    /**
     * @return Collection<StationWebhook>
     */
    public function getWebhooks(): Collection
    {
        return $this->webhooks;
    }

    /**
     * @return Collection<SftpUser>
     */
    public function getSftpUsers(): Collection
    {
        return $this->sftp_users;
    }

    public function clearCache(): void
    {
        $this->nowplaying = null;
        $this->nowplaying_timestamp = 0;
    }

    public function __toString(): string
    {
        $name = $this->getName();
        if (null !== $name) {
            return $name;
        }

        $id = $this->getId();
        return (null !== $id) ? 'Station #' . $id : 'New Station';
    }

    public function __clone()
    {
        $this->id = null;
        $this->short_name = '';
        $this->radio_base_dir = null;
        $this->adapter_api_key = null;
        $this->nowplaying = null;
        $this->nowplaying_timestamp = null;
        $this->current_streamer = null;
        $this->current_streamer_id = null;
        $this->is_streamer_live = false;
        $this->needs_restart = false;
        $this->has_started = false;

        $this->media_storage_location = null;
        $this->recordings_storage_location = null;
        $this->podcasts_storage_location = null;

        // Clear ports
        $fe_config = $this->getFrontendConfig();
        $fe_config->setPort(null);
        $this->setFrontendConfig($fe_config);

        $be_config = $this->getBackendConfig();
        $be_config->setDjPort(null);
        $be_config->setTelnetPort(null);
        $this->setBackendConfig($be_config);
    }
}