From 85319e25019ac2ad28fd2d42687f1adb7452eb83 Mon Sep 17 00:00:00 2001
From: Franco Fichtner <franco@opnsense.org>
Date: Wed, 5 Mar 2025 14:12:24 +0100
Subject: [PATCH] system: migrate 'default' tunable value to empty one #7440

After a bit of back and forth and issues reported with
bootstrapping it's better to get rid of the old keyword
which unifies the default selection under the empty value.
---
 src/etc/inc/system.inc                        |  1 +
 .../OPNsense/Core/FieldTypes/TunableField.php | 47 +++++++++----------
 .../mvc/app/models/OPNsense/Core/Tunables.xml |  2 +-
 3 files changed, 25 insertions(+), 25 deletions(-)

diff --git a/src/etc/inc/system.inc b/src/etc/inc/system.inc
index df5a80175..f2ed7166e 100644
--- a/src/etc/inc/system.inc
+++ b/src/etc/inc/system.inc
@@ -152,6 +152,7 @@ function system_sysctl_get()
     }
 
     foreach ($sysctls as $key => &$value) {
+        /* keeping the now depcreated 'default' as a keyword for selecting defaults */
         if ($value != 'default' && $value != '') {
             continue;
         }
diff --git a/src/opnsense/mvc/app/models/OPNsense/Core/FieldTypes/TunableField.php b/src/opnsense/mvc/app/models/OPNsense/Core/FieldTypes/TunableField.php
index d6ad361b7..739b08aa9 100644
--- a/src/opnsense/mvc/app/models/OPNsense/Core/FieldTypes/TunableField.php
+++ b/src/opnsense/mvc/app/models/OPNsense/Core/FieldTypes/TunableField.php
@@ -1,31 +1,29 @@
 <?php
 
-/**
- *    Copyright (C) 2025 Deciso B.V.
+/*
+ * Copyright (C) 2025 Deciso B.V.
+ * All rights reserved.
  *
- *    All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
  *
- *    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.
  *
- *    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.
+ * 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\Core\FieldTypes;
@@ -84,8 +82,9 @@ class TunableField extends ArrayField
         foreach ($this->iterateItems() as $node) {
             if (isset(self::$static_entries[(string)$node->tunable])) {
                 unset(self::$static_entries[(string)$node->tunable]);
-            } elseif ($node->value == 'default') {
-                /* default is only a valid choice when defaults are offered */
+            }
+            /* deprecate 'default', the model uses empty value to signal this */
+            if ($node->value == 'default') {
                 $node->value = '';
             }
             if (isset(self::$default_values[(string)$node->tunable])) {
diff --git a/src/opnsense/mvc/app/models/OPNsense/Core/Tunables.xml b/src/opnsense/mvc/app/models/OPNsense/Core/Tunables.xml
index 2dcc47725..ea86060fa 100644
--- a/src/opnsense/mvc/app/models/OPNsense/Core/Tunables.xml
+++ b/src/opnsense/mvc/app/models/OPNsense/Core/Tunables.xml
@@ -1,7 +1,7 @@
 <model>
     <mount>//sysctl</mount>
     <migration_prefix>TUN</migration_prefix>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
     <description>System Tunables</description>
     <items>
         <item type=".\TunableField">