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         return isLeftValid ? -1 : 1;
  57     }
  58
  59     int customCompare(const TagSet &left, const TagSet &right, const Utils::Compare::NaturalCompare<Qt::CaseInsensitive> &compare)
  60     {
  61         for (auto leftIter = left.cbegin(), rightIter = right.cbegin();
  62                 (leftIter != left.cend()) && (rightIter != right.cend());
  63                 ++leftIter, ++rightIter)
  64         {
  65             const int result = compare(leftIter->toString(), rightIter->toString());
  66             if (result != 0)
  67                 return result;
  68         }
  69         return threeWayCompare(left.size(), right.size());
  70     }
  71
  72     template <typename T>
  73     int customCompare(const T left, const T right)
  74     {
  75         static_assert(std::is_arithmetic_v<T>);
  76
  77         const bool isLeftValid = (left >= 0);
  78         const bool isRightValid = (right >= 0);
  79
  80         if (isLeftValid && isRightValid)
  81             return threeWayCompare(left, right);
  82         if (!isLeftValid && !isRightValid)
  83             return 0;
  84         return isLeftValid ? -1 : 1;
  85     }
  86
  87     int adjustSubSortColumn(const int column)
  88     {
  89         return ((column >= 0) && (column < TransferListModel::NB_COLUMNS))
  90                    ? column : TransferListModel::TR_NAME;
  91     }
  92 }
  93
  94 TransferListSortModel::TransferListSortModel(QObject *parent)
  95     : QSortFilterProxyModel {parent}
  96     , m_subSortColumn {u"TransferList/SubSortColumn"_s, TransferListModel::TR_NAME, adjustSubSortColumn}
  97     , m_subSortOrder {u"TransferList/SubSortOrder"_s, 0}
  98 {
  99     setSortRole(TransferListModel::UnderlyingDataRole);
 100 }
 101
 102 void TransferListSortModel::sort(const int column, const Qt::SortOrder order)
 103 {
 104     if ((m_lastSortColumn != column) && (m_lastSortColumn != -1))
 105     {
 106         m_subSortColumn = m_lastSortColumn;
 107         m_subSortOrder = m_lastSortOrder;
 108     }
 109     m_lastSortColumn = column;
 110     m_lastSortOrder = ((order == Qt::AscendingOrder) ? 0 : 1);
 111
 112     QSortFilterProxyModel::sort(column, order);
 113 }
 114
 115 void TransferListSortModel::setStatusFilter(const TorrentFilter::Type filter)
 116 {
 117     if (m_filter.setType(filter))
 118         invalidateRowsFilter();
 119 }
 120
 121 void TransferListSortModel::setCategoryFilter(const QString &category)
 122 {
 123     if (m_filter.setCategory(category))
 124         invalidateRowsFilter();
 125 }
 126
 127 void TransferListSortModel::disableCategoryFilter()
 128 {
 129     if (m_filter.setCategory(TorrentFilter::AnyCategory))
 130         invalidateRowsFilter();
 131 }
 132
 133 void TransferListSortModel::setTagFilter(const Tag &tag)
 134 {
 135     if (m_filter.setTag(tag))
 136         invalidateRowsFilter();
 137 }
 138
 139 void TransferListSortModel::disableTagFilter()
 140 {
 141     if (m_filter.setTag(TorrentFilter::AnyTag))
 142         invalidateRowsFilter();
 143 }
 144
 145 void TransferListSortModel::setTrackerFilter(const QSet<BitTorrent::TorrentID> &torrentIDs)
 146 {
 147     if (m_filter.setTorrentIDSet(torrentIDs))
 148         invalidateRowsFilter();
 149 }
 150
 151 void TransferListSortModel::disableTrackerFilter()
 152 {
 153     if (m_filter.setTorrentIDSet(TorrentFilter::AnyID))
 154         invalidateRowsFilter();
 155 }
 156
 157 int TransferListSortModel::compare(const QModelIndex &left, const QModelIndex &right) const
 158 {
 159     const int compareColumn = left.column();
 160     const QVariant leftValue = left.data(TransferListModel::UnderlyingDataRole);
 161     const QVariant rightValue = right.data(TransferListModel::UnderlyingDataRole);
 162
 163     switch (compareColumn)
 164     {
 165     case TransferListModel::TR_CATEGORY:
 166     case TransferListModel::TR_DOWNLOAD_PATH:
 167     case TransferListModel::TR_NAME:
 168     case TransferListModel::TR_SAVE_PATH:
 169     case TransferListModel::TR_TRACKER:
 170         return m_naturalCompare(leftValue.toString(), rightValue.toString());
 171
 172     case TransferListModel::TR_INFOHASH_V1:
 173         return threeWayCompare(leftValue.value<SHA1Hash>(), rightValue.value<SHA1Hash>());
 174
 175     case TransferListModel::TR_INFOHASH_V2:
 176         return threeWayCompare(leftValue.value<SHA256Hash>(), rightValue.value<SHA256Hash>());
 177
 178     case TransferListModel::TR_TAGS:
 179         return customCompare(leftValue.value<TagSet>(), rightValue.value<TagSet>(), m_naturalCompare);
 180
 181     case TransferListModel::TR_AMOUNT_DOWNLOADED:
 182     case TransferListModel::TR_AMOUNT_DOWNLOADED_SESSION:
 183     case TransferListModel::TR_AMOUNT_LEFT:
 184     case TransferListModel::TR_AMOUNT_UPLOADED:
 185     case TransferListModel::TR_AMOUNT_UPLOADED_SESSION:
 186     case TransferListModel::TR_COMPLETED:
 187     case TransferListModel::TR_ETA:
 188     case TransferListModel::TR_LAST_ACTIVITY:
 189     case TransferListModel::TR_REANNOUNCE:
 190     case TransferListModel::TR_SIZE:
 191     case TransferListModel::TR_TIME_ELAPSED:
 192     case TransferListModel::TR_TOTAL_SIZE:
 193         return customCompare(leftValue.toLongLong(), rightValue.toLongLong());
 194
 195     case TransferListModel::TR_AVAILABILITY:
 196     case TransferListModel::TR_PROGRESS:
 197     case TransferListModel::TR_RATIO:
 198     case TransferListModel::TR_RATIO_LIMIT:
 199     case TransferListModel::TR_POPULARITY:
 200         return customCompare(leftValue.toReal(), rightValue.toReal());
 201
 202     case TransferListModel::TR_STATUS:
 203         return threeWayCompare(leftValue.toInt(), rightValue.toInt());
 204
 205     case TransferListModel::TR_ADD_DATE:
 206     case TransferListModel::TR_SEED_DATE:
 207     case TransferListModel::TR_SEEN_COMPLETE_DATE:
 208         return customCompare(leftValue.toDateTime(), rightValue.toDateTime());
 209
 210     case TransferListModel::TR_DLLIMIT:
 211     case TransferListModel::TR_DLSPEED:
 212     case TransferListModel::TR_QUEUE_POSITION:
 213     case TransferListModel::TR_UPLIMIT:
 214     case TransferListModel::TR_UPSPEED:
 215         return customCompare(leftValue.toInt(), rightValue.toInt());
 216
 217     case TransferListModel::TR_PEERS:
 218     case TransferListModel::TR_SEEDS:
 219         {
 220             // Active peers/seeds take precedence over total peers/seeds
 221             const auto activeL = leftValue.toInt();
 222             const auto activeR = rightValue.toInt();
 223             if (activeL != activeR)
 224                 return threeWayCompare(activeL, activeR);
 225
 226             const auto totalL = left.data(TransferListModel::AdditionalUnderlyingDataRole).toInt();
 227             const auto totalR = right.data(TransferListModel::AdditionalUnderlyingDataRole).toInt();
 228             return threeWayCompare(totalL, totalR);
 229         }
 230
 231     default:
 232         Q_ASSERT_X(false, Q_FUNC_INFO, "Missing comparison case");
 233         break;
 234     }
 235
 236     return 0;
 237 }
 238
 239 bool TransferListSortModel::lessThan(const QModelIndex &left, const QModelIndex &right) const
 240 {
 241     Q_ASSERT(left.column() == right.column());
 242
 243     const int result = compare(left, right);
 244     if (result == 0)
 245     {
 246         const int subResult = compare(left.sibling(left.row(), m_subSortColumn), right.sibling(right.row(), m_subSortColumn));
 247         // Qt inverses lessThan() result when ordered descending.
 248         // For sub-sorting we have to do it manually.
 249         // When both are ordered descending subResult must be double-inversed, which is the same as no inversion.
 250         const bool inverseSubResult = (m_lastSortOrder != m_subSortOrder); // exactly one is descending
 251         return (inverseSubResult ? (subResult > 0) : (subResult < 0));
 252     }
 253
 254     return result < 0;
 255 }
 256
 257 bool TransferListSortModel::filterAcceptsRow(const int sourceRow, const QModelIndex &sourceParent) const
 258 {
 259     return matchFilter(sourceRow, sourceParent)
 260            && QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
 261 }
 262
 263 bool TransferListSortModel::matchFilter(const int sourceRow, const QModelIndex &sourceParent) const
 264 {
 265     const auto *model = qobject_cast<TransferListModel *>(sourceModel());
 266     if (!model) return false;
 267
 268     const BitTorrent::Torrent *torrent = model->torrentHandle(model->index(sourceRow, 0, sourceParent));
 269     if (!torrent) return false;
 270
 271     return m_filter.match(torrent);
 272 }