LocalApplication.cpp

/* *****************************************************************************
Copyright (c) 2016-2017, The Regents of the University of California (Regents).
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.

REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS
PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

*************************************************************************** */


// Written: fmckenna
// Modified by: Stevan Gavrilovic


#include "LocalApplication.h"
#include "OpenSRAPreferences.h"

#include <QHBoxLayout>
#include <QVBoxLayout>
#include <QGridLayout>
#include <QLabel>
#include <QLineEdit>
#include <QPushButton>
#include <QJsonObject>
#include <QStandardPaths>
#include <QCoreApplication>
#include <QStringList>
#include <QSettings>
#include <QDebug>
#include <QDir>
#include <QFileDialog>
#include <QProcessEnvironment>
#include <QCoreApplication>
#include <QFuture>
#include <QtConcurrent>

LocalApplication::LocalApplication(QString workflowScriptName, QWidget *parent) : Application(parent)
{
    this->workflowScript = workflowScriptName;

    theMainProcessHandler = std::make_unique<PythonProcessHandler>();
    thePreprocessHandler = std::make_unique<PythonProcessHandler>();

    connect(thePreprocessHandler.get(),&PythonProcessHandler::processFinished,this,&LocalApplication::handlePreprocessDone);

    connect(theMainProcessHandler.get(),&PythonProcessHandler::processFinished,this,&LocalApplication::handleApplicationRunDone);

}


bool LocalApplication::outputToJSON(QJsonObject &jsonObject)
{
    jsonObject["localAppDir"]=OpenSRAPreferences::getInstance()->getAppDir();
    jsonObject["remoteAppDir"]=OpenSRAPreferences::getInstance()->getAppDir();
    jsonObject["workingDir"]=OpenSRAPreferences::getInstance()->getLocalWorkDir();

    jsonObject["runType"]=QString("runningLocal");

    return true;
}


void LocalApplication::setupTempDir(const QString& subDir)
{
    statusMessage("Setting up temporary directory");

    workingDir = OpenSRAPreferences::getInstance()->getLocalWorkDir();

    if(!subDir.isEmpty())
        workingDir += QDir::separator() + subDir;

    QDir dirWork(workingDir);
    if (!dirWork.exists())
        if (!dirWork.mkpath(workingDir)) {
            QString errMsg = QString("Could not create Working Dir: ") + workingDir + QString(". Change the Local Jobs Directory location in preferences.");
            errorMessage(errMsg);

            return;
        }

}


void LocalApplication::onRunButtonPressed(QPushButton* button)
{

    //   QString appDir = appDirName->text();
    QString appDir = OpenSRAPreferences::getInstance()->getAppDir();
    QDir dirApp(appDir);
    if (!dirApp.exists()) {
        QString errMsg = QString("The application directory, ") + appDir +QString(" specified does not exist!. Check Local Application Directory im Preferences");
        errorMessage(errMsg);;
        return;
    }

    this->statusMessage("\nonRunButtonPressed "+ appDir);

    QString localWorkDir = OpenSRAPreferences::getInstance()->getLocalWorkDir();
    auto results_dir = localWorkDir + QDir::separator() + "Results";

    QDir dirWorkdir(results_dir);
    if (dirWorkdir.exists()) {
        this->statusMessage("Deleting old results directory at: "+results_dir);
        dirWorkdir.removeRecursively();
    }

    if(setUpForRun == false)
    {
        this->setupTempDir(QString());

        this->runButton = button;

        //statusMessage("Gathering Files to local workdir");

        emit setupForRun(workingDir, workingDir);

    }

    emit setupForRunDone(workingDir, workingDir);
}


void LocalApplication::onPreprocessButtonPressed(QPushButton* button)
{
    //   QString appDir = appDirName->text();
    QString appDir = OpenSRAPreferences::getInstance()->getAppDir();
    QDir dirApp(appDir);
    if (!dirApp.exists()) {
        QString errMsg = QString("The application directory, ") + appDir +QString(" specified does not exist!. Check Local Application Directory im Preferences");
        errorMessage(errMsg);;
        return;
    }

    this->setupTempDir(QString());

    this->preProcessButton = button;

    statusMessage("Gathering Files to local workdir");

    QString subDir = "Input";
    emit setupForPreprocessing(workingDir, subDir);
}


void LocalApplication::clear()
{
    setUpForRun = false;
    workingDir.clear();
}


bool LocalApplication::setupDoneRunPreprocessing(QString &workingDir, QString &/*inputFile*/)
{

    QString currentTime = QDateTime::currentDateTime().toString("yyyy-MM-ddTHH:mm:ss");
    QString msg1 = "Running preprocessing step on OpenSRA version " + QCoreApplication::applicationVersion() + " at " + currentTime;
    statusMessage(msg1);

    QString appDir = OpenSRAPreferences::getInstance()->getAppDir();

    QString pySCRIPT;

    auto pathToPreprocessScript = appDir + QDir::separator() + "Preprocess.py";

    QDir scriptDir(appDir);
    scriptDir.cd("OpenSRA");
    pySCRIPT = scriptDir.absoluteFilePath(pathToPreprocessScript);

    QFileInfo check_script(pySCRIPT);
    // check if file exists and if yes: Is it really a file and no directory?
    if (!check_script.exists() || !check_script.isFile())
    {
        QString errMsg = "Cannot find the Python script: " + pySCRIPT;
        errorMessage(errMsg);

        return false;
    }


    auto procEnv = QProcessEnvironment();
    auto sysEnv = QProcessEnvironment::systemEnvironment();
    procEnv.clear();

    statusMessage("Script to run: " + pySCRIPT);

    QString python;

    // Check if a python path is given in the app
    QSettings settings("SimCenter", QCoreApplication::applicationName()); //These names will need to be constants to be shared
    QVariant  pythonLocationVariant = settings.value("pythonExePath");
    if (pythonLocationVariant.isValid()) {
        python = pythonLocationVariant.toString();

    }

    if(python.isEmpty())
    {
        QString pythonEnvStr = "python_env";
        QString rootDir = QCoreApplication::applicationDirPath();

#ifdef Q_OS_WIN
        python = rootDir+QDir::separator()+pythonEnvStr+QDir::separator()+"python.exe";
#else
        python = rootDir+QDir::separator()+pythonEnvStr+QDir::separator()+"bin"+QDir::separator()+"python";
#endif

        QFileInfo checkPython(python);

        // check if exe exists and if yes: Is it really a exe and no directory?
        if (!checkPython.exists() || !checkPython.isExecutable()) {
            errorMessage(QString("NO PYTHON FOUND"));
            return false;
        }
    }

    errorMessage("First time after installation of OpenSRA, this step will take an additional 1 minute (approx.) to complete background tasks...");
    statusMessage(""); // switch back to status message format

    procEnv.insert("PATH", python);
    procEnv.insert("PYTHONPATH", python);
    procEnv.insert("USERNAME", "opensra_user");
    procEnv.insert("LOCALAPPDATA", QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation));

    // other environment variables needed for OpenSRA
    QFileInfo pythonPath(python);
    auto condaPrefix = pythonPath.absoluteDir().absolutePath();
    procEnv.insert("CONDA_PREFIX", condaPrefix);


#ifdef Q_OS_WIN
    QString projDataPath = condaPrefix + QDir::separator() + "Library" + QDir::separator() + "share" + QDir::separator() + "proj";
    procEnv.insert("PROJ_DATA", projDataPath);
    QString gdalDataPath = condaPrefix + QDir::separator() + "Library" + QDir::separator() + "share" + QDir::separator() + "gdal";
    procEnv.insert("GDAL_DATA", gdalDataPath);
#else
    QString projDataPath = condaPrefix + QDir::separator() + "Library" + QDir::separator() + "share" + QDir::separator() + "proj";
    procEnv.insert("PROJ_DATA", projDataPath);
    QString gdalDataPath = condaPrefix + QDir::separator() + "Library" + QDir::separator() + "share" + QDir::separator() + "gdal";
    procEnv.insert("GDAL_DATA", gdalDataPath);
#endif

    // Add some env var from system
    procEnv.insert("PROCESSOR_ARCHITECTURE", qgetenv("PROCESSOR_ARCHITECTURE"));

    // add procEnv
    thePreprocessHandler->setProcessEnv(procEnv);

    qDebug() << "Env: "<< procEnv.toStringList();
    qDebug() << "PATH: " << python;


#ifdef Q_OS_WIN

    QStringList args{pySCRIPT,"-w",workingDir};

    python = QString("\"") + python + QString("\"");

    qDebug() << python;
    qDebug() << args;

    //thePreprocessHandler->startProcess(python,args,"preprocessing",preProcessButton);
    thePreprocessHandler->startProcess(python,args,"analysis",preProcessButton);

    //    bool failed = false;
    //    if (!proc->waitForStarted())
    //    {
    //        qDebug() << "Failed to start the workflow!!! exit code returned: " << proc->exitCode();
    //        qDebug() << proc->errorString().split('\n');

    //        errorMessage("Failed to start the workflow!!!");
    //        errorMessage(proc->errorString());

    //        failed = true;
    //    }

    //    //    if(!proc->waitForFinished(-1))
    //    //    {
    //    //        qDebug() << "Failed to finish running the workflow!!! exit code returned: " << proc->exitCode();
    //    //        qDebug() << proc->errorString();

    //    //        errorMessage("Failed to finish running the workflow!!! exit code returned: " + QString::number(proc->exitCode()));
    //    //        errorMessage(proc->errorString());

    //    //        failed = true;
    //    //    }

    //    if(0 != proc->exitCode())
    //    {
    //        qDebug() << "Failed to run the workflow!!! exit code returned: " << proc->exitCode();
    //        qDebug() << proc->errorString();

    //        errorMessage("Failed to run the workflow!!!");
    //        failed = true;
    //    }

    //    if(failed)
    //    {
    //        qDebug().noquote() << proc->readAll();
    //        qDebug().noquote() << proc->readAllStandardError();
    //        return false;
    //    }

#else

    QString command = python + " \"" + pySCRIPT + "\"" + " -w " +  "\"" + workingDir + "\"";

    // Clean up the command for the debug log
    auto commandClean = command;
    commandClean.remove('\"');

    QDebug debugHelper = qDebug();
    debugHelper.noquote();
    debugHelper << "PYTHON COMMAND: " << commandClean;

    //    QFuture<void> future = QtConcurrent::run([=]() {

    //        QStringList cmdList = {"-c",command};

    //        thePreprocessHandler->startProcess("bash", cmdList, "preprocessing", runButton);

    //    });

    QStringList cmdList = {"-c",command};
    thePreprocessHandler->startProcess("bash", cmdList, "preprocessing", preProcessButton);

#endif

    return 0;
}


bool LocalApplication::setupDoneRunApplication(QString &tmpDirectory, QString &inputFile)
{
    QString currentTime = QDateTime::currentDateTime().toString("yyyy-MM-ddTHH:mm:ss");
    QString msg1 = "Running OpenSRA backend version " + QCoreApplication::applicationVersion() + " at " + currentTime;
    statusMessage(msg1);

    QString appDir = OpenSRAPreferences::getInstance()->getAppDir();

    QString pySCRIPT;

    QDir scriptDir(appDir);
    scriptDir.cd("OpenSRA");
    pySCRIPT = scriptDir.absoluteFilePath(workflowScript);

    QFileInfo check_script(pySCRIPT);
    // check if file exists and if yes: Is it really a file and no directory?
    if (!check_script.exists() || !check_script.isFile())
    {
        QString errMsg = "Cannot find the Python script: " + pySCRIPT;
        errorMessage(errMsg);

        return false;
    }


    auto procEnv = QProcessEnvironment();
    auto sysEnv = QProcessEnvironment::systemEnvironment();
    procEnv.clear();


    statusMessage("Script to run: " + pySCRIPT);


    QString python;

    // Check if a python path is given in the app
    QSettings settings("SimCenter", QCoreApplication::applicationName()); //These names will need to be constants to be shared
    QVariant  pythonLocationVariant = settings.value("pythonExePath");
    if (pythonLocationVariant.isValid()) {
        python = pythonLocationVariant.toString();

    }

    if(python.isEmpty())
    {
        QString pythonEnvStr = "python_env";
        QString rootDir = QCoreApplication::applicationDirPath();

#ifdef Q_OS_WIN
        python = rootDir+QDir::separator()+pythonEnvStr+QDir::separator()+"python.exe";
#else
        python = rootDir+QDir::separator()+pythonEnvStr+QDir::separator()+"bin"+QDir::separator()+"python";
#endif

        QFileInfo checkPython(python);

        // check if exe exists and if yes: Is it really a exe and no directory?
        if (!checkPython.exists() || !checkPython.isExecutable()) {
            errorMessage(QString("NO PYTHON FOUND"));
            return false;
        }
    }

//    statusMessage("Starting the analysis... this may take a while!");
    errorMessage("First time after installation of OpenSRA, this step will take an additional 10 minutes (approx.) to complete background tasks...");
    statusMessage(""); // switch back to status message format

    procEnv.insert("PATH", python);
    procEnv.insert("PYTHONPATH", python);
    procEnv.insert("LOCALAPPDATA", QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation));

    // other environment variables needed for OpenSRA
    QFileInfo pythonPath(python);
    auto condaPrefix = pythonPath.absoluteDir().absolutePath();
    procEnv.insert("CONDA_PREFIX", condaPrefix);
    QString projDataPath = condaPrefix + QDir::separator() + "Library" + QDir::separator() + "share" + QDir::separator() + "proj";
    procEnv.insert("PROJ_DATA", projDataPath);
    QString gdalDataPath = condaPrefix + QDir::separator() + "Library" + QDir::separator() + "share" + QDir::separator() + "gdal";
    procEnv.insert("GDAL_DATA", gdalDataPath);

    // Add some env var from system
    procEnv.insert("PROCESSOR_ARCHITECTURE", qgetenv("PROCESSOR_ARCHITECTURE"));

    // add procEnv
    theMainProcessHandler->setProcessEnv(procEnv);

    qDebug() << "Env: "<< procEnv.toStringList();
    qDebug() << "PATH: " << python;

#ifdef Q_OS_WIN

    QStringList args{pySCRIPT,"-w",inputFile};

    python = QString("\"") + python + QString("\"");

    qDebug() << python;
    qDebug() << args;

    theMainProcessHandler->startProcess(python,args,"backend", runButton);

    //    bool failed = false;
    //    if (!proc->waitForStarted())
    //    {
    //        qDebug() << "Failed to start the workflow!!! exit code returned: " << proc->exitCode();
    //        qDebug() << proc->errorString().split('\n');

    //        errorMessage("Failed to start the workflow!!!");
    //        errorMessage(proc->errorString());

    //        failed = true;
    //    }

    //    //    if(!proc->waitForFinished(-1))
    //    //    {
    //    //        qDebug() << "Failed to finish running the workflow!!! exit code returned: " << proc->exitCode();
    //    //        qDebug() << proc->errorString();

    //    //        errorMessage("Failed to finish running the workflow!!! exit code returned: " + QString::number(proc->exitCode()));
    //    //        errorMessage(proc->errorString());

    //    //        failed = true;
    //    //    }

    //    if(0 != proc->exitCode())
    //    {
    //        qDebug() << "Failed to run the workflow!!! exit code returned: " << proc->exitCode();
    //        qDebug() << proc->errorString();

    //        errorMessage("Failed to run the workflow!!!");
    //        failed = true;
    //    }

    //    if(failed)
    //    {
    //        qDebug().noquote() << proc->readAll();
    //        qDebug().noquote() << proc->readAllStandardError();
    //        return false;
    //    }

#else

    QString command;

    command = python + " \"" + pySCRIPT + "\"" + " -w " +  "\"" + inputFile + "\"";

    // Clean up the command for the debug log
    auto commandClean = command;
    commandClean.remove('\"');

    QDebug debugHelper = qDebug();
    debugHelper.noquote();
    debugHelper << "PYTHON COMMAND: " << commandClean;

    QStringList cmdList = {"-c",command};
    theMainProcessHandler->startProcess("bash", cmdList, "backend", runButton);
#endif
}


int LocalApplication::handlePreprocessDone(int res)
{

    if(res ==0)
        emit preprocessingDone();
    else
        this->errorMessage("Error at the \"PREPROCESSING\" step with result "+QString(res));

    return 0;
}



int LocalApplication::handleApplicationRunDone(int res)
{

    if(res ==0)
        emit processResults(QString(),QString(),QString());
    else
        this->errorMessage("Error at the \"PERFORM ANALYSIS\" step with result "+QString(res));

    return 0;
}