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   emit dataChanged();
  87 }
  88
  89 void BufferItem::updateActivity(const ActivityLevel &level) {
  90   _activity |= level;
  91   emit dataChanged();
  92 }
  93
  94 QVariant BufferItem::data(int column, int role) const {
  95   switch(role) {
  96   case NetworkModel::ItemTypeRole:
  97     return NetworkModel::BufferItemType;
  98   case NetworkModel::BufferIdRole:
  99     return qVariantFromValue(bufferInfo().uid());
 100   case NetworkModel::NetworkIdRole:
 101     return qVariantFromValue(bufferInfo().networkId());
 102   case NetworkModel::BufferInfoRole:
 103     return qVariantFromValue(bufferInfo());
 104   case NetworkModel::BufferTypeRole:
 105     return int(bufferType());
 106   case NetworkModel::ItemActiveRole:
 107     return isActive();
 108   case NetworkModel::BufferActivityRole:
 109     return qVariantFromValue((int)activity());
 110   default:
 111     return PropertyMapItem::data(column, role);
 112   }
 113 }
 114
 115 bool BufferItem::setData(int column, const QVariant &value, int role) {
 116   switch(role) {
 117   case NetworkModel::BufferActivityRole:
 118     setActivity((ActivityLevel)value.toInt());
 119   default:
 120     return PropertyMapItem::setData(column, value, role);
 121   }
 122   return true;
 123 }
 124
 125
 126 void BufferItem::attachIrcChannel(IrcChannel *ircChannel) {
 127   if(!ircChannel)
 128     return;
 129
 130   _ircChannel = ircChannel;
 131
 132   connect(ircChannel, SIGNAL(topicSet(QString)),
 133           this, SLOT(setTopic(QString)));
 134   connect(ircChannel, SIGNAL(ircUserJoined(IrcUser *)),
 135           this, SLOT(join(IrcUser *)));
 136   connect(ircChannel, SIGNAL(ircUserParted(IrcUser *)),
 137           this, SLOT(part(IrcUser *)));
 138   connect(ircChannel, SIGNAL(destroyed()),
 139           this, SLOT(ircChannelDestroyed()));
 140   connect(ircChannel, SIGNAL(ircUserModesSet(IrcUser *, QString)),
 141           this, SLOT(userModeChanged(IrcUser *)));
 142   connect(ircChannel, SIGNAL(ircUserModeAdded(IrcUser *, QString)),
 143           this, SLOT(userModeChanged(IrcUser *)));
 144   connect(ircChannel, SIGNAL(ircUserModeRemoved(IrcUser *, QString)),
 145           this, SLOT(userModeChanged(IrcUser *)));
 146
 147   emit dataChanged();
 148 }
 149
 150 void BufferItem::ircChannelDestroyed() {
 151   emit dataChanged();
 152   removeAllChilds();
 153 }
 154
 155 QString BufferItem::bufferName() const {
 156   if(bufferType() == StatusType)
 157     return tr("Status Buffer");
 158   else
 159     return bufferInfo().buffer();
 160 }
 161
 162 QString BufferItem::topic() const {
 163   if(_ircChannel)
 164     return _ircChannel->topic();
 165   else
 166     return QString();
 167 }
 168
 169 int BufferItem::nickCount() const {
 170   if(_ircChannel)
 171     return _ircChannel->ircUsers().count();
 172   else
 173     return 0;
 174 }
 175
 176 void BufferItem::setTopic(const QString &topic) {
 177   Q_UNUSED(topic);
 178   emit dataChanged(1);
 179 }
 180
 181 void BufferItem::join(IrcUser *ircUser) {
 182   if(!ircUser)
 183     return;
 184
 185   addUserToCategory(ircUser);
 186   emit dataChanged(2);
 187 }
 188
 189 void BufferItem::addUserToCategory(IrcUser *ircUser) {
 190   Q_ASSERT(_ircChannel);
 191
 192   UserCategoryItem *categoryItem;
 193   int categoryId = UserCategoryItem::categoryFromModes(_ircChannel->userModes(ircUser));
 194   if(!(categoryItem = qobject_cast<UserCategoryItem *>(childById(qHash(categoryId))))) {
 195     categoryItem = new UserCategoryItem(categoryId, this);
 196     newChild(categoryItem);
 197   }
 198   categoryItem->addUser(ircUser);
 199
 200   int totalusers = 0;
 201   for(int i = 0; i < childCount(); i++) {
 202     totalusers += child(i)->childCount();
 203   }
 204 }
 205
 206 void BufferItem::part(IrcUser *ircUser) {
 207   if(!ircUser) {
 208     qWarning() << bufferName() << "BufferItem::part(): unknown User" << ircUser;
 209     return;
 210   }
 211
 212   removeUserFromCategory(ircUser);
 213   emit dataChanged(2);
 214 }
 215
 216 void BufferItem::removeUserFromCategory(IrcUser *ircUser) {
 217   Q_ASSERT(_ircChannel);
 218
 219   bool success = false;
 220   UserCategoryItem *categoryItem = 0;
 221   for(int i = 0; i < childCount(); i++) {
 222     categoryItem = qobject_cast<UserCategoryItem *>(child(i));
 223     if(success = categoryItem->removeChildById((quint64)ircUser)) {
 224       if(categoryItem->childCount() == 0)
 225         removeChild(i);
 226       break;
 227     }
 228   }
 229
 230
 231   if(!success) {
 232     qDebug() << "==== Childlist for Item:" << this << id() << bufferName() << "====";
 233     for(int i = 0; i < childCount(); i++) {
 234       categoryItem = qobject_cast<UserCategoryItem *>(child(i));
 235       categoryItem->dumpChildList();
 236     }
 237     qDebug() << "==== End Of Childlist for Item:" << this << id() << bufferName() << "====";
 238   }
 239   Q_ASSERT(success);
 240
 241   int totalusers = 0;
 242   for(int i = 0; i < childCount(); i++) {
 243     totalusers += child(i)->childCount();
 244   }
 245 }
 246
 247 void BufferItem::userModeChanged(IrcUser *ircUser) {
 248   Q_ASSERT(_ircChannel);
 249
 250   UserCategoryItem *categoryItem;
 251   int categoryId = UserCategoryItem::categoryFromModes(_ircChannel->userModes(ircUser));
 252   if((categoryItem = qobject_cast<UserCategoryItem *>(childById(qHash(categoryId)))) && categoryItem->childById((quint64)(ircUser)))
 253     return; // already in the right category;
 254
 255   removeUserFromCategory(ircUser);
 256   addUserToCategory(ircUser);
 257 }
 258
 259 /*****************************************
 260 *  Network Items
 261 *****************************************/
 262 NetworkItem::NetworkItem(const NetworkId &netid, AbstractTreeItem *parent)
 263   : PropertyMapItem(QList<QString>() << "networkName" << "currentServer" << "nickCount", parent),
 264     _networkId(netid)
 265 {
 266   setFlags(Qt::ItemIsEnabled);
 267 }
 268
 269 QVariant NetworkItem::data(int column, int role) const {
 270   switch(role) {
 271   case NetworkModel::NetworkIdRole:
 272     return qVariantFromValue(_networkId);
 273   case NetworkModel::ItemTypeRole:
 274     return NetworkModel::NetworkItemType;
 275   case NetworkModel::ItemActiveRole:
 276     return isActive();
 277   default:
 278     return PropertyMapItem::data(column, role);
 279   }
 280 }
 281
 282 quint64 NetworkItem::id() const {
 283   return _networkId.toInt();
 284 }
 285
 286 bool NetworkItem::isActive() const {
 287   return _network;
 288 }
 289
 290 QString NetworkItem::networkName() const {
 291   if(_network)
 292     return _network->networkName();
 293   else
 294     return QString();
 295 }
 296
 297 QString NetworkItem::currentServer() const {
 298   if(_network)
 299     return _network->currentServer();
 300   else
 301     return QString();
 302 }
 303
 304 int NetworkItem::nickCount() const {
 305   if(_network)
 306     return _network->ircUsers().count();
 307   else
 308     return 0;
 309 }
 310
 311 void NetworkItem::attachNetwork(Network *network) {
 312   if(!network)
 313     return;
 314
 315   _network = network;
 316
 317   connect(network, SIGNAL(networkNameSet(QString)),
 318           this, SLOT(setNetworkName(QString)));
 319   connect(network, SIGNAL(currentServerSet(QString)),
 320           this, SLOT(setCurrentServer(QString)));
 321   connect(network, SIGNAL(ircChannelAdded(QString)),
 322           this, SLOT(attachIrcChannel(QString)));
 323   // FIXME: connect this and that...
 324
 325   emit dataChanged();
 326 }
 327
 328 void NetworkItem::attachIrcChannel(const QString &channelName) {
 329   IrcChannel *ircChannel = _network->ircChannel(channelName);
 330   if(!ircChannel) {
 331     qWarning() << "NetworkItem::attachIrcChannel(): unkown Channel" << channelName;
 332     return;
 333   }
 334
 335   BufferItem *bufferItem;
 336   for(int i = 0; i < childCount(); i++) {
 337     bufferItem = qobject_cast<BufferItem *>(child(i));
 338     if(bufferItem->bufferName() == ircChannel->name()) {
 339       bufferItem->attachIrcChannel(ircChannel);
 340       break;
 341     }
 342   }
 343 }
 344
 345 void NetworkItem::setNetworkName(const QString &networkName) {
 346   Q_UNUSED(networkName);
 347   emit dataChanged(0);
 348 }
 349
 350 void NetworkItem::setCurrentServer(const QString &serverName) {
 351   Q_UNUSED(serverName);
 352   emit dataChanged(1);
 353 }
 354
 355 /*****************************************
 356 *  User Category Items (like @vh etc.)
 357 *****************************************/
 358 // we hardcode this even though we have PREFIX in network... but that wouldn't help with mapping modes to
 359 // category strings anyway.
 360 const QList<UserCategoryItem::Category> UserCategoryItem::categories = QList<UserCategoryItem::Category>()
 361   << UserCategoryItem::Category('q', "Owners")
 362   << UserCategoryItem::Category('a', "Admins")
 363   << UserCategoryItem::Category('a', "Admins")
 364   << UserCategoryItem::Category('o', "Operators")
 365   << UserCategoryItem::Category('h', "Half-Ops")
 366   << UserCategoryItem::Category('v', "Voiced");
 367
 368 UserCategoryItem::UserCategoryItem(int category, AbstractTreeItem *parent)
 369   : PropertyMapItem(QStringList() << "categoryId", parent),
 370     _category(category)
 371 {
 372 }
 373
 374 QString UserCategoryItem::categoryId() {
 375   if(_category < categories.count())
 376     return categories[_category].displayString;
 377   else
 378     return QString("Users");
 379 }
 380
 381 quint64 UserCategoryItem::id() const {
 382   return qHash(_category);
 383 }
 384
 385 void UserCategoryItem::addUser(IrcUser *ircUser) {
 386   newChild(new IrcUserItem(ircUser, this));
 387 }
 388
 389 int UserCategoryItem::categoryFromModes(const QString &modes) {
 390   for(int i = 0; i < categories.count(); i++) {
 391     if(modes.contains(categories[i].mode))
 392       return i;
 393   }
 394   return categories.count();
 395 }
 396
 397 QVariant UserCategoryItem::data(int column, int role) const {
 398   switch(role) {
 399   case NetworkModel::ItemTypeRole:
 400     return NetworkModel::UserCategoryItemType;
 401   case NetworkModel::BufferIdRole:
 402     return parent()->data(column, role);
 403   case NetworkModel::NetworkIdRole:
 404     return parent()->data(column, role);
 405   case NetworkModel::BufferInfoRole:
 406     return parent()->data(column, role);
 407   default:
 408     return PropertyMapItem::data(column, role);
 409   }
 410 }
 411
 412
 413 /*****************************************
 414 *  Irc User Items
 415 *****************************************/
 416 IrcUserItem::IrcUserItem(IrcUser *ircUser, AbstractTreeItem *parent)
 417   : PropertyMapItem(QStringList() << "nickName", parent),
 418     _ircUser(ircUser)
 419 {
 420   // we don't need to handle the ircUser's destroyed signal since it's automatically removed
 421   // by the IrcChannel::ircUserParted();
 422
 423   connect(ircUser, SIGNAL(nickSet(QString)),
 424           this, SLOT(setNick(QString)));
 425 }
 426
 427 QString IrcUserItem::nickName() const {
 428   return _ircUser->nick();
 429 }
 430
 431 IrcUser *IrcUserItem::ircUser() {
 432   return _ircUser;
 433 }
 434
 435 quint64 IrcUserItem::id() const {
 436   return (quint64)_ircUser;
 437 }
 438
 439 QVariant IrcUserItem::data(int column, int role) const {
 440   switch(role) {
 441   case NetworkModel::ItemTypeRole:
 442     return NetworkModel::IrcUserItemType;
 443   case NetworkModel::BufferIdRole:
 444     return parent()->data(column, role);
 445   case NetworkModel::NetworkIdRole:
 446     return parent()->data(column, role);
 447   case NetworkModel::BufferInfoRole:
 448     return parent()->data(column, role);
 449   default:
 450     return PropertyMapItem::data(column, role);
 451   }
 452 }
 453
 454 QString IrcUserItem::toolTip(int column) const {
 455   Q_UNUSED(column);
 456   return "<p><b>" + nickName() + "</b><br />" + _ircUser->hostmask() + "</p>";
 457 }
 458
 459 void IrcUserItem::setNick(QString newNick) {
 460   Q_UNUSED(newNick);
 461   emit dataChanged(0);
 462 }
 463
 464 /*****************************************
 465  * NetworkModel
 466  *****************************************/
 467 NetworkModel::NetworkModel(QObject *parent)
 468   : TreeModel(NetworkModel::defaultHeader(), parent)
 469 {
 470 }
 471
 472 QList<QVariant >NetworkModel::defaultHeader() {
 473   QList<QVariant> data;
 474   data << tr("Buffer") << tr("Topic") << tr("Nick Count");
 475   return data;
 476 }
 477
 478 bool NetworkModel::isBufferIndex(const QModelIndex &index) const {
 479   return index.data(NetworkModel::ItemTypeRole) == NetworkModel::BufferItemType;
 480 }
 481
 482 /*
 483 Buffer *NetworkModel::getBufferByIndex(const QModelIndex &index) const {
 484   BufferItem *item = static_cast<BufferItem *>(index.internalPointer());
 485   return Client::instance()->buffer(item->id());
 486 }
 487 */
 488
 489
 490 // experimental stuff :)
 491 QModelIndex NetworkModel::networkIndex(NetworkId networkId) {
 492   return indexById(networkId.toInt());
 493 }
 494
 495 NetworkItem *NetworkModel::existsNetworkItem(NetworkId networkId) {
 496   return qobject_cast<NetworkItem *>(rootItem->childById(networkId.toInt()));
 497 }
 498
 499 NetworkItem *NetworkModel::networkItem(NetworkId networkId) {
 500   NetworkItem *netItem = existsNetworkItem(networkId);
 501
 502   if(netItem == 0) {
 503     netItem = new NetworkItem(networkId, rootItem);
 504     rootItem->newChild(netItem);
 505   }
 506
 507   Q_ASSERT(netItem);
 508   return netItem;
 509 }
 510
 511 QModelIndex NetworkModel::bufferIndex(BufferId bufferId) {
 512   AbstractTreeItem *netItem, *bufferItem;
 513   for(int i = 0; i < rootItem->childCount(); i++) {
 514     netItem = rootItem->child(i);
 515     if((bufferItem = netItem->childById(bufferId.toInt()))) {
 516       return indexById(bufferItem->id(), networkIndex(netItem->id()));
 517     }
 518   }
 519   return QModelIndex();
 520 }
 521
 522 BufferItem *NetworkModel::existsBufferItem(const BufferInfo &bufferInfo) {
 523   QModelIndex bufferIdx = bufferIndex(bufferInfo.uid());
 524   if(bufferIdx.isValid())
 525     return static_cast<BufferItem *>(bufferIdx.internalPointer());
 526   else
 527     return 0;
 528 }
 529
 530 BufferItem *NetworkModel::bufferItem(const BufferInfo &bufferInfo) {
 531   BufferItem *bufItem = existsBufferItem(bufferInfo);
 532   if(bufItem == 0) {
 533     NetworkItem *netItem = networkItem(bufferInfo.networkId());
 534     bufItem = new BufferItem(bufferInfo, netItem);
 535     netItem->newChild(bufItem);
 536   }
 537
 538   Q_ASSERT(bufItem);
 539   return bufItem;
 540 }
 541
 542 QStringList NetworkModel::mimeTypes() const {
 543   // mimetypes we accept for drops
 544   QStringList types;
 545   // comma separated list of colon separated pairs of networkid and bufferid
 546   // example: 0:1,0:2,1:4
 547   types << "application/Quassel/BufferItemList";
 548   return types;
 549 }
 550
 551 bool NetworkModel::mimeContainsBufferList(const QMimeData *mimeData) {
 552   return mimeData->hasFormat("application/Quassel/BufferItemList");
 553 }
 554
 555 QList< QPair<NetworkId, BufferId> > NetworkModel::mimeDataToBufferList(const QMimeData *mimeData) {
 556   QList< QPair<NetworkId, BufferId> > bufferList;
 557
 558   if(!mimeContainsBufferList(mimeData))
 559     return bufferList;
 560
 561   QStringList rawBufferList = QString::fromAscii(mimeData->data("application/Quassel/BufferItemList")).split(",");
 562   NetworkId networkId;
 563   BufferId bufferUid;
 564   foreach(QString rawBuffer, rawBufferList) {
 565     if(!rawBuffer.contains(":"))
 566       continue;
 567     networkId = rawBuffer.section(":", 0, 0).toInt();
 568     bufferUid = rawBuffer.section(":", 1, 1).toInt();
 569     bufferList.append(qMakePair(networkId, bufferUid));
 570   }
 571   return bufferList;
 572 }
 573
 574
 575 QMimeData *NetworkModel::mimeData(const QModelIndexList &indexes) const {
 576   QMimeData *mimeData = new QMimeData();
 577
 578   QStringList bufferlist;
 579   QString netid, uid, bufferid;
 580   foreach(QModelIndex index, indexes) {
 581     netid = QString::number(index.data(NetworkIdRole).value<NetworkId>().toInt());
 582     uid = QString::number(index.data(BufferIdRole).value<BufferId>().toInt());
 583     bufferid = QString("%1:%2").arg(netid).arg(uid);
 584     if(!bufferlist.contains(bufferid))
 585       bufferlist << bufferid;
 586   }
 587
 588   mimeData->setData("application/Quassel/BufferItemList", bufferlist.join(",").toAscii());
 589
 590   return mimeData;
 591 }
 592
 593 bool NetworkModel::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) {
 594   Q_UNUSED(action)
 595   Q_UNUSED(row)
 596   Q_UNUSED(column)
 597
 598   if(!mimeContainsBufferList(data))
 599     return false;
 600
 601   // target must be a query
 602   BufferItem::Type targetType = (BufferItem::Type)parent.data(NetworkModel::BufferTypeRole).toInt();
 603   if(targetType != BufferItem::QueryType)
 604     return false;
 605
 606   QList< QPair<NetworkId, BufferId> > bufferList = mimeDataToBufferList(data);
 607
 608   // exactly one buffer has to be dropped
 609   if(bufferList.count() != 1)
 610     return false;
 611
 612   NetworkId netId = bufferList.first().first;
 613   BufferId bufferId = bufferList.first().second;
 614
 615   // no self merges (would kill us)
 616   if(bufferId == parent.data(BufferIdRole).value<BufferId>())
 617     return false;
 618
 619   Q_ASSERT(rootItem->childById(netId.toInt()));
 620   Q_ASSERT(rootItem->childById(netId.toInt())->childById(bufferId.toInt()));
 621
 622   // source must be a query too
 623   BufferItem::Type sourceType = (BufferItem::Type)rootItem->childById(netId.toInt())->childById(bufferId.toInt())->data(0, BufferTypeRole).toInt();
 624   if(sourceType != BufferItem::QueryType)
 625     return false;
 626
 627   // TODO: warn user about buffermerge!
 628   qDebug() << "merging" << bufferId << parent.data(BufferIdRole).value<BufferId>();
 629   removeRow(parent.row(), parent.parent());
 630
 631   return true;
 632 }
 633
 634 void NetworkModel::attachNetwork(Network *net) {
 635   NetworkItem *netItem = networkItem(net->networkId());
 636   netItem->attachNetwork(net);
 637 }
 638
 639 void NetworkModel::bufferUpdated(BufferInfo bufferInfo) {
 640   BufferItem *bufItem = bufferItem(bufferInfo);
 641   QModelIndex itemindex = indexByItem(bufItem);
 642   emit dataChanged(itemindex, itemindex);
 643 }
 644
 645 void NetworkModel::updateBufferActivity(const Message &msg) {
 646   BufferItem::ActivityLevel level = BufferItem::OtherActivity;
 647   if(msg.type() == Message::Plain || msg.type() == Message::Notice)
 648     level |= BufferItem::NewMessage;
 649
 650   if(msg.flags() & Message::Highlight)
 651     level |= BufferItem::Highlight;
 652
 653   bufferItem(msg.buffer())->updateActivity(level);
 654 }
 655