WorkflowApp_quoFEM.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;
LOSS 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

#include "WorkflowApp_quoFEM.h"
#include <MainWindowWorkflowApp.h>

#include <Utils/FileOperations.h>

#include <QPushButton>
#include <QScrollArea>
#include <QJsonArray>
#include <QJsonObject>
#include <QJsonDocument>
#include <QLabel>
#include <QDebug>
#include <QHBoxLayout>
#include <QStackedWidget>
#include <RunLocalWidget.h>
#include <QProcess>
#include <QCoreApplication>
#include <RemoteService.h>
#include <QtNetwork/QNetworkAccessManager>
#include <QtNetwork/QNetworkReply>
#include <QtNetwork/QNetworkRequest>
#include <QHostInfo>
#include <QUuid>
#include <QDir>
#include <QFile>
#include <QStatusBar>

#include <QMenu>
#include <QMenuBar>
#include <Stampede3Machine.h>
#include <SC_ToolDialog.h>
#include <SC_RemoteAppTool.h>
#include <RemoteOpenSeesApp.h>

#include <SimCenterComponentSelection.h>
#include <RandomVariablesContainer.h>
#include <UQ_EngineSelection.h>
#include <FEM_Selection.h>
#include <InputWidgetEDP.h>

#include <LocalApplication.h>
#include <RemoteApplication.h>
#include <RemoteJobManager.h>
#include <RunWidget.h>
#include <Stampede3Machine.h>

//#include "CustomizedItemModel.h"

#include <QSettings>
#include <QUuid>
#include <QtNetwork/QNetworkAccessManager>
#include <QtNetwork/QNetworkReply>
#include <QtNetwork/QNetworkRequest>
#include <QHostInfo>
//#include <DakotaResultsSampling.h>
#include <UQ_Results.h>
#include <Utils/ProgramOutputDialog.h>
#include <Utils/RelativePathResolver.h>
#include <GoogleAnalytics.h>
//#include <SimCenterDirWatcher.h>

// static pointer for global procedure set in constructor
static WorkflowApp_quoFEM *theApp = 0;

// global procedure
int getNumParallelTasks() {
    return theApp->getMaxNumParallelTasks();
}

WorkflowApp_quoFEM::WorkflowApp_quoFEM(RemoteService *theService, QWidget *parent)
    : WorkflowAppWidget(theService, parent)
{
    // set static pointer for global procedure
    theApp = this;

    //
    // create the various widgets
    //

    theRVs = RandomVariablesContainer::getInstance();
    theFEM_Selection = new FEM_Selection(true);
    theUQ_Selection = new UQ_EngineSelection();
    theEDPs = new InputWidgetEDP();

    //theResults = new DakotaResultsSampling(theRVs);
    theResults = theUQ_Selection->getResults();

    TapisMachine *theMachine = new Stampede3Machine();
    
    localApp = new LocalApplication("qWHALE.py");
    remoteApp = new RemoteApplication("qWHALE.py", theService, theMachine);

    //    localApp = new LocalApplication("EE-UQ workflow.py");
    //   remoteApp = new RemoteApplication("EE-UQ workflow.py", theService);

    // localApp = new LocalApplication("EE-UQ.py");
    // remoteApp = new RemoteApplication("EE-UQ.py", theService);
    theJobManager = new RemoteJobManager(theService);

    SimCenterWidget *theWidgets[1];// =0;
    theRunWidget = new RunWidget(localApp, remoteApp, theWidgets, 0);

    //
    // connect signals and slots
    //

    // error messages and signals

    connect(localApp,SIGNAL(setupForRun(QString&,QString&)), this, SLOT(setUpForApplicationRun(QString&,QString&)));
    connect(localApp,SIGNAL(processResults(QString&)), this, SLOT(processResults(QString&)));
    connect(localApp,SIGNAL(sendErrorMessage(QString)), this,SLOT(errorMessage(QString)));
    connect(localApp,SIGNAL(sendStatusMessage(QString)), this,SLOT(statusMessage(QString)));
    connect(localApp,SIGNAL(sendFatalMessage(QString)), this,SLOT(fatalMessage(QString)));
    connect(localApp,SIGNAL(runComplete()), this, SLOT(runComplete()));
    connect(localApp, SIGNAL(runComplete()), this, SIGNAL(sendLocalRunComplete()));


    connect(remoteApp,SIGNAL(successfullJobStart()), theRunWidget, SLOT(hide()));    
    connect(remoteApp,SIGNAL(sendErrorMessage(QString)), this,SLOT(errorMessage(QString)));
    connect(remoteApp,SIGNAL(sendStatusMessage(QString)), this,SLOT(statusMessage(QString)));
    connect(remoteApp,SIGNAL(sendFatalMessage(QString)), this,SLOT(fatalMessage(QString)));
    connect(remoteApp,SIGNAL(setupForRun(QString&,QString&)), this, SLOT(setUpForApplicationRun(QString&,QString&)));
    connect(remoteApp,SIGNAL(successfullJobStart()), this, SLOT(runComplete()));
    
    connect(theJobManager,SIGNAL(processResults(QString&)), this, SLOT(processResults(QString&)));
    connect(theJobManager,SIGNAL(loadFile(QString&)), this, SLOT(loadFile(QString&)));
    connect(theJobManager, SIGNAL(closeDialog()), this, SLOT(runComplete()));
    connect(theJobManager,SIGNAL(sendErrorMessage(QString)),
	    this,SLOT(errorMessage(QString)));
    connect(theJobManager,SIGNAL(sendStatusMessage(QString)),
	    this,SLOT(statusMessage(QString)));
    connect(theJobManager,SIGNAL(sendFatalMessage(QString)),
	    this,SLOT(fatalMessage(QString)));
    
    connect(this,SIGNAL(setUpForApplicationRunDone(QString&,QString&)), theRunWidget, SLOT(setupForRunApplicationDone(QString&,QString&)));    
    connect(theService, SIGNAL(closeDialog()), this, SLOT(runComplete()));

    //
    // create layout to hold component selectio
    //


    QHBoxLayout *horizontalLayout = new QHBoxLayout();
    this->setLayout(horizontalLayout);
    this->setContentsMargins(0,5,0,5);
    //horizontalLayout->setMargin(0);

    //
    // create the component selection & add the components to it
    //

    theComponentSelection = new SimCenterComponentSelection();
    horizontalLayout->addWidget(theComponentSelection);

    theComponentSelection->addComponent(QString("UQ"),  theUQ_Selection);
    theComponentSelection->addComponent(QString("FEM"), theFEM_Selection);
    theComponentSelection->addComponent(QString("RV"),  theRVs);
    theComponentSelection->addComponent(QString("EDP"),  theEDPs);    
    theComponentSelection->addComponent(QString("RES"), theResults);

    theComponentSelection->displayComponent("UQ");

    // access a web page which will increment the usage count for this tool
    manager = new QNetworkAccessManager(this);

    connect(manager, SIGNAL(finished(QNetworkReply*)),
            this, SLOT(replyFinished(QNetworkReply*)));

    manager->get(QNetworkRequest(QUrl("http://opensees.berkeley.edu/OpenSees/developer/eeuq/use.php")));


    ProgramOutputDialog *theDialog=ProgramOutputDialog::getInstance();
    theDialog->appendInfoMessage("Welcome to quoFEM");
    //    theDialog->hideAfterElapsedTime(1);
}

WorkflowApp_quoFEM::~WorkflowApp_quoFEM()
{
    // hack to get around a sometimes occuring seg fault
    // as some classes in destructur remove RV from the RVCOntainer
    // which may already have been destructed .. so removing so no destructor called

  //    QWidget *newUQ = new QWidget();
  //    theComponentSelection->swapComponent("RV",newUQ);
}


void
WorkflowApp_quoFEM::setMainWindow(MainWindowWorkflowApp* window) {

  this->WorkflowAppWidget::setMainWindow(window);

  //
  // Add a Tool option to menu bar & add options to it
  //
  
  auto menuBar = theMainWindow->menuBar();
  
  QMenu *toolsMenu = new QMenu(tr("&Tools"),menuBar);
  SC_ToolDialog *theToolDialog = new SC_ToolDialog(this);

  //
  // Add Some Tools
  //

  // opensees@designsafe  
  RemoteOpenSeesApp *theOpenSeesApp = new RemoteOpenSeesApp();

  QString testAppName = "simcenter-opensees-frontera";
  QString testAppVersion = "1.0.0";
  TapisMachine *theMachine = new Stampede3Machine();
  SC_RemoteAppTool *theOpenSeesTool = new SC_RemoteAppTool(testAppName,
							   testAppVersion,
							   theMachine,
							   theRemoteService,
							   theOpenSeesApp,
							   theToolDialog);
  QStringList filesToDownload; filesToDownload << "results.zip";
  theOpenSeesTool->setFilesToDownload(filesToDownload, false);
  theOpenSeesTool->setAppNameReport(QString("OpenSeesAtDesignSafe"));  
				 
  
  theToolDialog->addTool(theOpenSeesTool, "OpenSees@DesignSafe");
  QAction *showOpenSees = toolsMenu->addAction("&OpenSees@DesignSafe");
  connect(showOpenSees, &QAction::triggered, this,[this, theDialog=theToolDialog, theEmp = theOpenSeesApp] {
    theDialog->showTool("OpenSees@DesignSafe");
  });
  
  
  //
  // Add Tools to menu bar
  //
  
  QAction* menuAfter = nullptr;
  foreach (QAction *action, menuBar->actions())
  {
    // First check for an examples menu and if that does not exist put it before the help menu
    QString actionText = action->text();
    if(actionText.compare("&Examples") == 0)
    {
        menuAfter = action;
        break;
    }
    else if(actionText.compare("&Help") == 0)
      {
        menuAfter = action;
        break;
    }
  }
  menuBar->insertMenu(menuAfter, toolsMenu);
  //menuBar->addMenu(toolsMenu);
}


void WorkflowApp_quoFEM::replyFinished(QNetworkReply *pReply)
{
    return;
}


bool
WorkflowApp_quoFEM::outputToJSON(QJsonObject &jsonObjectTop) {

    //
    // get each of the main widgets to output themselves
    //
  
    bool result = true;
    QJsonObject apps;
    result = theUQ_Selection->outputAppDataToJSON(apps);
    if (result == false)
        return result;
    
    result = theFEM_Selection->outputAppDataToJSON(apps);
    if (result == false)
        return result;

    jsonObjectTop["Applications"]=apps;
    
    result = theRVs->outputToJSON(jsonObjectTop);
    if (result == false)
        return result;

    result = theEDPs->outputToJSON(jsonObjectTop);
    if (result == false)
        return result;    

    result = theFEM_Selection->outputToJSON(jsonObjectTop);
    if (result == false)
        return result;

    result = theUQ_Selection->outputToJSON(jsonObjectTop);
    if (result == false)
        return result;    

    result = theRunWidget->outputToJSON(jsonObjectTop);
    if (result == false)
        return result;

    result = theResults->outputToJSON(jsonObjectTop);
    if (result == false)
        return result;

    //theRunLocalWidget->outputToJSON(jsonObjectTop);
    
    return result;
}

void
WorkflowApp_quoFEM::processResults(QString &dirName){


  //
  // get results widget fr currently selected UQ option
  //

  theResults=theUQ_Selection->getResults();
  if (theResults == NULL) {
    this->errorMessage("FATAL - UQ option selected not returning results widget");
    return;
  }

  //
  // connect signals for results widget
  //

  connect(theResults,SIGNAL(sendStatusMessage(QString)), this,SLOT(statusMessage(QString)));
  connect(theResults,SIGNAL(sendErrorMessage(QString)), this,SLOT(errorMessage(QString)));

  //
  // swap current results with existing one in selection & disconnect signals
  //

  QWidget *oldResults = theComponentSelection->swapComponent(QString("RES"), theResults);
  if (oldResults != NULL) {
    disconnect(oldResults,SIGNAL(sendErrorMessage(QString)), this,SLOT(errorMessage(QString)));
    disconnect(oldResults,SIGNAL(sendFatalMessage(QString)), this,SLOT(fatalMessage(QString)));  
    delete oldResults;
  }

  //
  // process results
  // 

  theResults->processResults(dirName);

  // theRunWidget->hide();
  theComponentSelection->displayComponent(QString("RES"));
}

void
WorkflowApp_quoFEM::clear(void)
{
    theFEM_Selection->clear();
    theRVs->clear();
    theEDPs->clear();
    theUQ_Selection->clear();
}

bool
WorkflowApp_quoFEM::inputFromJSON(QJsonObject &jsonObject)
{
  //
  // get each of the main widgets to input themselves
  //
  
  if (jsonObject.contains("Applications")) {
    
    QJsonObject theApplicationObject = jsonObject["Applications"].toObject();
    
    if (theUQ_Selection->inputAppDataFromJSON(theApplicationObject) == false)
      this->errorMessage("quoFEM: failed to read UQ application");
    
    if (theFEM_Selection->inputAppDataFromJSON(theApplicationObject) == false)
      this->errorMessage("quoFEM: failed to read FEM application");
    
  } else {
    qDebug() << jsonObject;
    this->errorMessage("quoFEM: failed to find Applicatons section in JSON");
    return false;
  }

  if (theUQ_Selection->inputFromJSON(jsonObject) == false)
    this->errorMessage("quoFEM: failed to read UQ Method data");
  
  if (theFEM_Selection->inputFromJSON(jsonObject) == false)
    this->errorMessage("quoFEM: failed to read FEM Method data");

  theEDPs->inputFromJSON(jsonObject);
  theRVs->inputFromJSON(jsonObject);

  theRunWidget->inputFromJSON(jsonObject);

  auto* theNewResults = theUQ_Selection->getResults();
  //
  if (theNewResults->inputFromJSON(jsonObject) == false)
      this->errorMessage("quoFEM: failed to read RES  data");
  theResults->setResultWidget(theNewResults);
  return true;
}


void
WorkflowApp_quoFEM::onRunButtonClicked() {
    theRunWidget->hide();
    theRunWidget->setMinimumWidth(this->width()*0.5);
    theRunWidget->showLocalApplication();
    GoogleAnalytics::ReportLocalRun();
}

void
WorkflowApp_quoFEM::onRemoteRunButtonClicked(){
    this->errorMessage("");

    bool loggedIn = theRemoteService->isLoggedIn();

    if (loggedIn == true) {
        theRunWidget->hide();
        theRunWidget->setMinimumWidth(this->width()*0.5);
        theRunWidget->showRemoteApplication();

    } else {
        errorMessage("ERROR - You Need to Login");
    }

    GoogleAnalytics::ReportDesignSafeRun();
}

void
WorkflowApp_quoFEM::onRemoteGetButtonClicked(){

    this->errorMessage("");

    bool loggedIn = theRemoteService->isLoggedIn();

    if (loggedIn == true) {

        theJobManager->hide();
        theJobManager->updateJobTable("");
        theJobManager->show();

    } else {
        errorMessage("ERROR - You Need to Login");
    }
}

void
WorkflowApp_quoFEM::onExitButtonClicked(){

}

void
WorkflowApp_quoFEM::setUpForApplicationRun(QString &workingDir, QString &subDir) {

    errorMessage("");

    //
    // create temporary directory in working dir
    // and copy all files needed to this directory by invoking copyFiles() on app widgets
    //

    // designsafe will need a unique name
    /* *********************************************
    will let ParallelApplication rename dir
    QUuid uniqueName = QUuid::createUuid();
    QString strUnique = uniqueName.toString();
    strUnique = strUnique.mid(1,36);
    QString tmpDirName = QString("tmp.SimCenter") + strUnique;
    *********************************************** */

    QString tmpDirName = QString("tmp.SimCenter");
    QDir workDir(workingDir);

    QString tmpDirectory = workDir.absoluteFilePath(tmpDirName);
    QDir destinationDirectory(tmpDirectory);

    if(destinationDirectory.exists()) {
      if (SCUtils::isSafeToRemoveRecursivily(tmpDirectory))      
	destinationDirectory.removeRecursively();
      else {
	QString msg("The Program stopped, it was about to recursivily remove: ");
	msg.append(tmpDirectory);
	fatalMessage(msg);
	return;
      }
    } 

    if (destinationDirectory.mkpath(tmpDirectory) == false) {
      QString msg("quoFEM::setUpForApplicationRun: Could not mkdir: ");
      msg += tmpDirectory;
      this->fatalMessage(msg);
    }

    QString templateDirectory  = destinationDirectory.absoluteFilePath(subDir);
    destinationDirectory.mkpath(templateDirectory);

    // copyPath(path, tmpDirectory, false);
    if (theFEM_Selection->copyFiles(templateDirectory) != true) {
        this->errorMessage("FEM selection failed to copy files");
        return;      
    }
    
    if (theUQ_Selection->copyFiles(templateDirectory) != true) {
        this->errorMessage("UQ selection failed to copy files");
        return;      
    }

    if (theRVs->copyFiles(templateDirectory) != true) {
        this->errorMessage("RV tab failed to copy files");
        return;
    }

    //
    // in new templatedir dir save the UI data into a file (same result as using saveAs)
    // NOTE: we append object workingDir to this which points to template dir
    //

    QString inputFile = templateDirectory + QDir::separator() + tr("scInput.json");

    QFile file(inputFile);
    if (!file.open(QFile::WriteOnly | QFile::Text)) {
        return;
    }
    QJsonObject json;
    if (this->outputToJSON(json) == false) {
        this->errorMessage("WorkflowApp - failed in outputToJson");
        return;
    }
    json["runDir"]=tmpDirectory;
    json["WorkflowType"]="Building Simulation";


    QJsonDocument doc(json);
    file.write(doc.toJson());
    file.close();

    //
    // ouput citation
    //
    
    QJsonObject citations;
    QString citeFile = templateDirectory + QDir::separator() + tr("please_cite.json");    
    this->createCitation(citations, citeFile);
    
    statusMessage("SetUp Done .. Now starting application");

    emit setUpForApplicationRunDone(tmpDirectory, inputFile);
}

int
WorkflowApp_quoFEM::loadFile(QString &fileName){

    statusMessage(QString("Loading File .. ") + fileName);

    //
    // open file
    //

    QFile file(fileName);
    if (!file.open(QFile::ReadOnly | QFile::Text)) {
        this->errorMessage(QString("Could Not Open File: ") + fileName);
        return -1;
    }

    //
    // place contents of file into json object
    //

    QString val;
    val=file.readAll();
    QJsonDocument doc = QJsonDocument::fromJson(val.toUtf8());
    QJsonObject jsonObj = doc.object();

    //Resolve absolute paths from relative ones
    QFileInfo fileInfo(fileName);
    SCUtils::ResolveAbsolutePaths(jsonObj, fileInfo.dir());
    
    // close file
    file.close();

    //
    // clear current and input from new JSON
    //

    this->clear();
    bool result = this->inputFromJSON(jsonObj);
    this->statusMessage("Done Loading File");
    
    if (result == true)
      return 0;
    else
      return -1;
}

int
WorkflowApp_quoFEM::getMaxNumParallelTasks() {
    return theUQ_Selection->getNumParallelTasks();
}


int
WorkflowApp_quoFEM::createCitation(QJsonObject &citation, QString citeFile) {

  QString cit("{\"quoFEM\": { \"citations\": [{\"citation\": \"Frank McKenna, Sang-ri Yi, Aakash Bangalore Satish, Adam Zsarnoczay, Michael Gardner, & Wael Elhaddad. (2025). NHERI-SimCenter/quoFEM: Version 4.1.0 (v4.1.0). https://doi.org/10.5281/zenodo.14583957 \",\"description\": \"This is the overall tool reference used to indicate the version of the tool.\"},{\"citation\": \"Gregory G. Deierlein, Frank McKenna, Adam Zsarnóczay, Tracy Kijewski-Correa, Ahsan Kareem, Wael Elhaddad, Laura Lowes, Matthew J. Schoettler, and Sanjay Govindjee (2020) A Cloud-Enabled Application Framework for Simulating Regional-Scale Impacts of Natural Hazards on the Built Environment. Frontiers in the Built Environment. 6:558706. doi: 10.3389/fbuil.2020.558706\",\"description\": \" This marker paper describes the SimCenter application framework, which was designed to simulate the impacts of natural hazards on the built environment.It  is a necessary attribute for publishing work resulting from the use of SimCenter tools, software, and datasets.\"}]}}");

  QJsonDocument docC = QJsonDocument::fromJson(cit.toUtf8());
  if(!docC.isNull()) {
    if(docC.isObject()) {
      citation = docC.object();        
    }  else {
      qDebug() << "WorkflowdAppEE_UQ citation text is not valid JSON: \n" << cit << endl;
    }
  }
  
  theFEM_Selection->outputCitation(citation);
  theUQ_Selection->outputCitation(citation);

  // write the citation to a citeFile if provided
  
  if (!citeFile.isEmpty()) {
    
    QFile file(citeFile);
    if (!file.open(QFile::WriteOnly | QFile::Text)) {
      errorMessage(QString("writeCitation - could not open file") + citeFile);
      progressDialog->hideProgressBar();
      return 0;
    }

    QJsonDocument doc(citation);
    file.write(doc.toJson());
    file.close();
  }
  
  return 0;    
}