Merge pull request #47 from ybznek/v1-1-error-2

Show LibXML errors in Diagnostics Dialog

Author: mpreisler

include/APIHelpers.h

@@ -66,4 +66,11 @@ QString oscapItemGetReadableDescription(struct xccdf_item* item, struct xccdf_po
  */
 QString oscapErrDesc();
 
+/**
+ * Returns QString containing utf8 contents of oscap_err_get_full_error()
+ *
+ * @exception nothrow This function is guaranteed to not throw any exceptions.
+ */
+QString oscapErrGetFullError();
+
 #endif

include/DiagnosticsDialog.h

@@ -50,6 +50,17 @@ enum MessageSeverity
     MS_ERROR
 };
 
+/**
+ * @brief MessageFormat can be any subset of this flags
+ */
+enum MessageFormat
+{
+    MF_STANDARD = 0x01,
+    MF_PREFORMATTED = 0x02, // Preserve whitespaces to output
+    MF_XML = 0x04, // Replace xml metacharacters with xml entities
+    MF_PREFORMATTED_XML = MF_PREFORMATTED | MF_XML,
+};
+
 /**
  * @brief Workbench displays errors and warnings, this dialog groups them
  *
@@ -85,31 +96,31 @@ class DiagnosticsDialog : public QDialog
          * The diagnostics dialog will not open when just these messages are
          * received.
          */
-        void infoMessage(const QString& message);
+        void infoMessage(const QString& message, MessageFormat format = MF_STANDARD);
 
         /**
          * @brief Scanner triggers this to show a warning message
          *
          * A warning message will open the diagnostics dialog if it isn't
          * being shown already.
          */
-        void warningMessage(const QString& message);
+        void warningMessage(const QString& message, MessageFormat format = MF_STANDARD);
 
         /**
          * @brief Scanner triggers this to show an error message
          *
          * An error message will open the diagnostics dialog if it isn't
          * being shown already.
          */
-        void errorMessage(const QString& message);
+        void errorMessage(const QString& message, MessageFormat format = MF_STANDARD);
 
         /**
          * @brief Report a caught exception.
          */
-        void exceptionMessage(const std::exception& e, const QString& context = "");
+        void exceptionMessage(const std::exception& e, const QString& context = "", MessageFormat format = MF_STANDARD);
 
     private:
-        void pushMessage(MessageSeverity severity, const QString& fullMessage);
+        void pushMessage(MessageSeverity severity, const QString& fullMessage, MessageFormat format = MF_STANDARD);
 
         /**
          * @brief Pushes a single info message containing version info

src/APIHelpers.cpp

@@ -70,3 +70,11 @@ QString oscapErrDesc()
 {
     return QString::fromUtf8(oscap_err_desc());
 }
+
+QString oscapErrGetFullError()
+{
+    char* fullErrorCstr = oscap_err_get_full_error();
+    QString fullError = QString::fromUtf8(fullErrorCstr);
+    free(fullErrorCstr);
+    return fullError;
+}

src/DiagnosticsDialog.cpp

@@ -63,36 +63,37 @@ void DiagnosticsDialog::waitUntilHidden(unsigned int interval)
     }
 }
 
-void DiagnosticsDialog::infoMessage(const QString& message)
+void DiagnosticsDialog::infoMessage(const QString& message, MessageFormat format)
 {
-    pushMessage(MS_INFO, message);
+    pushMessage(MS_INFO, message, format);
 }
 
-void DiagnosticsDialog::warningMessage(const QString& message)
+void DiagnosticsDialog::warningMessage(const QString& message, MessageFormat format)
 {
-    pushMessage(MS_WARNING, message);
+    pushMessage(MS_WARNING, message, format);
 
     // warning message is important, make sure the diagnostics are shown
     show();
 }
 
-void DiagnosticsDialog::errorMessage(const QString& message)
+void DiagnosticsDialog::errorMessage(const QString& message, MessageFormat format)
 {
-    pushMessage(MS_ERROR, message);
+    pushMessage(MS_ERROR, message, format);
 
     // error message is important, make sure the diagnostics are shown
     show();
 }
 
-void DiagnosticsDialog::exceptionMessage(const std::exception& e, const QString& context)
+void DiagnosticsDialog::exceptionMessage(const std::exception& e, const QString& context, MessageFormat format)
 {
-    pushMessage(MS_EXCEPTION, (context.isEmpty() ? "" : context + "\n\n" + QString::fromUtf8(e.what())));
+    pushMessage(MS_EXCEPTION, (context.isEmpty() ? "" : context + "\n\n" + QString::fromUtf8(e.what())), format);
 
     // error message is important, make sure the diagnostics are shown
     show();
 }
 
-void DiagnosticsDialog::pushMessage(MessageSeverity severity, const QString& fullMessage)
+
+void DiagnosticsDialog::pushMessage(MessageSeverity severity, const QString& fullMessage, MessageFormat format)
 {
     char stime[11];
     stime[10] = '\0';
@@ -132,9 +133,21 @@ void DiagnosticsDialog::pushMessage(MessageSeverity severity, const QString& ful
     strSeverity = strSeverity.leftJustified(8);
 
     std::cerr << stime << " | " << strSeverity.toUtf8().constData() << " | " << fullMessage.toUtf8().constData() << std::endl;
+   
+    QString outputMessage = fullMessage;
+    if (format & MF_XML)
+    {
+        outputMessage = Qt::escape(outputMessage);
+    }
+    
+    if (format & MF_PREFORMATTED)
+    {
+        outputMessage = QString("<pre>%1</pre>").arg(outputMessage);
+    }
+    
     mUI.messages->append(
         QString("<table><tr><td style=\"padding:5px 0px 0px 5px\"><pre>%1 </pre></td><td style=\"background: %2; padding:5px\"><pre>%3 </pre></td><td>%4</td></tr></table>\n")
-            .arg(stime, bgCol, strSeverity, fullMessage)
+            .arg(stime, bgCol, strSeverity, outputMessage)
     );
 }
 

src/MainWindow.cpp

@@ -337,7 +337,7 @@ void MainWindow::openFile(const QString& path)
         setWindowTitle(QObject::tr("SCAP Workbench"));
         mUI.tailoringFileComboBox->clear();
 
-        mDiagnosticsDialog->exceptionMessage(e, QObject::tr("Error while opening file."));
+        mDiagnosticsDialog->exceptionMessage(e, QObject::tr("Error while opening file."), MF_PREFORMATTED_XML);
     }
 }
 

src/ScanningSession.cpp

@@ -615,7 +615,7 @@ void ScanningSession::reloadSession(bool forceReload) const
     {
         if (xccdf_session_load(mSession) != 0)
             throw ScanningSessionException(
-                QString("Failed to reload session. OpenSCAP error message:\n%1").arg(oscapErrDesc()));
+                QString("Failed to reload session. OpenSCAP error message:\n%1").arg(oscapErrGetFullError()));
 
         struct xccdf_policy_model* policyModel = xccdf_session_get_policy_model(mSession);