Pony.fm/app/Http/Controllers/Api/V1/TracksController.php

<?php

/**
 * Pony.fm - A community for pony fan music.
 * Copyright (C) 2015-2017 Feld0.
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

namespace App\Http\Controllers\Api\V1;

use App\Commands\UploadTrackCommand;
use App\Http\Controllers\ApiControllerBase;
use App\Models\Image;
use App\Models\Track;
use Illuminate\Support\Facades\Response;

class TracksController extends ApiControllerBase
{
    public function postUploadTrack()
    {
        session_write_close();

        $response = $this->execute(new UploadTrackCommand(true, true, session('api_client_id'), true));
        $commandData = $response->getData(true);

        if (200 !== $response->getStatusCode()) {
            return $response;
        }

        $data = [
            'id'            => (string) $commandData['id'],
            'status_url'    => action('Api\V1\TracksController@getUploadStatus', ['id' => $commandData['id']]),
            'track_url'     => action('TracksController@getTrack', ['id' => $commandData['id'], 'slug' => $commandData['slug']]),
            'message'       => $commandData['autoPublish']
                ? 'This track has been accepted for processing! Poll the status_url to know when it has been published. It will be published at the track_url.'
                : "This track has been accepted for processing! Poll the status_url to know when it's ready to publish. It will be published at the track_url.",
        ];

        $response->setData($data);
        $response->setStatusCode(202);

        return $response;
    }

    public function getUploadStatus($trackId)
    {
        $track = Track::findOrFail($trackId);
        $this->authorize('edit', $track);

        if ($track->status === Track::STATUS_PROCESSING) {
            return Response::json(['message' => 'Processing...'], 202);
        } elseif ($track->status === Track::STATUS_COMPLETE) {
            return Response::json([
                'message' => $track->published_at
                    ? 'Processing complete! The track is live at the track_url. The artist can edit the track by visiting its edit_url.'
                    : 'Processing complete! The artist must publish the track by visiting its edit_url.',
                'edit_url' => action('ContentController@getTracks', ['id' => $trackId]),
                'track_url' => $track->url,
            ], 201);
        } else {
            // something went wrong
            return Response::json(['error' => 'Processing failed! Please contact logic@pony.fm to figure out what went wrong.'], 500);
        }
    }

    /**
     * Returns a stable representation of a track for the API. This is very
     * similar to the radio representation below but finds tracks by ID and is
     * expected to be more stable.
     *
     * @param int $id track ID
     * @return \Illuminate\Http\JsonResponse
     */
    public function getTrackDetails($id)
    {
        /** @var Track|null $track */
        $track = Track
            ::with('user', 'album', 'user.avatar', 'cover', 'genre')
            ->published()
            ->where('id', $id)->first();

        if (! $track) {
            return Response::json(['message' => 'Track not found.'], 404);
        }

        return Response::json(self::trackToJson($track, false, true), 200);
    }

    /**
     * Returns a serialized version of a track for use by radios.
     *
     * @deprecated in favour of getTrackDetails
     * @param $hash
     * @return \Illuminate\Http\JsonResponse
     */
    public function getTrackRadioDetails($hash)
    {
        /** @var Track|null $track */
        $track = Track
            ::with('user', 'album', 'user.avatar', 'cover', 'comments', 'genre')
            ->published()
            ->where('hash', $hash)->first();

        if (! $track) {
            return Response::json(['message' => 'Track not found.'], 403);
        }

        return Response::json(self::trackToJson($track, true, false), 200);
    }

    /**
     * Helper method to form the serialized version of a track for the V1 API.
     *
     * @param Track $track
     * @param bool $includeComments if true, includes the track's comments in the serialization
     * @return array serialized track
     */
    private static function trackToJson(Track $track, bool $includeComments, bool $includeStreamUrl)
    {
        $trackResponse = [
            'id' => $track->id,
            'title' => $track->title,
            'description' => $track->description,
            'lyrics' => $track->lyrics,
            'user' => [
                'id' => $track->user->id,
                'name' => $track->user->display_name,
                'url' => $track->user->url,
                'avatars' => [
                    'thumbnail' => $track->user->getAvatarUrl(Image::THUMBNAIL),
                    'small' => $track->user->getAvatarUrl(Image::SMALL),
                    'normal' => $track->user->getAvatarUrl(Image::NORMAL),
                ],
            ],
            'stats' => [
                'views' => $track->view_count,
                'plays' => $track->play_count,
                'downloads' => $track->download_count,
                'comments' => $track->comment_count,
                'favourites' => $track->favourite_count,
            ],
            'url' => $track->url,
            'is_vocal' => (bool) $track->is_vocal,
            'is_explicit' => (bool) $track->is_explicit,
            'is_downloadable' => (bool) $track->is_downloadable,
            'published_at' => $track->published_at,
            'duration' => $track->duration,
            'genre' => $track->genre != null
                ?
                [
                    'id' => $track->genre->id,
                    'name' => $track->genre->name,
                ] : null,
            'type' => [
                'id' => $track->trackType->id,
                'name' => $track->trackType->title,
            ],
            'covers' => [
                'thumbnail' => $track->getCoverUrl(Image::THUMBNAIL),
                'small' => $track->getCoverUrl(Image::SMALL),
                'normal' => $track->getCoverUrl(Image::NORMAL),
            ],

            // As of 2017-10-28, this should be expected to produce
            // "direct_upload", "mlpma", "ponify", or "eqbeats" for all tracks.
            'source' => $track->source,
        ];

        if ($includeComments) {
            $comments = [];
            foreach ($track->comments as $comment) {
                $comments[] = [
                    'id' => $comment->id,
                    'created_at' => $comment->created_at,
                    'content' => $comment->content,
                    'user' => [
                        'name' => $comment->user->display_name,
                        'id' => $comment->user->id,
                        'url' => $comment->user->url,
                        'avatars' => [
                            'normal' => $comment->user->getAvatarUrl(Image::NORMAL),
                            'thumbnail' => $comment->user->getAvatarUrl(Image::THUMBNAIL),
                            'small' => $comment->user->getAvatarUrl(Image::SMALL),
                        ],
                    ],
                ];
            }

            $trackResponse['comments'] = $comments;
        }

        if ($includeStreamUrl) {
            $trackResponse['streams'] = [
                'mp3' => [
                    'url'       => $track->getStreamUrl('MP3', session('api_client_id')),
                    'mime_type' => Track::$Formats['MP3']['mime_type'],
                ],
            ];
        }

        return $trackResponse;
    }
}