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)
198 qWarning() << "Core is currently not configured! Please connect with a Quassel Client for basic setup.";
200 if (!cs.isWritable()) {
201 qWarning() << "Cannot write quasselcore configuration; probably a permission problem.";
207 if (Quassel::isOptionSet("add-user")) {
208 exit(createUser() ? EXIT_SUCCESS : EXIT_FAILURE);
212 if (Quassel::isOptionSet("change-userpass")) {
213 exit(changeUserPass(Quassel::optionValue("change-userpass")) ?
214 EXIT_SUCCESS : EXIT_FAILURE);
217 connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
218 connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
219 if (!startListening()) exit(1); // TODO make this less brutal
221 if (Quassel::isOptionSet("oidentd"))
222 _oidentdConfigGenerator = new OidentdConfigGenerator(this);
228 // FIXME do we need more cleanup for handlers?
229 foreach(CoreAuthHandler *handler, _connectingClients) {
230 handler->deleteLater(); // disconnect non authed clients
232 qDeleteAll(_sessions);
233 qDeleteAll(_storageBackends);
237 /*** Session Restore ***/
239 void Core::saveState()
243 QVariantList activeSessions;
244 foreach(UserId user, instance()->_sessions.keys())
245 activeSessions << QVariant::fromValue<UserId>(user);
246 state["CoreStateVersion"] = 1;
247 state["ActiveSessions"] = activeSessions;
248 s.setCoreState(state);
252 void Core::restoreState()
254 if (!instance()->_configured) {
255 // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
258 if (instance()->_sessions.count()) {
259 qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
263 /* We don't check, since we are at the first version since switching to Git
264 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
266 qWarning() << qPrintable(tr("Core state too old, ignoring..."));
271 QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
272 if (activeSessions.count() > 0) {
273 quInfo() << "Restoring previous core state...";
274 foreach(QVariant v, activeSessions) {
275 UserId user = v.value<UserId>();
276 instance()->sessionForUser(user, true);
284 QString Core::setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
286 return instance()->setupCore(adminUser, adminPassword, backend, setupData);
290 QString Core::setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
293 return tr("Core is already configured! Not configuring again...");
295 if (adminUser.isEmpty() || adminPassword.isEmpty()) {
296 return tr("Admin user or password not set.");
298 if (!(_configured = initStorage(backend, setupData, true))) {
299 return tr("Could not setup storage!");
302 if (!saveBackendSettings(backend, setupData)) {
303 return tr("Could not save backend settings, probably a permission problem.");
306 quInfo() << qPrintable(tr("Creating admin user..."));
307 _storage->addUser(adminUser, adminPassword);
308 startListening(); // TODO check when we need this
313 QString Core::setupCoreForInternalUsage()
315 Q_ASSERT(!_storageBackends.isEmpty());
317 qsrand(QDateTime::currentDateTime().toTime_t());
319 for (int i = 0; i < 10; i++) {
321 pass += qrand() % 10;
324 // mono client currently needs sqlite
325 return setupCore("AdminUser", QString::number(pass), "SQLite", QVariantMap());
329 /*** Storage Handling ***/
330 void Core::registerStorageBackends()
332 // Register storage backends here!
333 registerStorageBackend(new SqliteStorage(this));
334 registerStorageBackend(new PostgreSqlStorage(this));
338 bool Core::registerStorageBackend(Storage *backend)
340 if (backend->isAvailable()) {
341 _storageBackends[backend->displayName()] = backend;
345 backend->deleteLater();
351 void Core::unregisterStorageBackends()
353 foreach(Storage *s, _storageBackends.values()) {
356 _storageBackends.clear();
360 void Core::unregisterStorageBackend(Storage *backend)
362 _storageBackends.remove(backend->displayName());
363 backend->deleteLater();
368 // "Type" => "sqlite"
369 bool Core::initStorage(const QString &backend, const QVariantMap &settings, bool setup)
373 if (backend.isEmpty()) {
377 Storage *storage = 0;
378 if (_storageBackends.contains(backend)) {
379 storage = _storageBackends[backend];
382 qCritical() << "Selected storage backend is not available:" << backend;
386 Storage::State storageState = storage->init(settings);
387 switch (storageState) {
388 case Storage::NeedsSetup:
390 return false; // trigger setup process
391 if (storage->setup(settings))
392 return initStorage(backend, settings, false);
393 // if initialization wasn't successful, we quit to keep from coming up unconfigured
394 case Storage::NotAvailable:
395 qCritical() << "FATAL: Selected storage backend is not available:" << backend;
397 case Storage::IsReady:
398 // delete all other backends
399 _storageBackends.remove(backend);
400 unregisterStorageBackends();
401 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
408 void Core::syncStorage()
415 /*** Storage Access ***/
416 bool Core::createNetwork(UserId user, NetworkInfo &info)
418 NetworkId networkId = instance()->_storage->createNetwork(user, info);
419 if (!networkId.isValid())
422 info.networkId = networkId;
427 /*** Network Management ***/
429 bool Core::sslSupported()
432 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
433 return sslServer && sslServer->isCertValid();
440 bool Core::reloadCerts()
443 SslServer *sslServerv4 = qobject_cast<SslServer *>(&instance()->_server);
444 bool retv4 = sslServerv4->reloadCerts();
446 SslServer *sslServerv6 = qobject_cast<SslServer *>(&instance()->_v6server);
447 bool retv6 = sslServerv6->reloadCerts();
449 return retv4 && retv6;
451 // SSL not supported, don't mark configuration reload as failed
457 bool Core::startListening()
459 // in mono mode we only start a local port if a port is specified in the cli call
460 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
463 bool success = false;
464 uint port = Quassel::optionValue("port").toUInt();
466 const QString listen = Quassel::optionValue("listen");
467 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
468 if (listen_list.size() > 0) {
469 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
471 if (!addr.setAddress(listen_term)) {
472 qCritical() << qPrintable(
473 tr("Invalid listen address %1")
478 switch (addr.protocol()) {
479 case QAbstractSocket::IPv6Protocol:
480 if (_v6server.listen(addr, port)) {
481 quInfo() << qPrintable(
482 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
483 .arg(addr.toString())
484 .arg(_v6server.serverPort())
485 .arg(Quassel::buildInfo().protocolVersion)
490 quWarning() << qPrintable(
491 tr("Could not open IPv6 interface %1:%2: %3")
492 .arg(addr.toString())
494 .arg(_v6server.errorString()));
496 case QAbstractSocket::IPv4Protocol:
497 if (_server.listen(addr, port)) {
498 quInfo() << qPrintable(
499 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
500 .arg(addr.toString())
501 .arg(_server.serverPort())
502 .arg(Quassel::buildInfo().protocolVersion)
507 // if v6 succeeded on Any, the port will be already in use - don't display the error then
508 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
509 quWarning() << qPrintable(
510 tr("Could not open IPv4 interface %1:%2: %3")
511 .arg(addr.toString())
513 .arg(_server.errorString()));
517 qCritical() << qPrintable(
518 tr("Invalid listen address %1, unknown network protocol")
527 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
533 void Core::stopListening(const QString &reason)
535 bool wasListening = false;
536 if (_server.isListening()) {
540 if (_v6server.isListening()) {
545 if (reason.isEmpty())
546 quInfo() << "No longer listening for GUI clients.";
548 quInfo() << qPrintable(reason);
553 void Core::incomingConnection()
555 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
557 while (server->hasPendingConnections()) {
558 QTcpSocket *socket = server->nextPendingConnection();
560 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
561 _connectingClients.insert(handler);
563 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
564 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
565 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
567 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
570 stopListening(tr("Closing server for basic setup."));
576 // Potentially called during the initialization phase (before handing the connection off to the session)
577 void Core::clientDisconnected()
579 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
582 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
583 _connectingClients.remove(handler);
584 handler->deleteLater();
586 // make server listen again if still not configured
591 // TODO remove unneeded sessions - if necessary/possible...
592 // Suggestion: kill sessions if they are not connected to any network and client.
596 void Core::setupClientSession(RemotePeer *peer, UserId uid)
598 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
601 // From now on everything is handled by the client session
602 disconnect(handler, 0, this, 0);
603 _connectingClients.remove(handler);
604 handler->deleteLater();
606 // Find or create session for validated user
609 // as we are currently handling an event triggered by incoming data on this socket
610 // it is unsafe to directly move the socket to the client thread.
611 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
615 void Core::customEvent(QEvent *event)
617 if (event->type() == AddClientEventId) {
618 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
619 addClientHelper(addClientEvent->peer, addClientEvent->userId);
625 void Core::addClientHelper(RemotePeer *peer, UserId uid)
627 // Find or create session for validated user
628 SessionThread *session = sessionForUser(uid);
629 session->addClient(peer);
633 void Core::setupInternalClientSession(InternalPeer *clientPeer)
637 setupCoreForInternalUsage();
642 uid = _storage->internalUser();
645 qWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
649 InternalPeer *corePeer = new InternalPeer(this);
650 corePeer->setPeer(clientPeer);
651 clientPeer->setPeer(corePeer);
653 // Find or create session for validated user
654 SessionThread *sessionThread = sessionForUser(uid);
655 sessionThread->addClient(corePeer);
659 SessionThread *Core::sessionForUser(UserId uid, bool restore)
661 if (_sessions.contains(uid))
662 return _sessions[uid];
664 SessionThread *session = new SessionThread(uid, restore, this);
665 _sessions[uid] = session;
671 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
673 qWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
677 QVariantList Core::backendInfo()
679 QVariantList backends;
680 foreach(const Storage *backend, instance()->_storageBackends.values()) {
682 v["DisplayName"] = backend->displayName();
683 v["Description"] = backend->description();
684 v["SetupKeys"] = backend->setupKeys();
685 v["SetupDefaults"] = backend->setupDefaults();
686 v["IsDefault"] = isStorageBackendDefault(backend);
693 // migration / backend selection
694 bool Core::selectBackend(const QString &backend)
696 // reregister all storage backends
697 registerStorageBackends();
698 if (!_storageBackends.contains(backend)) {
699 qWarning() << qPrintable(QString("Core::selectBackend(): unsupported backend: %1").arg(backend));
700 qWarning() << " supported backends are:" << qPrintable(QStringList(_storageBackends.keys()).join(", "));
704 Storage *storage = _storageBackends[backend];
705 QVariantMap settings = promptForSettings(storage);
707 Storage::State storageState = storage->init(settings);
708 switch (storageState) {
709 case Storage::IsReady:
710 if (!saveBackendSettings(backend, settings)) {
711 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
713 qWarning() << "Switched backend to:" << qPrintable(backend);
714 qWarning() << "Backend already initialized. Skipping Migration";
716 case Storage::NotAvailable:
717 qCritical() << "Backend is not available:" << qPrintable(backend);
719 case Storage::NeedsSetup:
720 if (!storage->setup(settings)) {
721 qWarning() << qPrintable(QString("Core::selectBackend(): unable to setup backend: %1").arg(backend));
725 if (storage->init(settings) != Storage::IsReady) {
726 qWarning() << qPrintable(QString("Core::migrateBackend(): unable to initialize backend: %1").arg(backend));
730 if (!saveBackendSettings(backend, settings)) {
731 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
733 qWarning() << "Switched backend to:" << qPrintable(backend);
737 // let's see if we have a current storage object we can migrate from
738 AbstractSqlMigrationReader *reader = getMigrationReader(_storage);
739 AbstractSqlMigrationWriter *writer = getMigrationWriter(storage);
740 if (reader && writer) {
741 qDebug() << qPrintable(QString("Migrating Storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
746 if (reader->migrateTo(writer)) {
747 qDebug() << "Migration finished!";
748 if (!saveBackendSettings(backend, settings)) {
749 qCritical() << qPrintable(QString("Could not save backend settings, probably a permission problem."));
755 qWarning() << qPrintable(QString("Core::migrateDb(): unable to migrate storage backend! (No migration writer for %1)").arg(backend));
758 // inform the user why we cannot merge
760 qWarning() << "No currently active backend. Skipping migration.";
763 qWarning() << "Currently active backend does not support migration:" << qPrintable(_storage->displayName());
766 qWarning() << "New backend does not support migration:" << qPrintable(backend);
769 // so we were unable to merge, but let's create a user \o/
776 bool Core::createUser()
778 QTextStream out(stdout);
779 QTextStream in(stdin);
780 out << "Add a new user:" << endl;
783 QString username = in.readLine().trimmed();
788 QString password = in.readLine().trimmed();
790 out << "Repeat Password: ";
792 QString password2 = in.readLine().trimmed();
796 if (password != password2) {
797 qWarning() << "Passwords don't match!";
800 if (password.isEmpty()) {
801 qWarning() << "Password is empty!";
805 if (_configured && _storage->addUser(username, password).isValid()) {
806 out << "Added user " << username << " successfully!" << endl;
810 qWarning() << "Unable to add user:" << qPrintable(username);
816 bool Core::changeUserPass(const QString &username)
818 QTextStream out(stdout);
819 QTextStream in(stdin);
820 UserId userId = _storage->getUserId(username);
821 if (!userId.isValid()) {
822 out << "User " << username << " does not exist." << endl;
826 out << "Change password for user: " << username << endl;
829 out << "New Password: ";
831 QString password = in.readLine().trimmed();
833 out << "Repeat Password: ";
835 QString password2 = in.readLine().trimmed();
839 if (password != password2) {
840 qWarning() << "Passwords don't match!";
843 if (password.isEmpty()) {
844 qWarning() << "Password is empty!";
848 if (_configured && _storage->updateUser(userId, password)) {
849 out << "Password changed successfully!" << endl;
853 qWarning() << "Failed to change password!";
859 bool Core::changeUserPassword(UserId userId, const QString &password)
861 if (!isConfigured() || !userId.isValid())
864 return instance()->_storage->updateUser(userId, password);
868 AbstractSqlMigrationReader *Core::getMigrationReader(Storage *storage)
873 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
875 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
879 return sqlStorage->createMigrationReader();
883 AbstractSqlMigrationWriter *Core::getMigrationWriter(Storage *storage)
888 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
890 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
894 return sqlStorage->createMigrationWriter();
898 bool Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
900 QVariantMap dbsettings;
901 dbsettings["Backend"] = backend;
902 dbsettings["ConnectionProperties"] = settings;
903 CoreSettings s = CoreSettings();
904 s.setStorageSettings(dbsettings);
909 QVariantMap Core::promptForSettings(const Storage *storage)
911 QVariantMap settings;
913 QStringList keys = storage->setupKeys();
917 QTextStream out(stdout);
918 QTextStream in(stdin);
919 out << "Default values are in brackets" << endl;
921 QVariantMap defaults = storage->setupDefaults();
923 foreach(QString key, keys) {
925 if (defaults.contains(key)) {
929 if (!val.toString().isEmpty()) {
930 out << " (" << val.toString() << ")";
935 bool noEcho = QString("password").toLower().startsWith(key.toLower());
939 value = in.readLine().trimmed();
945 if (!value.isEmpty()) {
946 switch (defaults[key].type()) {
948 val = QVariant(value.toInt());
951 val = QVariant(value);
961 void Core::stdInEcho(bool on)
963 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
965 GetConsoleMode(hStdin, &mode);
967 mode |= ENABLE_ECHO_INPUT;
969 mode &= ~ENABLE_ECHO_INPUT;
970 SetConsoleMode(hStdin, mode);
975 void Core::stdInEcho(bool on)
978 tcgetattr(STDIN_FILENO, &t);
983 tcsetattr(STDIN_FILENO, TCSANOW, &t);
987 #endif /* Q_OS_WIN */