mirror of
https://github.com/AzuraCast/AzuraCast.git
synced 2024-06-14 21:26:37 +00:00
354 lines
12 KiB
PHP
354 lines
12 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace App\Controller\Api\Stations;
|
|
|
|
use App\Controller\Api\AbstractApiCrudController;
|
|
use App\Controller\Api\Traits\CanSearchResults;
|
|
use App\Controller\Api\Traits\CanSortResults;
|
|
use App\Entity\Api\PodcastEpisode as ApiPodcastEpisode;
|
|
use App\Entity\ApiGenerator\PodcastEpisodeApiGenerator;
|
|
use App\Entity\PodcastEpisode;
|
|
use App\Entity\Repository\PodcastEpisodeRepository;
|
|
use App\Http\Response;
|
|
use App\Http\ServerRequest;
|
|
use App\OpenApi;
|
|
use App\Paginator;
|
|
use App\Service\Flow\UploadedFile;
|
|
use Doctrine\Common\Collections\Order;
|
|
use InvalidArgumentException;
|
|
use OpenApi\Attributes as OA;
|
|
use Psr\Http\Message\ResponseInterface;
|
|
use Symfony\Component\Serializer\Serializer;
|
|
use Symfony\Component\Validator\Validator\ValidatorInterface;
|
|
|
|
/** @extends AbstractApiCrudController<PodcastEpisode> */
|
|
#[
|
|
OA\Get(
|
|
path: '/station/{station_id}/podcast/{podcast_id}/episodes',
|
|
operationId: 'getEpisodes',
|
|
description: 'List all current episodes for a given podcast ID.',
|
|
security: OpenApi::API_KEY_SECURITY,
|
|
tags: ['Stations: Podcasts'],
|
|
parameters: [
|
|
new OA\Parameter(ref: OpenApi::REF_STATION_ID_REQUIRED),
|
|
new OA\Parameter(
|
|
name: 'podcast_id',
|
|
description: 'Podcast ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Success',
|
|
content: new OA\JsonContent(
|
|
type: 'array',
|
|
items: new OA\Items(ref: '#/components/schemas/Api_PodcastEpisode')
|
|
)
|
|
),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
|
|
]
|
|
),
|
|
OA\Post(
|
|
path: '/station/{station_id}/podcast/{podcast_id}/episodes',
|
|
operationId: 'addEpisode',
|
|
description: 'Create a new podcast episode.',
|
|
security: OpenApi::API_KEY_SECURITY,
|
|
requestBody: new OA\RequestBody(
|
|
content: new OA\JsonContent(ref: '#/components/schemas/Api_PodcastEpisode')
|
|
),
|
|
tags: ['Stations: Podcasts'],
|
|
parameters: [
|
|
new OA\Parameter(ref: OpenApi::REF_STATION_ID_REQUIRED),
|
|
new OA\Parameter(
|
|
name: 'podcast_id',
|
|
description: 'Podcast ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Success',
|
|
content: new OA\JsonContent(ref: '#/components/schemas/Api_PodcastEpisode')
|
|
),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
|
|
]
|
|
),
|
|
OA\Get(
|
|
path: '/station/{station_id}/podcast/{podcast_id}/episode/{id}',
|
|
operationId: 'getEpisode',
|
|
description: 'Retrieve details for a single podcast episode.',
|
|
security: OpenApi::API_KEY_SECURITY,
|
|
tags: ['Stations: Podcasts'],
|
|
parameters: [
|
|
new OA\Parameter(ref: OpenApi::REF_STATION_ID_REQUIRED),
|
|
new OA\Parameter(
|
|
name: 'podcast_id',
|
|
description: 'Podcast ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
new OA\Parameter(
|
|
name: 'id',
|
|
description: 'Podcast Episode ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
],
|
|
responses: [
|
|
new OA\Response(
|
|
response: 200,
|
|
description: 'Success',
|
|
content: new OA\JsonContent(ref: '#/components/schemas/Api_PodcastEpisode')
|
|
),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
|
|
]
|
|
),
|
|
OA\Put(
|
|
path: '/station/{station_id}/podcast/{podcast_id}/episode/{id}',
|
|
operationId: 'editEpisode',
|
|
description: 'Update details of a single podcast episode.',
|
|
security: OpenApi::API_KEY_SECURITY,
|
|
requestBody: new OA\RequestBody(
|
|
content: new OA\JsonContent(ref: '#/components/schemas/Api_PodcastEpisode')
|
|
),
|
|
tags: ['Stations: Podcasts'],
|
|
parameters: [
|
|
new OA\Parameter(ref: OpenApi::REF_STATION_ID_REQUIRED),
|
|
new OA\Parameter(
|
|
name: 'podcast_id',
|
|
description: 'Podcast ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
new OA\Parameter(
|
|
name: 'id',
|
|
description: 'Podcast Episode ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
],
|
|
responses: [
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
|
|
]
|
|
),
|
|
OA\Delete(
|
|
path: '/station/{station_id}/podcast/{podcast_id}/episode/{id}',
|
|
operationId: 'deleteEpisode',
|
|
description: 'Delete a single podcast episode.',
|
|
security: OpenApi::API_KEY_SECURITY,
|
|
tags: ['Stations: Podcasts'],
|
|
parameters: [
|
|
new OA\Parameter(ref: OpenApi::REF_STATION_ID_REQUIRED),
|
|
new OA\Parameter(
|
|
name: 'podcast_id',
|
|
description: 'Podcast ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
new OA\Parameter(
|
|
name: 'id',
|
|
description: 'Podcast Episode ID',
|
|
in: 'path',
|
|
required: true,
|
|
schema: new OA\Schema(type: 'string')
|
|
),
|
|
],
|
|
responses: [
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_SUCCESS, response: 200),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_ACCESS_DENIED, response: 403),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_NOT_FOUND, response: 404),
|
|
new OA\Response(ref: OpenApi::REF_RESPONSE_GENERIC_ERROR, response: 500),
|
|
]
|
|
)
|
|
]
|
|
final class PodcastEpisodesController extends AbstractApiCrudController
|
|
{
|
|
use CanSearchResults;
|
|
use CanSortResults;
|
|
|
|
protected string $entityClass = PodcastEpisode::class;
|
|
protected string $resourceRouteName = 'api:stations:podcast:episode';
|
|
|
|
public function __construct(
|
|
private readonly PodcastEpisodeRepository $episodeRepository,
|
|
private readonly PodcastEpisodeApiGenerator $episodeApiGen,
|
|
Serializer $serializer,
|
|
ValidatorInterface $validator,
|
|
) {
|
|
parent::__construct($serializer, $validator);
|
|
}
|
|
|
|
public function listAction(
|
|
ServerRequest $request,
|
|
Response $response,
|
|
array $params
|
|
): ResponseInterface {
|
|
$podcast = $request->getPodcast();
|
|
|
|
$queryBuilder = $this->em->createQueryBuilder()
|
|
->select('e, p, pm')
|
|
->from(PodcastEpisode::class, 'e')
|
|
->join('e.podcast', 'p')
|
|
->leftJoin('e.media', 'pm')
|
|
->where('e.podcast = :podcast')
|
|
->orderBy('e.created_at', 'DESC')
|
|
->setParameter('podcast', $podcast);
|
|
|
|
$queryBuilder = $this->searchQueryBuilder(
|
|
$request,
|
|
$queryBuilder,
|
|
[
|
|
'e.title',
|
|
]
|
|
);
|
|
|
|
$episodes = array_map(
|
|
fn($row) => $this->viewRecord($row, $request),
|
|
$queryBuilder->getQuery()->getResult()
|
|
);
|
|
|
|
$episodes = $this->sortArray(
|
|
$request,
|
|
$episodes,
|
|
[
|
|
'is_published' => 'is_published',
|
|
'publish_at' => 'publish_at',
|
|
'is_explicit' => 'is_explicit',
|
|
],
|
|
'id',
|
|
Order::Descending
|
|
);
|
|
|
|
$paginator = Paginator::fromArray($episodes, $request);
|
|
return $paginator->write($response);
|
|
}
|
|
|
|
/**
|
|
* @return PodcastEpisode|null
|
|
*/
|
|
protected function getRecord(ServerRequest $request, array $params): ?object
|
|
{
|
|
/** @var string $id */
|
|
$id = $params['episode_id'];
|
|
|
|
return $this->episodeRepository->fetchEpisodeForPodcast(
|
|
$request->getPodcast(),
|
|
$id
|
|
);
|
|
}
|
|
|
|
protected function createRecord(ServerRequest $request, array $data): object
|
|
{
|
|
$station = $request->getStation();
|
|
$podcast = $request->getPodcast();
|
|
|
|
$record = $this->editRecord(
|
|
$data,
|
|
new PodcastEpisode($podcast)
|
|
);
|
|
|
|
if (!empty($data['artwork_file'])) {
|
|
$artwork = UploadedFile::fromArray($data['artwork_file'], $station->getRadioTempDir());
|
|
$this->episodeRepository->writeEpisodeArt(
|
|
$record,
|
|
$artwork->readAndDeleteUploadedFile()
|
|
);
|
|
|
|
$this->em->persist($record);
|
|
$this->em->flush();
|
|
}
|
|
|
|
if (!empty($data['media_file'])) {
|
|
$media = UploadedFile::fromArray($data['media_file'], $station->getRadioTempDir());
|
|
|
|
$this->episodeRepository->uploadMedia(
|
|
$record,
|
|
$media->getClientFilename(),
|
|
$media->getUploadedPath()
|
|
);
|
|
}
|
|
|
|
return $record;
|
|
}
|
|
|
|
protected function deleteRecord(object $record): void
|
|
{
|
|
$this->episodeRepository->delete($record);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected function viewRecord(object $record, ServerRequest $request): ApiPodcastEpisode
|
|
{
|
|
if (!($record instanceof PodcastEpisode)) {
|
|
throw new InvalidArgumentException(sprintf('Record must be an instance of %s.', $this->entityClass));
|
|
}
|
|
|
|
$isInternal = $request->isInternal();
|
|
$router = $request->getRouter();
|
|
|
|
$return = $this->episodeApiGen->__invoke($record, $request);
|
|
|
|
$baseRouteParams = [
|
|
'station_id' => $request->getStation()->getIdRequired(),
|
|
'podcast_id' => $record->getPodcast()->getIdRequired(),
|
|
'episode_id' => $record->getIdRequired(),
|
|
];
|
|
|
|
$artRouteParams = $baseRouteParams;
|
|
if (0 !== $return->art_updated_at) {
|
|
$artRouteParams['timestamp'] = $return->art_updated_at;
|
|
}
|
|
|
|
$return->art = $router->named(
|
|
routeName: 'api:stations:podcast:episode:art',
|
|
routeParams: $artRouteParams,
|
|
absolute: !$isInternal
|
|
);
|
|
|
|
$return->links = [
|
|
...$return->links,
|
|
'self' => $router->fromHere(
|
|
routeName: $this->resourceRouteName,
|
|
routeParams: $baseRouteParams,
|
|
absolute: !$isInternal
|
|
),
|
|
'art' => $router->named(
|
|
routeName: 'api:stations:podcast:episode:art',
|
|
routeParams: $baseRouteParams,
|
|
absolute: !$isInternal
|
|
),
|
|
'media' => $router->fromHere(
|
|
routeName: 'api:stations:podcast:episode:media',
|
|
routeParams: $baseRouteParams,
|
|
absolute: !$isInternal
|
|
),
|
|
];
|
|
|
|
return $return;
|
|
}
|
|
}
|