Cleaned up.
[emufront] / src / utils / unziphelper.cpp
1 // EmuFront
2 // Copyright 2010 Mikko Keinänen
3 //
4 // This file is part of EmuFront.
5 //
6 //
7 // EmuFront is free software: you can redistribute it and/or modify
8 // it under the terms of the GNU General Public License version 2 as published by
9 // the Free Software Foundation and appearing in the file gpl.txt included in the
10 // packaging of this file.
11 //
12 // EmuFront is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with EmuFront.  If not, see <http://www.gnu.org/licenses/>.
19
20 #include <QFileInfo>
21 #include <QDebug>
22 #include "unziphelper.h"
23 #include "../dataobjects/mediaimage.h"
24 #include "../dataobjects/filepathobject.h"
25 #include "../exceptions/emufrontexception.h"
26
27 const QString UnzipHelper::UNZIP_COMMAND = "unzip ";
28 const QString UnzipHelper::UNZIP_LIST_ARGS = "-lv ";
29
30 UnzipHelper::UnzipHelper(QObject *parent) :
31     ProcessHelper(parent)
32 {
33 }
34
35 QList<MediaImage*> UnzipHelper::listContents(const QString filePath, const FilePathObject *fp)
36 {
37     if (!fp->getSetup()){
38         throw EmuFrontException(tr("Setup not available with %1.").arg(fp->getName()));
39     }
40
41     QFile fl(filePath);
42     if (!fl.open(QIODevice::ReadOnly)) {
43         throw new EmuFrontException(tr("Couldn't read file %1.").arg(filePath));
44     }
45
46     Setup *sup = fp->getSetup();
47     QList<MediaImage*>  fileList;
48
49     QString command;
50     command.append(UNZIP_COMMAND);
51     command.append(UNZIP_LIST_ARGS);
52     command.append("\"");
53     command.append(filePath);
54     command.append("\"");
55     qDebug() << command;
56     start(command);
57     // TODO: slot(s) for (start and) error signal(s)
58     bool procOk = waitForFinished();
59     if (!procOk) {
60         throw EmuFrontException(tr("Listing information from file %1 failed with unzip.").arg(filePath));
61     }
62     QString err = readAllStandardError();
63     QString msg = readAllStandardOutput();
64     qDebug() << "\nErrors:\n" << err << "\nMessage:\n" << msg;
65
66     /*
67
68     The unzip output should have 8 columns, we need to collect the data from
69     size, crc-32 and name columns.
70
71     $ unzip -lv zak.zip
72     Archive:  zak.zip
73      Length   Method    Size  Cmpr    Date    Time   CRC-32   Name
74     --------  ------  ------- ---- ---------- ----- --------  ----
75       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
76       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
77       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
78       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
79       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
80       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
81       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
82       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
83       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
84       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
85       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
86       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
87       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
88     --------          -------  ---                            -------
89      2273024           996859  56%                            13 files
90
91      Here's a regex tested in VIM matching an entry line
92      /^\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\+.\+$
93
94      Here's a regex (tested in VIM) picking the three required fields, length, crc-32 and filename:
95      :%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
96      */
97     QStringList lines = msg.split('\n'
98         //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+.+$")
99         );
100     QStringList entries;
101     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+.+$");
102     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.+)$");
103     foreach(QString ln, lines) {
104         if (!test.exactMatch(ln)) continue;
105         int pos = regExEntries.indexIn(ln);
106         entries = regExEntries.capturedTexts();
107         if (entries.count() < 4) continue;
108         QString filename = entries[3];
109         QString checksum = entries[2];
110         QString lenStr = entries[1];
111         bool ok;
112         int length = lenStr.toInt(&ok);
113         if (!ok) continue;
114         MediaImage *effo = new MediaImage(filename, checksum, length);
115         fileList << effo;
116     }
117
118     qDebug() << "File list has " << fileList.size() << " entries.";
119     return fileList;
120
121 }
122
123 /*
124     Returns the exit code of the unzip process.
125     Throws EmuFrontException if filePath is not readable
126     or targetPath is not writable.
127 */
128 int UnzipHelper::extractAll(QString filePath, QString targetPath)
129 {
130     QFileInfo fp(filePath);
131     if (!fp.isReadable()) {
132         throw EmuFrontException(tr("Cannot read file %1.").arg(filePath));
133     }
134     QFileInfo tp(targetPath);
135     if (!tp.isWritable()) {
136         throw EmuFrontException(tr("Cannot write to %1.").arg(targetPath));
137     }
138
139     // unzip filepath -d targetpath
140     QString command;
141     command.append(UNZIP_COMMAND);
142     command.append("\"");
143     command.append(filePath);
144     command.append("\"");
145     command.append(" -d ");
146     command.append(targetPath);
147     qDebug() << "Starting unzip command: " << command;
148     start(command);
149     bool procOk = waitForFinished(); // TODO: set timeout, now using default 30000ms
150     if (!procOk) {
151         throw EmuFrontException(tr("Failed unzipping file '%1' to '%2'.").arg(filePath).arg(targetPath));
152     }
153     return exitCode();
154 }