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