1 /***************************************************************************
2 * Copyright (C) 2005-2015 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 "graphicalui.h"
33 #include "networkmodel.h"
36 class CheckRemovalEvent : public QEvent
39 CheckRemovalEvent(const QModelIndex &source_index) : QEvent(QEvent::User), index(source_index) {};
40 QPersistentModelIndex index;
44 /*****************************************
45 * The Filter for the Tree View
46 *****************************************/
47 BufferViewFilter::BufferViewFilter(QAbstractItemModel *model, BufferViewConfig *config)
48 : QSortFilterProxyModel(model),
50 _sortOrder(Qt::AscendingOrder),
51 _showServerQueries(false),
53 _enableEditMode(tr("Show / Hide Chats"), this)
56 setSourceModel(model);
58 setDynamicSortFilter(true);
60 connect(this, SIGNAL(_dataChanged(const QModelIndex &, const QModelIndex &)),
61 this, SLOT(_q_sourceDataChanged(QModelIndex, QModelIndex)));
63 _enableEditMode.setCheckable(true);
64 _enableEditMode.setChecked(_editMode);
65 connect(&_enableEditMode, SIGNAL(toggled(bool)), this, SLOT(enableEditMode(bool)));
67 BufferSettings defaultSettings;
68 defaultSettings.notify("ServerNoticesTarget", this, SLOT(showServerQueriesChanged()));
69 showServerQueriesChanged();
73 void BufferViewFilter::setConfig(BufferViewConfig *config)
75 if (_config == config)
79 disconnect(_config, 0, this, 0);
90 if (config->isInitialized()) {
94 // we use a queued connection here since manipulating the connection list of a sending object
95 // doesn't seem to be such a good idea while executing a connected slots.
96 connect(config, SIGNAL(initDone()), this, SLOT(configInitialized()), Qt::QueuedConnection);
102 void BufferViewFilter::configInitialized()
107 // connect(config(), SIGNAL(bufferViewNameSet(const QString &)), this, SLOT(invalidate()));
108 connect(config(), SIGNAL(configChanged()), this, SLOT(invalidate()));
109 // connect(config(), SIGNAL(networkIdSet(const NetworkId &)), this, SLOT(invalidate()));
110 // connect(config(), SIGNAL(addNewBuffersAutomaticallySet(bool)), this, SLOT(invalidate()));
111 // connect(config(), SIGNAL(sortAlphabeticallySet(bool)), this, SLOT(invalidate()));
112 // connect(config(), SIGNAL(hideInactiveBuffersSet(bool)), this, SLOT(invalidate()));
113 // connect(config(), SIGNAL(allowedBufferTypesSet(int)), this, SLOT(invalidate()));
114 // connect(config(), SIGNAL(minimumActivitySet(int)), this, SLOT(invalidate()));
115 // connect(config(), SIGNAL(bufferListSet()), this, SLOT(invalidate()));
116 // connect(config(), SIGNAL(bufferAdded(const BufferId &, int)), this, SLOT(invalidate()));
117 // connect(config(), SIGNAL(bufferMoved(const BufferId &, int)), this, SLOT(invalidate()));
118 // connect(config(), SIGNAL(bufferRemoved(const BufferId &)), this, SLOT(invalidate()));
119 // connect(config(), SIGNAL(bufferPermanentlyRemoved(const BufferId &)), this, SLOT(invalidate()));
121 disconnect(config(), SIGNAL(initDone()), this, SLOT(configInitialized()));
123 setObjectName(config()->bufferViewName());
126 emit configChanged();
130 void BufferViewFilter::showServerQueriesChanged()
132 BufferSettings bufferSettings;
134 bool showQueries = (bufferSettings.serverNoticesTarget() & BufferSettings::DefaultBuffer);
135 if (_showServerQueries != showQueries) {
136 _showServerQueries = showQueries;
142 QList<QAction *> BufferViewFilter::actions(const QModelIndex &index)
145 QList<QAction *> actionList;
146 actionList << &_enableEditMode;
151 void BufferViewFilter::enableEditMode(bool enable)
153 if (_editMode == enable) {
161 if (enable == false) {
162 addBuffers(QList<BufferId>::fromSet(_toAdd));
163 QSet<BufferId>::const_iterator iter;
164 for (iter = _toTempRemove.constBegin(); iter != _toTempRemove.constEnd(); iter++) {
165 if (config()->temporarilyRemovedBuffers().contains(*iter))
167 config()->requestRemoveBuffer(*iter);
169 for (iter = _toRemove.constBegin(); iter != _toRemove.constEnd(); iter++) {
170 if (config()->removedBuffers().contains(*iter))
172 config()->requestRemoveBufferPermanently(*iter);
176 _toTempRemove.clear();
183 Qt::ItemFlags BufferViewFilter::flags(const QModelIndex &index) const
185 QModelIndex source_index = mapToSource(index);
186 Qt::ItemFlags flags = sourceModel()->flags(source_index);
188 NetworkModel::ItemType itemType = (NetworkModel::ItemType)sourceModel()->data(source_index, NetworkModel::ItemTypeRole).toInt();
189 BufferInfo::Type bufferType = (BufferInfo::Type)sourceModel()->data(source_index, NetworkModel::BufferTypeRole).toInt();
190 if (source_index == QModelIndex() || itemType == NetworkModel::NetworkItemType) {
191 flags |= Qt::ItemIsDropEnabled;
193 else if (_editMode) {
194 flags |= Qt::ItemIsUserCheckable | Qt::ItemIsTristate;
197 // prohibit dragging of most items. and most drop places
198 // only query to query is allowed for merging
199 if (bufferType != BufferInfo::QueryBuffer) {
200 ClientBufferViewConfig *clientConf = qobject_cast<ClientBufferViewConfig *>(config());
201 if (clientConf && clientConf->isLocked()) {
202 flags &= ~(Qt::ItemIsDropEnabled | Qt::ItemIsDragEnabled);
210 bool BufferViewFilter::dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
212 if (!config() || !NetworkModel::mimeContainsBufferList(data))
213 return QSortFilterProxyModel::dropMimeData(data, action, row, column, parent);
215 NetworkId droppedNetworkId;
216 QModelIndex source_parent = mapToSource(parent);
217 if (sourceModel()->data(source_parent, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
218 droppedNetworkId = sourceModel()->data(source_parent, NetworkModel::NetworkIdRole).value<NetworkId>();
220 QList<QPair<NetworkId, BufferId> > bufferList = NetworkModel::mimeDataToBufferList(data);
224 for (int i = 0; i < bufferList.count(); i++) {
225 networkId = bufferList[i].first;
226 bufferId = bufferList[i].second;
227 if (droppedNetworkId == networkId) {
231 if (row < rowCount(parent)) {
232 QModelIndex source_child = mapToSource(index(row, 0, parent));
233 BufferId beforeBufferId = sourceModel()->data(source_child, NetworkModel::BufferIdRole).value<BufferId>();
234 pos = config()->bufferList().indexOf(beforeBufferId);
235 if (_sortOrder == Qt::DescendingOrder)
239 if (_sortOrder == Qt::AscendingOrder)
240 pos = config()->bufferList().count();
245 if (config()->bufferList().contains(bufferId) && !config()->sortAlphabetically()) {
246 if (config()->bufferList().indexOf(bufferId) < pos)
248 ClientBufferViewConfig *clientConf = qobject_cast<ClientBufferViewConfig *>(config());
249 if (!clientConf || !clientConf->isLocked())
250 config()->requestMoveBuffer(bufferId, pos);
253 config()->requestAddBuffer(bufferId, pos);
264 void BufferViewFilter::sort(int column, Qt::SortOrder order)
267 QSortFilterProxyModel::sort(column, order);
271 void BufferViewFilter::addBuffer(const BufferId &bufferId) const
273 if (!config() || config()->bufferList().contains(bufferId))
276 int pos = config()->bufferList().count();
278 for (int i = 0; i < config()->bufferList().count(); i++) {
279 if (config() && config()->sortAlphabetically())
280 lt = bufferIdLessThan(bufferId, config()->bufferList()[i]);
282 lt = bufferId < config()->bufferList()[i];
289 config()->requestAddBuffer(bufferId, pos);
293 void BufferViewFilter::addBuffers(const QList<BufferId> &bufferIds) const
298 QList<BufferId> bufferList = config()->bufferList();
299 foreach(BufferId bufferId, bufferIds) {
300 if (bufferList.contains(bufferId))
303 int pos = bufferList.count();
305 for (int i = 0; i < bufferList.count(); i++) {
306 if (config() && config()->sortAlphabetically())
307 lt = bufferIdLessThan(bufferId, bufferList[i]);
309 lt = bufferId < config()->bufferList()[i];
313 bufferList.insert(pos, bufferId);
317 config()->requestAddBuffer(bufferId, pos);
322 bool BufferViewFilter::filterAcceptBuffer(const QModelIndex &source_bufferIndex) const
324 // no config -> "all buffers" -> accept everything
328 BufferId bufferId = sourceModel()->data(source_bufferIndex, NetworkModel::BufferIdRole).value<BufferId>();
329 Q_ASSERT(bufferId.isValid());
331 int activityLevel = sourceModel()->data(source_bufferIndex, NetworkModel::BufferActivityRole).toInt();
333 if (!config()->bufferList().contains(bufferId) && !_editMode) {
334 // add the buffer if...
335 if (config()->isInitialized()
336 && !config()->removedBuffers().contains(bufferId) // it hasn't been manually removed and either
337 && ((config()->addNewBuffersAutomatically() && !config()->temporarilyRemovedBuffers().contains(bufferId)) // is totally unknown to us (a new buffer)...
338 || (config()->temporarilyRemovedBuffers().contains(bufferId) && activityLevel > BufferInfo::OtherActivity))) { // or was just temporarily hidden and has a new message waiting for us.
341 // note: adding the buffer to the valid list does not temper with the following filters ("show only channels" and stuff)
345 if (config()->networkId().isValid() && config()->networkId() != sourceModel()->data(source_bufferIndex, NetworkModel::NetworkIdRole).value<NetworkId>())
348 int allowedBufferTypes = config()->allowedBufferTypes();
349 if (!config()->networkId().isValid())
350 allowedBufferTypes &= ~BufferInfo::StatusBuffer;
351 int bufferType = sourceModel()->data(source_bufferIndex, NetworkModel::BufferTypeRole).toInt();
352 if (!(allowedBufferTypes & bufferType))
355 if (bufferType & BufferInfo::QueryBuffer && !_showServerQueries && sourceModel()->data(source_bufferIndex, Qt::DisplayRole).toString().contains('.')) {
359 // the following dynamic filters may not trigger if the buffer is currently selected.
360 QModelIndex currentIndex = Client::bufferModel()->standardSelectionModel()->currentIndex();
361 if (bufferId == Client::bufferModel()->data(currentIndex, NetworkModel::BufferIdRole).value<BufferId>())
364 if (config()->hideInactiveBuffers() && !sourceModel()->data(source_bufferIndex, NetworkModel::ItemActiveRole).toBool() && activityLevel <= BufferInfo::OtherActivity)
367 if (config()->minimumActivity() > activityLevel)
374 bool BufferViewFilter::filterAcceptNetwork(const QModelIndex &source_index) const
379 if (config()->hideInactiveNetworks() && !(sourceModel()->data(source_index, NetworkModel::ItemActiveRole).toBool())) {
383 if (!config()->networkId().isValid()) {
387 return config()->networkId() == sourceModel()->data(source_index, NetworkModel::NetworkIdRole).value<NetworkId>();
392 bool BufferViewFilter::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const
394 QModelIndex child = sourceModel()->index(source_row, 0, source_parent);
396 if (!child.isValid()) {
397 qWarning() << "filterAcceptsRow has been called with an invalid Child";
401 NetworkModel::ItemType childType = (NetworkModel::ItemType)sourceModel()->data(child, NetworkModel::ItemTypeRole).toInt();
403 case NetworkModel::NetworkItemType:
404 return filterAcceptNetwork(child);
405 case NetworkModel::BufferItemType:
406 return filterAcceptBuffer(child);
413 bool BufferViewFilter::lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const
415 int leftItemType = sourceModel()->data(source_left, NetworkModel::ItemTypeRole).toInt();
416 int rightItemType = sourceModel()->data(source_right, NetworkModel::ItemTypeRole).toInt();
417 int itemType = leftItemType & rightItemType;
419 case NetworkModel::NetworkItemType:
420 return networkLessThan(source_left, source_right);
421 case NetworkModel::BufferItemType:
422 return bufferLessThan(source_left, source_right);
424 return QSortFilterProxyModel::lessThan(source_left, source_right);
429 bool BufferViewFilter::bufferLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const
431 BufferId leftBufferId = sourceModel()->data(source_left, NetworkModel::BufferIdRole).value<BufferId>();
432 BufferId rightBufferId = sourceModel()->data(source_right, NetworkModel::BufferIdRole).value<BufferId>();
434 int leftPos = config()->bufferList().indexOf(leftBufferId);
435 int rightPos = config()->bufferList().indexOf(rightBufferId);
436 if (leftPos == -1 && rightPos == -1)
437 return QSortFilterProxyModel::lessThan(source_left, source_right);
438 if (leftPos == -1 || rightPos == -1)
439 return !(leftPos < rightPos);
440 return leftPos < rightPos;
443 return bufferIdLessThan(leftBufferId, rightBufferId);
447 bool BufferViewFilter::networkLessThan(const QModelIndex &source_left, const QModelIndex &source_right) const
449 // NetworkId leftNetworkId = sourceModel()->data(source_left, NetworkModel::NetworkIdRole).value<NetworkId>();
450 // NetworkId rightNetworkId = sourceModel()->data(source_right, NetworkModel::NetworkIdRole).value<NetworkId>();
452 return QSortFilterProxyModel::lessThan(source_left, source_right);
456 QVariant BufferViewFilter::data(const QModelIndex &index, int role) const
460 case Qt::ForegroundRole:
461 case Qt::BackgroundRole:
462 case Qt::DecorationRole:
463 if ((config() && config()->disableDecoration()))
465 return GraphicalUi::uiStyle()->bufferViewItemData(mapToSource(index), role);
466 case Qt::CheckStateRole:
467 return checkedState(index);
469 return QSortFilterProxyModel::data(index, role);
474 QVariant BufferViewFilter::checkedState(const QModelIndex &index) const
476 if (!_editMode || !config())
479 QModelIndex source_index = mapToSource(index);
480 if (source_index == QModelIndex() || sourceModel()->data(source_index, NetworkModel::ItemTypeRole) == NetworkModel::NetworkItemType)
483 BufferId bufferId = sourceModel()->data(source_index, NetworkModel::BufferIdRole).value<BufferId>();
484 if (_toAdd.contains(bufferId))
487 if (_toTempRemove.contains(bufferId))
488 return Qt::PartiallyChecked;
490 if (_toRemove.contains(bufferId))
491 return Qt::Unchecked;
493 if (config()->bufferList().contains(bufferId))
496 if (config()->temporarilyRemovedBuffers().contains(bufferId))
497 return Qt::PartiallyChecked;
499 return Qt::Unchecked;
503 bool BufferViewFilter::setData(const QModelIndex &index, const QVariant &value, int role)
506 case Qt::CheckStateRole:
507 return setCheckedState(index, Qt::CheckState(value.toInt()));
509 return QSortFilterProxyModel::setData(index, value, role);
514 bool BufferViewFilter::setCheckedState(const QModelIndex &index, Qt::CheckState state)
516 QModelIndex source_index = mapToSource(index);
517 BufferId bufferId = sourceModel()->data(source_index, NetworkModel::BufferIdRole).value<BufferId>();
518 if (!bufferId.isValid())
523 _toAdd.remove(bufferId);
524 _toTempRemove.remove(bufferId);
525 _toRemove << bufferId;
527 case Qt::PartiallyChecked:
528 _toAdd.remove(bufferId);
529 _toTempRemove << bufferId;
530 _toRemove.remove(bufferId);
534 _toTempRemove.remove(bufferId);
535 _toRemove.remove(bufferId);
540 emit dataChanged(index, index);
545 void BufferViewFilter::checkPreviousCurrentForRemoval(const QModelIndex ¤t, const QModelIndex &previous)
548 if (previous.isValid())
549 QCoreApplication::postEvent(this, new CheckRemovalEvent(previous));
553 void BufferViewFilter::customEvent(QEvent *event)
555 if (event->type() != QEvent::User)
558 CheckRemovalEvent *removalEvent = static_cast<CheckRemovalEvent *>(event);
559 checkItemForRemoval(removalEvent->index);
565 void BufferViewFilter::checkItemsForRemoval(const QModelIndex &topLeft, const QModelIndex &bottomRight)
567 QModelIndex source_topLeft = mapToSource(topLeft);
568 QModelIndex source_bottomRight = mapToSource(bottomRight);
569 emit _dataChanged(source_topLeft, source_bottomRight);
573 bool BufferViewFilter::bufferIdLessThan(const BufferId &left, const BufferId &right)
575 Q_CHECK_PTR(Client::networkModel());
576 if (!Client::networkModel())
579 QModelIndex leftIndex = Client::networkModel()->bufferIndex(left);
580 QModelIndex rightIndex = Client::networkModel()->bufferIndex(right);
582 int leftType = Client::networkModel()->data(leftIndex, NetworkModel::BufferTypeRole).toInt();
583 int rightType = Client::networkModel()->data(rightIndex, NetworkModel::BufferTypeRole).toInt();
585 if (leftType != rightType)
586 return leftType < rightType;
588 return QString::compare(Client::networkModel()->data(leftIndex, Qt::DisplayRole).toString(), Client::networkModel()->data(rightIndex, Qt::DisplayRole).toString(), Qt::CaseInsensitive) < 0;