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

Fixed 'remember me' login option for several LMS instances on the same host, fixes #867

Browse Source
This commit is contained in:
emeric
2026-07-17 22:12:07 +02:00
parent 735c170a44
commit b6df7ae120
11 changed files with 178 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/libs/database/CMakeLists.txt
+1
View File
@@ -24,6 +24,7 @@ add_library(lmsdatabase STATIC
impl/objects/RatedTrack.cpp
impl/objects/Release.cpp
impl/objects/ScanSettings.cpp
impl/objects/ServerInfo.cpp
impl/objects/StarredArtist.cpp
impl/objects/StarredRelease.cpp
impl/objects/StarredTrack.cpp
src/libs/database/impl/Migration.cpp
+12 -1
View File
@@ -36,7 +36,7 @@ namespace lms::db
{
namespace
{
static constexpr Version LMS_DATABASE_VERSION{ 109 };
static constexpr Version LMS_DATABASE_VERSION{ 110 };
}
VersionInfo::VersionInfo()
@@ -1956,6 +1956,16 @@ CREATE TABLE IF NOT EXISTS "track_movement" (
utils::executeCommand(*session.getDboSession(), "UPDATE scan_settings SET audio_scan_version = audio_scan_version + 1");
}
void migrateFromV109(Session& session)
{
utils::executeCommand(*session.getDboSession(), R"(
CREATE TABLE IF NOT EXISTS "server_info" (
"id" integer primary key autoincrement,
"version" integer not null,
"instance_id" blob not null
))");
}
bool doDbMigration(Session& session)
{
constexpr std::string_view outdatedMsg{ "Outdated database, please rebuild it (delete the .db file and restart)" };
@@ -2041,6 +2051,7 @@ CREATE TABLE IF NOT EXISTS "track_movement" (
{ 106, migrateFromV106 },
{ 107, migrateFromV107 },
{ 108, migrateFromV108 },
{ 109, migrateFromV109 },
};
LMS_SCOPED_TRACE_OVERVIEW("Database", "Migration");
src/libs/database/impl/Session.cpp
+9
View File
@@ -49,6 +49,7 @@
#include "database/objects/Release.hpp"
#include "database/objects/ReleaseArtistLink.hpp"
#include "database/objects/ScanSettings.hpp"
#include "database/objects/ServerInfo.hpp"
#include "database/objects/StarredArtist.hpp"
#include "database/objects/StarredRelease.hpp"
#include "database/objects/StarredTrack.hpp"
@@ -125,6 +126,7 @@ namespace lms::db
_session.mapClass<UIState>("ui_state");
_session.mapClass<Work>("work");
_session.mapClass<User>("user");
_session.mapClass<ServerInfo>("server_info");
_session.mapClass<VersionInfo>("version_info");
}
@@ -191,6 +193,13 @@ namespace lms::db
create<ScanSettings>().modify()->setRecommendationEngineType(defaultRecommendationEngineType);
}
void Session::createServerInfoIfNeeded()
{
auto uniqueTransaction{ createWriteTransaction() };
ServerInfo::getOrCreate(*this);
}
void Session::createIndexesIfNeeded()
{
LMS_SCOPED_TRACE_OVERVIEW("Database", "IndexCreation");
src/libs/database/impl/objects/ServerInfo.cpp
+56
View File
@@ -0,0 +1,56 @@
/*
* Copyright (C) 2026 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 "database/objects/ServerInfo.hpp"
#include <Wt/Dbo/Impl.h>
#include <Wt/Dbo/WtSqlTraits.h>
#include "database/Session.hpp"
#include "Utils.hpp"
#include "traits/UUIDTraits.hpp"
DBO_INSTANTIATE_TEMPLATES(lms::db::ServerInfo)
namespace lms::db
{
ServerInfo::ServerInfo(core::UUID instanceId)
: _instanceId{ instanceId }
{
}
ServerInfo::pointer ServerInfo::getOrCreate(Session& session)
{
session.checkWriteTransaction();
pointer serverInfo{ utils::fetchQuerySingleResult(session.getDboSession()->find<ServerInfo>()) };
if (!serverInfo)
return session.getDboSession()->add(std::unique_ptr<ServerInfo>{ new ServerInfo{ core::UUID::generate() } });
return serverInfo;
}
ServerInfo::pointer ServerInfo::get(Session& session)
{
session.checkReadTransaction();
return utils::fetchQuerySingleResult(session.getDboSession()->find<ServerInfo>());
}
} // namespace lms::db
src/libs/database/include/database/Session.hpp
+1
View File
@@ -60,6 +60,7 @@ namespace lms::db
void prepareTablesIfNeeded(); // need to run only once at startup
bool migrateSchemaIfNeeded(); // returns true if migration was performed
void createScanSettingsIfNeeded(RecommendationEngineType defaultRecommendationEngineType = RecommendationEngineType::Clusters);
void createServerInfoIfNeeded();
void createIndexesIfNeeded();
void vacuumIfNeeded();
void vacuum();
src/libs/database/include/database/objects/ServerInfo.hpp
+54
View File
@@ -0,0 +1,54 @@
/*
* Copyright (C) 2026 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/>.
*/
#pragma once
#include <Wt/Dbo/Field.h>
#include "core/UUID.hpp"
namespace lms::db
{
class Session;
// Singleton row holding server-level metadata (not tied to any particular schema version)
class ServerInfo
{
public:
using pointer = Wt::Dbo::ptr<ServerInfo>;
ServerInfo() = default;
static pointer getOrCreate(Session& session);
static pointer get(Session& session);
core::UUID getInstanceId() const { return _instanceId; }
template<class Action>
void persist(Action& a)
{
Wt::Dbo::field(a, _instanceId, "instance_id");
}
private:
explicit ServerInfo(core::UUID instanceId);
core::UUID _instanceId;
};
} // namespace lms::db
src/libs/database/test/Migration.cpp
+3
View File
@@ -37,6 +37,7 @@
#include "database/objects/RatedTrack.hpp"
#include "database/objects/ReleaseArtistLink.hpp"
#include "database/objects/ScanSettings.hpp"
#include "database/objects/ServerInfo.hpp"
#include "database/objects/StarredArtist.hpp"
#include "database/objects/StarredRelease.hpp"
#include "database/objects/StarredTrack.hpp"
@@ -345,6 +346,7 @@ VALUES
// Now perform full migration
db.getTLSSession().migrateSchemaIfNeeded();
db.getTLSSession().createScanSettingsIfNeeded();
db.getTLSSession().createServerInfoIfNeeded();
// Now perform some dummy finds to ensure all fields are correctly mapped
{
@@ -374,6 +376,7 @@ VALUES
EXPECT_FALSE(ReleaseArtistLink::find(session, ReleaseArtistLinkId{}));
EXPECT_FALSE(ReleaseType::find(session, ReleaseTypeId{}));
EXPECT_FALSE(ScanSettings::find(session, ScanSettingsId{}));
EXPECT_NE(ServerInfo::get(session)->getInstanceId(), core::UUID{});
EXPECT_FALSE(StarredArtist::find(session, StarredArtistId{}));
EXPECT_FALSE(StarredRelease::find(session, StarredReleaseId{}));
EXPECT_FALSE(StarredTrack::find(session, StarredTrackId{}));
src/lms/main.cpp
+14 -2
View File
@@ -34,11 +34,13 @@
#include "core/Service.hpp"
#include "core/String.hpp"
#include "core/SystemPaths.hpp"
#include "core/UUID.hpp"
#include "audio/IAudioOutput.hpp"
#include "audio/IMusicNNEmbeddingExtractor.hpp"
#include "database/IDb.hpp"
#include "database/Session.hpp"
#include "database/objects/ServerInfo.hpp"
#include "database/profiling/IQueryProfiler.hpp"
#include "image/Image.hpp"
#include "services/artwork/IArtworkService.hpp"
@@ -111,6 +113,12 @@ namespace lms
throw core::LmsException{ "Invalid config value for 'jukebox-audio-backend'" };
}
core::UUID getServerInstanceId(db::Session& session)
{
auto transaction{ session.createReadTransaction() };
return db::ServerInfo::get(session)->getInstanceId();
}
std::error_code checkDirectoryAccessible(const std::filesystem::path& dir)
{
std::error_code ec;
@@ -433,13 +441,17 @@ namespace lms
// Connection pool size must be twice the number of threads: we have at least 2 io pools with getThreadCount() each and they all may access the database
auto database{ db::createDb(config->getPath("working-dir", "/var/lms") / "lms.db", getThreadCount() * 2) };
core::UUID serverInstanceId;
{
db::Session session{ *database };
session.prepareTablesIfNeeded();
bool migrationPerformed{ session.migrateSchemaIfNeeded() };
session.createScanSettingsIfNeeded(audio::canExtractMusicNNEmbeddings() ? db::RecommendationEngineType::AudioSimilarity : db::RecommendationEngineType::Clusters);
session.createServerInfoIfNeeded();
session.createIndexesIfNeeded();
serverInstanceId = getServerInstanceId(session);
// As this may be quite long, we only do it during startup
if (migrationPerformed)
session.vacuum();
@@ -517,8 +529,8 @@ namespace lms
// bind UI entry point
server.addEntryPoint(Wt::EntryPointType::Application,
[&database, &appManager, uiAuthenticationBackend](const Wt::WEnvironment& env) {
return ui::LmsApplication::create(env, *database, appManager, uiAuthenticationBackend);
[&database, &appManager, uiAuthenticationBackend, serverInstanceId](const Wt::WEnvironment& env) {
return ui::LmsApplication::create(env, *database, appManager, uiAuthenticationBackend, serverInstanceId);
});
proxyScannerEventsToApplication(*scannerService, server);
src/lms/ui/Auth.cpp
+17 -7
View File
@@ -44,16 +44,26 @@ namespace lms::ui
namespace
{
static constexpr core::LiteralString authTokenDomain{ "ui" };
static const std::string authCookieName{ "LmsAuth" };
static const std::string authCookieSalt{ Wt::Auth::SHA1HashFunction{}.compute(authCookieName, authTokenDomain.c_str()) }; // changing this will invalidate existing tokens
// Scoped per-instance so several LMS instances on the same host don't collide
std::string getAuthCookieName()
{
return "LmsAuth-" + LmsApp->getServerInstanceId().toString();
}
// changing the instance id, or this salt computation, invalidates existing "remember me" tokens
std::string getAuthCookieSalt()
{
return Wt::Auth::SHA1HashFunction{}.compute(LmsApp->getServerInstanceId().toString(), authTokenDomain.c_str());
}
void createAuthToken(db::UserId userId, const Wt::WDateTime& expiry)
{
const std::string authCookie{ Wt::WRandom::generateId(64) };
const std::string hashedAuthCookie{ Wt::Auth::SHA1HashFunction{}.compute(authCookie, authCookieSalt) };
const std::string hashedAuthCookie{ Wt::Auth::SHA1HashFunction{}.compute(authCookie, getAuthCookieSalt()) };
core::Service<auth::IAuthTokenService>::get()->createAuthToken(authTokenDomain, userId, hashedAuthCookie);
LmsApp->setCookie(authCookieName,
LmsApp->setCookie(getAuthCookieName(),
authCookie,
expiry.toTime_t() - Wt::WDateTime::currentDateTime().toTime_t(),
"",
@@ -147,18 +157,18 @@ namespace lms::ui
db::UserId processAuthToken(const Wt::WEnvironment& env)
{
const std::string* authCookie{ env.getCookie(authCookieName) };
const std::string* authCookie{ env.getCookie(getAuthCookieName()) };
if (!authCookie)
return db::UserId{};
const std::string hashedCookie{ Wt::Auth::SHA1HashFunction{}.compute(*authCookie, authCookieSalt) };
const std::string hashedCookie{ Wt::Auth::SHA1HashFunction{}.compute(*authCookie, getAuthCookieSalt()) };
const auto res{ core::Service<auth::IAuthTokenService>::get()->processAuthToken(authTokenDomain, boost::asio::ip::make_address(env.clientAddress()), hashedCookie) };
switch (res.state)
{
case auth::IAuthTokenService::AuthTokenProcessResult::State::Denied:
case auth::IAuthTokenService::AuthTokenProcessResult::State::Throttled:
LmsApp->setCookie(authCookieName, std::string{}, 0, "", "", env.urlScheme() == "https");
LmsApp->setCookie(getAuthCookieName(), std::string{}, 0, "", "", env.urlScheme() == "https");
return db::UserId{};
case auth::IAuthTokenService::AuthTokenProcessResult::State::Granted:
src/lms/ui/LmsApplication.cpp
+4 -3
View File
@@ -145,9 +145,9 @@ namespace lms::ui
} // namespace
std::unique_ptr<Wt::WApplication> LmsApplication::create(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend)
std::unique_ptr<Wt::WApplication> LmsApplication::create(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend, const core::UUID& serverInstanceId)
{
return std::make_unique<LmsApplication>(env, db, appManager, authBackend);
return std::make_unique<LmsApplication>(env, db, appManager, authBackend, serverInstanceId);
}
LmsApplication* LmsApplication::instance()
@@ -155,11 +155,12 @@ namespace lms::ui
return static_cast<LmsApplication*>(Wt::WApplication::instance());
}
LmsApplication::LmsApplication(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend)
LmsApplication::LmsApplication(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend, const core::UUID& serverInstanceId)
: Wt::WApplication{ env }
, _db{ db }
, _appManager{ appManager }
, _authBackend{ authBackend }
, _serverInstanceId{ serverInstanceId }
, _areDownloadsEnabled(core::Service<core::IConfig>::get()->getBool("ui-allow-downloads", true))
{
try
src/lms/ui/LmsApplication.hpp
+7 -3
View File
@@ -25,6 +25,8 @@
#include <Wt/WApplication.h>
#include "core/UUID.hpp"
#include "database/Object.hpp"
#include "database/objects/Types.hpp"
#include "database/objects/UserId.hpp"
@@ -53,10 +55,10 @@ namespace lms::ui
class LmsApplication : public Wt::WApplication
{
public:
LmsApplication(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend);
~LmsApplication();
LmsApplication(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend, const core::UUID& serverInstanceId);
~LmsApplication() override;
static std::unique_ptr<Wt::WApplication> create(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend);
static std::unique_ptr<Wt::WApplication> create(const Wt::WEnvironment& env, db::IDb& db, LmsApplicationManager& appManager, AuthenticationBackend authBackend, const core::UUID& serverInstanceId);
static LmsApplication* instance();
// Session application data
@@ -76,6 +78,7 @@ namespace lms::ui
scanner::Events& getScannerEvents() { return _scannerEvents; }
AuthenticationBackend getAuthBackend() const { return _authBackend; }
core::UUID getServerInstanceId() const { return _serverInstanceId; }
// Utils
static void post(const std::string& sessionId, const std::function<void()>& func);
@@ -112,6 +115,7 @@ namespace lms::ui
Wt::Signal<> _preQuit;
LmsApplicationManager& _appManager;
const AuthenticationBackend _authBackend;
const core::UUID _serverInstanceId;
const bool _areDownloadsEnabled;
scanner::Events _scannerEvents;
struct UserAuthInfo