From 82a0b947d9d664252c27b497c6286ffdc81a88ac Mon Sep 17 00:00:00 2001
From: Maxime Thiebaut <46688461+0xThiebaut@users.noreply.github.com>
Date: Wed, 2 Apr 2025 16:38:06 +0200
Subject: [PATCH] sysutils/beats: Refactor namespace (#4633)

* sysutils/beats: Refactor namespace

* Update sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/ACL/ACL.xml

---------

Co-authored-by: Franco Fichtner <franco@lastsummer.de>
---
 .../{Filebeat => Beats}/Api/ServiceController.php      | 10 +++++-----
 .../{Filebeat => Beats}/Api/SettingsController.php     |  6 +++---
 .../OPNsense/{Filebeat => Beats}/IndexController.php   |  4 ++--
 .../OPNsense/{Filebeat => Beats}/forms/filebeat.xml    |  0
 .../opnsense/mvc/app/models/OPNsense/Beats/ACL/ACL.xml |  9 +++++++++
 .../app/models/OPNsense/{Beats8 => Beats}/Filebeat.php |  2 +-
 .../app/models/OPNsense/{Beats8 => Beats}/Filebeat.xml |  0
 .../mvc/app/models/OPNsense/Beats/Menu/Menu.xml        |  7 +++++++
 .../mvc/app/models/OPNsense/Beats8/ACL/ACL.xml         |  9 ---------
 .../mvc/app/models/OPNsense/Beats8/Menu/Menu.xml       |  7 -------
 .../app/views/OPNsense/{Beats8 => Beats}/filebeat.volt | 10 +++++-----
 .../{actions_filebeat.conf => actions_beats.conf}      |  0
 .../templates/OPNsense/{Filebeat => Beats}/+TARGETS    |  0
 .../templates/OPNsense/{Filebeat => Beats}/filebeat    |  0
 .../OPNsense/{Filebeat => Beats}/filebeat.yml          |  0
 15 files changed, 32 insertions(+), 32 deletions(-)
 rename sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/{Filebeat => Beats}/Api/ServiceController.php (85%)
 rename sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/{Filebeat => Beats}/Api/SettingsController.php (92%)
 rename sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/{Filebeat => Beats}/IndexController.php (95%)
 rename sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/{Filebeat => Beats}/forms/filebeat.xml (100%)
 create mode 100644 sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/ACL/ACL.xml
 rename sysutils/beats/src/opnsense/mvc/app/models/OPNsense/{Beats8 => Beats}/Filebeat.php (98%)
 rename sysutils/beats/src/opnsense/mvc/app/models/OPNsense/{Beats8 => Beats}/Filebeat.xml (100%)
 create mode 100644 sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Menu/Menu.xml
 delete mode 100644 sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/ACL/ACL.xml
 delete mode 100644 sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Menu/Menu.xml
 rename sysutils/beats/src/opnsense/mvc/app/views/OPNsense/{Beats8 => Beats}/filebeat.volt (82%)
 rename sysutils/beats/src/opnsense/service/conf/actions.d/{actions_filebeat.conf => actions_beats.conf} (100%)
 rename sysutils/beats/src/opnsense/service/templates/OPNsense/{Filebeat => Beats}/+TARGETS (100%)
 rename sysutils/beats/src/opnsense/service/templates/OPNsense/{Filebeat => Beats}/filebeat (100%)
 rename sysutils/beats/src/opnsense/service/templates/OPNsense/{Filebeat => Beats}/filebeat.yml (100%)

diff --git a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/Api/ServiceController.php b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/Api/ServiceController.php
similarity index 85%
rename from sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/Api/ServiceController.php
rename to sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/Api/ServiceController.php
index 4911fb7ed..25187e3f5 100755
--- a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/Api/ServiceController.php
+++ b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/Api/ServiceController.php
@@ -26,20 +26,20 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-namespace OPNsense\Filebeat\Api;
+namespace OPNsense\Beats\Api;
 
 use OPNsense\Base\ApiMutableServiceControllerBase;
 
 /**
  * Class ServiceController
- * @package OPNsense\Filebeat
+ * @package OPNsense\Beats
  */
 class ServiceController extends ApiMutableServiceControllerBase
 {
-    protected static $internalServiceClass = '\OPNsense\Beats8\Filebeat';
-    protected static $internalServiceTemplate = 'OPNsense/Filebeat';
+    protected static $internalServiceClass = '\OPNsense\Beats\Filebeat';
+    protected static $internalServiceTemplate = 'OPNsense/Beats';
     protected static $internalServiceEnabled = 'enabled';
-    protected static $internalServiceName = 'filebeat';
+    protected static $internalServiceName = 'beats';
     protected function reconfigureForceRestart()
     {
         return 0;
diff --git a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/Api/SettingsController.php b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/Api/SettingsController.php
similarity index 92%
rename from sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/Api/SettingsController.php
rename to sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/Api/SettingsController.php
index e6851410f..e4f40c407 100755
--- a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/Api/SettingsController.php
+++ b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/Api/SettingsController.php
@@ -26,16 +26,16 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-namespace OPNsense\Filebeat\Api;
+namespace OPNsense\Beats\Api;
 
 use OPNsense\Base\ApiMutableModelControllerBase;
 
 /**
  * Class SettingsController Handles settings related API actions for the HelloWorld module
- * @package OPNsense\Filebeat
+ * @package OPNsense\Beats
  */
 class SettingsController extends ApiMutableModelControllerBase
 {
-    protected static $internalModelClass = 'OPNsense\Beats8\Filebeat';
+    protected static $internalModelClass = 'OPNsense\Beats\Filebeat';
     protected static $internalModelName = 'filebeat';
 }
diff --git a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/IndexController.php b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/IndexController.php
similarity index 95%
rename from sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/IndexController.php
rename to sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/IndexController.php
index 3125f43f6..e80879d0e 100755
--- a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/IndexController.php
+++ b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/IndexController.php
@@ -26,7 +26,7 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-namespace OPNsense\Filebeat;
+namespace OPNsense\Beats;
 
 /**
  * Class IndexController
@@ -37,7 +37,7 @@ class IndexController extends \OPNsense\Base\IndexController
     public function indexAction()
     {
         // pick the template to serve to our users.
-        $this->view->pick('OPNsense/Beats8/filebeat');
+        $this->view->pick('OPNsense/Beats/filebeat');
         // fetch form data "general" in
         $this->view->generalForm = $this->getForm("filebeat");
     }
diff --git a/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/forms/filebeat.xml b/sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/forms/filebeat.xml
similarity index 100%
rename from sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Filebeat/forms/filebeat.xml
rename to sysutils/beats/src/opnsense/mvc/app/controllers/OPNsense/Beats/forms/filebeat.xml
diff --git a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/ACL/ACL.xml b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/ACL/ACL.xml
new file mode 100644
index 000000000..84efad19e
--- /dev/null
+++ b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/ACL/ACL.xml
@@ -0,0 +1,9 @@
+<acl>
+    <page-services-beats>
+        <name>Services: Beats</name>
+        <patterns>
+            <pattern>ui/beats</pattern>
+            <pattern>api/beats/*</pattern>
+        </patterns>
+    </page-services-beats>
+</acl>
diff --git a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Filebeat.php b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Filebeat.php
similarity index 98%
rename from sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Filebeat.php
rename to sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Filebeat.php
index 137fec709..948db321c 100644
--- a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Filebeat.php
+++ b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Filebeat.php
@@ -26,7 +26,7 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-namespace OPNsense\Beats8;
+namespace OPNsense\Beats;
 
 use OPNsense\Base\BaseModel;
 use OPNsense\Base\Messages\Message;
diff --git a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Filebeat.xml b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Filebeat.xml
similarity index 100%
rename from sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Filebeat.xml
rename to sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Filebeat.xml
diff --git a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Menu/Menu.xml b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Menu/Menu.xml
new file mode 100644
index 000000000..bf659a0bf
--- /dev/null
+++ b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats/Menu/Menu.xml
@@ -0,0 +1,7 @@
+<menu>
+    <Services>
+        <Beats cssClass="fa fa-heartbeat fa-fw">
+            <Filebeat url="/ui/beats"/>
+        </Beats>
+    </Services>
+</menu>
diff --git a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/ACL/ACL.xml b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/ACL/ACL.xml
deleted file mode 100644
index b0a9bd1d7..000000000
--- a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/ACL/ACL.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-<acl>
-    <page-services-beats8>
-        <name>Services: Beats8</name>
-        <patterns>
-            <pattern>ui/filebeat/*</pattern>
-            <pattern>api/filebeat/*</pattern>
-        </patterns>
-    </page-services-beats8>
-</acl>
diff --git a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Menu/Menu.xml b/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Menu/Menu.xml
deleted file mode 100644
index 40674d06a..000000000
--- a/sysutils/beats/src/opnsense/mvc/app/models/OPNsense/Beats8/Menu/Menu.xml
+++ /dev/null
@@ -1,7 +0,0 @@
-<menu>
-    <Services>
-        <Beats8 cssClass="fa fa-heartbeat fa-fw">
-            <Filebeat url="/ui/filebeat"/>
-        </Beats8>
-    </Services>
-</menu>
diff --git a/sysutils/beats/src/opnsense/mvc/app/views/OPNsense/Beats8/filebeat.volt b/sysutils/beats/src/opnsense/mvc/app/views/OPNsense/Beats/filebeat.volt
similarity index 82%
rename from sysutils/beats/src/opnsense/mvc/app/views/OPNsense/Beats8/filebeat.volt
rename to sysutils/beats/src/opnsense/mvc/app/views/OPNsense/Beats/filebeat.volt
index 3118ff63c..b04e78091 100644
--- a/sysutils/beats/src/opnsense/mvc/app/views/OPNsense/Beats8/filebeat.volt
+++ b/sysutils/beats/src/opnsense/mvc/app/views/OPNsense/Beats/filebeat.volt
@@ -26,19 +26,19 @@
 
 <script>
     $( document ).ready(function() {
-        mapDataToFormUI({'frm_GeneralSettings':"/api/filebeat/settings/get"}).done(function(data){
-            updateServiceControlUI('filebeat');
+        mapDataToFormUI({'frm_GeneralSettings':"/api/beats/settings/get"}).done(function(data){
+            updateServiceControlUI('beats');
             $('.selectpicker').selectpicker('refresh');
         });
 
         $("#reconfigureAct").SimpleActionButton({
             onPreAction: function() {
                 const dfObj = new $.Deferred();
-                saveFormToEndpoint("/api/filebeat/settings/set", 'frm_GeneralSettings', function () { dfObj.resolve(); }, true, function () { dfObj.reject(); });
+                saveFormToEndpoint("/api/beats/settings/set", 'frm_GeneralSettings', function () { dfObj.resolve(); }, true, function () { dfObj.reject(); });
                 return dfObj;
             },
             onAction: function(data, status) {
-                updateServiceControlUI('filebeat');
+                updateServiceControlUI('beats');
             }
         });
     });
@@ -48,4 +48,4 @@
     {{ partial("layout_partials/base_form",['fields':generalForm,'id':'frm_GeneralSettings'])}}
 </div>
 
-{{ partial('layout_partials/base_apply_button', {'data_endpoint': '/api/filebeat/service/reconfigure'}) }}
+{{ partial('layout_partials/base_apply_button', {'data_endpoint': '/api/beats/service/reconfigure'}) }}
diff --git a/sysutils/beats/src/opnsense/service/conf/actions.d/actions_filebeat.conf b/sysutils/beats/src/opnsense/service/conf/actions.d/actions_beats.conf
similarity index 100%
rename from sysutils/beats/src/opnsense/service/conf/actions.d/actions_filebeat.conf
rename to sysutils/beats/src/opnsense/service/conf/actions.d/actions_beats.conf
diff --git a/sysutils/beats/src/opnsense/service/templates/OPNsense/Filebeat/+TARGETS b/sysutils/beats/src/opnsense/service/templates/OPNsense/Beats/+TARGETS
similarity index 100%
rename from sysutils/beats/src/opnsense/service/templates/OPNsense/Filebeat/+TARGETS
rename to sysutils/beats/src/opnsense/service/templates/OPNsense/Beats/+TARGETS
diff --git a/sysutils/beats/src/opnsense/service/templates/OPNsense/Filebeat/filebeat b/sysutils/beats/src/opnsense/service/templates/OPNsense/Beats/filebeat
similarity index 100%
rename from sysutils/beats/src/opnsense/service/templates/OPNsense/Filebeat/filebeat
rename to sysutils/beats/src/opnsense/service/templates/OPNsense/Beats/filebeat
diff --git a/sysutils/beats/src/opnsense/service/templates/OPNsense/Filebeat/filebeat.yml b/sysutils/beats/src/opnsense/service/templates/OPNsense/Beats/filebeat.yml
similarity index 100%
rename from sysutils/beats/src/opnsense/service/templates/OPNsense/Filebeat/filebeat.yml
rename to sysutils/beats/src/opnsense/service/templates/OPNsense/Beats/filebeat.yml