$s3_params * @property int $owner_id * @property bool $is_public * @property User $owner * * // The following are only available for collaborative playlists * @property-read ?string $collaborator_email The email of the user who added the song to the playlist * @property-read ?string $collaborator_name The name of the user who added the song to the playlist * @property-read ?int $collaborator_id The ID of the user who added the song to the playlist * @property-read ?string $added_at The date the song was added to the playlist */ class Song extends Model { use HasFactory; use Searchable; use SupportsDeleteWhereValueNotIn; public const ID_REGEX = '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}'; public $incrementing = false; protected $guarded = []; protected $hidden = ['updated_at', 'path', 'mtime']; protected $casts = [ 'length' => 'float', 'mtime' => 'int', 'track' => 'int', 'disc' => 'int', 'is_public' => 'bool', ]; protected $keyType = 'string'; protected static function booted(): void { static::creating(static fn (self $song) => $song->id = Str::uuid()->toString()); } public static function query(): SongBuilder { return parent::query(); } public function owner(): BelongsTo { return $this->belongsTo(User::class); } public function newEloquentBuilder($query): SongBuilder { return new SongBuilder($query); } public function artist(): BelongsTo { return $this->belongsTo(Artist::class); } public function album(): BelongsTo { return $this->belongsTo(Album::class); } public function album_artist(): BelongsTo // @phpcs:ignore { return $this->album->artist(); } public function playlists(): BelongsToMany { return $this->belongsToMany(Playlist::class); } public function interactions(): HasMany { return $this->hasMany(Interaction::class); } protected function title(): Attribute { return new Attribute( get: fn (?string $value) => $value ?: pathinfo($this->path, PATHINFO_FILENAME), set: static fn (string $value) => html_entity_decode($value) ); } public function accessibleBy(User $user): bool { return $this->is_public || $this->owner_id === $user->id; } protected function lyrics(): Attribute { $normalizer = static function (?string $value): string { // Since we're displaying the lyrics using

, replace breaks with newlines and strip all tags.
            $value = strip_tags(preg_replace('##i', PHP_EOL, $value));

            // also remove the timestamps that often come with LRC files
            return preg_replace('/\[\d{2}:\d{2}.\d{2}]\s*/m', '', $value);
        };

        return new Attribute(get: $normalizer, set: $normalizer);
    }

    protected function s3Params(): Attribute
    {
        return Attribute::get(function (): ?array {
            if (!preg_match('/^s3:\\/\\/(.*)/', $this->path, $matches)) {
                return null;
            }

            [$bucket, $key] = explode('/', $matches[1], 2);

            return compact('bucket', 'key');
        });
    }

    public static function getPathFromS3BucketAndKey(string $bucket, string $key): string
    {
        return "s3://$bucket/$key";
    }

    /** @return array */
    public function toSearchableArray(): array
    {
        $array = [
            'id' => $this->id,
            'title' => $this->title,
        ];

        if (!$this->artist->is_unknown && !$this->artist->is_various) {
            $array['artist'] = $this->artist->name;
        }

        return $array;
    }

    public function __toString(): string
    {
        return $this->id;
    }
}