owen/lms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added an option to skip playlists that are refering to a single album + skip playlists that are empty, fixes #577

Browse Source
This commit is contained in:
emeric
2025-01-15 21:14:18 +01:00
parent 4a75e5220e
commit 1d15be1e6c
15 changed files with 154 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/libs/database/impl/Migration.cpp
+8 -1
View File
@@ -35,7 +35,7 @@ namespace lms::db
{
namespace
{
static constexpr Version LMS_DATABASE_VERSION{ 77 };
static constexpr Version LMS_DATABASE_VERSION{ 78 };
}
VersionInfo::VersionInfo()
@@ -1029,6 +1029,12 @@ FROM tracklist)");
utils::executeCommand(*session.getDboSession(), "UPDATE scan_settings SET scan_version = scan_version + 1");
}
void migrateFromV77(Session& session)
{
// added new scan settings: skip single release playlists (default value is conservative, no need to rescan)
utils::executeCommand(*session.getDboSession(), "ALTER TABLE scan_settings ADD COLUMN skip_single_release_playlists BOOLEAN NOT NULL DEFAULT(FALSE)");
}
bool doDbMigration(Session& session)
{
constexpr std::string_view outdatedMsg{ "Outdated database, please rebuild it (delete the .db file and restart)" };
@@ -1082,6 +1088,7 @@ FROM tracklist)");
{ 74, migrateFromV74 },
{ 75, migrateFromV75 },
{ 76, migrateFromV76 },
{ 77, migrateFromV77 },
};
bool migrationPerformed{};
src/libs/database/impl/ScanSettings.cpp
+9
View File
@@ -94,6 +94,15 @@ namespace lms::db
}
}
void ScanSettings::setSkipSingleReleasePlayLists(bool value)
{
if (_skipSingleReleasePlayLists != value)
{
_skipSingleReleasePlayLists = value;
incScanVersion();
}
}
void ScanSettings::incScanVersion()
{
_scanVersion += 1;
src/libs/database/include/database/ScanSettings.hpp
+4
View File
@@ -70,6 +70,7 @@ namespace lms::db
SimilarityEngineType getSimilarityEngineType() const { return _similarityEngineType; }
std::vector<std::string> getArtistTagDelimiters() const;
std::vector<std::string> getDefaultTagDelimiters() const;
bool getSkipSingleReleasePlayLists() const { return _skipSingleReleasePlayLists; }
// Setters
void setUpdateStartTime(Wt::WTime t) { _startTime = t; }
@@ -78,6 +79,7 @@ namespace lms::db
void setSimilarityEngineType(SimilarityEngineType type) { _similarityEngineType = type; }
void setArtistTagDelimiters(std::span<const std::string_view> delimiters);
void setDefaultTagDelimiters(std::span<const std::string_view> delimiters);
void setSkipSingleReleasePlayLists(bool value);
void incScanVersion();
template<class Action>
@@ -90,6 +92,7 @@ namespace lms::db
Wt::Dbo::field(a, _extraTagsToScan, "extra_tags_to_scan");
Wt::Dbo::field(a, _artistTagDelimiters, "artist_tag_delimiters");
Wt::Dbo::field(a, _defaultTagDelimiters, "default_tag_delimiters");
Wt::Dbo::field(a, _skipSingleReleasePlayLists, "skip_single_release_playlists");
}
private:
@@ -100,5 +103,6 @@ namespace lms::db
std::string _extraTagsToScan;
std::string _artistTagDelimiters;
std::string _defaultTagDelimiters;
bool _skipSingleReleasePlayLists{ false };
};
} // namespace lms::db
src/libs/database/include/database/Track.hpp
+1
View File
@@ -294,6 +294,7 @@ namespace lms::db
std::vector<ObjectPtr<Artist>> getArtists(core::EnumSet<TrackArtistLinkType> artistLinkTypes) const; // no type means all
std::vector<ArtistId> getArtistIds(core::EnumSet<TrackArtistLinkType> artistLinkTypes) const; // no type means all
std::vector<ObjectPtr<TrackArtistLink>> getArtistLinks() const;
ReleaseId getReleaseId() const { return _release.id(); }
ObjectPtr<Release> getRelease() const { return _release; }
std::vector<ObjectPtr<Cluster>> getClusters() const;
std::vector<ClusterId> getClusterIds() const;
src/libs/services/scanner/impl/ScannerService.cpp
+2 -1
View File
@@ -338,7 +338,6 @@ namespace lms::scanner
return;
LMS_LOG(DBUPDATER, DEBUG, "Scanner settings updated");
LMS_LOG(DBUPDATER, DEBUG, "skipDuplicateMBID = " << newSettings.skipDuplicateMBID);
LMS_LOG(DBUPDATER, DEBUG, "Using scan settings version " << newSettings.scanVersion);
_settings = std::move(newSettings);
@@ -406,6 +405,8 @@ namespace lms::scanner
newSettings.artistTagDelimiters = scanSettings->getArtistTagDelimiters();
newSettings.defaultTagDelimiters = scanSettings->getDefaultTagDelimiters();
newSettings.skipSingleReleasePlayLists = scanSettings->getSkipSingleReleasePlayLists();
}
return newSettings;
src/libs/services/scanner/impl/ScannerSettings.hpp
+2
View File
@@ -42,6 +42,8 @@ namespace lms::scanner
std::vector<std::string> extraTags;
std::vector<std::string> artistTagDelimiters;
std::vector<std::string> defaultTagDelimiters;
bool skipSingleReleasePlayLists{};
std::vector<MediaLibraryInfo> mediaLibraries;
bool operator==(const ScannerSettings& rhs) const = default;
src/libs/services/scanner/impl/scanners/PlayListFileScanner.cpp
+1
View File
@@ -100,6 +100,7 @@ namespace lms::scanner
stats.deletions++;
}
context.stats.errors.emplace_back(_file, ScanErrorType::CannotReadPlayListFile);
LMS_LOG(DBUPDATER, DEBUG, "Removed playlist file " << _file);
return;
}
src/libs/services/scanner/impl/steps/ScanStepAssociatePlayListTracks.cpp
+58 -13
View File
@@ -26,10 +26,13 @@
#include "database/Db.hpp"
#include "database/Directory.hpp"
#include "database/PlayListFile.hpp"
#include "database/ReleaseId.hpp"
#include "database/Session.hpp"
#include "database/Track.hpp"
#include "database/TrackList.hpp"
#include "ScannerSettings.hpp"
namespace lms::scanner
{
namespace
@@ -37,10 +40,17 @@ namespace lms::scanner
constexpr std::size_t readBatchSize{ 20 };
constexpr std::size_t writeBatchSize{ 5 };
struct TrackInfo
{
db::TrackId trackId;
db::ReleaseId releaseId;
};
struct PlayListFileAssociation
{
db::PlayListFileId playListFileIdId;
std::vector<db::TrackId> trackIds;
std::vector<TrackInfo> tracks;
};
using PlayListFileAssociationContainer = std::deque<PlayListFileAssociation>;
@@ -49,6 +59,7 @@ namespace lms::scanner
db::Session& session;
db::PlayListFileId lastRetrievedPlayListFileId;
std::size_t processedPlayListFileCount{};
const ScannerSettings& settings;
};
db::Track::pointer getMatchingTrack(db::Session& session, const std::filesystem::path& filePath, const db::Directory::pointer& playListDirectory)
@@ -67,7 +78,19 @@ namespace lms::scanner
return matchingTrack;
}
bool trackListNeedsUpdate(db::Session& session, std::string_view name, std::span<const db::TrackId> trackIds, const db::TrackList::pointer& trackList)
bool isSingleReleasePlayList(std::span<const TrackInfo> tracks)
{
if (tracks.empty())
return true;
const db::ReleaseId releaseId{ tracks.front().releaseId };
if (std::all_of(std::cbegin(tracks) + 1, std::cend(tracks), [=](const TrackInfo& trackInfo) { return trackInfo.releaseId == releaseId; }))
return true;
return false;
}
bool trackListNeedsUpdate(db::Session& session, std::string_view name, std::span<const TrackInfo> tracks, const db::TrackList::pointer& trackList)
{
if (trackList->getName() != name)
return true;
@@ -78,13 +101,13 @@ namespace lms::scanner
bool needUpdate{};
std::size_t currentIndex{};
db::TrackListEntry::find(session, params, [&](const db::TrackListEntry::pointer& entry) {
if (currentIndex > trackIds.size() || trackIds[currentIndex] != entry->getTrackId())
if (currentIndex > tracks.size() || tracks[currentIndex].trackId != entry->getTrackId())
needUpdate = true;
currentIndex += 1;
});
if (currentIndex != trackIds.size())
if (currentIndex != tracks.size())
needUpdate = true;
return needUpdate;
@@ -108,20 +131,27 @@ namespace lms::scanner
// TODO optim: no need to fetch the whole track
db::Track::pointer track{ getMatchingTrack(searchContext.session, file, playListFile->getDirectory()) };
if (track)
playListAssociation.trackIds.push_back(track->getId());
playListAssociation.tracks.push_back(TrackInfo{ .trackId = track->getId(), .releaseId = track->getReleaseId() });
else
LMS_LOG(DBUPDATER, DEBUG, "Track '" << file.string() << "' not found in playlist '" << playListFile->getAbsoluteFilePath().string() << "'");
LMS_LOG(DBUPDATER, DEBUG, "Track " << file << " not found in playlist " << playListFile->getAbsoluteFilePath());
}
if (playListAssociation.tracks.empty()
|| (searchContext.settings.skipSingleReleasePlayLists && isSingleReleasePlayList(playListAssociation.tracks)))
{
playListAssociation.tracks.clear();
}
bool needUpdate{ true };
if (const db::TrackList::pointer trackList{ playListFile->getTrackList() })
needUpdate = trackListNeedsUpdate(searchContext.session, playListFile->getName(), playListAssociation.trackIds, trackList);
{
if (!playListAssociation.tracks.empty())
needUpdate = trackListNeedsUpdate(searchContext.session, playListFile->getName(), playListAssociation.tracks, trackList);
}
if (needUpdate)
{
LMS_LOG(DBUPDATER, DEBUG, "Updating PlayList '" << playListFile->getAbsoluteFilePath().string() << "' (" << playListAssociation.trackIds.size() << " files)");
playListFileAssociations.emplace_back(std::move(playListAssociation));
}
searchContext.processedPlayListFileCount++;
});
}
@@ -135,7 +165,19 @@ namespace lms::scanner
assert(playListFile);
db::TrackList::pointer trackList{ playListFile->getTrackList() };
if (!trackList)
if (playListFileAssociation.tracks.empty())
{
if (trackList)
{
LMS_LOG(DBUPDATER, DEBUG, "Removed associated tracklist for " << playListFile->getAbsoluteFilePath() << "");
trackList.remove();
}
return;
}
const bool createTrackList{ !trackList };
if (createTrackList)
{
trackList = session.create<db::TrackList>(playListFile->getName(), db::TrackListType::PlayList);
playListFile.modify()->setTrackList(trackList);
@@ -146,11 +188,13 @@ namespace lms::scanner
trackList.modify()->setName(playListFile->getName());
trackList.modify()->clear();
for (const db::TrackId trackId : playListFileAssociation.trackIds)
for (const TrackInfo trackInfo : playListFileAssociation.tracks)
{
if (db::Track::pointer track{ db::Track::find(session, trackId) })
if (db::Track::pointer track{ db::Track::find(session, trackInfo.trackId) })
session.create<db::TrackListEntry>(track, trackList, playListFile->getLastWriteTime());
}
LMS_LOG(DBUPDATER, DEBUG, std::string_view{ createTrackList ? "Created" : "Updated" } << " associated tracklist for " << playListFile->getAbsoluteFilePath() << " (" << playListFileAssociation.tracks.size() << " tracks)");
}
void updatePlayListFiles(db::Session& session, PlayListFileAssociationContainer& playListFileAssociations)
@@ -186,6 +230,7 @@ namespace lms::scanner
SearchPlayListFileContext searchContext{
.session = session,
.lastRetrievedPlayListFileId = {},
.settings = _settings,
};
PlayListFileAssociationContainer playListFileAssociations;
src/lms/ui/admin/ScanSettingsView.cpp
+29 -9
View File
@@ -19,6 +19,7 @@
#include "ScanSettingsView.hpp"
#include <Wt/WCheckBox.h>
#include <Wt/WComboBox.h>
#include <Wt/WFormModel.h>
#include <Wt/WLineEdit.h>
@@ -69,6 +70,7 @@ namespace lms::ui
static inline constexpr Field UpdatePeriodField{ "update-period" };
static inline constexpr Field UpdateStartTimeField{ "update-start-time" };
static inline constexpr Field SimilarityEngineTypeField{ "similarity-engine-type" };
static inline constexpr Field SkipSingleReleasePlayLists{ "skip-single-release-playlists" };
using UpdatePeriodModel = ValueStringModel<ScanSettings::UpdatePeriod>;
@@ -79,10 +81,12 @@ namespace lms::ui
addField(UpdatePeriodField);
addField(UpdateStartTimeField);
addField(SimilarityEngineTypeField);
addField(SkipSingleReleasePlayLists);
setValidator(UpdatePeriodField, createMandatoryValidator());
setValidator(UpdateStartTimeField, createMandatoryValidator());
setValidator(SimilarityEngineTypeField, createMandatoryValidator());
setValidator(SkipSingleReleasePlayLists, createMandatoryValidator());
}
std::shared_ptr<UpdatePeriodModel> updatePeriodModel() { return _updatePeriodModel; }
@@ -109,6 +113,8 @@ namespace lms::ui
setReadOnly(DatabaseSettingsModel::UpdateStartTimeField, true);
}
setValue(SkipSingleReleasePlayLists, scanSettings->getSkipSingleReleasePlayLists());
auto similarityEngineTypeRow{ _similarityEngineTypeModel->getRowFromValue(scanSettings->getSimilarityEngineType()) };
if (similarityEngineTypeRow)
setValue(SimilarityEngineTypeField, _similarityEngineTypeModel->getString(*similarityEngineTypeRow));
@@ -126,17 +132,28 @@ namespace lms::ui
ScanSettings::pointer scanSettings{ ScanSettings::get(LmsApp->getDbSession()) };
auto updatePeriodRow{ _updatePeriodModel->getRowFromString(valueText(UpdatePeriodField)) };
if (updatePeriodRow)
scanSettings.modify()->setUpdatePeriod(_updatePeriodModel->getValue(*updatePeriodRow));
{
const auto updatePeriodRow{ _updatePeriodModel->getRowFromString(valueText(UpdatePeriodField)) };
if (updatePeriodRow)
scanSettings.modify()->setUpdatePeriod(_updatePeriodModel->getValue(*updatePeriodRow));
}
auto startTimeRow{ _updateStartTimeModel->getRowFromString(valueText(UpdateStartTimeField)) };
if (startTimeRow)
scanSettings.modify()->setUpdateStartTime(_updateStartTimeModel->getValue(*startTimeRow));
{
const auto startTimeRow{ _updateStartTimeModel->getRowFromString(valueText(UpdateStartTimeField)) };
if (startTimeRow)
scanSettings.modify()->setUpdateStartTime(_updateStartTimeModel->getValue(*startTimeRow));
}
auto similarityEngineTypeRow{ _similarityEngineTypeModel->getRowFromString(valueText(SimilarityEngineTypeField)) };
if (similarityEngineTypeRow)
scanSettings.modify()->setSimilarityEngineType(_similarityEngineTypeModel->getValue(*similarityEngineTypeRow));
{
const bool skipSingleReleasePlayLists{ Wt::asNumber(value(SkipSingleReleasePlayLists)) != 0 };
scanSettings.modify()->setSkipSingleReleasePlayLists(skipSingleReleasePlayLists);
}
{
const auto similarityEngineTypeRow{ _similarityEngineTypeModel->getRowFromString(valueText(SimilarityEngineTypeField)) };
if (similarityEngineTypeRow)
scanSettings.modify()->setSimilarityEngineType(_similarityEngineTypeModel->getValue(*similarityEngineTypeRow));
}
scanSettings.modify()->setExtraTagsToScan(extraTagsToScan);
scanSettings.modify()->setArtistTagDelimiters(artistDelimiters);
@@ -318,6 +335,9 @@ namespace lms::ui
updateStartTime->setModel(model->updateStartTimeModel());
t->setFormWidget(DatabaseSettingsModel::UpdateStartTimeField, std::move(updateStartTime));
// Skip playlists
t->setFormWidget(DatabaseSettingsModel::SkipSingleReleasePlayLists, std::make_unique<Wt::WCheckBox>());
// Similarity engine type
auto similarityEngineType{ std::make_unique<Wt::WComboBox>() };
similarityEngineType->setModel(model->similarityEngineTypeModel());