1 /***************************************************************************
2 * Copyright (C) 2005-2018 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
23 #include <QCoreApplication>
26 #include "coreauthhandler.h"
27 #include "coresession.h"
28 #include "coresettings.h"
30 #include "internalpeer.h"
32 #include "postgresqlstorage.h"
34 #include "sqlauthenticator.h"
35 #include "sqlitestorage.h"
38 // Currently building with LDAP bindings is optional.
40 #include "ldapauthenticator.h"
52 // ==============================
54 // ==============================
55 const int Core::AddClientEventId = QEvent::registerEventType();
57 class AddClientEvent : public QEvent
60 AddClientEvent(RemotePeer *p, UserId uid) : QEvent(QEvent::Type(Core::AddClientEventId)), peer(p), userId(uid) {}
66 // ==============================
68 // ==============================
69 Core *Core::_instance{nullptr};
71 Core *Core::instance()
80 qWarning() << "Recreating core instance!";
85 // Parent all QObject-derived attributes, so when the Core instance gets moved into another
86 // thread, they get moved with it
87 _server.setParent(this);
88 _v6server.setParent(this);
89 _storageSyncTimer.setParent(this);
96 qDeleteAll(_connectingClients);
97 qDeleteAll(_sessions);
105 _startTime = QDateTime::currentDateTime().toUTC(); // for uptime :)
107 if (Quassel::runMode() == Quassel::RunMode::CoreOnly) {
108 Quassel::loadTranslation(QLocale::system());
111 // check settings version
112 // so far, we only have 1
114 if (s.version() != 1) {
115 qCritical() << "Invalid core settings version, terminating!";
116 QCoreApplication::exit(EXIT_FAILURE);
120 // Set up storage and authentication backends
121 registerStorageBackends();
122 registerAuthenticators();
124 QProcessEnvironment environment = QProcessEnvironment::systemEnvironment();
125 bool config_from_environment = Quassel::isOptionSet("config-from-environment");
128 QVariantMap db_connectionProperties;
130 QString auth_authenticator;
131 QVariantMap auth_properties;
133 bool writeError = false;
135 if (config_from_environment) {
136 db_backend = environment.value("DB_BACKEND");
137 auth_authenticator = environment.value("AUTH_AUTHENTICATOR");
141 QVariantMap dbsettings = cs.storageSettings().toMap();
142 db_backend = dbsettings.value("Backend").toString();
143 db_connectionProperties = dbsettings.value("ConnectionProperties").toMap();
145 QVariantMap authSettings = cs.authSettings().toMap();
146 auth_authenticator = authSettings.value("Authenticator", "Database").toString();
147 auth_properties = authSettings.value("AuthProperties").toMap();
149 writeError = !cs.isWritable();
153 _configured = initStorage(db_backend, db_connectionProperties, environment, config_from_environment);
155 // Not entirely sure what is 'legacy' about the above, but it seems to be the way things work!
157 initAuthenticator(auth_authenticator, auth_properties, environment, config_from_environment);
160 if (Quassel::isOptionSet("select-backend") || Quassel::isOptionSet("select-authenticator")) {
162 if (Quassel::isOptionSet("select-backend")) {
163 success &= selectBackend(Quassel::optionValue("select-backend"));
165 if (Quassel::isOptionSet("select-authenticator")) {
166 success &= selectAuthenticator(Quassel::optionValue("select-authenticator"));
168 QCoreApplication::exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
173 if (config_from_environment) {
174 _configured = initStorage(db_backend, db_connectionProperties, environment, config_from_environment, true);
175 initAuthenticator(auth_authenticator, auth_properties, environment, config_from_environment, true);
178 qWarning() << "Cannot configure from environment";
179 QCoreApplication::exit(EXIT_FAILURE);
184 if (_registeredStorageBackends.empty()) {
185 quWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
187 << qPrintable(tr("Currently, Quassel supports SQLite3 and PostgreSQL. You need to build your\n"
188 "Qt library with the sqlite or postgres plugin enabled in order for quasselcore\n"
190 QCoreApplication::exit(EXIT_FAILURE); // TODO make this less brutal (especially for mono client -> popup)
195 qWarning() << "Cannot write quasselcore configuration; probably a permission problem.";
196 QCoreApplication::exit(EXIT_FAILURE);
200 quInfo() << "Core is currently not configured! Please connect with a Quassel Client for basic setup.";
204 if (Quassel::isOptionSet("add-user")) {
205 bool success = createUser();
206 QCoreApplication::exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
210 if (Quassel::isOptionSet("change-userpass")) {
211 bool success = changeUserPass(Quassel::optionValue("change-userpass"));
212 QCoreApplication::exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
216 _strictIdentEnabled = Quassel::isOptionSet("strict-ident");
217 if (_strictIdentEnabled) {
221 if (Quassel::isOptionSet("oidentd")) {
222 _oidentdConfigGenerator = new OidentdConfigGenerator(this);
226 if (Quassel::isOptionSet("ident-daemon")) {
227 _identServer = new IdentServer(this);
230 Quassel::registerReloadHandler([]() {
231 // Currently, only reloading SSL certificates and the sysident cache is supported
232 if (Core::instance()) {
233 Core::instance()->cacheSysIdent();
234 Core::instance()->reloadCerts();
240 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
241 _storageSyncTimer.start(10 * 60 * 1000); // 10 minutes
244 connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
245 connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
247 if (!startListening()) {
248 QCoreApplication::exit(EXIT_FAILURE); // TODO make this less brutal
252 if (_configured && !Quassel::isOptionSet("norestore")) {
253 Core::restoreState();
258 if (_pendingInternalConnection) {
259 connectInternalPeer(_pendingInternalConnection);
260 _pendingInternalConnection = {};
266 /*** Session Restore ***/
268 void Core::saveState()
271 QVariantList activeSessions;
272 for (auto &&user : instance()->_sessions.keys())
273 activeSessions << QVariant::fromValue<UserId>(user);
274 _storage->setCoreState(activeSessions);
279 void Core::restoreState()
282 quWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
285 if (_sessions.count()) {
286 quWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
291 /* We don't check, since we are at the first version since switching to Git
292 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
294 quWarning() << qPrintable(tr("Core state too old, ignoring..."));
299 const QList<QVariant> &activeSessionsFallback = s.coreState().toMap()["ActiveSessions"].toList();
300 QVariantList activeSessions = instance()->_storage->getCoreState(activeSessionsFallback);
302 if (activeSessions.count() > 0) {
303 quInfo() << "Restoring previous core state...";
304 for(auto &&v : activeSessions) {
305 UserId user = v.value<UserId>();
306 sessionForUser(user, true);
314 QString Core::setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupData)
316 return instance()->setupCore(adminUser, adminPassword, backend, setupData, authenticator, authSetupData);
320 QString Core::setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupData)
323 return tr("Core is already configured! Not configuring again...");
325 if (adminUser.isEmpty() || adminPassword.isEmpty()) {
326 return tr("Admin user or password not set.");
328 if (!(_configured = initStorage(backend, setupData, {}, false, true))) {
329 return tr("Could not setup storage!");
332 quInfo() << "Selected authenticator:" << authenticator;
333 if (!(_configured = initAuthenticator(authenticator, authSetupData, {}, false, true)))
335 return tr("Could not setup authenticator!");
338 if (!saveBackendSettings(backend, setupData)) {
339 return tr("Could not save backend settings, probably a permission problem.");
341 saveAuthenticatorSettings(authenticator, authSetupData);
343 quInfo() << qPrintable(tr("Creating admin user..."));
344 _storage->addUser(adminUser, adminPassword);
346 startListening(); // TODO check when we need this
351 QString Core::setupCoreForInternalUsage()
353 Q_ASSERT(!_registeredStorageBackends.empty());
355 qsrand(QDateTime::currentDateTime().toMSecsSinceEpoch());
357 for (int i = 0; i < 10; i++) {
359 pass += qrand() % 10;
362 // mono client currently needs sqlite
363 return setupCore("AdminUser", QString::number(pass), "SQLite", QVariantMap(), "Database", QVariantMap());
367 /*** Storage Handling ***/
369 template<typename Storage>
370 void Core::registerStorageBackend()
372 auto backend = makeDeferredShared<Storage>(this);
373 if (backend->isAvailable())
374 _registeredStorageBackends.emplace_back(std::move(backend));
376 backend->deleteLater();
380 void Core::registerStorageBackends()
382 if (_registeredStorageBackends.empty()) {
383 registerStorageBackend<SqliteStorage>();
384 registerStorageBackend<PostgreSqlStorage>();
389 DeferredSharedPtr<Storage> Core::storageBackend(const QString &backendId) const
391 auto it = std::find_if(_registeredStorageBackends.begin(), _registeredStorageBackends.end(),
392 [backendId](const DeferredSharedPtr<Storage> &backend) {
393 return backend->displayName() == backendId;
395 return it != _registeredStorageBackends.end() ? *it : nullptr;
399 // "Type" => "sqlite"
400 bool Core::initStorage(const QString &backend, const QVariantMap &settings,
401 const QProcessEnvironment &environment, bool loadFromEnvironment, bool setup)
403 if (backend.isEmpty()) {
404 quWarning() << "No storage backend selected!";
408 auto storage = storageBackend(backend);
410 qCritical() << "Selected storage backend is not available:" << backend;
414 connect(storage.get(), SIGNAL(dbUpgradeInProgress(bool)), this, SIGNAL(dbUpgradeInProgress(bool)));
416 Storage::State storageState = storage->init(settings, environment, loadFromEnvironment);
417 switch (storageState) {
418 case Storage::NeedsSetup:
420 return false; // trigger setup process
421 if (storage->setup(settings, environment, loadFromEnvironment))
422 return initStorage(backend, settings, environment, loadFromEnvironment, false);
425 // if initialization wasn't successful, we quit to keep from coming up unconfigured
426 case Storage::NotAvailable:
427 qCritical() << "FATAL: Selected storage backend is not available:" << backend;
429 QCoreApplication::exit(EXIT_FAILURE);
433 case Storage::IsReady:
434 // delete all other backends
435 _registeredStorageBackends.clear();
436 connect(storage.get(), SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)),
437 this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
440 _storage = std::move(storage);
445 void Core::syncStorage()
452 /*** Storage Access ***/
453 bool Core::createNetwork(UserId user, NetworkInfo &info)
455 NetworkId networkId = instance()->_storage->createNetwork(user, info);
456 if (!networkId.isValid())
459 info.networkId = networkId;
464 /*** Authenticators ***/
466 // Authentication handling, now independent from storage.
467 template<typename Authenticator>
468 void Core::registerAuthenticator()
470 auto authenticator = makeDeferredShared<Authenticator>(this);
471 if (authenticator->isAvailable())
472 _registeredAuthenticators.emplace_back(std::move(authenticator));
474 authenticator->deleteLater();
478 void Core::registerAuthenticators()
480 if (_registeredAuthenticators.empty()) {
481 registerAuthenticator<SqlAuthenticator>();
483 registerAuthenticator<LdapAuthenticator>();
489 DeferredSharedPtr<Authenticator> Core::authenticator(const QString &backendId) const
491 auto it = std::find_if(_registeredAuthenticators.begin(), _registeredAuthenticators.end(),
492 [backendId](const DeferredSharedPtr<Authenticator> &authenticator) {
493 return authenticator->backendId() == backendId;
495 return it != _registeredAuthenticators.end() ? *it : nullptr;
499 // FIXME: Apparently, this is the legacy way of initting storage backends?
500 // If there's a not-legacy way, it should be used here
501 bool Core::initAuthenticator(const QString &backend, const QVariantMap &settings,
502 const QProcessEnvironment &environment, bool loadFromEnvironment,
505 if (backend.isEmpty()) {
506 quWarning() << "No authenticator selected!";
510 auto auth = authenticator(backend);
512 qCritical() << "Selected auth backend is not available:" << backend;
516 Authenticator::State authState = auth->init(settings, environment, loadFromEnvironment);
518 case Authenticator::NeedsSetup:
520 return false; // trigger setup process
521 if (auth->setup(settings, environment, loadFromEnvironment))
522 return initAuthenticator(backend, settings, environment, loadFromEnvironment, false);
525 // if initialization wasn't successful, we quit to keep from coming up unconfigured
526 case Authenticator::NotAvailable:
527 qCritical() << "FATAL: Selected auth backend is not available:" << backend;
529 QCoreApplication::exit(EXIT_FAILURE);
533 case Authenticator::IsReady:
534 // delete all other backends
535 _registeredAuthenticators.clear();
538 _authenticator = std::move(auth);
543 /*** Network Management ***/
545 bool Core::sslSupported()
548 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
549 return sslServer && sslServer->isCertValid();
556 bool Core::reloadCerts()
559 SslServer *sslServerv4 = qobject_cast<SslServer *>(&_server);
560 bool retv4 = sslServerv4->reloadCerts();
562 SslServer *sslServerv6 = qobject_cast<SslServer *>(&_v6server);
563 bool retv6 = sslServerv6->reloadCerts();
565 return retv4 && retv6;
567 // SSL not supported, don't mark configuration reload as failed
573 void Core::cacheSysIdent()
575 if (isConfigured()) {
576 _authUserNames = _storage->getAllAuthUserNames();
581 QString Core::strictSysIdent(UserId user) const
583 if (_authUserNames.contains(user)) {
584 return _authUserNames[user];
587 // A new user got added since we last pulled our cache from the database.
588 // There's no way to avoid a database hit - we don't even know the authname!
589 instance()->cacheSysIdent();
591 if (_authUserNames.contains(user)) {
592 return _authUserNames[user];
595 // ...something very weird is going on if we ended up here (an active CoreSession without a corresponding database entry?)
596 qWarning().nospace() << "Unable to find authusername for UserId " << user << ", this should never happen!";
597 return "unknown"; // Should we just terminate the program instead?
601 bool Core::startListening()
603 // in mono mode we only start a local port if a port is specified in the cli call
604 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
607 bool success = false;
608 uint port = Quassel::optionValue("port").toUInt();
610 const QString listen = Quassel::optionValue("listen");
611 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
612 if (listen_list.size() > 0) {
613 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
615 if (!addr.setAddress(listen_term)) {
616 qCritical() << qPrintable(
617 tr("Invalid listen address %1")
622 switch (addr.protocol()) {
623 case QAbstractSocket::IPv6Protocol:
624 if (_v6server.listen(addr, port)) {
625 quInfo() << qPrintable(
626 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
627 .arg(addr.toString())
628 .arg(_v6server.serverPort())
629 .arg(Quassel::buildInfo().protocolVersion)
634 quWarning() << qPrintable(
635 tr("Could not open IPv6 interface %1:%2: %3")
636 .arg(addr.toString())
638 .arg(_v6server.errorString()));
640 case QAbstractSocket::IPv4Protocol:
641 if (_server.listen(addr, port)) {
642 quInfo() << qPrintable(
643 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
644 .arg(addr.toString())
645 .arg(_server.serverPort())
646 .arg(Quassel::buildInfo().protocolVersion)
651 // if v6 succeeded on Any, the port will be already in use - don't display the error then
652 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
653 quWarning() << qPrintable(
654 tr("Could not open IPv4 interface %1:%2: %3")
655 .arg(addr.toString())
657 .arg(_server.errorString()));
661 qCritical() << qPrintable(
662 tr("Invalid listen address %1, unknown network protocol")
671 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
674 _identServer->startListening();
681 void Core::stopListening(const QString &reason)
684 _identServer->stopListening(reason);
687 bool wasListening = false;
688 if (_server.isListening()) {
692 if (_v6server.isListening()) {
697 if (reason.isEmpty())
698 quInfo() << "No longer listening for GUI clients.";
700 quInfo() << qPrintable(reason);
705 void Core::incomingConnection()
707 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
709 while (server->hasPendingConnections()) {
710 QTcpSocket *socket = server->nextPendingConnection();
712 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
713 _connectingClients.insert(handler);
715 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
716 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
717 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
719 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
722 stopListening(tr("Closing server for basic setup."));
728 // Potentially called during the initialization phase (before handing the connection off to the session)
729 void Core::clientDisconnected()
731 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
734 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
735 _connectingClients.remove(handler);
736 handler->deleteLater();
738 // make server listen again if still not configured
743 // TODO remove unneeded sessions - if necessary/possible...
744 // Suggestion: kill sessions if they are not connected to any network and client.
748 void Core::setupClientSession(RemotePeer *peer, UserId uid)
750 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
753 // From now on everything is handled by the client session
754 disconnect(handler, 0, this, 0);
755 _connectingClients.remove(handler);
756 handler->deleteLater();
758 // Find or create session for validated user
761 // as we are currently handling an event triggered by incoming data on this socket
762 // it is unsafe to directly move the socket to the client thread.
763 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
767 void Core::customEvent(QEvent *event)
769 if (event->type() == AddClientEventId) {
770 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
771 addClientHelper(addClientEvent->peer, addClientEvent->userId);
777 void Core::addClientHelper(RemotePeer *peer, UserId uid)
779 // Find or create session for validated user
780 SessionThread *session = sessionForUser(uid);
781 session->addClient(peer);
785 void Core::connectInternalPeer(QPointer<InternalPeer> peer)
787 if (_initialized && peer) {
788 setupInternalClientSession(peer);
791 _pendingInternalConnection = peer;
796 void Core::setupInternalClientSession(QPointer<InternalPeer> clientPeer)
800 setupCoreForInternalUsage();
805 uid = _storage->internalUser();
808 quWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
809 QCoreApplication::exit(EXIT_FAILURE);
814 quWarning() << "Client peer went away, not starting a session";
818 InternalPeer *corePeer = new InternalPeer(this);
819 corePeer->setPeer(clientPeer);
820 clientPeer->setPeer(corePeer);
822 // Find or create session for validated user
823 SessionThread *sessionThread = sessionForUser(uid);
824 sessionThread->addClient(corePeer);
828 SessionThread *Core::sessionForUser(UserId uid, bool restore)
830 if (_sessions.contains(uid))
831 return _sessions[uid];
833 SessionThread *session = new SessionThread(uid, restore, strictIdentEnabled(), this);
834 _sessions[uid] = session;
840 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
842 quWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
846 QVariantList Core::backendInfo()
848 instance()->registerStorageBackends();
850 QVariantList backendInfos;
851 for (auto &&backend : instance()->_registeredStorageBackends) {
853 v["BackendId"] = backend->backendId();
854 v["DisplayName"] = backend->displayName();
855 v["Description"] = backend->description();
856 v["SetupData"] = backend->setupData(); // ignored by legacy clients
858 // TODO Protocol Break: Remove legacy (cf. authenticatorInfo())
859 const auto &setupData = backend->setupData();
860 QStringList setupKeys;
861 QVariantMap setupDefaults;
862 for (int i = 0; i + 2 < setupData.size(); i += 3) {
863 setupKeys << setupData[i].toString();
864 setupDefaults[setupData[i].toString()] = setupData[i + 2];
866 v["SetupKeys"] = setupKeys;
867 v["SetupDefaults"] = setupDefaults;
868 // TODO Protocol Break: Remove
869 v["IsDefault"] = (backend->backendId() == "SQLite"); // newer clients will just use the first in the list
877 QVariantList Core::authenticatorInfo()
879 instance()->registerAuthenticators();
881 QVariantList authInfos;
882 for(auto &&backend : instance()->_registeredAuthenticators) {
884 v["BackendId"] = backend->backendId();
885 v["DisplayName"] = backend->displayName();
886 v["Description"] = backend->description();
887 v["SetupData"] = backend->setupData();
893 // migration / backend selection
894 bool Core::selectBackend(const QString &backend)
896 // reregister all storage backends
897 registerStorageBackends();
898 auto storage = storageBackend(backend);
900 QStringList backends;
901 std::transform(_registeredStorageBackends.begin(), _registeredStorageBackends.end(),
902 std::back_inserter(backends), [](const DeferredSharedPtr<Storage>& backend) {
903 return backend->displayName();
905 quWarning() << qPrintable(tr("Unsupported storage backend: %1").arg(backend));
906 quWarning() << qPrintable(tr("Supported backends are:")) << qPrintable(backends.join(", "));
910 QVariantMap settings = promptForSettings(storage.get());
912 Storage::State storageState = storage->init(settings);
913 switch (storageState) {
914 case Storage::IsReady:
915 if (!saveBackendSettings(backend, settings)) {
916 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
918 quWarning() << qPrintable(tr("Switched storage backend to: %1").arg(backend));
919 quWarning() << qPrintable(tr("Backend already initialized. Skipping Migration..."));
921 case Storage::NotAvailable:
922 qCritical() << qPrintable(tr("Storage backend is not available: %1").arg(backend));
924 case Storage::NeedsSetup:
925 if (!storage->setup(settings)) {
926 quWarning() << qPrintable(tr("Unable to setup storage backend: %1").arg(backend));
930 if (storage->init(settings) != Storage::IsReady) {
931 quWarning() << qPrintable(tr("Unable to initialize storage backend: %1").arg(backend));
935 if (!saveBackendSettings(backend, settings)) {
936 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
938 quWarning() << qPrintable(tr("Switched storage backend to: %1").arg(backend));
942 // let's see if we have a current storage object we can migrate from
943 auto reader = getMigrationReader(_storage.get());
944 auto writer = getMigrationWriter(storage.get());
945 if (reader && writer) {
946 qDebug() << qPrintable(tr("Migrating storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
949 if (reader->migrateTo(writer.get())) {
950 qDebug() << "Migration finished!";
951 qDebug() << qPrintable(tr("Migration finished!"));
952 if (!saveBackendSettings(backend, settings)) {
953 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
958 quWarning() << qPrintable(tr("Unable to migrate storage backend! (No migration writer for %1)").arg(backend));
962 // inform the user why we cannot merge
964 quWarning() << qPrintable(tr("No currently active storage backend. Skipping migration..."));
967 quWarning() << qPrintable(tr("Currently active storage backend does not support migration: %1").arg(_storage->displayName()));
970 quWarning() << qPrintable(tr("New storage backend does not support migration: %1").arg(backend));
973 // so we were unable to merge, but let's create a user \o/
974 _storage = std::move(storage);
979 // TODO: I am not sure if this function is implemented correctly.
980 // There is currently no concept of migraiton between auth backends.
981 bool Core::selectAuthenticator(const QString &backend)
983 // Register all authentication backends.
984 registerAuthenticators();
985 auto auther = authenticator(backend);
987 QStringList authenticators;
988 std::transform(_registeredAuthenticators.begin(), _registeredAuthenticators.end(),
989 std::back_inserter(authenticators), [](const DeferredSharedPtr<Authenticator>& authenticator) {
990 return authenticator->displayName();
992 quWarning() << qPrintable(tr("Unsupported authenticator: %1").arg(backend));
993 quWarning() << qPrintable(tr("Supported authenticators are:")) << qPrintable(authenticators.join(", "));
997 QVariantMap settings = promptForSettings(auther.get());
999 Authenticator::State state = auther->init(settings);
1001 case Authenticator::IsReady:
1002 saveAuthenticatorSettings(backend, settings);
1003 quWarning() << qPrintable(tr("Switched authenticator to: %1").arg(backend));
1005 case Authenticator::NotAvailable:
1006 qCritical() << qPrintable(tr("Authenticator is not available: %1").arg(backend));
1008 case Authenticator::NeedsSetup:
1009 if (!auther->setup(settings)) {
1010 quWarning() << qPrintable(tr("Unable to setup authenticator: %1").arg(backend));
1014 if (auther->init(settings) != Authenticator::IsReady) {
1015 quWarning() << qPrintable(tr("Unable to initialize authenticator: %1").arg(backend));
1019 saveAuthenticatorSettings(backend, settings);
1020 quWarning() << qPrintable(tr("Switched authenticator to: %1").arg(backend));
1023 _authenticator = std::move(auther);
1028 bool Core::createUser()
1030 QTextStream out(stdout);
1031 QTextStream in(stdin);
1032 out << "Add a new user:" << endl;
1033 out << "Username: ";
1035 QString username = in.readLine().trimmed();
1038 out << "Password: ";
1040 QString password = in.readLine().trimmed();
1042 out << "Repeat Password: ";
1044 QString password2 = in.readLine().trimmed();
1048 if (password != password2) {
1049 quWarning() << "Passwords don't match!";
1052 if (password.isEmpty()) {
1053 quWarning() << "Password is empty!";
1057 if (_configured && _storage->addUser(username, password).isValid()) {
1058 out << "Added user " << username << " successfully!" << endl;
1062 quWarning() << "Unable to add user:" << qPrintable(username);
1068 bool Core::changeUserPass(const QString &username)
1070 QTextStream out(stdout);
1071 QTextStream in(stdin);
1072 UserId userId = _storage->getUserId(username);
1073 if (!userId.isValid()) {
1074 out << "User " << username << " does not exist." << endl;
1078 if (!canChangeUserPassword(userId)) {
1079 out << "User " << username << " is configured through an auth provider that has forbidden manual password changing." << endl;
1083 out << "Change password for user: " << username << endl;
1086 out << "New Password: ";
1088 QString password = in.readLine().trimmed();
1090 out << "Repeat Password: ";
1092 QString password2 = in.readLine().trimmed();
1096 if (password != password2) {
1097 quWarning() << "Passwords don't match!";
1100 if (password.isEmpty()) {
1101 quWarning() << "Password is empty!";
1105 if (_configured && _storage->updateUser(userId, password)) {
1106 out << "Password changed successfully!" << endl;
1110 quWarning() << "Failed to change password!";
1116 bool Core::changeUserPassword(UserId userId, const QString &password)
1118 if (!isConfigured() || !userId.isValid())
1121 if (!canChangeUserPassword(userId))
1124 return instance()->_storage->updateUser(userId, password);
1127 // TODO: this code isn't currently 100% optimal because the core
1128 // doesn't know it can have multiple auth providers configured (there aren't
1129 // multiple auth providers at the moment anyway) and we have hardcoded the
1130 // Database provider to be always allowed.
1131 bool Core::canChangeUserPassword(UserId userId)
1133 QString authProvider = instance()->_storage->getUserAuthenticator(userId);
1134 if (authProvider != "Database") {
1135 if (authProvider != instance()->_authenticator->backendId()) {
1138 else if (instance()->_authenticator->canChangePassword()) {
1146 std::unique_ptr<AbstractSqlMigrationReader> Core::getMigrationReader(Storage *storage)
1151 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
1153 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
1157 return sqlStorage->createMigrationReader();
1161 std::unique_ptr<AbstractSqlMigrationWriter> Core::getMigrationWriter(Storage *storage)
1166 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
1168 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
1172 return sqlStorage->createMigrationWriter();
1176 bool Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
1178 QVariantMap dbsettings;
1179 dbsettings["Backend"] = backend;
1180 dbsettings["ConnectionProperties"] = settings;
1181 CoreSettings s = CoreSettings();
1182 s.setStorageSettings(dbsettings);
1187 void Core::saveAuthenticatorSettings(const QString &backend, const QVariantMap &settings)
1189 QVariantMap dbsettings;
1190 dbsettings["Authenticator"] = backend;
1191 dbsettings["AuthProperties"] = settings;
1192 CoreSettings().setAuthSettings(dbsettings);
1195 // Generic version of promptForSettings that doesn't care what *type* of
1196 // backend it runs over.
1197 template<typename Backend>
1198 QVariantMap Core::promptForSettings(const Backend *backend)
1200 QVariantMap settings;
1201 const QVariantList& setupData = backend->setupData();
1203 if (setupData.isEmpty())
1206 QTextStream out(stdout);
1207 QTextStream in(stdin);
1208 out << "Default values are in brackets" << endl;
1210 for (int i = 0; i + 2 < setupData.size(); i += 3) {
1211 QString key = setupData[i].toString();
1212 out << setupData[i+1].toString() << " [" << setupData[i+2].toString() << "]: " << flush;
1214 bool noEcho = key.toLower().contains("password");
1218 QString input = in.readLine().trimmed();
1224 QVariant value{setupData[i+2]};
1225 if (!input.isEmpty()) {
1226 switch (value.type()) {
1228 value = input.toInt();
1234 settings[key] = value;
1241 void Core::stdInEcho(bool on)
1243 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
1245 GetConsoleMode(hStdin, &mode);
1247 mode |= ENABLE_ECHO_INPUT;
1249 mode &= ~ENABLE_ECHO_INPUT;
1250 SetConsoleMode(hStdin, mode);
1254 void Core::stdInEcho(bool on)
1257 tcgetattr(STDIN_FILENO, &t);
1262 tcsetattr(STDIN_FILENO, TCSANOW, &t);
1265 #endif /* Q_OS_WIN */