/*
* Copyright (C) 2023 Emeric Poupon
*
* This file is part of LMS.
*
* LMS is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* LMS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with LMS. If not, see .
*/
#include "responses/Album.hpp"
#include "core/ITraceLogger.hpp"
#include "core/Service.hpp"
#include "core/String.hpp"
#include "database/Artist.hpp"
#include "database/Cluster.hpp"
#include "database/Directory.hpp"
#include "database/Release.hpp"
#include "database/User.hpp"
#include "services/feedback/IFeedbackService.hpp"
#include "services/scrobbling/IScrobblingService.hpp"
#include "RequestContext.hpp"
#include "SubsonicId.hpp"
#include "responses/Artist.hpp"
#include "responses/DiscTitle.hpp"
#include "responses/ItemDate.hpp"
#include "responses/ItemGenre.hpp"
#include "responses/RecordLabel.hpp"
namespace lms::api::subsonic
{
using namespace db;
Response::Node createAlbumNode(RequestContext& context, const Release::pointer& release, bool id3, const Directory::pointer& directory)
{
LMS_SCOPED_TRACE_DETAILED("Subsonic", "CreateAlbum");
Response::Node albumNode;
if (id3)
{
albumNode.setAttribute("id", idToString(release->getId()));
albumNode.setAttribute("name", release->getName());
albumNode.setAttribute("songCount", release->getTrackCount());
albumNode.setAttribute("duration", std::chrono::duration_cast(release->getDuration()).count());
}
else
{
Directory::pointer directoryToReport{ directory };
if (!directoryToReport)
{
Directory::FindParameters params;
params.setRelease(release->getId());
params.setRange(Range{ 0, 1 }); // only support 1 directory <-> 1 release
Directory::find(context.dbSession, params, [&](const Directory::pointer& foundDirectory) {
directoryToReport = foundDirectory;
});
}
if (directoryToReport)
{
albumNode.setAttribute("title", directoryToReport->getName());
albumNode.setAttribute("id", idToString(directoryToReport->getId()));
if (const Directory::pointer & parentDirectory{ directoryToReport->getParentDirectory() })
albumNode.setAttribute("parent", idToString(parentDirectory->getId()));
}
albumNode.setAttribute("album", release->getName());
albumNode.setAttribute("isDir", true);
}
albumNode.setAttribute("created", core::stringUtils::toISO8601String(release->getLastWritten()));
albumNode.setAttribute("coverArt", idToString(release->getId()));
if (const auto year{ release->getYear() })
albumNode.setAttribute("year", *year);
auto artists{ release->getReleaseArtists() };
if (artists.empty())
artists = release->getArtists();
if (!artists.empty())
{
if (!release->getArtistDisplayName().empty())
albumNode.setAttribute("artist", release->getArtistDisplayName());
else
albumNode.setAttribute("artist", utils::joinArtistNames(artists));
if (artists.size() == 1)
{
albumNode.setAttribute("artistId", idToString(artists.front()->getId()));
}
}
albumNode.setAttribute("playCount", core::Service::get()->getCount(context.user->getId(), release->getId()));
// Report the first GENRE for this track
const ClusterType::pointer genreClusterType{ ClusterType::find(context.dbSession, "GENRE") };
if (genreClusterType)
{
auto clusters{ release->getClusterGroups({ genreClusterType->getId() }, 1) };
if (!clusters.empty() && !clusters.front().empty())
albumNode.setAttribute("genre", clusters.front().front()->getName());
}
if (const Wt::WDateTime dateTime{ core::Service::get()->getStarredDateTime(context.user->getId(), release->getId()) }; dateTime.isValid())
albumNode.setAttribute("starred", core::stringUtils::toISO8601String(dateTime));
// Always report user rating, even if legacy API only specified it for directories
if (const auto rating{ core::Service::get()->getRating(context.user->getId(), release->getId()) })
albumNode.setAttribute("userRating", *rating);
if (!context.enableOpenSubsonic)
return albumNode;
// OpenSubsonic specific fields (must always be set)
albumNode.setAttribute("sortName", release->getSortName());
albumNode.setAttribute("mediaType", "album");
{
const Wt::WDateTime dateTime{ core::Service::get()->getLastListenDateTime(context.user->getId(), release->getId()) };
albumNode.setAttribute("played", dateTime.isValid() ? core::stringUtils::toISO8601String(dateTime) : std::string{ "" });
}
{
std::optional mbid{ release->getMBID() };
albumNode.setAttribute("musicBrainzId", mbid ? mbid->getAsString() : "");
}
auto addClusters{ [&](Response::Node::Key field, std::string_view clusterTypeName) {
albumNode.createEmptyArrayValue(field);
Cluster::FindParameters params;
params.setRelease(release->getId());
params.setClusterTypeName(clusterTypeName);
Cluster::find(context.dbSession, params, [&](const Cluster::pointer& cluster) {
albumNode.addArrayValue(field, cluster->getName());
});
} };
addClusters("moods", "MOOD");
// Genres
albumNode.createEmptyArrayChild("genres");
if (genreClusterType)
{
Cluster::FindParameters params;
params.setRelease(release->getId());
params.setClusterType(genreClusterType->getId());
Cluster::find(context.dbSession, params, [&](const Cluster::pointer& cluster) {
albumNode.addArrayChild("genres", createItemGenreNode(cluster->getName()));
});
}
albumNode.createEmptyArrayChild("artists");
for (const Artist::pointer& artist : release->getReleaseArtists())
albumNode.addArrayChild("artists", createArtistNode(artist));
albumNode.setAttribute("displayArtist", release->getArtistDisplayName());
albumNode.addChild("originalReleaseDate", createItemDateNode(release->getOriginalDate(), release->getOriginalYear()));
albumNode.setAttribute("isCompilation", release->isCompilation());
albumNode.createEmptyArrayValue("releaseTypes");
for (std::string_view releaseType : release->getReleaseTypeNames())
albumNode.addArrayValue("releaseTypes", releaseType);
albumNode.createEmptyArrayChild("discTitles");
for (const DiscInfo& discInfo : release->getDiscs())
{
if (!discInfo.name.empty())
albumNode.addArrayChild("discTitles", createDiscTitle(discInfo));
}
albumNode.createEmptyArrayChild("recordLabels");
release->visitLabels([&](const Label::pointer& label) {
albumNode.addArrayChild("recordLabels", createRecordLabel(label));
});
return albumNode;
}
} // namespace lms::api::subsonic