372 lines
14 KiB
C++
372 lines
14 KiB
C++
/*
|
|
* Copyright (C) 2024 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "ScanStepArtistReconciliation.hpp"
|
|
|
|
#include <cassert>
|
|
#include <ostream>
|
|
|
|
#include "core/ILogger.hpp"
|
|
|
|
#include "database/IDb.hpp"
|
|
#include "database/Session.hpp"
|
|
#include "database/objects/Artist.hpp"
|
|
#include "database/objects/ArtistInfo.hpp"
|
|
#include "database/objects/ReleaseArtistLink.hpp"
|
|
#include "database/objects/Track.hpp"
|
|
#include "database/objects/TrackArtistLink.hpp"
|
|
#include "database/objects/TrackList.hpp"
|
|
|
|
#include "ScanContext.hpp"
|
|
#include "ScannerSettings.hpp"
|
|
#include "helpers/ArtistHelpers.hpp"
|
|
#include "types/TrackMetadata.hpp"
|
|
|
|
namespace lms::scanner
|
|
{
|
|
namespace
|
|
{
|
|
std::ostream& operator<<(std::ostream& os, const db::Artist::pointer& artist)
|
|
{
|
|
os << "'" << artist->getName() << "'";
|
|
if (const auto mbid{ artist->getMBID() })
|
|
os << " [" << mbid->toString() << "]";
|
|
|
|
return os;
|
|
}
|
|
|
|
void recomputeArtist(db::Session& session, db::TrackArtistLink::pointer link, bool allowArtistMBIDFallback)
|
|
{
|
|
assert(!link->isArtistMBIDMatched());
|
|
|
|
Artist artistInfo{ std::nullopt, link->getArtistName(), link->getArtistSortName().empty() ? std::nullopt : std::make_optional<std::string>(link->getArtistSortName()) };
|
|
|
|
db::Artist::pointer newArtist{ helpers::getOrCreateArtistByName(session, artistInfo, helpers::AllowFallbackOnMBIDEntry{ allowArtistMBIDFallback }) };
|
|
LMS_LOG(DB, DEBUG, "Reconcile artist link for track " << link->getTrack()->getAbsoluteFilePath() << ", type " << static_cast<int>(link->getType()) << " from " << link->getArtist() << " to " << newArtist);
|
|
|
|
assert(newArtist != link->getArtist());
|
|
link.modify()->setArtist(newArtist);
|
|
}
|
|
|
|
void recomputeArtist(db::Session& session, db::ArtistInfo::pointer artistInfo, bool allowArtistMBIDFallback)
|
|
{
|
|
assert(!artistInfo->isMBIDMatched());
|
|
|
|
Artist artistMetadata{ std::nullopt, artistInfo->getName(), artistInfo->getSortName().empty() ? std::nullopt : std::make_optional<std::string>(artistInfo->getSortName()) };
|
|
db::Artist::pointer newArtist{ helpers::getOrCreateArtistByName(session, artistMetadata, helpers::AllowFallbackOnMBIDEntry{ allowArtistMBIDFallback }) };
|
|
LMS_LOG(DB, DEBUG, "Reconcile artist link for artist info " << artistInfo->getAbsoluteFilePath() << " from " << artistInfo->getArtist() << " to " << newArtist);
|
|
|
|
assert(newArtist != artistInfo->getArtist());
|
|
artistInfo.modify()->setArtist(newArtist);
|
|
}
|
|
|
|
struct ArtistReference
|
|
{
|
|
std::string name;
|
|
std::string sortName;
|
|
};
|
|
std::optional<ArtistReference> getMostRecentReleaseArtistReference(db::Session& session, db::ArtistId artistId)
|
|
{
|
|
std::optional<ArtistReference> ref;
|
|
|
|
db::ReleaseArtistLink::FindParameters params;
|
|
params.setArtist(artistId);
|
|
params.setSortMethod(db::ReleaseArtistLinkSortMethod::OriginalDateDesc);
|
|
params.setMBIDMatched(true);
|
|
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
|
|
|
db::ReleaseArtistLink::pointer foundLink;
|
|
db::ReleaseArtistLink::find(session, params, [&](const db::ReleaseArtistLink::pointer& link) {
|
|
ref = ArtistReference{ .name = std::string{ link->getArtistName() }, .sortName = std::string{ link->getArtistSortName() } };
|
|
});
|
|
|
|
return ref;
|
|
}
|
|
|
|
std::optional<ArtistReference> getMostRecentTrackArtistReference(db::Session& session, db::ArtistId artistId)
|
|
{
|
|
std::optional<ArtistReference> ref;
|
|
|
|
db::TrackArtistLink::FindParameters params;
|
|
params.setArtist(artistId);
|
|
params.setSortMethod(db::TrackArtistLinkSortMethod::OriginalDateDesc);
|
|
params.setMBIDMatched(true);
|
|
params.setRange(db::Range{ .offset = 0, .size = 1 });
|
|
|
|
db::TrackArtistLink::pointer foundLink;
|
|
db::TrackArtistLink::find(session, params, [&](const db::TrackArtistLink::pointer& link) {
|
|
ref = ArtistReference{ .name = std::string{ link->getArtistName() }, .sortName = std::string{ link->getArtistSortName() } };
|
|
});
|
|
|
|
return ref;
|
|
}
|
|
} // namespace
|
|
|
|
bool ScanStepArtistReconciliation::needProcess([[maybe_unused]] const ScanContext& context) const
|
|
{
|
|
// Since this step is very fast in case there is nothing to do, no need to skip if nothing has changed
|
|
return true;
|
|
}
|
|
|
|
void ScanStepArtistReconciliation::process(ScanContext& context)
|
|
{
|
|
// Reconcile artist name differences when MBID was used to match
|
|
updateArtistPreferredName(context);
|
|
|
|
// Reconcile artist links when MBID not used to match
|
|
{
|
|
// Order is important
|
|
updateLinksForArtistNameNoLongerMatch(context);
|
|
updateLinksWithArtistNameAmbiguity(context);
|
|
}
|
|
|
|
// Reconcile artist info when MBID not used to match
|
|
{
|
|
// Order is important
|
|
updateArtistInfoForArtistNameNoLongerMatch(context);
|
|
updateArtistInfoWithArtistNameAmbiguity(context);
|
|
}
|
|
}
|
|
|
|
void ScanStepArtistReconciliation::updateArtistPreferredName(ScanContext& context)
|
|
{
|
|
static constexpr std::size_t batchSize{ 50 };
|
|
|
|
db::Session& session{ _db.getTLSSession() };
|
|
|
|
// List artists that have different names when mbid matched.
|
|
// Possible reasons:
|
|
// - artist name changed over time (ex: Rhapsody then Rhapsody of Fire), legit use case
|
|
// - user renamed the artist
|
|
// Name to pick in order of priority:
|
|
// - name specified in artist info
|
|
// - name as referenced in the latest release of the artist
|
|
// - name as referenced in the latest link (any type)
|
|
|
|
struct ArtistToUpdate
|
|
{
|
|
db::Artist::pointer artist;
|
|
std::string newName;
|
|
std::string newSortName;
|
|
};
|
|
std::vector<ArtistToUpdate> artistsToUpdate;
|
|
auto updateArtists{ [&] {
|
|
auto transaction{ session.createWriteTransaction() };
|
|
|
|
for (auto& artistToUpdate : artistsToUpdate)
|
|
{
|
|
artistToUpdate.artist.modify()->setName(artistToUpdate.newName);
|
|
artistToUpdate.artist.modify()->setSortName(artistToUpdate.newSortName);
|
|
}
|
|
} };
|
|
|
|
db::ArtistId lastRetrievedArtist;
|
|
while (!_abortScan)
|
|
{
|
|
{
|
|
auto transaction{ session.createReadTransaction() };
|
|
|
|
const auto artists{ db::Artist::findWithMBIDNameVariants(session, lastRetrievedArtist, db::Range{ .offset = 0, .size = batchSize }) };
|
|
if (artists.empty())
|
|
break;
|
|
|
|
for (const db::Artist::pointer& artist : artists)
|
|
{
|
|
bool hasArtistInfo{};
|
|
db::ArtistInfo::find(session, artist->getId(), db::Range{ .offset = 0, .size = 1 }, [&](const db::ArtistInfo::pointer&) {
|
|
hasArtistInfo = true;
|
|
});
|
|
|
|
// Scanning artist info should have updated the name of the artist
|
|
if (hasArtistInfo)
|
|
continue;
|
|
|
|
std::optional<ArtistReference> mostRecentArtistRef{ getMostRecentReleaseArtistReference(session, artist->getId()) };
|
|
if (!mostRecentArtistRef)
|
|
mostRecentArtistRef = getMostRecentTrackArtistReference(session, artist->getId());
|
|
|
|
if (!mostRecentArtistRef)
|
|
{
|
|
LMS_LOG(DBUPDATER, DEBUG, "Unable to fix name discrepancy for artist " << artist << ": no link found!");
|
|
continue;
|
|
}
|
|
|
|
if (mostRecentArtistRef->name != artist->getName())
|
|
{
|
|
ArtistToUpdate& artistToUpdate{ artistsToUpdate.emplace_back() };
|
|
artistToUpdate.artist = artist;
|
|
artistToUpdate.newName = mostRecentArtistRef->name;
|
|
artistToUpdate.newSortName = mostRecentArtistRef->sortName;
|
|
|
|
LMS_LOG(DBUPDATER, DEBUG, "Updating artist " << artist << " name to '" << artistToUpdate.newName << "' using most recent artist link reference");
|
|
}
|
|
}
|
|
|
|
if (artists.size() < batchSize)
|
|
break;
|
|
}
|
|
|
|
if (artistsToUpdate.size() > batchSize)
|
|
{
|
|
updateArtists();
|
|
artistsToUpdate.clear();
|
|
}
|
|
}
|
|
|
|
updateArtists();
|
|
|
|
_progressCallback(context.currentStepStats);
|
|
}
|
|
|
|
void ScanStepArtistReconciliation::updateArtistInfoForArtistNameNoLongerMatch(ScanContext& context)
|
|
{
|
|
static constexpr std::size_t batchSize{ 50 };
|
|
|
|
const bool allowArtistMBIDFallback{ _settings.allowArtistMBIDFallback };
|
|
db::Session& session{ _db.getTLSSession() };
|
|
|
|
std::vector<db::ArtistInfo::pointer> artistInfo;
|
|
while (!_abortScan)
|
|
{
|
|
artistInfo.clear();
|
|
{
|
|
auto transaction{ session.createReadTransaction() };
|
|
db::ArtistInfo::findArtistNameNoLongerMatch(session, db::Range{ .offset = 0, .size = batchSize }, [&](const db::ArtistInfo::pointer& link) {
|
|
artistInfo.push_back(link);
|
|
});
|
|
}
|
|
|
|
if (artistInfo.empty())
|
|
break;
|
|
|
|
{
|
|
auto transaction{ session.createWriteTransaction() };
|
|
for (db::ArtistInfo::pointer& info : artistInfo)
|
|
{
|
|
recomputeArtist(session, info, allowArtistMBIDFallback);
|
|
context.currentStepStats.processedElems++;
|
|
}
|
|
|
|
_progressCallback(context.currentStepStats);
|
|
}
|
|
}
|
|
}
|
|
|
|
void ScanStepArtistReconciliation::updateArtistInfoWithArtistNameAmbiguity(ScanContext& context)
|
|
{
|
|
static constexpr std::size_t batchSize{ 50 };
|
|
|
|
const bool allowArtistMBIDFallback{ _settings.allowArtistMBIDFallback };
|
|
db::Session& session{ _db.getTLSSession() };
|
|
|
|
std::vector<db::ArtistInfo::pointer> artistInfo;
|
|
while (!_abortScan)
|
|
{
|
|
artistInfo.clear();
|
|
{
|
|
auto transaction{ session.createReadTransaction() };
|
|
db::ArtistInfo::findWithArtistNameAmbiguity(session, db::Range{ .offset = 0, .size = batchSize }, allowArtistMBIDFallback, [&](const db::ArtistInfo::pointer& info) {
|
|
artistInfo.push_back(info);
|
|
});
|
|
}
|
|
|
|
if (artistInfo.empty())
|
|
break;
|
|
|
|
{
|
|
auto transaction{ session.createWriteTransaction() };
|
|
for (db::ArtistInfo::pointer& info : artistInfo)
|
|
{
|
|
recomputeArtist(session, info, allowArtistMBIDFallback);
|
|
context.currentStepStats.processedElems++;
|
|
}
|
|
|
|
_progressCallback(context.currentStepStats);
|
|
}
|
|
}
|
|
}
|
|
void ScanStepArtistReconciliation::updateLinksForArtistNameNoLongerMatch(ScanContext& context)
|
|
{
|
|
static constexpr std::size_t batchSize{ 50 };
|
|
|
|
const bool allowArtistMBIDFallback{ _settings.allowArtistMBIDFallback };
|
|
db::Session& session{ _db.getTLSSession() };
|
|
|
|
std::vector<db::TrackArtistLink::pointer> links;
|
|
while (!_abortScan)
|
|
{
|
|
links.clear();
|
|
{
|
|
auto transaction{ session.createReadTransaction() };
|
|
db::TrackArtistLink::findArtistNameNoLongerMatch(session, db::Range{ .offset = 0, .size = batchSize }, [&](const db::TrackArtistLink::pointer& link) {
|
|
links.push_back(link);
|
|
});
|
|
}
|
|
|
|
if (links.empty())
|
|
break;
|
|
|
|
{
|
|
auto transaction{ session.createWriteTransaction() };
|
|
for (db::TrackArtistLink::pointer& link : links)
|
|
{
|
|
recomputeArtist(session, link, allowArtistMBIDFallback);
|
|
context.currentStepStats.processedElems++;
|
|
}
|
|
|
|
_progressCallback(context.currentStepStats);
|
|
}
|
|
}
|
|
}
|
|
|
|
void ScanStepArtistReconciliation::updateLinksWithArtistNameAmbiguity(ScanContext& context)
|
|
{
|
|
static constexpr std::size_t batchSize{ 50 };
|
|
|
|
const bool allowArtistMBIDFallback{ _settings.allowArtistMBIDFallback };
|
|
db::Session& session{ _db.getTLSSession() };
|
|
|
|
std::vector<db::TrackArtistLink::pointer> links;
|
|
while (!_abortScan)
|
|
{
|
|
links.clear();
|
|
{
|
|
auto transaction{ session.createReadTransaction() };
|
|
db::TrackArtistLink::findWithArtistNameAmbiguity(session, db::Range{ .offset = 0, .size = batchSize }, allowArtistMBIDFallback, [&](const db::TrackArtistLink::pointer& link) {
|
|
links.push_back(link);
|
|
});
|
|
}
|
|
|
|
if (links.empty())
|
|
break;
|
|
|
|
{
|
|
auto transaction{ session.createWriteTransaction() };
|
|
for (db::TrackArtistLink::pointer& link : links)
|
|
{
|
|
recomputeArtist(session, link, allowArtistMBIDFallback);
|
|
context.currentStepStats.processedElems++;
|
|
}
|
|
|
|
_progressCallback(context.currentStepStats);
|
|
}
|
|
}
|
|
}
|
|
} // namespace lms::scanner
|