Replacing the OSDaB-ZIP functionality using unzip utility.
[emufront] / src / utils / fileutil.cpp
index 126bb09..77e77f5 100644 (file)
@@ -1,18 +1,53 @@
+// 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 <QDir>
 #include <QDebug>
+#include <QProcess>
 #include "fileutil.h"
-#include "OSDaB-Zip/unzip.h"
+#include "zlib.h" /* crc32 */
+//#include "OSDaB-Zip/unzip.h"
 #include "../exceptions/emufrontexception.h"
 #include "../dataobjects/setup.h"
 #include "../dataobjects/mediaimage.h"
 #include "../dataobjects/mediaimagecontainer.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 ";
 
 FileUtil::FileUtil(QObject *parent) : QObject(parent)
-{}
+{
+    buf = new char[READ_BUFFER];
+}
 
-QList<MediaImageContainer*> FileUtil::scanFilePath(const FilePathObject *fp, QStringList filters)
+FileUtil::~FileUtil()
+{
+    delete[] buf;
+}
+
+/* Throws EmuFrontException */
+int FileUtil::scanFilePath(FilePathObject *fp, QStringList filters, DbMediaImageContainer *dbMic)
 {
     if (!fp->getSetup()){
         throw EmuFrontException(tr("Setup not available with %1.").arg(fp->getName()));
@@ -25,10 +60,10 @@ QList<MediaImageContainer*> FileUtil::scanFilePath(const FilePathObject *fp, QSt
         throw new 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")
         .arg(fp->getSetup()->getPlatform()->getName())
         .arg(fp->getSetup()->getMediaType()->getName());
-    QList<MediaImageContainer*> containers;
     QDir dir(fp->getName());
     if (!dir.exists() || !dir.isReadable())
         throw EmuFrontException(tr("Directory %1 doesn't exists or isn't readable!").arg(fp->getName()));
@@ -40,6 +75,9 @@ QList<MediaImageContainer*> FileUtil::scanFilePath(const FilePathObject *fp, QSt
 
     // 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.
+    QList<MediaImageContainer*> containers;
     for (int i = 0; i < list.size(); ++i)
     {
         QFileInfo fileInfo = list.at(i);
@@ -50,43 +88,155 @@ QList<MediaImageContainer*> FileUtil::scanFilePath(const FilePathObject *fp, QSt
 
         if (files.count() > 0)
         {
-            MediaImageContainer *con = new MediaImageContainer
-                (
+            // read crc32 checksum for media image container
+            quint32 crc = readCrc32(fileInfo.absoluteFilePath());
+            FilePathObject *fpo = new FilePathObject(*fp);
+            MediaImageContainer *con = new MediaImageContainer (
                     fileInfo.fileName(),
-                    "" /* TODO: count checksum! */,
+                    QString("%1").arg(crc, 0, 16),
                     fileInfo.size(),
                     files,
-                    // TODO: is it guaranteed, that the file path object containing the setup object remains alive
-                    // the whole lifecycle of (this) media image container object?
-                    // * if we assign a copy of the setup object -> waste of memory and time
-                    // * this function is designed to be used from media image path main dialog
-                    //   where we can ensure the lifecycle of file path object -> maybe move the implementation there!?
-                    // TODO: Ensure this! We really need a reference instead of 1000s of copies of setup object!!!
-                    fp->getSetup()
+                    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();
+            }
             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();
+
+    }
     qDebug() << "Done scanning files!";
-    return containers;
+    return count;
 }
 
-QList<MediaImage*> FileUtil::listContents(const QString filePath, const FilePathObject *fp)
+/* Uses crc32 from zlib.h to count crc32 checksum value */
+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;
+    if (!file.open(QIODevice::ReadOnly)) {
+        throw new EmuFrontException(QString(tr("Failed opening file %1 for reading the checksum!")).arg(filePath));
+    }
+    quint32 crc = crc32(0L, Z_NULL, 0);
+    int read = 0;
+    while((read = file.read(buf, READ_BUFFER))) {
+        crc = crc32(crc, (const Bytef*) buf, read);
+    }
+    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);
+    return crc;
+}
 
-    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<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<UnZip::ZipEntry> list = uz.entryList();
     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);
+    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+(.+)$");
+    foreach(QString ln, lines) {
+        if (!test.exactMatch(ln)) continue;
+        int pos = regExEntries.indexIn(ln);
+        if (regExEntries.captureCount() != 3) {
+            continue;
+            //throw new EmuFrontException(tr("Failed to read needed data from file %1.").arg(filePath));
+        }
+        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);
+    }
+
+    /*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;
@@ -98,7 +248,7 @@ QList<MediaImage*> FileUtil::listContents(const QString filePath, const FilePath
                 checksum, entry.uncompressedSize);
             fileList << effo;
         }
-    }
+    }*/
 
     qDebug() << "File list has " << fileList.size() << " entries.";
     return fileList;