1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #include "bufferviewfilter.h"
23 #include <QApplication>
27 #include "bufferinfo.h"
28 #include "buffermodel.h"
29 #include "buffersettings.h"
31 #include "clientbufferviewconfig.h"
32 #include "iconloader.h"
33 #include "networkmodel.h"
35 class CheckRemovalEvent : public QEvent {
37 CheckRemovalEvent(const QModelIndex &source_index) : QEvent(QEvent::User), index(source_index) {};
38 QPersistentModelIndex index;
41 /*****************************************
42 * The Filter for the Tree View
43 *****************************************/
44 BufferViewFilter::BufferViewFilter(QAbstractItemModel *model, BufferViewConfig *config)
45 : QSortFilterProxyModel(model),
47 _sortOrder(Qt::AscendingOrder),
48 _channelJoinedIcon(SmallIcon("user-online")),
49 _channelPartedIcon(SmallIcon("user-offline")),
50 _userOfflineIcon(SmallIcon("im-user-offline")),
51 _userAwayIcon(SmallIcon("im-user-away")),
52 _userOnlineIcon(SmallIcon("im-user")),
54 _enableEditMode(tr("Show / Hide buffers"), this)
57 setSourceModel(model);
59 setDynamicSortFilter(true);
61 connect(this, SIGNAL(_dataChanged(const QModelIndex &, const QModelIndex &)),
62 this, SLOT(_q_sourceDataChanged(QModelIndex,QModelIndex)));
64 _enableEditMode.setCheckable(true);
65 _enableEditMode.setChecked(_editMode);
66 connect(&_enableEditMode, SIGNAL(toggled(bool)), this, SLOT(enableEditMode(bool)));
68 BufferSettings bufferSettings;
69 _showUserStateIcons = bufferSettings.showUserStateIcons();
70 bufferSettings.notify("ShowUserStateIcons", this, SLOT(showUserStateIconsChanged()));
73 void BufferViewFilter::showUserStateIconsChanged() {
74 BufferSettings bufferSettings;
75 _showUserStateIcons = bufferSettings.showUserStateIcons();
78 void BufferViewFilter::setConfig(BufferViewConfig *config) {
83 disconnect(_config, 0, this, 0);
94 if(config->isInitialized()) {
97 connect(config, SIGNAL(initDone()), this, SLOT(configInitialized()));
102 void BufferViewFilter::configInitialized() {
106 connect(config(), SIGNAL(bufferViewNameSet(const QString &)), this, SLOT(invalidate()));
107 connect(config(), SIGNAL(networkIdSet(const NetworkId &)), this, SLOT(invalidate()));
108 connect(config(), SIGNAL(addNewBuffersAutomaticallySet(bool)), this, SLOT(invalidate()));
109 connect(config(), SIGNAL(sortAlphabeticallySet(bool)), this, SLOT(invalidate()));
110 connect(config(), SIGNAL(hideInactiveBuffersSet(bool)), this, SLOT(invalidate()));
111 connect(config(), SIGNAL(allowedBufferTypesSet(int)), this, SLOT(invalidate()));
112 connect(config(), SIGNAL(minimumActivitySet(int)), this, SLOT(invalidate()));
113 connect(config(), SIGNAL(bufferListSet()), this, SLOT(invalidate()));
114 connect(config(), SIGNAL(bufferAdded(const BufferId &, int)), this, SLOT(invalidate()));
115 connect(config(), SIGNAL(bufferMoved(const BufferId &, int)), this, SLOT(invalidate()));
116 connect(config(), SIGNAL(bufferRemoved(const BufferId &)), this, SLOT(invalidate()));
117 connect(config(), SIGNAL(bufferPermanentlyRemoved(const BufferId &)), this, SLOT(invalidate()));
119 disconnect(config(), SIGNAL(initDone()), this, SLOT(configInitialized()));
121 setObjectName(config()->bufferViewName());
124 emit configChanged();
127 QList<QAction *> BufferViewFilter::actions(const QModelIndex &index) {
129 QList<QAction *> actionList;
130 actionList << &_enableEditMode;
134 void BufferViewFilter::enableEditMode(bool enable) {
135 if(_editMode == enable) {
143 if(enable == false) {
144 int numBuffers = config()->bufferList().count();
145 QSet<BufferId>::const_iterator iter;
146 for(iter = _toAdd.constBegin(); iter != _toAdd.constEnd(); iter++) {
147 if(config()->bufferList().contains(*iter))
149 config()->requestAddBuffer(*iter, numBuffers);
151 for(iter = _toTempRemove.constBegin(); iter != _toTempRemove.constEnd(); iter++) {
152 if(config()->temporarilyRemovedBuffers().contains(*iter))
154 config()->requestRemoveBuffer(*iter);
156 for(iter = _toRemove.constBegin(); iter != _toRemove.constEnd(); iter++) {
157 if(config()->removedBuffers().contains(*iter))
159 config()->requestRemoveBufferPermanently(*iter);
163 _toTempRemove.clear();
170 Qt::ItemFlags BufferViewFilter::flags(const QModelIndex &index) const {
171 QModelIndex source_index = mapToSource(index);
172 Qt::ItemFlags flags = sourceModel()->flags(source_index);
174 NetworkModel::ItemType itemType = (NetworkModel::ItemType)sourceModel()->data(source_index, NetworkModel::ItemTypeRole).toInt();
175 BufferInfo::Type bufferType = (BufferInfo::Type)sourceModel()->data(source_index, NetworkModel::BufferTypeRole).toInt();
176 if(source_index == QModelIndex() || itemType == NetworkModel::NetworkItemType) {
177 flags |= Qt::ItemIsDropEnabled;
178 } else if(_editMode) {
179 flags |= Qt::ItemIsUserCheckable | Qt::ItemIsTristate;
182 // prohibit dragging of most items. and most drop places
183 // only query to query is allowed for merging
184 if(bufferType != BufferInfo::QueryBuffer) {
185 ClientBufferViewConfig *clientConf = qobject_cast<ClientBufferViewConfig *>(config());
186 if(clientConf && clientConf->isLocked()) {
187 flags &= ~(Qt::ItemIsDropEnabled | Qt::ItemIsDragEnabled);
194 bool BufferViewFilter::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) {
195 if(!config() || !NetworkModel::mimeContainsBufferList(data))
196 return QSortFilterProxyModel::dropMimeData(data, action, row, column, parent);
198 NetworkId droppedNetworkId;
199 QModelIndex source_parent = mapToSource(parent);
200 if(sourceModel()->data(source_parent, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
201 droppedNetworkId = sourceModel()->data(source_parent, NetworkModel::NetworkIdRole).value<NetworkId>();
203 QList< QPair<NetworkId, BufferId> > bufferList = NetworkModel::mimeDataToBufferList(data);
207 for(int i = 0; i < bufferList.count(); i++) {
208 networkId = bufferList[i].first;
209 bufferId = bufferList[i].second;
210 if(droppedNetworkId == networkId) {
214 if(row < rowCount(parent)) {
215 QModelIndex source_child = mapToSource(index(row, 0, parent));
216 BufferId beforeBufferId = sourceModel()->data(source_child, NetworkModel::BufferIdRole).value<BufferId>();
217 pos = config()->bufferList().indexOf(beforeBufferId);
218 if(_sortOrder == Qt::DescendingOrder)
221 if(_sortOrder == Qt::AscendingOrder)
222 pos = config()->bufferList().count();
227 if(config()->bufferList().contains(bufferId)) {
228 if(config()->bufferList().indexOf(bufferId) < pos)
230 config()->requestMoveBuffer(bufferId, pos);
232 config()->requestAddBuffer(bufferId, pos);
242 void BufferViewFilter::sort(int column, Qt::SortOrder order) {
244 QSortFilterProxyModel::sort(column, order);
247 void BufferViewFilter::addBuffer(const BufferId &bufferId) const {
248 if(!config() || config()->bufferList().contains(bufferId))
251 int pos = config()->bufferList().count();
253 for(int i = 0; i < config()->bufferList().count(); i++) {
254 if(config() && config()->sortAlphabetically())
255 lt = bufferIdLessThan(bufferId, config()->bufferList()[i]);
257 lt = bufferId < config()->bufferList()[i];
264 config()->requestAddBuffer(bufferId, pos);
267 bool BufferViewFilter::filterAcceptBuffer(const QModelIndex &source_bufferIndex) const {
268 // no config -> "all buffers" -> accept everything
272 BufferId bufferId = sourceModel()->data(source_bufferIndex, NetworkModel::BufferIdRole).value<BufferId>();
273 Q_ASSERT(bufferId.isValid());
275 int activityLevel = sourceModel()->data(source_bufferIndex, NetworkModel::BufferActivityRole).toInt();
277 if(!config()->bufferList().contains(bufferId) && !_editMode) {
278 // add the buffer if...
279 if(config()->isInitialized()
280 && !config()->removedBuffers().contains(bufferId) // it hasn't been manually removed and either
281 && ((config()->addNewBuffersAutomatically() && !config()->temporarilyRemovedBuffers().contains(bufferId)) // is totally unknown to us (a new buffer)...
282 || (config()->temporarilyRemovedBuffers().contains(bufferId) && activityLevel > BufferInfo::OtherActivity))) { // or was just temporarily hidden and has a new message waiting for us.
285 // note: adding the buffer to the valid list does not temper with the following filters ("show only channels" and stuff)
289 if(config()->networkId().isValid() && config()->networkId() != sourceModel()->data(source_bufferIndex, NetworkModel::NetworkIdRole).value<NetworkId>())
292 int allowedBufferTypes = config()->allowedBufferTypes();
293 if(!config()->networkId().isValid())
294 allowedBufferTypes &= ~BufferInfo::StatusBuffer;
295 if(!(allowedBufferTypes & sourceModel()->data(source_bufferIndex, NetworkModel::BufferTypeRole).toInt()))
298 // the following dynamic filters may not trigger if the buffer is currently selected.
299 QModelIndex currentIndex = Client::bufferModel()->standardSelectionModel()->currentIndex();
300 if(bufferId == Client::bufferModel()->data(currentIndex, NetworkModel::BufferIdRole).value<BufferId>())
303 if(config()->hideInactiveBuffers() && !sourceModel()->data(source_bufferIndex, NetworkModel::ItemActiveRole).toBool() && activityLevel <= BufferInfo::OtherActivity)
306 if(config()->minimumActivity() > activityLevel)
312 bool BufferViewFilter::filterAcceptNetwork(const QModelIndex &source_index) const {
316 if(!config()->networkId().isValid()) {
319 return config()->networkId() == sourceModel()->data(source_index, NetworkModel::NetworkIdRole).value<NetworkId>();
323 bool BufferViewFilter::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const {
324 QModelIndex child = sourceModel()->index(source_row, 0, source_parent);
326 if(!child.isValid()) {
327 qWarning() << "filterAcceptsRow has been called with an invalid Child";
331 NetworkModel::ItemType childType = (NetworkModel::ItemType)sourceModel()->data(child, NetworkModel::ItemTypeRole).toInt();
333 case NetworkModel::NetworkItemType:
334 return filterAcceptNetwork(child);
335 case NetworkModel::BufferItemType:
336 return filterAcceptBuffer(child);
342 bool BufferViewFilter::lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
343 int leftItemType = sourceModel()->data(source_left, NetworkModel::ItemTypeRole).toInt();
344 int rightItemType = sourceModel()->data(source_right, NetworkModel::ItemTypeRole).toInt();
345 int itemType = leftItemType & rightItemType;
347 case NetworkModel::NetworkItemType:
348 return networkLessThan(source_left, source_right);
349 case NetworkModel::BufferItemType:
350 return bufferLessThan(source_left, source_right);
352 return QSortFilterProxyModel::lessThan(source_left, source_right);
356 bool BufferViewFilter::bufferLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
357 BufferId leftBufferId = sourceModel()->data(source_left, NetworkModel::BufferIdRole).value<BufferId>();
358 BufferId rightBufferId = sourceModel()->data(source_right, NetworkModel::BufferIdRole).value<BufferId>();
360 int leftPos = config()->bufferList().indexOf(leftBufferId);
361 int rightPos = config()->bufferList().indexOf(rightBufferId);
362 if(leftPos == -1 && rightPos == -1)
363 return QSortFilterProxyModel::lessThan(source_left, source_right);
364 if(leftPos == -1 || rightPos == -1)
365 return !(leftPos < rightPos);
366 return leftPos < rightPos;
368 return bufferIdLessThan(leftBufferId, rightBufferId);
371 bool BufferViewFilter::networkLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const {
372 NetworkId leftNetworkId = sourceModel()->data(source_left, NetworkModel::NetworkIdRole).value<NetworkId>();
373 NetworkId rightNetworkId = sourceModel()->data(source_right, NetworkModel::NetworkIdRole).value<NetworkId>();
375 return QSortFilterProxyModel::lessThan(source_left, source_right);
378 QVariant BufferViewFilter::data(const QModelIndex &index, int role) const {
380 case Qt::DecorationRole:
382 case Qt::CheckStateRole:
383 return checkedState(index);
385 return QSortFilterProxyModel::data(index, role);
389 QVariant BufferViewFilter::icon(const QModelIndex &index) const {
390 if(!_showUserStateIcons || (config() && config()->disableDecoration()))
393 if(index.column() != 0)
396 QModelIndex source_index = mapToSource(index);
397 NetworkModel::ItemType itemType = (NetworkModel::ItemType)sourceModel()->data(source_index, NetworkModel::ItemTypeRole).toInt();
398 BufferInfo::Type bufferType = (BufferInfo::Type)sourceModel()->data(source_index, NetworkModel::BufferTypeRole).toInt();
399 bool isActive = sourceModel()->data(source_index, NetworkModel::ItemActiveRole).toBool();
401 if(itemType != NetworkModel::BufferItemType)
405 case BufferInfo::ChannelBuffer:
407 return _channelJoinedIcon;
409 return _channelPartedIcon;
410 case BufferInfo::QueryBuffer:
412 return _userOfflineIcon;
413 if(sourceModel()->data(source_index, NetworkModel::UserAwayRole).toBool())
414 return _userAwayIcon;
416 return _userOnlineIcon;
422 QVariant BufferViewFilter::checkedState(const QModelIndex &index) const {
423 if(!_editMode || !config())
426 QModelIndex source_index = mapToSource(index);
427 if(source_index == QModelIndex() || sourceModel()->data(source_index, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
430 BufferId bufferId = sourceModel()->data(source_index, NetworkModel::BufferIdRole).value<BufferId>();
431 if(_toAdd.contains(bufferId))
434 if(_toTempRemove.contains(bufferId))
435 return Qt::PartiallyChecked;
437 if(_toRemove.contains(bufferId))
438 return Qt::Unchecked;
440 if(config()->bufferList().contains(bufferId))
443 if(config()->temporarilyRemovedBuffers().contains(bufferId))
444 return Qt::PartiallyChecked;
446 return Qt::Unchecked;
449 bool BufferViewFilter::setData(const QModelIndex &index, const QVariant &value, int role) {
451 case Qt::CheckStateRole:
452 return setCheckedState(index, Qt::CheckState(value.toInt()));
454 return QSortFilterProxyModel::setData(index, value, role);
458 bool BufferViewFilter::setCheckedState(const QModelIndex &index, Qt::CheckState state) {
459 QModelIndex source_index = mapToSource(index);
460 BufferId bufferId = sourceModel()->data(source_index, NetworkModel::BufferIdRole).value<BufferId>();
461 if(!bufferId.isValid())
466 _toAdd.remove(bufferId);
467 _toTempRemove.remove(bufferId);
468 _toRemove << bufferId;
470 case Qt::PartiallyChecked:
471 _toAdd.remove(bufferId);
472 _toTempRemove << bufferId;
473 _toRemove.remove(bufferId);
477 _toTempRemove.remove(bufferId);
478 _toRemove.remove(bufferId);
483 emit dataChanged(index, index);
487 void BufferViewFilter::checkPreviousCurrentForRemoval(const QModelIndex ¤t, const QModelIndex &previous) {
489 if(previous.isValid())
490 QCoreApplication::postEvent(this, new CheckRemovalEvent(previous));
493 void BufferViewFilter::customEvent(QEvent *event) {
494 if(event->type() != QEvent::User)
497 CheckRemovalEvent *removalEvent = static_cast<CheckRemovalEvent *>(event);
498 checkItemForRemoval(removalEvent->index);
503 void BufferViewFilter::checkItemsForRemoval(const QModelIndex &topLeft, const QModelIndex &bottomRight) {
504 QModelIndex source_topLeft = mapToSource(topLeft);
505 QModelIndex source_bottomRight = mapToSource(bottomRight);
506 emit _dataChanged(source_topLeft, source_bottomRight);
509 bool BufferViewFilter::bufferIdLessThan(const BufferId &left, const BufferId &right) {
510 Q_CHECK_PTR(Client::networkModel());
511 if(!Client::networkModel())
514 QModelIndex leftIndex = Client::networkModel()->bufferIndex(left);
515 QModelIndex rightIndex = Client::networkModel()->bufferIndex(right);
517 int leftType = Client::networkModel()->data(leftIndex, NetworkModel::BufferTypeRole).toInt();
518 int rightType = Client::networkModel()->data(rightIndex, NetworkModel::BufferTypeRole).toInt();
520 if(leftType != rightType)
521 return leftType < rightType;
523 return QString::compare(Client::networkModel()->data(leftIndex, Qt::DisplayRole).toString(), Client::networkModel()->data(rightIndex, Qt::DisplayRole).toString(), Qt::CaseInsensitive) < 0;