src/base/search/searchpluginmanager.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015, 2018  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2006  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #pragma once
  31
  32 #include <QHash>
  33 #include <QMetaType>
  34 #include <QObject>
  35
  36 #include "base/utils/version.h"
  37
  38 using PluginVersion = Utils::Version<unsigned short, 2>;
  39 Q_DECLARE_METATYPE(PluginVersion)
  40
  41 namespace Net
  42 {
  43     struct DownloadResult;
  44 }
  45
  46 struct PluginInfo
  47 {
  48     QString name;
  49     PluginVersion version;
  50     QString fullName;
  51     QString url;
  52     QStringList supportedCategories;
  53     QString iconPath;
  54     bool enabled;
  55 };
  56
  57 class SearchDownloadHandler;
  58 class SearchHandler;
  59
  60 class SearchPluginManager : public QObject
  61 {
  62     Q_OBJECT
  63     Q_DISABLE_COPY_MOVE(SearchPluginManager)
  64
  65 public:
  66     SearchPluginManager();
  67     ~SearchPluginManager() override;
  68
  69     static SearchPluginManager *instance();
  70     static void freeInstance();
  71
  72     QStringList allPlugins() const;
  73     QStringList enabledPlugins() const;
  74     QStringList supportedCategories() const;
  75     QStringList getPluginCategories(const QString &pluginName) const;
  76     PluginInfo *pluginInfo(const QString &name) const;
  77
  78     void enablePlugin(const QString &name, bool enabled = true);
  79     void updatePlugin(const QString &name);
  80     void installPlugin(const QString &source);
  81     bool uninstallPlugin(const QString &name);
  82     static void updateIconPath(PluginInfo *const plugin);
  83     void checkForUpdates();
  84
  85     SearchHandler *startSearch(const QString &pattern, const QString &category, const QStringList &usedPlugins);
  86     SearchDownloadHandler *downloadTorrent(const QString &siteUrl, const QString &url);
  87
  88     static PluginVersion getPluginVersion(const QString &filePath);
  89     static QString categoryFullName(const QString &categoryName);
  90     QString pluginFullName(const QString &pluginName);
  91     static QString pluginsLocation();
  92     static QString engineLocation();
  93
  94 signals:
  95     void pluginEnabled(const QString &name, bool enabled);
  96     void pluginInstalled(const QString &name);
  97     void pluginInstallationFailed(const QString &name, const QString &reason);
  98     void pluginUninstalled(const QString &name);
  99     void pluginUpdated(const QString &name);
 100     void pluginUpdateFailed(const QString &name, const QString &reason);
 101
 102     void checkForUpdatesFinished(const QHash<QString, PluginVersion> &updateInfo);
 103     void checkForUpdatesFailed(const QString &reason);
 104
 105 private:
 106     void update();
 107     void updateNova();
 108     void parseVersionInfo(const QByteArray &info);
 109     void installPlugin_impl(const QString &name, const QString &path);
 110     bool isUpdateNeeded(const QString &pluginName, PluginVersion newVersion) const;
 111
 112     void versionInfoDownloadFinished(const Net::DownloadResult &result);
 113     void pluginDownloadFinished(const Net::DownloadResult &result);
 114
 115     static QString pluginPath(const QString &name);
 116
 117     static QPointer<SearchPluginManager> m_instance;
 118
 119     const QString m_updateUrl;
 120
 121     QHash<QString, PluginInfo*> m_plugins;
 122 };