src/base/torrentfileguard.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2016  Eugene Shalygin <eugene.shalygin@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 #pragma once
  30
  31 #include <QObject>
  32 #include <QString>
  33
  34 #include "base/path.h"
  35
  36 /// Utility class to defer file deletion
  37 class FileGuard
  38 {
  39 public:
  40     explicit FileGuard(const Path &path = {});
  41     ~FileGuard();
  42
  43     /// Cancels or re-enables deferred file deletion
  44     void setAutoRemove(bool remove) noexcept;
  45
  46 private:
  47     Path m_path;
  48     bool m_remove = false;
  49 };
  50
  51 /// Reads settings for .torrent files from preferences
  52 /// and sets the file guard up accordingly
  53 class TorrentFileGuard : private FileGuard
  54 {
  55     Q_GADGET
  56
  57 public:
  58     explicit TorrentFileGuard(const Path &path = {});
  59     ~TorrentFileGuard();
  60
  61     /// marks the torrent file as loaded (added) into the BitTorrent::Session
  62     void markAsAddedToSession();
  63     using FileGuard::setAutoRemove;
  64
  65     enum AutoDeleteMode : int     // do not change these names: they are stored in config file
  66     {
  67         Never,
  68         IfAdded,
  69         Always
  70     };
  71
  72     // static interface to get/set preferences
  73     static AutoDeleteMode autoDeleteMode();
  74     static void setAutoDeleteMode(AutoDeleteMode mode);
  75
  76 private:
  77     TorrentFileGuard(const Path &path, AutoDeleteMode mode);
  78
  79     Q_ENUM(AutoDeleteMode)
  80     AutoDeleteMode m_mode;
  81     bool m_wasAdded = false;
  82 };