1 /***************************************************************************
2 * Copyright (C) 2005-2016 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 ***************************************************************************/
21 #include <QCoreApplication>
24 #include "coreauthhandler.h"
25 #include "coresession.h"
26 #include "coresettings.h"
28 #include "internalpeer.h"
30 #include "postgresqlstorage.h"
32 #include "sqlitestorage.h"
45 # include <sys/types.h>
46 # include <sys/stat.h>
47 #endif /* HAVE_UMASK */
49 // ==============================
51 // ==============================
52 const int Core::AddClientEventId = QEvent::registerEventType();
54 class AddClientEvent : public QEvent
57 AddClientEvent(RemotePeer *p, UserId uid) : QEvent(QEvent::Type(Core::AddClientEventId)), peer(p), userId(uid) {}
63 // ==============================
65 // ==============================
66 Core *Core::instanceptr = 0;
68 Core *Core::instance()
70 if (instanceptr) return instanceptr;
71 instanceptr = new Core();
89 umask(S_IRWXG | S_IRWXO);
91 _startTime = QDateTime::currentDateTime().toUTC(); // for uptime :)
93 Quassel::loadTranslation(QLocale::system());
95 // FIXME: MIGRATION 0.3 -> 0.4: Move database and core config to new location
96 // Move settings, note this does not delete the old files
98 QSettings newSettings("quassel-irc.org", "quasselcore");
102 QSettings::Format format = QSettings::IniFormat;
104 QSettings::Format format = QSettings::NativeFormat;
106 QString newFilePath = Quassel::configDirPath() + "quasselcore"
107 + ((format == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
108 QSettings newSettings(newFilePath, format);
109 #endif /* Q_OS_MAC */
111 if (newSettings.value("Config/Version").toUInt() == 0) {
113 QString org = "quassel-irc.org";
115 QString org = "Quassel Project";
117 QSettings oldSettings(org, "Quassel Core");
118 if (oldSettings.allKeys().count()) {
119 qWarning() << "\n\n*** IMPORTANT: Config and data file locations have changed. Attempting to auto-migrate your core settings...";
120 foreach(QString key, oldSettings.allKeys())
121 newSettings.setValue(key, oldSettings.value(key));
122 newSettings.setValue("Config/Version", 1);
123 qWarning() << "* Your core settings have been migrated to" << newSettings.fileName();
125 #ifndef Q_OS_MAC /* we don't need to move the db and cert for mac */
127 QString quasselDir = qgetenv("APPDATA") + "/quassel/";
128 #elif defined Q_OS_MAC
129 QString quasselDir = QDir::homePath() + "/Library/Application Support/Quassel/";
131 QString quasselDir = QDir::homePath() + "/.quassel/";
134 QFileInfo info(Quassel::configDirPath() + "quassel-storage.sqlite");
135 if (!info.exists()) {
136 // move database, if we found it
137 QFile oldDb(quasselDir + "quassel-storage.sqlite");
138 if (oldDb.exists()) {
139 bool success = oldDb.rename(Quassel::configDirPath() + "quassel-storage.sqlite");
141 qWarning() << "* Your database has been moved to" << Quassel::configDirPath() + "quassel-storage.sqlite";
143 qWarning() << "!!! Moving your database has failed. Please move it manually into" << Quassel::configDirPath();
147 QFileInfo certInfo(quasselDir + "quasselCert.pem");
148 if (certInfo.exists()) {
149 QFile cert(quasselDir + "quasselCert.pem");
150 bool success = cert.rename(Quassel::configDirPath() + "quasselCert.pem");
152 qWarning() << "* Your certificate has been moved to" << Quassel::configDirPath() + "quasselCert.pem";
154 qWarning() << "!!! Moving your certificate has failed. Please move it manually into" << Quassel::configDirPath();
156 #endif /* !Q_OS_MAC */
157 qWarning() << "*** Migration completed.\n\n";
162 // check settings version
163 // so far, we only have 1
165 if (s.version() != 1) {
166 qCritical() << "Invalid core settings version, terminating!";
170 registerStorageBackends();
172 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
173 _storageSyncTimer.start(10 * 60 * 1000); // 10 minutes
181 QVariantMap dbsettings = cs.storageSettings().toMap();
182 _configured = initStorage(dbsettings.value("Backend").toString(), dbsettings.value("ConnectionProperties").toMap());
184 if (Quassel::isOptionSet("select-backend")) {
185 selectBackend(Quassel::optionValue("select-backend"));
190 if (!_storageBackends.count()) {
191 qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
192 qWarning() << qPrintable(tr("Currently, Quassel supports SQLite3 and PostgreSQL. You need to build your\n"
193 "Qt library with the sqlite or postgres plugin enabled in order for quasselcore\n"
195 exit(1); // TODO make this less brutal (especially for mono client -> popup)
197 qWarning() << "Core is currently not configured! Please connect with a Quassel Client for basic setup.";
200 if (Quassel::isOptionSet("add-user")) {
201 exit(createUser() ? EXIT_SUCCESS : EXIT_FAILURE);
205 if (Quassel::isOptionSet("change-userpass")) {
206 exit(changeUserPass(Quassel::optionValue("change-userpass")) ?
207 EXIT_SUCCESS : EXIT_FAILURE);
210 connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
211 connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
212 if (!startListening()) exit(1); // TODO make this less brutal
214 if (Quassel::isOptionSet("oidentd"))
215 _oidentdConfigGenerator = new OidentdConfigGenerator(this);
221 // FIXME do we need more cleanup for handlers?
222 foreach(CoreAuthHandler *handler, _connectingClients) {
223 handler->deleteLater(); // disconnect non authed clients
225 qDeleteAll(_sessions);
226 qDeleteAll(_storageBackends);
230 /*** Session Restore ***/
232 void Core::saveState()
236 QVariantList activeSessions;
237 foreach(UserId user, instance()->_sessions.keys())
238 activeSessions << QVariant::fromValue<UserId>(user);
239 state["CoreStateVersion"] = 1;
240 state["ActiveSessions"] = activeSessions;
241 s.setCoreState(state);
245 void Core::restoreState()
247 if (!instance()->_configured) {
248 // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
251 if (instance()->_sessions.count()) {
252 qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
256 /* We don't check, since we are at the first version since switching to Git
257 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
259 qWarning() << qPrintable(tr("Core state too old, ignoring..."));
264 QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
265 if (activeSessions.count() > 0) {
266 quInfo() << "Restoring previous core state...";
267 foreach(QVariant v, activeSessions) {
268 UserId user = v.value<UserId>();
269 instance()->sessionForUser(user, true);
277 QString Core::setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
279 return instance()->setupCore(adminUser, adminPassword, backend, setupData);
283 QString Core::setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
286 return tr("Core is already configured! Not configuring again...");
288 if (adminUser.isEmpty() || adminPassword.isEmpty()) {
289 return tr("Admin user or password not set.");
291 if (!(_configured = initStorage(backend, setupData, true))) {
292 return tr("Could not setup storage!");
295 saveBackendSettings(backend, setupData);
297 quInfo() << qPrintable(tr("Creating admin user..."));
298 _storage->addUser(adminUser, adminPassword);
299 startListening(); // TODO check when we need this
304 QString Core::setupCoreForInternalUsage()
306 Q_ASSERT(!_storageBackends.isEmpty());
308 qsrand(QDateTime::currentDateTime().toTime_t());
310 for (int i = 0; i < 10; i++) {
312 pass += qrand() % 10;
315 // mono client currently needs sqlite
316 return setupCore("AdminUser", QString::number(pass), "SQLite", QVariantMap());
320 /*** Storage Handling ***/
321 void Core::registerStorageBackends()
323 // Register storage backends here!
324 registerStorageBackend(new SqliteStorage(this));
325 registerStorageBackend(new PostgreSqlStorage(this));
329 bool Core::registerStorageBackend(Storage *backend)
331 if (backend->isAvailable()) {
332 _storageBackends[backend->displayName()] = backend;
336 backend->deleteLater();
342 void Core::unregisterStorageBackends()
344 foreach(Storage *s, _storageBackends.values()) {
347 _storageBackends.clear();
351 void Core::unregisterStorageBackend(Storage *backend)
353 _storageBackends.remove(backend->displayName());
354 backend->deleteLater();
359 // "Type" => "sqlite"
360 bool Core::initStorage(const QString &backend, const QVariantMap &settings, bool setup)
364 if (backend.isEmpty()) {
368 Storage *storage = 0;
369 if (_storageBackends.contains(backend)) {
370 storage = _storageBackends[backend];
373 qCritical() << "Selected storage backend is not available:" << backend;
377 Storage::State storageState = storage->init(settings);
378 switch (storageState) {
379 case Storage::NeedsSetup:
381 return false; // trigger setup process
382 if (storage->setup(settings))
383 return initStorage(backend, settings, false);
384 // if initialization wasn't successful, we quit to keep from coming up unconfigured
385 case Storage::NotAvailable:
386 qCritical() << "FATAL: Selected storage backend is not available:" << backend;
388 case Storage::IsReady:
389 // delete all other backends
390 _storageBackends.remove(backend);
391 unregisterStorageBackends();
392 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
399 void Core::syncStorage()
406 /*** Storage Access ***/
407 bool Core::createNetwork(UserId user, NetworkInfo &info)
409 NetworkId networkId = instance()->_storage->createNetwork(user, info);
410 if (!networkId.isValid())
413 info.networkId = networkId;
418 /*** Network Management ***/
420 bool Core::sslSupported()
423 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
424 return sslServer && sslServer->isCertValid();
431 bool Core::startListening()
433 // in mono mode we only start a local port if a port is specified in the cli call
434 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
437 bool success = false;
438 uint port = Quassel::optionValue("port").toUInt();
440 const QString listen = Quassel::optionValue("listen");
441 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
442 if (listen_list.size() > 0) {
443 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
445 if (!addr.setAddress(listen_term)) {
446 qCritical() << qPrintable(
447 tr("Invalid listen address %1")
452 switch (addr.protocol()) {
453 case QAbstractSocket::IPv6Protocol:
454 if (_v6server.listen(addr, port)) {
455 quInfo() << qPrintable(
456 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
457 .arg(addr.toString())
458 .arg(_v6server.serverPort())
459 .arg(Quassel::buildInfo().protocolVersion)
464 quWarning() << qPrintable(
465 tr("Could not open IPv6 interface %1:%2: %3")
466 .arg(addr.toString())
468 .arg(_v6server.errorString()));
470 case QAbstractSocket::IPv4Protocol:
471 if (_server.listen(addr, port)) {
472 quInfo() << qPrintable(
473 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
474 .arg(addr.toString())
475 .arg(_server.serverPort())
476 .arg(Quassel::buildInfo().protocolVersion)
481 // if v6 succeeded on Any, the port will be already in use - don't display the error then
482 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
483 quWarning() << qPrintable(
484 tr("Could not open IPv4 interface %1:%2: %3")
485 .arg(addr.toString())
487 .arg(_server.errorString()));
491 qCritical() << qPrintable(
492 tr("Invalid listen address %1, unknown network protocol")
501 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
507 void Core::stopListening(const QString &reason)
509 bool wasListening = false;
510 if (_server.isListening()) {
514 if (_v6server.isListening()) {
519 if (reason.isEmpty())
520 quInfo() << "No longer listening for GUI clients.";
522 quInfo() << qPrintable(reason);
527 void Core::incomingConnection()
529 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
531 while (server->hasPendingConnections()) {
532 QTcpSocket *socket = server->nextPendingConnection();
534 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
535 _connectingClients.insert(handler);
537 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
538 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
539 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
541 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
544 stopListening(tr("Closing server for basic setup."));
550 // Potentially called during the initialization phase (before handing the connection off to the session)
551 void Core::clientDisconnected()
553 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
556 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
557 _connectingClients.remove(handler);
558 handler->deleteLater();
560 // make server listen again if still not configured
565 // TODO remove unneeded sessions - if necessary/possible...
566 // Suggestion: kill sessions if they are not connected to any network and client.
570 void Core::setupClientSession(RemotePeer *peer, UserId uid)
572 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
575 // From now on everything is handled by the client session
576 disconnect(handler, 0, this, 0);
577 _connectingClients.remove(handler);
578 handler->deleteLater();
580 // Find or create session for validated user
583 // as we are currently handling an event triggered by incoming data on this socket
584 // it is unsafe to directly move the socket to the client thread.
585 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
589 void Core::customEvent(QEvent *event)
591 if (event->type() == AddClientEventId) {
592 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
593 addClientHelper(addClientEvent->peer, addClientEvent->userId);
599 void Core::addClientHelper(RemotePeer *peer, UserId uid)
601 // Find or create session for validated user
602 SessionThread *session = sessionForUser(uid);
603 session->addClient(peer);
607 void Core::setupInternalClientSession(InternalPeer *clientPeer)
611 setupCoreForInternalUsage();
616 uid = _storage->internalUser();
619 qWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
623 InternalPeer *corePeer = new InternalPeer(this);
624 corePeer->setPeer(clientPeer);
625 clientPeer->setPeer(corePeer);
627 // Find or create session for validated user
628 SessionThread *sessionThread = sessionForUser(uid);
629 sessionThread->addClient(corePeer);
633 SessionThread *Core::sessionForUser(UserId uid, bool restore)
635 if (_sessions.contains(uid))
636 return _sessions[uid];
638 SessionThread *session = new SessionThread(uid, restore, this);
639 _sessions[uid] = session;
645 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
647 qWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
651 QVariantList Core::backendInfo()
653 QVariantList backends;
654 foreach(const Storage *backend, instance()->_storageBackends.values()) {
656 v["DisplayName"] = backend->displayName();
657 v["Description"] = backend->description();
658 v["SetupKeys"] = backend->setupKeys();
659 v["SetupDefaults"] = backend->setupDefaults();
666 // migration / backend selection
667 bool Core::selectBackend(const QString &backend)
669 // reregister all storage backends
670 registerStorageBackends();
671 if (!_storageBackends.contains(backend)) {
672 qWarning() << qPrintable(QString("Core::selectBackend(): unsupported backend: %1").arg(backend));
673 qWarning() << " supported backends are:" << qPrintable(QStringList(_storageBackends.keys()).join(", "));
677 Storage *storage = _storageBackends[backend];
678 QVariantMap settings = promptForSettings(storage);
680 Storage::State storageState = storage->init(settings);
681 switch (storageState) {
682 case Storage::IsReady:
683 saveBackendSettings(backend, settings);
684 qWarning() << "Switched backend to:" << qPrintable(backend);
685 qWarning() << "Backend already initialized. Skipping Migration";
687 case Storage::NotAvailable:
688 qCritical() << "Backend is not available:" << qPrintable(backend);
690 case Storage::NeedsSetup:
691 if (!storage->setup(settings)) {
692 qWarning() << qPrintable(QString("Core::selectBackend(): unable to setup backend: %1").arg(backend));
696 if (storage->init(settings) != Storage::IsReady) {
697 qWarning() << qPrintable(QString("Core::migrateBackend(): unable to initialize backend: %1").arg(backend));
701 saveBackendSettings(backend, settings);
702 qWarning() << "Switched backend to:" << qPrintable(backend);
706 // let's see if we have a current storage object we can migrate from
707 AbstractSqlMigrationReader *reader = getMigrationReader(_storage);
708 AbstractSqlMigrationWriter *writer = getMigrationWriter(storage);
709 if (reader && writer) {
710 qDebug() << qPrintable(QString("Migrating Storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
715 if (reader->migrateTo(writer)) {
716 qDebug() << "Migration finished!";
717 saveBackendSettings(backend, settings);
721 qWarning() << qPrintable(QString("Core::migrateDb(): unable to migrate storage backend! (No migration writer for %1)").arg(backend));
724 // inform the user why we cannot merge
726 qWarning() << "No currently active backend. Skipping migration.";
729 qWarning() << "Currently active backend does not support migration:" << qPrintable(_storage->displayName());
732 qWarning() << "New backend does not support migration:" << qPrintable(backend);
735 // so we were unable to merge, but let's create a user \o/
742 bool Core::createUser()
744 QTextStream out(stdout);
745 QTextStream in(stdin);
746 out << "Add a new user:" << endl;
749 QString username = in.readLine().trimmed();
754 QString password = in.readLine().trimmed();
756 out << "Repeat Password: ";
758 QString password2 = in.readLine().trimmed();
762 if (password != password2) {
763 qWarning() << "Passwords don't match!";
766 if (password.isEmpty()) {
767 qWarning() << "Password is empty!";
771 if (_configured && _storage->addUser(username, password).isValid()) {
772 out << "Added user " << username << " successfully!" << endl;
776 qWarning() << "Unable to add user:" << qPrintable(username);
782 bool Core::changeUserPass(const QString &username)
784 QTextStream out(stdout);
785 QTextStream in(stdin);
786 UserId userId = _storage->getUserId(username);
787 if (!userId.isValid()) {
788 out << "User " << username << " does not exist." << endl;
792 out << "Change password for user: " << username << endl;
795 out << "New Password: ";
797 QString password = in.readLine().trimmed();
799 out << "Repeat Password: ";
801 QString password2 = in.readLine().trimmed();
805 if (password != password2) {
806 qWarning() << "Passwords don't match!";
809 if (password.isEmpty()) {
810 qWarning() << "Password is empty!";
814 if (_configured && _storage->updateUser(userId, password)) {
815 out << "Password changed successfully!" << endl;
819 qWarning() << "Failed to change password!";
825 bool Core::changeUserPassword(UserId userId, const QString &password)
827 if (!isConfigured() || !userId.isValid())
830 return instance()->_storage->updateUser(userId, password);
834 AbstractSqlMigrationReader *Core::getMigrationReader(Storage *storage)
839 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
841 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
845 return sqlStorage->createMigrationReader();
849 AbstractSqlMigrationWriter *Core::getMigrationWriter(Storage *storage)
854 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
856 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
860 return sqlStorage->createMigrationWriter();
864 void Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
866 QVariantMap dbsettings;
867 dbsettings["Backend"] = backend;
868 dbsettings["ConnectionProperties"] = settings;
869 CoreSettings().setStorageSettings(dbsettings);
873 QVariantMap Core::promptForSettings(const Storage *storage)
875 QVariantMap settings;
877 QStringList keys = storage->setupKeys();
881 QTextStream out(stdout);
882 QTextStream in(stdin);
883 out << "Default values are in brackets" << endl;
885 QVariantMap defaults = storage->setupDefaults();
887 foreach(QString key, keys) {
889 if (defaults.contains(key)) {
893 if (!val.toString().isEmpty()) {
894 out << " (" << val.toString() << ")";
899 bool noEcho = QString("password").toLower().startsWith(key.toLower());
903 value = in.readLine().trimmed();
909 if (!value.isEmpty()) {
910 switch (defaults[key].type()) {
912 val = QVariant(value.toInt());
915 val = QVariant(value);
925 void Core::stdInEcho(bool on)
927 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
929 GetConsoleMode(hStdin, &mode);
931 mode |= ENABLE_ECHO_INPUT;
933 mode &= ~ENABLE_ECHO_INPUT;
934 SetConsoleMode(hStdin, mode);
939 void Core::stdInEcho(bool on)
942 tcgetattr(STDIN_FILENO, &t);
947 tcsetattr(STDIN_FILENO, TCSANOW, &t);
951 #endif /* Q_OS_WIN */