src/Module/Api/Method/PlaylistMethod.php
<?php
declare(strict_types=0);
/**
* vim:set softtabstop=4 shiftwidth=4 expandtab:
*
* LICENSE: GNU Affero General Public License, version 3 (AGPL-3.0-or-later)
* Copyright Ampache.org, 2001-2023
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Ampache\Module\Api\Method;
use Ampache\Module\Api\Exception\ErrorCodeEnum;
use Ampache\Repository\Model\Playlist;
use Ampache\Repository\Model\Search;
use Ampache\Repository\Model\User;
use Ampache\Module\Api\Api;
use Ampache\Module\Api\Json_Data;
use Ampache\Module\Api\Xml_Data;
/**
* Class PlaylistMethod
* @package Lib\ApiMethods
*/
final class PlaylistMethod
{
public const ACTION = 'playlist';
/**
* playlist
* MINIMUM_API_VERSION=380001
*
* This returns a single playlist
*
* filter = (string) UID of playlist
*/
public static function playlist(array $input, User $user): bool
{
if (!Api::check_parameter($input, array('filter'), self::ACTION)) {
return false;
}
$object_id = $input['filter'];
$playlist = ((int) $object_id === 0)
? new Search((int) str_replace('smart_', '', $object_id), 'song', $user)
: new Playlist((int) $object_id);
if ($playlist->isNew()) {
/* HINT: Requested object string/id/type ("album", "myusername", "some song title", 1298376) */
Api::error(sprintf('Not Found: %s', $object_id), ErrorCodeEnum::NOT_FOUND, self::ACTION, 'filter', $input['api_format']);
return false;
}
if (!$playlist->type == 'public' && (!$playlist->has_access($user->id) && $user->access !== 100)) {
Api::error('Require: 100', ErrorCodeEnum::FAILED_ACCESS_CHECK, self::ACTION, 'account', $input['api_format']);
return false;
}
ob_end_clean();
switch ($input['api_format']) {
case 'json':
echo Json_Data::playlists(array($object_id), $user, false, true, false);
break;
default:
echo Xml_Data::playlists(array($object_id), $user);
}
return true;
}
}