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