2
0
Fork 0
mirror of https://github.com/koel/koel synced 2024-12-25 03:53:05 +00:00
koel/app/Services/SongService.php

152 lines
5.2 KiB
PHP
Raw Normal View History

2022-06-10 10:47:46 +00:00
<?php
namespace App\Services;
use App\Events\LibraryChanged;
use App\Facades\License;
2022-06-10 10:47:46 +00:00
use App\Models\Album;
use App\Models\Artist;
use App\Models\Song;
use App\Repositories\SongRepository;
use App\Services\SongStorage\SongStorage;
2022-06-10 10:47:46 +00:00
use App\Values\SongUpdateData;
use Illuminate\Support\Arr;
2022-06-10 10:47:46 +00:00
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Psr\Log\LoggerInterface;
use Throwable;
2022-06-10 10:47:46 +00:00
class SongService
{
public function __construct(
private SongRepository $songRepository,
private SongStorage $songStorage,
private LoggerInterface $logger
) {
2022-06-10 10:47:46 +00:00
}
/** @return Collection|array<array-key, Song> */
2022-10-12 09:27:35 +00:00
public function updateSongs(array $ids, SongUpdateData $data): Collection
2022-06-10 10:47:46 +00:00
{
if (count($ids) === 1) {
// If we're only updating one song, an empty non-required should be converted to the default values.
// This allows the user to clear those fields.
$data->disc = $data->disc ?: 1;
$data->track = $data->track ?: 0;
$data->lyrics = $data->lyrics ?: '';
$data->year = $data->year ?: null;
$data->genre = $data->genre ?: '';
$data->albumArtistName = $data->albumArtistName ?: $data->artistName;
}
2022-10-12 09:27:35 +00:00
return DB::transaction(function () use ($ids, $data): Collection {
return collect($ids)->reduce(function (Collection $updated, string $id) use ($data): Collection {
2022-06-10 10:47:46 +00:00
/** @var Song|null $song */
$song = Song::with('album', 'album.artist', 'artist')->find($id);
2022-07-29 06:47:10 +00:00
if ($song) {
$updated->push($this->updateSong($song, clone $data));
2022-06-10 10:47:46 +00:00
}
2022-10-12 09:27:35 +00:00
return $updated;
}, collect());
});
2022-06-10 10:47:46 +00:00
}
private function updateSong(Song $song, SongUpdateData $data): Song
{
// for non-nullable fields, if the provided data is empty, use the existing value
2022-10-12 09:27:35 +00:00
$data->albumName = $data->albumName ?: $song->album->name;
$data->artistName = $data->artistName ?: $song->artist->name;
$data->title = $data->title ?: $song->title;
// For nullable fields, use the existing value only if the provided data is explicitly null.
// This allows us to clear those fields.
$data->albumArtistName ??= $song->album_artist->name;
$data->lyrics ??= $song->lyrics;
$data->track ??= $song->track;
$data->disc ??= $song->disc;
$data->genre ??= $song->genre;
$data->year ??= $song->year;
2022-10-12 09:27:35 +00:00
$albumArtist = Artist::getOrCreate($data->albumArtistName);
$artist = Artist::getOrCreate($data->artistName);
$album = Album::getOrCreate($albumArtist, $data->albumName);
$song->album_id = $album->id;
$song->artist_id = $artist->id;
$song->title = $data->title;
$song->lyrics = $data->lyrics;
$song->track = $data->track;
$song->disc = $data->disc;
$song->genre = $data->genre;
$song->year = $data->year;
2022-06-10 10:47:46 +00:00
$song->push();
2022-06-10 10:47:46 +00:00
return $this->songRepository->getOne($song->id);
}
public function markSongsAsPublic(Collection $songs): void
{
Song::query()->whereIn('id', $songs->pluck('id'))->update(['is_public' => true]);
}
/** @return array<string> IDs of songs that are marked as private */
public function markSongsAsPrivate(Collection $songs): array
{
if (License::isPlus()) {
/**
* @var Collection|array<array-key, Song> $collaborativeSongs
* Songs that are in collaborative playlists and can't be marked as private as a result
*/
$collaborativeSongs = Song::query()
->whereIn('songs.id', $songs->pluck('id'))
->join('playlist_song', 'songs.id', '=', 'playlist_song.song_id')
->join('playlist_collaborators', 'playlist_song.playlist_id', '=', 'playlist_collaborators.playlist_id')
->select('songs.id')
->distinct()
->pluck('songs.id')
->all();
$applicableSongIds = $songs->whereNotIn('id', $collaborativeSongs)->pluck('id')->all();
} else {
$applicableSongIds = $songs->pluck('id')->all();
}
Song::query()->whereIn('id', $applicableSongIds)->update(['is_public' => false]);
return $applicableSongIds;
}
/**
* @param array<string>|string $ids
*/
public function deleteSongs(array|string $ids): void
{
$ids = Arr::wrap($ids);
DB::transaction(function () use ($ids): void {
$shouldBackUp = config('koel.backup_on_delete');
/** @var Collection|array<array-key, Song> $songs */
$songs = Song::query()->findMany($ids);
Song::destroy($ids);
$songs->each(function (Song $song) use ($shouldBackUp): void {
try {
$this->songStorage->delete($song, $shouldBackUp);
} catch (Throwable $e) {
$this->logger->error('Failed to remove song file', [
'path' => $song->path,
'exception' => $e,
]);
}
});
event(new LibraryChanged());
});
}
2022-06-10 10:47:46 +00:00
}