mirror of
https://github.com/koel/koel
synced 2024-12-01 00:09:17 +00:00
161 lines
4.9 KiB
PHP
161 lines
4.9 KiB
PHP
<?php
|
|
|
|
namespace App\Models;
|
|
|
|
use App\Builders\AlbumBuilder;
|
|
use Carbon\Carbon;
|
|
use Illuminate\Database\Eloquent\Casts\Attribute;
|
|
use Illuminate\Database\Eloquent\Collection;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
use Illuminate\Support\Arr;
|
|
use Illuminate\Support\Facades\File;
|
|
use Laravel\Scout\Searchable;
|
|
|
|
/**
|
|
* @property string $cover The album cover's file name
|
|
* @property string|null $cover_path The absolute path to the cover file
|
|
* @property bool $has_cover If the album has a non-default cover image
|
|
* @property int $id
|
|
* @property string $name Name of the album
|
|
* @property Artist $artist The album's artist
|
|
* @property int $artist_id
|
|
* @property Collection $songs
|
|
* @property bool $is_unknown If the album is the Unknown Album
|
|
* @property string|null $thumbnail_name The file name of the album's thumbnail
|
|
* @property string|null $thumbnail_path The full path to the thumbnail.
|
|
* Notice that this doesn't guarantee the thumbnail exists.
|
|
* @property string|null $thumbnail The public URL to the album's thumbnail
|
|
* @property Carbon $created_at
|
|
* @property float|string $length Total length of the album in seconds (dynamically calculated)
|
|
* @property int|string $play_count Total number of times the album's songs have been played (dynamically calculated)
|
|
* @property int|string $song_count Total number of songs on the album (dynamically calculated)
|
|
*/
|
|
class Album extends Model
|
|
{
|
|
use HasFactory;
|
|
use Searchable;
|
|
use SupportsDeleteWhereValueNotIn;
|
|
|
|
public const UNKNOWN_ID = 1;
|
|
public const UNKNOWN_NAME = 'Unknown Album';
|
|
|
|
protected $guarded = ['id'];
|
|
protected $hidden = ['updated_at'];
|
|
protected $casts = ['artist_id' => 'integer'];
|
|
|
|
/** @deprecated */
|
|
protected $appends = ['is_compilation'];
|
|
|
|
public static function query(): AlbumBuilder
|
|
{
|
|
return parent::query();
|
|
}
|
|
|
|
public function newEloquentBuilder($query): AlbumBuilder
|
|
{
|
|
return new AlbumBuilder($query);
|
|
}
|
|
|
|
/**
|
|
* Get an album using some provided information.
|
|
* If such is not found, a new album will be created using the information.
|
|
*/
|
|
public static function getOrCreate(Artist $artist, ?string $name = null): static
|
|
{
|
|
return static::query()->firstOrCreate([ // @phpstan-ignore-line
|
|
'artist_id' => $artist->id,
|
|
'name' => trim($name) ?: self::UNKNOWN_NAME,
|
|
]);
|
|
}
|
|
|
|
public function artist(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Artist::class);
|
|
}
|
|
|
|
public function songs(): HasMany
|
|
{
|
|
return $this->hasMany(Song::class);
|
|
}
|
|
|
|
protected function isUnknown(): Attribute
|
|
{
|
|
return Attribute::get(fn (): bool => $this->id === self::UNKNOWN_ID);
|
|
}
|
|
|
|
protected function cover(): Attribute
|
|
{
|
|
return Attribute::get(static fn (?string $value): ?string => album_cover_url($value));
|
|
}
|
|
|
|
protected function hasCover(): Attribute
|
|
{
|
|
return Attribute::get(fn (): bool => $this->cover_path
|
|
&& (app()->runningUnitTests() || File::exists($this->cover_path)));
|
|
}
|
|
|
|
protected function coverPath(): Attribute
|
|
{
|
|
return Attribute::get(function () {
|
|
$cover = Arr::get($this->attributes, 'cover');
|
|
|
|
return $cover ? album_cover_path($cover) : null;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Sometimes the tags extracted from getID3 are HTML entity encoded.
|
|
* This makes sure they are always sane.
|
|
*/
|
|
protected function name(): Attribute
|
|
{
|
|
return Attribute::get(static fn (string $value) => html_entity_decode($value));
|
|
}
|
|
|
|
protected function thumbnailName(): Attribute
|
|
{
|
|
return Attribute::get(function (): ?string {
|
|
if (!$this->has_cover) {
|
|
return null;
|
|
}
|
|
|
|
$parts = pathinfo($this->cover_path);
|
|
|
|
return sprintf('%s_thumb.%s', $parts['filename'], $parts['extension']);
|
|
});
|
|
}
|
|
|
|
protected function thumbnailPath(): Attribute
|
|
{
|
|
return Attribute::get(fn () => $this->thumbnail_name ? album_cover_path($this->thumbnail_name) : null);
|
|
}
|
|
|
|
protected function thumbnail(): Attribute
|
|
{
|
|
return Attribute::get(fn () => $this->thumbnail_name ? album_cover_url($this->thumbnail_name) : null);
|
|
}
|
|
|
|
/** @deprecated Only here for backward compat with mobile apps */
|
|
protected function isCompilation(): Attribute
|
|
{
|
|
return Attribute::get(fn () => $this->artist_id === Artist::VARIOUS_ID);
|
|
}
|
|
|
|
/** @return array<mixed> */
|
|
public function toSearchableArray(): array
|
|
{
|
|
$array = [
|
|
'id' => $this->id,
|
|
'name' => $this->name,
|
|
];
|
|
|
|
if (!$this->artist->is_unknown && !$this->artist->is_various) {
|
|
$array['artist'] = $this->artist->name;
|
|
}
|
|
|
|
return $array;
|
|
}
|
|
}
|