Changes debuglogs schema to avoid unecessary str allocation

Author: Felipe Zimmerle

headers/modsecurity/debug_log.h

@@ -50,8 +50,8 @@ class DebugLog {
     const std::string& getDebugLogFile();
     virtual int getDebugLogLevel();
 
- private:
     int m_debugLevel;
+ private:
     std::string m_fileName;
 };
 

headers/modsecurity/transaction.h

@@ -48,6 +48,30 @@ typedef struct Rules_t Rules;
 #include "modsecurity/collection/collection.h"
 #include "modsecurity/variable_origin.h"
 
+#ifndef NO_LOGS
+#define ms_dbg(b, c) \
+  do { \
+      if (m_rules && m_rules->m_debugLog && m_rules->m_debugLog->m_debugLevel >= b) { \
+          m_rules->debug(b, m_id, m_uri, c); \
+      } \
+  } while (0);
+#else
+#define ms_dbg(b, c) \
+  do { } while (0);
+#endif
+
+#ifndef NO_LOGS
+#define ms_dbg_a(t, b, c) \
+  do { \
+      if (t && t->m_rules && t->m_rules->m_debugLog && t->m_rules->m_debugLog->m_debugLevel >= b) { \
+          t->debug(b, c); \
+      } \
+  } while (0);
+#else
+#define ms_dbg_a(t, b, c) \
+    do { } while (0);
+#endif
+
 
 #define LOGFY_ADD(a, b) \
     yajl_gen_string(g, reinterpret_cast<const unsigned char*>(a), strlen(a)); \

src/actions/block.cc

@@ -31,9 +31,7 @@ namespace actions {
 
 bool Block::evaluate(Rule *rule, Transaction *transaction,
     std::shared_ptr<RuleMessage> rm) {
-#ifndef NO_LOGS
-    transaction->debug(8, "Marking request as disruptive.");
-#endif
+    ms_dbg_a(transaction, 8, "Marking request as disruptive.");
 
     for (Action *a : transaction->m_rules->m_defaultActions[rule->m_phase]) {
         if (a->isDisruptive() == false) {

src/actions/ctl/rule_engine.cc

@@ -19,6 +19,7 @@
 #include <string>
 
 #include "modsecurity/rules_properties.h"
+#include "modsecurity/rules.h"
 #include "modsecurity/transaction.h"
 
 namespace modsecurity {
@@ -50,9 +51,7 @@ bool RuleEngine::evaluate(Rule *rule, Transaction *transaction) {
     a << modsecurity::RulesProperties::ruleEngineStateString(m_ruleEngine);
     a << " as requested by a ctl:ruleEngine action";
 
-#ifndef NO_LOGS
-    transaction->debug(8, a.str());
-#endif
+    ms_dbg_a(transaction, 8, a.str());
 
     transaction->m_secRuleEngine = m_ruleEngine;
     return true;

src/actions/disruptive/allow.cc

@@ -20,6 +20,7 @@
 
 #include "modsecurity/transaction.h"
 #include "modsecurity/rule.h"
+#include "modsecurity/rules.h"
 #include "src/utils/string.h"
 #include "modsecurity/modsecurity.h"
 
@@ -49,11 +50,9 @@ bool Allow::init(std::string *error) {
 
 
 bool Allow::evaluate(Rule *rule, Transaction *transaction) {
-#ifndef NO_LOGS
-    transaction->debug(4, "Dropping the evaluation of upcoming rules " \
+    ms_dbg_a(transaction, 4, "Dropping the evaluation of upcoming rules " \
         "in favor of an `allow' action of type: " \
         + allowTypeToName(m_allowType));
-#endif
 
     transaction->m_allowType = m_allowType;
 

src/actions/disruptive/deny.cc

@@ -30,9 +30,7 @@ namespace disruptive {
 
 bool Deny::evaluate(Rule *rule, Transaction *transaction,
     std::shared_ptr<RuleMessage> rm) {
-#ifndef NO_LOGS
-    transaction->debug(8, "Running action deny");
-#endif
+    ms_dbg_a(transaction, 8, "Running action deny");
 
     if (transaction->m_it.status == 200) {
         transaction->m_it.status = 403;

src/actions/disruptive/deny.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "modsecurity/rules.h"
 #include "modsecurity/rule_message.h"
 
 #ifndef SRC_ACTIONS_DISRUPTIVE_DENY_H_

src/actions/disruptive/pass.cc

@@ -21,6 +21,7 @@
 
 #include "modsecurity/transaction.h"
 #include "modsecurity/rule.h"
+#include "modsecurity/rules.h"
 #include "modsecurity/rule_message.h"
 
 namespace modsecurity {
@@ -33,9 +34,7 @@ bool Pass::evaluate(Rule *rule, Transaction *transaction,
     intervention::free(&transaction->m_it);
     intervention::reset(&transaction->m_it);
 
-#ifndef NO_LOGS
-    transaction->debug(8, "Running action pass");
-#endif
+    ms_dbg_a(transaction, 8, "Running action pass");
 
     return true;
 }

src/actions/exec.cc

@@ -21,6 +21,7 @@
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
 #include "modsecurity/rule.h"
+#include "modsecurity/rules.h"
 #include "src/utils/system.h"
 #include "src/engine/lua.h"
 
@@ -49,9 +50,7 @@ bool Exec::init(std::string *error) {
 
 
 bool Exec::evaluate(Rule *rule, Transaction *t) {
-#ifndef NO_LOGS
-    t->debug(8, "Running script... " + m_script);
-#endif
+    ms_dbg_a(t, 8, "Running script... " + m_script);
     m_lua.run(t);
     return true;
 }

src/actions/init_col.cc

@@ -67,10 +67,8 @@ bool InitCol::evaluate(Rule *rule, Transaction *t) {
         return false;
     }
 
-#ifndef NO_LOGS
-    t->debug(5, "Collection `" + m_collection_key + "' initialized with " \
+    ms_dbg_a(t, 5, "Collection `" + m_collection_key + "' initialized with " \
         "value: " + collectionName);
-#endif
 
     return true;
 }