Status - System Logs - Consolidate - Common Functions

Factor common code section into to functions and place in include file.

 getGETPOSTsettingvalue
 miscellaneous_common_code
 tab_array_logs_common

 log_filter_form_system_submit
 filter_form_system

 log_filter_form_firewall_submit
 filter_form_firewall
 build_if_list

 manage_log_code
 manage_log_section

1 files changed, 17 insertions, 446 deletions

diff --git a/src/usr/local/www/status_logs.php b/src/usr/local/www/status_logs.php
index adf5ecc..a25d4a8 100755
--- a/src/usr/local/www/status_logs.php
+++ b/src/usr/local/www/status_logs.php
@@ -63,8 +63,8 @@
 ##|*MATCH=status_logs.php
 ##|-PRIV
 
-require("guiconfig.inc");
-require_once("filter_log.inc");
+require_once("status_logs_common.inc");
+
 
 /*
 Build a list of allowed log files so we can reject others to prevent the page
@@ -108,181 +108,23 @@ if (!$_GET['logfile']) {
 	}
 }
 
-$system_logfile = "{$g['varlog_path']}/" . basename($logfile) . ".log";
-
-
-function getGETPOSTsettingvalue($settingname, $default) {
-	$settingvalue = $default;
-	if ($_GET[$settingname]) {
-		$settingvalue = $_GET[$settingname];
-	}
-	if ($_POST[$settingname]) {
-		$settingvalue = $_POST[$settingname];
-	}
-	return $settingvalue;
-}
-
-
-$filtersubmit = getGETPOSTsettingvalue('filtersubmit', null);
-
-if ($filtersubmit) {
-	$filter_active = true;
-	$filtertext = getGETPOSTsettingvalue('filtertext', "");
-	$filterlogentries_qty = getGETPOSTsettingvalue('filterlogentries_qty', null);
-}
-
-$filterlogentries_submit = getGETPOSTsettingvalue('filterlogentries_submit', null);
-
-if ($filterlogentries_submit) {
-	$filter_active = true;
-	$filterfieldsarray = array();
-
-	$filterfieldsarray['time'] = getGETPOSTsettingvalue('filterlogentries_time', null);
-	$filterfieldsarray['process'] = getGETPOSTsettingvalue('filterlogentries_process', null);
-	$filterfieldsarray['pid'] = getGETPOSTsettingvalue('filterlogentries_pid', null);
-	$filterfieldsarray['message'] = getGETPOSTsettingvalue('filterlogentries_message', null);
-	$filterlogentries_qty = getGETPOSTsettingvalue('filterlogentries_qty', null);
-}
-
-
-# Manage Log - Code
-
-$specific_log = basename($logfile) . '_settings';
-
-# All
-$pconfig['cronorder'] = $config['syslog'][$specific_log]['cronorder'];
-$pconfig['nentries'] = $config['syslog'][$specific_log]['nentries'];
-$pconfig['logfilesize'] = $config['syslog'][$specific_log]['logfilesize'];
-$pconfig['format'] = $config['syslog'][$specific_log]['format'];
-
-# System General (main) Specific
-$pconfig['loglighttpd'] = !isset($config['syslog']['nologlighttpd']);
-
-$save_settings = getGETPOSTsettingvalue('save_settings', null);
-
-if ($save_settings) {
-
-	# All
-	$cronorder = getGETPOSTsettingvalue('cronorder',  null);
-	$nentries = getGETPOSTsettingvalue('nentries', null);
-	$logfilesize = getGETPOSTsettingvalue('logfilesize', null);
-	$format  = getGETPOSTsettingvalue('format',  null);
-
-	# System General (main) Specific
-	$loglighttpd  = getGETPOSTsettingvalue('loglighttpd',  null);
-
-	unset($input_errors);
-	$pconfig = $_POST;
-
-	/* input validation */
-	# All
-	if (isset($nentries) && (strlen($nentries) > 0)) {
-		if (!is_numeric($nentries) || ($nentries < 5) || ($nentries > 2000)) {
-			$input_errors[] = gettext("Number of log entries to show must be between 5 and 2000.");
-		}
-	}
-
-	if (isset($logfilesize) && (strlen($logfilesize) > 0)) {
-		if (!is_numeric($logfilesize) || ($logfilesize < 100000)) {
-			$input_errors[] = gettext("Log file size must be numeric and greater than or equal to 100000.");
-		}
-	}
-
-	if (!$input_errors) {
-
-		# Clear out the specific log settings and leave only the applied settings to override the general logging options (global) settings.
-		if (isset($config['syslog'][$specific_log])) {
-			unset($config['syslog'][$specific_log]);
-		}
-
-	# All
-		if ($cronorder != '') { # if not using the general logging options setting (global)
-			$config['syslog'][$specific_log]['cronorder'] = $cronorder;
-		}
-
-		if (isset($nentries) && (strlen($nentries) > 0)) {
-			$config['syslog'][$specific_log]['nentries'] = (int)$nentries;
-		}
-
-		if (isset($logfilesize) && (strlen($logfilesize) > 0)) {
-			$config['syslog'][$specific_log]['logfilesize'] = (int)$logfilesize;
-		}
-
-		if ($format != '') { # if not using the general logging options setting (global)
-			$config['syslog'][$specific_log]['format'] = $format;
-		}
-
-	# System General (main) Specific
-		if ($logfile == 'system') {
-			$oldnologlighttpd = isset($config['syslog']['nologlighttpd']);
-			$config['syslog']['nologlighttpd'] = $loglighttpd ? false : true;
-
-			if ($oldnologlighttpd !== $config['syslog']['nologlighttpd']) {
-				$logging_changed = $lighttpd_logging_changed = true;
-			}
-		}
-
-
-		// If any of the logging settings were changed then backup and sync (standard write_config).  Otherwise only write config (don't backup, don't sync).
-		if ($logging_changed) {
-			write_config($desc = "Log Display Settings Saved: " . gettext($allowed_logs[$logfile]["name"]), $backup = true, $write_config_only = false);
-			$retval = 0;
-			$retval = system_syslogd_start();
-		} else {
-			write_config($desc = "Log Display Settings Saved (no backup, no sync): " . gettext($allowed_logs[$logfile]["name"]), $backup = false, $write_config_only = true);
-		}
-
-		$savemsg = gettext("The changes have been applied successfully.");
-
-	# System General (main) Specific
-		if ($logfile == 'system') {
-			if ($lighttpd_logging_changed) {
-				ob_flush();
-				flush();
-				log_error(gettext("webConfigurator configuration has changed. Restarting webConfigurator."));
-				send_event("service restart webgui");
-				$savemsg .= "<br />" . gettext("WebGUI process is restarting.");
-			}
-		}
-	}
-}
-
 
-# Formatted/Raw Display
-if ($config['syslog'][$specific_log]['format'] == 'formatted') {
-	$rawfilter = false;
-} else if ($config['syslog'][$specific_log]['format'] == 'raw') {
-	$rawfilter = true;
-} else {	# Use the general logging options setting (global).
-	$rawfilter = isset($config['syslog']['rawfilter']);
-}
+// Log Filter Submit - System
+log_filter_form_system_submit();
 
 
-isset($config['syslog'][$specific_log]['nentries']) ? $nentries = $config['syslog'][$specific_log]['nentries'] : $nentries = $config['syslog']['nentries'];
+// Manage Log Section - Code
+manage_log_code();
 
-# Override Display Quantity
-if ($filterlogentries_qty) {
-	$nentries = $filterlogentries_qty;
-}
 
-if (!$nentries || !is_numeric($nentries)) {
-	$nentries = 50;
-}
+// Miscellaneous Common - Code
+miscellaneous_common_code();
 
-if ($_POST['clear']) {
-	clear_log_file($system_logfile);
-}
 
 if ($filtertext) {
 	$filtertextmeta="?filtertext=$filtertext";
 }
 
-/* Setup shortcuts if they exist */
-
-if (!empty($allowed_logs[$logfile]["shortcut"])) {
-	$shortcut_section = $allowed_logs[$logfile]["shortcut"];
-}
-
 $pgtitle = array(gettext("Status"), gettext("System logs"), gettext($allowed_logs[$logfile]["name"]));
 include("head.inc");
 
@@ -291,137 +133,20 @@ if (!$input_errors && $savemsg) {
 	$manage_log_active = false;
 }
 
-$tab_array = array();
-$tab_array[] = array(gettext("System"), ($logfile == 'system'), "status_logs.php");
-$tab_array[] = array(gettext("Firewall"), false, "status_logs_filter.php");
-$tab_array[] = array(gettext("DHCP"), ($logfile == 'dhcpd'), "status_logs.php?logfile=dhcpd");
-$tab_array[] = array(gettext("Portal Auth"), ($logfile == 'portalauth'), "status_logs.php?logfile=portalauth");
-$tab_array[] = array(gettext("IPsec"), ($logfile == 'ipsec'), "status_logs.php?logfile=ipsec");
-$tab_array[] = array(gettext("PPP"), ($logfile == 'ppp'), "status_logs.php?logfile=ppp");
-$tab_array[] = array(gettext("VPN"), false, "status_logs_vpn.php");
-$tab_array[] = array(gettext("Load Balancer"), ($logfile == 'relayd'), "status_logs.php?logfile=relayd");
-$tab_array[] = array(gettext("OpenVPN"), ($logfile == 'openvpn'), "status_logs.php?logfile=openvpn");
-$tab_array[] = array(gettext("NTP"), ($logfile == 'ntpd'), "status_logs.php?logfile=ntpd");
-$tab_array[] = array(gettext("Settings"), false, "status_logs_settings.php");
-display_top_tabs($tab_array);
-
-$tab_array = array();
-if (in_array($logfile, array('system', 'gateways', 'routing', 'resolver', 'wireless')))	 {
-	$tab_array[] = array(gettext("General"), ($logfile == 'system'), "/status_logs.php");
-	$tab_array[] = array(gettext("Gateways"), ($logfile == 'gateways'), "/status_logs.php?logfile=gateways");
-	$tab_array[] = array(gettext("Routing"), ($logfile == 'routing'), "/status_logs.php?logfile=routing");
-	$tab_array[] = array(gettext("Resolver"), ($logfile == 'resolver'), "/status_logs.php?logfile=resolver");
-	$tab_array[] = array(gettext("Wireless"), ($logfile == 'wireless'), "/status_logs.php?logfile=wireless");
-	display_top_tabs($tab_array, false, 'nav nav-tabs');
-}
-
-if ($filter_active) {
-	$filter_state = SEC_OPEN;
-} else {
-	$filter_state = SEC_CLOSED;
-}
-
-if (!$rawfilter) { // Advanced log filter form
-	$form = new Form(false);
+// Tab Array
+tab_array_logs_common();
 
-	$section = new Form_Section('Advanced Log Filter', 'adv-filter-panel', COLLAPSIBLE|$filter_state);
 
-	$group = new Form_Group('');
+// Filter Section/Form - System
+filter_form_system();
 
-	$group->add(new Form_Input(
-		'filterlogentries_time',
-		null,
-		'text',
-		$filterfieldsarray['time']
-	))->setWidth(3)->setHelp('Time');
-
-	$group->add(new Form_Input(
-		'filterlogentries_process',
-		null,
-		'text',
-		$filterfieldsarray['process']
-	))->setWidth(2)->setHelp('Process');
-
-	$group->add(new Form_Input(
-		'filterlogentries_pid',
-		null,
-		'text',
-		$filterfieldsarray['pid']
-	))->setWidth(2)->setHelp('PID');
-
-	$group->add(new Form_Input(
-		'filterlogentries_qty',
-		null,
-		'number',
-		$filterlogentries_qty,
-		['placeholder' => $nentries]
-	))->setWidth(2)->setHelp('Quantity');
-
-	$section->add($group);
-
-	$group = new Form_Group('');
-
-	$group->add(new Form_Input(
-		'filterlogentries_message',
-		null,
-		'text',
-		$filterfieldsarray['message']
-	))->setWidth(7)->setHelp('Message');
-
-	$btnsubmit = new Form_Button(
-		'filterlogentries_submit',
-		' ' . gettext('Apply Filter'),
-		null,
-		'fa-filter'
-	);
-} else { // Simple log filter form
-	$form = new Form(false);
-
-	$section = new Form_Section('Log Filter', 'basic-filter-panel', COLLAPSIBLE|$filter_state);
-
-	$group = new Form_Group('');
-
-	$group->add(new Form_Input(
-		'filtertext',
-		null,
-		'text',
-		$filtertext
-	))->setWidth(6)->setHelp('Filter Expression');
-
-	$group->add(new Form_Input(
-		'filterlogentries_qty',
-		null,
-		'number',
-		$filterlogentries_qty,
-		['placeholder' => $nentries]
-	))->setWidth(2)->setHelp('Quantity');
-
-	$btnsubmit = new Form_Button(
-		'filtersubmit',
-		' ' . gettext('Apply Filter'),
-		null,
-		'fa-filter'
-	);
-}
-
-$btnsubmit->removeClass('btn-primary')->addClass('btn-success')->addClass('btn-sm');
-
-$group->add(new Form_StaticText(
-	'',
-	$btnsubmit
-));
-
-$group->setHelp('<a target="_blank" href="http://www.php.net/manual/en/book.pcre.php">' . gettext('Regular expression reference') . '</a> ' . gettext('Precede with exclamation (!) to exclude match.'));
-$section->add($group);
-$form->add($section);
-print $form;
 
 // Now the forms are complete we can draw the log table and its controls
 if (!$rawfilter) {
 	if ($filterlogentries_submit) {
-		$filterlog = conv_log_filter($system_logfile, $nentries, $nentries + 100, $filterfieldsarray);
+		$filterlog = conv_log_filter($logfile_path, $nentries, $nentries + 100, $filterfieldsarray);
 	} else {
-		$filterlog = conv_log_filter($system_logfile, $nentries, $nentries + 100, $filtertext);
+		$filterlog = conv_log_filter($logfile_path, $nentries, $nentries + 100, $filtertext);
 	}
 ?>
 
@@ -503,9 +228,9 @@ if (!$rawfilter) {
 	}
 
 	if ($filtertext) {
-		$rows = dump_clog($system_logfile, $nentries, true, array("$filtertext"), $inverse);
+		$rows = dump_clog($logfile_path, $nentries, true, array("$filtertext"), $inverse);
 	} else {
-		$rows = dump_clog($system_logfile, $nentries, true, array(), $inverse);
+		$rows = dump_clog($logfile_path, $nentries, true, array(), $inverse);
 	}
 ?>
 			</tbody>
@@ -523,161 +248,7 @@ if (!$rawfilter) {
 
 <?php
 # Manage Log - Section/Form
-
-if ($input_errors) {
-	print_input_errors($input_errors);
-	$manage_log_active = true;
-}
-
-if ($manage_log_active) {
-	$manage_log_state = SEC_OPEN;
-} else {
-	$manage_log_state = SEC_CLOSED;
-}
-
-$form = new Form(false);
-
-$section = new Form_Section(gettext('Manage') . ' ' . gettext($allowed_logs[$logfile]["name"]) . ' ' . gettext('Log'), 'log-manager-panel', COLLAPSIBLE|$manage_log_state);
-
-$section->addInput(new Form_StaticText(
-	'',
-	'These settings override the "General Logging Options" settings.'
-));
-
-
-# All
-$group = new Form_Group('Forward/Reverse Display');
-
-$group->add(new Form_Checkbox(
-	'cronorder',
-	null,
-	'Forward',
-	($pconfig['cronorder'] == 'forward') ? true : false,
-	'forward'
-))->displayAsRadio()->setHelp('(newest at bottom)');
-
-$group->add(new Form_Checkbox(
-	'cronorder',
-	null,
-	'Reverse',
-	($pconfig['cronorder'] == 'reverse') ? true : false,
-	'reverse'
-))->displayAsRadio()->setHelp('(newest at top)');
-
-$group->add(new Form_Checkbox(
-	'cronorder',
-	null,
-	'General Logging Options Setting',
-	($pconfig['cronorder'] == '') ? true : false,
-	''
-))->displayAsRadio();
-
-$group->setHelp('Show log entries in forward or reverse order.');
-$section->add($group);
-
-$group = new Form_Group('GUI Log Entries');
-
-# Use the general logging options setting (global) as placeholder.
-$group->add(new Form_Input(
-	'nentries',
-	'GUI Log Entries',
-	'number',
-	$pconfig['nentries'],
-	['min' => 5, 'max' => 2000, 'placeholder' => $config['syslog']['nentries']]
-))->setWidth(2);
-
-$group->setHelp('This is the number of log entries displayed in the GUI. It does not affect how many entries are contained in the log.');
-$section->add($group);
-
-$group = new Form_Group('Log file size (Bytes)');
-
-# Use the general logging options setting (global) as placeholder.
-$group->add(new Form_Input(
-	'logfilesize',
-	'Log file size (Bytes)',
-	'number',
-	$pconfig['logfilesize'],
-	['min' => 100000, 'placeholder' => $config['syslog']['logfilesize'] ? $config['syslog']['logfilesize'] : "511488"]
-))->setWidth(2);
-$group->setHelp("The log is held in a constant-size circular log file. This field controls how large the log file is, and thus how many entries may exist inside the log. The default is approximately 500KB." .
-					'<br /><br />' .
-			"NOTE: The log size is changed the next time it is cleared. To immediately change the log size, first save the options to set the size, then clear the log using the \"Clear Log\" action below. ");
-$section->add($group);
-
-$group = new Form_Group('Formatted/Raw Display');
-
-$group->add(new Form_Checkbox(
-	'format',
-	null,
-	'Formatted',
-	($pconfig['format'] == 'formatted') ? true : false,
-	'formatted'
-))->displayAsRadio();
-
-$group->add(new Form_Checkbox(
-	'format',
-	null,
-	'Raw',
-	($pconfig['format'] == 'raw') ? true : false,
-	'raw'
-))->displayAsRadio();
-
-$group->add(new Form_Checkbox(
-	'format',
-	null,
-	'General Logging Options Setting',
-	($pconfig['format'] == '') ? true : false,
-	''
-))->displayAsRadio();
-
-$group->setHelp('Show the log entries as formatted or raw output as generated by the service. The raw output will reveal more detailed information, but it is more difficult to read.');
-$section->add($group);
-
-
-# System General (main) Specific
-if ($logfile == 'system') {
-	$section->addInput(new Form_Checkbox(
-		'loglighttpd',
-		'Web Server Log',
-		'Log errors from the web server process',
-		$pconfig['loglighttpd']
-	))->setHelp('If this is checked, errors from the lighttpd web server process for the GUI or Captive Portal will appear in the system log.');
-}
-
-
-$group = new Form_Group('Action');
-
-$btnsavesettings = new Form_Button(
-	'save_settings',
-	gettext('Save'),
-	null
-);
-
-$btnsavesettings->addClass('btn-sm');
-
-$group->add(new Form_StaticText(
-	'',
-	$btnsavesettings
-))->setHelp('Saves changed settings.');
-
-
-$btnclear = new Form_Button(
-	'clear',
-	' ' . gettext('Clear log'),
-	null,
-	'fa-trash'
-);
-
-$btnclear->removeClass('btn-primary')->addClass('btn-danger')->addClass('btn-sm');
-
-$group->add(new Form_StaticText(
-	'',
-	$btnclear
-))->setHelp('Clears local log file and reinitializes it as an empty log. Save any settings changes first.');
-
-$section->add($group);
-$form->add($section);
-print $form;
+manage_log_section();
 ?>
 
 <?php include("foot.inc"); ?>