Added signaling from FileUtil to MediaImagePathMainDiialog when the scan
[emufront] / src / utils / fileutil.cpp
index 5a6678e..80874bc 100644 (file)
@@ -20,9 +20,9 @@
 #include <QDir>
 #include <QDebug>
 #include <QProcess>
+#include <QProgressDialog>
 #include "fileutil.h"
 #include "zlib.h" /* crc32 */
-//#include "OSDaB-Zip/unzip.h"
 #include "../exceptions/emufrontexception.h"
 #include "../dataobjects/setup.h"
 #include "../dataobjects/mediaimage.h"
 #include "../dataobjects/mediatype.h"
 #include "../dataobjects/platform.h"
 #include "../db/dbmediaimagecontainer.h"
-
-//int FileUtil::MIC_BUFFER_SIZE = 50;
-
-const QString FileUtil::UNZIP_COMMAND = "unzip ";
-const QString FileUtil::UNZIP_LIST_ARGS = "-lv ";
+#include "unziphelper.h"
 
 FileUtil::FileUtil(QObject *parent) : QObject(parent)
 {
     buf = new char[READ_BUFFER];
+    unzipHelper = new UnzipHelper(this);
 }
 
 FileUtil::~FileUtil()
@@ -47,7 +44,9 @@ FileUtil::~FileUtil()
 }
 
 /* Throws EmuFrontException */
-int FileUtil::scanFilePath(FilePathObject *fp, QStringList filters, DbMediaImageContainer *dbMic)
+int FileUtil::scanFilePath(FilePathObject *fp,
+    QStringList filters, DbMediaImageContainer *dbMic,
+    QProgressDialog *progressDialog)
 {
     if (!fp->getSetup()){
         throw EmuFrontException(tr("Setup not available with %1.").arg(fp->getName()));
@@ -57,81 +56,100 @@ int FileUtil::scanFilePath(FilePathObject *fp, QStringList filters, DbMediaImage
             .arg(fp->getSetup()->getName()));
     }
     else if (!fp->getSetup()->getMediaType()){
-        throw new EmuFrontException(tr("No media type available with %1.")
+        throw EmuFrontException(tr("No media type available with %1.")
             .arg(fp->getSetup()->getName()));
     }
+
     int count = 0;
-    qDebug() << QString("We have a platform %1, media type %2")
+    /*qDebug() << QString("We have a platform %1, media type %2")
         .arg(fp->getSetup()->getPlatform()->getName())
-        .arg(fp->getSetup()->getMediaType()->getName());
+        .arg(fp->getSetup()->getMediaType()->getName());*/
     QDir dir(fp->getName());
     if (!dir.exists() || !dir.isReadable())
         throw EmuFrontException(tr("Directory %1 doesn't exists or isn't readable!").arg(fp->getName()));
 
-    qDebug() << QString("Scanning directory %1.").arg(fp->getName());
+    //qDebug() << QString("Scanning directory %1.").arg(fp->getName());
     dir.setFilter(QDir::Files | QDir::NoSymLinks | QDir::NoDotAndDotDot | QDir::Readable);
 
     if (filters.count() > 0) dir.setNameFilters(filters);
 
     // we'll go through the filtered archive files...
     QFileInfoList list = dir.entryInfoList();
-    // TODO: only a buffer of objects should be kept here,
-    // and write to database each time the buffer is filled.
+    //qDebug() << "We have " << list.count() << " files to go through.";
     QList<MediaImageContainer*> containers;
-    for (int i = 0; i < list.size(); ++i)
-    {
-        QFileInfo fileInfo = list.at(i);
-        qDebug() << QString("%1 %2").arg(fileInfo.size(), 10).arg(fileInfo.absoluteFilePath());
-
-        //... and collect the contents of each archive
-        QList<MediaImage*> files = listContents(fileInfo.absoluteFilePath(), fp);
-
-        if (files.count() > 0)
+    try {
+        progressDialog->setMinimum(0);
+        progressDialog->setMaximum(list.size());
+        for (int i = 0; i < list.size(); ++i)
         {
-            // read crc32 checksum for media image container
-            quint32 crc = readCrc32(fileInfo.absoluteFilePath());
-            FilePathObject *fpo = new FilePathObject(*fp);
-            MediaImageContainer *con = new MediaImageContainer (
-                    fileInfo.fileName(),
-                    QString("%1").arg(crc, 0, 16),
-                    fileInfo.size(),
-                    files,
-                    fpo // we need a copy since MediaImageContainers are deleted and the original filepath object would get deleted also.
-                );
-            containers.append(con);
-            ++count;
-            qDebug() << "We have " << containers.count() << " containers.";
-
-            if (containers.count() >= MIC_BUFFER_SIZE)  {
-                qDebug() << "We have " << containers.count()
-                    << " containers .. storing to db.";
-                dbMic->storeContainers(containers, fp);
-                qDeleteAll(containers);
-                containers.clear();
-                qDebug() << "containers now: " << containers.count();
+            progressDialog->setValue(i);
+            if (progressDialog->wasCanceled())
+                break;
+            QFileInfo fileInfo = list.at(i);
+            //qDebug() << QString("%1 %2").arg(fileInfo.size(), 10).arg(fileInfo.absoluteFilePath());
+
+            //... and collect the contents of each archive
+            QMap<QString, EmuFrontObject*> files = unzipHelper->listContents(fileInfo.absoluteFilePath(), fp);
+
+            if (files.count() > 0)
+            {
+                // read crc32 checksum for media image container
+                quint32 crc = readCrc32(fileInfo.absoluteFilePath());
+                FilePathObject *fpo = new FilePathObject(*fp);
+                MediaImageContainer *con = new MediaImageContainer (
+                        fileInfo.fileName(),
+                        QString("%1").arg(crc, 0, 16),
+                        fileInfo.size(),
+                        files,
+                        fpo // we need a copy since MediaImageContainers are deleted and the original filepath object would get deleted also.
+                        );
+                containers.append(con);
+                ++count;
+                //qDebug() << "We have " << containers.count() << " containers.";
+
+                if (containers.count() >= MIC_BUFFER_SIZE)  {
+                    //qDebug() << "We have " << containers.count() << " containers .. storing to db.";
+                    emit dbUpdateInProgress();
+                    dbMic->storeContainers(containers, fp);
+                    emit dbUpdateFinished();
+                    qDeleteAll(containers);
+                    containers.clear();
+                    //qDebug() << "containers now: " << containers.count();
+                }
+                //qDebug() << "We have " << containers.size() << " containers.";
+            } // files.count() > 0
+            else {
+                qDebug() << "No files from container " << fileInfo.absoluteFilePath();
             }
-            qDebug() << "We have " << containers.size() << " containers.";
         }
-    }
-    if (containers.count() > 0) {
-        qDebug() << "Storing the rest " << containers.count() << " containers.";
-        dbMic->storeContainers(containers, fp);
-        qDeleteAll(containers);
-        containers.clear();
+        progressDialog->setValue(list.size());
+        if (containers.count() > 0) {
+            //qDebug() << "Storing the rest " << containers.count() << " containers.";
+            emit dbUpdateInProgress();
+            dbMic->storeContainers(containers, fp);
+            emit dbUpdateFinished();
+            qDeleteAll(containers);
+            containers.clear();
 
+        }
+    } catch (EmuFrontException &e) {
+        qDebug() << "Got exception " << e.what() << ", aborting & deleting created data objects.";
+        qDeleteAll(containers);
+        throw e;
     }
-    qDebug() << "Done scanning files!";
+    //qDebug() << "Done scanning files!";
     return count;
 }
 
 /* Uses crc32 from zlib.h to count crc32 checksum value */
+/* Throws EmuFrontException */
 quint32 FileUtil::readCrc32(QString filePath)
 {
     // todo ... use some crc32 tool for this ... or maybe use md5 or something like that!!!
     QFile file(filePath);
-    qDebug() << "readCrc32: " << filePath;
+    //qDebug() << "readCrc32: " << filePath;
     if (!file.open(QIODevice::ReadOnly)) {
-        throw new EmuFrontException(QString(tr("Failed opening file %1 for reading the checksum!")).arg(filePath));
+        throw EmuFrontException(QString(tr("Failed opening file %1 for reading the checksum!")).arg(filePath));
     }
     quint32 crc = crc32(0L, Z_NULL, 0);
     int read = 0;
@@ -140,119 +158,11 @@ quint32 FileUtil::readCrc32(QString filePath)
     }
     file.close();
     if (crc <= 0)
-        throw new EmuFrontException(QString(tr("Failed reading crc checksum for file %1!")).arg(filePath));
-    qDebug() << QString("readCrc32, crc: %1").arg(crc, 0, 16);
+        throw EmuFrontException(QString(tr("Failed reading crc checksum for file %1!")).arg(filePath));
+    //qDebug() << QString("readCrc32, crc: %1").arg(crc, 0, 16);
     return crc;
 }
 
-QList<MediaImage*> FileUtil::listContents(const QString filePath, const FilePathObject *fp)
-{
-    if (!fp->getSetup()){
-        throw EmuFrontException(tr("Setup not available with %1.").arg(fp->getName()));
-    }
-
-    QFile fl(filePath);
-    if (!fl.open(QIODevice::ReadOnly)) {
-        throw new EmuFrontException(tr("Couldn't read file %1.").arg(filePath));
-    }
-
-    Setup *sup = fp->getSetup();
-    QList<MediaImage*>  fileList;
-
-    QProcess proc(this);
-    QString command;
-    command.append(UNZIP_COMMAND);
-    command.append(UNZIP_LIST_ARGS);
-    command.append("\"");
-    command.append(filePath);
-    command.append("\"");
-    qDebug() << command;
-    proc.start(command);
-    // TODO: slot(s) for (start and) error signal(s)
-    bool procOk = proc.waitForFinished();
-    if (!procOk) {
-        throw new EmuFrontException(tr("Listing information from file %1 failed with unzip.").arg(filePath));
-    }
-    QString err = proc.readAllStandardError();
-    QString msg = proc.readAllStandardOutput();
-    qDebug() << "\nErrors:\n" << err << "\nMessage:\n" << msg;
-
-    /*
-
-    The unzip output should have 8 columns, we need to collect the data from
-    size, crc-32 and name columns.
-
-    $ unzip -lv zak.zip
-    Archive:  zak.zip
-     Length   Method    Size  Cmpr    Date    Time   CRC-32   Name
-    --------  ------  ------- ---- ---------- ----- --------  ----
-      174848  Defl:N    21936  88% 1996-12-24 23:32 cd68329c  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 1 of 2 Side A)(Boot).d64
-      174848  Defl:N    21949  87% 1996-12-24 23:32 dc0d89f8  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 1 of 2 Side A)(Boot)[a].d64
-      174848  Defl:N    81818  53% 1996-12-24 23:32 a11bc616  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 1 of 2 Side A)(Boot)[cr ESI].d64
-      174848  Defl:N    48833  72% 1996-12-24 23:32 0815053d  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 1 of 2 Side A)(Boot)[cr SCI].d64
-      174848  Defl:N   105964  39% 1996-12-24 23:32 0c943d80  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 1 of 2 Side A)[cr Ikari].d64
-      174848  Defl:N    17876  90% 1996-12-24 23:32 51397eb8  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 1 of 2 Side B)[cr SCI].d64
-      174848  Defl:N   106231  39% 1996-12-24 23:32 0efadb0a  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side A).d64
-      174848  Defl:N   105974  39% 1996-12-24 23:32 6935c3e7  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side A)[a].d64
-      174848  Defl:N   105963  39% 1996-12-24 23:32 1e9c31de  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side A)[cr ESI].d64
-      174848  Defl:N    26294  85% 1996-12-24 23:32 ba5fdfdd  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side A)[cr Ikari].d64
-      174848  Defl:N   117996  33% 1996-12-24 23:32 efbf3fd6  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side B).d64
-      174848  Defl:N   118015  33% 1996-12-24 23:32 c9541ecd  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side B)[a].d64
-      174848  Defl:N   118010  33% 1996-12-24 23:32 68341056  Zak McKracken and the Alien Mindbenders (1988)(Lucasfilm Games)(Disk 2 of 2 Side B)[cr ESI].d64
-    --------          -------  ---                            -------
-     2273024           996859  56%                            13 files
-
-     Here's a regex tested in VIM matching an entry line
-     /^\s\+\d\+\s\+[A-Za-z:]*\s\+\d\+\s\+\d\{1,3}%\s\+\d\{4}-\d\{2}-\d\{2}\s\+\d\{2}:\d\{2}\s\+[0-9a-f]\{8}\s\+.\+$
-
-     Here's a regex (tested in VIM) picking the three required fields, length, crc-32 and filename:
-     :%s/^\s\+\(\d\+\)\s\+[A-Za-z:]*\s\+\d\+\s\+\d\{1,3}%\s\+\d\{4}-\d\{2}-\d\{2}\s\+\d\{2}:\d\{2}\s\+\([0-9a-f]\{8}\)\s\+\(.*$\)/\1 \2 \3/gc
-     */
-    QStringList lines = msg.split('\n'
-        //QRegExp("^\\s+\\d+\\s+[A-Za-z:]*\\s+\\d+\\s+\\d{1,3}%\\s+\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}\\s+[0-9a-f]{8}\\s+.+$")
-        );
-    QStringList entries;
-    QRegExp test("^\\s+\\d+\\s+[A-Za-z:]*\\s+\\d+\\s+\\d{1,3}%\\s+\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}\\s+[0-9a-f]{8}\\s+.+$");
-    QRegExp regExEntries("^\\s+(\\d+)\\s+[A-Za-z:]*\\s+\\d+\\s+\\d{1,3}%\\s+\\d{4}-\\d{2}-\\d{2}\\s+\\d{2}:\\d{2}\\s+([0-9a-f]{8})\\s+(\\S.+)$");
-    foreach(QString ln, lines) {
-        if (!test.exactMatch(ln)) continue;
-        int pos = regExEntries.indexIn(ln);
-        entries = regExEntries.capturedTexts();
-        if (entries.count() < 4) continue;
-        QString filename = entries[3];
-        QString checksum = entries[2];
-        QString lenStr = entries[1];
-        bool ok;
-        int length = lenStr.toInt(&ok);
-        if (!ok) continue;
-        MediaImage *effo = new MediaImage(filename, checksum, length);
-        fileList << effo;
-    }
-
-    /*UnZip uz;
-    UnZip::ErrorCode ec = uz.openArchive(filePath);
-    if (ec != UnZip::Ok)
-        throw EmuFrontException(tr("Error while opening zip-file %1, error code %2").arg(filePath).arg(ec));
-
-    QList<UnZip::ZipEntry> list = uz.entryList();
-    foreach(UnZip::ZipEntry entry, list)
-    {
-        qDebug() << "Zip entry " << entry.filename;
-        if (isSupportedFile(entry.filename, sup->getSupportedFileTypeExtensions()))
-        {
-            QString checksum = QString("%1").arg(entry.crc32, 0, 16);
-            qDebug() << "Checksum " << checksum;
-            MediaImage *effo = new MediaImage(entry.filename,
-                checksum, entry.uncompressedSize);
-            fileList << effo;
-        }
-    }*/
-
-    qDebug() << "File list has " << fileList.size() << " entries.";
-    return fileList;
-
-}
-
 bool FileUtil::isSupportedFile(const QString filename, const QStringList supportedFileExtensions)
 {
     QString ext = filename.section('.', -1);