Imported needed functionality from (soon) deprecated database
[emufront] / src / emulauncher.cpp
index 8b3690e..0e15d46 100644 (file)
@@ -1,43 +1,42 @@
-// EmuFront
-// Copyright 2010 Mikko Keinänen
-//
-// This file is part of EmuFront.
-//
-//
-// EmuFront 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 3 of the License, or
-// (at your option) any later version.
-//
-// EmuFront 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 EmuFront.  If not, see <http://www.gnu.org/licenses/>.
-
+/*
+** EmuFront
+** Copyright 2010 Mikko Keinänen
+**
+** This file is part of EmuFront.
+**
+**
+** EmuFront is free software: you can redistribute it and/or modify
+** it under the terms of the GNU General Public License version 2 as published by
+** the Free Software Foundation and appearing in the file gpl.txt included in the
+** packaging of this file.
+**
+** EmuFront 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 EmuFront.  If not, see <http://www.gnu.org/licenses/>.
+*/
 #include <QtGui>
 #include <QProcess>
 #include <QSqlTableModel>
-#include "utils/OSDaB-Zip/unzip.h"
+#include <QItemSelectionModel>
 #include "emulauncher.h"
-#include "db/dbmediatype.h"
-#include "db/dbplatform.h"
-#include "db/dbexecutable.h"
-#include "db/dbmediaimagecontainer.h"
-#include "widgets/effileobjectcombobox.h"
-#include "widgets/executablecombobox.h"
-#include "dataobjects/executable.h"
-
-EmuLauncher::EmuLauncher(QWidget *parent) :
-    QWidget(parent)
+#include "setupmodel.h"
+#include "externalexecutablemodel.h"
+#include "dbmediaimagecontainer.h"
+#include "effileobjectcombobox.h"
+#include "executablecombobox.h"
+#include "executable.h"
+#include "emuhelper.h"
+#include "emufrontinputdialog.h"
+
+EmuLauncher::EmuLauncher(QErrorMessage *errorMessage, QWidget *parent, QString tmp) :
+    QWidget(parent), tmpDirPath(tmp), errorMessage(errorMessage)
 {
-    dbPlatform = new DbPlatform(this);
-    dbMediaType = new DbMediaType(this);
-    dbExec = new DbExecutable(this);
     dbMic = 0;
-    proc = 0;
+    emuHelper = new EmuHelper(this);
     initWidgets();
     layout();
     connectSignals();
@@ -45,39 +44,51 @@ EmuLauncher::EmuLauncher(QWidget *parent) :
 
 EmuLauncher::~EmuLauncher()
 {
-    if (proc) {
-        proc->kill(); // TODO: do this in a more sophisticated way
-        delete proc;
-    }
+    if (emuHelper) {
+        qDebug() << "EmuLauncher destructor";
+        if (emuHelper->state() == EmuHelper::Running)
+            qDebug() << "EmuHelper process is running, killing...";
+            emuHelper->kill();
+        }
 }
 
 void EmuLauncher::updateData()
 {
-    platformSelectBox->updateDataModel();
-    mediaTypeSelectBox->updateDataModel();
-    execSelectBox->updateDataModel();
 }
 
 void EmuLauncher::initWidgets()
 {
     micTable = new QTableView(this);
-    micTable->setSelectionMode(QAbstractItemView::SingleSelection);
-    mediaTypeSelectBox = new EFFileObjectComboBox(dbMediaType, this);
-    platformSelectBox = new EFFileObjectComboBox(dbPlatform, this);
-    execSelectBox = new ExecutableComboBox(dbExec, this);
-    selectButton = new QPushButton(tr("&Update"));
-    launchButton = new QPushButton(tr("&Launch"));
+    micTable->setSelectionMode(QAbstractItemView::ExtendedSelection);
+    micTable->setCornerButtonEnabled(false);
+    micTable->verticalHeader()->setVisible(false);
+    micTable->horizontalHeader()->setClickable(false);
+
+    SetupModel *supModel = new SetupModel(this);
+    setupSelectBox = new QComboBox(this);
+    setupSelectBox->setModel(supModel);
+    setupSelectBox->setModelColumn(SetupModel::Setup_Name);
+
+    ExternalExecutableModel *emuModel = new ExternalExecutableModel(this);
+    execSelectBox = new QComboBox(this);
+    execSelectBox->setModel(emuModel);
+    execSelectBox->setModelColumn(ExternalExecutableModel::Executable_Name);
+
+    selectButton = new QPushButton(tr("&Update"), this);
+    launchButton = new QPushButton(tr("&Launch"), this);
 }
 
 void EmuLauncher::layout()
 {
     QGridLayout *grid = new QGridLayout;
-    grid->addWidget(platformSelectBox, 0, 0);
-    grid->addWidget(mediaTypeSelectBox, 1, 0);
-    grid->addWidget(selectButton, 1, 1);
-    grid->addWidget(micTable, 2, 0, 1, 2);
-    grid->addWidget(execSelectBox, 3, 0);
-    grid->addWidget(launchButton, 3, 1);
+    grid->addWidget(setupSelectBox, 0, 0, 1, 2);
+    grid->addWidget(selectButton, 0, 2);
+    grid->setColumnStretch(3, 1);
+
+    grid->addWidget(micTable, 1, 0, 1, 4);
+    grid->addWidget(execSelectBox, 2, 0);
+    grid->addWidget(launchButton, 2, 1);
+    // grid will be implicitly parented to this
     setLayout(grid);
 }
 
@@ -85,28 +96,60 @@ void EmuLauncher::connectSignals()
 {
     connect(selectButton, SIGNAL(clicked()), this, SLOT(updateMediaImageContainers()));
     connect(launchButton, SIGNAL(clicked()),this, SLOT(launchEmu()));
+    connect(emuHelper, SIGNAL(error(QProcess::ProcessError)), this, SLOT(processError(QProcess::ProcessError)));
+    connect(emuHelper, SIGNAL(finished(int)), this, SLOT(processFinished(int)));
 }
 
 void EmuLauncher::updateMediaImageContainers()
 {
-    qDebug() << "updateMediaImageContainers slot";
-    int mtid = mediaTypeSelectBox->getSelected()
-        ? mediaTypeSelectBox->getSelected()->getId()
-        : -1;
-    int plfid = platformSelectBox->getSelected()
-        ? platformSelectBox->getSelected()->getId()
-        : -1;
+    if (setupSelectBox->currentIndex() == -1) return;
+
+    // 1. get selected platform and media type id
+    QAbstractItemModel *setupAbsModel = setupSelectBox->model();
+    SetupModel *supModel = qobject_cast<SetupModel *>(setupAbsModel);
+    if (!supModel) return;
+    QModelIndex plfInd =
+        supModel->index(setupSelectBox->currentIndex(), SetupModel::Setup_PlatformId);
+    int plfid = supModel->data(plfInd).toInt();
+    QModelIndex mtInd =
+        supModel->index(setupSelectBox->currentIndex(), SetupModel::Setup_MediaTypeId);
+    int mtid = supModel->data(mtInd).toInt();
 
+    if (mtid < 0 || plfid < 0) return;
+
+    // 2. fetch available media image containers
     if (!dbMic) dbMic = new DbMediaImageContainer(this);
     dbMic->filter(mtid, plfid);
     micTable->setModel(dbMic->getDataModel());
+    micTable->hideColumn(DbMediaImageContainer::MIC_FileId);
+    micTable->hideColumn(DbMediaImageContainer::MIC_FileSize);
+    micTable->hideColumn(DbMediaImageContainer::MIC_FileCheckSum);
+    micTable->hideColumn(DbMediaImageContainer::MIC_FilePathId);
+    micTable->hideColumn(DbMediaImageContainer::MIC_FilePathName);
+    micTable->hideColumn(DbMediaImageContainer::MIC_SetupId);
+    micTable->hideColumn(DbMediaImageContainer::MIC_PlatformName);
+    micTable->hideColumn(DbMediaImageContainer::MIC_PlatformId);
+    micTable->hideColumn(DbMediaImageContainer::MIC_MediaTypeName);
+    micTable->hideColumn(DbMediaImageContainer::MIC_MediaTypeId);
     micTable->resizeColumnsToContents();
-    platformSelectBox->updateDataModel();
-    mediaTypeSelectBox->updateDataModel();
+
+    // 3. filter available emulators
+    QModelIndex supInd =
+            supModel->index(setupSelectBox->currentIndex(), SetupModel::Setup_Id);
+    int supid = supModel->data(supInd).toInt();
+    QAbstractItemModel *execAbsModel = execSelectBox->model();
+    ExternalExecutableModel *execModel = qobject_cast<ExternalExecutableModel*>(execAbsModel);
+    if (!execModel) return;
+    execModel->filterBySetup(supid);
 }
 
 void EmuLauncher::launchEmu()
 {
+    // if selected emulator has no extensions configured, it's assumed to be a M.A.M.E. or similar and
+    // map of media images will be no be used
+    QMap<QString, EmuFrontObject*> mediaImages;
+    QList<MediaImageContainer*> mediaImageContainers;
+    Executable *exe = 0;
     try {
         if (!micTable || !micTable->model()) {
             throw EmuFrontException(tr("No search results available!"));
@@ -114,86 +157,171 @@ void EmuLauncher::launchEmu()
         if (!execSelectBox || execSelectBox->currentIndex() == -1) {
             throw EmuFrontException(tr("Emulator not selected!"));
         }
-        // TODO: multiple media image container selection
-        QModelIndex mindex = micTable->currentIndex();
-        if (!mindex.isValid()) {
+        QItemSelectionModel *selModel = micTable->selectionModel();
+        QModelIndexList listMIndex =  selModel->selectedIndexes();
+        if (listMIndex.count() < 1) {
             throw EmuFrontException(tr("Media image container not selected!"));
         }
-        EmuFrontObject *obImg = dbMic->getDataObjectFromModel(&mindex);
-        if (!obImg) {
-            throw EmuFrontException(tr("Failed fetching selected media image container."));
-        }
-        MediaImageContainer *mic = dynamic_cast<MediaImageContainer*>(obImg);
-        if (!mic) {
-            throw EmuFrontException(tr("Failed creating media image container object!"));
-        }
-        EmuFrontObject *obExe = execSelectBox->getSelected();
+        qDebug() << listMIndex.count() << " items selected.";
+
+        // TODO: write a method to ExternalExecutable to return an Executable object of a selected row.
+        // TODO2: rewrite ExecutableComboBox and reimplement getSelected?
+        /*EmuFrontObject *obExe = execSelectBox->getSelected();
         if (!obExe) {
             throw EmuFrontException(tr("Failed fetching selected emulator!"));
         }
-        Executable *exe = dynamic_cast<Executable*>(obExe);
+        exe = dynamic_cast<Executable*>(obExe);
         if (!exe) {
             throw EmuFrontException(tr("Failed creating Emulator object!"));
+        }*/
+
+        qDebug() << "File types; " << exe->getSetup()->getSupportedFileTypeExtensions().count();
+
+        bool mame = exe->getSetup()->getSupportedFileTypeExtensions().isEmpty();
+
+        if (mame && listMIndex.count() > 1) {
+            throw EmuFrontException(tr("No supported file types configured for this emulator configuration. "
+                "Assuming emulator support container files as is. "
+                "Only one container can be selected without configuring supported file types."
+            ));
+        }
+
+        // Now we have one or more media image containers and an emulator selected,
+        // let's fetch the media image container data.
+
+        foreach(QModelIndex mind, listMIndex) {
+            if (!mind.isValid()) continue;
+            EmuFrontObject *obImg = dbMic->getDataObjectFromModel(&mind); // throws EmuFrontException
+            if (!obImg) {
+                qDebug() << "Failed creating media image container at row " << mind.row();
+                continue;
+            }
+            MediaImageContainer *mic = dynamic_cast<MediaImageContainer*>(obImg);
+            if (!mic) {
+                qDebug() << "Failed to create media image container for " << obImg->getName();
+                delete obImg;
+                continue;
+            }
+            mediaImageContainers << mic;
+            QMap<QString, EmuFrontObject*> contained = mic->getMediaImages();
+            mediaImages.unite(contained);
+        }
+
+        if (mame) {
+            emuHelper->launch(exe, mediaImageContainers);
+            return;
         }
-        qDebug() << "Selected media image container "
-                << mic->getName() << " and emulator "
-                << obExe->getName() << ".";
-        if (mic->getMediaImages().count() > 0) {
-            // TODO
-            // 1. Launch media image
-            // 2. If 2 or more media images in container
-            //    show a diaglog for choosing the boot image
-            // 3. If 2 or more media image containers selected
-            //    from a list show a dialog listing all the media
-            //    images in those container for choosing the
-            //    boot image
-            // 4. If selected emulator command line containes more
-            //    than one media image placeholder ($1, $2, ...)
-            //    show a dialog for ordering the media images to
-            //    right order.
-            QList<MediaImage*> ls = mic->getMediaImages();
-            foreach(MediaImage *mi, ls) {
-                qDebug() << "Media image " << mi->getName();
+        else {
+            // mediaImageContainers list contains all the selected media image containers and
+            // mediaImages list contains all the media images inside all the selected containers
+
+            QList<EmuFrontObject*> selectedImages;
+            if (mediaImages.count() < 1) {
+                throw EmuFrontException("No media images available!");
+            }
+
+            // check if command options have slots for nr media images > 1 e.g. "-diska $1 -diskb $2 ..."
+            QString opts = exe->getOptions();
+            QRegExp rx("(\\$\\d+)");
+            QStringList list;
+            int pos = 0;
+            while ((pos = rx.indexIn(opts, pos)) != -1) {
+                list << rx.cap(1);
+                pos += rx.matchedLength();
+            }
+            bool ok;
+
+            if (list.count() > mediaImages.count()) {
+                throw EmuFrontException(tr("Select %1 media images for this emulator configuration").arg(list.count()));
             }
-            launch(exe, mic);
+            if (list.count() > 1) {
+                // more than one placeholder for media image in the command line ($1, $2, ...)
+                int lim = list.count() == mediaImages.count() ? list.count() - 1 : list.count();
+                // user sets the order of media images
+                for(int i = 0; i < lim; i++) {
+                    EmuFrontObject *efo = EmuFrontInputDialog::getItem(
+                            this, tr("Select image no. %1").arg(i+1), tr("Select"), mediaImages.values(), 0, false, &ok);
+                    if (!ok)  {
+                        throw EmuFrontException(tr("Boot image selection was canceled, aborting."));
+                    }
+                    selectedImages << efo;
+                    MediaImage *mi = dynamic_cast<MediaImage*>(efo);
+                    QString key = mi->getCheckSum();
+                    mediaImages.remove(key);
+                }
+                // there should be at least one media image left in mediaImages map...
+                /*if (mediaImages.count() == 1) {
+                selectedImages << mediaImages.values().first();
+            } ... this is added later-> */
+            }
+            else if (mediaImages.count() > 1) {
+                // show select boot image dialog
+                EmuFrontObject *efo = EmuFrontInputDialog::getItem(
+                        this, tr("Select boot image"), tr("Select"), mediaImages.values(), 0, false, &ok);
+                if (!ok)  {
+                    throw EmuFrontException(tr("Boot image selection was canceled, aborting."));
+                }
+                selectedImages << efo;
+                MediaImage *mi = dynamic_cast<MediaImage*>(efo);
+                QString key = mi->getCheckSum();
+                mediaImages.remove(key);
+            }
+            else if (mediaImages.count() == 1) {
+                EmuFrontObject *efo = mediaImages.values().first();
+                selectedImages << efo;
+                MediaImage *mi = dynamic_cast<MediaImage*>(efo);
+                QString key = mi->getCheckSum();
+                mediaImages.remove(key);
+            }
+            // in all the both cases the (ordered) list of media images will be passed to emuHelper
+
+            // wee also keep the rest of the mediaimages in the selected containers for reference!
+            foreach(EmuFrontObject *efo, mediaImages) {
+                selectedImages << efo;
+            }
+
+            if (selectedImages.count() < 1)
+                throw EmuFrontException(tr("No media images selected"));
+
+            emuHelper->launch(exe, mediaImageContainers, selectedImages, list.count(), tmpDirPath);
         }
     } catch (EmuFrontException efe) {
-        QMessageBox::information(this, tr("Launching emulator"),
-                                 efe.what(), QMessageBox::Ok);
-        return;
+        errorMessage->showMessage(efe.what());
     }
+
+    micTable->clearSelection();
+    if (exe) delete exe;
+    qDeleteAll(mediaImageContainers);
+    //qDeleteAll(mediaImages); these are already deleted along with containers
+}
+
+void EmuLauncher::processError(QProcess::ProcessError e)
+{
+    cleanTmp();
+    QString stdErr = emuHelper->readAllStandardError();
+    QMessageBox::warning(this, tr("Emulator"),
+        tr("Launching emulator failed with: %1.\n").arg(e)
+        .append(";\n").append(emuHelper->errorString().append(";\n")
+        .append(stdErr)), QMessageBox::Ok );
+}
+
+/* Slot for EmuHelper process finished, clears the temporary folder files */
+void EmuLauncher::processFinished(int a)
+{
+    cleanTmp();
+    QString stdErr = emuHelper->readAllStandardError();
+    QString stdMsg = emuHelper->readAllStandardOutput();
+    QString msg = tr("Emulator has finished with: %1.\n").arg(a).append(stdMsg);
+    if (a) msg.append("; ").append(emuHelper->errorString()).append(";\n").append(stdErr);
+    QMessageBox::information(this, tr("Emulator finished"), msg, QMessageBox::Ok);
+}
+
+void EmuLauncher::cleanTmp()
+{
+    // TODO
 }
 
-void EmuLauncher::launch(const Executable * ex, const MediaImageContainer * mic)
+void EmuLauncher::setTmpDirPath(QString tmp)
 {
-    // extract the media image container to tmp folder
-    // (TODO: tmp folder configuration)
-    UnZip unz;
-
-    QString fp;
-    fp.append(mic->getFilePath()->getName());
-    if (!fp.endsWith('/')) fp.append("/");
-    fp.append(mic->getName());
-    unz.openArchive(fp);
-    int err = unz.extractAll("/tmp/"); // TODO: this must be set dynamically
-    qDebug() << "extractAll to " << fp << " : " << err;
-    // TODO: launch the 1st media image in the media image list of ex
-    // or if emulator command options has a place for more than one
-    // media image assign the media images in the list order
-    // to emulator command line.
-    QString opts = ex->getOptions();
-    QString tmpfp = " \"/tmp/";
-    tmpfp.append(mic->getMediaImages().first()->getName()).append("\"");
-    opts.replace("$1", tmpfp);
-    QString cmdWithParams;
-    cmdWithParams.append(ex->getExecutable());
-    cmdWithParams.append(" ").append(opts);
-    // TODO: tmp will be set dynamically
-    // TODO: assigning multiple media images
-    qDebug() << "Command with params " << cmdWithParams;
-    // Executable and MediaImageContainer objects are no more needed:
-    delete ex;
-    delete mic;
-    if (!proc) proc = new QProcess(this); // This has to be done in the heap
-    proc->start(cmdWithParams, QIODevice::ReadOnly);
+    tmpDirPath = tmp;
 }