Created APIFirewallTrafficShaperBandwidthDelete model and APIFirewallTrafficLimiterBandwidth endpoint

Author: jaredhendrickson13

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiterBandwidth.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 APIFirewallTrafficShaperLimiterBandwidth extends APIEndpoint {
+    public function __construct() {
+        $this->url = "/api/v1/firewall/traffic_shaper/limiter/bandwidth";
+    }
+
+    protected function post() {
+        return (new APIFirewallTrafficShaperLimiterBandwidthCreate())->call();
+    }
+
+    protected function delete() {
+        return (new APIFirewallTrafficShaperLimiterBandwidthDelete())->call();
+    }
+}

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

@@ -2270,6 +2270,18 @@ function get($id, $data=[], $all=false) {
             "return" => $id,
             "message" => "Firewall traffic shaper limiter and child queues cannot be deleted while in use"
         ],
+        4215 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper limiter bandwidth ID required"
+        ],
+        4216 => [
+            "status" => "bad request",
+            "code" => 400,
+            "return" => $id,
+            "message" => "Firewall traffic shaper limiter bandwidth ID does not exist"
+        ],
 
         //5000-5999 reserved for /users API calls
         5000 => [

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

@@ -0,0 +1,84 @@
+<?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/APIModel.inc");
+require_once("api/framework/APIResponse.inc");
+
+
+class APIFirewallTrafficShaperLimiterBandwidthDelete extends APIModel {
+    private $parent_id;
+
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-firewall-trafficshaper-limiter"];
+        $this->change_note = "Deleted firewall traffic shaper limiter bandwidth via API";
+    }
+
+    public function action() {
+        unset($this->config["dnshaper"]["queue"][$this->parent_id]["bandwidth"]["item"][$this->id]);
+        $this->write_config();
+        filter_configure();
+
+        return APIResponse\get(0, $this->validated_data);
+    }
+
+    public function validate_payload() {
+        $this->__validate_name();
+        $this->__validate_id();
+    }
+
+    private function __validate_name() {
+        # Check for our required `name` payload value
+        if (isset($this->initial_data["name"])) {
+            if ($this->get_limiter_id_by_name($this->initial_data["name"], true)) {
+                $this->parent_id = $this->get_limiter_id_by_name($this->initial_data["name"]);
+            } else {
+                $this->errors[] = APIResponse\get(4209);
+            }
+        } else {
+            $this->errors[] = APIResponse\get(4167);
+        }
+    }
+
+    private function __validate_id() {
+        # Check for our required `id` payload value
+        if (isset($this->initial_data["id"])) {
+            $id = intval($this->initial_data["id"]);
+
+            # Ensure a bandwidth object with this ID exists
+            if (array_key_exists($id, $this->config["dnshaper"]["queue"][$this->parent_id]["bandwidth"]["item"])) {
+                $this->id = $id;
+                $this->validated_data = $this->config["dnshaper"]["queue"][$this->parent_id]["bandwidth"]["item"][$id];
+            } else {
+                $this->errors[] = APIResponse\get(4216);
+            }
+        } else {
+            $this->errors[] = APIResponse\get(4215);
+        }
+    }
+
+    public function get_limiter_id_by_name($name, $as_bool=false) {
+        # Loop through each configured limiter and see if it uses this name
+        foreach ($this->config["dnshaper"]["queue"] as $id=>$limiter) {
+            # Check for matching names
+            if ($name === $limiter["name"]) {
+                return ($as_bool) ? true : $id;
+            }
+        }
+        return ($as_bool) ? false : null;
+    }
+
+}