-
Notifications
You must be signed in to change notification settings - Fork 45
/
kaitaistruct.cpp
338 lines (295 loc) · 12.5 KB
/
kaitaistruct.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
#include "kaitaistruct.h"
#include "kaitaistructform.h"
#include "settingsmanager.h"
#include <QStandardPaths>
#include <QFileDialog>
#include <QTemporaryDir>
#include <QProcess>
#include <QProcessEnvironment>
#include <QJsonArray>
#include <QDirIterator>
#include "hobbitspython.h"
KaitaiStruct::KaitaiStruct()
{
QList<ParameterDelegate::ParameterInfo> infos = {
{PARAM_KSY, ParameterDelegate::ParameterType::String, true},
{PARAM_PY, ParameterDelegate::ParameterType::String, true}
};
m_delegate = ParameterDelegate::create(
infos,
[](const Parameters ¶meters) {
if (parameters.contains("kaitai_struct_yaml")
&& !parameters.value("kaitai_struct_yaml").toString().isEmpty()) {
return QString("Custom Kaitai Parse");
}
else if (parameters.contains("precompiled_py_file")
&& !parameters.value("precompiled_py_file").toString().isEmpty()) {
QFileInfo info(parameters.value("precompiled_py_file").toString());
return QString("Kaitai Parse '%1'").arg(info.baseName());
}
return QString();
},
[](QSharedPointer<ParameterDelegate> delegate, QSize size) {
Q_UNUSED(size)
return new KaitaiStructForm(delegate);
});
}
AnalyzerInterface* KaitaiStruct::createDefaultAnalyzer()
{
return new KaitaiStruct();
}
QString KaitaiStruct::name()
{
return "Kaitai Struct";
}
QString KaitaiStruct::description()
{
return "Parses data using precompiled or custom Kaitai Struct specs";
}
QStringList KaitaiStruct::tags()
{
return {"Generic", "Integration"};
}
QSharedPointer<ParameterDelegate> KaitaiStruct::parameterDelegate()
{
return m_delegate;
}
QSharedPointer<const AnalyzerResult> KaitaiStruct::analyzeBits(
QSharedPointer<const BitContainer> container,
const Parameters ¶meters,
QSharedPointer<PluginActionProgress> progress)
{
QStringList invalidations = m_delegate->validate(parameters);
if (!invalidations.isEmpty()) {
return AnalyzerResult::error(QString("Invalid parameters passed to %1:\n%2").arg(name()).arg(invalidations.join("\n")));
}
progress->setProgressPercent(2);
QTemporaryDir dir;
if (!dir.isValid()) {
return AnalyzerResult::error("Could not allocate a temporary directory");
}
QFile inputBitFile(dir.filePath("input_bit_container.bits"));
QFile outputRangeFile(dir.filePath("parsed_ranges.json"));
if (!inputBitFile.open(QIODevice::Truncate | QIODevice::WriteOnly)) {
return AnalyzerResult::error("Could not allocate a temporary directory");
}
container->bits()->writeTo(&inputBitFile);
inputBitFile.close();
progress->setProgressPercent(10);
QString kscOutput = "";
if (parameters.contains(PARAM_KSY)
&& !parameters.value(PARAM_KSY).toString().isEmpty()) {
QString kscPath = SettingsManager::getPrivateSetting(KAITAI_PATH_KEY).toString();
if (kscPath.isEmpty()) {
return AnalyzerResult::error("A Kaitai Struct Compiler path must be specified");
}
QFile errorFile(dir.filePath("error.log"));
QFile stdoutFile(dir.filePath("stdout.log"));
QFile ksy(dir.filePath("custom.ksy"));
if (!ksy.open(QIODevice::Truncate | QIODevice::WriteOnly)) {
return AnalyzerResult::error("Could not open ksy file for writing");
}
ksy.write(parameters.value(PARAM_KSY).toString().toLocal8Bit());
ksy.close();
progress->setProgressPercent(20);
#ifdef Q_OS_WIN
QStringList kscAgs = {"/C", kscPath, "--debug", "--ksc-json-output", "-t", "python", ksy.fileName()};
#else
QStringList kscAgs = {"--debug", "--ksc-json-output", "-t", "python", ksy.fileName()};
#endif
QProcess kscProcess;
QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
QProcessEnvironment envUpdate;
envUpdate.insert("PATH", env.value("PATH"));
kscProcess.setProcessEnvironment(envUpdate);
kscProcess.setWorkingDirectory(dir.path());
kscProcess.setStandardErrorFile(errorFile.fileName());
kscProcess.setStandardOutputFile(stdoutFile.fileName());
#ifdef Q_OS_WIN
kscProcess.start("cmd.exe", kscAgs);
#else
kscProcess.start(kscPath, kscAgs);
#endif
kscProcess.waitForFinished();
QString stdOutput;
QString errorOutput;
if (errorFile.open(QIODevice::ReadOnly)) {
errorOutput = errorFile.readAll();
errorFile.close();
kscOutput += QString("ksc stderr:\n%2").arg(errorOutput);
}
if (stdoutFile.open(QIODevice::ReadOnly)) {
stdOutput = stdoutFile.readAll();
stdoutFile.close();
kscOutput += QString("ksc stdout:\n%2").arg(stdOutput);
}
// Check for unexpected stderr
if (!errorOutput.isEmpty()) {
return AnalyzerResult::error(QString("kaitai-struct-compiler error:\n%1").arg(kscOutput));
}
// Otherwise, parse the JSON
QJsonObject json = QJsonDocument::fromJson(stdOutput.toLatin1()).object();
for (QString key : json.keys()) {
if (!json.value(key).isObject()) {
continue;
}
QJsonObject obj = json.value(key).toObject();
if (!obj.contains("errors") || !obj.value("errors").isArray()) {
continue;
}
QString errorString = "KSC Error:\n";
QJsonArray arr = obj.value("errors").toArray();
for (QJsonValue val: arr) {
if (!val.isObject()) {
continue;
}
QJsonObject valObj = val.toObject();
QString errFile = valObj.value("file").toString();
QString errLoc = "";
QString errMsg = valObj.value("message").toString();
if (valObj.contains("path") && valObj.value("path").isArray()) {
QJsonArray errPathArr = valObj.value("path").toArray();
QStringList errPathStrings;
for (QJsonValue pathVal: errPathArr) {
errPathStrings.append(pathVal.toString());
}
errLoc += " " + errPathStrings.join("/");
}
if (valObj.contains("line")) {
errLoc += QString(" line:%1").arg(valObj.value("line").toInt());
}
if (valObj.contains("col")) {
errLoc += QString(" col:%1").arg(valObj.value("col").toInt());
}
errorString += QString("%1%2 - %3\n").arg(errFile).arg(errLoc).arg(errMsg);
}
return AnalyzerResult::error(errorString);
}
}
else if (parameters.contains(PARAM_PY)
&& !parameters.value(PARAM_PY).toString().isEmpty()) {
QString precompiledFilePath = parameters.value(PARAM_PY).toString();
QFileInfo info(precompiledFilePath);
QFile::copy(precompiledFilePath, dir.filePath(info.fileName()));
}
else {
return AnalyzerResult::error("Invalid parameters - must have a precompiled py or a custom ksy spec");
}
progress->setProgressPercent(40);
QString pyDepDir = dir.filePath("pydeps");
HobbitsPython::recursiveDirCopy(":/kaitaistruct/scripts/dependencies", pyDepDir);
auto pyRequest = PythonRequest::create(":/kaitaistruct/scripts/runner.py")->setFunctionName("parse_data");
pyRequest->addPathExtension(pyDepDir);
pyRequest->addArg(PythonArg::qString(inputBitFile.fileName()));
pyRequest->addArg(PythonArg::qString(outputRangeFile.fileName()));
auto watcher = HobbitsPython::getInstance().runProcessScript(pyRequest, true);
watcher->watcher()->future().waitForFinished();
auto result = watcher->result();
QString output = "";
bool errors = false;
if (!result->getStdOut().isEmpty()) {
output += "Python stdout:\n" + result->getStdOut() + "\n\n";
}
if (!result->getStdErr().isEmpty()) {
errors = true;
output += "Python stderr:\n" + result->getStdErr() + "\n\n";
}
if (!result->errors().isEmpty()) {
errors = true;
output += "Other errors:\n" + result->errors().join("\n") + "\n\n";
}
if (errors) {
return AnalyzerResult::error(QString("Failure Running parser in Python:\n%1").arg(output));
}
progress->setProgressPercent(85);
if (!outputRangeFile.exists()) {
QString errorString = "No analysis file was produced - check the Output tab to see if ksc or python produced any errors.";
errorString += "\n\nCommon problems to check for:";
errorString += "\n- Are you pointing to a valid Python 3 with the kaitaistruct package 0.9 installed?";
errorString += "\n- Are you pointing to a valid kaitai-struct-compiler version 0.9?";
return AnalyzerResult::error(errorString);
}
if (!outputRangeFile.open(QIODevice::ReadOnly)) {
return AnalyzerResult::error("Could not open analysis file for reading");
}
QJsonDocument outputData = QJsonDocument::fromJson((outputRangeFile.readAll()));
outputRangeFile.close();
if (!outputData.isObject()) {
return AnalyzerResult::error("Output analysis file has an invalid format");
}
QJsonObject outputObj = outputData.object();
if (!outputObj.contains("sections") || !outputObj.value("sections").isArray()) {
return AnalyzerResult::error("Output analysis file doesn't contain a 'sections' specification");
}
QList<RangeHighlight> highlights;
QMap<QString, QPair<Range, QList<QString>>> labelMap;
QList<QString> topLevel;
QJsonArray sections = outputObj.value("sections").toArray();
int sectionNum = 0;
for (auto section: sections) {
if (!section.isObject()) {
continue;
}
sectionNum++;
QJsonObject s = section.toObject();
QString label = QString("<%1>").arg(sectionNum);
if (s.contains("label") && s.value("label").isString()) {
label = s.value("label").toString();
}
if (!s.contains("start") || !s.contains("end") || !s.value("start").isDouble() || !s.value("end").isDouble()) {
labelMap.insert(label, {Range(), {}});
}
else {
Range range(qint64(s.value("start").toDouble())*8, qint64(s.value("end").toDouble())*8 - 1);
labelMap.insert(label, {range, {}});
}
if (!s.contains("parent") || s.value("parent").toString().isEmpty()) {
topLevel.append(label);
}
else if (labelMap.contains(s.value("parent").toString())) {
labelMap[s.value("parent").toString()].second.append(label);
}
}
int colorIdx = 0;
for (auto label : topLevel) {
highlights.append(makeHighlight(label, labelMap, colorIdx));
}
QSharedPointer<BitInfo> bitInfo = BitInfo::copyFromContainer(container);
bitInfo->clearHighlightCategory(KAITAI_STRUCT_CATEGORY);
bitInfo->addHighlights(highlights);
if (!kscOutput.isEmpty()) {
bitInfo->setMetadata(KSC_OUT_LABEL, kscOutput);
}
if (!output.isEmpty()) {
bitInfo->setMetadata(PYTHON_OUT_LABEL, output);
}
return AnalyzerResult::result(bitInfo, parameters);
}
RangeHighlight KaitaiStruct::makeHighlight(QString label, const QMap<QString, QPair<Range, QList<QString>>> &rangeData, int &colorIdx)
{
QList<QColor> colors = {
QColor(100, 220, 100, 200),
QColor(100, 0, 255, 200),
QColor(0, 150, 230, 200),
QColor(200, 140, 0, 200),
QColor(250, 50, 0, 200)
};
auto pair = rangeData.value(label);
if (pair.second.isEmpty()) {
auto highlight = RangeHighlight(KAITAI_STRUCT_CATEGORY, label, pair.first, colors.at(colorIdx).rgba());
colorIdx = (colorIdx + 1) % colors.size();
return highlight;
}
else {
int parentColorIndex = colorIdx;
colorIdx = 0;
QList<RangeHighlight> children;
for (auto child : pair.second) {
children.append(makeHighlight(child, rangeData, colorIdx));
}
colorIdx = parentColorIndex;
auto highlight = RangeHighlight(KAITAI_STRUCT_CATEGORY, label, children, colors.at(colorIdx).rgba());
colorIdx = (colorIdx + 1) % colors.size();
return highlight;
}
}