pfSense

<?php

/*

 * status_carp.php

 *

 * part of pfSense (https://www.pfsense.org)

 * Copyright (c) 2004-2013 BSD Perimeter

 * Copyright (c) 2013-2016 Electric Sheep Fencing

 * Copyright (c) 2014-2024 Rubicon Communications, LLC (Netgate)

 * All rights reserved.

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

##|+PRIV

##|*IDENT=page-status-carp

##|*NAME=Status: CARP

##|*DESCR=Allow access to the 'Status: CARP' page.

##|*MATCH=status_carp.php*

##|-PRIV

require_once("guiconfig.inc");

require_once("globals.inc");

unset($interface_arr_cache);

unset($interface_ip_arr_cache);

function find_ipalias($carpif) {

	$ips = array();

	foreach (config_get_path('virtualip/vip', []) as $vip) {

		if ($vip['mode'] != "ipalias") {

			continue;

		}

		if ($vip['interface'] != $carpif) {

			continue;

		}

		$ips[] = "{$vip['subnet']}/{$vip['subnet_bits']}";

	}

	return ($ips);

}

$status = get_carp_status();

if ($_POST['carp_maintenancemode'] != "") {

	if (!config_path_enabled('', 'virtualip_carp_maintenancemode')) {

		if ($_POST['carp_maintenancemode'] == "disable"){

			$errmsg = gettext("Persistent CARP Maintenance Mode is already disabled.");

		} else {

			$maintenancemode = true;

			$savemsg = gettext("Entering Persistent CARP Maintenance Mode.");

		}

	} else {

		if ($_POST['carp_maintenancemode'] == "enable"){

			$errmsg = gettext("Persistent CARP Maintenance Mode is already enabled.");

		} else {

			$maintenancemode = false;

			$savemsg = gettext("Leaving Persistent CARP Maintenance Mode.");

		}

	}

	/* allow to switch to Persistent Maintenance Mode if CARP is disabled

	 * see https://redmine.pfsense.org/issues/11727 */

	if (!$errmsg) {

		interfaces_carp_set_maintenancemode($maintenancemode);

	}

	if ($status == 0) {

		$_POST['disablecarp'] = "off";

	}

}

if ($_POST['disablecarp'] != "") {

	$viparr = config_get_path('virtualip/vip', []);

	if ($status != 0) {

		if ($_POST['disablecarp'] == "enable"){

			$errmsg = gettext("CARP is already enabled.");

		} else {

			enable_carp(false);

			foreach ($viparr as $vip) {

				if ($vip['mode'] != "carp" && $vip['mode'] != "ipalias")

					continue;

				if ($vip['mode'] == "ipalias" && substr($vip['interface'], 0, 4) != "_vip")

					continue;

				interface_vip_bring_down($vip);

			}

			$savemsg = sprintf(gettext("%s IPs have been disabled. Please note that disabling does not survive a reboot and some configuration changes will re-enable."), $carp_counter);

			$status = 0;

		}

	} else {

		if ($_POST['disablecarp'] == "disable"){

			$errmsg = gettext("CARP is already disabled.");

		} else {

			$savemsg .= gettext("CARP has been enabled.");

			foreach ($viparr as $vip) {

				switch ($vip['mode']) {

					case "carp":

						interface_carp_configure($vip);

						break;

					case 'ipalias':

						if (substr($vip['interface'], 0, 4) == "_vip") {

							interface_ipalias_configure($vip);

						}

						break;

				}

			}

			interfaces_sync_setup();

			enable_carp();

			$status = 1;

		}

	}

}

$carp_detected_problems = get_single_sysctl("net.inet.carp.demotion");

if (!empty($_POST['resetdemotion'])) {

	set_single_sysctl("net.inet.carp.demotion", 0 - $carp_detected_problems);

	sleep(1);

	$carp_detected_problems = get_single_sysctl("net.inet.carp.demotion");

}

$pgtitle = array(gettext("Status"), gettext("CARP"));

$shortcut_section = "carp";

include("head.inc");

if ($savemsg) {

	print_info_box($savemsg, 'success');

} else if ($errmsg) {

	print_info_box($errmsg);

}

$carpcount = 0;

foreach(config_get_path('virtualip/vip', []) as $carp) {

	if ($carp['mode'] == "carp") {

		$carpcount++;

		break;

	}

}

// If $carpcount > 0 display buttons then display table

// otherwise display error box and quit

if ($carpcount == 0) {

	print_info_box(gettext('No CARP interfaces have been defined.') . '<br />' .

				   '<a href="system_hasync.php" class="alert-link">' .

				   gettext("High availability sync settings can be configured here.") .

				   '</a>');

} else {

?>

	<div class="panel panel-default">

		<div class="panel-heading"><h2 class="panel-title"><?=gettext("CARP Maintenance");?></h2></div>

		<div class="panel-body">

			<div class="content">

				<form action="status_carp.php" method="post">

<?php

	if ($status != 0) {

		$carp_enabled = true;

	} else {

		$carp_enabled = false;

	}

	// Sadly this needs to be here so that it is inside the form

	if ($carp_detected_problems != 0) {

		print_info_box(

			gettext("CARP has detected a problem and this unit has a non-zero demotion status.") .

			"<br/>" .

			gettext("Check the link status on all interfaces configured with CARP VIPs and ") .

			sprintf(gettext('search the %1$sSystem Log%2$s for CARP demotion-related events.'), "<a href=\"/status_logs.php?filtertext=carp%3A+demoted+by\">", "</a>") .

			"<br/><br/>" .

			'<button type="submit" class="btn btn-warning" name="resetdemotion" id="resetdemotion" value="' .

			gettext("Reset CARP Demotion Status") .

			'"><i class="fa-solid fa-undo icon-embed-btn"></i>' .

			gettext("Reset CARP Demotion Status") .

			'</button>',

			'danger'

		);

	}

?>

				<button type="submit" class="btn btn-warning" name="disablecarp" value="<?=($carp_enabled ? 'disable' : 'enable')?>" ><i class="<?=($carp_enabled) ? 'fa-solid fa-ban' : 'fa-solid fa-check' ; ?> icon-embed-btn"></i><?=($carp_enabled ? gettext("Temporarily Disable CARP") : gettext("Enable CARP"))?></button>

				<button type="submit" class="btn btn-info" name="carp_maintenancemode" id="carp_maintenancemode" value="<?=(config_path_enabled('', 'virtualip_carp_maintenancemode') ? 'disable' : 'enable')?>" ><i class="fa-solid fa-wrench icon-embed-btn"></i><?=(config_path_enabled('', 'virtualip_carp_maintenancemode') ? gettext("Leave Persistent CARP Maintenance Mode") : gettext("Enter Persistent CARP Maintenance Mode"))?></button>

			</div>

		</div>

	</div>

	<div class="panel panel-default">

		<div class="panel-heading"><h2 class="panel-title"><?=gettext('CARP Status')?></h2></div>

			<div class="panel-body table-responsive">

				<table class="table table-striped table-condensed table-hover sortable-theme-bootstrap " data-sortable>

					<thead>

						<tr>

							<th><?=gettext("Interface and VHID")?></th>

							<th><?=gettext("Virtual IP Address")?></th>

							<th><?=gettext("Description")?></th>

							<th><?=gettext("Status")?></th>

						</tr>

					</thead>

					<tbody>

<?php

	foreach (config_get_path('virtualip/vip', []) as $carp) {

		if ($carp['mode'] != "carp") {

			continue;

		}

		$icon = '';

		$vhid = $carp['vhid'];

		$status = get_carp_interface_status("_vip{$carp['uniqid']}");

		$aliases = find_ipalias("_vip{$carp['uniqid']}");

		if ($carp_enabled == false) {

			$icon = 'fa-solid fa-times-circle';

			$status = "DISABLED";

		} else {

			if ($status == "MASTER") {

				$icon = 'fa-solid fa-play-circle text-success';

			} else if ($status == "BACKUP") {

				$icon = 'fa-solid fa-pause-circle text-warning';

			} else if ($status == "INIT") {

				$icon = 'fa-solid fa-question-circle text-danger';

			}

		}

?>

					<tr>

						<td><?=htmlspecialchars(convert_friendly_interface_to_friendly_descr($carp['interface']) . "@{$vhid}");?></td>

						<td>

<?php

		printf("{$carp['subnet']}/{$carp['subnet_bits']}");

		for ($i = 0; $i < count($aliases); $i++) {

			printf("<br>{$aliases[$i]}");

		}

?>

						</td>

						<td><?=htmlspecialchars($carp['descr'])?></td>

						<td><i class="<?=$icon?>"></i>&nbsp;<?=$status?></td>

					</tr>

<?php }?>

				</tbody>

			</table>

		</div>

	</div>

</form>

<div class="panel panel-default">

	<div class="panel-heading"><h2 class="panel-title"><?=gettext('State Synchronization Status')?></h2></div>

	<div class="panel-body"><div class="content">

		<?= gettext("State Creator Host IDs") ?>:

		<ul>

<?php

	$my_id = strtolower(ltrim(filter_get_host_id(), '0'));

	exec("/sbin/pfctl -sc | /usr/bin/tail -n +2 | /usr/bin/sort", $hostids);

	if (!is_array($hostids)) {

		$hostids = array();

	}

?>

<?php	foreach ($hostids as $hid):

		$hid = strtolower(ltrim($hid, '0')); ?>

			<li>

				<?= $hid ?>

<?php		if ($hid == $my_id): ?>

				(<?= gettext("This node") ?>)

<?php		endif; ?>

			</li>

<?php	endforeach; ?>

		</ul>

		<div class="infoblock blockopen">

<?php

	print_info_box(sprintf(gettext(

		'When state synchronization is enabled and functioning properly the list of state creator host IDs will be identical on each node participating in state synchronization.%1$s%1$s' .

		'The state creator host ID for this node can be set to a custom value under System > High Avail Sync. ' .

		'If the state creator host ID has recently changed, the old ID will remain until all states using the old ID expire or are removed.'

		), '<br/>'), 'info', false);

?>

		</div>

	</div></div>

</div>

<?php

}

include("foot.inc");