From d7adee30a16733838e98b14ceb4aeb175365d91b Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Tue, 18 Feb 2025 14:28:41 +0100
Subject: [PATCH] dnsmasq: call normalizeValue() during interface migration

---
 plist                                         |  1 +
 .../Base/FieldTypes/BaseListField.php         |  8 +++-
 .../OPNsense/Dnsmasq/Migrations/M1_0_0.php    | 45 +++++++++++++++++++
 3 files changed, 53 insertions(+), 1 deletion(-)
 create mode 100644 src/opnsense/mvc/app/models/OPNsense/Dnsmasq/Migrations/M1_0_0.php

diff --git a/plist b/plist
index 7b0c023af..e45d98f51 100644
--- a/plist
+++ b/plist
@@ -725,6 +725,7 @@
 /usr/local/opnsense/mvc/app/models/OPNsense/Dnsmasq/FieldTypes/AliasesField.php
 /usr/local/opnsense/mvc/app/models/OPNsense/Dnsmasq/FieldTypes/DomainIPField.php
 /usr/local/opnsense/mvc/app/models/OPNsense/Dnsmasq/Menu/Menu.xml
+/usr/local/opnsense/mvc/app/models/OPNsense/Dnsmasq/Migrations/M1_0_0.php
 /usr/local/opnsense/mvc/app/models/OPNsense/Firewall/ACL/ACL.xml
 /usr/local/opnsense/mvc/app/models/OPNsense/Firewall/Alias.php
 /usr/local/opnsense/mvc/app/models/OPNsense/Firewall/Alias.xml
diff --git a/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/BaseListField.php b/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/BaseListField.php
index 8cfe4e9a3..95fd1e513 100644
--- a/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/BaseListField.php
+++ b/src/opnsense/mvc/app/models/OPNsense/Base/FieldTypes/BaseListField.php
@@ -173,7 +173,13 @@ abstract class BaseListField extends BaseField
     {
         $values = [];
 
-        foreach ($this->getNodeData() as $key => $node) {
+        $data = $this->getNodeData();
+        if (!is_array($data)) {
+            /* XXX e.g. PortField returning a string; do not normalize */
+            return;
+        }
+
+        foreach ($data as $key => $node) {
             if ($node['selected']) {
                 $values[] = $key;
             }
diff --git a/src/opnsense/mvc/app/models/OPNsense/Dnsmasq/Migrations/M1_0_0.php b/src/opnsense/mvc/app/models/OPNsense/Dnsmasq/Migrations/M1_0_0.php
new file mode 100644
index 000000000..f27fb943c
--- /dev/null
+++ b/src/opnsense/mvc/app/models/OPNsense/Dnsmasq/Migrations/M1_0_0.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * Copyright (C) 2025 Deciso B.V.
+ * All rights reserved.
+ *
+ * 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 ``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 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.
+ */
+
+namespace OPNsense\Dnsmasq\Migrations;
+
+use OPNsense\Base\BaseModelMigration;
+
+class M1_0_0 extends BaseModelMigration
+{
+    /**
+     * Migrate older models into shared model
+     * @param $model
+     */
+    public function run($model)
+    {
+        /* make sure stale interfaces do not cause a validation issue */
+        $model->interface->normalizeValue();
+        parent::run($model);
+    }
+}