cwe_interfacedriver.cpp

/*********************************************************************************
**
** Copyright (c) 2017 The University of Notre Dame
** Copyright (c) 2017 The Regents of the University of California
**
** 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.
**
** 3. Neither the name of the copyright holder nor the names of its contributors may
** be used to endorse or promote products derived from this software without specific
** prior written permission.
**
** 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 HOLDER 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.
**
***********************************************************************************/

// Contributors:
// Written by Peter Sempolinski, for the Natural Hazard Modeling Laboratory, director: Ahsan Kareem, at Notre Dame

#include "cwe_interfacedriver.h"

#include "agaveInterfaces/agavehandler.h"
#include "agaveInterfaces/agavetaskreply.h"
#include "remotejobdata.h"

#include "utilFuncs/authform.h"

#include "remoteJobs/joboperator.h"
#include "remoteFiles/fileoperator.h"

#include "CFDanalysis/cwecaseinstance.h"
#include "CFDanalysis/cweanalysistype.h"
#include "CFDanalysis/cwejobaccountant.h"

#include "mainWindow/cwe_mainwindow.h"
#include "cwe_globals.h"

CWE_InterfaceDriver::CWE_InterfaceDriver(int argc, char *argv[], QObject *parent) : AgaveSetupDriver(argc, argv, parent)
{
    qRegisterMetaType<CaseState>("CaseState");

    // register binary resources
    if (!QResource::registerResource(QCoreApplication::applicationDirPath().append("/resources/cwe_help.rcc")))
    {
        cwe_globals::displayFatalPopup("Error: Unable to locate help files, your install may be corrupted. Please reinstall the client program", "Install Error");
    }

    /* populate with available cases */
    QDir confDir(":/config");
    QStringList filters;
    filters << "*.json" << "*.JSON";
    QStringList caseTypeFiles = confDir.entryList(filters);

    foreach (QString caseConfigFile, caseTypeFiles)
    {
        QString confPath = ":/config/";
        QJsonDocument rawConfig = CWEanalysisType::getRawJSON(confPath, caseConfigFile);
        if (rawConfig.isEmpty())
        {
            qCDebug(agaveAppLayer, "Unreadable template config file skipped: %s", qPrintable(caseConfigFile));
            continue;
        }
        if (CWEanalysisType::jsonConfigIsEnabled(&rawConfig, debugLoggingEnabled))
        {
            CWEanalysisType * newTemplate = new CWEanalysisType(rawConfig);
            if (!newTemplate->validParse())
            {
                qCDebug(agaveAppLayer, "Template Parse Invalid: %s", qPrintable(caseConfigFile));
                delete newTemplate;
            }
            else
            {
                templateList.append(newTemplate);
                qCDebug(agaveAppLayer, "Added New Template: %s", qPrintable(caseConfigFile));
            }
        }
    }
    for (int i = 0; i < argc; i++)
    {
        if (strcmp(argv[i],"useAlternateApps") == 0)
        {
            useAlternateApps = true;
        }
    }
}

CWE_InterfaceDriver::~CWE_InterfaceDriver()
{
    if (mainWindow != nullptr) delete mainWindow;
}

void CWE_InterfaceDriver::startup()
{
    if (offlineMode)
    {
        mainWindow = new CWE_MainWindow();

        mainWindow->runSetupSteps();
        mainWindow->show();

        QObject::connect(mainWindow->windowHandle(),SIGNAL(visibleChanged(bool)),this, SLOT(subWindowHidden(bool)));
        return;
    }

    createAndStartAgaveThread();

    myDataInterface->registerAgaveAppInfo("compress", "compress-0.1u1",{"directory", "compression_type"},{},"directory");
    myDataInterface->registerAgaveAppInfo("extract", "extract-0.1u1",{"inputFile"},{},"");

    authWindow = new AuthForm();
    authWindow->show();
    QObject::connect(authWindow->windowHandle(),SIGNAL(visibleChanged(bool)),this, SLOT(subWindowHidden(bool)));
}

void CWE_InterfaceDriver::closeAuthScreen()
{
    mainWindow = new CWE_MainWindow();
    myJobAccountant = new CWEjobAccountant(this);

    mainWindow->runSetupSteps();
    mainWindow->show();

    QObject::connect(mainWindow->windowHandle(),SIGNAL(visibleChanged(bool)),this, SLOT(subWindowHidden(bool)));

    if (useAlternateApps)
    {
        myDataInterface->registerAgaveAppInfo("cwe-serial", "cwe-serial-0.2.0", {"stage"}, {"directory", "file_input"}, "directory");
        myDataInterface->registerAgaveAppInfo("cwe-parallel", "cwe-parallel-0.2.0", {"stage"}, {"directory", "file_input"}, "directory");
    }
    else
    {
        RemoteDataReply * getAppList = myDataInterface->getAgaveAppList();

        if (getAppList == nullptr)
        {
            cwe_globals::displayFatalPopup("Unable to get app list from DesignSafe");
        }
        QObject::connect(getAppList, SIGNAL(haveAgaveAppList(RequestState,QVariantList)),
                         this, SLOT(checkAppList(RequestState,QVariantList)));
    }

    if (authWindow != nullptr)
    {
        QObject::disconnect(authWindow->windowHandle(),SIGNAL(visibleChanged(bool)),this, SLOT(subWindowHidden(bool)));
        authWindow->hide();
        authWindow->deleteLater();
        authWindow = nullptr;
    }

    //TODO: Reinstate the following, pending privacy policy resolution
    //if (!inDebugMode)
    //{
        //This URL is a counter
    //    pingManager.get(QNetworkRequest(QUrl("http://opensees.berkeley.edu/OpenSees/developer/cwe/use.php")));
    //}
}

void CWE_InterfaceDriver::loadStyleFiles()
{
    QString fullStyleSheet;
    QFile mainStyleFile(":/styleSheets/cweStyle.qss");

#ifdef Q_OS_WIN
    QFile appendedStyle(":/styleSheets/cweWin.qss");
#endif

#ifdef Q_OS_MACOS
    QFile appendedStyle(":/styleSheets/cweMac.qss");
#endif

#ifdef Q_OS_LINUX
    QFile appendedStyle(":/styleSheets/cweLinux.qss");
#endif

    if (!mainStyleFile.open(QFile::ReadOnly))
    {
        cwe_globals::displayFatalPopup("Unable to open main style file. Install may be corrupted.");
    }

    if (!appendedStyle.open(QFile::ReadOnly))
    {
        cwe_globals::displayFatalPopup("Unable to open platform style file. Install may be corrupted.");
    }

    fullStyleSheet = fullStyleSheet.append(mainStyleFile.readAll());
    fullStyleSheet = fullStyleSheet.append(appendedStyle.readAll());

    mainStyleFile.close();
    appendedStyle.close();

    qApp->setStyleSheet(fullStyleSheet);
}

QString CWE_InterfaceDriver::getBanner()
{
    return "SimCenter CWE CFD Client Program";
}

QString CWE_InterfaceDriver::getVersion()
{
    return "Version: 1.1.2";
}

QList<CWEanalysisType *> * CWE_InterfaceDriver::getTemplateList()
{
    return &templateList;
}

void CWE_InterfaceDriver::checkAppList(RequestState replyState, QVariantList appList)
{
    if (replyState != RequestState::GOOD)
    {
        cwe_globals::displayFatalPopup("Unable to connect to Agave to get app info.");
    }

    if (!registerOneAppByVersion(appList, "cwe-serial", {"stage"}, {"directory", "file_input"}, "directory"))
    {
        cwe_globals::displayFatalPopup("To use CWE, the SimCenter needs to register your DesignSafe username. The CWE program depends on several apps hosted on DesignSafe which are not listed as published. Please contact the SimCenter project, with your username, to be able to access these apps.", "Username Registration Needed");
    }
    if (!registerOneAppByVersion(appList, "cwe-parallel", {"stage"}, {"directory", "file_input"}, "directory"))
    {
        cwe_globals::displayFatalPopup("To use CWE, the SimCenter needs to register your DesignSafe username. The CWE program depends on several apps hosted on DesignSafe which are not listed as published. Please contact the SimCenter project, with your username, to be able to access these apps.", "Username Registration Needed");
    }
}

bool CWE_InterfaceDriver::registerOneAppByVersion(QVariantList appList, QString agaveAppName, QStringList parameterList, QStringList inputList, QString workingDirParameter)
{   
    QString idToUse;
    QString versionToUse;

    for (auto itr = appList.constBegin(); itr != appList.constEnd(); itr++)
    {
        QString appName = (*itr).toJsonObject().value("name").toString();
        QString appID = (*itr).toJsonObject().value("id").toString();
        QString appVersion = (*itr).toJsonObject().value("version").toString();

        if (appName != agaveAppName)
        {
            continue;
        }

        if ((idToUse.isEmpty()) || (QString::localeAwareCompare(appVersion, versionToUse) > 0))
        {
            idToUse = appID;
            versionToUse = appVersion;
        }
    }

    if (idToUse.isEmpty())
    {
        qCDebug(remoteInterface, "App searched for was not found.");
        return false;
    }

    myDataInterface->registerAgaveAppInfo(agaveAppName, idToUse, parameterList, inputList, workingDirParameter);
    return true;

}

bool CWE_InterfaceDriver::inOfflineMode()
{
    return offlineMode;
}