. */ namespace Poniverse\Ponyfm\Models; use Auth; use Cache; use Config; use DB; use Poniverse\Ponyfm\Contracts\Searchable; use Poniverse\Ponyfm\Exceptions\TrackFileNotFoundException; use Poniverse\Ponyfm\Traits\IndexedInElasticsearchTrait; use Poniverse\Ponyfm\Traits\SlugTrait; use Exception; use External; use getid3_writetags; use Helpers; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Support\Str; use Log; use Venturecraft\Revisionable\RevisionableTrait; /** * Poniverse\Ponyfm\Models\Track * * @property integer $id * @property integer $user_id * @property integer $license_id * @property integer $genre_id * @property integer $track_type_id * @property string $title * @property string $slug * @property string $description * @property string $lyrics * @property boolean $is_vocal * @property boolean $is_explicit * @property integer $cover_id * @property boolean $is_downloadable * @property float $duration * @property integer $play_count * @property integer $view_count * @property integer $download_count * @property integer $favourite_count * @property integer $comment_count * @property \Carbon\Carbon $created_at * @property string $updated_at * @property \Carbon\Carbon $deleted_at * @property \Carbon\Carbon $published_at * @property \Carbon\Carbon $released_at * @property integer $album_id * @property integer $track_number * @property boolean $is_latest * @property string $hash * @property boolean $is_listed * @property string $source * @property string $original_tags * @property string $metadata * @property-read \Poniverse\Ponyfm\Models\Genre $genre * @property-read \Poniverse\Ponyfm\Models\TrackType $trackType * @property-read \Illuminate\Database\Eloquent\Collection|\Poniverse\Ponyfm\Models\Comment[] $comments * @property-read \Illuminate\Database\Eloquent\Collection|\Poniverse\Ponyfm\Models\Favourite[] $favourites * @property-read \Poniverse\Ponyfm\Models\Image $cover * @property-read \Illuminate\Database\Eloquent\Collection|\Poniverse\Ponyfm\Models\ShowSong[] $showSongs * @property-read \Illuminate\Database\Eloquent\Collection|\Poniverse\Ponyfm\Models\ResourceUser[] $users * @property-read \Poniverse\Ponyfm\Models\User $user * @property-read \Poniverse\Ponyfm\Models\Album $album * @property-read \Illuminate\Database\Eloquent\Collection|\Poniverse\Ponyfm\Models\TrackFile[] $trackFiles * @property-read mixed $year * @property-read mixed $url * @property-read mixed $download_directory * @property-read mixed $status * @property-read \Illuminate\Database\Eloquent\Collection|\Venturecraft\Revisionable\Revision[] $revisionHistory * @method static \Illuminate\Database\Query\Builder|\Poniverse\Ponyfm\Models\Track userDetails() * @method static \Illuminate\Database\Query\Builder|\Poniverse\Ponyfm\Models\Track published() * @method static \Illuminate\Database\Query\Builder|\Poniverse\Ponyfm\Models\Track listed() * @method static \Illuminate\Database\Query\Builder|\Poniverse\Ponyfm\Models\Track explicitFilter() * @method static \Illuminate\Database\Query\Builder|\Poniverse\Ponyfm\Models\Track withComments() * @method static \Illuminate\Database\Query\Builder|\Poniverse\Ponyfm\Models\Track mlpma() */ class Track extends Model implements Searchable { use SoftDeletes, IndexedInElasticsearchTrait; protected $elasticsearchType = 'track'; protected $dates = ['deleted_at', 'published_at', 'released_at']; protected $hidden = ['original_tags', 'metadata']; protected $casts = [ 'id' => 'integer', 'user_id' => 'integer', 'license_id' => 'integer', 'album_id' => 'integer', 'track_number' => 'integer', 'genre_id' => 'integer', 'track_type_id' => 'integer', 'is_vocal' => 'boolean', 'is_explicit' => 'boolean', 'cover_id' => 'integer', 'is_downloadable' => 'boolean', 'is_latest' => 'boolean', 'is_listed' => 'boolean', 'original_tags' => 'array', 'metadata' => 'array', ]; use SlugTrait { SlugTrait::setTitleAttribute as setTitleAttributeSlug; } use RevisionableTrait; // Used for the track's upload status. const STATUS_COMPLETE = 0; const STATUS_PROCESSING = 1; const STATUS_ERROR = 2; public static $Formats = [ 'FLAC' => [ 'index' => 0, 'is_lossless' => true, 'extension' => 'flac', 'tag_format' => 'metaflac', 'tag_method' => 'updateTagsWithGetId3', 'mime_type' => 'audio/flac', 'command' => 'ffmpeg 2>&1 -y -i {$source} -map 0:a -map_metadata -1 -codec:a flac -aq 8 -f flac {$target}' ], 'MP3' => [ 'index' => 1, 'is_lossless' => false, 'extension' => 'mp3', 'tag_format' => 'id3v2.3', 'tag_method' => 'updateTagsWithGetId3', 'mime_type' => 'audio/mpeg', 'command' => 'ffmpeg 2>&1 -y -i {$source} -map 0:a -map_metadata -1 -codec:a libmp3lame -ab 320k -f mp3 {$target}' ], 'OGG Vorbis' => [ 'index' => 2, 'is_lossless' => false, 'extension' => 'ogg', 'tag_format' => 'vorbiscomment', 'tag_method' => 'updateTagsWithGetId3', 'mime_type' => 'audio/ogg', 'command' => 'ffmpeg 2>&1 -y -i {$source} -map 0:a -map_metadata -1 -codec:a libvorbis -aq 7 -f ogg {$target}' ], 'AAC' => [ 'index' => 3, 'is_lossless' => false, 'extension' => 'm4a', 'tag_format' => 'AtomicParsley', 'tag_method' => 'updateTagsWithAtomicParsley', 'mime_type' => 'audio/mp4', 'command' => 'ffmpeg 2>&1 -y -i {$source} -map 0:a -map_metadata -1 -codec:a libfaac -ab 256k -f mp4 {$target}' ], 'ALAC' => [ 'index' => 4, 'is_lossless' => true, 'extension' => 'alac.m4a', 'tag_format' => 'AtomicParsley', 'tag_method' => 'updateTagsWithAtomicParsley', 'mime_type' => 'audio/mp4', 'command' => 'ffmpeg 2>&1 -y -i {$source} -map 0:a -map_metadata -1 -codec:a alac {$target}' ], ]; /** * `TrackFiles` in these formats, with the exception of any master files, will * be generated upon user request and kept around temporarily. * * After updating this array, run `php artisan rebuild:track-cache` to bring * the track store into a consistent state. * * The strings in this array must match keys in the `Track::$Formats` array. * * @var array */ public static $CacheableFormats = [ 'OGG Vorbis', 'ALAC', 'AAC' ]; public static function summary() { return self::select('tracks.id', 'title', 'user_id', 'slug', 'is_vocal', 'is_explicit', 'created_at', 'published_at', 'duration', 'is_downloadable', 'genre_id', 'track_type_id', 'cover_id', 'album_id', 'comment_count', 'download_count', 'view_count', 'play_count', 'favourite_count'); } public function scopeUserDetails($query) { if (Auth::check()) { $query->with([ 'users' => function($query) { $query->whereUserId(Auth::user()->id); } ]); } } public function scopePublished($query) { $query->whereNotNull('published_at'); } public function scopeListed($query) { $query->whereIsListed(true); } public function scopeExplicitFilter($query) { if (!Auth::check() || !Auth::user()->can_see_explicit_content) { $query->whereIsExplicit(false); } } public function scopeWithComments($query) { $query->with([ 'comments' => function($query) { $query->with('user'); } ]); } /** * Limits results to MLP Music Archive tracks. * * @param $query */ public function scopeMlpma($query) { $query->join('mlpma_tracks', 'tracks.id', '=', 'mlpma_tracks.track_id'); } /** * @param integer $count */ public static function popular($count, $allowExplicit = false) { $trackIds = Cache::remember('popular_tracks'.$count.'-'.($allowExplicit ? 'explicit' : 'safe'), 5, function() use ($allowExplicit, $count) { $query = static ::published() ->listed() ->join(DB::raw(' ( SELECT `track_id`, `created_at` FROM `resource_log_items` WHERE track_id IS NOT NULL AND log_type = 3 AND `created_at` > now() - INTERVAL 1 DAY ) AS ranged_plays'), 'tracks.id', '=', 'ranged_plays.track_id') ->groupBy('id') ->orderBy('plays', 'desc') ->take($count); if (!$allowExplicit) { $query->whereIsExplicit(false); } $results = []; foreach ($query->get(['*', DB::raw('count(*) as plays')]) as $track) { $results[] = $track->id; } return $results; }); if (!count($trackIds)) { return []; } $tracks = Track::summary() ->userDetails() ->explicitFilter() ->published() ->with('user', 'genre', 'cover', 'album', 'album.user') ->whereIn('id', $trackIds); $processed = []; foreach ($tracks->get() as $track) { $processed[] = Track::mapPublicTrackSummary($track); } // Songs that get played more should drop down // in the list so they don't hog the top spots. array_reverse($processed); return $processed; } public static function mapPublicTrackShow(Track $track) { $returnValue = self::mapPublicTrackSummary($track); $returnValue['description'] = $track->description; $returnValue['lyrics'] = $track->lyrics; $comments = []; foreach ($track->comments as $comment) { $comments[] = Comment::mapPublic($comment); } $returnValue['comments'] = $comments; if ($track->album_id != null) { $returnValue['album'] = [ 'title' => $track->album->title, 'url' => $track->album->url, ]; } $formats = []; foreach ($track->trackFiles as $trackFile) { $formats[] = [ 'name' => $trackFile->format, 'extension' => $trackFile->extension, 'url' => $trackFile->url, 'size' => $trackFile->size, 'isCacheable' => (bool) $trackFile->is_cacheable ]; } $returnValue['share'] = [ 'url' => action('TracksController@getShortlink', ['id' => $track->id]), 'html' => '', 'bbcode' => '[url='.$track->url.'][img]'.$track->getCoverUrl().'[/img][/url]', 'twitterUrl' => 'https://platform.twitter.com/widgets/tweet_button.html?text='.$track->title.' by '.$track->user->display_name.' on Pony.fm' ]; $returnValue['share']['tumblrUrl'] = 'http://www.tumblr.com/share/video?embed='.urlencode($returnValue['share']['html']).'&caption='.urlencode($track->title); $returnValue['formats'] = $formats; return $returnValue; } public static function mapPublicTrackSummary(Track $track) { $userData = [ 'stats' => [ 'views' => 0, 'plays' => 0, 'downloads' => 0 ], 'is_favourited' => false ]; if (Auth::check() && $track->users->count()) { $userRow = $track->users[0]; $userData = [ 'stats' => [ 'views' => (int) $userRow->view_count, 'plays' => (int) $userRow->play_count, 'downloads' => $userRow->download_count, ], 'is_favourited' => (bool) $userRow->is_favourited ]; } return [ 'id' => (int) $track->id, 'title' => $track->title, 'user' => [ 'id' => (int) $track->user->id, 'name' => $track->user->display_name, 'url' => $track->user->url ], 'stats' => [ 'views' => (int) $track->view_count, 'plays' => (int) $track->play_count, 'downloads' => (int) $track->download_count, 'comments' => (int) $track->comment_count, 'favourites' => (int) $track->favourite_count ], 'url' => $track->url, 'slug' => $track->slug, 'is_vocal' => $track->is_vocal, 'is_explicit' => $track->is_explicit, 'is_downloadable' => $track->is_downloadable, 'is_published' => $track->isPublished(), 'published_at' => $track->isPublished() ? $track->published_at->format('c') : null, 'duration' => $track->duration, 'genre' => $track->genre != null ? [ 'id' => (int) $track->genre->id, 'slug' => $track->genre->slug, 'name' => $track->genre->name ] : null, 'track_type_id' => $track->track_type_id, 'covers' => [ 'thumbnail' => $track->getCoverUrl(Image::THUMBNAIL), 'small' => $track->getCoverUrl(Image::SMALL), 'normal' => $track->getCoverUrl(Image::NORMAL), 'original' => $track->getCoverUrl(Image::ORIGINAL) ], 'streams' => [ 'mp3' => $track->getStreamUrl('MP3'), 'aac' => (!Config::get('app.debug') || is_file($track->getFileFor('AAC'))) ? $track->getStreamUrl('AAC') : null, 'ogg' => (Config::get('app.debug') || is_file($track->getFileFor('OGG Vorbis'))) ? $track->getStreamUrl('OGG Vorbis') : null ], 'user_data' => $userData, 'permissions' => [ 'delete' => Auth::check() && Auth::user()->id == $track->user_id, 'edit' => Auth::check() && Auth::user()->id == $track->user_id ] ]; } public static function mapPrivateTrackShow(Track $track) { $showSongs = []; foreach ($track->showSongs as $showSong) { $showSongs[] = ['id' => $showSong->id, 'title' => $showSong->title]; } $returnValue = self::mapPrivateTrackSummary($track); $returnValue['album_id'] = $track->album_id; $returnValue['show_songs'] = $showSongs; $returnValue['cover_id'] = $track->cover_id; $returnValue['real_cover_url'] = $track->getCoverUrl(Image::NORMAL); $returnValue['cover_url'] = $track->hasCover() ? $track->getCoverUrl(Image::NORMAL) : null; $returnValue['released_at'] = $track->released_at ? $track->released_at->toDateString() : null; $returnValue['lyrics'] = $track->lyrics; $returnValue['description'] = $track->description; $returnValue['is_downloadable'] = !$track->isPublished() ? true : (bool) $track->is_downloadable; $returnValue['license_id'] = $track->license_id != null ? $track->license_id : 3; return $returnValue; } public static function mapPrivateTrackSummary(Track $track) { return [ 'id' => $track->id, 'title' => $track->title, 'user_id' => $track->user_id, 'slug' => $track->slug, 'is_vocal' => $track->is_vocal, 'is_explicit' => $track->is_explicit, 'is_downloadable' => $track->is_downloadable, 'is_published' => $track->isPublished(), 'created_at' => $track->created_at->format('c'), 'published_at' => $track->published_at ? $track->published_at->format('c') : null, 'duration' => $track->duration, 'genre_id' => $track->genre_id, 'track_type_id' => $track->track_type_id, 'cover_url' => $track->getCoverUrl(Image::SMALL), 'is_listed' => !!$track->is_listed ]; } protected $table = 'tracks'; public function genre() { return $this->belongsTo('Poniverse\Ponyfm\Models\Genre'); } public function trackType() { return $this->belongsTo('Poniverse\Ponyfm\Models\TrackType', 'track_type_id'); } public function comments() { return $this->hasMany('Poniverse\Ponyfm\Models\Comment')->orderBy('created_at', 'desc'); } public function favourites() { return $this->hasMany('Poniverse\Ponyfm\Models\Favourite'); } public function cover() { return $this->belongsTo('Poniverse\Ponyfm\Models\Image'); } public function showSongs() { return $this->belongsToMany('Poniverse\Ponyfm\Models\ShowSong'); } public function users() { return $this->hasMany('Poniverse\Ponyfm\Models\ResourceUser'); } public function user() { return $this->belongsTo('Poniverse\Ponyfm\Models\User'); } public function album() { return $this->belongsTo('Poniverse\Ponyfm\Models\Album'); } public function trackFiles() { return $this->hasMany('Poniverse\Ponyfm\Models\TrackFile'); } public function getYearAttribute() { return date('Y', strtotime($this->getReleaseDate())); } public function setTitleAttribute($value) { $this->setTitleAttributeSlug($value); ; $this->updateHash(); } /** * Returns the size of this track's file in the given format. * * @param $formatName * @return int filesize in bytes * @throws TrackFileNotFoundException */ public function getFilesize($formatName) { $trackFile = $this->trackFiles()->where('format', $formatName)->first(); if ($trackFile) { return (int) $trackFile->filesize; } else { throw new TrackFileNotFoundException(); } } public function canView($user) { if ($this->isPublished()) { return true; } return $this->user_id == $user->id; } public function getUrlAttribute() { return action('TracksController@getTrack', ['id' => $this->id, 'slug' => $this->slug]); } public function getDownloadDirectoryAttribute() { if ($this->album) { return $this->user->display_name.'/'.$this->album->title; } return $this->user->display_name; } public function getReleaseDate() { if ($this->released_at !== null) { return $this->released_at; } if ($this->published_at !== null) { return Str::limit($this->published_at, 10, ''); } return Str::limit($this->attributes['created_at'], 10, ''); } public function ensureDirectoryExists() { $destination = $this->getDirectory(); umask(0); if (!is_dir($destination)) { mkdir($destination, 0777, true); } } public function hasCover() { return $this->cover_id != null; } public function isPublished() { return $this->published_at != null && $this->deleted_at == null; } public function getCoverUrl($type = Image::NORMAL) { if (!$this->hasCover()) { if ($this->album_id != null) { return $this->album->getCoverUrl($type); } return $this->user->getAvatarUrl($type); } return $this->cover->getUrl($type); } public function getStreamUrl($format = 'MP3') { return action('TracksController@getStream', ['id' => $this->id, 'extension' => self::$Formats[$format]['extension']]); } public function getDirectory() { $dir = (string) (floor($this->id / 100) * 100); return \Config::get('ponyfm.files_directory').'/tracks/'.$dir; } public function getDates() { return ['created_at', 'deleted_at', 'published_at', 'released_at']; } public function getFilenameFor($format) { if (!isset(self::$Formats[$format])) { throw new Exception("$format is not a valid format!"); } $format = self::$Formats[$format]; return "{$this->id}.{$format['extension']}"; } public function getDownloadFilenameFor($format) { if (!isset(self::$Formats[$format])) { throw new Exception("$format is not a valid format!"); } $format = self::$Formats[$format]; return "{$this->title}.{$format['extension']}"; } /** * @return string */ public function getFileFor($format) { if (!isset(self::$Formats[$format])) { throw new Exception("$format is not a valid format!"); } $format = self::$Formats[$format]; return "{$this->getDirectory()}/{$this->id}.{$format['extension']}"; } /** * Returns the path to the "temporary" master file uploaded by the user. * This file is used during the upload process to generate the actual master * file stored by Pony.fm. * * @return string */ public function getTemporarySourceFile():string { return Config::get('ponyfm.files_directory').'/queued-tracks/'.$this->id; } public function getUrlFor($format) { if (!isset(self::$Formats[$format])) { throw new Exception("$format is not a valid format!"); } $format = self::$Formats[$format]; return action('TracksController@getDownload', ['id' => $this->id, 'extension' => $format['extension']]); } /** * @return string one of the Track::STATUS_* values, indicating whether this track is currently being processed */ public function getStatusAttribute() { return $this->trackFiles->reduce(function($carry, $trackFile) { if ((int) $trackFile->status === TrackFile::STATUS_PROCESSING_ERROR) { return static::STATUS_ERROR; } elseif ( $carry !== static::STATUS_ERROR && in_array($trackFile->status, [TrackFile::STATUS_PROCESSING, TrackFile::STATUS_PROCESSING_PENDING])) { return static::STATUS_PROCESSING; } elseif ( !in_array($carry, [static::STATUS_ERROR, static::STATUS_PROCESSING, TrackFile::STATUS_PROCESSING_PENDING]) && (int) $trackFile->status === TrackFile::STATUS_NOT_BEING_PROCESSED ) { return static::STATUS_COMPLETE; } else { return $carry; } }, static::STATUS_COMPLETE); } public function updateHash() { $this->hash = md5(Helpers::sanitizeInputForHashing($this->user->display_name).' - '.Helpers::sanitizeInputForHashing($this->title)); } public function updateTags($trackFileFormat = 'all') { if ($trackFileFormat === 'all') { foreach ($this->trackFiles as $trackFile) { $this->updateTagsForTrackFile($trackFile); } } else { $trackFile = $this->trackFiles()->where('format', $trackFileFormat)->firstOrFail(); $this->updateTagsForTrackFile($trackFile); } } private function updateTagsForTrackFile(TrackFile $trackFile) { $trackFile->touch(); if (\File::exists($trackFile->getFile())) { $format = $trackFile->format; $data = self::$Formats[$format]; $this->{$data['tag_method']}($format); } } /** @noinspection PhpUnusedPrivateMethodInspection */ private function updateTagsWithAtomicParsley($format) { $command = 'AtomicParsley "'.$this->getFileFor($format).'" '; $command .= '--title '.escapeshellarg($this->title).' '; $command .= '--artist '.escapeshellarg($this->user->display_name).' '; $command .= '--year "'.$this->year.'" '; $command .= '--genre '.escapeshellarg($this->genre != null ? $this->genre->name : '').' '; $command .= '--copyright '.escapeshellarg('© '.$this->year.' '.$this->user->display_name).' '; $command .= '--comment "'.'Downloaded from: https://pony.fm/'.'" '; $command .= '--encodingTool "'.'Pony.fm - https://pony.fm/'.'" '; if ($this->album_id !== null) { $command .= '--album '.escapeshellarg($this->album->title).' '; $command .= '--tracknum '.$this->track_number.' '; } if ($this->cover !== null) { $command .= '--artwork '.$this->cover->getFile(Image::ORIGINAL).' '; } $command .= '--overWrite'; External::execute($command); } /** @noinspection PhpUnusedPrivateMethodInspection */ private function updateTagsWithGetId3($format) { require_once(app_path().'/Library/getid3/getid3/getid3.php'); require_once(app_path().'/Library/getid3/getid3/write.php'); $tagWriter = new getid3_writetags; $tagWriter->overwrite_tags = true; $tagWriter->tag_encoding = 'UTF-8'; $tagWriter->remove_other_tags = true; $tagWriter->tag_data = [ 'title' => [$this->title], 'artist' => [$this->user->display_name], 'year' => [''.$this->year], 'genre' => [$this->genre != null ? $this->genre->name : ''], 'comment' => ['Downloaded from: https://pony.fm/'], 'copyright' => ['© '.$this->year.' '.$this->user->display_name], 'publisher' => ['Pony.fm - https://pony.fm/'], 'encoded_by' => ['https://pony.fm/'], // 'url_artist' => [$this->user->url], // 'url_source' => [$this->url], // 'url_file' => [$this->url], 'url_publisher' => ['https://pony.fm/'] ]; if ($this->album_id !== null) { $tagWriter->tag_data['album'] = [$this->album->title]; $tagWriter->tag_data['track'] = [$this->track_number]; } if ($format == 'MP3' && $this->cover_id != null && is_file($this->cover->getFile())) { $tagWriter->tag_data['attached_picture'][0] = [ 'data' => file_get_contents($this->cover->getFile(Image::ORIGINAL)), 'picturetypeid' => 2, 'description' => 'cover', 'mime' => $this->cover->mime ]; } $tagWriter->filename = $this->getFileFor($format); $tagWriter->tagformats = [self::$Formats[$format]['tag_format']]; if ($tagWriter->WriteTags()) { if (!empty($tagWriter->warnings)) { Log::warning('Track #'.$this->id.': There were some warnings:
'.implode('

', $tagWriter->warnings)); } } else { Log::error('Track #'.$this->id.': Failed to write tags!
'.implode('

', $tagWriter->errors)); } } private function getCacheKey($key) { return 'track-'.$this->id.'-'.$key; } /** * @inheritdoc */ public function shouldBeIndexed():bool { return $this->is_listed && $this->published_at !== null && !$this->trashed(); } /** * @inheritdoc */ public function toElasticsearch():array { return [ 'title' => $this->title, 'artist' => $this->user->display_name, 'published_at' => $this->published_at ? $this->published_at->toIso8601String() : null, 'genre' => $this->genre->name, 'track_type' => $this->trackType->title, 'show_songs' => $this->showSongs->pluck('title') ]; } }