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!";
90 qDeleteAll(_connectingClients);
91 qDeleteAll(_sessions);
99 _startTime = QDateTime::currentDateTime().toUTC(); // for uptime :)
101 Quassel::loadTranslation(QLocale::system());
103 // check settings version
104 // so far, we only have 1
106 if (s.version() != 1) {
107 qCritical() << "Invalid core settings version, terminating!";
108 QCoreApplication::exit(EXIT_FAILURE);
112 // Set up storage and authentication backends
113 registerStorageBackends();
114 registerAuthenticators();
116 QProcessEnvironment environment = QProcessEnvironment::systemEnvironment();
117 bool config_from_environment = Quassel::isOptionSet("config-from-environment");
120 QVariantMap db_connectionProperties;
122 QString auth_authenticator;
123 QVariantMap auth_properties;
125 bool writeError = false;
127 if (config_from_environment) {
128 db_backend = environment.value("DB_BACKEND");
129 auth_authenticator = environment.value("AUTH_AUTHENTICATOR");
133 QVariantMap dbsettings = cs.storageSettings().toMap();
134 db_backend = dbsettings.value("Backend").toString();
135 db_connectionProperties = dbsettings.value("ConnectionProperties").toMap();
137 QVariantMap authSettings = cs.authSettings().toMap();
138 auth_authenticator = authSettings.value("Authenticator", "Database").toString();
139 auth_properties = authSettings.value("AuthProperties").toMap();
141 writeError = !cs.isWritable();
145 _configured = initStorage(db_backend, db_connectionProperties, environment, config_from_environment);
147 // Not entirely sure what is 'legacy' about the above, but it seems to be the way things work!
149 initAuthenticator(auth_authenticator, auth_properties, environment, config_from_environment);
152 if (Quassel::isOptionSet("select-backend") || Quassel::isOptionSet("select-authenticator")) {
154 if (Quassel::isOptionSet("select-backend")) {
155 success &= selectBackend(Quassel::optionValue("select-backend"));
157 if (Quassel::isOptionSet("select-authenticator")) {
158 success &= selectAuthenticator(Quassel::optionValue("select-authenticator"));
160 QCoreApplication::exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
165 if (config_from_environment) {
166 _configured = initStorage(db_backend, db_connectionProperties, environment, config_from_environment, true);
167 initAuthenticator(auth_authenticator, auth_properties, environment, config_from_environment, true);
170 qWarning() << "Cannot configure from environment";
171 QCoreApplication::exit(EXIT_FAILURE);
176 if (_registeredStorageBackends.empty()) {
177 quWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
179 << qPrintable(tr("Currently, Quassel supports SQLite3 and PostgreSQL. You need to build your\n"
180 "Qt library with the sqlite or postgres plugin enabled in order for quasselcore\n"
182 QCoreApplication::exit(EXIT_FAILURE); // TODO make this less brutal (especially for mono client -> popup)
187 qWarning() << "Cannot write quasselcore configuration; probably a permission problem.";
188 QCoreApplication::exit(EXIT_FAILURE);
192 quInfo() << "Core is currently not configured! Please connect with a Quassel Client for basic setup.";
196 if (Quassel::isOptionSet("add-user")) {
197 bool success = createUser();
198 QCoreApplication::exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
202 if (Quassel::isOptionSet("change-userpass")) {
203 bool success = changeUserPass(Quassel::optionValue("change-userpass"));
204 QCoreApplication::exit(success ? EXIT_SUCCESS : EXIT_FAILURE);
208 _strictIdentEnabled = Quassel::isOptionSet("strict-ident");
209 if (_strictIdentEnabled) {
213 if (Quassel::isOptionSet("oidentd")) {
214 _oidentdConfigGenerator = new OidentdConfigGenerator(this);
217 Quassel::registerReloadHandler([]() {
218 // Currently, only reloading SSL certificates and the sysident cache is supported
219 if (Core::instance()) {
220 Core::instance()->cacheSysIdent();
221 Core::instance()->reloadCerts();
227 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
228 _storageSyncTimer.start(10 * 60 * 1000); // 10 minutes
231 connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
232 connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
234 if (!startListening()) {
235 QCoreApplication::exit(EXIT_FAILURE); // TODO make this less brutal
239 if (_configured && !Quassel::isOptionSet("norestore")) {
240 Core::restoreState();
246 /*** Session Restore ***/
248 void Core::saveState()
251 QVariantList activeSessions;
252 for (auto &&user : instance()->_sessions.keys())
253 activeSessions << QVariant::fromValue<UserId>(user);
254 _storage->setCoreState(activeSessions);
259 void Core::restoreState()
262 quWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
265 if (_sessions.count()) {
266 quWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
271 /* We don't check, since we are at the first version since switching to Git
272 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
274 quWarning() << qPrintable(tr("Core state too old, ignoring..."));
279 const QList<QVariant> &activeSessionsFallback = s.coreState().toMap()["ActiveSessions"].toList();
280 QVariantList activeSessions = instance()->_storage->getCoreState(activeSessionsFallback);
282 if (activeSessions.count() > 0) {
283 quInfo() << "Restoring previous core state...";
284 for(auto &&v : activeSessions) {
285 UserId user = v.value<UserId>();
286 sessionForUser(user, true);
294 QString Core::setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupData)
296 return instance()->setupCore(adminUser, adminPassword, backend, setupData, authenticator, authSetupData);
300 QString Core::setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData, const QString &authenticator, const QVariantMap &authSetupData)
303 return tr("Core is already configured! Not configuring again...");
305 if (adminUser.isEmpty() || adminPassword.isEmpty()) {
306 return tr("Admin user or password not set.");
308 if (!(_configured = initStorage(backend, setupData, {}, false, true))) {
309 return tr("Could not setup storage!");
312 quInfo() << "Selected authenticator:" << authenticator;
313 if (!(_configured = initAuthenticator(authenticator, authSetupData, {}, false, true)))
315 return tr("Could not setup authenticator!");
318 if (!saveBackendSettings(backend, setupData)) {
319 return tr("Could not save backend settings, probably a permission problem.");
321 saveAuthenticatorSettings(authenticator, authSetupData);
323 quInfo() << qPrintable(tr("Creating admin user..."));
324 _storage->addUser(adminUser, adminPassword);
326 startListening(); // TODO check when we need this
331 QString Core::setupCoreForInternalUsage()
333 Q_ASSERT(!_registeredStorageBackends.empty());
335 qsrand(QDateTime::currentDateTime().toMSecsSinceEpoch());
337 for (int i = 0; i < 10; i++) {
339 pass += qrand() % 10;
342 // mono client currently needs sqlite
343 return setupCore("AdminUser", QString::number(pass), "SQLite", QVariantMap(), "Database", QVariantMap());
347 /*** Storage Handling ***/
349 template<typename Storage>
350 void Core::registerStorageBackend()
352 auto backend = makeDeferredShared<Storage>(this);
353 if (backend->isAvailable())
354 _registeredStorageBackends.emplace_back(std::move(backend));
356 backend->deleteLater();
360 void Core::registerStorageBackends()
362 if (_registeredStorageBackends.empty()) {
363 registerStorageBackend<SqliteStorage>();
364 registerStorageBackend<PostgreSqlStorage>();
369 DeferredSharedPtr<Storage> Core::storageBackend(const QString &backendId) const
371 auto it = std::find_if(_registeredStorageBackends.begin(), _registeredStorageBackends.end(),
372 [backendId](const DeferredSharedPtr<Storage> &backend) {
373 return backend->displayName() == backendId;
375 return it != _registeredStorageBackends.end() ? *it : nullptr;
379 // "Type" => "sqlite"
380 bool Core::initStorage(const QString &backend, const QVariantMap &settings,
381 const QProcessEnvironment &environment, bool loadFromEnvironment, bool setup)
383 if (backend.isEmpty()) {
384 quWarning() << "No storage backend selected!";
388 auto storage = storageBackend(backend);
390 qCritical() << "Selected storage backend is not available:" << backend;
394 Storage::State storageState = storage->init(settings, environment, loadFromEnvironment);
395 switch (storageState) {
396 case Storage::NeedsSetup:
398 return false; // trigger setup process
399 if (storage->setup(settings, environment, loadFromEnvironment))
400 return initStorage(backend, settings, environment, loadFromEnvironment, false);
403 // if initialization wasn't successful, we quit to keep from coming up unconfigured
404 case Storage::NotAvailable:
405 qCritical() << "FATAL: Selected storage backend is not available:" << backend;
407 QCoreApplication::exit(EXIT_FAILURE);
411 case Storage::IsReady:
412 // delete all other backends
413 _registeredStorageBackends.clear();
414 connect(storage.get(), SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)),
415 this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
418 _storage = std::move(storage);
423 void Core::syncStorage()
430 /*** Storage Access ***/
431 bool Core::createNetwork(UserId user, NetworkInfo &info)
433 NetworkId networkId = instance()->_storage->createNetwork(user, info);
434 if (!networkId.isValid())
437 info.networkId = networkId;
442 /*** Authenticators ***/
444 // Authentication handling, now independent from storage.
445 template<typename Authenticator>
446 void Core::registerAuthenticator()
448 auto authenticator = makeDeferredShared<Authenticator>(this);
449 if (authenticator->isAvailable())
450 _registeredAuthenticators.emplace_back(std::move(authenticator));
452 authenticator->deleteLater();
456 void Core::registerAuthenticators()
458 if (_registeredAuthenticators.empty()) {
459 registerAuthenticator<SqlAuthenticator>();
461 registerAuthenticator<LdapAuthenticator>();
467 DeferredSharedPtr<Authenticator> Core::authenticator(const QString &backendId) const
469 auto it = std::find_if(_registeredAuthenticators.begin(), _registeredAuthenticators.end(),
470 [backendId](const DeferredSharedPtr<Authenticator> &authenticator) {
471 return authenticator->backendId() == backendId;
473 return it != _registeredAuthenticators.end() ? *it : nullptr;
477 // FIXME: Apparently, this is the legacy way of initting storage backends?
478 // If there's a not-legacy way, it should be used here
479 bool Core::initAuthenticator(const QString &backend, const QVariantMap &settings,
480 const QProcessEnvironment &environment, bool loadFromEnvironment,
483 if (backend.isEmpty()) {
484 quWarning() << "No authenticator selected!";
488 auto auth = authenticator(backend);
490 qCritical() << "Selected auth backend is not available:" << backend;
494 Authenticator::State authState = auth->init(settings, environment, loadFromEnvironment);
496 case Authenticator::NeedsSetup:
498 return false; // trigger setup process
499 if (auth->setup(settings, environment, loadFromEnvironment))
500 return initAuthenticator(backend, settings, environment, loadFromEnvironment, false);
503 // if initialization wasn't successful, we quit to keep from coming up unconfigured
504 case Authenticator::NotAvailable:
505 qCritical() << "FATAL: Selected auth backend is not available:" << backend;
507 QCoreApplication::exit(EXIT_FAILURE);
511 case Authenticator::IsReady:
512 // delete all other backends
513 _registeredAuthenticators.clear();
516 _authenticator = std::move(auth);
521 /*** Network Management ***/
523 bool Core::sslSupported()
526 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
527 return sslServer && sslServer->isCertValid();
534 bool Core::reloadCerts()
537 SslServer *sslServerv4 = qobject_cast<SslServer *>(&_server);
538 bool retv4 = sslServerv4->reloadCerts();
540 SslServer *sslServerv6 = qobject_cast<SslServer *>(&_v6server);
541 bool retv6 = sslServerv6->reloadCerts();
543 return retv4 && retv6;
545 // SSL not supported, don't mark configuration reload as failed
551 void Core::cacheSysIdent()
553 if (isConfigured()) {
554 _authUserNames = _storage->getAllAuthUserNames();
559 QString Core::strictSysIdent(UserId user) const
561 if (_authUserNames.contains(user)) {
562 return _authUserNames[user];
565 // A new user got added since we last pulled our cache from the database.
566 // There's no way to avoid a database hit - we don't even know the authname!
567 instance()->cacheSysIdent();
569 if (_authUserNames.contains(user)) {
570 return _authUserNames[user];
573 // ...something very weird is going on if we ended up here (an active CoreSession without a corresponding database entry?)
574 qWarning().nospace() << "Unable to find authusername for UserId " << user << ", this should never happen!";
575 return "unknown"; // Should we just terminate the program instead?
579 bool Core::startListening()
581 // in mono mode we only start a local port if a port is specified in the cli call
582 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
585 bool success = false;
586 uint port = Quassel::optionValue("port").toUInt();
588 const QString listen = Quassel::optionValue("listen");
589 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
590 if (listen_list.size() > 0) {
591 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
593 if (!addr.setAddress(listen_term)) {
594 qCritical() << qPrintable(
595 tr("Invalid listen address %1")
600 switch (addr.protocol()) {
601 case QAbstractSocket::IPv6Protocol:
602 if (_v6server.listen(addr, port)) {
603 quInfo() << qPrintable(
604 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
605 .arg(addr.toString())
606 .arg(_v6server.serverPort())
607 .arg(Quassel::buildInfo().protocolVersion)
612 quWarning() << qPrintable(
613 tr("Could not open IPv6 interface %1:%2: %3")
614 .arg(addr.toString())
616 .arg(_v6server.errorString()));
618 case QAbstractSocket::IPv4Protocol:
619 if (_server.listen(addr, port)) {
620 quInfo() << qPrintable(
621 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
622 .arg(addr.toString())
623 .arg(_server.serverPort())
624 .arg(Quassel::buildInfo().protocolVersion)
629 // if v6 succeeded on Any, the port will be already in use - don't display the error then
630 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
631 quWarning() << qPrintable(
632 tr("Could not open IPv4 interface %1:%2: %3")
633 .arg(addr.toString())
635 .arg(_server.errorString()));
639 qCritical() << qPrintable(
640 tr("Invalid listen address %1, unknown network protocol")
649 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
655 void Core::stopListening(const QString &reason)
657 bool wasListening = false;
658 if (_server.isListening()) {
662 if (_v6server.isListening()) {
667 if (reason.isEmpty())
668 quInfo() << "No longer listening for GUI clients.";
670 quInfo() << qPrintable(reason);
675 void Core::incomingConnection()
677 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
679 while (server->hasPendingConnections()) {
680 QTcpSocket *socket = server->nextPendingConnection();
682 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
683 _connectingClients.insert(handler);
685 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
686 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
687 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
689 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
692 stopListening(tr("Closing server for basic setup."));
698 // Potentially called during the initialization phase (before handing the connection off to the session)
699 void Core::clientDisconnected()
701 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
704 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
705 _connectingClients.remove(handler);
706 handler->deleteLater();
708 // make server listen again if still not configured
713 // TODO remove unneeded sessions - if necessary/possible...
714 // Suggestion: kill sessions if they are not connected to any network and client.
718 void Core::setupClientSession(RemotePeer *peer, UserId uid)
720 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
723 // From now on everything is handled by the client session
724 disconnect(handler, 0, this, 0);
725 _connectingClients.remove(handler);
726 handler->deleteLater();
728 // Find or create session for validated user
731 // as we are currently handling an event triggered by incoming data on this socket
732 // it is unsafe to directly move the socket to the client thread.
733 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
737 void Core::customEvent(QEvent *event)
739 if (event->type() == AddClientEventId) {
740 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
741 addClientHelper(addClientEvent->peer, addClientEvent->userId);
747 void Core::addClientHelper(RemotePeer *peer, UserId uid)
749 // Find or create session for validated user
750 SessionThread *session = sessionForUser(uid);
751 session->addClient(peer);
755 void Core::setupInternalClientSession(InternalPeer *clientPeer)
759 setupCoreForInternalUsage();
764 uid = _storage->internalUser();
767 quWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
771 InternalPeer *corePeer = new InternalPeer(this);
772 corePeer->setPeer(clientPeer);
773 clientPeer->setPeer(corePeer);
775 // Find or create session for validated user
776 SessionThread *sessionThread = sessionForUser(uid);
777 sessionThread->addClient(corePeer);
781 SessionThread *Core::sessionForUser(UserId uid, bool restore)
783 if (_sessions.contains(uid))
784 return _sessions[uid];
786 SessionThread *session = new SessionThread(uid, restore, strictIdentEnabled(), this);
787 _sessions[uid] = session;
793 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
795 quWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
799 QVariantList Core::backendInfo()
801 instance()->registerStorageBackends();
803 QVariantList backendInfos;
804 for (auto &&backend : instance()->_registeredStorageBackends) {
806 v["BackendId"] = backend->backendId();
807 v["DisplayName"] = backend->displayName();
808 v["Description"] = backend->description();
809 v["SetupData"] = backend->setupData(); // ignored by legacy clients
811 // TODO Protocol Break: Remove legacy (cf. authenticatorInfo())
812 const auto &setupData = backend->setupData();
813 QStringList setupKeys;
814 QVariantMap setupDefaults;
815 for (int i = 0; i + 2 < setupData.size(); i += 3) {
816 setupKeys << setupData[i].toString();
817 setupDefaults[setupData[i].toString()] = setupData[i + 2];
819 v["SetupKeys"] = setupKeys;
820 v["SetupDefaults"] = setupDefaults;
821 // TODO Protocol Break: Remove
822 v["IsDefault"] = (backend->backendId() == "SQLite"); // newer clients will just use the first in the list
830 QVariantList Core::authenticatorInfo()
832 instance()->registerAuthenticators();
834 QVariantList authInfos;
835 for(auto &&backend : instance()->_registeredAuthenticators) {
837 v["BackendId"] = backend->backendId();
838 v["DisplayName"] = backend->displayName();
839 v["Description"] = backend->description();
840 v["SetupData"] = backend->setupData();
846 // migration / backend selection
847 bool Core::selectBackend(const QString &backend)
849 // reregister all storage backends
850 registerStorageBackends();
851 auto storage = storageBackend(backend);
853 QStringList backends;
854 std::transform(_registeredStorageBackends.begin(), _registeredStorageBackends.end(),
855 std::back_inserter(backends), [](const DeferredSharedPtr<Storage>& backend) {
856 return backend->displayName();
858 quWarning() << qPrintable(tr("Unsupported storage backend: %1").arg(backend));
859 quWarning() << qPrintable(tr("Supported backends are:")) << qPrintable(backends.join(", "));
863 QVariantMap settings = promptForSettings(storage.get());
865 Storage::State storageState = storage->init(settings);
866 switch (storageState) {
867 case Storage::IsReady:
868 if (!saveBackendSettings(backend, settings)) {
869 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
871 quWarning() << qPrintable(tr("Switched storage backend to: %1").arg(backend));
872 quWarning() << qPrintable(tr("Backend already initialized. Skipping Migration..."));
874 case Storage::NotAvailable:
875 qCritical() << qPrintable(tr("Storage backend is not available: %1").arg(backend));
877 case Storage::NeedsSetup:
878 if (!storage->setup(settings)) {
879 quWarning() << qPrintable(tr("Unable to setup storage backend: %1").arg(backend));
883 if (storage->init(settings) != Storage::IsReady) {
884 quWarning() << qPrintable(tr("Unable to initialize storage backend: %1").arg(backend));
888 if (!saveBackendSettings(backend, settings)) {
889 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
891 quWarning() << qPrintable(tr("Switched storage backend to: %1").arg(backend));
895 // let's see if we have a current storage object we can migrate from
896 auto reader = getMigrationReader(_storage.get());
897 auto writer = getMigrationWriter(storage.get());
898 if (reader && writer) {
899 qDebug() << qPrintable(tr("Migrating storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
902 if (reader->migrateTo(writer.get())) {
903 qDebug() << "Migration finished!";
904 qDebug() << qPrintable(tr("Migration finished!"));
905 if (!saveBackendSettings(backend, settings)) {
906 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
911 quWarning() << qPrintable(tr("Unable to migrate storage backend! (No migration writer for %1)").arg(backend));
915 // inform the user why we cannot merge
917 quWarning() << qPrintable(tr("No currently active storage backend. Skipping migration..."));
920 quWarning() << qPrintable(tr("Currently active storage backend does not support migration: %1").arg(_storage->displayName()));
923 quWarning() << qPrintable(tr("New storage backend does not support migration: %1").arg(backend));
926 // so we were unable to merge, but let's create a user \o/
927 _storage = std::move(storage);
932 // TODO: I am not sure if this function is implemented correctly.
933 // There is currently no concept of migraiton between auth backends.
934 bool Core::selectAuthenticator(const QString &backend)
936 // Register all authentication backends.
937 registerAuthenticators();
938 auto auther = authenticator(backend);
940 QStringList authenticators;
941 std::transform(_registeredAuthenticators.begin(), _registeredAuthenticators.end(),
942 std::back_inserter(authenticators), [](const DeferredSharedPtr<Authenticator>& authenticator) {
943 return authenticator->displayName();
945 quWarning() << qPrintable(tr("Unsupported authenticator: %1").arg(backend));
946 quWarning() << qPrintable(tr("Supported authenticators are:")) << qPrintable(authenticators.join(", "));
950 QVariantMap settings = promptForSettings(auther.get());
952 Authenticator::State state = auther->init(settings);
954 case Authenticator::IsReady:
955 saveAuthenticatorSettings(backend, settings);
956 quWarning() << qPrintable(tr("Switched authenticator to: %1").arg(backend));
958 case Authenticator::NotAvailable:
959 qCritical() << qPrintable(tr("Authenticator is not available: %1").arg(backend));
961 case Authenticator::NeedsSetup:
962 if (!auther->setup(settings)) {
963 quWarning() << qPrintable(tr("Unable to setup authenticator: %1").arg(backend));
967 if (auther->init(settings) != Authenticator::IsReady) {
968 quWarning() << qPrintable(tr("Unable to initialize authenticator: %1").arg(backend));
972 saveAuthenticatorSettings(backend, settings);
973 quWarning() << qPrintable(tr("Switched authenticator to: %1").arg(backend));
976 _authenticator = std::move(auther);
981 bool Core::createUser()
983 QTextStream out(stdout);
984 QTextStream in(stdin);
985 out << "Add a new user:" << endl;
988 QString username = in.readLine().trimmed();
993 QString password = in.readLine().trimmed();
995 out << "Repeat Password: ";
997 QString password2 = in.readLine().trimmed();
1001 if (password != password2) {
1002 quWarning() << "Passwords don't match!";
1005 if (password.isEmpty()) {
1006 quWarning() << "Password is empty!";
1010 if (_configured && _storage->addUser(username, password).isValid()) {
1011 out << "Added user " << username << " successfully!" << endl;
1015 quWarning() << "Unable to add user:" << qPrintable(username);
1021 bool Core::changeUserPass(const QString &username)
1023 QTextStream out(stdout);
1024 QTextStream in(stdin);
1025 UserId userId = _storage->getUserId(username);
1026 if (!userId.isValid()) {
1027 out << "User " << username << " does not exist." << endl;
1031 if (!canChangeUserPassword(userId)) {
1032 out << "User " << username << " is configured through an auth provider that has forbidden manual password changing." << endl;
1036 out << "Change password for user: " << username << endl;
1039 out << "New Password: ";
1041 QString password = in.readLine().trimmed();
1043 out << "Repeat Password: ";
1045 QString password2 = in.readLine().trimmed();
1049 if (password != password2) {
1050 quWarning() << "Passwords don't match!";
1053 if (password.isEmpty()) {
1054 quWarning() << "Password is empty!";
1058 if (_configured && _storage->updateUser(userId, password)) {
1059 out << "Password changed successfully!" << endl;
1063 quWarning() << "Failed to change password!";
1069 bool Core::changeUserPassword(UserId userId, const QString &password)
1071 if (!isConfigured() || !userId.isValid())
1074 if (!canChangeUserPassword(userId))
1077 return instance()->_storage->updateUser(userId, password);
1080 // TODO: this code isn't currently 100% optimal because the core
1081 // doesn't know it can have multiple auth providers configured (there aren't
1082 // multiple auth providers at the moment anyway) and we have hardcoded the
1083 // Database provider to be always allowed.
1084 bool Core::canChangeUserPassword(UserId userId)
1086 QString authProvider = instance()->_storage->getUserAuthenticator(userId);
1087 if (authProvider != "Database") {
1088 if (authProvider != instance()->_authenticator->backendId()) {
1091 else if (instance()->_authenticator->canChangePassword()) {
1099 std::unique_ptr<AbstractSqlMigrationReader> Core::getMigrationReader(Storage *storage)
1104 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
1106 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
1110 return sqlStorage->createMigrationReader();
1114 std::unique_ptr<AbstractSqlMigrationWriter> Core::getMigrationWriter(Storage *storage)
1119 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
1121 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
1125 return sqlStorage->createMigrationWriter();
1129 bool Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
1131 QVariantMap dbsettings;
1132 dbsettings["Backend"] = backend;
1133 dbsettings["ConnectionProperties"] = settings;
1134 CoreSettings s = CoreSettings();
1135 s.setStorageSettings(dbsettings);
1140 void Core::saveAuthenticatorSettings(const QString &backend, const QVariantMap &settings)
1142 QVariantMap dbsettings;
1143 dbsettings["Authenticator"] = backend;
1144 dbsettings["AuthProperties"] = settings;
1145 CoreSettings().setAuthSettings(dbsettings);
1148 // Generic version of promptForSettings that doesn't care what *type* of
1149 // backend it runs over.
1150 template<typename Backend>
1151 QVariantMap Core::promptForSettings(const Backend *backend)
1153 QVariantMap settings;
1154 const QVariantList& setupData = backend->setupData();
1156 if (setupData.isEmpty())
1159 QTextStream out(stdout);
1160 QTextStream in(stdin);
1161 out << "Default values are in brackets" << endl;
1163 for (int i = 0; i + 2 < setupData.size(); i += 3) {
1164 QString key = setupData[i].toString();
1165 out << setupData[i+1].toString() << " [" << setupData[i+2].toString() << "]: " << flush;
1167 bool noEcho = key.toLower().contains("password");
1171 QString input = in.readLine().trimmed();
1177 QVariant value{setupData[i+2]};
1178 if (!input.isEmpty()) {
1179 switch (value.type()) {
1181 value = input.toInt();
1187 settings[key] = value;
1194 void Core::stdInEcho(bool on)
1196 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
1198 GetConsoleMode(hStdin, &mode);
1200 mode |= ENABLE_ECHO_INPUT;
1202 mode &= ~ENABLE_ECHO_INPUT;
1203 SetConsoleMode(hStdin, mode);
1207 void Core::stdInEcho(bool on)
1210 tcgetattr(STDIN_FILENO, &t);
1215 tcsetattr(STDIN_FILENO, TCSANOW, &t);
1218 #endif /* Q_OS_WIN */