src/core/coresession.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #include <QtScript>
  22
  23 #include "core.h"
  24 #include "coresession.h"
  25 #include "networkconnection.h"
  26 #include "userinputhandler.h"
  27
  28 #include "signalproxy.h"
  29 #include "buffersyncer.h"
  30 #include "corebacklogmanager.h"
  31 #include "corebufferviewmanager.h"
  32 #include "coreirclisthelper.h"
  33 #include "storage.h"
  34
  35 #include "corenetwork.h"
  36 #include "ircuser.h"
  37 #include "ircchannel.h"
  38 #include "identity.h"
  39
  40 #include "util.h"
  41 #include "coreusersettings.h"
  42 #include "logger.h"
  43
  44 CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
  45   : QObject(parent),
  46     _user(uid),
  47     _signalProxy(new SignalProxy(SignalProxy::Server, 0, this)),
  48     _aliasManager(this),
  49     _bufferSyncer(new BufferSyncer(this)),
  50     _backlogManager(new CoreBacklogManager(this)),
  51     _bufferViewManager(new CoreBufferViewManager(_signalProxy, this)),
  52     _ircListHelper(new CoreIrcListHelper(this)),
  53     _coreInfo(this),
  54     scriptEngine(new QScriptEngine(this))
  55 {
  56
  57   SignalProxy *p = signalProxy();
  58   connect(p, SIGNAL(peerRemoved(QIODevice *)), this, SLOT(removeClient(QIODevice *)));
  59
  60   //p->attachSlot(SIGNAL(disconnectFromNetwork(NetworkId)), this, SLOT(disconnectFromNetwork(NetworkId))); // FIXME
  61   p->attachSlot(SIGNAL(sendInput(BufferInfo, QString)), this, SLOT(msgFromClient(BufferInfo, QString)));
  62   p->attachSignal(this, SIGNAL(displayMsg(Message)));
  63   p->attachSignal(this, SIGNAL(displayStatusMsg(QString, QString)));
  64   p->attachSignal(this, SIGNAL(bufferInfoUpdated(BufferInfo)));
  65
  66   p->attachSignal(this, SIGNAL(identityCreated(const Identity &)));
  67   p->attachSignal(this, SIGNAL(identityRemoved(IdentityId)));
  68   p->attachSlot(SIGNAL(createIdentity(const Identity &)), this, SLOT(createIdentity(const Identity &)));
  69   p->attachSlot(SIGNAL(removeIdentity(IdentityId)), this, SLOT(removeIdentity(IdentityId)));
  70
  71   p->attachSignal(this, SIGNAL(networkCreated(NetworkId)));
  72   p->attachSignal(this, SIGNAL(networkRemoved(NetworkId)));
  73   p->attachSlot(SIGNAL(createNetwork(const NetworkInfo &)), this, SLOT(createNetwork(const NetworkInfo &)));
  74   p->attachSlot(SIGNAL(updateNetwork(const NetworkInfo &)), this, SLOT(updateNetwork(const NetworkInfo &)));
  75   p->attachSlot(SIGNAL(removeNetwork(NetworkId)), this, SLOT(removeNetwork(NetworkId)));
  76
  77   loadSettings();
  78   initScriptEngine();
  79
  80   // init BufferSyncer
  81   QHash<BufferId, MsgId> lastSeenHash = Core::bufferLastSeenMsgIds(user());
  82   foreach(BufferId id, lastSeenHash.keys())
  83     _bufferSyncer->requestSetLastSeenMsg(id, lastSeenHash[id]);
  84
  85   connect(_bufferSyncer, SIGNAL(lastSeenMsgSet(BufferId, MsgId)), this, SLOT(storeBufferLastSeenMsg(BufferId, MsgId)));
  86   connect(_bufferSyncer, SIGNAL(removeBufferRequested(BufferId)), this, SLOT(removeBufferRequested(BufferId)));
  87   connect(this, SIGNAL(bufferRemoved(BufferId)), _bufferSyncer, SLOT(removeBuffer(BufferId)));
  88   connect(this, SIGNAL(bufferRenamed(BufferId, QString)), _bufferSyncer, SLOT(renameBuffer(BufferId, QString)));
  89   p->synchronize(_bufferSyncer);
  90
  91
  92   // init alias manager
  93   p->synchronize(&aliasManager());
  94
  95   // init BacklogManager
  96   p->synchronize(_backlogManager);
  97
  98   // init IrcListHelper
  99   p->synchronize(ircListHelper());
 100
 101   // init CoreInfo
 102   p->synchronize(&_coreInfo);
 103
 104   // Restore session state
 105   if(restoreState) restoreSessionState();
 106
 107   emit initialized();
 108 }
 109
 110 CoreSession::~CoreSession() {
 111   saveSessionState();
 112   foreach(NetworkConnection *conn, _connections.values()) {
 113     delete conn;
 114   }
 115   foreach(CoreNetwork *net, _networks.values()) {
 116     delete net;
 117   }
 118 }
 119
 120 UserId CoreSession::user() const {
 121   return _user;
 122 }
 123
 124 CoreNetwork *CoreSession::network(NetworkId id) const {
 125   if(_networks.contains(id)) return _networks[id];
 126   return 0;
 127 }
 128
 129 NetworkConnection *CoreSession::networkConnection(NetworkId id) const {
 130   if(_connections.contains(id)) return _connections[id];
 131   return 0;
 132 }
 133
 134 Identity *CoreSession::identity(IdentityId id) const {
 135   if(_identities.contains(id)) return _identities[id];
 136   return 0;
 137 }
 138
 139 void CoreSession::loadSettings() {
 140   CoreUserSettings s(user());
 141
 142   foreach(IdentityId id, s.identityIds()) {
 143     Identity *i = new Identity(s.identity(id), this);
 144     if(!i->isValid()) {
 145       quWarning() << "Invalid identity! Removing...";
 146       s.removeIdentity(id);
 147       delete i;
 148       continue;
 149     }
 150     if(_identities.contains(i->id())) {
 151       quWarning() << "Duplicate identity, ignoring!";
 152       delete i;
 153       continue;
 154     }
 155     connect(i, SIGNAL(updated(const QVariantMap &)), this, SLOT(identityUpdated(const QVariantMap &)));
 156     _identities[i->id()] = i;
 157     signalProxy()->synchronize(i);
 158   }
 159   if(!_identities.count()) {
 160     Identity i(1);
 161     i.setToDefaults();
 162     i.setIdentityName(tr("Default Identity"));
 163     createIdentity(i);
 164   }
 165
 166   foreach(NetworkInfo info, Core::networks(user())) {
 167     createNetwork(info);
 168   }
 169 }
 170
 171 void CoreSession::saveSessionState() const {
 172
 173 }
 174
 175 void CoreSession::restoreSessionState() {
 176   QList<NetworkId> nets = Core::connectedNetworks(user());
 177   foreach(NetworkId id, nets) {
 178     connectToNetwork(id);
 179   }
 180 }
 181
 182 void CoreSession::updateBufferInfo(UserId uid, const BufferInfo &bufinfo) {
 183   if(uid == user()) emit bufferInfoUpdated(bufinfo);
 184 }
 185
 186 void CoreSession::connectToNetwork(NetworkId id) {
 187   CoreNetwork *net = network(id);
 188   if(!net) {
 189     quWarning() << "Connect to unknown network requested! net:" << id << "user:" << user();
 190     return;
 191   }
 192
 193   NetworkConnection *conn = networkConnection(id);
 194   if(!conn) {
 195     conn = new NetworkConnection(net, this);
 196     _connections[id] = conn;
 197     attachNetworkConnection(conn);
 198   }
 199   conn->connectToIrc();
 200 }
 201
 202 void CoreSession::attachNetworkConnection(NetworkConnection *conn) {
 203   connect(conn, SIGNAL(connected(NetworkId)), this, SLOT(networkConnected(NetworkId)));
 204   connect(conn, SIGNAL(quitRequested(NetworkId)), this, SLOT(networkDisconnected(NetworkId)));
 205
 206   // I guess we don't need these anymore, client-side can just connect the network's signals directly
 207   //signalProxy()->attachSignal(conn, SIGNAL(connected(NetworkId)), SIGNAL(networkConnected(NetworkId)));
 208   //signalProxy()->attachSignal(conn, SIGNAL(disconnected(NetworkId)), SIGNAL(networkDisconnected(NetworkId)));
 209
 210   connect(conn, SIGNAL(displayMsg(Message::Type, BufferInfo::Type, QString, QString, QString, Message::Flags)),
 211           this, SLOT(recvMessageFromServer(Message::Type, BufferInfo::Type, QString, QString, QString, Message::Flags)));
 212   connect(conn, SIGNAL(displayStatusMsg(QString)), this, SLOT(recvStatusMsgFromServer(QString)));
 213
 214   connect(conn, SIGNAL(nickChanged(const NetworkId &, const QString &, const QString &)),
 215           this, SLOT(renameBuffer(const NetworkId &, const QString &, const QString &)));
 216   connect(conn, SIGNAL(channelJoined(NetworkId, const QString &, const QString &)),
 217           this, SLOT(channelJoined(NetworkId, const QString &, const QString &)));
 218   connect(conn, SIGNAL(channelParted(NetworkId, const QString &)),
 219           this, SLOT(channelParted(NetworkId, const QString &)));
 220 }
 221
 222 void CoreSession::disconnectFromNetwork(NetworkId id) {
 223   if(!_connections.contains(id))
 224     return;
 225
 226   //_connections[id]->disconnectFromIrc();
 227   _connections[id]->userInputHandler()->handleQuit(BufferInfo(), QString());
 228 }
 229
 230 void CoreSession::networkStateRequested() {
 231 }
 232
 233 void CoreSession::addClient(QObject *dev) { // this is QObject* so we can use it in signal connections
 234   QIODevice *device = qobject_cast<QIODevice *>(dev);
 235   if(!device) {
 236     quError() << "Invoking CoreSession::addClient with a QObject that is not a QIODevice!";
 237   } else {
 238     signalProxy()->addPeer(device);
 239     QVariantMap reply;
 240     reply["MsgType"] = "SessionInit";
 241     reply["SessionState"] = sessionState();
 242     SignalProxy::writeDataToDevice(device, reply);
 243   }
 244 }
 245
 246 void CoreSession::removeClient(QIODevice *iodev) {
 247   // no checks for validity check - privateslot...
 248   QTcpSocket *socket = qobject_cast<QTcpSocket *>(iodev);
 249   if(socket)
 250     quInfo() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("disconnected (UserId: %1).").arg(user().toInt()));
 251   else
 252     quInfo() << "Local client disconnedted.";
 253   disconnect(socket, 0, this, 0);
 254   socket->deleteLater();
 255 }
 256
 257 SignalProxy *CoreSession::signalProxy() const {
 258   return _signalProxy;
 259 }
 260
 261 // FIXME we need a sane way for creating buffers!
 262 void CoreSession::networkConnected(NetworkId networkid) {
 263   Core::bufferInfo(user(), networkid, BufferInfo::StatusBuffer); // create status buffer
 264   Core::setNetworkConnected(user(), networkid, true);
 265 }
 266
 267 // called now only on /quit and requested disconnects, not on normal disconnects!
 268 void CoreSession::networkDisconnected(NetworkId networkid) {
 269   // if the network has already been removed, we don't have a networkconnection left either, so we don't do anything
 270   // make sure to not depend on the network still existing when calling this function!
 271   if(_connections.contains(networkid)) {
 272     Core::setNetworkConnected(user(), networkid, false);
 273     _connections.take(networkid)->deleteLater();
 274   }
 275 }
 276
 277 void CoreSession::channelJoined(NetworkId id, const QString &channel, const QString &key) {
 278   Core::setChannelPersistent(user(), id, channel, true);
 279   Core::setPersistentChannelKey(user(), id, channel, key);
 280 }
 281
 282 void CoreSession::channelParted(NetworkId id, const QString &channel) {
 283   Core::setChannelPersistent(user(), id, channel, false);
 284 }
 285
 286 QHash<QString, QString> CoreSession::persistentChannels(NetworkId id) const {
 287   return Core::persistentChannels(user(), id);
 288   return QHash<QString, QString>();
 289 }
 290
 291 // FIXME switch to BufferId
 292 void CoreSession::msgFromClient(BufferInfo bufinfo, QString msg) {
 293   NetworkConnection *conn = networkConnection(bufinfo.networkId());
 294   if(conn) {
 295     conn->userInput(bufinfo, msg);
 296   } else {
 297     quWarning() << "Trying to send to unconnected network:" << msg;
 298   }
 299 }
 300
 301 // ALL messages coming pass through these functions before going to the GUI.
 302 // So this is the perfect place for storing the backlog and log stuff.
 303 void CoreSession::recvMessageFromServer(Message::Type type, BufferInfo::Type bufferType,
 304                                         QString target, QString text, QString sender, Message::Flags flags) {
 305   NetworkConnection *netCon = qobject_cast<NetworkConnection*>(this->sender());
 306   Q_ASSERT(netCon);
 307
 308   BufferInfo bufferInfo = Core::bufferInfo(user(), netCon->networkId(), bufferType, target);
 309   Message msg(bufferInfo, type, text, sender, flags);
 310   msg.setMsgId(Core::storeMessage(msg));
 311   Q_ASSERT(msg.msgId() != 0);
 312   emit displayMsg(msg);
 313 }
 314
 315 void CoreSession::recvStatusMsgFromServer(QString msg) {
 316   NetworkConnection *s = qobject_cast<NetworkConnection*>(sender());
 317   Q_ASSERT(s);
 318   emit displayStatusMsg(s->networkName(), msg);
 319 }
 320
 321 QList<BufferInfo> CoreSession::buffers() const {
 322   return Core::requestBuffers(user());
 323 }
 324
 325
 326 QVariant CoreSession::sessionState() {
 327   QVariantMap v;
 328
 329   QVariantList bufs;
 330   foreach(BufferInfo id, buffers()) bufs << qVariantFromValue(id);
 331   v["BufferInfos"] = bufs;
 332   QVariantList networkids;
 333   foreach(NetworkId id, _networks.keys()) networkids << qVariantFromValue(id);
 334   v["NetworkIds"] = networkids;
 335
 336   quint32 ircusercount = 0;
 337   quint32 ircchannelcount = 0;
 338   foreach(Network *net, _networks.values()) {
 339     ircusercount += net->ircUserCount();
 340     ircchannelcount += net->ircChannelCount();
 341   }
 342   v["IrcUserCount"] = ircusercount;
 343   v["IrcChannelCount"] = ircchannelcount;
 344
 345   QList<QVariant> idlist;
 346   foreach(Identity *i, _identities.values()) idlist << qVariantFromValue(*i);
 347   v["Identities"] = idlist;
 348
 349   //v["Payload"] = QByteArray(100000000, 'a');  // for testing purposes
 350   return v;
 351 }
 352
 353 void CoreSession::storeBufferLastSeenMsg(BufferId buffer, const MsgId &msgId) {
 354   Core::setBufferLastSeenMsg(user(), buffer, msgId);
 355 }
 356
 357 void CoreSession::initScriptEngine() {
 358   signalProxy()->attachSlot(SIGNAL(scriptRequest(QString)), this, SLOT(scriptRequest(QString)));
 359   signalProxy()->attachSignal(this, SIGNAL(scriptResult(QString)));
 360
 361   // FIXME
 362   //QScriptValue storage_ = scriptEngine->newQObject(storage);
 363   //scriptEngine->globalObject().setProperty("storage", storage_);
 364 }
 365
 366 void CoreSession::scriptRequest(QString script) {
 367   emit scriptResult(scriptEngine->evaluate(script).toString());
 368 }
 369
 370 /*** Identity Handling ***/
 371
 372 void CoreSession::createIdentity(const Identity &id) {
 373   // find free ID
 374   int i;
 375   for(i = 1; i <= _identities.count(); i++) {
 376     if(!_identities.keys().contains(i)) break;
 377   }
 378   //qDebug() << "found free id" << i;
 379   Identity *newId = new Identity(id, this);
 380   newId->setId(i);
 381   _identities[i] = newId;
 382   signalProxy()->synchronize(newId);
 383   CoreUserSettings s(user());
 384   s.storeIdentity(*newId);
 385   connect(newId, SIGNAL(updated(const QVariantMap &)), this, SLOT(identityUpdated(const QVariantMap &)));
 386   emit identityCreated(*newId);
 387 }
 388
 389 void CoreSession::removeIdentity(IdentityId id) {
 390   Identity *i = _identities.take(id);
 391   if(i) {
 392     emit identityRemoved(id);
 393     CoreUserSettings s(user());
 394     s.removeIdentity(id);
 395     i->deleteLater();
 396   }
 397 }
 398
 399 void CoreSession::identityUpdated(const QVariantMap &data) {
 400   IdentityId id = data.value("identityId", 0).value<IdentityId>();
 401   if(!id.isValid() || !_identities.contains(id)) {
 402     quWarning() << "Update request for unknown identity received!";
 403     return;
 404   }
 405   CoreUserSettings s(user());
 406   s.storeIdentity(*_identities.value(id));
 407 }
 408
 409 /*** Network Handling ***/
 410
 411 void CoreSession::createNetwork(const NetworkInfo &info_) {
 412   NetworkInfo info = info_;
 413   int id;
 414
 415   if(!info.networkId.isValid())
 416     Core::createNetwork(user(), info);
 417
 418   if(!info.networkId.isValid()) {
 419     quWarning() << qPrintable(tr("CoreSession::createNetwork(): Got invalid networkId from Core when trying to create network %1!").arg(info.networkName));
 420     return;
 421   }
 422
 423   id = info.networkId.toInt();
 424   if(!_networks.contains(id)) {
 425     CoreNetwork *net = new CoreNetwork(id, this);
 426     connect(net, SIGNAL(connectRequested(NetworkId)), this, SLOT(connectToNetwork(NetworkId)));
 427     connect(net, SIGNAL(disconnectRequested(NetworkId)), this, SLOT(disconnectFromNetwork(NetworkId)));
 428     net->setNetworkInfo(info);
 429     net->setProxy(signalProxy());
 430     _networks[id] = net;
 431     signalProxy()->synchronize(net);
 432     emit networkCreated(id);
 433   } else {
 434     quWarning() << qPrintable(tr("CoreSession::createNetwork(): Trying to create a network that already exists, updating instead!"));
 435     updateNetwork(info);
 436   }
 437 }
 438
 439 // FIXME: move to CoreNetwork
 440 void CoreSession::updateNetwork(const NetworkInfo &info) {
 441   if(!_networks.contains(info.networkId)) {
 442     quWarning() << "Update request for unknown network received!";
 443     return;
 444   }
 445   _networks[info.networkId]->setNetworkInfo(info);
 446   Core::updateNetwork(user(), info);
 447 }
 448
 449 void CoreSession::removeNetwork(NetworkId id) {
 450   // Make sure the network is disconnected!
 451   NetworkConnection *conn = _connections.value(id, 0);
 452   if(conn) {
 453     if(conn->connectionState() != Network::Disconnected) {
 454       connect(conn, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetwork(NetworkId)));
 455       conn->disconnectFromIrc();
 456     } else {
 457       _connections.take(id)->deleteLater();  // TODO make this saner
 458       destroyNetwork(id);
 459     }
 460   } else {
 461     destroyNetwork(id);
 462   }
 463 }
 464
 465 void CoreSession::destroyNetwork(NetworkId id) {
 466   if(_connections.contains(id)) {
 467     // this can happen if the network was reconnecting while being removed
 468     _connections.take(id)->deleteLater();
 469   }
 470   QList<BufferId> removedBuffers = Core::requestBufferIdsForNetwork(user(), id);
 471   Network *net = _networks.take(id);
 472   if(net && Core::removeNetwork(user(), id)) {
 473     foreach(BufferId bufferId, removedBuffers) {
 474       _bufferSyncer->removeBuffer(bufferId);
 475     }
 476     emit networkRemoved(id);
 477     net->deleteLater();
 478   }
 479 }
 480
 481 void CoreSession::removeBufferRequested(BufferId bufferId) {
 482   BufferInfo bufferInfo = Core::getBufferInfo(user(), bufferId);
 483   if(!bufferInfo.isValid()) {
 484     quWarning() << "CoreSession::removeBufferRequested(): invalid BufferId:" << bufferId << "for User:" << user();
 485     return;
 486   }
 487
 488   if(bufferInfo.type() == BufferInfo::StatusBuffer) {
 489     quWarning() << "CoreSession::removeBufferRequested(): Status Buffers cannot be removed!";
 490     return;
 491   }
 492
 493   if(bufferInfo.type() == BufferInfo::ChannelBuffer) {
 494     CoreNetwork *net = network(bufferInfo.networkId());
 495     if(!net) {
 496       quWarning() << "CoreSession::removeBufferRequested(): Received BufferInfo with unknown networkId!";
 497       return;
 498     }
 499     IrcChannel *chan = net->ircChannel(bufferInfo.bufferName());
 500     if(chan) {
 501       quWarning() << "CoreSession::removeBufferRequested(): Unable to remove Buffer for joined Channel:" << bufferInfo.bufferName();
 502       return;
 503     }
 504   }
 505   if(Core::removeBuffer(user(), bufferId))
 506     emit bufferRemoved(bufferId);
 507 }
 508
 509 void CoreSession::renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName) {
 510   BufferId bufferId = Core::renameBuffer(user(), networkId, newName, oldName);
 511   if(bufferId.isValid()) {
 512     emit bufferRenamed(bufferId, newName);
 513   }
 514 }