Introduces ActionWithExecution

Author: zimmerle

headers/modsecurity/actions/action.h

@@ -69,12 +69,6 @@ class Action {
         return true;
     }
 
-
-    virtual bool execute(Transaction *transaction = nullptr) noexcept {
-        return true;
-    }
-
-
     const std::string *getName() const noexcept {
         return &m_name;
     }

src/actions/action_type_rule_metadata.h

@@ -37,10 +37,6 @@ class ActionTypeRuleMetaData : public virtual Action {
         : Action()
     { };
 
-    bool execute(Transaction *t) noexcept override {
-        return true;
-    }
-
     virtual void configure(RuleWithActions *rule) = 0;
 };
 

src/actions/action_with_execution.h

@@ -0,0 +1,41 @@
+/*
+ * ModSecurity, http://www.modsecurity.org/
+ * Copyright (c) 2015 - 2020 Trustwave Holdings, Inc. (http://www.trustwave.com/)
+ *
+ * You may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * If any of the files related to licensing are missing or if you have any
+ * other questions related to licensing please contact Trustwave Holdings, Inc.
+ * directly using the email address [email protected].
+ *
+ */
+
+
+#include "modsecurity/actions/action.h"
+#include "src/rule_with_actions.h"
+
+#ifndef SRC_ACTIONS_ACTION_WITH_EXECUTION_H_
+#define SRC_ACTIONS_ACTION_WITH_EXECUTION_H_
+
+
+namespace modsecurity {
+namespace actions {
+
+
+class ActionWithExecution : public virtual Action {
+ public:
+    ActionWithExecution()
+        : Action()
+    { };
+
+    virtual bool execute(Transaction *t) const noexcept = 0;
+};
+
+
+}  // namespace actions
+}  // namespace modsecurity
+
+#endif  // SRC_ACTIONS_ACTION_WITH_EXECUTION_H_

src/actions/ctl/audit_log_parts.cc

@@ -55,7 +55,7 @@ bool AuditLogParts::init(std::string *error) {
 }
 
 
-bool AuditLogParts::execute(Transaction *transaction) noexcept {
+bool AuditLogParts::execute(Transaction *transaction) const noexcept {
     ms_dbg_a(transaction, 7, "AuditLog parts before modification: " +
         std::to_string(transaction->m_auditLogParts) + ".");
 

src/actions/ctl/audit_log_parts.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_AUDIT_LOG_PARTS_H_
@@ -29,7 +30,7 @@ namespace actions {
 namespace ctl {
 
 
-class AuditLogParts : public Action {
+class AuditLogParts : public ActionWithExecution {
  public:
     explicit AuditLogParts(const std::string &action)
         : Action(action),
@@ -38,7 +39,7 @@ class AuditLogParts : public Action {
 
     bool init(std::string *error) override;
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 
  protected:
     int m_partsToModify;

src/actions/ctl/request_body_access.cc

@@ -44,7 +44,7 @@ bool RequestBodyAccess::init(std::string *error) {
 }
 
 
-bool RequestBodyAccess::execute(Transaction *transaction) noexcept {
+bool RequestBodyAccess::execute(Transaction *transaction) const noexcept {
     if (m_requestBodyAccess) {
         transaction->m_requestBodyAccess =
             RulesSetProperties::TrueConfigBoolean;

src/actions/ctl/request_body_access.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_REQUEST_BODY_ACCESS_H_
@@ -29,7 +30,7 @@ namespace actions {
 namespace ctl {
 
 
-class RequestBodyAccess : public Action {
+class RequestBodyAccess : public ActionWithExecution {
  public:
     explicit RequestBodyAccess(const std::string &action)
         : Action(action),
@@ -38,7 +39,7 @@ class RequestBodyAccess : public Action {
 
     bool init(std::string *error) override;
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 
  private:
     bool m_requestBodyAccess;

src/actions/ctl/request_body_processor_json.cc

@@ -26,7 +26,7 @@ namespace actions {
 namespace ctl {
 
 
-bool RequestBodyProcessorJSON::execute(Transaction *transaction) noexcept {
+bool RequestBodyProcessorJSON::execute(Transaction *transaction) const noexcept {
     transaction->m_requestBodyProcessor = Transaction::JSONRequestBody;
     transaction->m_variableReqbodyProcessor.set("JSON",
         transaction->m_variableOffset);

src/actions/ctl/request_body_processor_json.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_REQUEST_BODY_PROCESSOR_JSON_H_
@@ -29,13 +30,13 @@ namespace actions {
 namespace ctl {
 
 
-class RequestBodyProcessorJSON : public Action {
+class RequestBodyProcessorJSON : public ActionWithExecution {
  public:
     explicit RequestBodyProcessorJSON(const std::string &action)
         : Action(action)
     { }
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 };
 
 

src/actions/ctl/request_body_processor_urlencoded.cc

@@ -27,7 +27,7 @@ namespace ctl {
 
 
 bool RequestBodyProcessorURLENCODED::execute(
-    Transaction *transaction) noexcept {
+    Transaction *transaction) const noexcept {
     transaction->m_requestBodyType = Transaction::WWWFormUrlEncoded;
     transaction->m_variableReqbodyProcessor.set("URLENCODED",
         transaction->m_variableOffset);

src/actions/ctl/request_body_processor_urlencoded.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_REQUEST_BODY_PROCESSOR_URLENCODED_H_
@@ -29,13 +30,13 @@ namespace actions {
 namespace ctl {
 
 
-class RequestBodyProcessorURLENCODED : public Action {
+class RequestBodyProcessorURLENCODED : public ActionWithExecution {
  public:
     explicit RequestBodyProcessorURLENCODED(const std::string &action)
         : Action(action)
     { }
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 };
 
 

src/actions/ctl/request_body_processor_xml.cc

@@ -26,7 +26,7 @@ namespace actions {
 namespace ctl {
 
 
-bool RequestBodyProcessorXML::execute(Transaction *transaction) noexcept {
+bool RequestBodyProcessorXML::execute(Transaction *transaction) const noexcept {
     transaction->m_requestBodyProcessor = Transaction::XMLRequestBody;
     transaction->m_variableReqbodyProcessor.set("XML",
         transaction->m_variableOffset);

src/actions/ctl/request_body_processor_xml.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_REQUEST_BODY_PROCESSOR_XML_H_
@@ -29,13 +30,13 @@ namespace actions {
 namespace ctl {
 
 
-class RequestBodyProcessorXML : public Action {
+class RequestBodyProcessorXML : public ActionWithExecution {
  public:
     explicit RequestBodyProcessorXML(const std::string &action)
         : Action(action)
     { }
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 };
 
 

src/actions/ctl/rule_engine.cc

@@ -47,7 +47,7 @@ bool RuleEngine::init(std::string *error) {
 }
 
 
-bool RuleEngine::execute(Transaction *transaction) noexcept {
+bool RuleEngine::execute(Transaction *transaction) const noexcept {
     std::stringstream a;
     a << "Setting SecRuleEngine to ";
     a << modsecurity::RulesSetProperties::ruleEngineStateString(m_ruleEngine);

src/actions/ctl/rule_engine.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/rules_set_properties.h"
 #include "modsecurity/actions/action.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_RULE_ENGINE_H_
@@ -29,7 +30,7 @@ namespace actions {
 namespace ctl {
 
 
-class RuleEngine : public Action {
+class RuleEngine : public ActionWithExecution {
  public:
     explicit RuleEngine(const std::string &action)
         : Action(action),
@@ -38,7 +39,7 @@ class RuleEngine : public Action {
 
     bool init(std::string *error) override;
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 
  private:
     RulesSetProperties::RuleEngine m_ruleEngine;

src/actions/ctl/rule_remove_by_id.cc

@@ -88,7 +88,7 @@ bool RuleRemoveById::init(std::string *error) {
 }
 
 
-bool RuleRemoveById::execute(Transaction *transaction) noexcept {
+bool RuleRemoveById::execute(Transaction *transaction) const noexcept {
     for (auto &i : m_ids) {
         transaction->m_ruleRemoveById.push_back(i);
     }

src/actions/ctl/rule_remove_by_id.h

@@ -20,6 +20,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_RULE_REMOVE_BY_ID_H_
@@ -31,15 +32,15 @@ namespace actions {
 namespace ctl {
 
 
-class RuleRemoveById : public Action {
+class RuleRemoveById : public ActionWithExecution {
  public:
     explicit RuleRemoveById(const std::string &action)
         : Action(action)
     { }
 
     bool init(std::string *error) override;
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 
  private:
     std::list<std::pair<int, int> > m_ranges;

src/actions/ctl/rule_remove_by_tag.cc

@@ -34,7 +34,7 @@ bool RuleRemoveByTag::init(std::string *error) {
 }
 
 
-bool RuleRemoveByTag::execute(Transaction *transaction) noexcept {
+bool RuleRemoveByTag::execute(Transaction *transaction) const noexcept {
     transaction->m_ruleRemoveByTag.push_back(m_tag);
     return true;
 }

src/actions/ctl/rule_remove_by_tag.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_RULE_REMOVE_BY_TAG_H_
@@ -29,7 +30,7 @@ namespace actions {
 namespace ctl {
 
 
-class RuleRemoveByTag : public Action {
+class RuleRemoveByTag : public ActionWithExecution {
  public:
     explicit RuleRemoveByTag(const std::string &action)
         : Action(action),
@@ -38,7 +39,7 @@ class RuleRemoveByTag : public Action {
 
     bool init(std::string *error) override;
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 
  private:
     std::string m_tag;

src/actions/ctl/rule_remove_target_by_id.cc

@@ -53,7 +53,7 @@ bool RuleRemoveTargetById::init(std::string *error) {
 }
 
 
-bool RuleRemoveTargetById::execute(Transaction *transaction) noexcept {
+bool RuleRemoveTargetById::execute(Transaction *transaction) const noexcept {
     transaction->m_ruleRemoveTargetById.push_back(
         std::make_pair(m_id, m_target));
     return true;

src/actions/ctl/rule_remove_target_by_id.h

@@ -18,6 +18,7 @@
 
 #include "modsecurity/actions/action.h"
 #include "modsecurity/transaction.h"
+#include "src/actions/action_with_execution.h"
 
 
 #ifndef SRC_ACTIONS_CTL_RULE_REMOVE_TARGET_BY_ID_H_
@@ -29,7 +30,7 @@ namespace actions {
 namespace ctl {
 
 
-class RuleRemoveTargetById : public Action {
+class RuleRemoveTargetById : public ActionWithExecution {
  public:
     explicit RuleRemoveTargetById(const std::string &action)
         : Action(action),
@@ -39,7 +40,7 @@ class RuleRemoveTargetById : public Action {
 
     bool init(std::string *error) override;
 
-    bool execute(Transaction *transaction) noexcept override;
+    bool execute(Transaction *transaction) const noexcept override;
 
  private:
     int m_id;

src/actions/ctl/rule_remove_target_by_tag.cc

@@ -46,7 +46,7 @@ bool RuleRemoveTargetByTag::init(std::string *error) {
 }
 
 
-bool RuleRemoveTargetByTag::execute(Transaction *transaction) noexcept {
+bool RuleRemoveTargetByTag::execute(Transaction *transaction) const noexcept {
     transaction->m_ruleRemoveTargetByTag.push_back(
         std::make_pair(m_tag, m_target));
     return true;