AddonInstaller.h

/*
 *  Copyright (C) 2011-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "threads/Event.h"
#include "utils/Job.h"

#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>

class CFileItemList;

namespace ADDON
{

class CAddonVersion;

class CAddonDatabase;

class CRepository;
using RepositoryPtr = std::shared_ptr<CRepository>;

class IAddon;
using AddonPtr = std::shared_ptr<IAddon>;
using VECADDONS = std::vector<AddonPtr>;

enum class BackgroundJob : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

enum class ModalJob : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

enum class AutoUpdateJob : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

enum class DependencyJob : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

enum class InstallModalPrompt : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

enum class AllowCheckForUpdates : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

enum class RecurseOrphaned : bool
{
  CHOICE_YES = true,
  CHOICE_NO = false,
};

class CAddonInstaller : public IJobCallback
{
public:
  static CAddonInstaller &GetInstance();

  bool IsDownloading() const;
  void GetInstallList(ADDON::VECADDONS &addons) const;
  bool GetProgress(const std::string& addonID, unsigned int& percent, bool& downloadFinshed) const;
  bool Cancel(const std::string &addonID);

  bool InstallModal(const std::string& addonID,
                    ADDON::AddonPtr& addon,
                    InstallModalPrompt promptForInstall);

  bool InstallOrUpdate(const std::string& addonID, BackgroundJob background, ModalJob modal);

  bool InstallOrUpdateDependency(const ADDON::AddonPtr& dependsId,
                                 const ADDON::RepositoryPtr& repo);

  bool RemoveDependency(const std::shared_ptr<IAddon>& dependsId) const;

  std::vector<std::string> RemoveOrphanedDepsRecursively() const;

  void InstallAddons(const ADDON::VECADDONS& addons,
                     bool wait,
                     AllowCheckForUpdates allowCheckForUpdates);

  bool InstallFromZip(const std::string &path);

  bool Install(const std::string& addonId,
               const ADDON::CAddonVersion& version,
               const std::string& repoId);

  bool UnInstall(const ADDON::AddonPtr& addon, bool removeData);

  bool CheckDependencies(const ADDON::AddonPtr& addon, CAddonDatabase* database = nullptr);

  bool CheckDependencies(const ADDON::AddonPtr& addon,
                         std::pair<std::string, std::string>& failedDep,
                         CAddonDatabase* database = nullptr);

  bool HasJob(const std::string& ID) const;

  void OnJobComplete(unsigned int jobID, bool success, CJob* job) override;
  void OnJobProgress(unsigned int jobID, unsigned int progress, unsigned int total, const CJob *job) override;

  class CDownloadJob
  {
  public:
    explicit CDownloadJob(unsigned int id) : jobID(id) { }

    unsigned int jobID;
    unsigned int progress = 0;
    bool downloadFinshed = false;
  };

  typedef std::map<std::string, CDownloadJob> JobMap;

private:
  // private construction, and no assignments; use the provided singleton methods
  CAddonInstaller();
  CAddonInstaller(const CAddonInstaller&) = delete;
  CAddonInstaller const& operator=(CAddonInstaller const&) = delete;
  ~CAddonInstaller() override;

  bool DoInstall(const ADDON::AddonPtr& addon,
                 const ADDON::RepositoryPtr& repo,
                 BackgroundJob background,
                 ModalJob modal,
                 AutoUpdateJob autoUpdate,
                 DependencyJob dependsInstall,
                 AllowCheckForUpdates allowCheckForUpdates);

  bool CheckDependencies(const ADDON::AddonPtr &addon, std::vector<std::string>& preDeps, CAddonDatabase &database, std::pair<std::string, std::string> &failedDep);

  void PrunePackageCache();
  int64_t EnumeratePackageFolder(std::map<std::string, std::unique_ptr<CFileItemList>>& result);

  mutable CCriticalSection m_critSection;
  JobMap m_downloadJobs;
  CEvent m_idle;
};

}; // namespace ADDON