1 /***************************************************************************
2 * Copyright (C) 2005-2014 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")) {
205 if (Quassel::isOptionSet("change-userpass")) {
206 changeUserPass(Quassel::optionValue("change-userpass"));
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()) activeSessions << QVariant::fromValue<UserId>(user);
238 state["CoreStateVersion"] = 1;
239 state["ActiveSessions"] = activeSessions;
240 s.setCoreState(state);
244 void Core::restoreState()
246 if (!instance()->_configured) {
247 // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
250 if (instance()->sessions.count()) {
251 qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
255 /* We don't check, since we are at the first version since switching to Git
256 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
258 qWarning() << qPrintable(tr("Core state too old, ignoring..."));
263 QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
264 if (activeSessions.count() > 0) {
265 quInfo() << "Restoring previous core state...";
266 foreach(QVariant v, activeSessions) {
267 UserId user = v.value<UserId>();
268 instance()->createSession(user, true);
276 QString Core::setup(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
278 return instance()->setupCore(adminUser, adminPassword, backend, setupData);
282 QString Core::setupCore(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData)
285 return tr("Core is already configured! Not configuring again...");
287 if (adminUser.isEmpty() || adminPassword.isEmpty()) {
288 return tr("Admin user or password not set.");
290 if (!(_configured = initStorage(backend, setupData, true))) {
291 return tr("Could not setup storage!");
294 saveBackendSettings(backend, setupData);
296 quInfo() << qPrintable(tr("Creating admin user..."));
297 _storage->addUser(adminUser, adminPassword);
298 startListening(); // TODO check when we need this
303 QString Core::setupCoreForInternalUsage()
305 Q_ASSERT(!_storageBackends.isEmpty());
307 qsrand(QDateTime::currentDateTime().toTime_t());
309 for (int i = 0; i < 10; i++) {
311 pass += qrand() % 10;
314 // mono client currently needs sqlite
315 return setupCore("AdminUser", QString::number(pass), "SQLite", QVariantMap());
319 /*** Storage Handling ***/
320 void Core::registerStorageBackends()
322 // Register storage backends here!
323 registerStorageBackend(new SqliteStorage(this));
324 registerStorageBackend(new PostgreSqlStorage(this));
328 bool Core::registerStorageBackend(Storage *backend)
330 if (backend->isAvailable()) {
331 _storageBackends[backend->displayName()] = backend;
335 backend->deleteLater();
341 void Core::unregisterStorageBackends()
343 foreach(Storage *s, _storageBackends.values()) {
346 _storageBackends.clear();
350 void Core::unregisterStorageBackend(Storage *backend)
352 _storageBackends.remove(backend->displayName());
353 backend->deleteLater();
358 // "Type" => "sqlite"
359 bool Core::initStorage(const QString &backend, const QVariantMap &settings, bool setup)
363 if (backend.isEmpty()) {
367 Storage *storage = 0;
368 if (_storageBackends.contains(backend)) {
369 storage = _storageBackends[backend];
372 qCritical() << "Selected storage backend is not available:" << backend;
376 Storage::State storageState = storage->init(settings);
377 switch (storageState) {
378 case Storage::NeedsSetup:
380 return false; // trigger setup process
381 if (storage->setup(settings))
382 return initStorage(backend, settings, false);
383 // if initialization wasn't successful, we quit to keep from coming up unconfigured
384 case Storage::NotAvailable:
385 qCritical() << "FATAL: Selected storage backend is not available:" << backend;
387 case Storage::IsReady:
388 // delete all other backends
389 _storageBackends.remove(backend);
390 unregisterStorageBackends();
391 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
398 void Core::syncStorage()
405 /*** Storage Access ***/
406 bool Core::createNetwork(UserId user, NetworkInfo &info)
408 NetworkId networkId = instance()->_storage->createNetwork(user, info);
409 if (!networkId.isValid())
412 info.networkId = networkId;
417 /*** Network Management ***/
419 bool Core::sslSupported()
422 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
423 return sslServer && sslServer->isCertValid();
430 bool Core::startListening()
432 // in mono mode we only start a local port if a port is specified in the cli call
433 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
436 bool success = false;
437 uint port = Quassel::optionValue("port").toUInt();
439 const QString listen = Quassel::optionValue("listen");
440 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
441 if (listen_list.size() > 0) {
442 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
444 if (!addr.setAddress(listen_term)) {
445 qCritical() << qPrintable(
446 tr("Invalid listen address %1")
451 switch (addr.protocol()) {
452 case QAbstractSocket::IPv6Protocol:
453 if (_v6server.listen(addr, port)) {
454 quInfo() << qPrintable(
455 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
456 .arg(addr.toString())
457 .arg(_v6server.serverPort())
458 .arg(Quassel::buildInfo().protocolVersion)
463 quWarning() << qPrintable(
464 tr("Could not open IPv6 interface %1:%2: %3")
465 .arg(addr.toString())
467 .arg(_v6server.errorString()));
469 case QAbstractSocket::IPv4Protocol:
470 if (_server.listen(addr, port)) {
471 quInfo() << qPrintable(
472 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
473 .arg(addr.toString())
474 .arg(_server.serverPort())
475 .arg(Quassel::buildInfo().protocolVersion)
480 // if v6 succeeded on Any, the port will be already in use - don't display the error then
481 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
482 quWarning() << qPrintable(
483 tr("Could not open IPv4 interface %1:%2: %3")
484 .arg(addr.toString())
486 .arg(_server.errorString()));
490 qCritical() << qPrintable(
491 tr("Invalid listen address %1, unknown network protocol")
500 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
506 void Core::stopListening(const QString &reason)
508 bool wasListening = false;
509 if (_server.isListening()) {
513 if (_v6server.isListening()) {
518 if (reason.isEmpty())
519 quInfo() << "No longer listening for GUI clients.";
521 quInfo() << qPrintable(reason);
526 void Core::incomingConnection()
528 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
530 while (server->hasPendingConnections()) {
531 QTcpSocket *socket = server->nextPendingConnection();
533 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
534 _connectingClients.insert(handler);
536 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
537 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
538 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
540 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
543 stopListening(tr("Closing server for basic setup."));
549 // Potentially called during the initialization phase (before handing the connection off to the session)
550 void Core::clientDisconnected()
552 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
555 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
556 _connectingClients.remove(handler);
557 handler->deleteLater();
559 // make server listen again if still not configured
564 // TODO remove unneeded sessions - if necessary/possible...
565 // Suggestion: kill sessions if they are not connected to any network and client.
569 void Core::setupClientSession(RemotePeer *peer, UserId uid)
571 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
574 // From now on everything is handled by the client session
575 disconnect(handler, 0, this, 0);
576 _connectingClients.remove(handler);
577 handler->deleteLater();
579 // Find or create session for validated user
580 SessionThread *session;
581 if (sessions.contains(uid)) {
582 session = sessions[uid];
585 session = createSession(uid);
587 qWarning() << qPrintable(tr("Could not initialize session for client:")) << qPrintable(peer->description());
594 // as we are currently handling an event triggered by incoming data on this socket
595 // it is unsafe to directly move the socket to the client thread.
596 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
600 void Core::customEvent(QEvent *event)
602 if (event->type() == AddClientEventId) {
603 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
604 addClientHelper(addClientEvent->peer, addClientEvent->userId);
610 void Core::addClientHelper(RemotePeer *peer, UserId uid)
612 // Find or create session for validated user
613 if (!sessions.contains(uid)) {
614 qWarning() << qPrintable(tr("Could not find a session for client:")) << qPrintable(peer->description());
620 SessionThread *session = sessions[uid];
621 session->addClient(peer);
625 void Core::setupInternalClientSession(InternalPeer *clientPeer)
629 setupCoreForInternalUsage();
634 uid = _storage->internalUser();
637 qWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
641 InternalPeer *corePeer = new InternalPeer(this);
642 corePeer->setPeer(clientPeer);
643 clientPeer->setPeer(corePeer);
645 // Find or create session for validated user
646 SessionThread *sessionThread;
647 if (sessions.contains(uid))
648 sessionThread = sessions[uid];
650 sessionThread = createSession(uid);
652 sessionThread->addClient(corePeer);
656 SessionThread *Core::createSession(UserId uid, bool restore)
658 if (sessions.contains(uid)) {
659 qWarning() << "Calling createSession() when a session for the user already exists!";
662 SessionThread *sess = new SessionThread(uid, restore, this);
663 sessions[uid] = sess;
669 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
671 qWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
675 QVariantList Core::backendInfo()
677 QVariantList backends;
678 foreach(const Storage *backend, instance()->_storageBackends.values()) {
680 v["DisplayName"] = backend->displayName();
681 v["Description"] = backend->description();
682 v["SetupKeys"] = backend->setupKeys();
683 v["SetupDefaults"] = backend->setupDefaults();
690 // migration / backend selection
691 bool Core::selectBackend(const QString &backend)
693 // reregister all storage backends
694 registerStorageBackends();
695 if (!_storageBackends.contains(backend)) {
696 qWarning() << qPrintable(QString("Core::selectBackend(): unsupported backend: %1").arg(backend));
697 qWarning() << " supported backends are:" << qPrintable(QStringList(_storageBackends.keys()).join(", "));
701 Storage *storage = _storageBackends[backend];
702 QVariantMap settings = promptForSettings(storage);
704 Storage::State storageState = storage->init(settings);
705 switch (storageState) {
706 case Storage::IsReady:
707 saveBackendSettings(backend, settings);
708 qWarning() << "Switched backend to:" << qPrintable(backend);
709 qWarning() << "Backend already initialized. Skipping Migration";
711 case Storage::NotAvailable:
712 qCritical() << "Backend is not available:" << qPrintable(backend);
714 case Storage::NeedsSetup:
715 if (!storage->setup(settings)) {
716 qWarning() << qPrintable(QString("Core::selectBackend(): unable to setup backend: %1").arg(backend));
720 if (storage->init(settings) != Storage::IsReady) {
721 qWarning() << qPrintable(QString("Core::migrateBackend(): unable to initialize backend: %1").arg(backend));
725 saveBackendSettings(backend, settings);
726 qWarning() << "Switched backend to:" << qPrintable(backend);
730 // let's see if we have a current storage object we can migrate from
731 AbstractSqlMigrationReader *reader = getMigrationReader(_storage);
732 AbstractSqlMigrationWriter *writer = getMigrationWriter(storage);
733 if (reader && writer) {
734 qDebug() << qPrintable(QString("Migrating Storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
739 if (reader->migrateTo(writer)) {
740 qDebug() << "Migration finished!";
741 saveBackendSettings(backend, settings);
745 qWarning() << qPrintable(QString("Core::migrateDb(): unable to migrate storage backend! (No migration writer for %1)").arg(backend));
748 // inform the user why we cannot merge
750 qWarning() << "No currently active backend. Skipping migration.";
753 qWarning() << "Currently active backend does not support migration:" << qPrintable(_storage->displayName());
756 qWarning() << "New backend does not support migration:" << qPrintable(backend);
759 // so we were unable to merge, but let's create a user \o/
766 void Core::createUser()
768 QTextStream out(stdout);
769 QTextStream in(stdin);
770 out << "Add a new user:" << endl;
773 QString username = in.readLine().trimmed();
778 QString password = in.readLine().trimmed();
780 out << "Repeat Password: ";
782 QString password2 = in.readLine().trimmed();
786 if (password != password2) {
787 qWarning() << "Passwords don't match!";
790 if (password.isEmpty()) {
791 qWarning() << "Password is empty!";
795 if (_configured && _storage->addUser(username, password).isValid()) {
796 out << "Added user " << username << " successfully!" << endl;
799 qWarning() << "Unable to add user:" << qPrintable(username);
804 void Core::changeUserPass(const QString &username)
806 QTextStream out(stdout);
807 QTextStream in(stdin);
808 UserId userId = _storage->getUserId(username);
809 if (!userId.isValid()) {
810 out << "User " << username << " does not exist." << endl;
814 out << "Change password for user: " << username << endl;
817 out << "New Password: ";
819 QString password = in.readLine().trimmed();
821 out << "Repeat Password: ";
823 QString password2 = in.readLine().trimmed();
827 if (password != password2) {
828 qWarning() << "Passwords don't match!";
831 if (password.isEmpty()) {
832 qWarning() << "Password is empty!";
836 if (_configured && _storage->updateUser(userId, password)) {
837 out << "Password changed successfully!" << endl;
840 qWarning() << "Failed to change password!";
845 AbstractSqlMigrationReader *Core::getMigrationReader(Storage *storage)
850 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
852 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
856 return sqlStorage->createMigrationReader();
860 AbstractSqlMigrationWriter *Core::getMigrationWriter(Storage *storage)
865 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
867 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
871 return sqlStorage->createMigrationWriter();
875 void Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
877 QVariantMap dbsettings;
878 dbsettings["Backend"] = backend;
879 dbsettings["ConnectionProperties"] = settings;
880 CoreSettings().setStorageSettings(dbsettings);
884 QVariantMap Core::promptForSettings(const Storage *storage)
886 QVariantMap settings;
888 QStringList keys = storage->setupKeys();
892 QTextStream out(stdout);
893 QTextStream in(stdin);
894 out << "Default values are in brackets" << endl;
896 QVariantMap defaults = storage->setupDefaults();
898 foreach(QString key, keys) {
900 if (defaults.contains(key)) {
904 if (!val.toString().isEmpty()) {
905 out << " (" << val.toString() << ")";
910 bool noEcho = QString("password").toLower().startsWith(key.toLower());
914 value = in.readLine().trimmed();
920 if (!value.isEmpty()) {
921 switch (defaults[key].type()) {
923 val = QVariant(value.toInt());
926 val = QVariant(value);
936 void Core::stdInEcho(bool on)
938 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
940 GetConsoleMode(hStdin, &mode);
942 mode |= ENABLE_ECHO_INPUT;
944 mode &= ~ENABLE_ECHO_INPUT;
945 SetConsoleMode(hStdin, mode);
950 void Core::stdInEcho(bool on)
953 tcgetattr(STDIN_FILENO, &t);
958 tcsetattr(STDIN_FILENO, TCSANOW, &t);
962 #endif /* Q_OS_WIN */