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"
33 Core *Core::instanceptr = 0;
36 Core *Core::instance() {
37 if(instanceptr) return instanceptr;
38 instanceptr = new Core();
43 void Core::destroy() {
48 Core::Core() : storage(0) {
49 startTime = QDateTime::currentDateTime(); // for uptime :)
51 // Register storage backends here!
52 registerStorageBackend(new SqliteStorage(this));
54 if(!_storageBackends.count()) {
55 qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
56 exit(1); // TODO make this less brutal (especially for mono client -> popup)
58 connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
59 _storageSyncTimer.start(10 * 60 * 1000); // in msecs
67 if(!(configured = initStorage(cs.storageSettings().toMap()))) {
68 qWarning("Core is currently not configured!");
70 // try to migrate old settings
71 QVariantMap old = cs.oldDbSettings().toMap();
72 if(old.count() && old["Type"].toString().toUpper() == "SQLITE") {
73 QVariantMap newSettings;
74 newSettings["Backend"] = "SQLite";
75 if((configured = initStorage(newSettings))) {
76 qWarning("...but thankfully I found some old settings to migrate!");
77 cs.setStorageSettings(newSettings);
82 connect(&server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
83 if(!startListening(cs.port())) exit(1); // TODO make this less brutal
87 foreach(QTcpSocket *socket, blocksizes.keys()) { qDebug() << "disconnecting" << socket << blocksizes.keys();
88 socket->disconnectFromHost(); // disconnect local (i.e. non-authed) clients
91 qDeleteAll(_storageBackends);
94 /*** Session Restore ***/
96 void Core::saveState() {
99 QVariantList activeSessions;
100 foreach(UserId user, instance()->sessions.keys()) activeSessions << QVariant::fromValue<UserId>(user);
101 state["CoreBuild"] = Global::quasselBuild;
102 state["ActiveSessions"] = activeSessions;
103 s.setCoreState(state);
106 void Core::restoreState() {
107 if(!instance()->configured) {
108 qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
111 if(instance()->sessions.count()) {
112 qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
116 uint build = s.coreState().toMap()["CoreBuild"].toUInt();
118 qWarning() << qPrintable(tr("Core state too old, ignoring..."));
121 QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
122 if(activeSessions.count() > 0) {
123 qDebug() << "Restoring previous core state...";
124 foreach(QVariant v, activeSessions) {
125 UserId user = v.value<UserId>();
126 instance()->createSession(user, true);
133 QString Core::setupCore(const QVariant &setupData_) {
134 QVariantMap setupData = setupData_.toMap();
135 QString user = setupData.take("AdminUser").toString();
136 QString password = setupData.take("AdminPasswd").toString();
137 if(user.isEmpty() || password.isEmpty()) {
138 return tr("Admin user or password not set.");
140 if(!initStorage(setupData, true)) {
141 return tr("Could not setup storage!");
144 s.setStorageSettings(setupData);
145 qDebug() << qPrintable(tr("Creating admin user..."));
147 storage->addUser(user, password);
149 startListening(); // TODO check when we need this
153 /*** Storage Handling ***/
155 bool Core::registerStorageBackend(Storage *backend) {
156 if(backend->isAvailable()) {
157 _storageBackends[backend->displayName()] = backend;
160 backend->deleteLater();
165 void Core::unregisterStorageBackend(Storage *backend) {
166 _storageBackends.remove(backend->displayName());
167 backend->deleteLater();
171 // "Type" => "sqlite"
172 bool Core::initStorage(QVariantMap dbSettings, bool setup) {
173 QString backend = dbSettings["Backend"].toString();
174 if(backend.isEmpty()) {
175 //qWarning() << "No storage backend selected!";
176 return configured = false;
179 if(_storageBackends.contains(backend)) {
180 storage = _storageBackends[backend];
182 qWarning() << "Selected storage backend is not available:" << backend;
183 return configured = false;
185 if(!storage->init(dbSettings)) {
186 if(!setup || !(storage->setup(dbSettings) && storage->init(dbSettings))) {
187 qWarning() << "Could not init storage!";
189 return configured = false;
192 // delete all other backends
193 foreach(Storage *s, _storageBackends.values()) {
194 if(s != storage) s->deleteLater();
196 _storageBackends.clear();
198 connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
199 return configured = true;
202 void Core::syncStorage() {
203 QMutexLocker locker(&mutex);
204 if(storage) storage->sync();
207 /*** Storage Access ***/
208 bool Core::createNetwork(UserId user, NetworkInfo &info) {
209 QMutexLocker locker(&mutex);
210 NetworkId networkId = instance()->storage->createNetwork(user, info);
211 if(!networkId.isValid())
214 info.networkId = networkId;
218 bool Core::updateNetwork(UserId user, const NetworkInfo &info) {
219 QMutexLocker locker(&mutex);
220 return instance()->storage->updateNetwork(user, info);
223 bool Core::removeNetwork(UserId user, const NetworkId &networkId) {
224 QMutexLocker locker(&mutex);
225 return instance()->storage->removeNetwork(user, networkId);
228 QList<NetworkInfo> Core::networks(UserId user) {
229 QMutexLocker locker(&mutex);
230 return instance()->storage->networks(user);
233 NetworkId Core::networkId(UserId user, const QString &network) {
234 QMutexLocker locker(&mutex);
235 return instance()->storage->getNetworkId(user, network);
238 BufferInfo Core::bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
239 QMutexLocker locker(&mutex);
240 return instance()->storage->getBufferInfo(user, networkId, type, buffer);
243 BufferInfo Core::getBufferInfo(UserId user, const BufferId &bufferId) {
244 QMutexLocker locker(&mutex);
245 return instance()->storage->getBufferInfo(user, bufferId);
248 MsgId Core::storeMessage(const Message &message) {
249 QMutexLocker locker(&mutex);
250 return instance()->storage->logMessage(message);
253 QList<Message> Core::requestMsgs(BufferInfo buffer, int lastmsgs, int offset) {
254 QMutexLocker locker(&mutex);
255 return instance()->storage->requestMsgs(buffer, lastmsgs, offset);
258 QList<Message> Core::requestMsgs(BufferInfo buffer, QDateTime since, int offset) {
259 QMutexLocker locker(&mutex);
260 return instance()->storage->requestMsgs(buffer, since, offset);
263 QList<Message> Core::requestMsgRange(BufferInfo buffer, int first, int last) {
264 QMutexLocker locker(&mutex);
265 return instance()->storage->requestMsgRange(buffer, first, last);
268 QList<BufferInfo> Core::requestBuffers(UserId user, QDateTime since) {
269 QMutexLocker locker(&mutex);
270 return instance()->storage->requestBuffers(user, since);
273 bool Core::removeBuffer(const UserId &user, const BufferId &bufferId) {
274 QMutexLocker locker(&mutex);
275 return instance()->storage->removeBuffer(user, bufferId);
278 BufferId Core::renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) {
279 QMutexLocker locker(&mutex);
280 return instance()->storage->renameBuffer(user, networkId, newName, oldName);
283 void Core::setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate) {
284 QMutexLocker locker(&mutex);
285 return instance()->storage->setBufferLastSeen(user, bufferId, seenDate);
288 QHash<BufferId, QDateTime> Core::bufferLastSeenDates(UserId user) {
289 QMutexLocker locker(&mutex);
290 return instance()->storage->bufferLastSeenDates(user);
293 /*** Network Management ***/
295 bool Core::startListening(uint port) {
296 if(!server.listen(QHostAddress::Any, port)) {
297 qWarning(qPrintable(QString("Could not open GUI client port %1: %2").arg(port).arg(server.errorString())));
300 qDebug() << "Listening for GUI clients on port" << server.serverPort();
304 void Core::stopListening() {
306 qDebug() << "No longer listening for GUI clients.";
309 void Core::incomingConnection() {
310 // TODO implement SSL
311 while(server.hasPendingConnections()) {
312 QTcpSocket *socket = server.nextPendingConnection();
313 connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
314 connect(socket, SIGNAL(readyRead()), this, SLOT(clientHasData()));
315 QVariantMap clientInfo;
316 blocksizes.insert(socket, (quint32)0);
317 qDebug() << "Client connected from" << qPrintable(socket->peerAddress().toString());
321 qDebug() << "Closing server for basic setup.";
326 void Core::clientHasData() {
327 QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());
328 Q_ASSERT(socket && blocksizes.contains(socket));
330 while(SignalProxy::readDataFromDevice(socket, blocksizes[socket], item)) {
331 QVariantMap msg = item.toMap();
332 processClientMessage(socket, msg);
333 if(!blocksizes.contains(socket)) break; // this socket is no longer ours to handle!
337 void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
338 if(!msg.contains("MsgType")) {
339 // Client is way too old, does not even use the current init format
340 qWarning() << qPrintable(tr("Antique client trying to connect... refusing."));
344 // OK, so we have at least an init message format we can understand
345 if(msg["MsgType"] == "ClientInit") {
347 reply["CoreVersion"] = Global::quasselVersion;
348 reply["CoreDate"] = Global::quasselDate;
349 reply["CoreBuild"] = Global::quasselBuild;
350 // TODO: Make the core info configurable
351 int uptime = startTime.secsTo(QDateTime::currentDateTime());
352 int updays = uptime / 86400; uptime %= 86400;
353 int uphours = uptime / 3600; uptime %= 3600;
354 int upmins = uptime / 60;
355 reply["CoreInfo"] = tr("<b>Quassel Core Version %1 (Build >= %2)</b><br>"
356 "Up %3d%4h%5m (since %6)").arg(Global::quasselVersion).arg(Global::quasselBuild)
357 .arg(updays).arg(uphours,2,10,QChar('0')).arg(upmins,2,10,QChar('0')).arg(startTime.toString(Qt::TextDate));
359 reply["SupportSsl"] = false;
360 reply["LoginEnabled"] = true;
362 // Just version information -- check it!
363 if(msg["ClientBuild"].toUInt() < Global::clientBuildNeeded) {
364 reply["MsgType"] = "ClientInitReject";
365 reply["Error"] = tr("<b>Your Quassel Client is too old!</b><br>"
366 "This core needs at least client version %1 (Build >= %2).<br>"
367 "Please consider upgrading your client.").arg(Global::quasselVersion).arg(Global::quasselBuild);
368 SignalProxy::writeDataToDevice(socket, reply);
369 qWarning() << qPrintable(tr("Client %1 too old, rejecting.").arg(socket->peerAddress().toString()));
370 socket->close(); return;
372 // check if we are configured, start wizard otherwise
374 reply["Configured"] = false;
375 QList<QVariant> backends;
376 foreach(Storage *backend, _storageBackends.values()) {
378 v["DisplayName"] = backend->displayName();
379 v["Description"] = backend->description();
382 reply["StorageBackends"] = backends;
383 reply["LoginEnabled"] = false;
385 reply["Configured"] = true;
387 clientInfo[socket] = msg; // store for future reference
388 reply["MsgType"] = "ClientInitAck";
389 SignalProxy::writeDataToDevice(socket, reply);
391 // for the rest, we need an initialized connection
392 if(!clientInfo.contains(socket)) {
394 reply["MsgType"] = "ClientLoginReject";
395 reply["Error"] = tr("<b>Client not initialized!</b><br>You need to send an init message before trying to login.");
396 SignalProxy::writeDataToDevice(socket, reply);
397 qWarning() << qPrintable(tr("Client %1 did not send an init message before trying to login, rejecting.").arg(socket->peerAddress().toString()));
398 socket->close(); return;
400 if(msg["MsgType"] == "CoreSetupData") {
402 QString result = setupCore(msg["SetupData"]);
403 if(!result.isEmpty()) {
404 reply["MsgType"] = "CoreSetupReject";
405 reply["Error"] = result;
407 reply["MsgType"] = "CoreSetupAck";
409 SignalProxy::writeDataToDevice(socket, reply);
410 } else if(msg["MsgType"] == "ClientLogin") {
413 UserId uid = storage->validateUser(msg["User"].toString(), msg["Password"].toString());
416 reply["MsgType"] = "ClientLoginReject";
417 reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
418 SignalProxy::writeDataToDevice(socket, reply);
421 reply["MsgType"] = "ClientLoginAck";
422 SignalProxy::writeDataToDevice(socket, reply);
423 qDebug() << qPrintable(tr("Client %1 initialized and authentificated successfully as \"%2\".").arg(socket->peerAddress().toString(), msg["User"].toString()));
424 setupClientSession(socket, uid);
429 // Potentially called during the initialization phase (before handing the connection off to the session)
430 void Core::clientDisconnected() {
431 QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender()); // Note: This might be a QObject* already (if called by ~Core())!
433 blocksizes.remove(socket);
434 clientInfo.remove(socket);
435 qDebug() << qPrintable(tr("Non-authed client disconnected."));
436 socket->deleteLater();
439 // make server listen again if still not configured
444 // TODO remove unneeded sessions - if necessary/possible...
445 // Suggestion: kill sessions if they are not connected to any network and client.
448 void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
449 // Find or create session for validated user
451 if(sessions.contains(uid)) sess = sessions[uid];
452 else sess = createSession(uid);
453 // Hand over socket, session then sends state itself
454 disconnect(socket, 0, this, 0);
455 blocksizes.remove(socket);
456 clientInfo.remove(socket);
458 qWarning() << qPrintable(tr("Could not initialize session for client %1!").arg(socket->peerAddress().toString()));
461 sess->addClient(socket);
464 SessionThread *Core::createSession(UserId uid, bool restore) {
465 if(sessions.contains(uid)) {
466 qWarning() << "Calling createSession() when a session for the user already exists!";
469 SessionThread *sess = new SessionThread(uid, restore, this);
470 sessions[uid] = sess;