src/base/search/searchpluginmanager.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015-2024  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/path.h"
  37 #include "base/utils/version.h"
  38
  39 using PluginVersion = Utils::Version<2>;
  40 Q_DECLARE_METATYPE(PluginVersion)
  41
  42 namespace Net
  43 {
  44     struct DownloadResult;
  45 }
  46
  47 struct PluginInfo
  48 {
  49     QString name;
  50     PluginVersion version;
  51     QString fullName;
  52     QString url;
  53     QStringList supportedCategories;
  54     Path iconPath;
  55     bool enabled = false;
  56 };
  57
  58 class SearchDownloadHandler;
  59 class SearchHandler;
  60
  61 class SearchPluginManager final : public QObject
  62 {
  63     Q_OBJECT
  64     Q_DISABLE_COPY_MOVE(SearchPluginManager)
  65
  66 public:
  67     SearchPluginManager();
  68     ~SearchPluginManager() override;
  69
  70     static SearchPluginManager *instance();
  71     static void freeInstance();
  72
  73     QStringList allPlugins() const;
  74     QStringList enabledPlugins() const;
  75     QStringList supportedCategories() const;
  76     QStringList getPluginCategories(const QString &pluginName) const;
  77     PluginInfo *pluginInfo(const QString &name) const;
  78     QString pluginNameBySiteURL(const QString &siteURL) const;
  79
  80     void enablePlugin(const QString &name, bool enabled = true);
  81     void updatePlugin(const QString &name);
  82     void installPlugin(const QString &source);
  83     bool uninstallPlugin(const QString &name);
  84     static void updateIconPath(PluginInfo *plugin);
  85     void checkForUpdates();
  86
  87     SearchHandler *startSearch(const QString &pattern, const QString &category, const QStringList &usedPlugins);
  88     SearchDownloadHandler *downloadTorrent(const QString &pluginName, const QString &url);
  89
  90     static PluginVersion getPluginVersion(const Path &filePath);
  91     static QString categoryFullName(const QString &categoryName);
  92     QString pluginFullName(const QString &pluginName) const;
  93     static Path pluginsLocation();
  94     static Path engineLocation();
  95
  96 signals:
  97     void pluginEnabled(const QString &name, bool enabled);
  98     void pluginInstalled(const QString &name);
  99     void pluginInstallationFailed(const QString &name, const QString &reason);
 100     void pluginUninstalled(const QString &name);
 101     void pluginUpdated(const QString &name);
 102     void pluginUpdateFailed(const QString &name, const QString &reason);
 103
 104     void checkForUpdatesFinished(const QHash<QString, PluginVersion> &updateInfo);
 105     void checkForUpdatesFailed(const QString &reason);
 106
 107 private:
 108     void applyProxySettings();
 109     void update();
 110     void updateNova();
 111     void parseVersionInfo(const QByteArray &info);
 112     void installPlugin_impl(const QString &name, const Path &path);
 113     bool isUpdateNeeded(const QString &pluginName, const PluginVersion &newVersion) const;
 114
 115     void versionInfoDownloadFinished(const Net::DownloadResult &result);
 116     void pluginDownloadFinished(const Net::DownloadResult &result);
 117
 118     static Path pluginPath(const QString &name);
 119
 120     static QPointer<SearchPluginManager> m_instance;
 121
 122     const QString m_updateUrl;
 123
 124     QHash<QString, PluginInfo*> m_plugins;
 125 };