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"
42 #endif /* Q_OS_WIN32 */
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_WS_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_WS_MAC /* we don't need to move the db and cert for mac */
127 QString quasselDir = qgetenv("APPDATA") + "/quassel/";
128 #elif defined Q_WS_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_WS_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 setup wasn't successfull we mark the backend as unavailable
384 case Storage::NotAvailable:
385 qCritical() << "Selected storage backend is not available:" << backend;
386 storage->deleteLater();
387 _storageBackends.remove(backend);
390 case Storage::IsReady:
391 // delete all other backends
392 _storageBackends.remove(backend);
393 unregisterStorageBackends();
394 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
401 void Core::syncStorage()
408 /*** Storage Access ***/
409 bool Core::createNetwork(UserId user, NetworkInfo &info)
411 NetworkId networkId = instance()->_storage->createNetwork(user, info);
412 if (!networkId.isValid())
415 info.networkId = networkId;
420 /*** Network Management ***/
422 bool Core::sslSupported()
425 SslServer *sslServer = qobject_cast<SslServer *>(&instance()->_server);
426 return sslServer && sslServer->isCertValid();
433 bool Core::startListening()
435 // in mono mode we only start a local port if a port is specified in the cli call
436 if (Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
439 bool success = false;
440 uint port = Quassel::optionValue("port").toUInt();
442 const QString listen = Quassel::optionValue("listen");
443 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
444 if (listen_list.size() > 0) {
445 foreach(const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
447 if (!addr.setAddress(listen_term)) {
448 qCritical() << qPrintable(
449 tr("Invalid listen address %1")
454 switch (addr.protocol()) {
455 case QAbstractSocket::IPv6Protocol:
456 if (_v6server.listen(addr, port)) {
457 quInfo() << qPrintable(
458 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
459 .arg(addr.toString())
460 .arg(_v6server.serverPort())
461 .arg(Quassel::buildInfo().protocolVersion)
466 quWarning() << qPrintable(
467 tr("Could not open IPv6 interface %1:%2: %3")
468 .arg(addr.toString())
470 .arg(_v6server.errorString()));
472 case QAbstractSocket::IPv4Protocol:
473 if (_server.listen(addr, port)) {
474 quInfo() << qPrintable(
475 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
476 .arg(addr.toString())
477 .arg(_server.serverPort())
478 .arg(Quassel::buildInfo().protocolVersion)
483 // if v6 succeeded on Any, the port will be already in use - don't display the error then
484 if (!success || _server.serverError() != QAbstractSocket::AddressInUseError)
485 quWarning() << qPrintable(
486 tr("Could not open IPv4 interface %1:%2: %3")
487 .arg(addr.toString())
489 .arg(_server.errorString()));
493 qCritical() << qPrintable(
494 tr("Invalid listen address %1, unknown network protocol")
503 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
509 void Core::stopListening(const QString &reason)
511 bool wasListening = false;
512 if (_server.isListening()) {
516 if (_v6server.isListening()) {
521 if (reason.isEmpty())
522 quInfo() << "No longer listening for GUI clients.";
524 quInfo() << qPrintable(reason);
529 void Core::incomingConnection()
531 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
533 while (server->hasPendingConnections()) {
534 QTcpSocket *socket = server->nextPendingConnection();
536 CoreAuthHandler *handler = new CoreAuthHandler(socket, this);
537 _connectingClients.insert(handler);
539 connect(handler, SIGNAL(disconnected()), SLOT(clientDisconnected()));
540 connect(handler, SIGNAL(socketError(QAbstractSocket::SocketError,QString)), SLOT(socketError(QAbstractSocket::SocketError,QString)));
541 connect(handler, SIGNAL(handshakeComplete(RemotePeer*,UserId)), SLOT(setupClientSession(RemotePeer*,UserId)));
543 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
546 stopListening(tr("Closing server for basic setup."));
552 // Potentially called during the initialization phase (before handing the connection off to the session)
553 void Core::clientDisconnected()
555 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
558 quInfo() << qPrintable(tr("Non-authed client disconnected:")) << qPrintable(handler->socket()->peerAddress().toString());
559 _connectingClients.remove(handler);
560 handler->deleteLater();
562 // make server listen again if still not configured
567 // TODO remove unneeded sessions - if necessary/possible...
568 // Suggestion: kill sessions if they are not connected to any network and client.
572 void Core::setupClientSession(RemotePeer *peer, UserId uid)
574 CoreAuthHandler *handler = qobject_cast<CoreAuthHandler *>(sender());
577 // From now on everything is handled by the client session
578 disconnect(handler, 0, this, 0);
579 _connectingClients.remove(handler);
580 handler->deleteLater();
582 // Find or create session for validated user
583 SessionThread *session;
584 if (sessions.contains(uid)) {
585 session = sessions[uid];
588 session = createSession(uid);
590 qWarning() << qPrintable(tr("Could not initialize session for client:")) << qPrintable(peer->description());
597 // as we are currently handling an event triggered by incoming data on this socket
598 // it is unsafe to directly move the socket to the client thread.
599 QCoreApplication::postEvent(this, new AddClientEvent(peer, uid));
603 void Core::customEvent(QEvent *event)
605 if (event->type() == AddClientEventId) {
606 AddClientEvent *addClientEvent = static_cast<AddClientEvent *>(event);
607 addClientHelper(addClientEvent->peer, addClientEvent->userId);
613 void Core::addClientHelper(RemotePeer *peer, UserId uid)
615 // Find or create session for validated user
616 if (!sessions.contains(uid)) {
617 qWarning() << qPrintable(tr("Could not find a session for client:")) << qPrintable(peer->description());
623 SessionThread *session = sessions[uid];
624 session->addClient(peer);
628 void Core::setupInternalClientSession(InternalPeer *clientPeer)
632 setupCoreForInternalUsage();
637 uid = _storage->internalUser();
640 qWarning() << "Core::setupInternalClientSession(): You're trying to run monolithic Quassel with an unusable Backend! Go fix it!";
644 InternalPeer *corePeer = new InternalPeer(this);
645 corePeer->setPeer(clientPeer);
646 clientPeer->setPeer(corePeer);
648 // Find or create session for validated user
649 SessionThread *sessionThread;
650 if (sessions.contains(uid))
651 sessionThread = sessions[uid];
653 sessionThread = createSession(uid);
655 sessionThread->addClient(corePeer);
659 SessionThread *Core::createSession(UserId uid, bool restore)
661 if (sessions.contains(uid)) {
662 qWarning() << "Calling createSession() when a session for the user already exists!";
665 SessionThread *sess = new SessionThread(uid, restore, this);
666 sessions[uid] = sess;
672 void Core::socketError(QAbstractSocket::SocketError err, const QString &errorString)
674 qWarning() << QString("Socket error %1: %2").arg(err).arg(errorString);
678 QVariantList Core::backendInfo()
680 QVariantList backends;
681 foreach(const Storage *backend, instance()->_storageBackends.values()) {
683 v["DisplayName"] = backend->displayName();
684 v["Description"] = backend->description();
685 v["SetupKeys"] = backend->setupKeys();
686 v["SetupDefaults"] = backend->setupDefaults();
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 saveBackendSettings(backend, settings);
711 qWarning() << "Switched backend to:" << qPrintable(backend);
712 qWarning() << "Backend already initialized. Skipping Migration";
714 case Storage::NotAvailable:
715 qCritical() << "Backend is not available:" << qPrintable(backend);
717 case Storage::NeedsSetup:
718 if (!storage->setup(settings)) {
719 qWarning() << qPrintable(QString("Core::selectBackend(): unable to setup backend: %1").arg(backend));
723 if (storage->init(settings) != Storage::IsReady) {
724 qWarning() << qPrintable(QString("Core::migrateBackend(): unable to initialize backend: %1").arg(backend));
728 saveBackendSettings(backend, settings);
729 qWarning() << "Switched backend to:" << qPrintable(backend);
733 // let's see if we have a current storage object we can migrate from
734 AbstractSqlMigrationReader *reader = getMigrationReader(_storage);
735 AbstractSqlMigrationWriter *writer = getMigrationWriter(storage);
736 if (reader && writer) {
737 qDebug() << qPrintable(QString("Migrating Storage backend %1 to %2...").arg(_storage->displayName(), storage->displayName()));
742 if (reader->migrateTo(writer)) {
743 qDebug() << "Migration finished!";
744 saveBackendSettings(backend, settings);
748 qWarning() << qPrintable(QString("Core::migrateDb(): unable to migrate storage backend! (No migration writer for %1)").arg(backend));
751 // inform the user why we cannot merge
753 qWarning() << "No currently active backend. Skipping migration.";
756 qWarning() << "Currently active backend does not support migration:" << qPrintable(_storage->displayName());
759 qWarning() << "New backend does not support migration:" << qPrintable(backend);
762 // so we were unable to merge, but let's create a user \o/
769 void Core::createUser()
771 QTextStream out(stdout);
772 QTextStream in(stdin);
773 out << "Add a new user:" << endl;
776 QString username = in.readLine().trimmed();
781 QString password = in.readLine().trimmed();
783 out << "Repeat Password: ";
785 QString password2 = in.readLine().trimmed();
789 if (password != password2) {
790 qWarning() << "Passwords don't match!";
793 if (password.isEmpty()) {
794 qWarning() << "Password is empty!";
798 if (_configured && _storage->addUser(username, password).isValid()) {
799 out << "Added user " << username << " successfully!" << endl;
802 qWarning() << "Unable to add user:" << qPrintable(username);
807 void Core::changeUserPass(const QString &username)
809 QTextStream out(stdout);
810 QTextStream in(stdin);
811 UserId userId = _storage->getUserId(username);
812 if (!userId.isValid()) {
813 out << "User " << username << " does not exist." << endl;
817 out << "Change password for user: " << username << endl;
820 out << "New Password: ";
822 QString password = in.readLine().trimmed();
824 out << "Repeat Password: ";
826 QString password2 = in.readLine().trimmed();
830 if (password != password2) {
831 qWarning() << "Passwords don't match!";
834 if (password.isEmpty()) {
835 qWarning() << "Password is empty!";
839 if (_configured && _storage->updateUser(userId, password)) {
840 out << "Password changed successfully!" << endl;
843 qWarning() << "Failed to change password!";
848 AbstractSqlMigrationReader *Core::getMigrationReader(Storage *storage)
853 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
855 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
859 return sqlStorage->createMigrationReader();
863 AbstractSqlMigrationWriter *Core::getMigrationWriter(Storage *storage)
868 AbstractSqlStorage *sqlStorage = qobject_cast<AbstractSqlStorage *>(storage);
870 qDebug() << "Core::migrateDb(): only SQL based backends can be migrated!";
874 return sqlStorage->createMigrationWriter();
878 void Core::saveBackendSettings(const QString &backend, const QVariantMap &settings)
880 QVariantMap dbsettings;
881 dbsettings["Backend"] = backend;
882 dbsettings["ConnectionProperties"] = settings;
883 CoreSettings().setStorageSettings(dbsettings);
887 QVariantMap Core::promptForSettings(const Storage *storage)
889 QVariantMap settings;
891 QStringList keys = storage->setupKeys();
895 QTextStream out(stdout);
896 QTextStream in(stdin);
897 out << "Default values are in brackets" << endl;
899 QVariantMap defaults = storage->setupDefaults();
901 foreach(QString key, keys) {
903 if (defaults.contains(key)) {
907 if (!val.toString().isEmpty()) {
908 out << " (" << val.toString() << ")";
913 bool noEcho = QString("password").toLower().startsWith(key.toLower());
917 value = in.readLine().trimmed();
923 if (!value.isEmpty()) {
924 switch (defaults[key].type()) {
926 val = QVariant(value.toInt());
929 val = QVariant(value);
939 void Core::stdInEcho(bool on)
941 HANDLE hStdin = GetStdHandle(STD_INPUT_HANDLE);
943 GetConsoleMode(hStdin, &mode);
945 mode |= ENABLE_ECHO_INPUT;
947 mode &= ~ENABLE_ECHO_INPUT;
948 SetConsoleMode(hStdin, mode);
953 void Core::stdInEcho(bool on)
956 tcgetattr(STDIN_FILENO, &t);
961 tcsetattr(STDIN_FILENO, TCSANOW, &t);
965 #endif /* Q_OS_WIN32 */