Added endpoint /api/v1/firewall/traffic_shaper/limiter/queue to add and delete child queues for limiters, added corresponding unit tests, minor adjustments to traffic shaper application

Author: jaredhendrickson13

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: jaredhendrickson13

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiterQueue.inc

@@ -0,0 +1,30 @@
+<?php
+//   Copyright 2021 Jared Hendrickson
+//
+//   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.
+
+require_once("api/framework/APIEndpoint.inc");
+
+class APIFirewallTrafficShaperLimiterQueue extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper/limiter/queue";
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperLimiterQueueCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperLimiterQueueDelete())->call();
+    }
+}

pfSense-pkg-API/files/etc/inc/api/framework/APIResponse.inc

@@ -2282,6 +2282,36 @@ function get($id, $data=[], $all=false) {
             "return" => $id,
             "message" => "Firewall traffic shaper limiter bandwidth ID does not exist"
         ],
+        4217 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper limiter queue weight must be between 1 and 100"
+        ],
+        4218 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper parent limiter required"
+        ],
+        4219 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper parent limiter does not exist"
+        ],
+        4220 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper limiter queue name required"
+        ],
+        4221 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper limiter queue name does not exist"
+        ],
 
         //5000-5999 reserved for /users API calls
         5000 => [

pfSense-pkg-API/files/etc/inc/api/models/APIFirewallTrafficShaperLimiterBandwidthCreate.inc

@@ -29,8 +29,17 @@ class APIFirewallTrafficShaperLimiterBandwidthCreate extends APIModel {
         $this->__init_config();
         $this->config["dnshaper"]["queue"][$this->id]["bandwidth"]["item"][] = $this->validated_data;
         $this->write_config();
-        filter_configure();
+        mark_subsystem_dirty('shaper');
 
+        # Only reload the filter immediately if it was requested by the client
+        if ($this->initial_data["apply"] === true) {
+            # Reload the filter, reset RRD logs and mark the subsystem as applied
+            filter_configure();
+            system("rm -f /var/db/rrd/*queuedrops.rrd");
+            system("rm -f /var/db/rrd/*queues.rrd");
+            enable_rrd_graphing();
+            clear_subsystem_dirty('shaper');
+        }
         return APIResponse\get(0, $this->validated_data);
     }
 

pfSense-pkg-API/files/etc/inc/api/models/APIFirewallTrafficShaperLimiterBandwidthDelete.inc

@@ -30,8 +30,17 @@ class APIFirewallTrafficShaperLimiterBandwidthDelete extends APIModel {
     public function action() {
         unset($this->config["dnshaper"]["queue"][$this->parent_id]["bandwidth"]["item"][$this->id]);
         $this->write_config();
-        filter_configure();
+        mark_subsystem_dirty('shaper');
 
+        # Only reload the filter immediately if it was requested by the client
+        if ($this->initial_data["apply"] === true) {
+            # Reload the filter, reset RRD logs and mark the subsystem as applied
+            filter_configure();
+            system("rm -f /var/db/rrd/*queuedrops.rrd");
+            system("rm -f /var/db/rrd/*queues.rrd");
+            enable_rrd_graphing();
+            clear_subsystem_dirty('shaper');
+        }
         return APIResponse\get(0, $this->validated_data);
     }
 

pfSense-pkg-API/files/etc/inc/api/models/APIFirewallTrafficShaperLimiterDelete.inc

@@ -28,8 +28,17 @@ class APIFirewallTrafficShaperLimiterDelete extends APIModel {
     public function action() {
         unset($this->config["dnshaper"]["queue"][$this->id]);
         $this->write_config();
-        filter_configure();
+        mark_subsystem_dirty('shaper');
 
+        # Only reload the filter immediately if it was requested by the client
+        if ($this->initial_data["apply"] === true) {
+            # Reload the filter, reset RRD logs and mark the subsystem as applied
+            filter_configure();
+            system("rm -f /var/db/rrd/*queuedrops.rrd");
+            system("rm -f /var/db/rrd/*queues.rrd");
+            enable_rrd_graphing();
+            clear_subsystem_dirty('shaper');
+        }
         return APIResponse\get(0, $this->validated_data);
     }