From 34c308681efd522933c7fe33d8f5997165aeca43 Mon Sep 17 00:00:00 2001
From: John Wass <wassj@ctc.com>
Date: Tue, 16 Jan 2024 11:08:18 -0500
Subject: [PATCH] Add lang for config (#991)

Adds a sourceview lang for fapolicyd config syntax.

Closes #939
---
 .../language-specs/fapolicyd-config.lang      | 63 +++++++++++++++++++
 .../resources/sourceview/styles/fapolicyd.xml |  4 ++
 .../ui/config/config_text_view.py             |  2 +-
 fapolicy_analyzer/ui/editable_text_view.py    |  8 +--
 fapolicy_analyzer/ui/rules/rules_text_view.py |  2 +-
 news/991.added.md                             |  1 +
 6 files changed, 73 insertions(+), 7 deletions(-)
 create mode 100644 fapolicy_analyzer/resources/sourceview/language-specs/fapolicyd-config.lang
 create mode 100644 news/991.added.md

diff --git a/fapolicy_analyzer/resources/sourceview/language-specs/fapolicyd-config.lang b/fapolicy_analyzer/resources/sourceview/language-specs/fapolicyd-config.lang
new file mode 100644
index 000000000..6af545c0e
--- /dev/null
+++ b/fapolicy_analyzer/resources/sourceview/language-specs/fapolicyd-config.lang
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright Concurrent Technologies Corporation 2024
+
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<language id="fapolicyd-config" name="File Access Policy Daemon Config" version="2.0" _section="Other">
+    <metadata>
+        <property name="globs">*.config</property>
+        <property name="line-comment-start">#</property>
+    </metadata>
+
+    <styles>
+        <style id="config-eq-sign" name="Separator"/>
+        <style id="config-key" name="Config key name"/>
+    </styles>
+
+    <definitions>
+        <context id="config-eq-sign" style-ref="config-eq-sign">
+            <match>=</match>
+        </context>
+
+        <context id="config-key" style-ref="config-key">
+            <suffix> =</suffix>
+            <keyword>permissive</keyword>
+            <keyword>nice_val</keyword>
+            <keyword>q_size</keyword>
+            <keyword>uid</keyword>
+            <keyword>gid</keyword>
+            <keyword>do_stat_report</keyword>
+            <keyword>detailed_report</keyword>
+            <keyword>db_max_size</keyword>
+            <keyword>subj_cache_size</keyword>
+            <keyword>obj_cache_size</keyword>
+            <keyword>watch_fs</keyword>
+            <keyword>trust</keyword>
+            <keyword>integrity</keyword>
+            <keyword>syslog_format</keyword>
+            <keyword>rpm_sha256_only</keyword>
+            <keyword>allow_filesystem_mark</keyword>
+        </context>
+
+        <context id="fapolicyd-config">
+            <include>
+                <context ref="config-eq-sign"/>
+                <context ref="config-key"/>
+                <context ref="def:shell-like-comment"/>
+            </include>
+        </context>
+    </definitions>
+</language>
diff --git a/fapolicy_analyzer/resources/sourceview/styles/fapolicyd.xml b/fapolicy_analyzer/resources/sourceview/styles/fapolicyd.xml
index 5123f871e..526910363 100644
--- a/fapolicy_analyzer/resources/sourceview/styles/fapolicyd.xml
+++ b/fapolicy_analyzer/resources/sourceview/styles/fapolicyd.xml
@@ -71,4 +71,8 @@
     <!-- File markers -->
     <style name="fapolicyd-rules:marker" foreground="#AAAA00" bold="true" italic="true"/>
 
+    <!-- Config keys -->
+    <style name="fapolicyd-config:config-key" foreground="black" underline="true"/>
+    <style name="fapolicyd-config:config-eq-sign" bold="true"/>
+
 </style-scheme>
diff --git a/fapolicy_analyzer/ui/config/config_text_view.py b/fapolicy_analyzer/ui/config/config_text_view.py
index 09a8a3c57..998297cc6 100644
--- a/fapolicy_analyzer/ui/config/config_text_view.py
+++ b/fapolicy_analyzer/ui/config/config_text_view.py
@@ -28,4 +28,4 @@ def on_config_changed(self, buffer):
         self.config_changed(self._get_text())
 
     def _get_view_lang_id(self) -> Optional[str]:
-        return None
+        return "fapolicyd-config"
diff --git a/fapolicy_analyzer/ui/editable_text_view.py b/fapolicy_analyzer/ui/editable_text_view.py
index 10dd70a4e..d8c3b2a65 100644
--- a/fapolicy_analyzer/ui/editable_text_view.py
+++ b/fapolicy_analyzer/ui/editable_text_view.py
@@ -60,7 +60,7 @@ def _get_view_lang(self):
             try:
                 with resources.path(
                     "fapolicy_analyzer.resources.sourceview.language-specs",
-                    lang_id,
+                    f"{lang_id}.lang",
                 ) as path:
                     if (
                         os.path.dirname(path.as_posix())
@@ -74,11 +74,9 @@ def _get_view_lang(self):
                         )
             except Exception as ex:
                 logging.warning("Could not load the rules language file")
-                logging.debug(
-                    "Error loading GtkSource language file fapolicyd-rules.lang", ex
-                )
+                logging.debug(f"Error loading GtkSource language: {lang_id}", ex)
 
-            return lang_manager.get_language("fapolicyd-rules")
+            return lang_manager.get_language(lang_id)
 
     def _get_view_style(self):
         style_manager = GtkSource.StyleSchemeManager.get_default()
diff --git a/fapolicy_analyzer/ui/rules/rules_text_view.py b/fapolicy_analyzer/ui/rules/rules_text_view.py
index 869f4308a..2c459b9e0 100644
--- a/fapolicy_analyzer/ui/rules/rules_text_view.py
+++ b/fapolicy_analyzer/ui/rules/rules_text_view.py
@@ -28,4 +28,4 @@ def on_rules_changed(self, buffer):
         self.rules_changed(self._get_text())
 
     def _get_view_lang_id(self) -> Optional[str]:
-        return "fapolicyd-rules.lang"
+        return "fapolicyd-rules"
diff --git a/news/991.added.md b/news/991.added.md
new file mode 100644
index 000000000..c0f2b0636
--- /dev/null
+++ b/news/991.added.md
@@ -0,0 +1 @@
+Added syntax highlighting to the fapolicyd config editor