plugin_handler.h

Go to the documentation of this file.

/**************************************************************************
 *   Copyright (C) 2019 - 2025 Alec Leamas                                 *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, see <https://www.gnu.org/licenses/>. *
 ***************************************************************************/
 
#ifndef PLUGIN_HANDLER_H__
#define PLUGIN_HANDLER_H__
 
#include "config.h"
 
#include <map>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include <archive.h>
 
#include <wx/cmdline.h>
 
#include "observable/evtvar.h"
#include "model/catalog_parser.h"
 
bool isRegularFile(const char* path);
 
class CompatOs {
public:
  static CompatOs* GetInstance();
  std::string name() const { return _name; }
  std::string version() const { return _version; }
 
private:
  CompatOs();
  std::string _name;
  std::string _version;
};
 
class PluginHandler {
public:
  static PluginHandler* GetInstance();
 
  PluginHandler(const PluginHandler&) = delete;
  PluginHandler& operator=(const PluginHandler&) = delete;
 
  obs::EventVar evt_download_ok;
 
  obs::EventVar evt_download_failed;
 
  static void Cleanup(const std::string& filelist, const std::string& plugname);
 
  static void CleanupFiles(const std::string& manifestFile,
                           const std::string& plugname);
 
  static std::string PluginsInstallDataPath();
 
  static std::string FileListPath(std::string name);
 
  static std::string VersionPath(std::string name);
 
  static std::string ImportedMetadataPath(std::string name);
 
  static std::vector<std::string> GetImportPaths();
 
  static bool IsCompatible(const PluginMetadata& metadata,
                           const char* os = PKG_TARGET,
                           const char* os_version = PKG_TARGET_VERSION);
 
  bool IsPluginWritable(std::string name);
 
  const std::vector<PluginMetadata> GetInstalled();
 
  std::vector<std::string> GetInstalldataPlugins();
 
  void SetInstalledMetadata(const PluginMetadata& pm);
 
  const std::vector<PluginMetadata> GetAvailable();
 
  std::vector<PluginMetadata> getCompatiblePlugins();
 
  const std::map<std::string, int> GetCountByTarget();
 
  std::string GetPluginByLibrary(const std::string& filename);
 
  std::string GetMetadataPath();
 
  std::string GetUserMetadataPath();
 
  void setMetadata(std::string path) { metadataPath = path; }
 
  bool InstallPlugin(PluginMetadata plugin);
 
  bool InstallPlugin(PluginMetadata plugin, std::string path);
 
  bool ExtractMetadata(const std::string& path, PluginMetadata& metadata);
 
  /* Install a new, downloaded but not installed plugin tarball. */
  bool InstallPlugin(const std::string& path);
 
  bool Uninstall(const std::string plugin);
 
  bool ClearInstallData(const std::string plugin_name);
 
  bool InstallPluginFromCache(PluginMetadata plugin);
 
  CatalogData* GetCatalogData() { return &catalogData; }
 
protected:
  PluginHandler();
 
private:
  std::string metadataPath;
  std::vector<PluginMetadata> installed;
  CatalogData catalogData;
  std::string last_error_msg;
  bool InstallPlugin(const std::string& path, std::string& filelist,
                     const std::string metadata_path, bool only_metadata);
 
  bool ExplodeTarball(struct archive* src, struct archive* dest,
                      std::string& filelist, const std::string& metadata_path,
                      bool only_metadata);
  bool ExtractTarball(const std::string path, std::string& filelist,
                      const std::string metadata_path = "",
                      bool only_metadata = false);
  bool ArchiveCheck(int r, const char* msg, struct archive* a);
 
  std::unordered_map<std::string, std::vector<std::string>> FilesByPlugin;
 
  bool DoClearInstallData(const std::string plugin_name);
};
 
#endif  // PLUGIN_HANDLER_H__