<?php
namespace App\Models;
use App\Casts\SmartPlaylistRulesCast;
use App\Facades\License as LicenseFacade;
use App\Models\Concerns\MorphsToEmbeds;
use App\Models\Contracts\Embeddable;
use App\Models\Song as Playable;
use App\Values\SmartPlaylist\SmartPlaylistRuleGroupCollection;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Collection as EloquentCollection;
use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Support\Collection;
use Laravel\Scout\Searchable;
use OwenIt\Auditing\Auditable;
use OwenIt\Auditing\Contracts\Auditable as AuditableContract;
/**
* @property string $id
* @property string $name
* @property string $description
* @property bool $is_smart
* @property User $owner
* @property ?SmartPlaylistRuleGroupCollection $rule_groups
* @property ?SmartPlaylistRuleGroupCollection $rules
* @property Carbon $created_at
* @property EloquentCollection<array-key, Playable> $playables
* @property EloquentCollection<array-key, User> $users
* @property EloquentCollection<array-key, User> $collaborators
* @property ?string $cover The playlist cover's file name
* @property-read EloquentCollection<array-key, PlaylistFolder> $folders
* @property-read bool $is_collaborative
* @property int $owner_id
*/
class Playlist extends Model implements AuditableContract, Embeddable
{
use Auditable;
use HasFactory;
use HasUuids;
use MorphsToEmbeds;
use Searchable;
protected $hidden = ['created_at', 'updated_at'];
protected $guarded = [];
protected $casts = [
'rules' => SmartPlaylistRulesCast::class,
];
protected $appends = ['is_smart'];
protected $with = ['users', 'collaborators', 'folders'];
public function playables(): BelongsToMany
{
return $this->belongsToMany(Playable::class)
->withTimestamps()
->withPivot('position')
->orderByPivot('position');
}
public function users(): BelongsToMany
{
return $this->belongsToMany(User::class)
->withPivot('role', 'position')
->withTimestamps();
}
protected function owner(): Attribute
{
return Attribute::get(fn () => $this->users()->wherePivot('role', 'owner')->sole())->shouldCache();
}
public function collaborators(): BelongsToMany
{
return $this->users()->wherePivot('role', 'collaborator');
}
public function folders(): BelongsToMany
{
return $this->belongsToMany(PlaylistFolder::class, null, null, 'folder_id');
}
public function collaborationTokens(): HasMany
{
return $this->hasMany(PlaylistCollaborationToken::class);
}
protected function isSmart(): Attribute
{
return Attribute::get(fn (): bool => (bool) $this->rule_groups?->isNotEmpty())->shouldCache();
}
protected function ruleGroups(): Attribute
{
// aliasing the attribute to avoid confusion
return Attribute::get(fn () => $this->rules);
}
public function ownedBy(User $user): bool
{
return $this->owner->is($user);
}
public function inFolder(PlaylistFolder $folder): bool
{
return $this->folders->contains($folder);
}
public function getFolder(?User $contextUser = null): ?PlaylistFolder
{
return $this->folders->firstWhere(
fn (PlaylistFolder $folder) => $folder->user->is($contextUser ?? $this->owner)
);
}
public function getFolderId(?User $user = null): ?string
{
return $this->getFolder($user)?->id;
}
public function addCollaborator(User $user): void
{
if (!$this->hasCollaborator($user)) {
$this->users()->attach($user, ['role' => 'collaborator']);
}
}
public function hasCollaborator(User $collaborator): bool
{
return $this->collaborators->contains(static fn (User $user): bool => $collaborator->is($user));
}
/**
* @param Collection|array<array-key, Playable>|Playable|array<string> $playables
*/
public function addPlayables(Collection|Playable|array $playables, ?User $collaborator = null): void
{
$collaborator ??= $this->owner;
$maxPosition = $this->playables()->getQuery()->max('position') ?? 0;
if (!is_array($playables)) {
$playables = Collection::wrap($playables)->pluck('id')->all();
}
$data = [];
foreach ($playables as $playable) {
$data[$playable] = [
'position' => ++$maxPosition,
'user_id' => $collaborator->id,
];
}
$this->playables()->attach($data);
}
/**
* @param Collection<array-key, Playable>|Playable|array<string> $playables
*/
public function removePlayables(Collection|Playable|array $playables): void
{
if (!is_array($playables)) {
$playables = Collection::wrap($playables)->pluck('id')->all();
}
$this->playables()->detach($playables);
}
protected function isCollaborative(): Attribute
{
return Attribute::get(
fn (): bool => !$this->is_smart && LicenseFacade::isPlus() && $this->collaborators->isNotEmpty()
)->shouldCache();
}
/** @inheritdoc */
public function toSearchableArray(): array
{
return [
'id' => $this->id,
'owner_id' => $this->owner_id,
'name' => $this->name,
'description' => $this->description,
];
}
}