owncloud / music

lib/Db/PodcastChannel.php

<?php declare(strict_types=1);

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Pauli Järvinen <pauli.jarvinen@gmail.com>
 * @copyright Pauli Järvinen 2021 - 2025
 */

namespace OCA\Music\Db;

use OCA\Music\Utility\Util;
use OCP\IURLGenerator;

/**
 * @method string getRssUrl()
 * @method void setRssUrl(string $url)
 * @method string getRssHash()
 * @method void setRssHash(string $hash)
 * @method string getContentHash()
 * @method void setContentHash(string $hash)
 * @method string getUpdateChecked()
 * @method void setUpdateChecked(string $timestamp)
 * @method ?string getPublished()
 * @method void setPublished(?string $timestamp)
 * @method ?string getLastBuildDate()
 * @method void setLastBuildDate(?string $timestamp)
 * @method ?string getTitle()
 * @method void setTitle(?string $title)
 * @method ?string getLinkUrl()
 * @method void setLinkUrl(?string $url)
 * @method ?string getLanguage()
 * @method void setLanguage(?string $language)
 * @method ?string getCopyright()
 * @method void setCopyright(?string $copyright)
 * @method ?string getAuthor()
 * @method void setAuthor(?string $author)
 * @method ?string getDescription()
 * @method void setDescription(?string $description)
 * @method ?string getImageUrl()
 * @method void setImageUrl(?string $url)
 * @method ?string getCategory()
 * @method void setCategory(?string $category)
 * @method ?string getStarred()
 * @method void setStarred(?string $timestamp)
 * @method int getRating()
 * @method void setRating(int $rating)
 */
class PodcastChannel extends Entity {
	public string $rssUrl = '';
	public string $rssHash = '';
	public string $contentHash = '';
	public string $updateChecked = '';
	public ?string $published = null;
	public ?string $lastBuildDate = null;
	public ?string $title = null;
	public ?string $linkUrl = null;
	public ?string $language = null;
	public ?string $copyright = null;
	public ?string $author = null;
	public ?string $description = null;
	public ?string $imageUrl = null;
	public ?string $category = null;
	public ?string $starred = null;
	public int $rating = 0;

	// not part of the default content, may be injected separately
	/** @var ?PodcastEpisode[] $episodes */
	private ?array $episodes = null;

	public function __construct() {
		$this->addType('rating', 'int');
	}

	/**
	 * @return ?PodcastEpisode[]
	 */
	public function getEpisodes() : ?array {
		return $this->episodes;
	}

	/**
	 * @param PodcastEpisode[] $episodes
	 */
	public function setEpisodes(array $episodes) : void {
		$this->episodes = $episodes;
	}

	public function toApi(IURLGenerator $urlGenerator) : array {
		$result = [
			'id' => $this->getId(),
			'title' => $this->getTitle(),
			'image' => $this->createImageUrl($urlGenerator),
			'hash' => $this->getContentHash()
		];

		if ($this->episodes !== null) {
			$result['episodes'] = \array_map(fn($e) => $e->toApi($urlGenerator), $this->episodes);
		}

		return $result;
	}

	public function detailsToApi(IURLGenerator $urlGenerator) : array {
		return [
			'id' => $this->getId(),
			'title' => $this->getTitle(),
			'description' => $this->getDescription(),
			'image' => $this->createImageUrl($urlGenerator) . '?originalSize=true',
			'link_url' =>  $this->getLinkUrl(),
			'rss_url' => $this->getRssUrl(),
			'language' => $this->getLanguage(),
			'copyright' => $this->getCopyright(),
			'author' => $this->getAuthor(),
			'category' => $this->getCategory(),
			'published' => $this->getPublished(),
			'last_build_date' => $this->getLastBuildDate(),
			'update_checked' => $this->getUpdateChecked(),
		];
	}

	public function toAmpacheApi() : array {
		$result = [
			'id' => (string)$this->getId(),
			'name' => $this->getTitle(),
			'description' => $this->getDescription(),
			'language' => $this->getLanguage(),
			'copyright' => $this->getCopyright(),
			'feed_url' => $this->getRssUrl(),
			'build_date' => Util::formatDateTimeUtcOffset($this->getLastBuildDate()),
			'sync_date' => Util::formatDateTimeUtcOffset($this->getUpdateChecked()),
			'public_url' => $this->getLinkUrl(),
			'website' => $this->getLinkUrl(),
			'art' => $this->getImageUrl(),
			'has_art' => !empty($this->getImageUrl()),
			'flag' => !empty($this->getStarred()),
			'rating' => $this->getRating(),
			'preciserating' => $this->getRating(),
		];

		if ($this->episodes !== null) {
			$createImageUrl = fn($e) => $this->getImageUrl();

The parameter $e is not used and could be removed.

			$result['podcast_episode'] = \array_map(fn($e) => $e->toAmpacheApi($createImageUrl, null), $this->episodes);
		}

		return $result;
	}

	public function toSubsonicApi() : array {
		$result = [
			'id' => 'podcast_channel-' . $this->getId(),
			'url' => $this->getRssUrl(),
			'title' => $this->getTitle(),
			'description' => $this->getDescription(),
			'coverArt' => 'podcast_channel-' . $this->getId(),
			'originalImageUrl' => $this->getImageUrl(),
			'status' => 'completed',
			'starred' => Util::formatZuluDateTime($this->getStarred())
		];

		if ($this->episodes !== null) {
			$result['episode'] = \array_map(fn($e) => $e->toSubsonicApi(), $this->episodes);
		}

		return $result;
	}

	/**
	 * Create URL which loads the channel image via the cloud server. The URL handles down-scaling and caching automatically.
	 */
	private function createImageUrl(IURLGenerator $urlGenerator) : string {
		return $urlGenerator->linkToRoute('music.coverApi.podcastCover', ['channelId' => $this->getId()]);
	}
}