src/uisupport/bufferviewfilter.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 "bufferviewfilter.h"
  22
  23 #include <QCoreApplication>
  24
  25 #include "buffermodel.h"
  26 #include "client.h"
  27 #include "networkmodel.h"
  28
  29 #include "uisettings.h"
  30
  31 class CheckRemovalEvent : public QEvent {
  32 public:
  33   CheckRemovalEvent(const QModelIndex &source_index) : QEvent(QEvent::User), index(source_index) {};
  34   QPersistentModelIndex index;
  35 };
  36
  37 /*****************************************
  38 * The Filter for the Tree View
  39 *****************************************/
  40 BufferViewFilter::BufferViewFilter(QAbstractItemModel *model, BufferViewConfig *config)
  41   : QSortFilterProxyModel(model),
  42     _config(0)
  43 {
  44   setConfig(config);
  45   setSourceModel(model);
  46
  47   setDynamicSortFilter(true);
  48
  49   loadColors();
  50
  51   connect(this, SIGNAL(_dataChanged(const QModelIndex &, const QModelIndex &)),
  52           this, SLOT(_q_sourceDataChanged(QModelIndex,QModelIndex)));
  53 }
  54
  55 void BufferViewFilter::loadColors() {
  56   UiSettings s("QtUi/Colors");
  57   _FgColorInactiveActivity = s.value("inactiveActivityFG", QVariant(QColor(Qt::gray))).value<QColor>();
  58   _FgColorNoActivity = s.value("noActivityFG", QVariant(QColor(Qt::black))).value<QColor>();
  59   _FgColorHighlightActivity = s.value("highlightActivityFG", QVariant(QColor(Qt::magenta))).value<QColor>();
  60   _FgColorNewMessageActivity = s.value("newMessageActivityFG", QVariant(QColor(Qt::green))).value<QColor>();
  61   _FgColorOtherActivity = s.value("otherActivityFG", QVariant(QColor(Qt::darkGreen))).value<QColor>();
  62 }
  63
  64 void BufferViewFilter::setConfig(BufferViewConfig *config) {
  65   if(_config == config)
  66     return;
  67
  68   if(_config) {
  69     disconnect(_config, 0, this, 0);
  70   }
  71
  72   _config = config;
  73   if(config->isInitialized()) {
  74     configInitialized();
  75   } else {
  76     connect(config, SIGNAL(initDone()), this, SLOT(configInitialized()));
  77     invalidate();
  78   }
  79 }
  80
  81 void BufferViewFilter::configInitialized() {
  82   if(!config())
  83     return;
  84
  85   connect(config(), SIGNAL(bufferViewNameSet(const QString &)), this, SLOT(invalidate()));
  86   connect(config(), SIGNAL(networkIdSet(const NetworkId &)), this, SLOT(invalidate()));
  87   connect(config(), SIGNAL(addNewBuffersAutomaticallySet(bool)), this, SLOT(invalidate()));
  88   connect(config(), SIGNAL(sortAlphabeticallySet(bool)), this, SLOT(invalidate()));
  89   connect(config(), SIGNAL(hideInactiveBuffersSet(bool)), this, SLOT(invalidate()));
  90   connect(config(), SIGNAL(allowedBufferTypesSet(int)), this, SLOT(invalidate()));
  91   connect(config(), SIGNAL(minimumActivitySet(int)), this, SLOT(invalidate()));
  92   connect(config(), SIGNAL(bufferListSet()), this, SLOT(invalidate()));
  93   connect(config(), SIGNAL(bufferAdded(const BufferId &, int)), this, SLOT(invalidate()));
  94   connect(config(), SIGNAL(bufferMoved(const BufferId &, int)), this, SLOT(invalidate()));
  95   connect(config(), SIGNAL(bufferRemoved(const BufferId &)), this, SLOT(invalidate()));
  96   connect(config(), SIGNAL(bufferPermanentlyRemoved(const BufferId &)), this, SLOT(invalidate()));
  97
  98   disconnect(config(), SIGNAL(initDone()), this, SLOT(configInitialized()));
  99
 100   invalidate();
 101 }
 102
 103 Qt::ItemFlags BufferViewFilter::flags(const QModelIndex &index) const {
 104   Qt::ItemFlags flags = mapToSource(index).flags();
 105   if(_config && index == QModelIndex() || index.parent() == QModelIndex())
 106     flags |= Qt::ItemIsDropEnabled;
 107   return flags;
 108 }
 109
 110 bool BufferViewFilter::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) {
 111   if(!config() || !NetworkModel::mimeContainsBufferList(data))
 112     return QSortFilterProxyModel::dropMimeData(data, action, row, column, parent);
 113
 114   NetworkId droppedNetworkId;
 115   if(parent.data(NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
 116     droppedNetworkId = parent.data(NetworkModel::NetworkIdRole).value<NetworkId>();
 117
 118   QList< QPair<NetworkId, BufferId> > bufferList = NetworkModel::mimeDataToBufferList(data);
 119   BufferId bufferId;
 120   NetworkId networkId;
 121   int pos;
 122   for(int i = 0; i < bufferList.count(); i++) {
 123     networkId = bufferList[i].first;
 124     bufferId = bufferList[i].second;
 125     if(droppedNetworkId == networkId) {
 126       if(row < 0)
 127         row = 0;
 128       if(row < rowCount(parent)) {
 129         BufferId beforeBufferId = parent.child(row, 0).data(NetworkModel::BufferIdRole).value<BufferId>();
 130         pos = config()->bufferList().indexOf(beforeBufferId);
 131       } else {
 132         pos = config()->bufferList().count();
 133       }
 134
 135       if(config()->bufferList().contains(bufferId)) {
 136         if(config()->bufferList().indexOf(bufferId) < pos)
 137           pos--;
 138         config()->requestMoveBuffer(bufferId, pos);
 139       } else {
 140         config()->requestAddBuffer(bufferId, pos);
 141       }
 142
 143     } else {
 144       addBuffer(bufferId);
 145     }
 146   }
 147   return true;
 148 }
 149
 150 void BufferViewFilter::addBuffer(const BufferId &bufferId) const {
 151   if(!config() || config()->bufferList().contains(bufferId))
 152     return;
 153
 154   int pos = config()->bufferList().count();
 155   bool lt;
 156   for(int i = 0; i < config()->bufferList().count(); i++) {
 157     if(config() && config()->sortAlphabetically())
 158       lt = bufferIdLessThan(bufferId, config()->bufferList()[i]);
 159     else
 160       lt = bufferId < config()->bufferList()[i];
 161
 162     if(lt) {
 163       pos = i;
 164       break;
 165     }
 166   }
 167   config()->requestAddBuffer(bufferId, pos);
 168 }
 169
 170 bool BufferViewFilter::filterAcceptBuffer(const QModelIndex &source_bufferIndex) const {
 171   // no config -> "all buffers" -> accept everything
 172   if(!config())
 173     return true;
 174
 175   BufferId bufferId = sourceModel()->data(source_bufferIndex, NetworkModel::BufferIdRole).value<BufferId>();
 176   Q_ASSERT(bufferId.isValid());
 177
 178   int activityLevel = source_bufferIndex.data(NetworkModel::BufferActivityRole).toInt();
 179
 180   if(!config()->bufferList().contains(bufferId)) {
 181     // add the buffer if...
 182     if(config()->isInitialized() && !config()->removedBuffers().contains(bufferId) // it hasn't been manually removed and either
 183        && ((config()->addNewBuffersAutomatically() && !config()->temporarilyRemovedBuffers().contains(bufferId)) // is totally unknown to us (a new buffer)...
 184            || (config()->temporarilyRemovedBuffers().contains(bufferId) && activityLevel > Buffer::OtherActivity))) { // or was just temporarily hidden and has a new message waiting for us.
 185       addBuffer(bufferId);
 186     }
 187     // note: adding the buffer to the valid list does not temper with the following filters ("show only channels" and stuff)
 188     return false;
 189   }
 190
 191   if(config()->networkId().isValid() && config()->networkId() != sourceModel()->data(source_bufferIndex, NetworkModel::NetworkIdRole).value<NetworkId>())
 192     return false;
 193
 194   if(!(config()->allowedBufferTypes() & (BufferInfo::Type)source_bufferIndex.data(NetworkModel::BufferTypeRole).toInt()))
 195     return false;
 196
 197   if(config()->hideInactiveBuffers() && !source_bufferIndex.data(NetworkModel::ItemActiveRole).toBool())
 198     return false;
 199
 200   if(config()->minimumActivity() > activityLevel) {
 201     if(bufferId != Client::bufferModel()->standardSelectionModel()->currentIndex().data(NetworkModel::BufferIdRole).value<BufferId>())
 202       return false;
 203   }
 204
 205   return true;
 206 }
 207
 208 bool BufferViewFilter::filterAcceptNetwork(const QModelIndex &source_index) const {
 209   if(!config())
 210     return true;
 211
 212   if(!config()->networkId().isValid()) {
 213     return true;
 214   } else {
 215     return config()->networkId() == sourceModel()->data(source_index, NetworkModel::NetworkIdRole).value<NetworkId>();
 216   }
 217 }
 218
 219 bool BufferViewFilter::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const {
 220   QModelIndex child = sourceModel()->index(source_row, 0, source_parent);
 221
 222   if(!child.isValid()) {
 223     qWarning() << "filterAcceptsRow has been called with an invalid Child";
 224     return false;
 225   }
 226
 227   if(!source_parent.isValid())
 228     return filterAcceptNetwork(child);
 229   else
 230     return filterAcceptBuffer(child);
 231 }
 232
 233 bool BufferViewFilter::lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
 234   int itemType = sourceModel()->data(source_left, NetworkModel::ItemTypeRole).toInt();
 235   switch(itemType) {
 236   case NetworkModel::NetworkItemType:
 237     return networkLessThan(source_left, source_right);
 238   case NetworkModel::BufferItemType:
 239     return bufferLessThan(source_left, source_right);
 240   default:
 241     return QSortFilterProxyModel::lessThan(source_left, source_right);
 242   }
 243 }
 244
 245 bool BufferViewFilter::bufferLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
 246   BufferId leftBufferId = sourceModel()->data(source_left, NetworkModel::BufferIdRole).value<BufferId>();
 247   BufferId rightBufferId = sourceModel()->data(source_right, NetworkModel::BufferIdRole).value<BufferId>();
 248   if(config()) {
 249     return config()->bufferList().indexOf(leftBufferId) < config()->bufferList().indexOf(rightBufferId);
 250   } else
 251     return bufferIdLessThan(leftBufferId, rightBufferId);
 252 }
 253
 254 bool BufferViewFilter::networkLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
 255   NetworkId leftNetworkId = sourceModel()->data(source_left, NetworkModel::NetworkIdRole).value<NetworkId>();
 256   NetworkId rightNetworkId = sourceModel()->data(source_right, NetworkModel::NetworkIdRole).value<NetworkId>();
 257
 258   if(config() && config()->sortAlphabetically())
 259     return QSortFilterProxyModel::lessThan(source_left, source_right);
 260   else
 261     return leftNetworkId < rightNetworkId;
 262 }
 263
 264 QVariant BufferViewFilter::data(const QModelIndex &index, int role) const {
 265   if(role == Qt::ForegroundRole)
 266     return foreground(index);
 267   else
 268     return QSortFilterProxyModel::data(index, role);
 269 }
 270
 271 QVariant BufferViewFilter::foreground(const QModelIndex &index) const {
 272   if(!index.data(NetworkModel::ItemActiveRole).toBool())
 273     return _FgColorInactiveActivity;
 274
 275   Buffer::ActivityLevel activity = (Buffer::ActivityLevel)index.data(NetworkModel::BufferActivityRole).toInt();
 276
 277   if(activity & Buffer::Highlight)
 278     return _FgColorHighlightActivity;
 279   if(activity & Buffer::NewMessage)
 280     return _FgColorNewMessageActivity;
 281   if(activity & Buffer::OtherActivity)
 282     return _FgColorOtherActivity;
 283
 284   return _FgColorNoActivity;
 285 }
 286
 287 void BufferViewFilter::checkPreviousCurrentForRemoval(const QModelIndex &current, const QModelIndex &previous) {
 288   Q_UNUSED(current);
 289   if(previous.isValid())
 290     QCoreApplication::postEvent(this, new CheckRemovalEvent(previous));
 291 }
 292
 293 void BufferViewFilter::customEvent(QEvent *event) {
 294   if(event->type() != QEvent::User)
 295     return;
 296
 297   CheckRemovalEvent *removalEvent = static_cast<CheckRemovalEvent *>(event);
 298   checkItemForRemoval(removalEvent->index);
 299
 300   event->accept();
 301 }
 302
 303 void BufferViewFilter::checkItemsForRemoval(const QModelIndex &topLeft, const QModelIndex &bottomRight) {
 304   QModelIndex source_topLeft = mapToSource(topLeft);
 305   QModelIndex source_bottomRight = mapToSource(bottomRight);
 306   emit _dataChanged(source_topLeft, source_bottomRight);
 307 }
 308
 309 // ******************************
 310 //  Helper
 311 // ******************************
 312 bool bufferIdLessThan(const BufferId &left, const BufferId &right) {
 313   Q_CHECK_PTR(Client::networkModel());
 314   if(!Client::networkModel())
 315     return true;
 316
 317   QModelIndex leftIndex = Client::networkModel()->bufferIndex(left);
 318   QModelIndex rightIndex = Client::networkModel()->bufferIndex(right);
 319
 320   int leftType = Client::networkModel()->data(leftIndex, NetworkModel::BufferTypeRole).toInt();
 321   int rightType = Client::networkModel()->data(rightIndex, NetworkModel::BufferTypeRole).toInt();
 322
 323   if(leftType != rightType)
 324     return leftType < rightType;
 325   else
 326     return QString::compare(Client::networkModel()->data(leftIndex, Qt::DisplayRole).toString(), Client::networkModel()->data(rightIndex, Qt::DisplayRole).toString(), Qt::CaseInsensitive) < 0;
 327 }
 328