1 /***************************************************************************
2 * Copyright (C) 2005-09 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #include <QCoreApplication>
24 #include "coresession.h"
25 #include "coresettings.h"
27 #include "signalproxy.h"
28 #include "sqlitestorage.h"
37 Core *Core::instanceptr = 0;
39 Core *Core::instance() {
40 if(instanceptr) return instanceptr;
41 instanceptr = new Core();
46 void Core::destroy() {
54 _startTime = QDateTime::currentDateTime().toUTC(); // for uptime :)
56 Quassel::loadTranslation(QLocale::system());
58 // FIXME: MIGRATION 0.3 -> 0.4: Move database and core config to new location
59 // Move settings, note this does not delete the old files
61 QSettings newSettings("quassel-irc.org", "quasselcore");
65 QSettings::Format format = QSettings::IniFormat;
67 QSettings::Format format = QSettings::NativeFormat;
69 QString newFilePath = Quassel::configDirPath() + "quasselcore"
70 + ((format == QSettings::NativeFormat) ? QLatin1String(".conf") : QLatin1String(".ini"));
71 QSettings newSettings(newFilePath, format);
74 if(newSettings.value("Config/Version").toUInt() == 0) {
76 QString org = "quassel-irc.org";
78 QString org = "Quassel Project";
80 QSettings oldSettings(org, "Quassel Core");
81 if(oldSettings.allKeys().count()) {
82 qWarning() << "\n\n*** IMPORTANT: Config and data file locations have changed. Attempting to auto-migrate your core settings...";
83 foreach(QString key, oldSettings.allKeys())
84 newSettings.setValue(key, oldSettings.value(key));
85 newSettings.setValue("Config/Version", 1);
86 qWarning() << "* Your core settings have been migrated to" << newSettings.fileName();
88 #ifndef Q_WS_MAC /* we don't need to move the db and cert for mac */
90 QString quasselDir = qgetenv("APPDATA") + "/quassel/";
91 #elif defined Q_WS_MAC
92 QString quasselDir = QDir::homePath() + "/Library/Application Support/Quassel/";
94 QString quasselDir = QDir::homePath() + "/.quassel/";
97 QFileInfo info(Quassel::configDirPath() + "quassel-storage.sqlite");
99 // move database, if we found it
100 QFile oldDb(quasselDir + "quassel-storage.sqlite");
102 bool success = oldDb.rename(Quassel::configDirPath() + "quassel-storage.sqlite");
104 qWarning() << "* Your database has been moved to" << Quassel::configDirPath() + "quassel-storage.sqlite";
106 qWarning() << "!!! Moving your database has failed. Please move it manually into" << Quassel::configDirPath();
110 QFileInfo certInfo(quasselDir + "quasselCert.pem");
111 if(certInfo.exists()) {
112 QFile cert(quasselDir + "quasselCert.pem");
113 bool success = cert.rename(Quassel::configDirPath() + "quasselCert.pem");
115 qWarning() << "* Your certificate has been moved to" << Quassel::configDirPath() + "quasselCert.pem";
117 qWarning() << "!!! Moving your certificate has failed. Please move it manually into" << Quassel::configDirPath();
119 #endif /* !Q_WS_MAC */
120 qWarning() << "*** Migration completed.\n\n";
125 // check settings version
126 // so far, we only have 1
128 if(s.version() != 1) {
129 qCritical() << "Invalid core settings version, terminating!";
133 // Register storage backends here!
134 registerStorageBackend(new SqliteStorage(this));
136 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
137 _storageSyncTimer.start(10 * 60 * 1000); // 10 minutes
142 _configured = initStorage(cs.storageSettings().toMap());
145 if(!_storageBackends.count()) {
146 qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
147 qWarning() << qPrintable(tr("Currently, Quassel only supports SQLite3. You need to build your\n"
148 "Qt library with the sqlite plugin enabled in order for quasselcore\n"
150 exit(1); // TODO make this less brutal (especially for mono client -> popup)
152 qWarning() << "Core is currently not configured! Please connect with a Quassel Client for basic setup.";
155 connect(&_server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
156 connect(&_v6server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
157 if(!startListening()) exit(1); // TODO make this less brutal
161 foreach(QTcpSocket *socket, blocksizes.keys()) {
162 socket->disconnectFromHost(); // disconnect non authed clients
164 qDeleteAll(sessions);
165 qDeleteAll(_storageBackends);
168 /*** Session Restore ***/
170 void Core::saveState() {
173 QVariantList activeSessions;
174 foreach(UserId user, instance()->sessions.keys()) activeSessions << QVariant::fromValue<UserId>(user);
175 state["CoreStateVersion"] = 1;
176 state["ActiveSessions"] = activeSessions;
177 s.setCoreState(state);
180 void Core::restoreState() {
181 if(!instance()->_configured) {
182 // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
185 if(instance()->sessions.count()) {
186 qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
190 /* We don't check, since we are at the first version since switching to Git
191 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
193 qWarning() << qPrintable(tr("Core state too old, ignoring..."));
197 QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
198 if(activeSessions.count() > 0) {
199 quInfo() << "Restoring previous core state...";
200 foreach(QVariant v, activeSessions) {
201 UserId user = v.value<UserId>();
202 instance()->createSession(user, true);
208 QString Core::setupCoreForInternalUsage() {
209 Q_ASSERT(!_storageBackends.isEmpty());
210 QVariantMap setupData;
211 qsrand(QDateTime::currentDateTime().toTime_t());
213 for(int i = 0; i < 10; i++) {
215 pass += qrand() % 10;
217 setupData["AdminUser"] = "AdminUser";
218 setupData["AdminPasswd"] = QString::number(pass);
219 setupData["Backend"] = _storageBackends[_storageBackends.keys().first()]->displayName();
220 return setupCore(setupData);
223 QString Core::setupCore(QVariantMap setupData) {
224 QString user = setupData.take("AdminUser").toString();
225 QString password = setupData.take("AdminPasswd").toString();
226 if(user.isEmpty() || password.isEmpty()) {
227 return tr("Admin user or password not set.");
229 _configured = initStorage(setupData, true);
231 return tr("Could not setup storage!");
234 s.setStorageSettings(setupData);
235 quInfo() << qPrintable(tr("Creating admin user..."));
236 _storage->addUser(user, password);
237 startListening(); // TODO check when we need this
241 /*** Storage Handling ***/
243 bool Core::registerStorageBackend(Storage *backend) {
244 if(backend->isAvailable()) {
245 _storageBackends[backend->displayName()] = backend;
248 backend->deleteLater();
253 void Core::unregisterStorageBackend(Storage *backend) {
254 _storageBackends.remove(backend->displayName());
255 backend->deleteLater();
259 // "Type" => "sqlite"
260 bool Core::initStorage(QVariantMap dbSettings, bool setup) {
263 QString backend = dbSettings["Backend"].toString();
264 if(backend.isEmpty()) {
268 Storage *storage = 0;
269 if(_storageBackends.contains(backend)) {
270 storage = _storageBackends[backend];
272 qCritical() << "Selected storage backend is not available:" << backend;
276 Storage::State storageState = storage->init(dbSettings);
277 switch(storageState) {
278 case Storage::NeedsSetup:
280 return false; // trigger setup process
281 if(storage->setup(dbSettings))
282 return initStorage(dbSettings, false);
283 // if setup wasn't successfull we mark the backend as unavailable
284 case Storage::NotAvailable:
285 qCritical() << "Selected storage backend is not available:" << backend;
286 storage->deleteLater();
287 _storageBackends.remove(backend);
290 case Storage::IsReady:
291 // delete all other backends
292 foreach(Storage *s, _storageBackends.values()) {
293 if(s != storage) s->deleteLater();
295 _storageBackends.clear();
296 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
302 void Core::syncStorage() {
307 /*** Storage Access ***/
308 bool Core::createNetwork(UserId user, NetworkInfo &info) {
309 NetworkId networkId = instance()->_storage->createNetwork(user, info);
310 if(!networkId.isValid())
313 info.networkId = networkId;
317 /*** Network Management ***/
319 bool Core::startListening() {
320 // in mono mode we only start a local port if a port is specified in the cli call
321 if(Quassel::runMode() == Quassel::Monolithic && !Quassel::isOptionSet("port"))
324 bool success = false;
325 uint port = Quassel::optionValue("port").toUInt();
327 const QString listen = Quassel::optionValue("listen");
328 const QStringList listen_list = listen.split(",", QString::SkipEmptyParts);
329 if(listen_list.size() > 0) {
330 foreach (const QString listen_term, listen_list) { // TODO: handle multiple interfaces for same TCP version gracefully
332 if(!addr.setAddress(listen_term)) {
333 qCritical() << qPrintable(
334 tr("Invalid listen address %1")
338 switch(addr.protocol()) {
339 case QAbstractSocket::IPv4Protocol:
340 if(_server.listen(addr, port)) {
341 quInfo() << qPrintable(
342 tr("Listening for GUI clients on IPv4 %1 port %2 using protocol version %3")
343 .arg(addr.toString())
344 .arg(_server.serverPort())
345 .arg(Quassel::buildInfo().protocolVersion)
349 quWarning() << qPrintable(
350 tr("Could not open IPv4 interface %1:%2: %3")
351 .arg(addr.toString())
353 .arg(_server.errorString()));
355 case QAbstractSocket::IPv6Protocol:
356 if(_v6server.listen(addr, port)) {
357 quInfo() << qPrintable(
358 tr("Listening for GUI clients on IPv6 %1 port %2 using protocol version %3")
359 .arg(addr.toString())
360 .arg(_v6server.serverPort())
361 .arg(Quassel::buildInfo().protocolVersion)
365 // if v4 succeeded on Any, the port will be already in use - don't display the error then
366 // FIXME: handle this more sanely, make sure we can listen to both v4 and v6 by default!
367 if(!success || _v6server.serverError() != QAbstractSocket::AddressInUseError)
368 quWarning() << qPrintable(
369 tr("Could not open IPv6 interface %1:%2: %3")
370 .arg(addr.toString())
372 .arg(_v6server.errorString()));
376 qCritical() << qPrintable(
377 tr("Invalid listen address %1, unknown network protocol")
386 quError() << qPrintable(tr("Could not open any network interfaces to listen on!"));
391 void Core::stopListening(const QString &reason) {
392 bool wasListening = false;
393 if(_server.isListening()) {
397 if(_v6server.isListening()) {
403 quInfo() << "No longer listening for GUI clients.";
405 quInfo() << qPrintable(reason);
409 void Core::incomingConnection() {
410 QTcpServer *server = qobject_cast<QTcpServer *>(sender());
412 while(server->hasPendingConnections()) {
413 QTcpSocket *socket = server->nextPendingConnection();
414 connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
415 connect(socket, SIGNAL(readyRead()), this, SLOT(clientHasData()));
416 connect(socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
418 QVariantMap clientInfo;
419 blocksizes.insert(socket, (quint32)0);
420 quInfo() << qPrintable(tr("Client connected from")) << qPrintable(socket->peerAddress().toString());
423 stopListening(tr("Closing server for basic setup."));
428 void Core::clientHasData() {
429 QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());
430 Q_ASSERT(socket && blocksizes.contains(socket));
432 while(SignalProxy::readDataFromDevice(socket, blocksizes[socket], item)) {
433 QVariantMap msg = item.toMap();
434 processClientMessage(socket, msg);
435 if(!blocksizes.contains(socket)) break; // this socket is no longer ours to handle!
439 void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
440 if(!msg.contains("MsgType")) {
441 // Client is way too old, does not even use the current init format
442 qWarning() << qPrintable(tr("Antique client trying to connect... refusing."));
446 // OK, so we have at least an init message format we can understand
447 if(msg["MsgType"] == "ClientInit") {
450 // Just version information -- check it!
451 uint ver = msg["ProtocolVersion"].toUInt();
452 if(ver < Quassel::buildInfo().coreNeedsProtocol) {
453 reply["MsgType"] = "ClientInitReject";
454 reply["Error"] = tr("<b>Your Quassel Client is too old!</b><br>"
455 "This core needs at least client/core protocol version %1.<br>"
456 "Please consider upgrading your client.").arg(Quassel::buildInfo().coreNeedsProtocol);
457 SignalProxy::writeDataToDevice(socket, reply);
458 qWarning() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("too old, rejecting."));
459 socket->close(); return;
462 reply["CoreVersion"] = Quassel::buildInfo().fancyVersionString;
463 reply["CoreDate"] = Quassel::buildInfo().buildDate;
464 reply["ProtocolVersion"] = Quassel::buildInfo().protocolVersion;
465 // TODO: Make the core info configurable
466 int uptime = startTime().secsTo(QDateTime::currentDateTime().toUTC());
467 int updays = uptime / 86400; uptime %= 86400;
468 int uphours = uptime / 3600; uptime %= 3600;
469 int upmins = uptime / 60;
470 reply["CoreInfo"] = tr("<b>Quassel Core Version %1</b><br>"
472 "Up %3d%4h%5m (since %6)").arg(Quassel::buildInfo().fancyVersionString)
473 .arg(Quassel::buildInfo().buildDate)
474 .arg(updays).arg(uphours,2,10,QChar('0')).arg(upmins,2,10,QChar('0')).arg(startTime().toString(Qt::TextDate));
477 SslServer *sslServer = qobject_cast<SslServer *>(&_server);
478 QSslSocket *sslSocket = qobject_cast<QSslSocket *>(socket);
479 bool supportSsl = (bool)sslServer && (bool)sslSocket && sslServer->isCertValid();
481 bool supportSsl = false;
484 #ifndef QT_NO_COMPRESS
485 bool supportsCompression = true;
487 bool supportsCompression = false;
490 reply["SupportSsl"] = supportSsl;
491 reply["SupportsCompression"] = supportsCompression;
492 // switch to ssl/compression after client has been informed about our capabilities (see below)
494 reply["LoginEnabled"] = true;
496 // check if we are configured, start wizard otherwise
498 reply["Configured"] = false;
499 QList<QVariant> backends;
500 foreach(Storage *backend, _storageBackends.values()) {
502 v["DisplayName"] = backend->displayName();
503 v["Description"] = backend->description();
506 reply["StorageBackends"] = backends;
507 reply["LoginEnabled"] = false;
509 reply["Configured"] = true;
511 clientInfo[socket] = msg; // store for future reference
512 reply["MsgType"] = "ClientInitAck";
513 SignalProxy::writeDataToDevice(socket, reply);
516 // after we told the client that we are ssl capable we switch to ssl mode
517 if(supportSsl && msg["UseSsl"].toBool()) {
518 qDebug() << qPrintable(tr("Starting TLS for Client:")) << qPrintable(socket->peerAddress().toString());
519 connect(sslSocket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
520 sslSocket->startServerEncryption();
524 #ifndef QT_NO_COMPRESS
525 if(supportsCompression && msg["UseCompression"].toBool()) {
526 socket->setProperty("UseCompression", true);
527 qDebug() << "Using compression for Client:" << qPrintable(socket->peerAddress().toString());
532 // for the rest, we need an initialized connection
533 if(!clientInfo.contains(socket)) {
535 reply["MsgType"] = "ClientLoginReject";
536 reply["Error"] = tr("<b>Client not initialized!</b><br>You need to send an init message before trying to login.");
537 SignalProxy::writeDataToDevice(socket, reply);
538 qWarning() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("did not send an init message before trying to login, rejecting."));
539 socket->close(); return;
541 if(msg["MsgType"] == "CoreSetupData") {
543 QString result = setupCore(msg["SetupData"].toMap());
544 if(!result.isEmpty()) {
545 reply["MsgType"] = "CoreSetupReject";
546 reply["Error"] = result;
548 reply["MsgType"] = "CoreSetupAck";
550 SignalProxy::writeDataToDevice(socket, reply);
551 } else if(msg["MsgType"] == "ClientLogin") {
553 UserId uid = _storage->validateUser(msg["User"].toString(), msg["Password"].toString());
555 reply["MsgType"] = "ClientLoginReject";
556 reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
557 SignalProxy::writeDataToDevice(socket, reply);
560 reply["MsgType"] = "ClientLoginAck";
561 SignalProxy::writeDataToDevice(socket, reply);
562 quInfo() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("initialized and authenticated successfully as \"%1\" (UserId: %2).").arg(msg["User"].toString()).arg(uid.toInt()));
563 setupClientSession(socket, uid);
568 // Potentially called during the initialization phase (before handing the connection off to the session)
569 void Core::clientDisconnected() {
570 QTcpSocket *socket = qobject_cast<QTcpSocket *>(sender());
572 // here it's safe to call methods on socket!
573 quInfo() << qPrintable(tr("Non-authed client disconnected.")) << qPrintable(socket->peerAddress().toString());
574 blocksizes.remove(socket);
575 clientInfo.remove(socket);
576 socket->deleteLater();
578 // we have to crawl through the hashes and see if we find a victim to remove
579 qDebug() << qPrintable(tr("Non-authed client disconnected. (socket allready destroyed)"));
581 // DO NOT CALL ANY METHODS ON socket!!
582 socket = static_cast<QTcpSocket *>(sender());
584 QHash<QTcpSocket *, quint32>::iterator blockSizeIter = blocksizes.begin();
585 while(blockSizeIter != blocksizes.end()) {
586 if(blockSizeIter.key() == socket) {
587 blockSizeIter = blocksizes.erase(blockSizeIter);
593 QHash<QTcpSocket *, QVariantMap>::iterator clientInfoIter = clientInfo.begin();
594 while(clientInfoIter != clientInfo.end()) {
595 if(clientInfoIter.key() == socket) {
596 clientInfoIter = clientInfo.erase(clientInfoIter);
604 // make server listen again if still not configured
609 // TODO remove unneeded sessions - if necessary/possible...
610 // Suggestion: kill sessions if they are not connected to any network and client.
613 void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
614 // Find or create session for validated user
616 if(sessions.contains(uid)) sess = sessions[uid];
617 else sess = createSession(uid);
618 // Hand over socket, session then sends state itself
619 disconnect(socket, 0, this, 0);
620 blocksizes.remove(socket);
621 clientInfo.remove(socket);
623 qWarning() << qPrintable(tr("Could not initialize session for client:")) << qPrintable(socket->peerAddress().toString());
626 sess->addClient(socket);
629 void Core::setupInternalClientSession(SignalProxy *proxy) {
632 setupCoreForInternalUsage();
635 UserId uid = _storage->internalUser();
637 // Find or create session for validated user
639 if(sessions.contains(uid))
640 sess = sessions[uid];
642 sess = createSession(uid);
643 sess->addClient(proxy);
646 SessionThread *Core::createSession(UserId uid, bool restore) {
647 if(sessions.contains(uid)) {
648 qWarning() << "Calling createSession() when a session for the user already exists!";
651 SessionThread *sess = new SessionThread(uid, restore, this);
652 sessions[uid] = sess;
658 void Core::sslErrors(const QList<QSslError> &errors) {
660 QSslSocket *socket = qobject_cast<QSslSocket *>(sender());
662 socket->ignoreSslErrors();
666 void Core::socketError(QAbstractSocket::SocketError err) {
667 QAbstractSocket *socket = qobject_cast<QAbstractSocket *>(sender());
668 if(socket && err != QAbstractSocket::RemoteHostClosedError)
669 qWarning() << "Core::socketError()" << socket << err << socket->errorString();