536f2f792560c386c132f02d1fc4781ac1e47a59
[quassel.git] / src / client / client.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 "client.h"
22
23 #include "bufferinfo.h"
24 #include "buffersyncer.h"
25 #include "clientbacklogmanager.h"
26 #include "bufferviewmanager.h"
27 #include "global.h"
28 #include "identity.h"
29 #include "ircchannel.h"
30 #include "ircuser.h"
31 #include "message.h"
32 #include "network.h"
33 #include "networkmodel.h"
34 #include "buffermodel.h"
35 #include "quasselui.h"
36 #include "signalproxy.h"
37 #include "util.h"
38 #include "buffersettings.h"
39
40 QPointer<Client> Client::instanceptr = 0;
41 AccountId Client::_currentCoreAccount = 0;
42
43 /*** Initialization/destruction ***/
44
45 Client *Client::instance() {
46   if(!instanceptr)
47     instanceptr = new Client();
48   return instanceptr;
49 }
50
51 void Client::destroy() {
52   //delete instanceptr;
53   instanceptr->deleteLater();
54 }
55
56 void Client::init(AbstractUi *ui) {
57   instance()->mainUi = ui;
58   instance()->init();
59 }
60
61 Client::Client(QObject *parent)
62   : QObject(parent),
63     socket(0),
64     _signalProxy(new SignalProxy(SignalProxy::Client, this)),
65     mainUi(0),
66     _networkModel(0),
67     _bufferModel(0),
68     _bufferSyncer(0),
69     _backlogManager(new ClientBacklogManager(this)),
70     _bufferViewManager(0),
71     _connectedToCore(false),
72     _syncedToCore(false)
73 {
74   _monitorBuffer = new Buffer(BufferInfo(), this);
75   connect(_backlogManager, SIGNAL(backlog(BufferId, const QVariantList &)),
76           this, SLOT(receiveBacklog(BufferId, const QVariantList &)));
77 }
78
79 Client::~Client() {
80   disconnectFromCore();
81 }
82
83 void Client::init() {
84   _currentCoreAccount = 0;
85   _networkModel = new NetworkModel(this);
86
87   connect(this, SIGNAL(bufferUpdated(BufferInfo)),
88           _networkModel, SLOT(bufferUpdated(BufferInfo)));
89   connect(this, SIGNAL(networkRemoved(NetworkId)),
90           _networkModel, SLOT(networkRemoved(NetworkId)));
91
92   _bufferModel = new BufferModel(_networkModel);
93
94   SignalProxy *p = signalProxy();
95
96   p->attachSlot(SIGNAL(displayMsg(const Message &)), this, SLOT(recvMessage(const Message &)));
97   p->attachSlot(SIGNAL(displayStatusMsg(QString, QString)), this, SLOT(recvStatusMsg(QString, QString)));
98
99   p->attachSlot(SIGNAL(bufferInfoUpdated(BufferInfo)), this, SLOT(updateBufferInfo(BufferInfo)));
100   p->attachSignal(this, SIGNAL(sendInput(BufferInfo, QString)));
101   p->attachSignal(this, SIGNAL(requestNetworkStates()));
102
103   p->attachSignal(this, SIGNAL(requestCreateIdentity(const Identity &)), SIGNAL(createIdentity(const Identity &)));
104   p->attachSignal(this, SIGNAL(requestUpdateIdentity(const Identity &)), SIGNAL(updateIdentity(const Identity &)));
105   p->attachSignal(this, SIGNAL(requestRemoveIdentity(IdentityId)), SIGNAL(removeIdentity(IdentityId)));
106   p->attachSlot(SIGNAL(identityCreated(const Identity &)), this, SLOT(coreIdentityCreated(const Identity &)));
107   p->attachSlot(SIGNAL(identityRemoved(IdentityId)), this, SLOT(coreIdentityRemoved(IdentityId)));
108
109   p->attachSignal(this, SIGNAL(requestCreateNetwork(const NetworkInfo &)), SIGNAL(createNetwork(const NetworkInfo &)));
110   p->attachSignal(this, SIGNAL(requestUpdateNetwork(const NetworkInfo &)), SIGNAL(updateNetwork(const NetworkInfo &)));
111   p->attachSignal(this, SIGNAL(requestRemoveNetwork(NetworkId)), SIGNAL(removeNetwork(NetworkId)));
112   p->attachSlot(SIGNAL(networkCreated(NetworkId)), this, SLOT(coreNetworkCreated(NetworkId)));
113   p->attachSlot(SIGNAL(networkRemoved(NetworkId)), this, SLOT(coreNetworkRemoved(NetworkId)));
114
115   connect(p, SIGNAL(disconnected()), this, SLOT(disconnectFromCore()));
116
117   //connect(mainUi, SIGNAL(connectToCore(const QVariantMap &)), this, SLOT(connectToCore(const QVariantMap &)));
118   connect(mainUi, SIGNAL(disconnectFromCore()), this, SLOT(disconnectFromCore()));
119   connect(this, SIGNAL(connected()), mainUi, SLOT(connectedToCore()));
120   connect(this, SIGNAL(disconnected()), mainUi, SLOT(disconnectedFromCore()));
121
122   layoutTimer = new QTimer(this);
123   layoutTimer->setInterval(0);
124   layoutTimer->setSingleShot(false);
125   connect(layoutTimer, SIGNAL(timeout()), this, SLOT(layoutMsg()));
126
127 }
128
129 /*** public static methods ***/
130
131 AccountId Client::currentCoreAccount() {
132   return _currentCoreAccount;
133 }
134
135 void Client::setCurrentCoreAccount(AccountId id) {
136   _currentCoreAccount = id;
137 }
138
139 QList<BufferInfo> Client::allBufferInfos() {
140   QList<BufferInfo> bufferids;
141   foreach(Buffer *buffer, buffers()) {
142     bufferids << buffer->bufferInfo();
143   }
144   return bufferids;
145 }
146
147 QList<Buffer *> Client::buffers() {
148   return instance()->_buffers.values();
149 }
150
151
152 Buffer *Client::statusBuffer(const NetworkId &networkId) const {
153   if(_statusBuffers.contains(networkId))
154     return _statusBuffers[networkId];
155   else
156     return 0;
157 }
158
159 Buffer *Client::buffer(BufferId bufferId) {
160   if(instance()->_buffers.contains(bufferId))
161     return instance()->_buffers[bufferId];
162   else
163     return 0;
164 }
165
166 Buffer *Client::buffer(BufferInfo bufferInfo) {
167   Buffer *buff = buffer(bufferInfo.bufferId());
168
169   if(!buff) {
170     Client *client = Client::instance();
171     buff = new Buffer(bufferInfo, client);
172     connect(buff, SIGNAL(destroyed()), client, SLOT(bufferDestroyed()));
173     client->_buffers[bufferInfo.bufferId()] = buff;
174     if(bufferInfo.type() == BufferInfo::StatusBuffer)
175       client->_statusBuffers[bufferInfo.networkId()] = buff;
176
177     emit client->bufferUpdated(bufferInfo);
178
179     // I don't like this: but currently there isn't really a prettier way:
180     if(isSynced()) {  // this slows down syncing a lot, so disable it during sync
181       QModelIndex bufferIdx = networkModel()->bufferIndex(bufferInfo.bufferId());
182       bufferModel()->setCurrentIndex(bufferModel()->mapFromSource(bufferIdx));
183     }
184   }
185   Q_ASSERT(buff);
186   return buff;
187 }
188
189 bool Client::isConnected() {
190   return instance()->_connectedToCore;
191 }
192
193 bool Client::isSynced() {
194   return instance()->_syncedToCore;
195 }
196
197 /*** Network handling ***/
198
199 QList<NetworkId> Client::networkIds() {
200   return instance()->_networks.keys();
201 }
202
203 const Network * Client::network(NetworkId networkid) {
204   if(instance()->_networks.contains(networkid)) return instance()->_networks[networkid];
205   else return 0;
206 }
207
208 void Client::createNetwork(const NetworkInfo &info) {
209   emit instance()->requestCreateNetwork(info);
210 }
211
212 void Client::updateNetwork(const NetworkInfo &info) {
213   emit instance()->requestUpdateNetwork(info);
214 }
215
216 void Client::removeNetwork(NetworkId id) {
217   emit instance()->requestRemoveNetwork(id);
218 }
219
220 void Client::addNetwork(Network *net) {
221   net->setProxy(signalProxy());
222   signalProxy()->synchronize(net);
223   networkModel()->attachNetwork(net);
224   connect(net, SIGNAL(destroyed()), instance(), SLOT(networkDestroyed()));
225   instance()->_networks[net->networkId()] = net;
226   emit instance()->networkCreated(net->networkId());
227 }
228
229 void Client::coreNetworkCreated(NetworkId id) {
230   if(_networks.contains(id)) {
231     qWarning() << "Creation of already existing network requested!";
232     return;
233   }
234   Network *net = new Network(id, this);
235   addNetwork(net);
236 }
237
238 void Client::coreNetworkRemoved(NetworkId id) {
239   if(!_networks.contains(id)) return;
240   Network *net = _networks.take(id);
241   emit networkRemoved(net->networkId());
242   net->deleteLater();
243 }
244
245 /*** Identity handling ***/
246
247 QList<IdentityId> Client::identityIds() {
248   return instance()->_identities.keys();
249 }
250
251 const Identity * Client::identity(IdentityId id) {
252   if(instance()->_identities.contains(id)) return instance()->_identities[id];
253   else return 0;
254 }
255
256 void Client::createIdentity(const Identity &id) {
257   emit instance()->requestCreateIdentity(id);
258 }
259
260 void Client::updateIdentity(const Identity &id) {
261   emit instance()->requestUpdateIdentity(id);
262 }
263
264 void Client::removeIdentity(IdentityId id) {
265   emit instance()->requestRemoveIdentity(id);
266 }
267
268 void Client::coreIdentityCreated(const Identity &other) {
269   if(!_identities.contains(other.id())) {
270     Identity *identity = new Identity(other, this);
271     _identities[other.id()] = identity;
272     identity->setInitialized();
273     signalProxy()->synchronize(identity);
274     emit identityCreated(other.id());
275   } else {
276     qWarning() << tr("Identity already exists in client!");
277   }
278 }
279
280 void Client::coreIdentityRemoved(IdentityId id) {
281   if(_identities.contains(id)) {
282     emit identityRemoved(id);
283     Identity *i = _identities.take(id);
284     i->deleteLater();
285   }
286 }
287
288 /***  ***/
289 void Client::userInput(BufferInfo bufferInfo, QString message) {
290   emit instance()->sendInput(bufferInfo, message);
291 }
292
293 /*** core connection stuff ***/
294
295 void Client::setConnectedToCore(QIODevice *sock, AccountId id) {
296   socket = sock;
297   signalProxy()->addPeer(socket);
298   _connectedToCore = true;
299   setCurrentCoreAccount(id);
300 }
301
302 void Client::setSyncedToCore() {
303   // create buffersyncer
304   Q_ASSERT(!_bufferSyncer);
305   _bufferSyncer = new BufferSyncer(this);
306   connect(bufferSyncer(), SIGNAL(lastSeenMsgSet(BufferId, MsgId)), this, SLOT(updateLastSeenMsg(BufferId, MsgId)));
307   connect(bufferSyncer(), SIGNAL(bufferRemoved(BufferId)), this, SLOT(bufferRemoved(BufferId)));
308   connect(bufferSyncer(), SIGNAL(bufferRenamed(BufferId, QString)), this, SLOT(bufferRenamed(BufferId, QString)));
309   signalProxy()->synchronize(bufferSyncer());
310
311   // attach backlog manager
312   signalProxy()->synchronize(backlogManager());
313
314   // create a new BufferViewManager
315   _bufferViewManager = new BufferViewManager(signalProxy(), this);
316   
317   _syncedToCore = true;
318   emit connected();
319   emit coreConnectionStateChanged(true);
320 }
321
322 void Client::setSecuredConnection() {
323   emit securedConnection();
324 }
325
326 void Client::disconnectFromCore() {
327   if(!isConnected())
328     return;
329   _connectedToCore = false;
330   
331   if(socket) {
332     socket->close();
333     socket->deleteLater();
334   }
335   _syncedToCore = false;
336   emit disconnected();
337   emit coreConnectionStateChanged(false);
338
339   // Clear internal data. Hopefully nothing relies on it at this point.
340   setCurrentCoreAccount(0);
341
342   if(_bufferSyncer) {
343     _bufferSyncer->deleteLater();
344     _bufferSyncer = 0;
345   }
346
347   if(_bufferViewManager) {
348     _bufferViewManager->deleteLater();
349     _bufferViewManager = 0;
350   }
351
352   _networkModel->clear();
353
354   QHash<BufferId, Buffer *>::iterator bufferIter =  _buffers.begin();
355   while(bufferIter != _buffers.end()) {
356     Buffer *buffer = bufferIter.value();
357     disconnect(buffer, SIGNAL(destroyed()), this, 0);
358     bufferIter = _buffers.erase(bufferIter);
359     buffer->deleteLater();
360   }
361   Q_ASSERT(_buffers.isEmpty());
362
363   _statusBuffers.clear();
364
365   QHash<NetworkId, Network*>::iterator netIter = _networks.begin();
366   while(netIter != _networks.end()) {
367     Network *net = netIter.value();
368     emit networkRemoved(net->networkId());
369     disconnect(net, SIGNAL(destroyed()), this, 0);
370     netIter = _networks.erase(netIter);
371     net->deleteLater();
372   }
373   Q_ASSERT(_networks.isEmpty());
374
375   QHash<IdentityId, Identity*>::iterator idIter = _identities.begin();
376   while(idIter != _identities.end()) {
377     Identity *id = idIter.value();
378     emit identityRemoved(id->id());
379     idIter = _identities.erase(idIter);
380     id->deleteLater();
381   }
382   Q_ASSERT(_identities.isEmpty());
383
384   layoutQueue.clear();
385   layoutTimer->stop();
386 }
387
388 void Client::setCoreConfiguration(const QVariantMap &settings) {
389   SignalProxy::writeDataToDevice(socket, settings);
390 }
391
392 /*** ***/
393
394 void Client::updateBufferInfo(BufferInfo id) {
395   emit bufferUpdated(id);
396 }
397
398 void Client::bufferDestroyed() {
399   Buffer *buffer = static_cast<Buffer *>(sender());
400   QHash<BufferId, Buffer *>::iterator iter = _buffers.begin();
401   while(iter != _buffers.end()) {
402     if(iter.value() == buffer) {
403       iter = _buffers.erase(iter);
404       break;
405     }
406     iter++;
407   }
408
409   QHash<NetworkId, Buffer *>::iterator statusIter = _statusBuffers.begin();
410   while(statusIter != _statusBuffers.end()) {
411     if(statusIter.value() == buffer) {
412       statusIter = _statusBuffers.erase(statusIter);
413       break;
414     }
415     statusIter++;
416   }
417 }
418
419 void Client::networkDestroyed() {
420   Network *net = static_cast<Network *>(sender());
421   QHash<NetworkId, Network *>::iterator netIter = _networks.begin();
422   while(netIter != _networks.end()) {
423     if(*netIter == net) {
424       netIter = _networks.erase(netIter);
425       break;
426     } else {
427       netIter++;
428     }
429   }
430 }
431
432 void Client::recvMessage(const Message &message) {
433   Message msg = message;
434   Buffer *b;
435
436   checkForHighlight(msg);
437
438   // FIXME clean up code! (dup)
439
440   if(msg.flags() & Message::Redirected) {
441     BufferSettings bufferSettings;
442     bool inStatus = bufferSettings.value("UserMessagesInStatusBuffer", QVariant(true)).toBool();
443     bool inQuery = bufferSettings.value("UserMessagesInQueryBuffer", QVariant(false)).toBool();
444     bool inCurrent = bufferSettings.value("UserMessagesInCurrentBuffer", QVariant(false)).toBool();
445
446     if(inStatus) {
447       b = statusBuffer(msg.bufferInfo().networkId());
448       if(b) {
449         b->appendMsg(msg);
450       } else if(!inQuery && !inCurrent) {       // make sure the message get's shown somewhere
451         b = buffer(msg.bufferInfo());
452         b->appendMsg(msg);
453       }
454     }
455
456     if(inQuery) {
457       b = buffer(msg.bufferInfo().bufferId());
458       if(b) {
459         b->appendMsg(msg);
460       } else if(!inStatus && !inCurrent) { // make sure the message get's shown somewhere
461         b = statusBuffer(msg.bufferInfo().networkId());
462       if(!b) b = buffer(msg.bufferInfo()); // seems like we have to create the buffer anyways...
463       b->appendMsg(msg);
464       }
465     }
466
467     if(inCurrent) {
468       BufferId currentId = bufferModel()->currentIndex().data(NetworkModel::BufferIdRole).value<BufferId>();
469       b = buffer(currentId);
470       if(b && currentId != msg.bufferInfo().bufferId() && !inQuery) {
471         b->appendMsg(msg);
472       } else if(!inStatus && !inQuery) {        // make sure the message get's shown somewhere
473         b = statusBuffer(msg.bufferInfo().networkId());
474         if(!b) b = buffer(msg.bufferInfo()); // seems like we have to create the buffer anyways...
475         b->appendMsg(msg);
476       }
477     }
478   } else {
479     // the regular case: we can deliver where it was supposed to go
480     b = buffer(msg.bufferInfo());
481     b->appendMsg(msg);
482   }
483   
484   //bufferModel()->updateBufferActivity(msg);
485
486   if(msg.type() == Message::Plain || msg.type() == Message::Notice || msg.type() == Message::Action) {
487     const Network *net = network(msg.bufferInfo().networkId());
488     QString networkName = net != 0
489       ? net->networkName() + ":"
490       : QString();
491     QString sender = networkName + msg.bufferInfo().bufferName() + ":" + msg.sender();
492     Message mmsg = Message(msg.timestamp(), msg.bufferInfo(), msg.type(), msg.text(), sender, msg.flags());
493     monitorBuffer()->appendMsg(mmsg);
494   }
495
496   emit messageReceived(msg);
497 }
498
499 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
500   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
501 }
502
503 void Client::receiveBacklog(BufferId bufferId, const QVariantList &msgs) {
504   Buffer *buffer_ = buffer(bufferId);
505   if(!buffer_) {
506     qWarning() << "Client::receiveBacklog(): received Backlog for unknown Buffer:" << bufferId;
507     return;
508   }
509
510   if(msgs.isEmpty())
511     return; // no work to be done...
512   
513   QVariantList::const_iterator msgIter = msgs.constBegin();
514   QVariantList::const_iterator msgIterEnd = msgs.constEnd();
515   Message msg;
516   while(msgIter != msgIterEnd) {
517     msg = (*msgIter).value<Message>();
518     checkForHighlight(msg);
519     buffer_->prependMsg(msg);
520     msgIter++;
521   }
522
523   if(!layoutQueue.contains(buffer_))
524     layoutQueue.append(buffer_);
525
526   if(!layoutTimer->isActive()) {
527     layoutTimer->start();
528   }
529 }
530
531 void Client::layoutMsg() {
532   if(layoutQueue.isEmpty()) {
533     layoutTimer->stop();
534     return;
535   }
536   
537   Buffer *buffer = layoutQueue.takeFirst();
538   if(buffer->layoutMsg()) {
539     layoutQueue.append(buffer);  // Buffer has more messages in its queue --> Round Robin
540     return;
541   }
542
543   if(layoutQueue.isEmpty())
544     layoutTimer->stop();
545 }
546
547 AbstractUiMsg *Client::layoutMsg(const Message &msg) {
548   return instance()->mainUi->layoutMsg(msg);
549 }
550
551 void Client::checkForHighlight(Message &msg) {
552   NotificationSettings notificationSettings;
553   const Network *net = network(msg.bufferInfo().networkId());
554   if(net && !net->myNick().isEmpty()) {
555     QStringList nickList;
556     if(notificationSettings.highlightNick() == NotificationSettings::CurrentNick) {
557       nickList << net->myNick();
558     } else if(notificationSettings.highlightNick() == NotificationSettings::AllNicks) {
559       nickList = identity(net->identity())->nicks();
560     }
561     foreach(QString nickname, nickList) {
562       QRegExp nickRegExp("^(.*\\W)?" + QRegExp::escape(nickname) + "(\\W.*)?$");
563       if((msg.type() & (Message::Plain | Message::Notice | Message::Action))
564           && !(msg.flags() & Message::Self)
565           && nickRegExp.exactMatch(msg.text())) {
566         msg.setFlags(msg.flags() | Message::Highlight);
567         return;
568       }
569     }
570
571     foreach(QVariant highlight, notificationSettings.highlightList()) {
572       QVariantMap highlightRule = highlight.toMap();
573       if(!highlightRule["enable"].toBool())
574         continue;
575       Qt::CaseSensitivity caseSensitivity = highlightRule["cs"].toBool() ? Qt::CaseSensitive : Qt::CaseInsensitive;
576       QString name = highlightRule["name"].toString();
577       QRegExp userRegExp;
578       if(highlightRule["regex"].toBool()) {
579         userRegExp = QRegExp(name, caseSensitivity);
580       } else {
581         userRegExp = QRegExp("^(.*\\W)?" + QRegExp::escape(name) + "(\\W.*)?$", caseSensitivity);
582       }
583       if((msg.type() & (Message::Plain | Message::Notice | Message::Action))
584           && !(msg.flags() & Message::Self)
585           && userRegExp.exactMatch(msg.text())) {
586         msg.setFlags(msg.flags() | Message::Highlight);
587         return;
588       }
589     }
590   }
591 }
592
593 void Client::updateLastSeenMsg(BufferId id, const MsgId &msgId) {
594   Buffer *b = buffer(id);
595   if(!b) {
596     qWarning() << "Client::updateLastSeen(): Unknown buffer" << id;
597     return;
598   }
599   b->setLastSeenMsg(msgId);
600 }
601
602 void Client::setBufferLastSeenMsg(BufferId id, const MsgId &msgId) {
603   if(!bufferSyncer())
604     return;
605   bufferSyncer()->requestSetLastSeenMsg(id, msgId);
606 }
607
608 void Client::removeBuffer(BufferId id) {
609   if(!bufferSyncer()) return;
610   bufferSyncer()->requestRemoveBuffer(id);
611 }
612
613 void Client::bufferRemoved(BufferId bufferId) {
614   // first remove the buffer from has. this prohibits further lastSeenUpdates
615   Buffer *buff = 0;
616   if(_buffers.contains(bufferId)) {
617     buff = _buffers.take(bufferId);
618     disconnect(buff, 0, this, 0);
619   }
620
621   // then we select a sane buffer (status buffer)
622   /* we have to manually select a buffer because otherwise inconsitent changes
623    * to the model might occur:
624    * the result of a buffer removal triggers a change in the selection model.
625    * the newly selected buffer might be a channel that hasn't been selected yet
626    * and a new nickview would be created (which never heard of the "rowsAboutToBeRemoved").
627    * this new view (and/or) its sort filter will then only receive a "rowsRemoved" signal.
628    */
629   QModelIndex current = bufferModel()->currentIndex();
630   if(current.data(NetworkModel::BufferIdRole).value<BufferId>() == bufferId) {
631     bufferModel()->setCurrentIndex(current.sibling(0,0));
632   }
633
634   // and remove it from the model
635   networkModel()->removeBuffer(bufferId);
636
637   if(buff)
638     buff->deleteLater();
639 }
640
641 void Client::bufferRenamed(BufferId bufferId, const QString &newName) {
642   QModelIndex bufferIndex = networkModel()->bufferIndex(bufferId);
643   if(bufferIndex.isValid()) {
644     networkModel()->setData(bufferIndex, newName, Qt::DisplayRole);
645   }
646 }