src/gui/transferlistsortmodel.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2013  Nick Tiskov <daymansmail@gmail.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   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 Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #include "transferlistsortmodel.h"
  30
  31 #include <type_traits>
  32
  33 #include <QDateTime>
  34
  35 #include "base/bittorrent/infohash.h"
  36 #include "base/bittorrent/torrent.h"
  37 #include "transferlistmodel.h"
  38
  39 namespace
  40 {
  41     template <typename T>
  42     int threeWayCompare(const T &left, const T &right)
  43     {
  44         if (left == right)
  45             return 0;
  46         return (left < right) ? -1 : 1;
  47     }
  48
  49     int customCompare(const QDateTime &left, const QDateTime &right)
  50     {
  51         const bool isLeftValid = left.isValid();
  52         const bool isRightValid = right.isValid();
  53
  54         if (isLeftValid && isRightValid)
  55             return threeWayCompare(left, right);
  56         if (!isLeftValid && !isRightValid)
  57             return 0;
  58         return isLeftValid ? -1 : 1;
  59     }
  60
  61     int customCompare(const TagSet &left, const TagSet &right, const Utils::Compare::NaturalCompare<Qt::CaseInsensitive> &compare)
  62     {
  63         for (auto leftIter = left.cbegin(), rightIter = right.cbegin();
  64             (leftIter != left.cend()) && (rightIter != right.cend());
  65             ++leftIter, ++rightIter)
  66         {
  67             const int result = compare(*leftIter, *rightIter);
  68             if (result != 0)
  69                 return result;
  70         }
  71         return threeWayCompare(left.size(), right.size());
  72     }
  73
  74     template <typename T>
  75     int customCompare(const T left, const T right)
  76     {
  77         static_assert(std::is_arithmetic_v<T>);
  78
  79         const bool isLeftValid = (left >= 0);
  80         const bool isRightValid = (right >= 0);
  81
  82         if (isLeftValid && isRightValid)
  83             return threeWayCompare(left, right);
  84         if (!isLeftValid && !isRightValid)
  85             return 0;
  86         return isLeftValid ? -1 : 1;
  87     }
  88
  89     int adjustSubSortColumn(const int column)
  90     {
  91         return ((column >= 0) && (column < TransferListModel::NB_COLUMNS))
  92                    ? column : TransferListModel::TR_NAME;
  93     }
  94 }
  95
  96 TransferListSortModel::TransferListSortModel(QObject *parent)
  97     : QSortFilterProxyModel {parent}
  98     , m_subSortColumn {"TransferList/SubSortColumn", TransferListModel::TR_NAME, adjustSubSortColumn}
  99     , m_subSortOrder {"TransferList/SubSortOrder", 0}
 100 {
 101     setSortRole(TransferListModel::UnderlyingDataRole);
 102 }
 103
 104 void TransferListSortModel::sort(const int column, const Qt::SortOrder order)
 105 {
 106     if ((m_lastSortColumn != column) && (m_lastSortColumn != -1))
 107     {
 108         m_subSortColumn = m_lastSortColumn;
 109         m_subSortOrder = m_lastSortOrder;
 110     }
 111     m_lastSortColumn = column;
 112     m_lastSortOrder = ((order == Qt::AscendingOrder) ? 0 : 1);
 113
 114     QSortFilterProxyModel::sort(column, order);
 115 }
 116
 117 void TransferListSortModel::setStatusFilter(TorrentFilter::Type filter)
 118 {
 119     if (m_filter.setType(filter))
 120         invalidateFilter();
 121 }
 122
 123 void TransferListSortModel::setCategoryFilter(const QString &category)
 124 {
 125     if (m_filter.setCategory(category))
 126         invalidateFilter();
 127 }
 128
 129 void TransferListSortModel::disableCategoryFilter()
 130 {
 131     if (m_filter.setCategory(TorrentFilter::AnyCategory))
 132         invalidateFilter();
 133 }
 134
 135 void TransferListSortModel::setTagFilter(const QString &tag)
 136 {
 137     if (m_filter.setTag(tag))
 138         invalidateFilter();
 139 }
 140
 141 void TransferListSortModel::disableTagFilter()
 142 {
 143     if (m_filter.setTag(TorrentFilter::AnyTag))
 144         invalidateFilter();
 145 }
 146
 147 void TransferListSortModel::setTrackerFilter(const QSet<BitTorrent::TorrentID> &torrentIDs)
 148 {
 149     if (m_filter.setTorrentIDSet(torrentIDs))
 150         invalidateFilter();
 151 }
 152
 153 void TransferListSortModel::disableTrackerFilter()
 154 {
 155     if (m_filter.setTorrentIDSet(TorrentFilter::AnyID))
 156         invalidateFilter();
 157 }
 158
 159 int TransferListSortModel::compare(const QModelIndex &left, const QModelIndex &right) const
 160 {
 161     const int compareColumn = left.column();
 162     const QVariant leftValue = left.data(TransferListModel::UnderlyingDataRole);
 163     const QVariant rightValue = right.data(TransferListModel::UnderlyingDataRole);
 164
 165     switch (compareColumn)
 166     {
 167     case TransferListModel::TR_CATEGORY:
 168     case TransferListModel::TR_NAME:
 169     case TransferListModel::TR_SAVE_PATH:
 170     case TransferListModel::TR_TRACKER:
 171         return m_naturalCompare(leftValue.toString(), rightValue.toString());
 172
 173     case TransferListModel::TR_TAGS:
 174         return customCompare(leftValue.value<TagSet>(), rightValue.value<TagSet>(), m_naturalCompare);
 175
 176     case TransferListModel::TR_AMOUNT_DOWNLOADED:
 177     case TransferListModel::TR_AMOUNT_DOWNLOADED_SESSION:
 178     case TransferListModel::TR_AMOUNT_LEFT:
 179     case TransferListModel::TR_AMOUNT_UPLOADED:
 180     case TransferListModel::TR_AMOUNT_UPLOADED_SESSION:
 181     case TransferListModel::TR_COMPLETED:
 182     case TransferListModel::TR_ETA:
 183     case TransferListModel::TR_LAST_ACTIVITY:
 184     case TransferListModel::TR_SIZE:
 185     case TransferListModel::TR_TIME_ELAPSED:
 186     case TransferListModel::TR_TOTAL_SIZE:
 187         return customCompare(leftValue.toLongLong(), rightValue.toLongLong());
 188
 189     case TransferListModel::TR_AVAILABILITY:
 190     case TransferListModel::TR_PROGRESS:
 191     case TransferListModel::TR_RATIO:
 192     case TransferListModel::TR_RATIO_LIMIT:
 193         return customCompare(leftValue.toReal(), rightValue.toReal());
 194
 195     case TransferListModel::TR_STATUS:
 196         return threeWayCompare(leftValue.toInt(), rightValue.toInt());
 197
 198     case TransferListModel::TR_ADD_DATE:
 199     case TransferListModel::TR_SEED_DATE:
 200     case TransferListModel::TR_SEEN_COMPLETE_DATE:
 201         return customCompare(leftValue.toDateTime(), rightValue.toDateTime());
 202
 203     case TransferListModel::TR_DLLIMIT:
 204     case TransferListModel::TR_DLSPEED:
 205     case TransferListModel::TR_QUEUE_POSITION:
 206     case TransferListModel::TR_UPLIMIT:
 207     case TransferListModel::TR_UPSPEED:
 208         return customCompare(leftValue.toInt(), rightValue.toInt());
 209
 210     case TransferListModel::TR_PEERS:
 211     case TransferListModel::TR_SEEDS:
 212         {
 213             // Active peers/seeds take precedence over total peers/seeds
 214             const auto activeL = leftValue.toInt();
 215             const auto activeR = rightValue.toInt();
 216             if (activeL != activeR)
 217                 return threeWayCompare(activeL, activeR);
 218
 219             const auto totalL = left.data(TransferListModel::AdditionalUnderlyingDataRole).toInt();
 220             const auto totalR = right.data(TransferListModel::AdditionalUnderlyingDataRole).toInt();
 221             return threeWayCompare(totalL, totalR);
 222         }
 223
 224     default:
 225         Q_ASSERT_X(false, Q_FUNC_INFO, "Missing comparsion case");
 226         break;
 227     }
 228
 229     return 0;
 230 }
 231
 232 bool TransferListSortModel::lessThan(const QModelIndex &left, const QModelIndex &right) const
 233 {
 234     Q_ASSERT(left.column() == right.column());
 235
 236     const int result = compare(left, right);
 237     if (result == 0)
 238     {
 239         const int subResult = compare(left.sibling(left.row(), m_subSortColumn), right.sibling(right.row(), m_subSortColumn));
 240         // Qt inverses lessThan() result when ordered descending.
 241         // For sub-sorting we have to do it manually.
 242         // When both are ordered descending subResult must be double-inversed, which is the same as no inversion.
 243         const bool inverseSubResult = (m_lastSortOrder != m_subSortOrder); // exactly one is descending
 244         return (inverseSubResult ? (subResult > 0) : (subResult < 0));
 245     }
 246
 247     return result < 0;
 248 }
 249
 250 bool TransferListSortModel::filterAcceptsRow(const int sourceRow, const QModelIndex &sourceParent) const
 251 {
 252     return matchFilter(sourceRow, sourceParent)
 253            && QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
 254 }
 255
 256 bool TransferListSortModel::matchFilter(const int sourceRow, const QModelIndex &sourceParent) const
 257 {
 258     const auto *model = qobject_cast<TransferListModel *>(sourceModel());
 259     if (!model) return false;
 260
 261     const BitTorrent::Torrent *torrent = model->torrentHandle(model->index(sourceRow, 0, sourceParent));
 262     if (!torrent) return false;
 263
 264     return m_filter.match(torrent);
 265 }