QmitkPipInstaller.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef QmitkPipInstaller_h
#define QmitkPipInstaller_h
 
#include <mitkPipPackageInfo.h>
 
#include <QObject>
#include <QProcess>
#include <QTemporaryFile>
 
class MITKPYTHONINSTALLER_EXPORT QmitkPipInstaller : public QObject
{
  Q_OBJECT
 
public:
  explicit QmitkPipInstaller(QObject* parent = nullptr);
  ~QmitkPipInstaller() override;
 
  void SetInstallSpec(const mitk::PipInstallSpec& spec);
 
  void StartInstall();
 
  void Cancel();
 
  void AbandonInstall();
 
  bool IsRunning() const;
 
  const std::vector<mitk::PipPackageInfo>& GetResolvedPackages() const;
 
signals:
  void VirtualEnvCreationStarted();
 
  void PipUpgradeStarted();
 
  void ResolveStarted();
 
  void PackageStatusChanged(int index, const QString& name, mitk::PackageStatus status);
 
  void PostInstallStepStarted(const QString& displayName);
 
  void InstallFinished(bool success);
 
  void OutputReceived(const QString& text, bool isError);
 
  void ProgressChanged(int current, int total);
 
  void ErrorOccurred(const QString& message);
 
private slots:
  void OnStandardOutputReady();
  void OnStandardErrorReady();
  void OnProcessFinished(int exitCode, QProcess::ExitStatus exitStatus);
 
private:
  enum class State
  {
    Idle,
    CreatingVirtualEnv,
    UpgradingPip,
    Resolving,
    Installing,
    RunningPostInstall,
    Cancelling,
    Done,
    Failed
  };
 
  void BeginVirtualEnvPhase();
  void StartPipUpgrade();
  void StartResolveGroup();
  void StartInstallPackage();
  void BeginPostInstallPhase();
  void StartPostInstallStep();
  QStringList BuildPipArgs(const QStringList& baseArgs, const mitk::PipInstallGroup& group) const;
  void AdvanceToNextGroup();
  bool ParseResolveReport(const QString& reportPath, int groupIndex);
  QString PythonExecutable() const;
  QString RequirePythonExecutable();
  void FinalizeCancel();
  void RemoveCreatedVirtualEnv();
 
  mitk::PipInstallSpec m_Spec;
 
  // Working copy of the groups driving the current install run. Currently equal
  // to m_Spec.groups; kept as a separate member so the install loop and
  // ParseResolveReport index a stable list, and so future synthetic groups can
  // be appended in StartInstall() without disturbing the caller's spec.
  std::vector<mitk::PipInstallGroup> m_Groups;
  std::vector<mitk::PipPackageInfo> m_ResolvedPackages;
 
  QProcess* m_Process = nullptr;
  State m_State = State::Idle;
  bool m_AnyFailed = false;
  bool m_CreatedVirtualEnv = false;
 
  int m_CurrentGroup = 0;
  int m_CurrentPackage = 0;
  int m_GroupStartIndex = 0;
  int m_CurrentPostInstallStep = 0;
 
  QTemporaryFile m_ReportFile;
};
 
#endif