Added APIFirewallTrafficShaperRead model to read all configured traffic shapers

Author: jaredhendrickson13

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

@@ -20,6 +20,10 @@ class APIFirewallTrafficShaper extends APIEndpoint {
         $this->url = "/api/v1/firewall/traffic_shaper";
     }
 
+    protected function get() {
+        return (new APIFirewallTrafficShaperRead())->call();
+    }
+
     protected function post() {
         return (new APIFirewallTrafficShaperCreate())->call();
     }

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

@@ -0,0 +1,36 @@
+<?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 APIFirewallTrafficShaperRead extends APIModel {
+    # Create our method constructor
+    public function __construct() {
+        parent::__construct();
+        $this->privileges = ["page-all", "page-firewall-trafficshaper"];
+    }
+
+    public function action() {
+        # Check that we have a configuration
+        if (!empty($this->config["shaper"]["queue"])) {
+            $shaper_array = $this->config["shaper"]["queue"];
+        } else {
+            $shaper_array = [];
+        }
+        return APIResponse\get(0, $shaper_array);
+    }
+}

tests/test_api_v1_firewall_traffic_shaper.py

@@ -16,6 +16,7 @@
 
 class APIUnitTestFirewallRule(unit_test_framework.APIUnitTest):
     url = "/api/v1/firewall/traffic_shaper"
+    get_tests = [{"name": "Read all traffic shapers"}]
     post_tests = [
         {
             "name": "Create a traffic shaper",