PackageInstaller.h

/* miktex/PackageManager/PackageInstaller.h:            -*- C++ -*-
 
   Copyright (C) 2001-2021 Christian Schenk
 
   This file is part of MiKTeX Package Manager.
 
   MiKTeX Package Manager 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, or
   (at your option) any later version.
 
   MiKTeX Package Manager 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 MiKTeX Package Manager; if not, write to the Free
   Software Foundation, 59 Temple Place - Suite 330, Boston, MA
   02111-1307, USA. */
 
#pragma once
 
#if !defined(E22949C2ACEF4F1DB1F4008919909456)
#define E22949C2ACEF4F1DB1F4008919909456
 
#include "config.h"
 
#include <cstddef>
#include <ctime>
 
#include <string>
#include <vector>
 
#include <miktex/Util/OptionSet>
#include <miktex/Util/PathName>
 
#include "RepositoryInfo.h"
#include "definitions.h"
 
MIKTEX_PACKAGES_BEGIN_NAMESPACE;

enum class UpdateDbOption
{
  FromCache,
};
 
typedef MiKTeX::Util::OptionSet<UpdateDbOption> UpdateDbOptionSet;

enum class Notification
{
  None = 0,
  DownloadPackageStart,
  DownloadPackageEnd,
  InstallFileStart,
  InstallFileEnd,
  InstallPackageStart,
  InstallPackageEnd,
  RemoveFileStart,
  RemoveFileEnd,
  RemovePackageStart,
  RemovePackageEnd,
};

class MIKTEXNOVTABLE PackageInstallerCallback
{
public:
  virtual void MIKTEXTHISCALL ReportLine(const std::string& str) = 0;

public:
  virtual bool MIKTEXTHISCALL OnRetryableError(const std::string& message) = 0;

public:
  virtual bool MIKTEXTHISCALL OnProgress(Notification nf) = 0;
};
 
class MIKTEXNOVTABLE PackageInstaller
{
public:
  virtual MIKTEXTHISCALL ~PackageInstaller() noexcept = 0;

public:
  virtual void MIKTEXTHISCALL Dispose() = 0;

public:
  virtual void MIKTEXTHISCALL SetRepository(const std::string& repository) = 0;

public:
  virtual void MIKTEXTHISCALL SetDownloadDirectory(const MiKTeX::Util::PathName& directory) = 0;

public:
  virtual void MIKTEXTHISCALL UpdateDb(UpdateDbOptionSet options) = 0;

public:
  virtual void MIKTEXTHISCALL UpdateDbAsync() = 0;

public:
  virtual void MIKTEXTHISCALL FindUpdates() = 0;

public:
  virtual void MIKTEXTHISCALL FindUpdatesAsync() = 0;

public:
  struct UpdateInfo
  {
    std::string packageId;

    std::time_t timePackaged = InvalidTimeT;

    std::string version;

    enum Action {
      None,
      Keep,
      KeepAdmin,
      KeepObsolete,
      Update,
      ForceUpdate, 
      ForceRemove,
      Repair,
      ReleaseStateChange
    };

    Action action = None;
  };

public:
  virtual std::vector<UpdateInfo> MIKTEXTHISCALL GetUpdates() = 0;

public:
  virtual void MIKTEXTHISCALL FindUpgrades(PackageLevel packageLevel) = 0;

public:
  virtual void MIKTEXTHISCALL FindUpgradesAsync(PackageLevel packageLevel) = 0;

public:
  struct UpgradeInfo
  {
    std::string packageId;
    std::time_t timePackaged = InvalidTimeT;
    std::string version;
  };

public:
  virtual std::vector<UpgradeInfo> MIKTEXTHISCALL GetUpgrades() = 0;

public:
  enum class Role
  {
    Application,
    Installer,
    Updater
  };

public:
  virtual void MIKTEXTHISCALL InstallRemove(Role role) = 0;

public:
  virtual void MIKTEXTHISCALL InstallRemoveAsync(Role role) = 0;

public:
  virtual void MIKTEXTHISCALL WaitForCompletion() = 0;

public:
  virtual void MIKTEXTHISCALL Download() = 0;

public:
  virtual void MIKTEXTHISCALL DownloadAsync() = 0;

public:
  struct ProgressInfo
  {
    std::string packageId;

    std::string displayName;

    MiKTeX::Util::PathName fileName;

    unsigned long cFilesRemoveCompleted = 0;

    unsigned long cFilesRemoveTotal = 0;

    unsigned long cPackagesRemoveCompleted = 0;

    unsigned long cPackagesRemoveTotal = 0;

    std::size_t cbPackageDownloadCompleted = 0;

    std::size_t cbPackageDownloadTotal = 0;

    std::size_t cbDownloadCompleted = 0;
    
    std::size_t cbDownloadTotal = 0;

    std::size_t cFilesPackageInstallCompleted = 0;

    unsigned long cFilesPackageInstallTotal = 0;

    unsigned long cFilesInstallCompleted = 0;

    unsigned long cFilesInstallTotal = 0;

    unsigned long cPackagesInstallCompleted = 0;

    unsigned long cPackagesInstallTotal = 0;

    std::size_t cbPackageInstallCompleted = 0;

    std::size_t cbPackageInstallTotal = 0;

    std::size_t cbInstallCompleted = 0;

    std::size_t cbInstallTotal = 0;

    unsigned long bytesPerSecond = 0;

    unsigned long timeRemaining = 0;
    
    bool ready = false;

    unsigned numErrors = 0;

    bool cancelled = false;
  };

public:
  virtual ProgressInfo MIKTEXTHISCALL GetProgressInfo() = 0;

public:
  virtual void MIKTEXTHISCALL SetCallback(PackageInstallerCallback* callback) = 0;

public:
  virtual void MIKTEXTHISCALL SetFileLists(const std::vector<std::string>& toBeInstalled, const std::vector<std::string>& toBeRemoved) = 0;

public:
  virtual void MIKTEXTHISCALL SetPackageLevel(PackageLevel packageLevel) = 0;

public:
  virtual void MIKTEXTHISCALL SetFileList(const std::vector<std::string>& toBeInstalled) = 0;

public:
  virtual bool MIKTEXTHISCALL IsRunning() const = 0;

public:
  virtual void MIKTEXTHISCALL RegisterComponents(bool postInstall) = 0;

public:
  struct InitInfo
  {
    InitInfo() = default;
    InitInfo(const InitInfo& other) = default;
    InitInfo& operator=(const InitInfo& other) = default;
    InitInfo(InitInfo&& other) = default;
    InitInfo& operator=(InitInfo&& other) = default;
    ~InitInfo() = default;
    PackageInstallerCallback* callback = nullptr;
    bool unattended = false;
    bool enablePostProcessing = true;
  };
};
 
MIKTEX_PACKAGES_END_NAMESPACE;
 
#endif