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);
225 Quassel::registerReloadHandler([]() {
226 // Currently, only reloading SSL certificates and the sysident cache is supported
227 if (Core::instance()) {
228 Core::instance()->cacheSysIdent();
229 Core::instance()->reloadCerts();
235 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
236 _storageSyncTimer.start(10 * 60 * 1000); // 10 minutes
239 connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
240 connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
242 if (!startListening()) {
243 QCoreApplication::exit(EXIT_FAILURE); // TODO make this less brutal
247 if (_configured && !Quassel::isOptionSet("norestore")) {
248 Core::restoreState();
253 if (_pendingInternalConnection) {
254 connectInternalPeer(_pendingInternalConnection);
255 _pendingInternalConnection = {};
261 /*** Session Restore ***/
263 void Core::saveState()
266 QVariantList activeSessions;
267 for (auto &&user : instance()->_sessions.keys())
268 activeSessions << QVariant::fromValue<UserId>(user);
269 _storage->setCoreState(activeSessions);
274 void Core::restoreState()
277 quWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
280 if (_sessions.count()) {
281 quWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
286 /* We don't check, since we are at the first version since switching to Git
287 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
289 quWarning() << qPrintable(tr("Core state too old, ignoring..."));
294 const QList<QVariant> &activeSessionsFallback = s.coreState().toMap()["ActiveSessions"].toList();
295 QVariantList activeSessions = instance()->_storage->getCoreState(activeSessionsFallback);
297 if (activeSessions.count() > 0) {
298 quInfo() << "Restoring previous core state...";
299 for(auto &&v : activeSessions) {
300 UserId user = v.value<UserId>();
301 sessionForUser(user, true);
309 QString Core::setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupData)
311 return instance()->setupCore(adminUser, adminPassword, backend, setupData, authenticator, authSetupData);
315 QString Core::setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupData)
318 return tr("Core is already configured! Not configuring again...");
320 if (adminUser.isEmpty() || adminPassword.isEmpty()) {
321 return tr("Admin user or password not set.");
323 if (!(_configured = initStorage(backend, setupData, {}, false, true))) {
324 return tr("Could not setup storage!");
327 quInfo() << "Selected authenticator:" << authenticator;
328 if (!(_configured = initAuthenticator(authenticator, authSetupData, {}, false, true)))
330 return tr("Could not setup authenticator!");
333 if (!saveBackendSettings(backend, setupData)) {
334 return tr("Could not save backend settings, probably a permission problem.");
336 saveAuthenticatorSettings(authenticator, authSetupData);
338 quInfo() << qPrintable(tr("Creating admin user..."));
339 _storage->addUser(adminUser, adminPassword);
341 startListening(); // TODO check when we need this
346 QString Core::setupCoreForInternalUsage()
348 Q_ASSERT(!_registeredStorageBackends.empty());
350 qsrand(QDateTime::currentDateTime().toMSecsSinceEpoch());
352 for (int i = 0; i < 10; i++) {
354 pass += qrand() % 10;
357 // mono client currently needs sqlite
358 return setupCore("AdminUser", QString::number(pass), "SQLite", QVariantMap(), "Database", QVariantMap());
362 /*** Storage Handling ***/
364 template<typename Storage>
365 void Core::registerStorageBackend()
367 auto backend = makeDeferredShared<Storage>(this);
368 if (backend->isAvailable())
369 _registeredStorageBackends.emplace_back(std::move(backend));
371 backend->deleteLater();
375 void Core::registerStorageBackends()
377 if (_registeredStorageBackends.empty()) {
378 registerStorageBackend<SqliteStorage>();
379 registerStorageBackend<PostgreSqlStorage>();
384 DeferredSharedPtr<Storage> Core::storageBackend(const QString &backendId) const
386 auto it = std::find_if(_registeredStorageBackends.begin(), _registeredStorageBackends.end(),
387 [backendId](const DeferredSharedPtr<Storage> &backend) {
388 return backend->displayName() == backendId;
390 return it != _registeredStorageBackends.end() ? *it : nullptr;
394 // "Type" => "sqlite"
395 bool Core::initStorage(const QString &backend, const QVariantMap &settings,
396 const QProcessEnvironment &environment, bool loadFromEnvironment, bool setup)
398 if (backend.isEmpty()) {
399 quWarning() << "No storage backend selected!";
403 auto storage = storageBackend(backend);
405 qCritical() << "Selected storage backend is not available:" << backend;
409 connect(storage.get(), SIGNAL(dbUpgradeInProgress(bool)), this, SIGNAL(dbUpgradeInProgress(bool)));
411 Storage::State storageState = storage->init(settings, environment, loadFromEnvironment);
412 switch (storageState) {
413 case Storage::NeedsSetup:
415 return false; // trigger setup process
416 if (storage->setup(settings, environment, loadFromEnvironment))
417 return initStorage(backend, settings, environment, loadFromEnvironment, false);
420 // if initialization wasn't successful, we quit to keep from coming up unconfigured
421 case Storage::NotAvailable:
422 qCritical() << "FATAL: Selected storage backend is not available:" << backend;
424 QCoreApplication::exit(EXIT_FAILURE);
428 case Storage::IsReady:
429 // delete all other backends
430 _registeredStorageBackends.clear();
431 connect(storage.get(), SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)),
432 this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
435 _storage = std::move(storage);
440 void Core::syncStorage()
447 /*** Storage Access ***/
448 bool Core::createNetwork(UserId user, NetworkInfo &info)
450 NetworkId networkId = instance()->_storage->createNetwork(user, info);
451 if (!networkId.isValid())
454 info.networkId = networkId;
459 /*** Authenticators ***/
461 // Authentication handling, now independent from storage.
462 template<typename Authenticator>
463 void Core::registerAuthenticator()
465 auto authenticator = makeDeferredShared<Authenticator>(this);
466 if (authenticator->isAvailable())
467 _registeredAuthenticators.emplace_back(std::move(authenticator));
469 authenticator->deleteLater();
473 void Core::registerAuthenticators()
475 if (_registeredAuthenticators.empty()) {
476 registerAuthenticator<SqlAuthenticator>();
478 registerAuthenticator<LdapAuthenticator>();
484 DeferredSharedPtr<Authenticator> Core::authenticator(const QString &backendId) const
486 auto it = std::find_if(_registeredAuthenticators.begin(), _registeredAuthenticators.end(),
487 [backendId](const DeferredSharedPtr<Authenticator> &authenticator) {
488 return authenticator->backendId() == backendId;
490 return it != _registeredAuthenticators.end() ? *it : nullptr;
494 // FIXME: Apparently, this is the legacy way of initting storage backends?
495 // If there's a not-legacy way, it should be used here
496 bool Core::initAuthenticator(const QString &backend, const QVariantMap &settings,
497 const QProcessEnvironment &environment, bool loadFromEnvironment,
500 if (backend.isEmpty()) {
501 quWarning() << "No authenticator selected!";
505 auto auth = authenticator(backend);
507 qCritical() << "Selected auth backend is not available:" << backend;
511 Authenticator::State authState = auth->init(settings, environment, loadFromEnvironment);
513 case Authenticator::NeedsSetup:
515 return false; // trigger setup process
516 if (auth->setup(settings, environment, loadFromEnvironment))
517 return initAuthenticator(backend, settings, environment, loadFromEnvironment, false);
520 // if initialization wasn't successful, we quit to keep from coming up unconfigured
521 case Authenticator::NotAvailable:
522 qCritical() << "FATAL: Selected auth backend is not available:" << backend;
524 QCoreApplication::exit(EXIT_FAILURE);
528 case Authenticator::IsReady:
529 // delete all other backends
530 _registeredAuthenticators.clear();
533 _authenticator = std::move(auth);
538 /*** Network Management ***/
540 bool Core::sslSupported()
543 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
544 return sslServer && sslServer->isCertValid();
551 bool Core::reloadCerts()
554 SslServer *sslServerv4 = qobject_cast<SslServer *>(&_server);
555 bool retv4 = sslServerv4->reloadCerts();
557 SslServer *sslServerv6 = qobject_cast<SslServer *>(&_v6server);
558 bool retv6 = sslServerv6->reloadCerts();
560 return retv4 && retv6;
562 // SSL not supported, don't mark configuration reload as failed
568 void Core::cacheSysIdent()
570 if (isConfigured()) {
571 _authUserNames = _storage->getAllAuthUserNames();
576 QString Core::strictSysIdent(UserId user) const
578 if (_authUserNames.contains(user)) {
579 return _authUserNames[user];
582 // A new user got added since we last pulled our cache from the database.
583 // There's no way to avoid a database hit - we don't even know the authname!
584 instance()->cacheSysIdent();
586 if (_authUserNames.contains(user)) {
587 return _authUserNames[user];
590 // ...something very weird is going on if we ended up here (an active CoreSession without a corresponding database entry?)
591 qWarning().nospace() << "Unable to find authusername for UserId " << user << ", this should never happen!";
592 return "unknown"; // Should we just terminate the program instead?
596 bool Core::startListening()
598 // in mono mode we only start a local port if a port is specified in the cli call
599 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
602 bool success = false;
603 uint port = Quassel::optionValue("port").toUInt();
605 const QString listen = Quassel::optionValue("listen");
606 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
607 if (listen_list.size() > 0) {
608 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
610 if (!addr.setAddress(listen_term)) {
611 qCritical() << qPrintable(
612 tr("Invalid listen address %1")
617 switch (addr.protocol()) {
618 case QAbstractSocket::IPv6Protocol:
619 if (_v6server.listen(addr, port)) {
620 quInfo() << qPrintable(
621 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
622 .arg(addr.toString())
623 .arg(_v6server.serverPort())
624 .arg(Quassel::buildInfo().protocolVersion)
629 quWarning() << qPrintable(
630 tr("Could not open IPv6 interface %1:%2: %3")
631 .arg(addr.toString())
633 .arg(_v6server.errorString()));
635 case QAbstractSocket::IPv4Protocol:
636 if (_server.listen(addr, port)) {
637 quInfo() << qPrintable(
638 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
639 .arg(addr.toString())
640 .arg(_server.serverPort())
641 .arg(Quassel::buildInfo().protocolVersion)
646 // if v6 succeeded on Any, the port will be already in use - don't display the error then
647 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
648 quWarning() << qPrintable(
649 tr("Could not open IPv4 interface %1:%2: %3")
650 .arg(addr.toString())
652 .arg(_server.errorString()));
656 qCritical() << qPrintable(
657 tr("Invalid listen address %1, unknown network protocol")
666 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
672 void Core::stopListening(const QString &reason)
674 bool wasListening = false;
675 if (_server.isListening()) {
679 if (_v6server.isListening()) {
684 if (reason.isEmpty())
685 quInfo() << "No longer listening for GUI clients.";
687 quInfo() << qPrintable(reason);
692 void Core::incomingConnection()
694 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
696 while (server->hasPendingConnections()) {
697 QTcpSocket *socket = server->nextPendingConnection();
699 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
700 _connectingClients.insert(handler);
702 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
703 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
704 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
706 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
709 stopListening(tr("Closing server for basic setup."));
715 // Potentially called during the initialization phase (before handing the connection off to the session)
716 void Core::clientDisconnected()
718 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
721 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
722 _connectingClients.remove(handler);
723 handler->deleteLater();
725 // make server listen again if still not configured
730 // TODO remove unneeded sessions - if necessary/possible...
731 // Suggestion: kill sessions if they are not connected to any network and client.
735 void Core::setupClientSession(RemotePeer *peer, UserId uid)
737 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
740 // From now on everything is handled by the client session
741 disconnect(handler, 0, this, 0);
742 _connectingClients.remove(handler);
743 handler->deleteLater();
745 // Find or create session for validated user
748 // as we are currently handling an event triggered by incoming data on this socket
749 // it is unsafe to directly move the socket to the client thread.
750 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
754 void Core::customEvent(QEvent *event)
756 if (event->type() == AddClientEventId) {
757 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
758 addClientHelper(addClientEvent->peer, addClientEvent->userId);
764 void Core::addClientHelper(RemotePeer *peer, UserId uid)
766 // Find or create session for validated user
767 SessionThread *session = sessionForUser(uid);
768 session->addClient(peer);
772 void Core::connectInternalPeer(QPointer<InternalPeer> peer)
774 if (_initialized && peer) {
775 setupInternalClientSession(peer);
778 _pendingInternalConnection = peer;
783 void Core::setupInternalClientSession(QPointer<InternalPeer> clientPeer)
787 setupCoreForInternalUsage();
792 uid = _storage->internalUser();
795 quWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
796 QCoreApplication::exit(EXIT_FAILURE);
801 quWarning() << "Client peer went away, not starting a session";
805 InternalPeer *corePeer = new InternalPeer(this);
806 corePeer->setPeer(clientPeer);
807 clientPeer->setPeer(corePeer);
809 // Find or create session for validated user
810 SessionThread *sessionThread = sessionForUser(uid);
811 sessionThread->addClient(corePeer);
815 SessionThread *Core::sessionForUser(UserId uid, bool restore)
817 if (_sessions.contains(uid))
818 return _sessions[uid];
820 SessionThread *session = new SessionThread(uid, restore, strictIdentEnabled(), this);
821 _sessions[uid] = session;
827 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
829 quWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
833 QVariantList Core::backendInfo()
835 instance()->registerStorageBackends();
837 QVariantList backendInfos;
838 for (auto &&backend : instance()->_registeredStorageBackends) {
840 v["BackendId"] = backend->backendId();
841 v["DisplayName"] = backend->displayName();
842 v["Description"] = backend->description();
843 v["SetupData"] = backend->setupData(); // ignored by legacy clients
845 // TODO Protocol Break: Remove legacy (cf. authenticatorInfo())
846 const auto &setupData = backend->setupData();
847 QStringList setupKeys;
848 QVariantMap setupDefaults;
849 for (int i = 0; i + 2 < setupData.size(); i += 3) {
850 setupKeys << setupData[i].toString();
851 setupDefaults[setupData[i].toString()] = setupData[i + 2];
853 v["SetupKeys"] = setupKeys;
854 v["SetupDefaults"] = setupDefaults;
855 // TODO Protocol Break: Remove
856 v["IsDefault"] = (backend->backendId() == "SQLite"); // newer clients will just use the first in the list
864 QVariantList Core::authenticatorInfo()
866 instance()->registerAuthenticators();
868 QVariantList authInfos;
869 for(auto &&backend : instance()->_registeredAuthenticators) {
871 v["BackendId"] = backend->backendId();
872 v["DisplayName"] = backend->displayName();
873 v["Description"] = backend->description();
874 v["SetupData"] = backend->setupData();
880 // migration / backend selection
881 bool Core::selectBackend(const QString &backend)
883 // reregister all storage backends
884 registerStorageBackends();
885 auto storage = storageBackend(backend);
887 QStringList backends;
888 std::transform(_registeredStorageBackends.begin(), _registeredStorageBackends.end(),
889 std::back_inserter(backends), [](const DeferredSharedPtr<Storage>& backend) {
890 return backend->displayName();
892 quWarning() << qPrintable(tr("Unsupported storage backend: %1").arg(backend));
893 quWarning() << qPrintable(tr("Supported backends are:")) << qPrintable(backends.join(", "));
897 QVariantMap settings = promptForSettings(storage.get());
899 Storage::State storageState = storage->init(settings);
900 switch (storageState) {
901 case Storage::IsReady:
902 if (!saveBackendSettings(backend, settings)) {
903 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
905 quWarning() << qPrintable(tr("Switched storage backend to: %1").arg(backend));
906 quWarning() << qPrintable(tr("Backend already initialized. Skipping Migration..."));
908 case Storage::NotAvailable:
909 qCritical() << qPrintable(tr("Storage backend is not available: %1").arg(backend));
911 case Storage::NeedsSetup:
912 if (!storage->setup(settings)) {
913 quWarning() << qPrintable(tr("Unable to setup storage backend: %1").arg(backend));
917 if (storage->init(settings) != Storage::IsReady) {
918 quWarning() << qPrintable(tr("Unable to initialize storage backend: %1").arg(backend));
922 if (!saveBackendSettings(backend, settings)) {
923 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
925 quWarning() << qPrintable(tr("Switched storage backend to: %1").arg(backend));
929 // let's see if we have a current storage object we can migrate from
930 auto reader = getMigrationReader(_storage.get());
931 auto writer = getMigrationWriter(storage.get());
932 if (reader && writer) {
933 qDebug() << qPrintable(tr("Migrating storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
936 if (reader->migrateTo(writer.get())) {
937 qDebug() << "Migration finished!";
938 qDebug() << qPrintable(tr("Migration finished!"));
939 if (!saveBackendSettings(backend, settings)) {
940 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
945 quWarning() << qPrintable(tr("Unable to migrate storage backend! (No migration writer for %1)").arg(backend));
949 // inform the user why we cannot merge
951 quWarning() << qPrintable(tr("No currently active storage backend. Skipping migration..."));
954 quWarning() << qPrintable(tr("Currently active storage backend does not support migration: %1").arg(_storage->displayName()));
957 quWarning() << qPrintable(tr("New storage backend does not support migration: %1").arg(backend));
960 // so we were unable to merge, but let's create a user \o/
961 _storage = std::move(storage);
966 // TODO: I am not sure if this function is implemented correctly.
967 // There is currently no concept of migraiton between auth backends.
968 bool Core::selectAuthenticator(const QString &backend)
970 // Register all authentication backends.
971 registerAuthenticators();
972 auto auther = authenticator(backend);
974 QStringList authenticators;
975 std::transform(_registeredAuthenticators.begin(), _registeredAuthenticators.end(),
976 std::back_inserter(authenticators), [](const DeferredSharedPtr<Authenticator>& authenticator) {
977 return authenticator->displayName();
979 quWarning() << qPrintable(tr("Unsupported authenticator: %1").arg(backend));
980 quWarning() << qPrintable(tr("Supported authenticators are:")) << qPrintable(authenticators.join(", "));
984 QVariantMap settings = promptForSettings(auther.get());
986 Authenticator::State state = auther->init(settings);
988 case Authenticator::IsReady:
989 saveAuthenticatorSettings(backend, settings);
990 quWarning() << qPrintable(tr("Switched authenticator to: %1").arg(backend));
992 case Authenticator::NotAvailable:
993 qCritical() << qPrintable(tr("Authenticator is not available: %1").arg(backend));
995 case Authenticator::NeedsSetup:
996 if (!auther->setup(settings)) {
997 quWarning() << qPrintable(tr("Unable to setup authenticator: %1").arg(backend));
1001 if (auther->init(settings) != Authenticator::IsReady) {
1002 quWarning() << qPrintable(tr("Unable to initialize authenticator: %1").arg(backend));
1006 saveAuthenticatorSettings(backend, settings);
1007 quWarning() << qPrintable(tr("Switched authenticator to: %1").arg(backend));
1010 _authenticator = std::move(auther);
1015 bool Core::createUser()
1017 QTextStream out(stdout);
1018 QTextStream in(stdin);
1019 out << "Add a new user:" << endl;
1020 out << "Username: ";
1022 QString username = in.readLine().trimmed();
1025 out << "Password: ";
1027 QString password = in.readLine().trimmed();
1029 out << "Repeat Password: ";
1031 QString password2 = in.readLine().trimmed();
1035 if (password != password2) {
1036 quWarning() << "Passwords don't match!";
1039 if (password.isEmpty()) {
1040 quWarning() << "Password is empty!";
1044 if (_configured && _storage->addUser(username, password).isValid()) {
1045 out << "Added user " << username << " successfully!" << endl;
1049 quWarning() << "Unable to add user:" << qPrintable(username);
1055 bool Core::changeUserPass(const QString &username)
1057 QTextStream out(stdout);
1058 QTextStream in(stdin);
1059 UserId userId = _storage->getUserId(username);
1060 if (!userId.isValid()) {
1061 out << "User " << username << " does not exist." << endl;
1065 if (!canChangeUserPassword(userId)) {
1066 out << "User " << username << " is configured through an auth provider that has forbidden manual password changing." << endl;
1070 out << "Change password for user: " << username << endl;
1073 out << "New Password: ";
1075 QString password = in.readLine().trimmed();
1077 out << "Repeat Password: ";
1079 QString password2 = in.readLine().trimmed();
1083 if (password != password2) {
1084 quWarning() << "Passwords don't match!";
1087 if (password.isEmpty()) {
1088 quWarning() << "Password is empty!";
1092 if (_configured && _storage->updateUser(userId, password)) {
1093 out << "Password changed successfully!" << endl;
1097 quWarning() << "Failed to change password!";
1103 bool Core::changeUserPassword(UserId userId, const QString &password)
1105 if (!isConfigured() || !userId.isValid())
1108 if (!canChangeUserPassword(userId))
1111 return instance()->_storage->updateUser(userId, password);
1114 // TODO: this code isn't currently 100% optimal because the core
1115 // doesn't know it can have multiple auth providers configured (there aren't
1116 // multiple auth providers at the moment anyway) and we have hardcoded the
1117 // Database provider to be always allowed.
1118 bool Core::canChangeUserPassword(UserId userId)
1120 QString authProvider = instance()->_storage->getUserAuthenticator(userId);
1121 if (authProvider != "Database") {
1122 if (authProvider != instance()->_authenticator->backendId()) {
1125 else if (instance()->_authenticator->canChangePassword()) {
1133 std::unique_ptr<AbstractSqlMigrationReader> Core::getMigrationReader(Storage *storage)
1138 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
1140 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
1144 return sqlStorage->createMigrationReader();
1148 std::unique_ptr<AbstractSqlMigrationWriter> Core::getMigrationWriter(Storage *storage)
1153 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
1155 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
1159 return sqlStorage->createMigrationWriter();
1163 bool Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
1165 QVariantMap dbsettings;
1166 dbsettings["Backend"] = backend;
1167 dbsettings["ConnectionProperties"] = settings;
1168 CoreSettings s = CoreSettings();
1169 s.setStorageSettings(dbsettings);
1174 void Core::saveAuthenticatorSettings(const QString &backend, const QVariantMap &settings)
1176 QVariantMap dbsettings;
1177 dbsettings["Authenticator"] = backend;
1178 dbsettings["AuthProperties"] = settings;
1179 CoreSettings().setAuthSettings(dbsettings);
1182 // Generic version of promptForSettings that doesn't care what *type* of
1183 // backend it runs over.
1184 template<typename Backend>
1185 QVariantMap Core::promptForSettings(const Backend *backend)
1187 QVariantMap settings;
1188 const QVariantList& setupData = backend->setupData();
1190 if (setupData.isEmpty())
1193 QTextStream out(stdout);
1194 QTextStream in(stdin);
1195 out << "Default values are in brackets" << endl;
1197 for (int i = 0; i + 2 < setupData.size(); i += 3) {
1198 QString key = setupData[i].toString();
1199 out << setupData[i+1].toString() << " [" << setupData[i+2].toString() << "]: " << flush;
1201 bool noEcho = key.toLower().contains("password");
1205 QString input = in.readLine().trimmed();
1211 QVariant value{setupData[i+2]};
1212 if (!input.isEmpty()) {
1213 switch (value.type()) {
1215 value = input.toInt();
1221 settings[key] = value;
1228 void Core::stdInEcho(bool on)
1230 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
1232 GetConsoleMode(hStdin, &mode);
1234 mode |= ENABLE_ECHO_INPUT;
1236 mode &= ~ENABLE_ECHO_INPUT;
1237 SetConsoleMode(hStdin, mode);
1241 void Core::stdInEcho(bool on)
1244 tcgetattr(STDIN_FILENO, &t);
1249 tcsetattr(STDIN_FILENO, TCSANOW, &t);
1252 #endif /* Q_OS_WIN */