src/gui/watchedfoldersmodel.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2021  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 #include "watchedfoldersmodel.h"
  30
  31 #include <QDir>
  32
  33 #include "base/exceptions.h"
  34 #include "base/global.h"
  35 #include "base/utils/fs.h"
  36
  37 WatchedFoldersModel::WatchedFoldersModel(TorrentFilesWatcher *fsWatcher, QObject *parent)
  38     : QAbstractListModel {parent}
  39     , m_fsWatcher {fsWatcher}
  40     , m_watchedFolders {m_fsWatcher->folders().keys()}
  41     , m_watchedFoldersOptions {m_fsWatcher->folders()}
  42 {
  43     connect(m_fsWatcher, &TorrentFilesWatcher::watchedFolderSet, this, &WatchedFoldersModel::onFolderSet);
  44     connect(m_fsWatcher, &TorrentFilesWatcher::watchedFolderRemoved, this, &WatchedFoldersModel::onFolderRemoved);
  45 }
  46
  47 int WatchedFoldersModel::rowCount(const QModelIndex &parent) const
  48 {
  49     return parent.isValid() ? 0 : m_watchedFolders.count();
  50 }
  51
  52 int WatchedFoldersModel::columnCount([[maybe_unused]] const QModelIndex &parent) const
  53 {
  54     return 1;
  55 }
  56
  57 QVariant WatchedFoldersModel::data(const QModelIndex &index, const int role) const
  58 {
  59     if (!index.isValid() || (index.row() >= rowCount()) || (index.column() >= columnCount()))
  60         return {};
  61
  62     if (role == Qt::DisplayRole)
  63         return m_watchedFolders.at(index.row()).toString();
  64
  65     return {};
  66 }
  67
  68 QVariant WatchedFoldersModel::headerData(const int section, const Qt::Orientation orientation, const int role) const
  69 {
  70     if ((orientation != Qt::Horizontal) || (role != Qt::DisplayRole)
  71             || (section < 0) || (section >= columnCount()))
  72     {
  73         return {};
  74     }
  75
  76     return tr("Watched Folder");
  77 }
  78
  79 bool WatchedFoldersModel::removeRows(const int row, const int count, const QModelIndex &parent)
  80 {
  81     if (parent.isValid() || (row < 0) || (row >= rowCount())
  82         || (count <= 0) || ((row + count) > rowCount()))
  83     {
  84         return false;
  85     }
  86
  87     const int firstRow = row;
  88     const int lastRow = row + (count - 1);
  89
  90     beginRemoveRows(parent, firstRow, lastRow);
  91     for (int i = firstRow; i <= lastRow; ++i)
  92     {
  93         const Path folderPath = m_watchedFolders.takeAt(i);
  94         m_watchedFoldersOptions.remove(folderPath);
  95         m_deletedFolders.insert(folderPath);
  96     }
  97     endRemoveRows();
  98
  99     return true;
 100 }
 101
 102 void WatchedFoldersModel::addFolder(const Path &path, const TorrentFilesWatcher::WatchedFolderOptions &options)
 103 {
 104     if (path.isEmpty())
 105         throw InvalidArgument(tr("Watched folder path cannot be empty."));
 106
 107     if (path.isRelative())
 108         throw InvalidArgument(tr("Watched folder path cannot be relative."));
 109
 110     if (m_watchedFoldersOptions.contains(path))
 111         throw RuntimeError(tr("Folder '%1' is already in watch list.").arg(path.toString()));
 112
 113     const QDir watchDir {path.data()};
 114     if (!watchDir.exists())
 115         throw RuntimeError(tr("Folder '%1' doesn't exist.").arg(path.toString()));
 116     if (!watchDir.isReadable())
 117         throw RuntimeError(tr("Folder '%1' isn't readable.").arg(path.toString()));
 118
 119     m_deletedFolders.remove(path);
 120
 121     beginInsertRows(QModelIndex(), rowCount(), rowCount());
 122     m_watchedFolders.append(path);
 123     m_watchedFoldersOptions[path] = options;
 124     endInsertRows();
 125 }
 126
 127 TorrentFilesWatcher::WatchedFolderOptions WatchedFoldersModel::folderOptions(const int row) const
 128 {
 129     Q_ASSERT((row >= 0) && (row < rowCount()));
 130
 131     const Path folderPath = m_watchedFolders.at(row);
 132     return m_watchedFoldersOptions[folderPath];
 133 }
 134
 135 void WatchedFoldersModel::setFolderOptions(const int row, const TorrentFilesWatcher::WatchedFolderOptions &options)
 136 {
 137     Q_ASSERT((row >= 0) && (row < rowCount()));
 138
 139     const Path folderPath = m_watchedFolders.at(row);
 140     m_watchedFoldersOptions[folderPath] = options;
 141 }
 142
 143 void WatchedFoldersModel::apply()
 144 {
 145     const QSet<Path> deletedFolders {m_deletedFolders};
 146     // We have to clear `m_deletedFolders` for optimization reason, otherwise
 147     // it will be cleared one element at a time in `onFolderRemoved()` handler
 148     m_deletedFolders.clear();
 149     for (const Path &path : deletedFolders)
 150         m_fsWatcher->removeWatchedFolder(path);
 151
 152     for (const Path &path : asConst(m_watchedFolders))
 153         m_fsWatcher->setWatchedFolder(path, m_watchedFoldersOptions.value(path));
 154 }
 155
 156 void WatchedFoldersModel::onFolderSet(const Path &path, const TorrentFilesWatcher::WatchedFolderOptions &options)
 157 {
 158     if (!m_watchedFoldersOptions.contains(path))
 159     {
 160         m_deletedFolders.remove(path);
 161
 162         beginInsertRows(QModelIndex(), rowCount(), rowCount());
 163         m_watchedFolders.append(path);
 164         m_watchedFoldersOptions[path] = options;
 165         endInsertRows();
 166     }
 167     else
 168     {
 169         m_watchedFoldersOptions[path] = options;
 170     }
 171 }
 172
 173 void WatchedFoldersModel::onFolderRemoved(const Path &path)
 174 {
 175     const int row = m_watchedFolders.indexOf(path);
 176     if (row >= 0)
 177         removeRows(row, 1);
 178
 179     m_deletedFolders.remove(path);
 180 }