System: Settings: Tunables - refactor to MVC, closes https://github.com/opnsense/core/issues/7249

This commit is contained in:
Ad Schellevis 2025-01-04 12:40:28 +01:00
parent b694c81be2
commit 071925da51
9 changed files with 97 additions and 369 deletions

1
plist
View File

@ -2422,7 +2422,6 @@
/usr/local/www/system_advanced_firewall.php
/usr/local/www/system_advanced_misc.php
/usr/local/www/system_advanced_network.php
/usr/local/www/system_advanced_sysctl.php
/usr/local/www/system_authservers.php
/usr/local/www/system_gateway_groups.php
/usr/local/www/system_gateway_groups_edit.php

View File

@ -29,6 +29,7 @@ namespace OPNsense\Core\Api;
use OPNsense\Base\ApiMutableModelControllerBase;
use OPNsense\Core\Backend;
use OPNsense\Core\Config;
use OPNsense\Base\UserException;
class TunablesController extends ApiMutableModelControllerBase
@ -36,29 +37,69 @@ class TunablesController extends ApiMutableModelControllerBase
protected static $internalModelName = 'sysctl';
protected static $internalModelClass = 'OPNsense\Core\Tunables';
public function searchAction()
public function searchItemAction()
{
return $this->searchBase("item", null, "sysctl");
}
public function setSubnetAction($uuid)
public function setItemAction($uuid)
{
if ($this->request->isPost() && count(explode('-', $uuid)) != 5) {
/* generate new uuid when key is a tunable name (from system_sysctl_defaults) */
Config::getInstance()->lock();
$uuid = $this->getModel()->item->generateUUID();
}
return $this->setBase("sysctl", "item", $uuid);
}
public function addSubnetAction()
public function addItemAction()
{
return $this->addBase("sysctl", "item");
}
public function getSubnetAction($uuid = null)
public function getItemAction($uuid = null)
{
return $this->getBase("sysctl", "item", $uuid);
}
public function delSubnetAction($uuid)
public function delItemAction($uuid)
{
return $this->delBase("item", $uuid);
}
public function resetAction()
{
if ($this->request->isPost()) {
if (file_exists('/usr/local/etc/config.xml')) {
Config::getInstance()->lock();
$factory_config = Config::getInstance()->toArrayFromFile('/usr/local/etc/config.xml', []);
$mdl = $this->getModel()->Default();
if (!empty($factory_config['sysctl']) && !empty($factory_config['sysctl']['item'])){
foreach ($factory_config['sysctl']['item'] as $item) {
$node = $mdl->item->Add();
foreach ($item as $key => $val) {
$node->$key = (string)$val;
}
}
}
$this->save();
return ['status' => 'ok'];
} else {
return ['status' => 'no_default'];
}
}
return ['status' => 'failed'];
}
public function reconfigureAction()
{
if ($this->request->isPost()) {
/* both sysctl and login use tunables, restart them both */
$tmp1 = strtolower(trim((new Backend())->configdpRun('service restart', ['login'])));
$tmp2 = strtolower(trim((new Backend())->configdpRun('service restart', ['sysctl'])));
return ['status' => $tmp1 == 'ok' && $tmp2 == 'ok' ? 'ok' : 'failed'];
}
return ['status' => 'failed'];
}
}

View File

@ -34,6 +34,5 @@ class TunablesController extends \OPNsense\Base\IndexController
{
$this->view->pick('OPNsense/Core/tunables');
$this->view->formDialogTunable = $this->getForm('tunable');
}
}

View File

@ -1,16 +1,16 @@
<form>
<field>
<id>item.tunable</id>
<id>sysctl.tunable</id>
<label>Tunable</label>
<type>text</type>
</field>
<field>
<id>item.value</id>
<id>sysctl.value</id>
<label>Value</label>
<type>text</type>
</field>
<field>
<id>item.descr</id>
<id>sysctl.descr</id>
<label>Description</label>
<type>text</type>
</field>

View File

@ -528,7 +528,8 @@
<page-system-advanced-sysctl>
<name>System: Advanced: Tunables</name>
<patterns>
<pattern>system_advanced_sysctl.php*</pattern>
<pattern>ui/core/tunables</pattern>
<pattern>api/core/tunables/*</pattern>
</patterns>
</page-system-advanced-sysctl>
<page-system-authservers>

View File

@ -1,7 +1,7 @@
<?php
/**
* Copyright (C) 2020 Deciso B.V.
* Copyright (C) 2025 Deciso B.V.
*
* All rights reserved.
*
@ -50,7 +50,8 @@ class TunableField extends ArrayField
{
$result = [];
foreach (self::$static_entries as $key => $item){
$result[] = [
/* md5($key) ensures static keys identifiable as static options */
$result[md5($key)] = [
'tunable' => $key,
'value' => $item['value'] ?? '',
'default_value' => $item['default'],
@ -62,6 +63,9 @@ class TunableField extends ArrayField
return $result;
}
/**
* {@inheritdoc}
*/
protected function actionPostLoadingEvent()
{
if (self::$default_values === null) {
@ -78,6 +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 */
$node->value = '';
}
if (isset(self::$default_values[(string)$node->tunable])) {
$node->default_value->setValue(self::$default_values[(string)$node->tunable]['value']);

View File

@ -63,9 +63,7 @@
<Edit url="/system_general.php*" visibility="hidden"/>
</General>
<Miscellaneous url="/system_advanced_misc.php"/>
<Tunables url="/system_advanced_sysctl.php">
<Edit url="/system_advanced_sysctl.php*" visibility="hidden"/>
</Tunables>
<Tunables url="/ui/core/tunables"/>
</Settings>
<Snapshots cssClass="fa fa-hdd-o fa-fw" url="/ui/core/snapshots"/>
<Trust cssClass="fa fa-certificate fa-fw">

View File

@ -27,11 +27,11 @@
<script>
$( document ).ready(function() {
$("#grid").UIBootgrid(
{ search:'/api/core/tunables/search/',
get:'/api/core/tunables/get/',
set:'/api/core/tunables/set/',
add:'/api/core/tunables/add/',
del:'/api/core/tunables/del/',
{ search:'/api/core/tunables/search_item/',
get:'/api/core/tunables/get_item/',
set:'/api/core/tunables/set_item/',
add:'/api/core/tunables/add_item/',
del:'/api/core/tunables/del_item/',
options: {
formatters: {
"tunable_type": function (column, row) {
@ -53,6 +53,32 @@
}
}
);
$("#reset_defaults").click(function(event){
event.preventDefault();
BootstrapDialog.show({
type:BootstrapDialog.TYPE_DANGER,
title: "{{ lang._('Tunable') }}",
message: "{{ lang._('Are you sure you want to reset all tunables back to factory defaults?')}}",
buttons: [
{
label: "{{ lang._('No') }}",
action: function(dialogRef) {
dialogRef.close();
}
},
{
label: "{{ lang._('Yes') }}",
action: function(dialogRef) {
ajaxCall('/api/core/tunables/reset', {}, function(){
dialogRef.close();
$('#grid').bootgrid('reload');
});
}
}
]
});
});
$("#reconfigureAct").SimpleActionButton();
});
</script>
@ -73,7 +99,11 @@
</tbody>
<tfoot>
<tr>
<td></td>
<td>
<button id="reset_defaults" class="btn btn-danger btn-xs" data-toggle="tooltip" title="{{ lang._('Default') }}">
<i class="fa fa-trash-o fa-fw"></i>
</button>
</td>
<td>
<button data-action="add" type="button" class="btn btn-xs btn-primary"><span class="fa fa-fw fa-plus"></span></button>
<button data-action="deleteSelected" type="button" class="btn btn-xs btn-default"><span class="fa fa-fw fa-trash-o"></span></button>

View File

@ -1,347 +0,0 @@
<?php
/*
* Copyright (C) 2014-2022 Deciso B.V.
* Copyright (C) 2005-2007 Scott Ullrich <sullrich@gmail.com>
* Copyright (C) 2008 Shrew Soft Inc. <mgrooms@shrew.net>
* Copyright (C) 2003-2004 Manuel Kasper <mk@neon1.net>
* 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.
*/
require_once("guiconfig.inc");
require_once("system.inc");
$a_defaults = system_sysctl_defaults();
$a_system = []; /* to be filled from defaults */
$a_tunable = &config_read_array('sysctl', 'item');
$a_sysctl = json_decode(configd_run('system sysctl gather'), true);
if ($_SERVER['REQUEST_METHOD'] === 'GET') {
if (isset($_GET['id']) && isset($a_tunable[$_GET['id']])) {
$id = $_GET['id'];
}
if (isset($_GET['act'])) {
$act = $_GET['act'];
} else {
$act = null;
}
$pconfig = [];
if (isset($id)) {
$pconfig['tunable'] = $a_tunable[$id]['tunable'];
$pconfig['value'] = $a_tunable[$id]['value'];
$pconfig['descr'] = $a_tunable[$id]['descr'];
} else {
$pconfig['tunable'] = isset($_GET['tunable']) ? $_GET['tunable'] : null;
$pconfig['value'] = null;
$pconfig['descr'] = null;
}
} elseif ($_SERVER['REQUEST_METHOD'] === 'POST') {
if (isset($_POST['id']) && isset($a_tunable[$_POST['id']])) {
$id = $_POST['id'];
}
if (isset($_POST['act'])) {
$act = $_POST['act'];
} else {
$act = null;
}
$pconfig = $_POST;
if (isset($id) && $act == "del") {
unset($a_tunable[$id]);
write_config();
mark_subsystem_dirty('sysctl');
header(url_safe('Location: /system_advanced_sysctl.php'));
exit;
} else if ($act == 'reset') {
// reset tunables to factory defaults (when available)
if (file_exists('/usr/local/etc/config.xml')) {
$factory_config = load_config_from_file('/usr/local/etc/config.xml');
if (!empty($factory_config['sysctl']) && !empty($factory_config['sysctl']['item'])){
$a_tunable = $factory_config['sysctl']['item'];
mark_subsystem_dirty('sysctl');
write_config();
}
}
header(url_safe('Location: /system_advanced_sysctl.php'));
exit;
} else if (!empty($pconfig['apply'])) {
system_sysctl_configure();
system_login_configure();
clear_subsystem_dirty('sysctl');
header(url_safe('Location: /system_advanced_sysctl.php'));
exit;
} elseif (!empty($pconfig['Submit'])) {
$tunableent = [];
$tunableent['tunable'] = $pconfig['tunable'];
$tunableent['value'] = $pconfig['value'];
$tunableent['descr'] = $pconfig['descr'];
if (isset($id)) {
$a_tunable[$id] = $tunableent;
} else {
$a_tunable[] = $tunableent;
}
mark_subsystem_dirty('sysctl');
write_config();
header(url_safe('Location: /system_advanced_sysctl.php'));
exit;
}
}
foreach ($a_defaults as $name => $info) {
if (!empty($info['required'])) {
$a_system[] = $name;
}
}
foreach ($a_tunable as $key => &$tunable) {
/* translate hidden strings before HTML escape */
if (!empty($tunable['descr'])) {
$tunable['descr'] = gettext($tunable['descr']);
} elseif (!empty($a_sysctl[$tunable['tunable']]['description'])) {
$tunable['descr'] = $a_sysctl[$tunable['tunable']]['description'];
}
if (!empty($a_defaults[$tunable['tunable']]['type'])) {
$tunable['type'] = $a_defaults[$tunable['tunable']]['type'];
} elseif (!empty($a_sysctl[$tunable['tunable']]['type'])) {
$tunable['type'] = $a_sysctl[$tunable['tunable']]['type'];
}
/* add the key for config-bound tunables */
$tunable['key'] = $key;
/* remove system defaults in config items */
$pos = array_search($tunable['tunable'], $a_system);
if ($pos !== false) {
unset($a_system[$pos]);
}
}
foreach ($a_system as $default) {
/* display system defaults as well */
$next = [ 'tunable' => $default, 'value' => 'default', 'descr' => $a_sysctl[$default]['description'] ?? '' ];
if (!empty($a_defaults[$default]['type'])) {
$next['type'] = $a_defaults[$default]['type'];
} elseif (!empty($a_sysctl[$default]['type'])) {
$next['type'] = $a_sysctl[$default]['type'];
}
if (!empty($a_defaults[$default]['description'])) {
$next['descr'] = $a_defaults[$default]['description'];
}
$a_tunable[] = $next;
}
uasort($a_tunable, function($a, $b) {
return strnatcmp($a['tunable'], $b['tunable']);
});
include("head.inc");
legacy_html_escape_form_data($a_tunable);
legacy_html_escape_form_data($pconfig);
?>
<body>
<script>
$( document ).ready(function() {
// delete entry
$(".act_delete").click(function(event){
event.preventDefault();
var id = $(this).data('id');
BootstrapDialog.show({
type:BootstrapDialog.TYPE_DANGER,
title: "<?= gettext("Tunable");?>",
message: "<?=gettext("Do you really want to delete this entry?");?>",
buttons: [{
label: "<?=gettext("No");?>",
action: function(dialogRef) {
dialogRef.close();
}}, {
label: "<?=gettext("Yes");?>",
action: function(dialogRef) {
$("#id").val(id);
$("#action").val("del");
$("#iform").submit()
}
}]
});
});
if ($("a[href='#set_defaults']").length > 0) {
$("a[href='#set_defaults']").click(function(event){
event.preventDefault();
BootstrapDialog.show({
type:BootstrapDialog.TYPE_DANGER,
title: "<?= gettext("Tunable");?>",
message: "<?=gettext("Are you sure you want to reset all tunables back to factory defaults?");?>",
buttons: [{
label: "<?=gettext("No");?>",
action: function(dialogRef) {
dialogRef.close();
}}, {
label: "<?=gettext("Yes");?>",
action: function(dialogRef) {
$("#action").val("reset");
$("#iform").submit()
}
}]
});
});
}
});
</script>
<?php include("fbegin.inc"); ?>
<!-- row -->
<section class="page-content-main">
<div class="container-fluid">
<div class="row">
<?php
if (isset($savemsg)) {
print_info_box($savemsg);
}
if (is_subsystem_dirty('sysctl') && ($act != "edit" )) {
print_info_box_apply(gettext('The firewall tunables have changed. You must apply the configuration to take affect.'). '<br>' .gettext('Tunables are composed of runtime settings for sysctl.conf which take effect ' .
'immediately after apply and boot settings for loader.conf which require a reboot.'));
}
?>
<form method="post" id="iform">
<input type="hidden" id="id" name="id" value="" />
<input type="hidden" id="action" name="act" value="" />
</form>
<section class="col-xs-12">
<div class="table-responsive content-box tab-content" style="overflow: auto;">
<?php if ($act != 'edit'): ?>
<table class="table table-striped">
<tr>
<th><?= gettext('Name') ?></th>
<th><?= gettext('Description') ?></th>
<th><?= gettext('Type') ?></th>
<th><?= gettext('Value') ?></th>
<th class="text-nowrap">
<a href="system_advanced_sysctl.php?act=edit" class="btn btn-primary btn-xs" data-toggle="tooltip" title="<?= html_safe(gettext('Add')) ?>">
<i class="fa fa-plus fa-fw"></i>
</a>
<a href="#set_defaults" class="btn btn-danger btn-xs" data-toggle="tooltip" title="<?= html_safe(gettext('Default')) ?>">
<i class="fa fa-trash-o fa-fw"></i>
</a>
</th>
</tr>
<?php foreach ($a_tunable as &$tunable): ?>
<tr>
<td><?= $tunable['tunable'] ?></td>
<td>
<?php if (isset($tunable['descr'])): ?>
<?= $tunable['descr'] ?>
<?php endif ?>
</td>
<td>
<?php if (empty($tunable['type']) && strpos($tunable['tunable'], '.') !== false): ?>
<span class="text-warning"><?= gettext('environment') ?></span>
<?php elseif ($tunable['type'] === 'w'): ?>
<?= gettext('runtime') ?>
<?php elseif ($tunable['type'] === 't'): ?>
<?= gettext('boot-time') ?>
<?php elseif ($tunable['type'] === 'r'): ?>
<span class="text-danger"><?= gettext('read-only') ?></span>
<?php else: ?>
<?= gettext('environment') ?>
<?php endif ?>
</td>
<td>
<?php if ($tunable['value'] == 'default'): ?>
<?php if (!empty($a_defaults[$tunable['tunable']])): ?>
<?= gettext('default') . ' (' . $a_defaults[$tunable['tunable']]['default'] . ')' ?>
<?php else: ?>
<span class="text-danger"><?= gettext('unknown') ?></span>
<?php endif ?>
<?php else: ?>
<?= $tunable['value'] ?>
<?php endif ?>
</td>
<td class="text-nowrap">
<?php if (array_key_exists('key', $tunable)): ?>
<a href="system_advanced_sysctl.php?act=edit&amp;id=<?= $tunable['key'] ?>" class="btn btn-default btn-xs" data-toggle="tooltip" title="<?= html_safe(gettext('Edit')) ?>">
<i class="fa fa-pencil fa-fw"></i>
</a>
<a id="del_<?= $tunable['key'] ?>" data-id="<?= $tunable['key'] ?>" title="<?= html_safe(gettext('Delete')) ?>" data-toggle="tooltip" class="act_delete btn btn-default btn-xs">
<span class="fa fa-trash fa-fw"></span>
</a>
<?php else: ?>
<a href="system_advanced_sysctl.php?act=edit&amp;tunable=<?= $tunable['tunable'] ?>" class="btn btn-default btn-xs" data-toggle="tooltip" title="<?= html_safe(gettext('Edit')) ?>">
<i class="fa fa-pencil fa-fw"></i>
</a>
<?php endif ?>
</td>
</tr>
<?php endforeach ?>
</table>
<?php else: ?>
<form method="post">
<table class="table table-striped opnsense_standard_table_form">
<tr>
<td style="width:22%"><strong><?= gettext('Edit system tunable') ?></strong></td>
<td style="width:78%"></td>
</tr>
<tr>
<td><i class="fa fa-info-circle text-muted"></i> <?=gettext("Tunable"); ?></td>
<td>
<input type="text" name="tunable" value="<?=$pconfig['tunable']; ?>" />
</td>
</tr>
<tr>
<td><i class="fa fa-info-circle text-muted"></i> <?=gettext("Description"); ?></td>
<td>
<textarea name="descr"><?=$pconfig['descr']; ?></textarea>
</td>
</tr>
<tr>
<td><i class="fa fa-info-circle text-muted"></i> <?=gettext("Value"); ?></td>
<td>
<input name="value" type="text" value="<?=$pconfig['value']; ?>" />
</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>
<input name="Submit" type="submit" class="btn btn-primary" value="<?=html_safe(gettext('Save')); ?>" />
<input type="button" class="btn btn-default" value="<?=html_safe(gettext("Cancel"));?>" onclick="window.location.href='/system_advanced_sysctl.php'" />
<?php if (isset($id)): ?>
<input name="id" type="hidden" value="<?=$id;?>" />
<?php endif ?>
</td>
</tr>
</table>
</form>
<?php endif ?>
</div>
</section>
</div>
</div>
</section>
<?php include("foot.inc");