src/base/torrentfilter.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2014  Vladimir Golovnev <glassez@yandex.ru>
   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 #pragma once
  30
  31 #include <optional>
  32
  33 #include <QSet>
  34 #include <QString>
  35
  36 #include "base/bittorrent/infohash.h"
  37 #include "base/tag.h"
  38
  39 namespace BitTorrent
  40 {
  41     class Torrent;
  42 }
  43
  44 using TorrentIDSet = QSet<BitTorrent::TorrentID>;
  45
  46 class TorrentFilter
  47 {
  48 public:
  49     enum Type
  50     {
  51         All,
  52         Downloading,
  53         Seeding,
  54         Completed,
  55         Running,
  56         Stopped,
  57         Active,
  58         Inactive,
  59         Stalled,
  60         StalledUploading,
  61         StalledDownloading,
  62         Checking,
  63         Moving,
  64         Errored,
  65
  66         _Count
  67     };
  68
  69     // These mean any permutation, including no category / tag.
  70     static const std::optional<QString> AnyCategory;
  71     static const std::optional<TorrentIDSet> AnyID;
  72     static const std::optional<Tag> AnyTag;
  73
  74     static const TorrentFilter DownloadingTorrent;
  75     static const TorrentFilter SeedingTorrent;
  76     static const TorrentFilter CompletedTorrent;
  77     static const TorrentFilter StoppedTorrent;
  78     static const TorrentFilter RunningTorrent;
  79     static const TorrentFilter ActiveTorrent;
  80     static const TorrentFilter InactiveTorrent;
  81     static const TorrentFilter StalledTorrent;
  82     static const TorrentFilter StalledUploadingTorrent;
  83     static const TorrentFilter StalledDownloadingTorrent;
  84     static const TorrentFilter CheckingTorrent;
  85     static const TorrentFilter MovingTorrent;
  86     static const TorrentFilter ErroredTorrent;
  87
  88     TorrentFilter() = default;
  89     // category & tags: pass empty string for uncategorized / untagged torrents.
  90     TorrentFilter(Type type
  91             , const std::optional<TorrentIDSet> &idSet = AnyID
  92             , const std::optional<QString> &category = AnyCategory
  93             , const std::optional<Tag> &tag = AnyTag
  94             , std::optional<bool> isPrivate = {});
  95     TorrentFilter(const QString &filter
  96             , const std::optional<TorrentIDSet> &idSet = AnyID
  97             , const std::optional<QString> &category = AnyCategory
  98             , const std::optional<Tag> &tags = AnyTag
  99             , std::optional<bool> isPrivate = {});
 100
 101
 102     bool setType(Type type);
 103     bool setTypeByName(const QString &filter);
 104     bool setTorrentIDSet(const std::optional<TorrentIDSet> &idSet);
 105     bool setCategory(const std::optional<QString> &category);
 106     bool setTag(const std::optional<Tag> &tag);
 107     bool setPrivate(std::optional<bool> isPrivate);
 108
 109     bool match(const BitTorrent::Torrent *torrent) const;
 110
 111 private:
 112     bool matchState(const BitTorrent::Torrent *torrent) const;
 113     bool matchHash(const BitTorrent::Torrent *torrent) const;
 114     bool matchCategory(const BitTorrent::Torrent *torrent) const;
 115     bool matchTag(const BitTorrent::Torrent *torrent) const;
 116     bool matchPrivate(const BitTorrent::Torrent *torrent) const;
 117
 118     Type m_type {All};
 119     std::optional<QString> m_category;
 120     std::optional<Tag> m_tag;
 121     std::optional<TorrentIDSet> m_idSet;
 122     std::optional<bool> m_private;
 123 };