diff --git a/CMakeLists.txt b/CMakeLists.txt index 6cb75ea9..454f7397 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.12) -project(lms) +project(lms VERSION 3.69.0) set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake/modules/) diff --git a/README.md b/README.md index 7141ba87..a327bd39 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,9 @@ If neither exists, it will then search for a file named `artist` (or another nam 2. Scan for the image: the directory is scanned starting from this common path, moving upwards if needed, until the artist image file is found. 3. Fallback search: if no image is found, _LMS_ will then search within each individual album folder. +## Disc image lookup +_LMS_ automatically associates images with each disc in your collection. Name the image file after the disc's subtitle or another identifier configured in `lms.conf` (see the `medium-image-file-names` setting), and place it in the same directory as the disc's tracks. If no suitable image is found, LMS will also look for embedded images within the tracks of the disc. + ## Playlist support _LMS_ supports playlist files in `m3u` and `m3u8` formats. These playlists are synced during the scan process and are available as public shared playlists. diff --git a/approot/admin-about.xml b/approot/admin-about.xml new file mode 100644 index 00000000..44b2f5c8 --- /dev/null +++ b/approot/admin-about.xml @@ -0,0 +1,39 @@ + + + + +
+
+
+
+
${tr:Lms.Admin.About.about}
+
+
+
+
+
+ ${tr:Lms.Admin.About.version} +
+
+ ${version} +
+
+
+
+ ${tr:Lms.Admin.About.homepage} +
+
+ ${homepage-link} +
+
+
+
+
+ ${ok-btn class="btn btn-primary"} +
+
+
+
+ + + diff --git a/approot/main.xml b/approot/main.xml index d9c0fcd4..bc1eb859 100644 --- a/approot/main.xml +++ b/approot/main.xml @@ -44,6 +44,7 @@
  • ${scan-settings class="dropdown-item"}
  • ${scanner class="dropdown-item"}
  • ${users class="dropdown-item"}
    • +
  • ${about class="dropdown-item"}
    • ${}
  • ${debug-tools class="dropdown-item"}
    • @@ -57,7 +58,6 @@ diff --git a/approot/messages.xml b/approot/messages.xml index 070c40f2..8ef86dac 100644 --- a/approot/messages.xml +++ b/approot/messages.xml @@ -52,12 +52,18 @@ User not found + About Debug tools Libraries Scan settings Scanner Users + +About +Homepage +Version + Music libraries Create library @@ -101,11 +107,11 @@ Cannot get track duration -Unable to read the image at index {1} +Unable to read the image at index {1}: {2} Cannot parse artist info file Cannot parse audio file Cannot read file ({1}) -Cannot parse image file +Cannot parse image file: {1} Cannot parse lyrics file Cannot parse playlist file Compact the database. Caution: this may take a while and will block the whole application during the compact step! diff --git a/approot/messages_es.xml b/approot/messages_es.xml index 0bce3785..f10b5bbe 100644 --- a/approot/messages_es.xml +++ b/approot/messages_es.xml @@ -52,12 +52,18 @@ No existe el usuario + Acerca de Herramientas de depuración Bibliotecas Opciones de escaneo Escanear Usuarios + +Acerca de +Página principal +Versión + Bibliotecas musicales Crear una biblioteca @@ -101,11 +107,11 @@ No ha sido posible obtener la duración de la pista -No se puede leer la imagen en el índice {1} +No se puede leer la imagen en el índice {1} : {2} No ha sido posible analizar el fichero de información sobre el artista No ha sido posible analizar el fichero de audio No ha sido posible leer el fichero ({1}) -No ha sido posible analizar del fichero de imagen +No ha sido posible analizar del fichero de imagen : {1} No ha sido posible analizar el fichero de letras No ha sido posible analizar el fichero de la lista de distribución Compactar la base de datos. ¡Atención!: esta operación puede tardar bastante tiempo y la aplicación se bloqueará mientras dura la operación de compactación diff --git a/approot/messages_fr.xml b/approot/messages_fr.xml index c8c654b0..40a1ca5d 100644 --- a/approot/messages_fr.xml +++ b/approot/messages_fr.xml @@ -52,12 +52,18 @@ L'utilisateur n'existe pas + À propos Outils de débogage Bibliothèques Paramètres du scan Scanner Utilisateurs + +À propos +Page d’accueil +Version + Bibliothèques musicales Créer une bibliothèque @@ -101,11 +107,11 @@ Impossible de récupérer la durée de la piste -Impossible de lire l'image à l'indice {1} +Impossible de lire l'image à l'indice {1} : {2} Impossible d'analyser le fichier d'informations sur l'artiste Impossible d'analyser le fichier audio Impossible de lire le fichier ({1}) -Impossible d'analyser le fichier image +Impossible d'analyser le fichier image : {1} Impossible d'analyser le fichier de paroles Impossible d'analyser le fichier de liste de lecture Compacter la base de données. Attention : cette opération peut prendre du temps et va vérouiller l'application pendant toute l'étape de compactage! diff --git a/approot/messages_it.xml b/approot/messages_it.xml index 42a157a5..0238697e 100644 --- a/approot/messages_it.xml +++ b/approot/messages_it.xml @@ -52,12 +52,18 @@ Utente non trovato + Informazioni Strumenti di debug Librerie Impostazioni di scansione Scanner Utenti + +Informazioni +Pagina iniziale +Versione + Librerie musicali Crea libreria @@ -101,11 +107,11 @@ Non sono stato in grado di determinare la durata della traccia -Impossibile leggere l'immagine all'indice {1} +Impossibile leggere l'immagine all'indice {1} : {2} Impossibile analizzare il file delle informazioni sull'artista Impossibile analizzare il file audio Non in grado di leggere il file ({1}) -Impossibile analizzare il file immagine +Impossibile analizzare il file immagine : {1} Impossibile analizzare il file dei testi Impossibile analizzare il file della playlist Compatta il database. Attenzione: ciò potrebbe richiedere del tempo e bloccherà l'intera applicazione durante il passaggio di compattazione! diff --git a/approot/messages_pl.xml b/approot/messages_pl.xml index 5adcdb87..41792a50 100644 --- a/approot/messages_pl.xml +++ b/approot/messages_pl.xml @@ -53,12 +53,18 @@ Użytkownik nie odnaleziony + O programie Narzędzia debugowania Biblioteki Ustawienia skanowania Skaner Użytkownicy + +O programie +Strona główna +Wersja + Biblioteki muzyczne Utwórz bibliotekę @@ -102,11 +108,11 @@ Nie udało się ustalić długości ścieżki -Nie można odczytać obrazu pod indeksem {1} +Nie można odczytać obrazu pod indeksem {1} : {2} Nie można przetworzyć pliku z informacjami o artyście" Nie można przeanalizować pliku audio Nie udało się odczytać pliku ({1}) -Nie można przeanalizować pliku obrazu +Nie można przeanalizować pliku obrazu : {1} Nie można przetworzyć pliku z tekstem Nie można przeanalizować pliku playlisty Sprasuj bazę danych. Uwaga: może to trochę zająć, a cała aplikacja będzie w tym czasie zablokowana! diff --git a/approot/messages_zh.xml b/approot/messages_zh.xml index 6ca9201f..5125fd20 100644 --- a/approot/messages_zh.xml +++ b/approot/messages_zh.xml @@ -58,6 +58,12 @@ + + + + + + diff --git a/approot/misc.xml b/approot/misc.xml index 78ebf5b2..6fd85b17 100644 --- a/approot/misc.xml +++ b/approot/misc.xml @@ -19,6 +19,8 @@ + + diff --git a/approot/release.xml b/approot/release.xml index 92160133..0d856885 100644 --- a/approot/release.xml +++ b/approot/release.xml @@ -33,7 +33,7 @@
    - ${container class="d-grid gap-3"} + ${disc-container class="d-grid gap-3"} ${}
    ${copyright class="text-reset"}
    ${    } @@ -101,6 +101,7 @@
    ${play-btn class="d-none d-sm-block btn btn-sm btn-outline-secondary border-0"} + ${star-btn class="d-none d-sm-block btn btn-sm btn-outline-secondary border-0"}
    ${more-btn data-bs-toggle="dropdown" aria-expanded="false" class="btn btn-sm btn-outline-secondary border-0"}
      diff --git a/approot/tracks.xml b/approot/tracks.xml index f8caea0e..9117cf1b 100644 --- a/approot/tracks.xml +++ b/approot/tracks.xml @@ -51,6 +51,7 @@
    ${play-btn class="d-none d-sm-block btn btn-sm btn-outline-secondary border-0"} + ${star-btn class="d-none d-sm-block btn btn-sm btn-outline-secondary border-0"}
    ${more-btn data-bs-toggle="dropdown" aria-expanded="false" class="btn btn-sm btn-outline-secondary border-0"}
      diff --git a/conf/lms.conf b/conf/lms.conf index 4636f82e..124bde9f 100644 --- a/conf/lms.conf +++ b/conf/lms.conf @@ -7,9 +7,8 @@ working-dir = "/var/lms"; # ffmpeg location ffmpeg-file = "/usr/bin/ffmpeg"; -# Log files, empty means stdout +# Log files, empty means debug+info on stdout, warning+error+fatal on stderr log-file = ""; -access-log-file = ""; # Minimum severity, can be "debug", "info", "warning", "error" or "fatal" # "debug" is useful for debugging purposes, but it will also generate a lot of log data and slow down the application log-min-severity = "info"; @@ -99,13 +98,17 @@ cover-max-cache-size = 30; # JPEG quality for covers (range is 1-100) cover-jpeg-quality = 75; -# Preferred file names for covers (order is important) +# Preferred file names for covers (order is important, accept wildcards) cover-preferred-file-names = ("cover", "front", "folder", "default"); -# File names for artist images (order is important) +# File names for artist images (order is important, accept wildcards) # Note: files whose name is the artist's MBID are always searched before the names in this list. You can place the MBID files anywhere in your libraries. artist-image-file-names = ("artist"); +# File names for medium images (order is important, accept wildcards) +# Note: files named after the disc itself are always searched before the names in this list. +medium-image-file-names = ("discsubtitle"); + # Playqueue max entry count playqueue-max-entry-count = 1000; diff --git a/src/libs/core/CMakeLists.txt b/src/libs/core/CMakeLists.txt index 0eb0675e..06ae031b 100644 --- a/src/libs/core/CMakeLists.txt +++ b/src/libs/core/CMakeLists.txt @@ -2,6 +2,14 @@ pkg_check_modules(Config++ REQUIRED IMPORTED_TARGET libconfig++) pkg_check_modules(Archive REQUIRED IMPORTED_TARGET libarchive) pkg_check_modules(XXHASH REQUIRED IMPORTED_TARGET libxxhash) +set(LMS_VERSION ${PROJECT_VERSION}) + +configure_file( + impl/Version.cpp.in + impl/Version.cpp + @ONLY + ) + add_library(lmscore STATIC impl/http/Client.cpp impl/http/SendQueue.cpp @@ -19,12 +27,11 @@ add_library(lmscore STATIC impl/Path.cpp impl/Random.cpp impl/RecursiveSharedMutex.cpp - impl/StreamLogger.cpp impl/String.cpp impl/TraceLogger.cpp impl/UUID.cpp - impl/WtLogger.cpp impl/XxHash3.cpp + ${CMAKE_CURRENT_BINARY_DIR}/impl/Version.cpp ) target_include_directories(lmscore INTERFACE diff --git a/src/libs/core/bench/TraceLoggerBench.cpp b/src/libs/core/bench/TraceLoggerBench.cpp index ac3eb591..06430750 100644 --- a/src/libs/core/bench/TraceLoggerBench.cpp +++ b/src/libs/core/bench/TraceLoggerBench.cpp @@ -17,19 +17,17 @@ * along with LMS. If not, see . */ -#include #include #include #include "core/ILogger.hpp" #include "core/ITraceLogger.hpp" -#include "core/StreamLogger.hpp" namespace lms::core { // The trace logger is meant to built/destroyed once - const Service logger{ std::make_unique(std::cout, logging::StreamLogger::allSeverities) }; + const Service logger{ logging::createLogger() }; const Service traceLogger{ tracing::createTraceLogger(tracing::Level::Overview) }; static void BM_TraceLogger_Overview(benchmark::State& state) diff --git a/src/libs/core/impl/Logger.cpp b/src/libs/core/impl/Logger.cpp index a4765e44..3be471c5 100644 --- a/src/libs/core/impl/Logger.cpp +++ b/src/libs/core/impl/Logger.cpp @@ -17,7 +17,17 @@ * along with LMS. If not, see . */ -#include "core/ILogger.hpp" +#include "Logger.hpp" + +#include + +#include +#include +#include +#include + +#include "core/Exception.hpp" +#include "core/String.hpp" namespace lms::core::logging { @@ -63,6 +73,8 @@ namespace lms::core::logging return "UI"; case Module::UTILS: return "UTILS"; + case Module::WT: + return "WT"; } return ""; } @@ -103,4 +115,94 @@ namespace lms::core::logging { return _oss.str(); } + + std::unique_ptr createLogger(Severity minSeverity, const std::filesystem::path& logFilePath) + { + return std::make_unique(minSeverity, logFilePath); + } + + Logger::OutputStream::OutputStream(std::ostream& os) + : stream{ os } + { + } + + Logger::Logger(Severity minSeverity, const std::filesystem::path& logFilePath) + { + if (!logFilePath.empty()) + { + _logFileStream = std::make_unique(logFilePath, std::ios::out | std::ios::app); + if (!_logFileStream->is_open()) + { + const std::error_code ec{ errno, std::generic_category() }; + throw LmsException{ "Cannot open log file '" + logFilePath.string() + "' for writing: " + ec.message() }; + } + } + + switch (minSeverity) + { + case core::logging::Severity::DEBUG: + if (_logFileStream) + addOutputStream(*_logFileStream, { core::logging::Severity::DEBUG }); + else + addOutputStream(std::cout, { core::logging::Severity::DEBUG }); + [[fallthrough]]; + case core::logging::Severity::INFO: + if (_logFileStream) + addOutputStream(*_logFileStream, { core::logging::Severity::INFO }); + else + addOutputStream(std::cout, { core::logging::Severity::INFO }); + [[fallthrough]]; + case core::logging::Severity::WARNING: + if (_logFileStream) + addOutputStream(*_logFileStream, { core::logging::Severity::WARNING }); + else + addOutputStream(std::cerr, { core::logging::Severity::WARNING }); + [[fallthrough]]; + case core::logging::Severity::ERROR: + if (_logFileStream) + addOutputStream(*_logFileStream, { core::logging::Severity::ERROR }); + else + addOutputStream(std::cerr, { core::logging::Severity::ERROR }); + [[fallthrough]]; + case core::logging::Severity::FATAL: + if (_logFileStream) + addOutputStream(*_logFileStream, { core::logging::Severity::FATAL }); + else + addOutputStream(std::cerr, { core::logging::Severity::FATAL }); + break; + } + } + + Logger::~Logger() = default; + + void Logger::addOutputStream(std::ostream& os, Severity severity) + { + auto it{ std::find_if(_outputStreams.begin(), _outputStreams.end(), [&os](const OutputStream& outputStream) { return &outputStream.stream == &os; }) }; + if (it == _outputStreams.end()) + it = _outputStreams.emplace(_outputStreams.end(), os); + + assert(!_severityToOutputStreamMap.contains(severity)); + _severityToOutputStreamMap.emplace(severity, &(*it)); + } + + bool Logger::isSeverityActive(Severity severity) const + { + return _severityToOutputStreamMap.contains(severity); + } + + void Logger::processLog(const Log& log) + { + processLog(log.getModule(), log.getSeverity(), log.getMessage()); + } + + void Logger::processLog(Module module, Severity severity, std::string_view message) + { + assert(isSeverityActive(severity)); // should have been filtered out by a isSeverityActive call + OutputStream* outputStream{ _severityToOutputStreamMap.at(severity) }; + const Wt::WDateTime now{ Wt::WDateTime::currentDateTime() }; + + std::unique_lock lock{ outputStream->mutex }; + outputStream->stream << stringUtils::toISO8601String(now) << " " << std::this_thread::get_id() << " [" << getSeverityName(severity) << "] [" << getModuleName(module) << "] " << message << std::endl; + } + } // namespace lms::core::logging \ No newline at end of file diff --git a/src/libs/core/impl/Logger.hpp b/src/libs/core/impl/Logger.hpp new file mode 100644 index 00000000..7498f896 --- /dev/null +++ b/src/libs/core/impl/Logger.hpp @@ -0,0 +1,59 @@ +/* + * Copyright (C) 2019 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 . + */ + +#pragma once + +#include +#include +#include +#include +#include + +#include "core/ILogger.hpp" + +namespace lms::core::logging +{ + class Logger final : public ILogger + { + public: + Logger(Severity minSeverity, const std::filesystem::path& logFilePath); + ~Logger() override; + Logger(const Logger&) = delete; + Logger& operator=(const Logger&) = delete; + + private: + bool isSeverityActive(Severity severity) const override; + void processLog(const Log& log) override; + void processLog(Module module, Severity severity, std::string_view message) override; + + void addOutputStream(std::ostream& os, Severity severity); + + struct OutputStream + { + OutputStream(std::ostream& os); + + std::mutex mutex; + std::ostream& stream; + }; + + std::list _outputStreams; + std::unordered_map _severityToOutputStreamMap; + std::unique_ptr _logFileStream; + }; +} // namespace lms::core::logging \ No newline at end of file diff --git a/src/libs/core/impl/Path.cpp b/src/libs/core/impl/Path.cpp index ff7436a4..d17c5bc3 100644 --- a/src/libs/core/impl/Path.cpp +++ b/src/libs/core/impl/Path.cpp @@ -86,4 +86,24 @@ namespace lms::core::pathUtils return longestCommonPath; } + + std::string sanitizeFileStem(const std::string_view fileStem) + { + // Keep UTF8-encoded characters, but skip illegal ASCII characters + constexpr std::array illegalChars{ '/', '\\', ':', '*', '?', '"', '<', '>', '|' }; + static_assert(std::all_of(std::begin(illegalChars), std::end(illegalChars), [](unsigned char c) { return c < 128; }), "Illegal characters must be ASCII"); + + std::string sanitized; + sanitized.reserve(fileStem.size()); + + for (const char c : fileStem) + { + if (std::any_of(std::begin(illegalChars), std::end(illegalChars), [c](char illegalChar) { return c == illegalChar; })) + continue; + + sanitized.push_back(c); + } + + return sanitized; + } } // namespace lms::core::pathUtils diff --git a/src/libs/core/impl/TraceLogger.cpp b/src/libs/core/impl/TraceLogger.cpp index af521eb2..2b47cf51 100644 --- a/src/libs/core/impl/TraceLogger.cpp +++ b/src/libs/core/impl/TraceLogger.cpp @@ -25,6 +25,7 @@ #include "core/Exception.hpp" #include "core/ILogger.hpp" +#include "core/String.hpp" namespace lms::core::tracing { diff --git a/src/libs/core/impl/StreamLogger.cpp b/src/libs/core/impl/Version.cpp.in similarity index 53% rename from src/libs/core/impl/StreamLogger.cpp rename to src/libs/core/impl/Version.cpp.in index e8d23736..f5ef0630 100644 --- a/src/libs/core/impl/StreamLogger.cpp +++ b/src/libs/core/impl/Version.cpp.in @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Emeric Poupon + * Copyright (C) 2025 Emeric Poupon * * This file is part of LMS. * @@ -17,22 +17,12 @@ * along with LMS. If not, see . */ -#include -#include +#include "core/Version.hpp" -#include "core/StreamLogger.hpp" - -namespace lms::core::logging +namespace lms::core { - StreamLogger::StreamLogger(std::ostream& os, EnumSet severities) - : _os{ os } - , _severities{ severities } + std::string_view getVersion() { + return "v" "@LMS_VERSION@"; } - - void StreamLogger::processLog(const Log& log) - { - assert(isSeverityActive(log.getSeverity())); - _os << std::this_thread::get_id() << " [" << getSeverityName(log.getSeverity()) << "] [" << getModuleName(log.getModule()) << "] " << log.getMessage() << std::endl; - } -} // namespace lms::core::logging \ No newline at end of file +} // namespace lms::core diff --git a/src/libs/core/impl/WtLogger.cpp b/src/libs/core/impl/WtLogger.cpp deleted file mode 100644 index 4714e669..00000000 --- a/src/libs/core/impl/WtLogger.cpp +++ /dev/null @@ -1,75 +0,0 @@ -/* - * Copyright (C) 2019 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 "core/WtLogger.hpp" - -#include -#include - -#include -#include - -#include "core/Exception.hpp" - -namespace lms::core::logging -{ - namespace - { - std::string to_string(std::thread::id id) - { - std::ostringstream oss; - oss << id; - return oss.str(); - } - } // namespace - - WtLogger::WtLogger(Severity minSeverity) - : _minSeverity{ minSeverity } - { - } - - std::string WtLogger::computeLogConfig(Severity minSeverity) - { - switch (minSeverity) - { - case Severity::DEBUG: - return "*"; - case Severity::INFO: - return "* -debug"; - case Severity::WARNING: - return "* -debug -info"; - case Severity::ERROR: - return "* -debug -info -warning"; - case Severity::FATAL: - return "* -debug -info -warning -error"; - } - - throw LmsException{ "Unhandled severity" }; - } - - bool WtLogger::isSeverityActive(Severity severity) const - { - return static_cast(severity) <= static_cast(_minSeverity); - } - - void WtLogger::processLog(const Log& log) - { - Wt::log(getSeverityName(log.getSeverity())) << Wt::WLogger::sep << to_string(std::this_thread::get_id()) << Wt::WLogger::sep << "[" << getModuleName(log.getModule()) << "]" << Wt::WLogger::sep << log.getMessage(); - } -} // namespace lms::core::logging \ No newline at end of file diff --git a/src/libs/core/include/core/ILogger.hpp b/src/libs/core/include/core/ILogger.hpp index 336898e9..89ac41c3 100644 --- a/src/libs/core/include/core/ILogger.hpp +++ b/src/libs/core/include/core/ILogger.hpp @@ -19,11 +19,12 @@ #pragma once +#include +#include #include #include #include "core/Service.hpp" -#include "core/String.hpp" namespace lms::core::logging { @@ -57,6 +58,7 @@ namespace lms::core::logging TRANSCODING, UI, UTILS, + WT, }; const char* getModuleName(Module mod); @@ -92,7 +94,11 @@ namespace lms::core::logging virtual bool isSeverityActive(Severity severity) const = 0; virtual void processLog(const Log& log) = 0; + virtual void processLog(Module module, Severity severity, std::string_view message) = 0; }; + + static constexpr Severity defaultMinSeverity{ Severity::INFO }; + std::unique_ptr createLogger(Severity minSeverity = defaultMinSeverity, const std::filesystem::path& logFilePath = {}); } // namespace lms::core::logging #define LMS_LOG(module, severity, message) \ diff --git a/src/libs/core/include/core/Path.hpp b/src/libs/core/include/core/Path.hpp index 2d8fece0..38ab0790 100644 --- a/src/libs/core/include/core/Path.hpp +++ b/src/libs/core/include/core/Path.hpp @@ -21,6 +21,8 @@ #include #include +#include +#include #include @@ -54,4 +56,7 @@ namespace lms::core::pathUtils return longestCommonPath; } + + // A method that sanitize a file stem, removing any illegal chars + std::string sanitizeFileStem(std::string_view fileStem); } // namespace lms::core::pathUtils diff --git a/src/libs/core/include/core/StreamLogger.hpp b/src/libs/core/include/core/StreamLogger.hpp deleted file mode 100644 index 2e694fe2..00000000 --- a/src/libs/core/include/core/StreamLogger.hpp +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright (C) 2019 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 . - */ - -#pragma once - -#include "core/EnumSet.hpp" -#include "core/ILogger.hpp" - -namespace lms::core::logging -{ - class StreamLogger final : public ILogger - { - public: - static constexpr EnumSet allSeverities{ Severity::FATAL, Severity::ERROR, Severity::WARNING, Severity::INFO, Severity::DEBUG }; - static constexpr EnumSet defaultSeverities{ Severity::FATAL, Severity::ERROR, Severity::WARNING, Severity::INFO }; - - StreamLogger(std::ostream& oss, EnumSet severities = defaultSeverities); - - bool isSeverityActive(Severity severity) const override { return _severities.contains(severity); } - void processLog(const Log& log) override; - - private: - std::ostream& _os; - const EnumSet _severities; - }; -} // namespace lms::core::logging \ No newline at end of file diff --git a/src/libs/core/include/core/WtLogger.hpp b/src/libs/core/include/core/Version.hpp similarity index 58% rename from src/libs/core/include/core/WtLogger.hpp rename to src/libs/core/include/core/Version.hpp index af615ab9..084572b0 100644 --- a/src/libs/core/include/core/WtLogger.hpp +++ b/src/libs/core/include/core/Version.hpp @@ -1,5 +1,5 @@ /* - * Copyright (C) 2019 Emeric Poupon + * Copyright (C) 2025 Emeric Poupon * * This file is part of LMS. * @@ -19,22 +19,9 @@ #pragma once -#include +#include -#include "core/ILogger.hpp" - -namespace lms::core::logging +namespace lms::core { - class WtLogger final : public ILogger - { - public: - WtLogger(Severity minSeverity); - - static std::string computeLogConfig(Severity minSeverity); - - private: - bool isSeverityActive(Severity severity) const override; - void processLog(const Log& log) override; - const Severity _minSeverity; - }; -} // namespace lms::core::logging \ No newline at end of file + std::string_view getVersion(); +} // namespace lms::core diff --git a/src/libs/core/test/Path.cpp b/src/libs/core/test/Path.cpp index 1e525b06..7aa52907 100644 --- a/src/libs/core/test/Path.cpp +++ b/src/libs/core/test/Path.cpp @@ -103,4 +103,34 @@ namespace lms::core::pathUtils::tests EXPECT_EQ(core::pathUtils::isPathInRootPath(test.path, test.rootPath), test.expectedResult) << "Failed: path = " << test.path << ", rootPath = " << test.rootPath; } } + + TEST(Path, sanitizeFileStem) + { + struct TestCase + { + std::string input; + std::string_view expectedOutput; + }; + + TestCase tests[]{ + { "", "" }, // empty input + { "valid_file_name", "valid_file_name" }, + { "invalid:file*name?", "invalidfilename" }, + { "another|invalid", "anotherinvalidname" }, + { "/leading/slash", "leadingslash" }, + { "\\backslash\\file", "backslashfile" }, + { "file_with_äöüß", "file_with_äöüß" }, // keep German umlauts + { "file_with_éèêë", "file_with_éèêë" }, // keep French accents + { "héllo 漢字", "héllo 漢字" }, // keep UTF8 characters + { "file_with_üñîçødë", "file_with_üñîçødë" }, // keep special characters + { "file_with_!@#$%^&*()_+", "file_with_!@#$%^&()_+" }, // remove special characters + { "file_with_", "file_with_" }, // handle double dots + { "file.with.extension", "file.with.extension" }, // keep extensions + }; + + for (const TestCase& test : tests) + { + EXPECT_EQ(core::pathUtils::sanitizeFileStem(test.input), test.expectedOutput) << "Failed: input = " << test.input; + } + } } // namespace lms::core::pathUtils::tests \ No newline at end of file diff --git a/src/libs/database/CMakeLists.txt b/src/libs/database/CMakeLists.txt index 96af316e..5a57c591 100644 --- a/src/libs/database/CMakeLists.txt +++ b/src/libs/database/CMakeLists.txt @@ -8,6 +8,7 @@ add_library(lmsdatabase STATIC impl/objects/Image.cpp impl/objects/Listen.cpp impl/objects/MediaLibrary.cpp + impl/objects/Medium.cpp impl/objects/PlayListFile.cpp impl/objects/PlayQueue.cpp impl/objects/TrackArtistLink.cpp diff --git a/src/libs/database/impl/Migration.cpp b/src/libs/database/impl/Migration.cpp index c6e1e1b6..e4b77bbf 100644 --- a/src/libs/database/impl/Migration.cpp +++ b/src/libs/database/impl/Migration.cpp @@ -34,7 +34,7 @@ namespace lms::db { namespace { - static constexpr Version LMS_DATABASE_VERSION{ 98 }; + static constexpr Version LMS_DATABASE_VERSION{ 99 }; } VersionInfo::VersionInfo() @@ -1423,6 +1423,111 @@ WHERE art.image_id IS NULL)"); dropIndexes(session); } + void migrateFromV98(Session& session) + { + // Medium support + dropIndexes(session); + + // New table for mediums + utils::executeCommand(*session.getDboSession(), R"(CREATE TABLE IF NOT EXISTS "medium" ( + "id" integer primary key autoincrement, + "version" integer not null, + "name" text not null, + "position" integer, + "track_count" integer, + "media" text not null, + "replay_gain" real, + "release_id" bigint, + "preferred_artwork_id" bigint, + constraint "fk_medium_release" foreign key ("release_id") references "release" ("id") on delete cascade deferrable initially deferred, + constraint "fk_medium_preferred_artwork" foreign key ("preferred_artwork_id") references "artwork" ("id") on delete set null deferrable initially deferred + ))"); + + // New primary key in track -> need to recreate the table + utils::executeCommand(*session.getDboSession(), R"(CREATE TABLE IF NOT EXISTS "track_backup" ( + "id" integer primary key autoincrement, + "version" integer not null, + "scan_version" integer not null, + "track_number" integer, + "name" text not null, + "duration" integer, + "bitrate" integer not null, + "bits_per_sample" integer not null, + "channel_count" integer not null, + "sample_rate" integer not null, + "date" text, + "original_date" text, + "absolute_file_path" text not null, + "file_size" bigint not null, + "file_last_write" text, + "file_added" text, + "mbid" text not null, + "recording_mbid" text not null, + "copyright" text not null, + "copyright_url" text not null, + "advisory" integer not null, + "replay_gain" real, + "artist_display_name" text not null, + "comment" text not null, + "medium_id" bigint, + "release_id" bigint, + "media_library_id" bigint, + "directory_id" bigint, + "preferred_artwork_id" bigint, + "preferred_media_artwork_id" bigint, + constraint "fk_track_medium" foreign key ("medium_id") references "medium" ("id") on delete cascade deferrable initially deferred, + constraint "fk_track_release" foreign key ("release_id") references "release" ("id") on delete cascade deferrable initially deferred, + constraint "fk_track_media_library" foreign key ("media_library_id") references "media_library" ("id") on delete set null deferrable initially deferred, + constraint "fk_track_directory" foreign key ("directory_id") references "directory" ("id") on delete cascade deferrable initially deferred, + constraint "fk_track_preferred_artwork" foreign key ("preferred_artwork_id") references "artwork" ("id") on delete set null deferrable initially deferred, + constraint "fk_track_preferred_media_artwork" foreign key ("preferred_media_artwork_id") references "artwork" ("id") on delete set null deferrable initially deferred + ))"); + + // Migrate data: + // - removed disc_number, total_track, disc_subtitle, release_replay_gain + // - renamed track_replay_gain to replay_gain + // - with the new medium_id field set to null + utils::executeCommand(*session.getDboSession(), R"(INSERT INTO track_backup +SELECT + id, + version, + scan_version, + track_number, + name, + duration, + bitrate, + bits_per_sample, + channel_count, + sample_rate, + date, + original_date, + absolute_file_path, + file_size, + file_last_write, + file_added, + mbid, + recording_mbid, + copyright, + copyright_url, + advisory, + track_replay_gain AS replay_gain, + artist_display_name, + comment, + NULL as medium_id, + release_id, + media_library_id, + directory_id, + preferred_artwork_id, + preferred_media_artwork_id +FROM track)"); + + utils::executeCommand(*session.getDboSession(), "DROP TABLE track"); + utils::executeCommand(*session.getDboSession(), "ALTER TABLE track_backup RENAME TO track"); + + // Just increment the scan version of the settings to make the next scan rescan all audio files + utils::executeCommand(*session.getDboSession(), "UPDATE scan_settings SET artist_info_scan_version = artist_info_scan_version + 1"); + } + bool doDbMigration(Session& session) { constexpr std::string_view outdatedMsg{ "Outdated database, please rebuild it (delete the .db file and restart)" }; @@ -1497,6 +1602,7 @@ WHERE art.image_id IS NULL)"); { 95, migrateFromV95 }, { 96, migrateFromV96 }, { 97, migrateFromV97 }, + { 98, migrateFromV98 }, }; bool migrationPerformed{}; diff --git a/src/libs/database/impl/Session.cpp b/src/libs/database/impl/Session.cpp index b01e7268..f467b01a 100644 --- a/src/libs/database/impl/Session.cpp +++ b/src/libs/database/impl/Session.cpp @@ -33,6 +33,7 @@ #include "database/objects/Image.hpp" #include "database/objects/Listen.hpp" #include "database/objects/MediaLibrary.hpp" +#include "database/objects/Medium.hpp" #include "database/objects/PlayListFile.hpp" #include "database/objects/PlayQueue.hpp" #include "database/objects/RatedArtist.hpp" @@ -82,6 +83,7 @@ namespace lms::db _session.mapClass