From cff4c085d3e5d6236915c60d1dfb21e1796b3af8 Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Fri, 30 Jan 2026 08:57:45 +0100
Subject: [PATCH] make: add a linter for PHP class name consistency #9638

---
 Mk/lint.mk                |  5 +++-
 Scripts/class-filename.sh | 52 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+), 1 deletion(-)
 create mode 100755 Scripts/class-filename.sh

diff --git a/Mk/lint.mk b/Mk/lint.mk
index 970e01cfdb..0c579b1670 100644
--- a/Mk/lint.mk
+++ b/Mk/lint.mk
@@ -108,6 +108,9 @@ lint-model:
 lint-acl:
 	@${COREREFDIR}/Scripts/dashboard-acl.sh ${COREREFDIR}
 
+lint-class:
+	@${COREREFDIR}/Scripts/class-filename.sh ${COREREFDIR}
+
 SCRIPTDIRS!=	if [ -d ${.CURDIR}/src/opnsense/scripts ]; then find ${.CURDIR}/src/opnsense/scripts -type d -depth 1; fi
 
 lint-exec:
@@ -151,4 +154,4 @@ lint-plist:
 	@rm ${WRKDIR}/plist.*
 .endif
 
-lint: lint-plist lint-desc lint-shell lint-xml lint-model lint-acl lint-exec lint-php
+lint: lint-plist lint-desc lint-shell lint-xml lint-model lint-acl lint-class lint-exec lint-php
diff --git a/Scripts/class-filename.sh b/Scripts/class-filename.sh
new file mode 100755
index 0000000000..3adc9e545e
--- /dev/null
+++ b/Scripts/class-filename.sh
@@ -0,0 +1,52 @@
+#!/bin/sh
+
+# Copyright (c) 2026 Franco Fichtner <franco@opnsense.org>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+
+RET=0
+
+for FILE in $(find src -name "*.php"); do
+	CLASS=$(grep ^class ${FILE} | awk '{ print $2 }')
+	if [ -z "${CLASS}" ]; then
+		continue
+	fi
+	MULTI=
+	OK=
+	for _CLASS in ${CLASS}; do
+		if [ "$(basename ${FILE})" == "${_CLASS}.php" ]; then
+			OK=${_CLASS}
+		else
+			MULTI="${_CLASS} ${MULTI}"
+		fi
+	done
+	if [ -z "${OK}" ]; then
+		echo "${FILE}: error: does not match class name" ${CLASS}
+		RET=1
+	elif [ -n "${MULTI}" ]; then
+		echo "${FILE}: warning: has additional classes" ${MULTI}
+	fi
+done
+
+exit ${RET}