Text substitution within rule's titles and descriptions

[Šimon Lukašík]

This patch set enables variable titles and descriptions of the rules.
You can test the patches with examplary content at 

 
https://git.fedorahosted.org/cgit/openscap.git/tree/tests/API/XCCDF/unitt...

Cheeers!

[PATCH 1/2] Introduce a helper function for <xccdf:sub> resolution within xccdf:Item

[Šimon Lukašík]

From: Simon Lukasik <slukasik(a)redhat.com&gt;

---
 CMakeLists.txt       |  2 +-
 include/APIHelpers.h | 15 +++++++++++++++
 src/APIHelpers.cpp   | 17 +++++++++++++++++
 3 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 59b0366..6454f2c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -20,7 +20,7 @@ endif()
 # custom openscap parameters.
 if (NOT DEFINED OPENSCAP_LIBRARIES OR NOT DEFINED OPENSCAP_INCLUDE_DIRS)
     include("${CMAKE_ROOT}/Modules/FindPkgConfig.cmake")
-    pkg_check_modules(OPENSCAP REQUIRED libopenscap>=1.0.4)
+    pkg_check_modules(OPENSCAP REQUIRED libopenscap>=1.0.5)
 endif()
 
 # This is optional, only required if user wants documentation rebuilt
diff --git a/include/APIHelpers.h b/include/APIHelpers.h
index cf8f2a2..e1face5 100644
--- a/include/APIHelpers.h
+++ b/include/APIHelpers.h
@@ -29,6 +29,7 @@
 extern "C"
 {
 #include <xccdf_benchmark.h>
+#include <xccdf_policy.h>
 }
 
 /**
@@ -39,6 +40,20 @@ extern "C"
 QString oscapTextIteratorGetPreferred(struct oscap_text_iterator* it, const QString&
lang = "");
 
 /**
+ * Get human readable title of the given XCCDF Item. The title is selected based on the
given
+ * preferred language and then the the XCCDF Substitution is resolved in accordance with
given
+ * XCCDF policy.
+ */
+QString oscapItemGetReadableTitle(struct xccdf_item *item, struct xccdf_policy *policy,
const QString& lang = "");
+
+/**
+ * Get human readable description of the given XCCDF Item. The description is selected
based
+ * on the given preferred language and then the the XCCDF Substitution is resolved in
accordance
+ * with given XCCDF policy.
+ */
+QString oscapItemGetReadableDescription(struct xccdf_item *item, struct xccdf_policy
*policy, const QString& lang = "");
+
+/**
  * Returns QString containing utf8 contents of oscap_err_desc()
  */
 QString oscapErrDesc();
diff --git a/src/APIHelpers.cpp b/src/APIHelpers.cpp
index c553ba5..8f1f057 100644
--- a/src/APIHelpers.cpp
+++ b/src/APIHelpers.cpp
@@ -24,6 +24,7 @@
 extern "C"
 {
 #include <oscap_error.h>
+#include <xccdf_policy.h>
 }
 
 QString oscapTextIteratorGetPreferred(struct oscap_text_iterator* it, const QString&
lang)
@@ -36,6 +37,22 @@ QString oscapTextIteratorGetPreferred(struct oscap_text_iterator* it,
const QStr
     return ret;
 }
 
+QString oscapItemGetReadableTitle(struct xccdf_item *item, struct xccdf_policy *policy,
const QString& lang)
+{
+    char* readable_s = xccdf_policy_get_readable_item_title(policy, item, lang.isEmpty()
? NULL : lang.toUtf8().constData());
+    const QString ret(readable_s != NULL ? QString::fromUtf8(readable_s) :
"(none)");
+    free(readable_s);
+    return ret;
+}
+
+QString oscapItemGetReadableDescription(struct xccdf_item *item, struct xccdf_policy
*policy, const QString& lang)
+{
+    char* readable_s = xccdf_policy_get_readable_item_description(policy, item,
lang.isEmpty() ? NULL : lang.toUtf8().constData());
+    const QString ret(readable_s != NULL ? QString::fromUtf8(readable_s) :
"(none)");
+    free(readable_s);
+    return ret;
+}
+
 QString oscapErrDesc()
 {
     return QString::fromUtf8(oscap_err_desc());
-- 
1.8.5.3

[PATCH 2/2] Resolve <xccdf:sub> elements when showing titles and descriptions of the rules.

[Šimon Lukašík]

From: Simon Lukasik <slukasik(a)redhat.com&gt;

The <xccdf:sub> elements in the tailoring window are left untouched.
That way we provide better visibility into what is happening behind
the curtain. This design decision shall be revisited once the
set-value/refine-value feature is implemented.
---
 src/MainWindow.cpp | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/src/MainWindow.cpp b/src/MainWindow.cpp
index ed5733b..6acf002 100644
--- a/src/MainWindow.cpp
+++ b/src/MainWindow.cpp
@@ -869,12 +869,10 @@ void MainWindow::refreshSelectedRulesTree()
          it != selectedRules.end(); ++it)
     {
         struct xccdf_rule* rule = *it;
-        const QString preferredTitle =
oscapTextIteratorGetPreferred(xccdf_rule_get_title(rule));
-        const QString preferredDesc =
oscapTextIteratorGetPreferred(xccdf_rule_get_description(rule));
 
         QTreeWidgetItem* treeItem = new QTreeWidgetItem();
-        treeItem->setText(0, preferredTitle);
-        treeItem->setToolTip(0, preferredDesc);
+        treeItem->setText(0, oscapItemGetReadableTitle((struct xccdf_item *)rule,
policy));
+        treeItem->setToolTip(0, oscapItemGetReadableDescription((struct xccdf_item
*)rule, policy));
 
         mUI.selectedRulesTree->addTopLevelItem(treeItem);
     }
@@ -903,16 +901,20 @@ void MainWindow::scanProgressReport(const QString& rule_id,
const QString& resul
     assert(fileOpened());
 
     struct xccdf_benchmark* benchmark = 0;
+    struct xccdf_policy* policy = 0;
     try
     {
         benchmark =
xccdf_policy_model_get_benchmark(xccdf_session_get_policy_model(mScanningSession->getXCCDFSession()));
+        policy = xccdf_session_get_xccdf_policy(mScanningSession->getXCCDFSession());
     }
     catch (const std::exception& e)
     {
-        scanErrorMessage(QString("Can't get benchmark from scanning session,
details follow:\n%1").arg(QString::fromUtf8(e.what())));
+        scanErrorMessage(QString("Can't get benchmark or policy from scanning
session, details follow:\n%1").arg(QString::fromUtf8(e.what())));
 
         return;
     }
+    if (!policy)
+        return;
 
     struct xccdf_item* item = xccdf_benchmark_get_member(benchmark, XCCDF_ITEM,
rule_id.toUtf8().constData());
 
@@ -930,8 +932,8 @@ void MainWindow::scanProgressReport(const QString& rule_id, const
QString& resul
     if (mUI.ruleResultsTree->findItems(rule_id, Qt::MatchExactly, 0).empty())
         mUI.progressBar->setValue(mUI.progressBar->value() + 1);
 
-    const QString preferredTitle =
oscapTextIteratorGetPreferred(xccdf_item_get_title(item));
-    const QString preferredDesc =
oscapTextIteratorGetPreferred(xccdf_item_get_description(item));
+    const QString preferredTitle = oscapItemGetReadableTitle(item, policy);
+    const QString preferredDesc = oscapItemGetReadableDescription(item, policy);
 
     QString resultTooltip;
     QBrush resultBrush;
-- 
1.8.5.3

[Martin Preisler]

----- Original Message -----
>  From: "Simon Lukasik" <isimluk(a)fedoraproject.org&gt;
>  To: scap-workbench(a)lists.fedorahosted.org
>  Sent: Tuesday, March 11, 2014 11:09:01 AM
>  Subject: Text substitution within rule's titles and descriptions
>  
>  This patch set enables variable titles and descriptions of the rules.
>  You can test the patches with examplary content at
>  
>   
> https://git.fedorahosted.org/cgit/openscap.git/tree/tests/API/XCCDF/unitt...
>  
>  Cheeers!
>   
Merged. Thanks!

https://git.fedorahosted.org/cgit/scap-workbench.git/commit/?id=65f940f7f...
https://git.fedorahosted.org/cgit/scap-workbench.git/commit/?id=c5804b4fb...

-- 
Martin Preisler