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