Merging r730:732 from trunk to branches/0.3. Forwardports fancy bufferviews.
[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   setCurrentCoreAccount(0);
337   emit disconnected();
338   emit coreConnectionStateChanged(false);
339
340   // Clear internal data. Hopefully nothing relies on it at this point.
341   if(_bufferSyncer) {
342     _bufferSyncer->deleteLater();
343     _bufferSyncer = 0;
344   }
345
346   if(_bufferViewManager) {
347     _bufferViewManager->deleteLater();
348     _bufferViewManager = 0;
349   }
350
351   _networkModel->clear();
352
353   QHash<BufferId, Buffer *>::iterator bufferIter =  _buffers.begin();
354   while(bufferIter != _buffers.end()) {
355     Buffer *buffer = bufferIter.value();
356     disconnect(buffer, SIGNAL(destroyed()), this, 0);
357     bufferIter = _buffers.erase(bufferIter);
358     buffer->deleteLater();
359   }
360   Q_ASSERT(_buffers.isEmpty());
361
362   _statusBuffers.clear();
363
364   QHash<NetworkId, Network*>::iterator netIter = _networks.begin();
365   while(netIter != _networks.end()) {
366     Network *net = netIter.value();
367     emit networkRemoved(net->networkId());
368     disconnect(net, SIGNAL(destroyed()), this, 0);
369     netIter = _networks.erase(netIter);
370     net->deleteLater();
371   }
372   Q_ASSERT(_networks.isEmpty());
373
374   QHash<IdentityId, Identity*>::iterator idIter = _identities.begin();
375   while(idIter != _identities.end()) {
376     Identity *id = idIter.value();
377     emit identityRemoved(id->id());
378     idIter = _identities.erase(idIter);
379     id->deleteLater();
380   }
381   Q_ASSERT(_identities.isEmpty());
382
383   layoutQueue.clear();
384   layoutTimer->stop();
385 }
386
387 void Client::setCoreConfiguration(const QVariantMap &settings) {
388   SignalProxy::writeDataToDevice(socket, settings);
389 }
390
391 /*** ***/
392
393 void Client::updateBufferInfo(BufferInfo id) {
394   emit bufferUpdated(id);
395 }
396
397 void Client::bufferDestroyed() {
398   Buffer *buffer = static_cast<Buffer *>(sender());
399   QHash<BufferId, Buffer *>::iterator iter = _buffers.begin();
400   while(iter != _buffers.end()) {
401     if(iter.value() == buffer) {
402       iter = _buffers.erase(iter);
403       break;
404     }
405     iter++;
406   }
407
408   QHash<NetworkId, Buffer *>::iterator statusIter = _statusBuffers.begin();
409   while(statusIter != _statusBuffers.end()) {
410     if(statusIter.value() == buffer) {
411       statusIter = _statusBuffers.erase(statusIter);
412       break;
413     }
414     statusIter++;
415   }
416 }
417
418 void Client::networkDestroyed() {
419   Network *net = static_cast<Network *>(sender());
420   QHash<NetworkId, Network *>::iterator netIter = _networks.begin();
421   while(netIter != _networks.end()) {
422     if(*netIter == net) {
423       netIter = _networks.erase(netIter);
424       break;
425     } else {
426       netIter++;
427     }
428   }
429 }
430
431 void Client::recvMessage(const Message &message) {
432   Message msg = message;
433   Buffer *b;
434
435   checkForHighlight(msg);
436
437   // FIXME clean up code! (dup)
438
439   if(msg.flags() & Message::Redirected) {
440     BufferSettings bufferSettings;
441     bool inStatus = bufferSettings.value("UserMessagesInStatusBuffer", QVariant(true)).toBool();
442     bool inQuery = bufferSettings.value("UserMessagesInQueryBuffer", QVariant(false)).toBool();
443     bool inCurrent = bufferSettings.value("UserMessagesInCurrentBuffer", QVariant(false)).toBool();
444
445     if(inStatus) {
446       b = statusBuffer(msg.bufferInfo().networkId());
447       if(b) {
448         b->appendMsg(msg);
449       } else if(!inQuery && !inCurrent) {       // make sure the message get's shown somewhere
450         b = buffer(msg.bufferInfo());
451         b->appendMsg(msg);
452       }
453     }
454
455     if(inQuery) {
456       b = buffer(msg.bufferInfo().bufferId());
457       if(b) {
458         b->appendMsg(msg);
459       } else if(!inStatus && !inCurrent) { // make sure the message get's shown somewhere
460         b = statusBuffer(msg.bufferInfo().networkId());
461       if(!b) b = buffer(msg.bufferInfo()); // seems like we have to create the buffer anyways...
462       b->appendMsg(msg);
463       }
464     }
465
466     if(inCurrent) {
467       BufferId currentId = bufferModel()->currentIndex().data(NetworkModel::BufferIdRole).value<BufferId>();
468       b = buffer(currentId);
469       if(b && currentId != msg.bufferInfo().bufferId() && !inQuery) {
470         b->appendMsg(msg);
471       } else if(!inStatus && !inQuery) {        // make sure the message get's shown somewhere
472         b = statusBuffer(msg.bufferInfo().networkId());
473         if(!b) b = buffer(msg.bufferInfo()); // seems like we have to create the buffer anyways...
474         b->appendMsg(msg);
475       }
476     }
477   } else {
478     // the regular case: we can deliver where it was supposed to go
479     b = buffer(msg.bufferInfo());
480     b->appendMsg(msg);
481   }
482   
483   //bufferModel()->updateBufferActivity(msg);
484
485   if(msg.type() == Message::Plain || msg.type() == Message::Notice || msg.type() == Message::Action) {
486     const Network *net = network(msg.bufferInfo().networkId());
487     QString networkName = net != 0
488       ? net->networkName() + ":"
489       : QString();
490     QString sender = networkName + msg.bufferInfo().bufferName() + ":" + msg.sender();
491     Message mmsg = Message(msg.timestamp(), msg.bufferInfo(), msg.type(), msg.text(), sender, msg.flags());
492     monitorBuffer()->appendMsg(mmsg);
493   }
494
495   emit messageReceived(msg);
496 }
497
498 void Client::recvStatusMsg(QString /*net*/, QString /*msg*/) {
499   //recvMessage(net, Message::server("", QString("[STATUS] %1").arg(msg)));
500 }
501
502 void Client::receiveBacklog(BufferId bufferId, const QVariantList &msgs) {
503   Buffer *buffer_ = buffer(bufferId);
504   if(!buffer_) {
505     qWarning() << "Client::recvBacklogData(): received Backlog for unknown Buffer:" << bufferId;
506     return;
507   }
508
509   if(msgs.isEmpty())
510     return; // no work to be done...
511   
512   QVariantList::const_iterator msgIter = msgs.constBegin();
513   QVariantList::const_iterator msgIterEnd = msgs.constEnd();
514   Message msg;
515   while(msgIter != msgIterEnd) {
516     msg = (*msgIter).value<Message>();
517     checkForHighlight(msg);
518     buffer_->prependMsg(msg);
519     msgIter++;
520   }
521
522   if(!layoutQueue.contains(buffer_))
523     layoutQueue.append(buffer_);
524
525   if(!layoutTimer->isActive()) {
526     layoutTimer->start();
527   }
528 }
529
530 void Client::layoutMsg() {
531   if(layoutQueue.isEmpty()) {
532     layoutTimer->stop();
533     return;
534   }
535   
536   Buffer *buffer = layoutQueue.takeFirst();
537   if(buffer->layoutMsg()) {
538     layoutQueue.append(buffer);  // Buffer has more messages in its queue --> Round Robin
539     return;
540   } 
541
542   if(layoutQueue.isEmpty())
543     layoutTimer->stop();
544 }
545
546 AbstractUiMsg *Client::layoutMsg(const Message &msg) {
547   return instance()->mainUi->layoutMsg(msg);
548 }
549
550 void Client::checkForHighlight(Message &msg) {
551   NotificationSettings notificationSettings;
552   const Network *net = network(msg.bufferInfo().networkId());
553   if(net && !net->myNick().isEmpty()) {
554     QStringList nickList;
555     if(notificationSettings.highlightNick() == NotificationSettings::CurrentNick) {
556       nickList << net->myNick();
557     } else if(notificationSettings.highlightNick() == NotificationSettings::AllNicks) {
558       nickList = identity(net->identity())->nicks();
559     }
560     foreach(QString nickname, nickList) {
561       QRegExp nickRegExp("^(.*\\W)?" + QRegExp::escape(nickname) + "(\\W.*)?$");
562       if((msg.type() & (Message::Plain | Message::Notice | Message::Action))
563           && !(msg.flags() & Message::Self)
564           && nickRegExp.exactMatch(msg.text())) {
565         msg.setFlags(msg.flags() | Message::Highlight);
566         return;
567       }
568     }
569
570     foreach(QVariant highlight, notificationSettings.highlightList()) {
571       QVariantMap highlightRule = highlight.toMap();
572       if(!highlightRule["enable"].toBool())
573         continue;
574       Qt::CaseSensitivity caseSensitivity = highlightRule["cs"].toBool() ? Qt::CaseSensitive : Qt::CaseInsensitive;
575       QString name = highlightRule["name"].toString();
576       QRegExp userRegExp;
577       if(highlightRule["regex"].toBool()) {
578         userRegExp = QRegExp(name, caseSensitivity);
579       } else {
580         userRegExp = QRegExp("^(.*\\W)?" + QRegExp::escape(name) + "(\\W.*)?$", caseSensitivity);
581       }
582       if((msg.type() & (Message::Plain | Message::Notice | Message::Action))
583           && !(msg.flags() & Message::Self)
584           && userRegExp.exactMatch(msg.text())) {
585         msg.setFlags(msg.flags() | Message::Highlight);
586         return;
587       }
588     }
589   }
590 }
591
592 void Client::updateLastSeenMsg(BufferId id, const MsgId &msgId) {
593   Buffer *b = buffer(id);
594   if(!b) {
595     qWarning() << "Client::updateLastSeen(): Unknown buffer" << id;
596     return;
597   }
598   b->setLastSeenMsg(msgId);
599 }
600
601 void Client::setBufferLastSeenMsg(BufferId id, const MsgId &msgId) {
602   if(!bufferSyncer())
603     return;
604   bufferSyncer()->requestSetLastSeenMsg(id, msgId);
605 }
606
607 void Client::removeBuffer(BufferId id) {
608   if(!bufferSyncer()) return;
609   bufferSyncer()->requestRemoveBuffer(id);
610 }
611
612 void Client::bufferRemoved(BufferId bufferId) {
613   // first remove the buffer from has. this prohibits further lastSeenUpdates
614   Buffer *buff = 0;
615   if(_buffers.contains(bufferId)) {
616     buff = _buffers.take(bufferId);
617     disconnect(buff, 0, this, 0);
618   }
619
620   // then we select a sane buffer (status buffer)
621   /* we have to manually select a buffer because otherwise inconsitent changes
622    * to the model might occur:
623    * the result of a buffer removal triggers a change in the selection model.
624    * the newly selected buffer might be a channel that hasn't been selected yet
625    * and a new nickview would be created (which never heard of the "rowsAboutToBeRemoved").
626    * this new view (and/or) its sort filter will then only receive a "rowsRemoved" signal.
627    */
628   QModelIndex current = bufferModel()->currentIndex();
629   if(current.data(NetworkModel::BufferIdRole).value<BufferId>() == bufferId) {
630     bufferModel()->setCurrentIndex(current.sibling(0,0));
631   }
632
633   // and remove it from the model
634   networkModel()->removeBuffer(bufferId);
635
636   if(buff)
637     buff->deleteLater();
638 }
639
640 void Client::bufferRenamed(BufferId bufferId, const QString &newName) {
641   QModelIndex bufferIndex = networkModel()->bufferIndex(bufferId);
642   if(bufferIndex.isValid()) {
643     networkModel()->setData(bufferIndex, newName, Qt::DisplayRole);
644   }
645 }