Fixing Issues with the NetworkModel. Though the performance still
[quassel.git] / src / client / networkmodel.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 "networkmodel.h"
22
23 #include <QAbstractItemView>
24
25 #include "bufferinfo.h"
26 #include "client.h"
27 #include "signalproxy.h"
28 #include "network.h"
29 #include "ircchannel.h"
30 #include "ircuser.h"
31
32 #include "util.h" // get rid of this (needed for isChannelName)
33
34 /*****************************************
35 *  Fancy Buffer Items
36 *****************************************/
37 BufferItem::BufferItem(BufferInfo bufferInfo, AbstractTreeItem *parent)
38   : PropertyMapItem(QStringList() << "bufferName" << "topic" << "nickCount", parent),
39     _bufferInfo(bufferInfo),
40     _activity(NoActivity)
41 {
42   // determine BufferType
43   if(bufferInfo.buffer().isEmpty())
44     _type = StatusType;
45   else if(isChannelName(bufferInfo.buffer()))
46     _type = ChannelType;
47   else
48     _type = QueryType;
49
50   Qt::ItemFlags flags = Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemIsDragEnabled;
51   if(bufferType() == QueryType)
52     flags |= Qt::ItemIsDropEnabled;
53   setFlags(flags);
54 }
55
56
57 const BufferInfo &BufferItem::bufferInfo() const {
58   return _bufferInfo;
59 }
60
61 quint64 BufferItem::id() const {
62   return bufferInfo().uid().toInt();
63 }
64
65 bool BufferItem::isStatusBuffer() const {
66    return bufferType() == StatusType;
67 }
68
69 BufferItem::Type BufferItem::bufferType() const {
70   return _type;
71 }
72
73 bool BufferItem::isActive() const {
74   if(bufferType() == ChannelType)
75     return _ircChannel;
76   else
77     return qobject_cast<NetworkItem *>(parent())->isActive();
78 }
79
80 BufferItem::ActivityLevel BufferItem::activity() const {
81   return _activity;
82 }
83
84 void BufferItem::setActivity(const ActivityLevel &level) {
85   _activity = level;
86 }
87
88 void BufferItem::addActivity(const ActivityLevel &level) {
89   _activity |= level;
90 }
91
92 QVariant BufferItem::data(int column, int role) const {
93   switch(role) {
94   case NetworkModel::ItemTypeRole:
95     return NetworkModel::BufferItemType;
96   case NetworkModel::BufferIdRole:
97     return qVariantFromValue(bufferInfo().uid());
98   case NetworkModel::NetworkIdRole:
99     return qVariantFromValue(bufferInfo().networkId());
100   case NetworkModel::BufferTypeRole:
101     return int(bufferType());
102   case NetworkModel::ItemActiveRole:
103     return isActive();
104   default:
105     return PropertyMapItem::data(column, role);
106   }
107 }
108
109 void BufferItem::attachIrcChannel(IrcChannel *ircChannel) {
110   if(!ircChannel)
111     return;
112   
113   _ircChannel = ircChannel;
114
115   connect(ircChannel, SIGNAL(topicSet(QString)),
116           this, SLOT(setTopic(QString)));
117   connect(ircChannel, SIGNAL(ircUserJoined(IrcUser *)),
118           this, SLOT(join(IrcUser *)));
119   connect(ircChannel, SIGNAL(ircUserParted(IrcUser *)),
120           this, SLOT(part(IrcUser *)));
121   connect(ircChannel, SIGNAL(destroyed()),
122           this, SLOT(ircChannelDestroyed()));
123   connect(ircChannel, SIGNAL(ircUserModesSet(IrcUser *, QString)),
124           this, SLOT(userModeChanged(IrcUser *)));
125   connect(ircChannel, SIGNAL(ircUserModeAdded(IrcUser *, QString)),
126           this, SLOT(userModeChanged(IrcUser *)));
127   connect(ircChannel, SIGNAL(ircUserModeRemoved(IrcUser *, QString)),
128           this, SLOT(userModeChanged(IrcUser *)));
129   
130   emit dataChanged();
131 }
132
133 void BufferItem::ircChannelDestroyed() {
134   emit dataChanged();
135   removeAllChilds();
136 }
137
138 QString BufferItem::bufferName() const {
139   if(bufferType() == StatusType)
140     return tr("Status Buffer");
141   else
142     return bufferInfo().buffer();
143 }
144
145 QString BufferItem::topic() const {
146   if(_ircChannel)
147     return _ircChannel->topic();
148   else
149     return QString();
150 }
151
152 int BufferItem::nickCount() const {
153   if(_ircChannel)
154     return _ircChannel->ircUsers().count();
155   else
156     return 0;
157 }
158
159 void BufferItem::setTopic(const QString &topic) {
160   Q_UNUSED(topic);
161   emit dataChanged(1);
162 }
163
164 void BufferItem::join(IrcUser *ircUser) {
165   if(!ircUser)
166     return;
167
168   addUserToCategory(ircUser);
169   emit dataChanged(2);
170 }
171
172 void BufferItem::addUserToCategory(IrcUser *ircUser) {
173   Q_ASSERT(_ircChannel);
174   
175   UserCategoryItem *categoryItem;
176   int categoryId = UserCategoryItem::categoryFromModes(_ircChannel->userModes(ircUser));
177   if(!(categoryItem = qobject_cast<UserCategoryItem *>(childById(qHash(categoryId))))) {
178     categoryItem = new UserCategoryItem(categoryId, this);
179     emit newChild(categoryItem);
180   }
181   
182   categoryItem->addUser(ircUser);
183 }
184
185 void BufferItem::part(IrcUser *ircUser) {
186   Q_UNUSED(ircUser);
187   emit dataChanged(2);
188 }
189
190 void BufferItem::removeUserFromCategory(IrcUser *ircUser) {
191   UserCategoryItem *categoryItem = 0;
192   IrcUserItem *userItem;
193   for(int i = 0; i < childCount(); i++) {
194     categoryItem = qobject_cast<UserCategoryItem *>(child(i));
195     if((userItem = qobject_cast<IrcUserItem *>(categoryItem->childById((quint64)ircUser)))) {
196       userItem->deleteLater();
197       return;
198     }
199   }
200 }
201
202 void BufferItem::userModeChanged(IrcUser *ircUser) {
203   Q_ASSERT(_ircChannel);
204     
205   UserCategoryItem *categoryItem;
206   int categoryId = UserCategoryItem::categoryFromModes(_ircChannel->userModes(ircUser));
207   if((categoryItem = qobject_cast<UserCategoryItem *>(childById(qHash(categoryId)))))
208     return; // already in the right category;
209   
210   removeUserFromCategory(ircUser);
211   addUserToCategory(ircUser);
212 }
213
214 /*****************************************
215 *  Network Items
216 *****************************************/
217 NetworkItem::NetworkItem(const NetworkId &netid, AbstractTreeItem *parent)
218   : PropertyMapItem(QList<QString>() << "networkName" << "currentServer" << "nickCount", parent),
219     _networkId(netid)
220 {
221   setFlags(Qt::ItemIsEnabled);
222 }
223
224 QVariant NetworkItem::data(int column, int role) const {
225   switch(role) {
226   case NetworkModel::NetworkIdRole:
227     return qVariantFromValue(_networkId);
228   case NetworkModel::ItemTypeRole:
229     return NetworkModel::NetworkItemType;
230   case NetworkModel::ItemActiveRole:
231     return isActive();
232   default:
233     return PropertyMapItem::data(column, role);
234   }
235 }
236
237 quint64 NetworkItem::id() const {
238   return _networkId.toInt();
239 }
240
241 bool NetworkItem::isActive() const {
242   return _network;
243 }
244
245 QString NetworkItem::networkName() const {
246   if(_network)
247     return _network->networkName();
248   else
249     return QString();
250 }
251
252 QString NetworkItem::currentServer() const {
253   if(_network)
254     return _network->currentServer();
255   else
256     return QString();
257 }
258
259 int NetworkItem::nickCount() const {
260   if(_network)
261     return _network->ircUsers().count();
262   else
263     return 0;
264 }
265
266 void NetworkItem::attachNetwork(Network *network) {
267   if(!network)
268     return;
269   
270   _network = network;
271
272   connect(network, SIGNAL(networkNameSet(QString)),
273           this, SLOT(setNetworkName(QString)));
274   connect(network, SIGNAL(currentServerSet(QString)),
275           this, SLOT(setCurrentServer(QString)));
276   connect(network, SIGNAL(ircChannelAdded(QString)),
277           this, SLOT(attachIrcChannel(QString)));
278   // FIXME: connect this and that...
279
280   emit dataChanged();
281 }
282
283 void NetworkItem::attachIrcChannel(const QString &channelName) {
284   IrcChannel *ircChannel = _network->ircChannel(channelName);
285   if(!ircChannel) {
286     qWarning() << "NetworkItem::attachIrcChannel(): unkown Channel" << channelName;
287     return;
288   }
289   
290   BufferItem *bufferItem;
291   for(int i = 0; i < childCount(); i++) {
292     bufferItem = qobject_cast<BufferItem *>(child(i));
293     if(bufferItem->bufferName() == ircChannel->name()) {
294       bufferItem->attachIrcChannel(ircChannel);
295       break;
296     }
297   }
298 }
299
300 void NetworkItem::setNetworkName(const QString &networkName) {
301   Q_UNUSED(networkName);
302   emit dataChanged(0);
303 }
304
305 void NetworkItem::setCurrentServer(const QString &serverName) {
306   Q_UNUSED(serverName);
307   emit dataChanged(1);
308 }
309
310 /*****************************************
311 *  User Category Items (like @vh etc.)
312 *****************************************/
313 // we hardcode this even though we have PREFIX in network... but that wouldn't help with mapping modes to
314 // category strings anyway.
315 const QList<UserCategoryItem::Category> UserCategoryItem::categories = QList<UserCategoryItem::Category>() << UserCategoryItem::Category('q', "Owners")
316                                                                                                            << UserCategoryItem::Category('a', "Admins")
317                                                                                                            << UserCategoryItem::Category('a', "Admins")
318                                                                                                            << UserCategoryItem::Category('o', "Operators")
319                                                                                                            << UserCategoryItem::Category('h', "Half-Ops")
320                                                                                                            << UserCategoryItem::Category('v', "Voiced");
321
322 UserCategoryItem::UserCategoryItem(int category, AbstractTreeItem *parent)
323   : PropertyMapItem(QStringList() << "categoryId", parent),
324     _category(category)
325 {
326   connect(this, SIGNAL(childRemoved(int)),
327           this, SLOT(checkNoChilds()));
328 }
329
330 QString UserCategoryItem::categoryId() {
331   if(_category < categories.count())
332     return categories[_category].displayString;
333   else
334     return QString("Users");
335 }
336
337 void UserCategoryItem::checkNoChilds() {
338   if(childCount() == 0)
339     deleteLater();
340 }
341
342 quint64 UserCategoryItem::id() const {
343   return qHash(_category);
344 }
345
346 void UserCategoryItem::addUser(IrcUser *ircUser) {
347   emit newChild(new IrcUserItem(ircUser, this));
348 }
349
350 int UserCategoryItem::categoryFromModes(const QString &modes) {
351   for(int i = 0; i < categories.count(); i++) {
352     if(modes.contains(categories[i].mode))
353       return i;
354   }
355   return categories.count();
356 }
357      
358 /*****************************************
359 *  Irc User Items
360 *****************************************/
361 IrcUserItem::IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent)
362   : PropertyMapItem(QStringList() << "nickName", parent),
363     _ircUser(ircUser)
364 {
365   connect(ircUser, SIGNAL(destroyed()),
366           this, SLOT(ircUserDestroyed()));
367   
368   connect(ircUser, SIGNAL(nickSet(QString)),
369           this, SLOT(setNick(QString)));
370 }
371
372 QString IrcUserItem::nickName() {
373   return _ircUser->nick();
374 }
375
376 IrcUser *IrcUserItem::ircUser() {
377   return _ircUser;
378 }
379
380 quint64 IrcUserItem::id() const {
381   return (quint64)_ircUser;
382 }
383
384 void IrcUserItem::setNick(QString newNick) {
385   Q_UNUSED(newNick);
386   emit dataChanged(0);
387 }
388 void IrcUserItem::ircUserDestroyed() {
389   deleteLater();
390 }
391
392 /*****************************************
393  * NetworkModel
394  *****************************************/
395 NetworkModel::NetworkModel(QObject *parent)
396   : TreeModel(NetworkModel::defaultHeader(), parent)
397 {
398 }
399
400 QList<QVariant >NetworkModel::defaultHeader() {
401   QList<QVariant> data;
402   data << tr("Buffer") << tr("Topic") << tr("Nick Count");
403   return data;
404 }
405
406 bool NetworkModel::isBufferIndex(const QModelIndex &index) const {
407   return index.data(NetworkModel::ItemTypeRole) == NetworkModel::BufferItemType;
408 }
409
410 /*
411 Buffer *NetworkModel::getBufferByIndex(const QModelIndex &index) const {
412   BufferItem *item = static_cast<BufferItem *>(index.internalPointer());
413   return Client::instance()->buffer(item->id());
414 }
415 */
416
417
418 // experimental stuff :)
419 QModelIndex NetworkModel::networkIndex(NetworkId networkId) {
420   return indexById(networkId.toInt());
421 }
422
423 NetworkItem *NetworkModel::existsNetworkItem(NetworkId networkId) {
424   return qobject_cast<NetworkItem *>(rootItem->childById(networkId.toInt()));
425 }
426
427 NetworkItem *NetworkModel::networkItem(NetworkId networkId) {
428   NetworkItem *netItem = existsNetworkItem(networkId);
429
430   if(netItem == 0) {
431     netItem = new NetworkItem(networkId, rootItem);
432     appendChild(rootItem, netItem);
433   }
434
435   Q_ASSERT(netItem);
436   return netItem;
437 }
438
439 QModelIndex NetworkModel::bufferIndex(BufferId bufferId) {
440   AbstractTreeItem *netItem, *bufferItem;
441   for(int i = 0; i < rootItem->childCount(); i++) {
442     netItem = rootItem->child(i);
443     if((bufferItem = netItem->childById(bufferId.toInt()))) {
444       return indexById(bufferItem->id(), networkIndex(netItem->id()));
445     }
446   }
447   return QModelIndex();
448 }
449
450 BufferItem *NetworkModel::existsBufferItem(const BufferInfo &bufferInfo) {
451   QModelIndex bufferIdx = bufferIndex(bufferInfo.uid());
452   if(bufferIdx.isValid())
453     return static_cast<BufferItem *>(bufferIdx.internalPointer());
454   else
455     return 0;
456 }
457
458 BufferItem *NetworkModel::bufferItem(const BufferInfo &bufferInfo) {
459   BufferItem *bufItem = existsBufferItem(bufferInfo);
460   if(bufItem == 0) {
461     NetworkItem *netItem = networkItem(bufferInfo.networkId());
462     bufItem = new BufferItem(bufferInfo, netItem);
463     appendChild(netItem, bufItem);
464   }
465
466   Q_ASSERT(bufItem);
467   return bufItem;
468 }
469
470 QStringList NetworkModel::mimeTypes() const {
471   // mimetypes we accept for drops
472   QStringList types;
473   // comma separated list of colon separated pairs of networkid and bufferid
474   // example: 0:1,0:2,1:4
475   types << "application/Quassel/BufferItemList";
476   return types;
477 }
478
479 bool NetworkModel::mimeContainsBufferList(const QMimeData *mimeData) {
480   return mimeData->hasFormat("application/Quassel/BufferItemList");
481 }
482
483 QList< QPair<NetworkId, BufferId> > NetworkModel::mimeDataToBufferList(const QMimeData *mimeData) {
484   QList< QPair<NetworkId, BufferId> > bufferList;
485
486   if(!mimeContainsBufferList(mimeData))
487     return bufferList;
488
489   QStringList rawBufferList = QString::fromAscii(mimeData->data("application/Quassel/BufferItemList")).split(",");
490   NetworkId networkId;
491   BufferId bufferUid;
492   foreach(QString rawBuffer, rawBufferList) {
493     if(!rawBuffer.contains(":"))
494       continue;
495     networkId = rawBuffer.section(":", 0, 0).toInt();
496     bufferUid = rawBuffer.section(":", 1, 1).toInt();
497     bufferList.append(qMakePair(networkId, bufferUid));
498   }
499   return bufferList;
500 }
501
502
503 QMimeData *NetworkModel::mimeData(const QModelIndexList &indexes) const {
504   QMimeData *mimeData = new QMimeData();
505
506   QStringList bufferlist;
507   QString netid, uid, bufferid;
508   foreach(QModelIndex index, indexes) {
509     netid = QString::number(index.data(NetworkIdRole).value<NetworkId>().toInt());
510     uid = QString::number(index.data(BufferIdRole).value<BufferId>().toInt());
511     bufferid = QString("%1:%2").arg(netid).arg(uid);
512     if(!bufferlist.contains(bufferid))
513       bufferlist << bufferid;
514   }
515
516   mimeData->setData("application/Quassel/BufferItemList", bufferlist.join(",").toAscii());
517
518   return mimeData;
519 }
520
521 bool NetworkModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) {
522   Q_UNUSED(action)
523   Q_UNUSED(row)
524   Q_UNUSED(column)
525
526   if(!mimeContainsBufferList(data))
527     return false;
528
529   // target must be a query
530   BufferItem::Type targetType = (BufferItem::Type)parent.data(NetworkModel::BufferTypeRole).toInt();
531   if(targetType != BufferItem::QueryType)
532     return false;
533
534   QList< QPair<NetworkId, BufferId> > bufferList = mimeDataToBufferList(data);
535
536   // exactly one buffer has to be dropped
537   if(bufferList.count() != 1)
538     return false;
539
540   NetworkId netId = bufferList.first().first;
541   BufferId bufferId = bufferList.first().second;
542
543   // no self merges (would kill us)
544   if(bufferId == parent.data(BufferIdRole).value<BufferId>())
545     return false; 
546   
547   Q_ASSERT(rootItem->childById(netId.toInt()));
548   Q_ASSERT(rootItem->childById(netId.toInt())->childById(bufferId.toInt()));
549
550   // source must be a query too
551   BufferItem::Type sourceType = (BufferItem::Type)rootItem->childById(netId.toInt())->childById(bufferId.toInt())->data(0, BufferTypeRole).toInt();
552   if(sourceType != BufferItem::QueryType)
553     return false;
554     
555   // TODO: warn user about buffermerge!
556   qDebug() << "merging" << bufferId << parent.data(BufferIdRole).value<BufferId>();
557   removeRow(parent.row(), parent.parent());
558   
559   return true;
560 }
561
562 void NetworkModel::attachNetwork(Network *net) {
563   NetworkItem *netItem = networkItem(net->networkId());
564   netItem->attachNetwork(net);
565 }
566
567 void NetworkModel::bufferUpdated(BufferInfo bufferInfo) {
568   BufferItem *bufItem = bufferItem(bufferInfo);
569   QModelIndex itemindex = indexByItem(bufItem);
570   emit dataChanged(itemindex, itemindex);
571 }
572
573 void NetworkModel::bufferActivity(BufferItem::ActivityLevel level, BufferInfo bufferInfo) {
574 //   BufferItem *bufferItem = buffer(buf->bufferInfo());
575 //   if(!bufferItem) {
576 //     qWarning() << "NetworkModel::bufferActivity(): received Activity Info for uknown Buffer";
577 //     return;
578 //   }
579 //   bufferItem->setActivity(level);
580 //   bufferUpdated(buf);
581 }
582