wizard: reimplement system setup #8378

AdSchellevis · 2025-02-26T16:15:37Z

This commit implements our replacement for the setup wizard. The questions are roughly the same as in the legacy version. Some less relevant options have been removed (pppoe ondemand for example) and isc-dhcpd has been replaced with dnsmasq.

Only standard tools have been used, a memory model to validate the data and simple input forms in tabs.

The in memory model acts as a wrapper around a legacy configuration data and a couple of component models to apply the requested settings.

Some legacy settings using isset() have been altered to use their empty() equivalent.

fichtner · 2025-02-26T16:33:37Z

src/etc/config.xml.sample

+  <dnsmasq>
+      <enable>1</enable>
+      <port>0</port>
+      <interface>lan</interface>


if people don't assign a "lan" interface in console assignment this can be a problem. we also need to make sure migrations do the normalize dance then on this field and the one in dhcp_ranges ;(

@fichtner but isn't this the same for isc at the moment?

core/src/etc/config.xml.sample

Lines 96 to 104 in 3e299b2

<dhcpd>

<lan>

<enable/>

<range>

<from>192.168.1.100</from>

<to>192.168.1.199</to>

</range>

</lan>

</dhcpd>

In practice this likely means we need to replace the dhcpd sections in console.inc, which I haven't looked at yet (but should do indeed)

dhcp is disabled when lan is not used, yes, this ties back to the console.inc madness

as far as isc doing it, also yes, but it's not an mvc migration-breaks-on-validation case

the console part should be handled implemented via 70b1672 now.

fichtner · 2025-02-26T16:34:14Z

src/etc/inc/system.inc

@@ -328,7 +328,7 @@ function get_searchdomains()
        $master_list[] = $syscfg['dnssearchdomain'];
    }

-    if (isset($syscfg['dnsallowoverride'])) {
+    if (!empty($syscfg['dnsallowoverride'])) {


we did have issues with one of these before

@fichtner not sure what it was, but for simplicity, I prefer the empty() variants, so if it doesn't work as it should, we might have to figure out why that is.

this was #2751 and looks like it was fixed in the way we want, but then we should move all spots to !empty, not just this one

@fichtner let's change the rest of them as well indeed, 588566f should do the trick.

fichtner · 2025-02-26T16:36:03Z

src/opnsense/mvc/app/models/OPNsense/Core/ACL/ACL.xml

@@ -365,7 +365,8 @@
    <page-wizard-system>
        <name>System Setup Wizard</name>


Menu says System: Wizard, I wonder if can bury it in System: Settings

I don't have a strong preference, can change the acl description or the menu item.

system: settings or system: configuration, decide after merge

fichtner · 2025-03-03T13:36:15Z

src/etc/inc/xmlparse.inc

@@ -51,6 +51,7 @@ function listtags()
      'user',
      'vip', 'virtual_server', 'vlan',
      'winsserver', 'wolentry', 'widget',
+      'dhcp_ranges'


would be nice to add this sorted

fichtner · 2025-03-03T13:45:16Z

src/www/system_general.php

@@ -200,7 +200,6 @@
            $config['system']['dnsallowoverride'] = true;
            $config['system']['dnsallowoverride_exclude'] = implode(',', $pconfig['dnsallowoverride_exclude']);
        } elseif (isset($config['system']['dnsallowoverride'])) {


Suggested change

} elseif (isset($config['system']['dnsallowoverride'])) {

} else {

fichtner · 2025-03-03T13:46:09Z

src/opnsense/service/conf/actions.d/actions_system.conf

+
+

Suggested change

fichtner · 2025-03-03T14:03:55Z

src/www/services_opendns.php

@@ -89,7 +89,7 @@
                $config['system']['dnsserver'][] = $v4_server[0];
                $config['system']['dnsserver'][] = $v4_server[1];
            }
-            if (isset($config['system']['dnsallowoverride'])) {
+            if (!empty($config['system']['dnsallowoverride'])) {
                unset($config['system']['dnsallowoverride']);


to avoid flip flop

Suggested change

unset($config['system']['dnsallowoverride']);

$config['system']['dnsallowoverride'] = false;

fichtner

minor comments

This commit implements our replacement for the setup wizard. The questions are roughly the same as in the legacy version. Some less relevant options have been removed (pppoe ondemand for example) and isc-dhcpd has been replaced with dnsmasq. Only standard tools have been used, a memory model to validate the data and simple input forms in tabs. The in memory model acts as a wrapper around a legacy configuration data and a couple of component models to apply the requested settings. Some legacy settings using isset() have been altered to use their empty() equivalent.

… the console setup configures the same (#8352) Fix some small php arnings in the process, but further than that just rewrite the dhcpd console handling to use dnsmasq instead of isc. Eventually we will need to rewrite the console tools as well, but let's try to keep this compatible with minimal impact.

…) for #8352

AdSchellevis · 2025-03-03T14:26:10Z

@fichtner fixed in c1ef2a5 , merging now

AdSchellevis added the feature Adding new functionality label Feb 26, 2025

AdSchellevis self-assigned this Feb 26, 2025

fichtner reviewed Feb 26, 2025

View reviewed changes

AdSchellevis force-pushed the FR8352_wizard branch from 70b1672 to a56e108 Compare March 2, 2025 17:38

fichtner reviewed Mar 3, 2025

View reviewed changes

src/opnsense/service/conf/actions.d/actions_system.conf Outdated

Comment on lines 156 to 157

Copy link

Member

fichtner Mar 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

fichtner reviewed Mar 3, 2025

View reviewed changes

fichtner approved these changes Mar 3, 2025

View reviewed changes

AdSchellevis added 4 commits March 3, 2025 15:25

wizard: change other occurrences of isset($config['dnsallowoverride']…

ef94ea7

…) for #8352

wizard: sort listtags() and some other minor review comments for #8352

c1ef2a5

AdSchellevis force-pushed the FR8352_wizard branch from 588566f to c1ef2a5 Compare March 3, 2025 14:25

AdSchellevis merged commit 592a62b into master Mar 3, 2025

AdSchellevis deleted the FR8352_wizard branch March 3, 2025 14:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wizard: reimplement system setup #8378

wizard: reimplement system setup #8378

AdSchellevis commented Feb 26, 2025

fichtner Feb 26, 2025

AdSchellevis Feb 26, 2025

fichtner Feb 27, 2025

AdSchellevis Mar 2, 2025

fichtner Feb 26, 2025

AdSchellevis Feb 26, 2025

fichtner Feb 27, 2025

AdSchellevis Mar 2, 2025

fichtner Feb 26, 2025

AdSchellevis Feb 26, 2025

fichtner Mar 3, 2025

fichtner Mar 3, 2025

fichtner Mar 3, 2025

fichtner Mar 3, 2025

fichtner Mar 3, 2025

fichtner left a comment

AdSchellevis commented Mar 3, 2025

	<dhcpd>
	<lan>
	<enable/>
	<range>
	<from>192.168.1.100</from>
	<to>192.168.1.199</to>
	</range>
	</lan>
	</dhcpd>

		@@ -365,7 +365,8 @@
		<page-wizard-system>
		<name>System Setup Wizard</name>

	} elseif (isset($config['system']['dnsallowoverride'])) {
	} else {

	unset($config['system']['dnsallowoverride']);
	$config['system']['dnsallowoverride'] = false;

wizard: reimplement system setup #8378

wizard: reimplement system setup #8378

Conversation

AdSchellevis commented Feb 26, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fichtner left a comment

Choose a reason for hiding this comment

AdSchellevis commented Mar 3, 2025