src/base/bittorrent/resumedatastorage.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015-2022  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 <QtContainerFwd>
  32 #include <QList>
  33 #include <QMutex>
  34 #include <QObject>
  35
  36 #include "base/3rdparty/expected.hpp"
  37 #include "base/path.h"
  38 #include "infohash.h"
  39 #include "loadtorrentparams.h"
  40
  41 namespace BitTorrent
  42 {
  43     using LoadResumeDataResult = nonstd::expected<LoadTorrentParams, QString>;
  44
  45     struct LoadedResumeData
  46     {
  47         TorrentID torrentID;
  48         LoadResumeDataResult result;
  49     };
  50
  51     class ResumeDataStorage : public QObject
  52     {
  53         Q_OBJECT
  54         Q_DISABLE_COPY_MOVE(ResumeDataStorage)
  55
  56     public:
  57         explicit ResumeDataStorage(const Path &path, QObject *parent = nullptr);
  58
  59         Path path() const;
  60
  61         virtual QList<TorrentID> registeredTorrents() const = 0;
  62         virtual LoadResumeDataResult load(const TorrentID &id) const = 0;
  63         virtual void store(const TorrentID &id, const LoadTorrentParams &resumeData) const = 0;
  64         virtual void remove(const TorrentID &id) const = 0;
  65         virtual void storeQueue(const QList<TorrentID> &queue) const = 0;
  66
  67         void loadAll() const;
  68         QList<LoadedResumeData> fetchLoadedResumeData() const;
  69
  70     signals:
  71         void loadStarted(const QList<BitTorrent::TorrentID> &torrents);
  72         void loadFinished();
  73
  74     protected:
  75         void onResumeDataLoaded(const TorrentID &torrentID, const LoadResumeDataResult &loadResumeDataResult) const;
  76
  77     private:
  78         virtual void doLoadAll() const = 0;
  79
  80         const Path m_path;
  81         mutable QList<LoadedResumeData> m_loadedResumeData;
  82         mutable QMutex m_loadedResumeDataMutex;
  83     };
  84 }