1 /***************************************************************************
2 * Copyright (C) 2005-08 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 <QMetaObject>
22 #include <QMetaMethod>
23 #include <QMutexLocker>
24 #include <QCoreApplication>
27 #include "coresession.h"
28 #include "coresettings.h"
29 #include "signalproxy.h"
30 #include "sqlitestorage.h"
35 Core *Core::instanceptr = 0;
38 Core *Core::instance() {
39 if(instanceptr) return instanceptr;
40 instanceptr = new Core();
45 void Core::destroy() {
50 Core::Core() : storage(0) {
51 startTime = QDateTime::currentDateTime(); // for uptime :)
53 // Register storage backends here!
54 registerStorageBackend(new SqliteStorage(this));
56 if(!_storageBackends.count()) {
57 qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
58 exit(1); // TODO make this less brutal (especially for mono client -> popup)
60 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
61 _storageSyncTimer.start(10 * 60 * 1000); // in msecs
69 if(!(configured = initStorage(cs.storageSettings().toMap()))) {
70 qWarning("Core is currently not configured! Please connect with a Quassel Client for basic setup.");
72 // try to migrate old settings
73 QVariantMap old = cs.oldDbSettings().toMap();
74 if(old.count() && old["Type"].toString().toUpper() == "SQLITE") {
75 QVariantMap newSettings;
76 newSettings["Backend"] = "SQLite";
77 if((configured = initStorage(newSettings))) {
78 qWarning("...but thankfully I found some old settings to migrate!");
79 cs.setStorageSettings(newSettings);
84 connect(&server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
85 if(!startListening(cs.port())) exit(1); // TODO make this less brutal
89 foreach(QTcpSocket *socket, blocksizes.keys()) { qDebug() << "disconnecting" << socket << blocksizes.keys();
90 socket->disconnectFromHost(); // disconnect local (i.e. non-authed) clients
93 qDeleteAll(_storageBackends);
96 /*** Session Restore ***/
98 void Core::saveState() {
101 QVariantList activeSessions;
102 foreach(UserId user, instance()->sessions.keys()) activeSessions << QVariant::fromValue<UserId>(user);
103 state["CoreStateVersion"] = 1;
104 state["ActiveSessions"] = activeSessions;
105 s.setCoreState(state);
108 void Core::restoreState() {
109 if(!instance()->configured) {
110 // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
113 if(instance()->sessions.count()) {
114 qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
118 /* We don't check, since we are at the first version since switching to Git
119 uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
121 qWarning() << qPrintable(tr("Core state too old, ignoring..."));
125 QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
126 if(activeSessions.count() > 0) {
127 qDebug() << "Restoring previous core state...";
128 foreach(QVariant v, activeSessions) {
129 UserId user = v.value<UserId>();
130 instance()->createSession(user, true);
137 QString Core::setupCore(const QVariant &setupData_) {
138 QVariantMap setupData = setupData_.toMap();
139 QString user = setupData.take("AdminUser").toString();
140 QString password = setupData.take("AdminPasswd").toString();
141 if(user.isEmpty() || password.isEmpty()) {
142 return tr("Admin user or password not set.");
144 if(!initStorage(setupData, true)) {
145 return tr("Could not setup storage!");
148 s.setStorageSettings(setupData);
149 qDebug() << qPrintable(tr("Creating admin user..."));
151 storage->addUser(user, password);
153 startListening(); // TODO check when we need this
157 /*** Storage Handling ***/
159 bool Core::registerStorageBackend(Storage *backend) {
160 if(backend->isAvailable()) {
161 _storageBackends[backend->displayName()] = backend;
164 backend->deleteLater();
169 void Core::unregisterStorageBackend(Storage *backend) {
170 _storageBackends.remove(backend->displayName());
171 backend->deleteLater();
175 // "Type" => "sqlite"
176 bool Core::initStorage(QVariantMap dbSettings, bool setup) {
177 QString backend = dbSettings["Backend"].toString();
178 if(backend.isEmpty()) {
179 //qWarning() << "No storage backend selected!";
180 return configured = false;
183 if(_storageBackends.contains(backend)) {
184 storage = _storageBackends[backend];
186 qWarning() << "Selected storage backend is not available:" << backend;
187 return configured = false;
189 if(!storage->init(dbSettings)) {
190 if(!setup || !(storage->setup(dbSettings) && storage->init(dbSettings))) {
191 qWarning() << "Could not init storage!";
193 return configured = false;
196 // delete all other backends
197 foreach(Storage *s, _storageBackends.values()) {
198 if(s != storage) s->deleteLater();
200 _storageBackends.clear();
202 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
203 return configured = true;
206 void Core::syncStorage() {
207 QMutexLocker locker(&mutex);
208 if(storage) storage->sync();
211 /*** Storage Access ***/
212 void Core::setUserSetting(UserId userId, const QString &settingName, const QVariant &data) {
213 QMutexLocker locker(&mutex);
214 instance()->storage->setUserSetting(userId, settingName, data);
217 QVariant Core::getUserSetting(UserId userId, const QString &settingName, const QVariant &data) {
218 QMutexLocker locker(&mutex);
219 return instance()->storage->getUserSetting(userId, settingName, data);
222 bool Core::createNetwork(UserId user, NetworkInfo &info) {
223 QMutexLocker locker(&mutex);
224 NetworkId networkId = instance()->storage->createNetwork(user, info);
225 if(!networkId.isValid())
228 info.networkId = networkId;
232 bool Core::updateNetwork(UserId user, const NetworkInfo &info) {
233 QMutexLocker locker(&mutex);
234 return instance()->storage->updateNetwork(user, info);
237 bool Core::removeNetwork(UserId user, const NetworkId &networkId) {
238 QMutexLocker locker(&mutex);
239 return instance()->storage->removeNetwork(user, networkId);
242 QList<NetworkInfo> Core::networks(UserId user) {
243 QMutexLocker locker(&mutex);
244 return instance()->storage->networks(user);
247 NetworkId Core::networkId(UserId user, const QString &network) {
248 QMutexLocker locker(&mutex);
249 return instance()->storage->getNetworkId(user, network);
252 QList<NetworkId> Core::connectedNetworks(UserId user) {
253 QMutexLocker locker(&mutex);
254 return instance()->storage->connectedNetworks(user);
257 void Core::setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) {
258 QMutexLocker locker(&mutex);
259 return instance()->storage->setNetworkConnected(user, networkId, isConnected);
262 QHash<QString, QString> Core::persistentChannels(UserId user, const NetworkId &networkId) {
263 QMutexLocker locker(&mutex);
264 return instance()->storage->persistentChannels(user, networkId);
267 void Core::setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) {
268 QMutexLocker locker(&mutex);
269 return instance()->storage->setChannelPersistent(user, networkId, channel, isJoined);
272 void Core::setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) {
273 QMutexLocker locker(&mutex);
274 return instance()->storage->setPersistentChannelKey(user, networkId, channel, key);
277 BufferInfo Core::bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
278 QMutexLocker locker(&mutex);
279 return instance()->storage->getBufferInfo(user, networkId, type, buffer);
282 BufferInfo Core::getBufferInfo(UserId user, const BufferId &bufferId) {
283 QMutexLocker locker(&mutex);
284 return instance()->storage->getBufferInfo(user, bufferId);
287 MsgId Core::storeMessage(const Message &message) {
288 QMutexLocker locker(&mutex);
289 return instance()->storage->logMessage(message);
292 QList<Message> Core::requestMsgs(UserId user, BufferId buffer, int lastmsgs, int offset) {
293 QMutexLocker locker(&mutex);
294 return instance()->storage->requestMsgs(user, buffer, lastmsgs, offset);
297 QList<Message> Core::requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset) {
298 QMutexLocker locker(&mutex);
299 return instance()->storage->requestMsgs(user, buffer, since, offset);
302 QList<Message> Core::requestMsgRange(UserId user, BufferId buffer, int first, int last) {
303 QMutexLocker locker(&mutex);
304 return instance()->storage->requestMsgRange(user, buffer, first, last);
307 QList<BufferInfo> Core::requestBuffers(UserId user) {
308 QMutexLocker locker(&mutex);
309 return instance()->storage->requestBuffers(user);
312 QList<BufferId> Core::requestBufferIdsForNetwork(UserId user, NetworkId networkId) {
313 QMutexLocker locker(&mutex);
314 return instance()->storage->requestBufferIdsForNetwork(user, networkId);
317 bool Core::removeBuffer(const UserId &user, const BufferId &bufferId) {
318 QMutexLocker locker(&mutex);
319 return instance()->storage->removeBuffer(user, bufferId);
322 BufferId Core::renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) {
323 QMutexLocker locker(&mutex);
324 return instance()->storage->renameBuffer(user, networkId, newName, oldName);
327 void Core::setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) {
328 QMutexLocker locker(&mutex);
329 return instance()->storage->setBufferLastSeenMsg(user, bufferId, msgId);
332 QHash<BufferId, MsgId> Core::bufferLastSeenMsgIds(UserId user) {
333 QMutexLocker locker(&mutex);
334 return instance()->storage->bufferLastSeenMsgIds(user);
337 /*** Network Management ***/
339 bool Core::startListening(uint port) {
340 if(!server.listen(QHostAddress::Any, port)) {
341 qWarning("%s", qPrintable(QString("Could not open GUI client port %1: %2").arg(port).arg(server.errorString())));
344 qDebug() << "Listening for GUI clients on port" << server.serverPort();
348 void Core::stopListening() {
350 qDebug() << "No longer listening for GUI clients.";
353 void Core::incomingConnection() {
354 while(server.hasPendingConnections()) {
355 QTcpSocket *socket = server.nextPendingConnection();
356 connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
357 connect(socket, SIGNAL(readyRead()), this, SLOT(clientHasData()));
358 connect(socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
360 QVariantMap clientInfo;
361 blocksizes.insert(socket, (quint32)0);
362 qDebug() << "Client connected from" << qPrintable(socket->peerAddress().toString());
366 qDebug() << "Closing server for basic setup.";
371 void Core::clientHasData() {
372 QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());
373 Q_ASSERT(socket && blocksizes.contains(socket));
375 while(SignalProxy::readDataFromDevice(socket, blocksizes[socket], item)) {
376 QVariantMap msg = item.toMap();
377 processClientMessage(socket, msg);
378 if(!blocksizes.contains(socket)) break; // this socket is no longer ours to handle!
382 void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
383 if(!msg.contains("MsgType")) {
384 // Client is way too old, does not even use the current init format
385 qWarning() << qPrintable(tr("Antique client trying to connect... refusing."));
389 // OK, so we have at least an init message format we can understand
390 if(msg["MsgType"] == "ClientInit") {
393 // Just version information -- check it!
394 if((msg.contains("ClientBuild") && msg["ClientBuild"].toUInt() < 732)
395 || (!msg.contains("ClientBuild") && msg["ProtocolVersion"].toUInt() < Global::coreNeedsProtocol)) {
396 reply["MsgType"] = "ClientInitReject";
397 reply["Error"] = tr("<b>Your Quassel Client is too old!</b><br>"
398 "This core needs at least client/core protocol version %1.<br>"
399 "Please consider upgrading your client.").arg(Global::coreNeedsProtocol);
400 SignalProxy::writeDataToDevice(socket, reply);
401 qWarning() << qPrintable(tr("Client %1 too old, rejecting.").arg(socket->peerAddress().toString()));
402 socket->close(); return;
405 reply["CoreVersion"] = Global::quasselVersion;
406 reply["CoreDate"] = Global::quasselBuildDate;
407 reply["CoreBuild"] = 860; // FIXME legacy
408 reply["ProtocolVersion"] = Global::protocolVersion;
409 // TODO: Make the core info configurable
410 int uptime = startTime.secsTo(QDateTime::currentDateTime());
411 int updays = uptime / 86400; uptime %= 86400;
412 int uphours = uptime / 3600; uptime %= 3600;
413 int upmins = uptime / 60;
414 reply["CoreInfo"] = tr("<b>Quassel Core Version %1</b><br>"
416 "Up %3d%4h%5m (since %6)").arg(Global::quasselVersion).arg(Global::quasselBuildDate)
417 .arg(updays).arg(uphours,2,10,QChar('0')).arg(upmins,2,10,QChar('0')).arg(startTime.toString(Qt::TextDate));
419 #ifndef QT_NO_OPENSSL
420 SslServer *sslServer = qobject_cast<SslServer *>(&server);
421 QSslSocket *sslSocket = qobject_cast<QSslSocket *>(socket);
422 bool supportSsl = (bool)sslServer && (bool)sslSocket && sslServer->certIsValid();
424 bool supportSsl = false;
427 reply["SupportSsl"] = supportSsl;
428 // switch to ssl after client has been informed about our capabilities (see below)
430 reply["LoginEnabled"] = true;
432 // check if we are configured, start wizard otherwise
434 reply["Configured"] = false;
435 QList<QVariant> backends;
436 foreach(Storage *backend, _storageBackends.values()) {
438 v["DisplayName"] = backend->displayName();
439 v["Description"] = backend->description();
442 reply["StorageBackends"] = backends;
443 reply["LoginEnabled"] = false;
445 reply["Configured"] = true;
447 clientInfo[socket] = msg; // store for future reference
448 reply["MsgType"] = "ClientInitAck";
449 SignalProxy::writeDataToDevice(socket, reply);
451 #ifndef QT_NO_OPENSSL
452 // after we told the client that we are ssl capable we switch to ssl mode
453 if(supportSsl && msg["UseSsl"].toBool()) {
454 qDebug() << "Starting TLS for Client:" << qPrintable(socket->peerAddress().toString());
455 connect(sslSocket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
456 sslSocket->startServerEncryption();
461 // for the rest, we need an initialized connection
462 if(!clientInfo.contains(socket)) {
464 reply["MsgType"] = "ClientLoginReject";
465 reply["Error"] = tr("<b>Client not initialized!</b><br>You need to send an init message before trying to login.");
466 SignalProxy::writeDataToDevice(socket, reply);
467 qWarning() << qPrintable(tr("Client %1 did not send an init message before trying to login, rejecting.").arg(socket->peerAddress().toString()));
468 socket->close(); return;
470 if(msg["MsgType"] == "CoreSetupData") {
472 QString result = setupCore(msg["SetupData"]);
473 if(!result.isEmpty()) {
474 reply["MsgType"] = "CoreSetupReject";
475 reply["Error"] = result;
477 reply["MsgType"] = "CoreSetupAck";
479 SignalProxy::writeDataToDevice(socket, reply);
480 } else if(msg["MsgType"] == "ClientLogin") {
483 UserId uid = storage->validateUser(msg["User"].toString(), msg["Password"].toString());
486 reply["MsgType"] = "ClientLoginReject";
487 reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
488 SignalProxy::writeDataToDevice(socket, reply);
491 reply["MsgType"] = "ClientLoginAck";
492 SignalProxy::writeDataToDevice(socket, reply);
493 qDebug() << qPrintable(tr("Client %1 initialized and authenticated successfully as \"%2\" (UserId: %3).").arg(socket->peerAddress().toString(), msg["User"].toString()).arg(uid.toInt()));
494 setupClientSession(socket, uid);
499 // Potentially called during the initialization phase (before handing the connection off to the session)
500 void Core::clientDisconnected() {
501 QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender()); // Note: This might be a QObject* already (if called by ~Core())!
503 blocksizes.remove(socket);
504 clientInfo.remove(socket);
505 qDebug() << qPrintable(tr("Non-authed client disconnected."));
506 socket->deleteLater();
509 // make server listen again if still not configured
514 // TODO remove unneeded sessions - if necessary/possible...
515 // Suggestion: kill sessions if they are not connected to any network and client.
518 void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
519 // Find or create session for validated user
521 if(sessions.contains(uid)) sess = sessions[uid];
522 else sess = createSession(uid);
523 // Hand over socket, session then sends state itself
524 disconnect(socket, 0, this, 0);
525 blocksizes.remove(socket);
526 clientInfo.remove(socket);
528 qWarning() << qPrintable(tr("Could not initialize session for client %1!").arg(socket->peerAddress().toString()));
531 sess->addClient(socket);
534 SessionThread *Core::createSession(UserId uid, bool restore) {
535 if(sessions.contains(uid)) {
536 qWarning() << "Calling createSession() when a session for the user already exists!";
539 SessionThread *sess = new SessionThread(uid, restore, this);
540 sessions[uid] = sess;
545 #ifndef QT_NO_OPENSSL
546 void Core::sslErrors(const QList<QSslError> &errors) {
548 QSslSocket *socket = qobject_cast<QSslSocket *>(sender());
550 socket->ignoreSslErrors();
554 void Core::socketError(QAbstractSocket::SocketError err) {
555 QAbstractSocket *socket = qobject_cast<QAbstractSocket *>(sender());
556 if(socket && err != QAbstractSocket::RemoteHostClosedError)
557 qDebug() << "Core::socketError()" << socket << err << socket->errorString();