src/uisupport/bufferview.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 "bufferview.h"
  22
  23 #include "buffermodel.h"
  24 #include "bufferviewfilter.h"
  25 #include "buffersyncer.h"
  26 #include "client.h"
  27 #include "mappedselectionmodel.h"
  28 #include "network.h"
  29 #include "networkmodel.h"
  30
  31 #include "uisettings.h"
  32
  33 #include "global.h"
  34
  35 #include <QAction>
  36 #include <QFlags>
  37 #include <QHeaderView>
  38 #include <QInputDialog>
  39 #include <QLineEdit>
  40 #include <QMenu>
  41 #include <QMessageBox>
  42 #include <QSet>
  43
  44 /*****************************************
  45 * The TreeView showing the Buffers
  46 *****************************************/
  47 // Please be carefull when reimplementing methods which are used to inform the view about changes to the data
  48 // to be on the safe side: call QTreeView's method aswell
  49 BufferView::BufferView(QWidget *parent)
  50   : QTreeView(parent),
  51     _connectNetAction(tr("Connect"), this),
  52     _disconnectNetAction(tr("Disconnect"), this),
  53     _joinChannelAction(tr("Join Channel"), this),
  54
  55     _joinBufferAction(tr("Join"), this),
  56     _partBufferAction(tr("Part"), this),
  57     _hideBufferTemporarilyAction(tr("Hide buffers"), this),
  58     _hideBufferPermanentlyAction(tr("Hide buffers permanently"), this),
  59     _removeBufferAction(tr("Delete buffer"), this),
  60     _ignoreListAction(tr("Ignore list"), this),
  61
  62     _hideJoinAction(tr("Join Events"), this),
  63     _hidePartAction(tr("Part Events"), this),
  64     _hideKillAction(tr("Kill Events"), this),
  65     _hideQuitAction(tr("Quit Events"), this),
  66     _hideModeAction(tr("Mode Events"), this)
  67
  68 {
  69   // currently no events can be hidden -> disable actions
  70   _hideJoinAction.setCheckable(true);
  71   _hidePartAction.setCheckable(true);
  72   _hideKillAction.setCheckable(true);
  73   _hideQuitAction.setCheckable(true);
  74   _hideModeAction.setCheckable(true);
  75   _hideJoinAction.setEnabled(false);
  76   _hidePartAction.setEnabled(false);
  77   _ignoreListAction.setEnabled(false);
  78   _hideKillAction.setEnabled(false);
  79   _hideQuitAction.setEnabled(false);
  80   _hideModeAction.setEnabled(false);
  81
  82   setSelectionMode(QAbstractItemView::ExtendedSelection);
  83 }
  84
  85 void BufferView::init() {
  86   setIndentation(10);
  87   header()->setContextMenuPolicy(Qt::ActionsContextMenu);
  88   hideColumn(1);
  89   hideColumn(2);
  90   expandAll();
  91
  92   setAnimated(true);
  93
  94 #ifndef QT_NO_DRAGANDDROP
  95   setDragEnabled(true);
  96   setAcceptDrops(true);
  97   setDropIndicatorShown(true);
  98 #endif
  99
 100   setSortingEnabled(true);
 101   sortByColumn(0, Qt::AscendingOrder);
 102 #ifndef Q_WS_QWS
 103   // this is a workaround to not join channels automatically... we need a saner way to navigate for qtopia anyway though,
 104   // such as mark first, activate at second click...
 105   connect(this, SIGNAL(activated(QModelIndex)), this, SLOT(joinChannel(QModelIndex)));
 106 #else
 107   connect(this, SIGNAL(doubleClicked(QModelIndex)), this, SLOT(joinChannel(QModelIndex)));  // Qtopia uses single click for activation
 108 #endif
 109 }
 110
 111 void BufferView::setModel(QAbstractItemModel *model) {
 112   delete selectionModel();
 113   if(QTreeView::model()) {
 114     disconnect(QTreeView::model(), SIGNAL(layoutChanged()), this, SLOT(layoutChanged()));
 115   }
 116
 117   QTreeView::setModel(model);
 118   init();
 119   // remove old Actions
 120   QList<QAction *> oldactions = header()->actions();
 121   foreach(QAction *action, oldactions) {
 122     header()->removeAction(action);
 123     action->deleteLater();
 124   }
 125
 126   if(!model)
 127     return;
 128
 129   connect(model, SIGNAL(layoutChanged()), this, SLOT(layoutChanged()));
 130
 131   QString sectionName;
 132   QAction *showSection;
 133   for(int i = 1; i < model->columnCount(); i++) {
 134     sectionName = (model->headerData(i, Qt::Horizontal, Qt::DisplayRole)).toString();
 135     showSection = new QAction(sectionName, header());
 136     showSection->setCheckable(true);
 137     showSection->setChecked(!isColumnHidden(i));
 138     showSection->setProperty("column", i);
 139     connect(showSection, SIGNAL(toggled(bool)), this, SLOT(toggleHeader(bool)));
 140     header()->addAction(showSection);
 141   }
 142
 143 }
 144
 145 void BufferView::setFilteredModel(QAbstractItemModel *model_, BufferViewConfig *config) {
 146   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 147   if(filter) {
 148     filter->setConfig(config);
 149     setConfig(config);
 150     return;
 151   }
 152
 153   if(model()) {
 154     disconnect(this, 0, model(), 0);
 155   }
 156
 157   if(!model_) {
 158     setModel(model_);
 159   } else {
 160     BufferViewFilter *filter = new BufferViewFilter(model_, config);
 161     setModel(filter);
 162   }
 163   setConfig(config);
 164 }
 165
 166 void BufferView::setSelectionModel(QItemSelectionModel *selectionModel) {
 167   if(QTreeView::selectionModel())
 168     disconnect(selectionModel, SIGNAL(currentChanged(QModelIndex, QModelIndex)),
 169                model(), SIGNAL(checkPreviousCurrentForRemoval(QModelIndex, QModelIndex)));
 170
 171   QTreeView::setSelectionModel(selectionModel);
 172   BufferViewFilter *filter = qobject_cast<BufferViewFilter *>(model());
 173   if(filter) {
 174     connect(selectionModel, SIGNAL(currentChanged(QModelIndex, QModelIndex)),
 175             filter, SLOT(checkPreviousCurrentForRemoval(QModelIndex, QModelIndex)));
 176   }
 177 }
 178
 179 void BufferView::setConfig(BufferViewConfig *config) {
 180   if(_config == config)
 181     return;
 182
 183   if(_config) {
 184     disconnect(_config, 0, this, 0);
 185   }
 186
 187   _config = config;
 188   if(config) {
 189     connect(config, SIGNAL(networkIdSet(const NetworkId &)), this, SLOT(setRootIndexForNetworkId(const NetworkId &)));
 190     setRootIndexForNetworkId(config->networkId());
 191   } else {
 192     setRootIndex(QModelIndex());
 193   }
 194 }
 195
 196 void BufferView::setRootIndexForNetworkId(const NetworkId &networkId) {
 197   if(!networkId.isValid() || !model()) {
 198     setRootIndex(QModelIndex());
 199   } else {
 200     int networkCount = model()->rowCount();
 201     QModelIndex child;
 202     for(int i = 0; i < networkCount; i++) {
 203       child = model()->index(i, 0);
 204       if(networkId == model()->data(child, NetworkModel::NetworkIdRole).value<NetworkId>())
 205         setRootIndex(child);
 206     }
 207   }
 208 }
 209
 210 void BufferView::joinChannel(const QModelIndex &index) {
 211   BufferInfo::Type bufferType = (BufferInfo::Type)index.data(NetworkModel::BufferTypeRole).value<int>();
 212
 213   if(bufferType != BufferInfo::ChannelBuffer)
 214     return;
 215
 216   BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 217
 218   Client::userInput(bufferInfo, QString("/JOIN %1").arg(bufferInfo.bufferName()));
 219 }
 220
 221 void BufferView::keyPressEvent(QKeyEvent *event) {
 222   if(event->key() == Qt::Key_Backspace || event->key() == Qt::Key_Delete) {
 223     event->accept();
 224     removeSelectedBuffers();
 225   }
 226   QTreeView::keyPressEvent(event);
 227 }
 228
 229 void BufferView::removeSelectedBuffers(bool permanently) {
 230   if(!config())
 231     return;
 232
 233   BufferId bufferId;
 234   QSet<BufferId> removedRows;
 235   foreach(QModelIndex index, selectionModel()->selectedIndexes()) {
 236     if(index.data(NetworkModel::ItemTypeRole) != NetworkModel::BufferItemType)
 237       continue;
 238
 239     bufferId = index.data(NetworkModel::BufferIdRole).value<BufferId>();
 240     if(removedRows.contains(bufferId))
 241       continue;
 242
 243     removedRows << bufferId;
 244
 245     if(permanently)
 246       config()->requestRemoveBufferPermanently(bufferId);
 247     else
 248       config()->requestRemoveBuffer(bufferId);
 249   }
 250 }
 251
 252 void BufferView::rowsInserted(const QModelIndex & parent, int start, int end) {
 253   QTreeView::rowsInserted(parent, start, end);
 254
 255   // ensure that newly inserted network nodes are expanded per default
 256   if(parent.data(NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 257     return;
 258
 259   if(model()->rowCount(parent) == 1 && parent.data(NetworkModel::ItemActiveRole) == true) {
 260     // without updating the parent the expand will have no effect... Qt Bug?
 261     update(parent);
 262     expand(parent);
 263   }
 264 }
 265
 266 void BufferView::layoutChanged() {
 267   Q_ASSERT(model());
 268
 269   // expand all active networks
 270   QModelIndex networkIdx;
 271   for(int row = 0; row < model()->rowCount(); row++) {
 272     networkIdx = model()->index(row, 0);
 273     update(networkIdx);
 274     if(model()->rowCount(networkIdx) > 0 && model()->data(networkIdx, NetworkModel::ItemActiveRole) == true) {
 275       expand(networkIdx);
 276     } else {
 277       collapse(networkIdx);
 278     }
 279   }
 280
 281   // update selection to current one
 282   MappedSelectionModel *mappedSelectionModel = qobject_cast<MappedSelectionModel *>(selectionModel());
 283   if(!config() || !mappedSelectionModel)
 284     return;
 285
 286   mappedSelectionModel->mappedSetCurrentIndex(Client::bufferModel()->standardSelectionModel()->currentIndex(), QItemSelectionModel::Current);
 287   mappedSelectionModel->mappedSelect(Client::bufferModel()->standardSelectionModel()->selection(), QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows);
 288 }
 289
 290 void BufferView::dataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight) {
 291   QTreeView::dataChanged(topLeft, bottomRight);
 292
 293   // determine how many items have been changed and if any of them is a networkitem
 294   // which just swichted from active to inactive or vice versa
 295   if(topLeft.data(NetworkModel::ItemTypeRole) != NetworkModel::NetworkItemType)
 296     return;
 297
 298   for(int i = topLeft.row(); i <= bottomRight.row(); i++) {
 299     QModelIndex networkIdx = topLeft.sibling(topLeft.row(), 0);
 300     if(model()->rowCount(networkIdx) == 0)
 301       continue;
 302
 303     bool isActive = networkIdx.data(NetworkModel::ItemActiveRole).toBool();
 304     if(isExpanded(networkIdx) != isActive) setExpanded(networkIdx, isActive);
 305   }
 306 }
 307
 308
 309 void BufferView::toggleHeader(bool checked) {
 310   QAction *action = qobject_cast<QAction *>(sender());
 311   header()->setSectionHidden((action->property("column")).toInt(), !checked);
 312 }
 313
 314 bool BufferView::checkRequirements(const QModelIndex &index, ItemActiveStates requiredActiveState) {
 315   if(!index.isValid())
 316     return false;
 317
 318 //   NetworkModel::itemTypes itemType = static_cast<NetworkModel::itemTypes>(index.data(NetworkModel::ItemTypeRole).toInt());
 319 //   if(!(itemType & validItemTypes))
 320 //     return false;
 321
 322   ItemActiveStates isActive = index.data(NetworkModel::ItemActiveRole).toBool()
 323     ? ActiveState
 324     : InactiveState;
 325
 326   if(!(isActive & requiredActiveState))
 327     return false;
 328
 329   return true;
 330 }
 331
 332 void BufferView::addItemToMenu(QAction &action, QMenu &menu, const QModelIndex &index, ItemActiveStates requiredActiveState) {
 333   if(checkRequirements(index, requiredActiveState)) {
 334     menu.addAction(&action);
 335     action.setVisible(true);
 336   } else {
 337     action.setVisible(false);
 338   }
 339 }
 340
 341 void BufferView::addItemToMenu(QAction &action, QMenu &menu, bool condition) {
 342   if(condition) {
 343     menu.addAction(&action);
 344     action.setVisible(true);
 345   } else {
 346     action.setVisible(false);
 347   }
 348 }
 349
 350
 351 void BufferView::addItemToMenu(QMenu &subMenu, QMenu &menu, const QModelIndex &index, ItemActiveStates requiredActiveState) {
 352   if(checkRequirements(index, requiredActiveState)) {
 353     menu.addMenu(&subMenu);
 354     subMenu.setVisible(true);
 355   } else {
 356     subMenu.setVisible(false);
 357   }
 358 }
 359
 360 void BufferView::addSeparatorToMenu(QMenu &menu, const QModelIndex &index, ItemActiveStates requiredActiveState) {
 361   if(checkRequirements(index, requiredActiveState)) {
 362     menu.addSeparator();
 363   }
 364 }
 365
 366 QMenu *BufferView::createHideEventsSubMenu(QMenu &menu) {
 367   // QMenu *hideEventsMenu = new QMenu(tr("Hide Events"), &menu);
 368   QMenu *hideEventsMenu = menu.addMenu(tr("Hide Events"));
 369   hideEventsMenu->addAction(&_hideJoinAction);
 370   hideEventsMenu->addAction(&_hidePartAction);
 371   hideEventsMenu->addAction(&_hideKillAction);
 372   hideEventsMenu->addAction(&_hideQuitAction);
 373   hideEventsMenu->addAction(&_hideModeAction);
 374   return hideEventsMenu;
 375 }
 376
 377 //void BufferView::showContextMenu(const QPoint &pos) {
 378 void BufferView::contextMenuEvent(QContextMenuEvent *event) {
 379   QModelIndex index = indexAt(event->pos());
 380   if(!index.isValid())
 381     return;
 382
 383   const Network *network = Client::network(index.data(NetworkModel::NetworkIdRole).value<NetworkId>());
 384   Q_CHECK_PTR(network);
 385
 386   QIcon connectionStateIcon;
 387   if(network) {
 388     if(network->connectionState() == Network::Initialized) {
 389       connectionStateIcon = QIcon(":/22x22/actions/network-connect");
 390     } else if(network->connectionState() == Network::Disconnected) {
 391       connectionStateIcon = QIcon(":/22x22/actions/network-disconnect");
 392     } else {
 393       connectionStateIcon = QIcon(":/22x22/actions/gear");
 394     }
 395   }
 396
 397   QMenu contextMenu(this);
 398   NetworkModel::itemType itemType = static_cast<NetworkModel::itemType>(index.data(NetworkModel::ItemTypeRole).toInt());
 399
 400   switch(itemType) {
 401   case NetworkModel::NetworkItemType:
 402     _disconnectNetAction.setIcon(connectionStateIcon);
 403     _connectNetAction.setIcon(connectionStateIcon);
 404     addItemToMenu(_disconnectNetAction, contextMenu, index, ActiveState);
 405     addItemToMenu(_connectNetAction, contextMenu, index, InactiveState);
 406     addSeparatorToMenu(contextMenu, index, ActiveState);
 407     addItemToMenu(_joinChannelAction, contextMenu, index, ActiveState);
 408     break;
 409   case NetworkModel::BufferItemType:
 410     {
 411       BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 412       switch(bufferInfo.type()) {
 413       case BufferInfo::ChannelBuffer:
 414         addItemToMenu(_joinBufferAction, contextMenu, index, InactiveState);
 415         addItemToMenu(_partBufferAction, contextMenu, index, ActiveState);
 416         addItemToMenu(_hideBufferTemporarilyAction, contextMenu, (bool)config());
 417         addItemToMenu(_hideBufferPermanentlyAction, contextMenu, (bool)config());
 418         addItemToMenu(_removeBufferAction, contextMenu, index, InactiveState);
 419         createHideEventsSubMenu(contextMenu);
 420         addItemToMenu(_ignoreListAction, contextMenu);
 421         break;
 422       case BufferInfo::QueryBuffer:
 423         addItemToMenu(_hideBufferTemporarilyAction, contextMenu, (bool)config());
 424         addItemToMenu(_hideBufferPermanentlyAction, contextMenu, (bool)config());
 425         addItemToMenu(_removeBufferAction, contextMenu);
 426         createHideEventsSubMenu(contextMenu);
 427         break;
 428       default:
 429         addItemToMenu(_hideBufferTemporarilyAction, contextMenu, (bool)config());
 430         addItemToMenu(_hideBufferPermanentlyAction, contextMenu, (bool)config());
 431         break;
 432       }
 433     }
 434     break;
 435   default:
 436     return;
 437   }
 438
 439   if(contextMenu.actions().isEmpty())
 440     return;
 441   QAction *result = contextMenu.exec(QCursor::pos());
 442
 443   // Handle Result
 444   if(network && result == &_connectNetAction) {
 445     network->requestConnect();
 446     return;
 447   }
 448
 449   if(network && result == &_disconnectNetAction) {
 450     network->requestDisconnect();
 451     return;
 452   }
 453
 454   if(result == &_joinChannelAction) {
 455     // FIXME no QInputDialog in Qtopia
 456 #ifndef Q_WS_QWS
 457     bool ok;
 458     QString channelName = QInputDialog::getText(this, tr("Join Channel"), tr("Input channel name:"), QLineEdit::Normal, QString(), &ok);
 459     if(ok && !channelName.isEmpty()) {
 460       BufferInfo bufferInfo = index.child(0,0).data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 461       if(bufferInfo.isValid()) {
 462         Client::instance()->userInput(bufferInfo, QString("/J %1").arg(channelName));
 463       }
 464     }
 465 #endif
 466     return;
 467   }
 468
 469   if(result == &_joinBufferAction) {
 470     BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 471     Client::instance()->userInput(bufferInfo, QString("/JOIN %1").arg(bufferInfo.bufferName()));
 472     return;
 473   }
 474
 475   if(result == &_partBufferAction) {
 476     BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 477     Client::instance()->userInput(bufferInfo, QString("/PART %1").arg(bufferInfo.bufferName()));
 478     return;
 479   }
 480
 481   if(result == &_hideBufferTemporarilyAction) {
 482     removeSelectedBuffers();
 483     return;
 484   }
 485
 486   if(result == &_hideBufferPermanentlyAction) {
 487     removeSelectedBuffers(true);
 488     return;
 489   }
 490
 491   if(result == &_removeBufferAction) {
 492     BufferInfo bufferInfo = index.data(NetworkModel::BufferInfoRole).value<BufferInfo>();
 493     int res = QMessageBox::question(this, tr("Remove buffer permanently?"),
 494                                     tr("Do you want to delete the buffer \"%1\" permanently? This will delete all related data, including all backlog "
 495                                        "data, from the core's database!").arg(bufferInfo.bufferName()),
 496                                         QMessageBox::Yes|QMessageBox::No, QMessageBox::No);
 497     if(res == QMessageBox::Yes) {
 498       Client::removeBuffer(bufferInfo.bufferId());
 499     }
 500     return;
 501   }
 502
 503 }
 504
 505 void BufferView::wheelEvent(QWheelEvent* event) {
 506   if(UiSettings().value("MouseWheelChangesBuffers", QVariant(true)).toBool() == (bool)(event->modifiers() & Qt::AltModifier))
 507     return QTreeView::wheelEvent(event);
 508
 509   int rowDelta = ( event->delta() > 0 ) ? -1 : 1;
 510   QModelIndex currentIndex = selectionModel()->currentIndex();
 511   QModelIndex resultingIndex;
 512   if( model()->hasIndex(  currentIndex.row() + rowDelta, currentIndex.column(), currentIndex.parent() ) )
 513     {
 514       resultingIndex = currentIndex.sibling( currentIndex.row() + rowDelta, currentIndex.column() );
 515     }
 516     else //if we scroll into a the parent node...
 517       {
 518         QModelIndex parent = currentIndex.parent();
 519         QModelIndex aunt = parent.sibling( parent.row() + rowDelta, parent.column() );
 520         if( rowDelta == -1 )
 521           resultingIndex = aunt.child( model()->rowCount( aunt ) - 1, 0 );
 522         else
 523           resultingIndex = aunt.child( 0, 0 );
 524         if( !resultingIndex.isValid() )
 525           return;
 526       }
 527   selectionModel()->setCurrentIndex( resultingIndex, QItemSelectionModel::ClearAndSelect | QItemSelectionModel::Rows );
 528   selectionModel()->select( resultingIndex, QItemSelectionModel::ClearAndSelect );
 529
 530 }
 531
 532
 533 QSize BufferView::sizeHint() const {
 534   return QTreeView::sizeHint();
 535
 536   if(!model())
 537     return QTreeView::sizeHint();
 538
 539   if(model()->rowCount() == 0)
 540     return QSize(120, 50);
 541
 542   int columnSize = 0;
 543   for(int i = 0; i < model()->columnCount(); i++) {
 544     if(!isColumnHidden(i))
 545       columnSize += sizeHintForColumn(i);
 546   }
 547   return QSize(columnSize, 50);
 548 }
 549
 550 // ==============================
 551 //  BufferView Dock
 552 // ==============================
 553 BufferViewDock::BufferViewDock(BufferViewConfig *config, QWidget *parent)
 554   : QDockWidget(config->bufferViewName(), parent)
 555 {
 556   setObjectName("BufferViewDock-" + QString::number(config->bufferViewId()));
 557   toggleViewAction()->setData(config->bufferViewId());
 558   setAllowedAreas(Qt::RightDockWidgetArea|Qt::LeftDockWidgetArea);
 559   connect(config, SIGNAL(bufferViewNameSet(const QString &)), this, SLOT(bufferViewRenamed(const QString &)));
 560 }
 561
 562 BufferViewDock::BufferViewDock(QWidget *parent)
 563   : QDockWidget(tr("All Buffers"), parent)
 564 {
 565   setObjectName("BufferViewDock--1");
 566   toggleViewAction()->setData((int)-1);
 567   setAllowedAreas(Qt::RightDockWidgetArea|Qt::LeftDockWidgetArea);
 568 }
 569
 570 void BufferViewDock::bufferViewRenamed(const QString &newName) {
 571   setWindowTitle(newName);
 572   toggleViewAction()->setText(newName);
 573 }