feat: add IsVerbose field to Rule for detailed debug output (#106)

Author: Copilot

object/rule.go

@@ -38,6 +38,7 @@ type Rule struct {
 	Action      string        `xorm:"varchar(100) notnull" json:"action"`
 	StatusCode  int           `xorm:"int notnull" json:"statusCode"`
 	Reason      string        `xorm:"varchar(100) notnull" json:"reason"`
+	IsVerbose   bool          `xorm:"bool" json:"isVerbose"`
 }
 
 func GetGlobalRules() ([]*Rule, error) {

rule/rule.go

@@ -19,6 +19,7 @@ import (
 	"net/http"
 
 	"github.com/casbin/caswaf/object"
+	"github.com/casbin/caswaf/util"
 )
 
 type Rule interface {
@@ -89,7 +90,10 @@ func CheckRules(ruleIds []string, r *http.Request) (*RuleResult, error) {
 
 			// Update reason if rule has custom reason
 			if result.Action == "Block" || result.Action == "Drop" {
-				if rule.Reason != "" {
+				if rule.IsVerbose {
+					// Add verbose debug info with rule name and triggered expression
+					result.Reason = util.GenerateVerboseReason(rule.GetId(), result.Reason, rule.Reason)
+				} else if rule.Reason != "" {
 					result.Reason = rule.Reason
 				} else if result.Reason != "" {
 					result.Reason = fmt.Sprintf("hit rule %s: %s", ruleIds[i], result.Reason)

util/rule.go

@@ -0,0 +1,29 @@
+// Copyright 2024 The casbin Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// 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
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package util
+
+import "fmt"
+
+// GenerateVerboseReason creates a detailed reason message for verbose mode
+func GenerateVerboseReason(ruleId string, expressionReason string, customReason string) string {
+	verboseReason := fmt.Sprintf("Rule [%s] triggered", ruleId)
+	if expressionReason != "" {
+		verboseReason += fmt.Sprintf(" - %s", expressionReason)
+	}
+	if customReason != "" {
+		verboseReason += fmt.Sprintf(" - Custom reason: %s", customReason)
+	}
+	return verboseReason
+}

web/src/RuleEditPage.js

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 import React from "react";
-import {Button, Card, Col, Input, InputNumber, Row, Select} from "antd";
+import {Button, Card, Col, Input, InputNumber, Row, Select, Switch} from "antd";
 import * as Setting from "./Setting";
 import * as RuleBackend from "./backend/RuleBackend";
 import i18next from "i18next";
@@ -216,6 +216,19 @@ class RuleEditPage extends React.Component {
             </Col>
           </Row>
         }
+        {
+          <Row style={{marginTop: "20px"}}>
+            <Col span={2} style={{marginTop: "5px"}}>
+              {i18next.t("rule:Verbose mode")}:
+            </Col>
+            <Col span={22}>
+              <Switch checked={this.state.rule.isVerbose}
+                onChange={checked => {
+                  this.updateRuleField("isVerbose", checked);
+                }} />
+            </Col>
+          </Row>
+        }
       </Card>
     );
   }

web/src/locales/de/data.json

@@ -86,6 +86,7 @@
     "Status code": "Status code",
     "Type": "Type",
     "Value": "Value",
+    "Verbose mode": "Verbose mode",
     "and": "and",
     "begin": "begin",
     "contains": "contains",

web/src/locales/en/data.json

@@ -86,6 +86,7 @@
     "Status code": "Status code",
     "Type": "Type",
     "Value": "Value",
+    "Verbose mode": "Verbose mode",
     "and": "and",
     "begin": "begin",
     "contains": "contains",

web/src/locales/es/data.json

@@ -86,6 +86,7 @@
     "Status code": "Status code",
     "Type": "Type",
     "Value": "Value",
+    "Verbose mode": "Verbose mode",
     "and": "and",
     "begin": "begin",
     "contains": "contains",

web/src/locales/fr/data.json

@@ -86,6 +86,7 @@
     "Status code": "Status code",
     "Type": "Type",
     "Value": "Value",
+    "Verbose mode": "Verbose mode",
     "and": "and",
     "begin": "begin",
     "contains": "contains",

web/src/locales/id/data.json

@@ -86,6 +86,7 @@
     "Status code": "Status code",
     "Type": "Type",
     "Value": "Value",
+    "Verbose mode": "Verbose mode",
     "and": "and",
     "begin": "begin",
     "contains": "contains",

web/src/locales/ja/data.json

@@ -86,6 +86,7 @@
     "Status code": "Status code",
     "Type": "Type",
     "Value": "Value",
+    "Verbose mode": "Verbose mode",
     "and": "and",
     "begin": "begin",
     "contains": "contains",