Some cleanups, debug output--
[quassel.git] / src / client / client.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-09 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 "client.h"
22
23 #include "abstractmessageprocessor.h"
24 #include "abstractui.h"
25 #include "bufferinfo.h"
26 #include "buffermodel.h"
27 #include "buffersettings.h"
28 #include "buffersyncer.h"
29 #include "bufferviewconfig.h"
30 #include "bufferviewoverlay.h"
31 #include "clientaliasmanager.h"
32 #include "clientbacklogmanager.h"
33 #include "clientbufferviewmanager.h"
34 #include "clientirclisthelper.h"
35 #include "clientidentity.h"
36 #include "clientignorelistmanager.h"
37 #include "clientuserinputhandler.h"
38 #include "coreaccountmodel.h"
39 #include "coreconnection.h"
40 #include "ircchannel.h"
41 #include "ircuser.h"
42 #include "message.h"
43 #include "messagemodel.h"
44 #include "network.h"
45 #include "networkconfig.h"
46 #include "networkmodel.h"
47 #include "quassel.h"
48 #include "signalproxy.h"
49 #include "util.h"
50
51 #include <stdio.h>
52 #include <stdlib.h>
53
54 QPointer<Client> Client::instanceptr = 0;
55 Quassel::Features Client::_coreFeatures = 0;
56
57 /*** Initialization/destruction ***/
58
59 bool Client::instanceExists()
60 {
61   return instanceptr;
62 }
63
64 Client *Client::instance() {
65   if(!instanceptr)
66     instanceptr = new Client();
67   return instanceptr;
68 }
69
70 void Client::destroy() {
71   if(instanceptr) {
72     delete instanceptr->mainUi();
73     instanceptr->deleteLater();
74     instanceptr = 0;
75   }
76 }
77
78 void Client::init(AbstractUi *ui) {
79   instance()->_mainUi = ui;
80   instance()->init();
81 }
82
83 Client::Client(QObject *parent)
84   : QObject(parent),
85     _signalProxy(new SignalProxy(SignalProxy::Client, this)),
86     _mainUi(0),
87     _networkModel(0),
88     _bufferModel(0),
89     _bufferSyncer(0),
90     _aliasManager(0),
91     _backlogManager(new ClientBacklogManager(this)),
92     _bufferViewManager(0),
93     _bufferViewOverlay(new BufferViewOverlay(this)),
94     _ircListHelper(new ClientIrcListHelper(this)),
95     _inputHandler(0),
96     _networkConfig(0),
97     _ignoreListManager(0),
98     _messageModel(0),
99     _messageProcessor(0),
100     _coreAccountModel(new CoreAccountModel(this)),
101     _coreConnection(new CoreConnection(_coreAccountModel, this)),
102     _connected(false),
103     _debugLog(&_debugLogBuffer)
104 {
105   _signalProxy->synchronize(_ircListHelper);
106 }
107
108 Client::~Client() {
109   disconnectFromCore();
110 }
111
112 void Client::init() {
113   _networkModel = new NetworkModel(this);
114
115   connect(this, SIGNAL(networkRemoved(NetworkId)),
116           _networkModel, SLOT(networkRemoved(NetworkId)));
117
118   _bufferModel = new BufferModel(_networkModel);
119   _messageModel = mainUi()->createMessageModel(this);
120   _messageProcessor = mainUi()->createMessageProcessor(this);
121   _inputHandler = new ClientUserInputHandler(this);
122
123   SignalProxy *p = signalProxy();
124
125   p->attachSlot(SIGNAL(displayMsg(const Message &)), this, SLOT(recvMessage(const Message &)));
126   p->attachSlot(SIGNAL(displayStatusMsg(QString, QString)), this, SLOT(recvStatusMsg(QString, QString)));
127
128   p->attachSlot(SIGNAL(bufferInfoUpdated(BufferInfo)), _networkModel, SLOT(bufferUpdated(BufferInfo)));
129   p->attachSignal(inputHandler(), SIGNAL(sendInput(BufferInfo, QString)));
130   p->attachSignal(this, SIGNAL(requestNetworkStates()));
131
132   p->attachSignal(this, SIGNAL(requestCreateIdentity(const Identity &, const QVariantMap &)), SIGNAL(createIdentity(const Identity &, const QVariantMap &)));
133   p->attachSignal(this, SIGNAL(requestRemoveIdentity(IdentityId)), SIGNAL(removeIdentity(IdentityId)));
134   p->attachSlot(SIGNAL(identityCreated(const Identity &)), this, SLOT(coreIdentityCreated(const Identity &)));
135   p->attachSlot(SIGNAL(identityRemoved(IdentityId)), this, SLOT(coreIdentityRemoved(IdentityId)));
136
137   p->attachSignal(this, SIGNAL(requestCreateNetwork(const NetworkInfo &, const QStringList &)), SIGNAL(createNetwork(const NetworkInfo &, const QStringList &)));
138   p->attachSignal(this, SIGNAL(requestRemoveNetwork(NetworkId)), SIGNAL(removeNetwork(NetworkId)));
139   p->attachSlot(SIGNAL(networkCreated(NetworkId)), this, SLOT(coreNetworkCreated(NetworkId)));
140   p->attachSlot(SIGNAL(networkRemoved(NetworkId)), this, SLOT(coreNetworkRemoved(NetworkId)));
141
142   //connect(mainUi(), SIGNAL(connectToCore(const QVariantMap &)), this, SLOT(connectToCore(const QVariantMap &)));
143   connect(mainUi(), SIGNAL(disconnectFromCore()), this, SLOT(disconnectFromCore()));
144   connect(this, SIGNAL(connected()), mainUi(), SLOT(connectedToCore()));
145   connect(this, SIGNAL(disconnected()), mainUi(), SLOT(disconnectedFromCore()));
146
147   // attach backlog manager
148   p->synchronize(backlogManager());
149   connect(backlogManager(), SIGNAL(messagesReceived(BufferId, int)), _messageModel, SLOT(messagesReceived(BufferId, int)));
150
151   coreAccountModel()->load();
152
153   connect(coreConnection(), SIGNAL(stateChanged(CoreConnection::ConnectionState)), SLOT(connectionStateChanged(CoreConnection::ConnectionState)));
154   coreConnection()->init();
155 }
156
157 /*** public static methods ***/
158
159 AbstractUi *Client::mainUi() {
160   return instance()->_mainUi;
161 }
162
163 void Client::setCoreFeatures(Quassel::Features features) {
164   _coreFeatures = features;
165 }
166
167 bool Client::isConnected() {
168   return instance()->_connected;
169 }
170
171 bool Client::internalCore() {
172   return currentCoreAccount().isInternal();
173 }
174
175 /*** Network handling ***/
176
177 QList<NetworkId> Client::networkIds() {
178   return instance()->_networks.keys();
179 }
180
181 const Network * Client::network(NetworkId networkid) {
182   if(instance()->_networks.contains(networkid)) return instance()->_networks[networkid];
183   else return 0;
184 }
185
186 void Client::createNetwork(const NetworkInfo &info, const QStringList &persistentChannels) {
187   emit instance()->requestCreateNetwork(info, persistentChannels);
188 }
189
190 void Client::removeNetwork(NetworkId id) {
191   emit instance()->requestRemoveNetwork(id);
192 }
193
194 void Client::updateNetwork(const NetworkInfo &info) {
195   Network *netptr = instance()->_networks.value(info.networkId, 0);
196   if(!netptr) {
197     qWarning() << "Update for unknown network requested:" << info;
198     return;
199   }
200   netptr->requestSetNetworkInfo(info);
201 }
202
203 void Client::addNetwork(Network *net) {
204   net->setProxy(signalProxy());
205   signalProxy()->synchronize(net);
206   networkModel()->attachNetwork(net);
207   connect(net, SIGNAL(destroyed()), instance(), SLOT(networkDestroyed()));
208   instance()->_networks[net->networkId()] = net;
209   emit instance()->networkCreated(net->networkId());
210 }
211
212 void Client::coreNetworkCreated(NetworkId id) {
213   if(_networks.contains(id)) {
214     qWarning() << "Creation of already existing network requested!";
215     return;
216   }
217   Network *net = new Network(id, this);
218   addNetwork(net);
219 }
220
221 void Client::coreNetworkRemoved(NetworkId id) {
222   if(!_networks.contains(id))
223     return;
224   Network *net = _networks.take(id);
225   emit networkRemoved(net->networkId());
226   net->deleteLater();
227 }
228
229 /*** Identity handling ***/
230
231 QList<IdentityId> Client::identityIds() {
232   return instance()->_identities.keys();
233 }
234
235 const Identity *Client::identity(IdentityId id) {
236   if(instance()->_identities.contains(id)) return instance()->_identities[id];
237   else return 0;
238 }
239
240 void Client::createIdentity(const CertIdentity &id) {
241   QVariantMap additional;
242 #ifdef HAVE_SSL
243   additional["KeyPem"] = id.sslKey().toPem();
244   additional["CertPem"] = id.sslCert().toPem();
245 #endif
246   emit instance()->requestCreateIdentity(id, additional);
247 }
248
249 void Client::updateIdentity(IdentityId id, const QVariantMap &ser) {
250   Identity *idptr = instance()->_identities.value(id, 0);
251   if(!idptr) {
252     qWarning() << "Update for unknown identity requested:" << id;
253     return;
254   }
255   idptr->requestUpdate(ser);
256 }
257
258 void Client::removeIdentity(IdentityId id) {
259   emit instance()->requestRemoveIdentity(id);
260 }
261
262 void Client::coreIdentityCreated(const Identity &other) {
263   if(!_identities.contains(other.id())) {
264     Identity *identity = new Identity(other, this);
265     _identities[other.id()] = identity;
266     identity->setInitialized();
267     signalProxy()->synchronize(identity);
268     emit identityCreated(other.id());
269   } else {
270     qWarning() << tr("Identity already exists in client!");
271   }
272 }
273
274 void Client::coreIdentityRemoved(IdentityId id) {
275   if(_identities.contains(id)) {
276     emit identityRemoved(id);
277     Identity *i = _identities.take(id);
278     i->deleteLater();
279   }
280 }
281
282 /*** User input handling ***/
283
284 void Client::userInput(const BufferInfo &bufferInfo, const QString &message) {
285   // we need to make sure that AliasManager is ready before processing input
286   if(aliasManager() && aliasManager()->isInitialized())
287     inputHandler()->handleUserInput(bufferInfo, message);
288   else
289    instance()-> _userInputBuffer.append(qMakePair(bufferInfo, message));
290 }
291
292 void Client::sendBufferedUserInput() {
293   for(int i = 0; i < _userInputBuffer.count(); i++)
294     userInput(_userInputBuffer.at(i).first, _userInputBuffer.at(i).second);
295
296   _userInputBuffer.clear();
297 }
298
299 /*** core connection stuff ***/
300
301 void Client::connectionStateChanged(CoreConnection::ConnectionState state) {
302   switch(state) {
303   case CoreConnection::Disconnected:
304     setDisconnectedFromCore();
305     break;
306   case CoreConnection::Synchronized:
307     setSyncedToCore();
308     break;
309   default:
310     break;
311   }
312 }
313
314 void Client::setSyncedToCore() {
315   // create buffersyncer
316   Q_ASSERT(!_bufferSyncer);
317   _bufferSyncer = new BufferSyncer(this);
318   connect(bufferSyncer(), SIGNAL(lastSeenMsgSet(BufferId, MsgId)), _networkModel, SLOT(setLastSeenMsgId(BufferId, MsgId)));
319   connect(bufferSyncer(), SIGNAL(markerLineSet(BufferId,MsgId)), _networkModel, SLOT(setMarkerLineMsgId(BufferId,MsgId)));
320   connect(bufferSyncer(), SIGNAL(bufferRemoved(BufferId)), this, SLOT(bufferRemoved(BufferId)));
321   connect(bufferSyncer(), SIGNAL(bufferRenamed(BufferId, QString)), this, SLOT(bufferRenamed(BufferId, QString)));
322   connect(bufferSyncer(), SIGNAL(buffersPermanentlyMerged(BufferId, BufferId)), this, SLOT(buffersPermanentlyMerged(BufferId, BufferId)));
323   connect(bufferSyncer(), SIGNAL(buffersPermanentlyMerged(BufferId, BufferId)), _messageModel, SLOT(buffersPermanentlyMerged(BufferId, BufferId)));
324   connect(networkModel(), SIGNAL(setLastSeenMsg(BufferId, MsgId)), bufferSyncer(), SLOT(requestSetLastSeenMsg(BufferId, const MsgId &)));
325   signalProxy()->synchronize(bufferSyncer());
326
327   // create a new BufferViewManager
328   Q_ASSERT(!_bufferViewManager);
329   _bufferViewManager = new ClientBufferViewManager(signalProxy(), this);
330   connect(bufferViewManager(), SIGNAL(initDone()), this, SLOT(createDefaultBufferView()));
331
332   // create AliasManager
333   Q_ASSERT(!_aliasManager);
334   _aliasManager = new ClientAliasManager(this);
335   connect(aliasManager(), SIGNAL(initDone()), SLOT(sendBufferedUserInput()));
336   signalProxy()->synchronize(aliasManager());
337
338   // create NetworkConfig
339   Q_ASSERT(!_networkConfig);
340   _networkConfig = new NetworkConfig("GlobalNetworkConfig", this);
341   signalProxy()->synchronize(networkConfig());
342
343   // create IgnoreListManager
344   Q_ASSERT(!_ignoreListManager);
345   _ignoreListManager = new ClientIgnoreListManager(this);
346   signalProxy()->synchronize(ignoreListManager());
347
348   // trigger backlog request once all active bufferviews are initialized
349   connect(bufferViewOverlay(), SIGNAL(initDone()), this, SLOT(requestInitialBacklog()));
350
351   _connected = true;
352   emit connected();
353   emit coreConnectionStateChanged(true);
354 }
355
356 void Client::requestInitialBacklog() {
357   // usually it _should_ take longer until the bufferViews are initialized, so that's what
358   // triggers this slot. But we have to make sure that we know all buffers yet.
359   // so we check the BufferSyncer and in case it wasn't initialized we wait for that instead
360   if(!bufferSyncer()->isInitialized()) {
361     connect(bufferViewOverlay(), SIGNAL(initDone()), this, SLOT(requestInitialBacklog()));
362     connect(bufferSyncer(), SIGNAL(initDone()), this, SLOT(requestInitialBacklog()));
363     return;
364   }
365   _backlogManager->requestInitialBacklog();
366 }
367
368 void Client::createDefaultBufferView() {
369   if(bufferViewManager()->bufferViewConfigs().isEmpty()) {
370     BufferViewConfig config(-1);
371     config.setBufferViewName(tr("All Chats"));
372     config.initSetBufferList(networkModel()->allBufferIdsSorted());
373     bufferViewManager()->requestCreateBufferView(config.toVariantMap());
374   }
375 }
376
377 void Client::disconnectFromCore() {
378   if(!coreConnection()->isConnected())
379     return;
380
381   coreConnection()->disconnectFromCore();
382 }
383
384 void Client::setDisconnectedFromCore() {
385   _connected = false;
386   _coreFeatures = 0;
387
388   emit disconnected();
389   emit coreConnectionStateChanged(false);
390
391   backlogManager()->reset();
392   messageProcessor()->reset();
393
394   // Clear internal data. Hopefully nothing relies on it at this point.
395
396   if(_bufferSyncer) {
397     _bufferSyncer->deleteLater();
398     _bufferSyncer = 0;
399   }
400
401   if(_bufferViewManager) {
402     _bufferViewManager->deleteLater();
403     _bufferViewManager = 0;
404   }
405
406   if(_aliasManager) {
407     _aliasManager->deleteLater();
408     _aliasManager = 0;
409   }
410
411   if(_ignoreListManager) {
412     _ignoreListManager->deleteLater();
413     _ignoreListManager = 0;
414   }
415   // we probably don't want to save pending input for reconnect
416   _userInputBuffer.clear();
417
418   _messageModel->clear();
419   _networkModel->clear();
420
421   QHash<NetworkId, Network*>::iterator netIter = _networks.begin();
422   while(netIter != _networks.end()) {
423     Network *net = netIter.value();
424     emit networkRemoved(net->networkId());
425     disconnect(net, SIGNAL(destroyed()), this, 0);
426     netIter = _networks.erase(netIter);
427     net->deleteLater();
428   }
429   Q_ASSERT(_networks.isEmpty());
430
431   QHash<IdentityId, Identity *>::iterator idIter = _identities.begin();
432   while(idIter != _identities.end()) {
433     emit identityRemoved(idIter.key());
434     Identity *id = idIter.value();
435     idIter = _identities.erase(idIter);
436     id->deleteLater();
437   }
438   Q_ASSERT(_identities.isEmpty());
439
440   if(_networkConfig) {
441     _networkConfig->deleteLater();
442     _networkConfig = 0;
443   }
444 }
445
446 /*** ***/
447
448 void Client::networkDestroyed() {
449   Network *net = static_cast<Network *>(sender());
450   QHash<NetworkId, Network *>::iterator netIter = _networks.begin();
451   while(netIter != _networks.end()) {
452     if(*netIter == net) {
453       netIter = _networks.erase(netIter);
454       break;
455     } else {
456       netIter++;
457     }
458   }
459 }
460
461 // Hmm... we never used this...
462 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
463   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
464 }
465
466 void Client::recvMessage(const Message &msg) {
467   Message msg_ = msg;
468   messageProcessor()->process(msg_);
469 }
470
471 void Client::setBufferLastSeenMsg(BufferId id, const MsgId &msgId) {
472   if(bufferSyncer())
473     bufferSyncer()->requestSetLastSeenMsg(id, msgId);
474 }
475
476 void Client::setBufferMarkerLine(BufferId id, const MsgId &msgId) {
477   if(bufferSyncer())
478     bufferSyncer()->requestSetMarkerLine(id, msgId);
479 }
480
481 void Client::removeBuffer(BufferId id) {
482   if(!bufferSyncer()) return;
483   bufferSyncer()->requestRemoveBuffer(id);
484 }
485
486 void Client::renameBuffer(BufferId bufferId, const QString &newName) {
487   if(!bufferSyncer())
488     return;
489   bufferSyncer()->requestRenameBuffer(bufferId, newName);
490 }
491
492 void Client::mergeBuffersPermanently(BufferId bufferId1, BufferId bufferId2) {
493   if(!bufferSyncer())
494     return;
495   bufferSyncer()->requestMergeBuffersPermanently(bufferId1, bufferId2);
496 }
497
498 void Client::purgeKnownBufferIds() {
499   if(!bufferSyncer())
500     return;
501   bufferSyncer()->requestPurgeBufferIds();
502 }
503
504 void Client::bufferRemoved(BufferId bufferId) {
505   // select a sane buffer (status buffer)
506   /* we have to manually select a buffer because otherwise inconsitent changes
507    * to the model might occur:
508    * the result of a buffer removal triggers a change in the selection model.
509    * the newly selected buffer might be a channel that hasn't been selected yet
510    * and a new nickview would be created (which never heard of the "rowsAboutToBeRemoved").
511    * this new view (and/or) its sort filter will then only receive a "rowsRemoved" signal.
512    */
513   QModelIndex current = bufferModel()->currentIndex();
514   if(current.data(NetworkModel::BufferIdRole).value<BufferId>() == bufferId) {
515     bufferModel()->setCurrentIndex(current.sibling(0,0));
516   }
517
518   // and remove it from the model
519   networkModel()->removeBuffer(bufferId);
520 }
521
522 void Client::bufferRenamed(BufferId bufferId, const QString &newName) {
523   QModelIndex bufferIndex = networkModel()->bufferIndex(bufferId);
524   if(bufferIndex.isValid()) {
525     networkModel()->setData(bufferIndex, newName, Qt::DisplayRole);
526   }
527 }
528
529 void Client::buffersPermanentlyMerged(BufferId bufferId1, BufferId bufferId2) {
530   QModelIndex idx = networkModel()->bufferIndex(bufferId1);
531   bufferModel()->setCurrentIndex(bufferModel()->mapFromSource(idx));
532   networkModel()->removeBuffer(bufferId2);
533 }
534
535 void Client::logMessage(QtMsgType type, const char *msg) {
536   fprintf(stderr, "%s\n", msg);
537   fflush(stderr);
538   if(type == QtFatalMsg) {
539     Quassel::logFatalMessage(msg);
540   } else {
541     QString msgString = QString("%1\n").arg(msg);
542
543     //Check to see if there is an instance around, else we risk recursions
544     //when calling instance() and creating new ones.
545     if (!instanceExists())
546       return;
547
548     instance()->_debugLog << msgString;
549     emit instance()->logUpdated(msgString);
550   }
551 }