fix: [plugin] fix bug with custom kaitai struct running

Author: hello-adam

src/hobbits-plugins/analyzers/KaitaiStruct/kaitaistruct.cpp

@@ -10,12 +10,11 @@
 #include <QDirIterator>
 #include "hobbitspython.h"
 
-
 KaitaiStruct::KaitaiStruct()
 {
     QList<ParameterDelegate::ParameterInfo> infos = {
-        {"katai_struct_yaml", QJsonValue::String, true},
-        {"precompiled_py_file", QJsonValue::String, true}
+        {PARAM_KSY, QJsonValue::String, true},
+        {PARAM_PY, QJsonValue::String, true}
     };
 
     m_delegate = QSharedPointer<ParameterDelegateUi>(
@@ -90,8 +89,10 @@ QSharedPointer<const AnalyzerResult> KaitaiStruct::analyzeBits(
 
     progress->setProgressPercent(10);
 
-    if (parameters.contains("kaitai_struct_yaml")
-            && !parameters.value("kaitai_struct_yaml").toString().isEmpty()) {
+    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");
@@ -104,7 +105,7 @@ QSharedPointer<const AnalyzerResult> KaitaiStruct::analyzeBits(
         if (!ksy.open(QIODevice::Truncate | QIODevice::WriteOnly)) {
             return AnalyzerResult::error("Could not open ksy file for writing");
         }
-        ksy.write(parameters.value("katai_struct_yaml").toString().toLocal8Bit());
+        ksy.write(parameters.value(PARAM_KSY).toString().toLocal8Bit());
         ksy.close();
 
         progress->setProgressPercent(20);
@@ -135,21 +136,23 @@ QSharedPointer<const AnalyzerResult> KaitaiStruct::analyzeBits(
         if (errorFile.open(QIODevice::ReadOnly)) {
             errorOutput = errorFile.readAll();
             errorFile.close();
+            kscOutput += QString("stderr:\n%2").arg(errorOutput);
         }
 
         if (stdoutFile.open(QIODevice::ReadOnly)) {
             stdOutput = stdoutFile.readAll();
             stdoutFile.close();
+            kscOutput += QString("stdout:\n%2").arg(stdOutput);
         }
 
         if (!errorOutput.isEmpty()) {
-            return AnalyzerResult::error(QString("kaitai-struct-compiler error:\n%1\n\nstdout: %2").arg(errorOutput).arg(stdOutput));
+            return AnalyzerResult::error(QString("kaitai-struct-compiler error:\n%1").arg(kscOutput));
         }
 
     }
-    else if (parameters.contains("precompiled_py_file")
-             && !parameters.value("precompiled_py_file").toString().isEmpty()) {
-        QString precompiledFilePath = parameters.value("precompiled_py_file").toString();
+    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()));
     }
@@ -249,6 +252,13 @@ QSharedPointer<const AnalyzerResult> KaitaiStruct::analyzeBits(
     QSharedPointer<BitInfo> bitInfo = BitInfo::copyFromContainer(container);
     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);
 }
 

src/hobbits-plugins/analyzers/KaitaiStruct/kaitaistructform.cpp

@@ -5,6 +5,7 @@
 #include <QFileDialog>
 #include "settingsmanager.h"
 #include <QDirIterator>
+#include "kaitaistruct.h"
 
 KaitaiStructForm::KaitaiStructForm(QSharedPointer<ParameterDelegate> delegate) :
     ui(new Ui::KaitaiStructForm()),
@@ -13,9 +14,7 @@ KaitaiStructForm::KaitaiStructForm(QSharedPointer<ParameterDelegate> delegate) :
 {
     ui->setupUi(this);
 
-    m_paramHelper->addTextEditStringParameter("katai_struct_yaml", ui->te_ksy);
-
-    m_paramHelper->addParameter("katai_struct_yaml",
+    m_paramHelper->addParameter(PARAM_KSY,
     [this](QJsonValue value) {
         if (value.toString().isEmpty()) {
             return false;
@@ -31,7 +30,7 @@ KaitaiStructForm::KaitaiStructForm(QSharedPointer<ParameterDelegate> delegate) :
         return QJsonValue(ui->te_ksy->toPlainText());
     });
 
-    m_paramHelper->addParameter("precompiled_py_file",
+    m_paramHelper->addParameter(PARAM_PY,
     [this](QJsonValue value) {
         if (value.toString().isEmpty()) {
             return false;
@@ -161,6 +160,7 @@ void KaitaiStructForm::previewBitsUiImpl(QSharedPointer<BitContainerPreview> con
     m_highlightNav->setContainer(container);
     if (container.isNull()) {
         m_highlightNav->setTitle("");
+        ui->te_output->clear();
     }
     else {
         QString resultLabel = container->info()->metadata(KAITAI_RESULT_LABEL).toString();
@@ -169,5 +169,17 @@ void KaitaiStructForm::previewBitsUiImpl(QSharedPointer<BitContainerPreview> con
             resultLabel += "...";
         }
         m_highlightNav->setTitle(resultLabel);
+
+        QString outText = "";
+        QVariant kscOutput = container->info()->metadata(KSC_OUT_LABEL);
+        if (kscOutput.isValid()) {
+            outText += kscOutput.toString() + "\n\n";
+        }
+        QVariant pyOutput = container->info()->metadata(PYTHON_OUT_LABEL);
+        if (pyOutput.isValid()) {
+            outText += pyOutput.toString();
+        }
+        ui->te_output->setPlainText(outText);
+
     }
 }

src/hobbits-plugins/analyzers/KaitaiStruct/kaitaistructform.h

@@ -9,6 +9,11 @@ const QString KAITAI_PATH_KEY = "kaitai_struct_compiler_path";
 const QString KSY_PATH_KEY = "ksy_directory_path";
 const QString KAITAI_STRUCT_CATEGORY = "kaitai_struct";
 const QString KAITAI_RESULT_LABEL = "kaitai_struct_result_label";
+const QString KSC_OUT_LABEL = "KSC Output";
+const QString PYTHON_OUT_LABEL = "Kaitai Python Output";
+
+const QString PARAM_KSY = "kaitai_struct_yaml";
+const QString PARAM_PY = "precompiled_py_file";
 
 namespace Ui
 {