pfSense

<?php

/*

 * services_wol.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.

 *

 * originally based on m0n0wall (http://m0n0.ch/wall)

 * Copyright (c) 2003-2004 Manuel Kasper <mk@neon1.net>.

 * 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-services-wakeonlan

##|*NAME=Services: Wake-on-LAN

##|*DESCR=Allow access to the 'Services: Wake-on-LAN' page.

##|*MATCH=services_wol.php*

##|-PRIV

require_once("guiconfig.inc");

init_config_arr(array('wol', 'wolentry'));

$a_wol = &$config['wol']['wolentry'];

function send_wol($if, $mac, $description, & $savemsg, & $class) {

	$ipaddr = get_interface_ip($if);

	if (!is_ipaddr($ipaddr) || !is_macaddr($mac)) {

		return array();

	}

	if (!empty($description)) {

		$description = ' (' . htmlspecialchars($description) . ')';

	}

	/* determine broadcast address */

	$bcip = gen_subnet_max($ipaddr, get_interface_subnet($if));

	/* Execute wol command and check return code. */

	if (!mwexec("/usr/local/bin/wol -i {$bcip} {$mac}")) {

		$savemsg .= sprintf(gettext('Sent magic packet to %1$s%2$s.'), $mac, $description) . "<br />";

		$class = 'success';

	} else {

		$savemsg .= sprintf(gettext('Please check the %1$ssystem log%2$s, the wol command for %3$s (%4$s) did not complete successfully.'), '<a href="/status_logs.php">', '</a>', $description, htmlspecialchars($mac)) . "<br />";

		$class = 'warning';

	}

}

$savemsg = "";

$class = "";

if ($_REQUEST['wakeall'] != "") {

	foreach ($a_wol as $wolent) {

		send_wol($wolent['interface'], $wolent['mac'], $wolent['descr'], $savemsg, $class);

	}

	$savemsg .= gettext('Sent magic packet to all devices.') . "<br />";

}

if ($_POST['Submit'] || $_POST['mac']) {

	unset($input_errors);

	if ($_POST['mac']) {

		/* normalize MAC addresses - lowercase and convert Windows-ized hyphenated MACs to colon delimited */

		$mac = strtolower(str_replace("-", ":", $_POST['mac']));

		$if = $_POST['if'];

	}

	/* input validation */

	if (!$mac || !is_macaddr($mac)) {

		$input_errors[] = gettext("A valid MAC address must be specified.");

	}

	if (!$if) {

		$input_errors[] = gettext("A valid interface must be specified.");

	}

	if (!$input_errors) {

		send_wol($if, $mac, '', $savemsg, $class);

	}

}

if ($_POST['act'] == "del") {

	if ($a_wol[$_POST['id']]) {

		unset($a_wol[$_POST['id']]);

		write_config(gettext("Deleted a device from WOL configuration."));

		header("Location: services_wol.php");

		exit;

	}

}

$pgtitle = array(gettext("Services"), gettext("Wake-on-LAN"));

include("head.inc");

?>

<div class="infoblock blockopen">

<?php

print_info_box(gettext('This service can be used to wake up (power on) computers by sending special "Magic Packets".') . '<br />' .

			   gettext('The NIC in the computer that is to be woken up must support Wake-on-LAN and must be properly configured (WOL cable, BIOS settings).'),

			   'info', false);

?>

</div>

<?php

if ($input_errors) {

	print_input_errors($input_errors);

}

if ($savemsg) {

	print_info_box($savemsg, $class);

}

$selected_if = (empty($if) ? 'lan' : $if);

if (!isset(get_configured_interface_list(false)[$selected_if])) {

	$selected_if = null;

}

$form = new Form(false);

$section = new Form_Section('Wake-on-LAN');

$section->addInput(new Form_Select(

	'if',

	'*Interface',

	$selected_if,

	get_configured_interface_with_descr()

))->setHelp('Choose which interface the host to be woken up is connected to.');

$section->addInput(new Form_Input(

	'mac',

	'*MAC address',

	'text',

	$mac

))->setHelp('Enter a MAC address in the following format: xx:xx:xx:xx:xx:xx');

$form->add($section);

$form->addGlobal(new Form_Button(

	'Submit',

	'Send',

	null,

	'fa-solid fa-power-off'

))->addClass('btn-primary');

print $form;

?>

<div class="panel panel-default">

	<div class="panel-heading">

		<h2 class="panel-title"><?=gettext("Wake-on-LAN Devices");?></h2>

	</div>

<?php

	// Add top buttons if more than 24 entries in the table

	if (is_array($a_wol) && (count($a_wol) > 24)) {

?>

	<div class="panel-footer">

		<a class="btn btn-success" href="services_wol_edit.php">

			<i class="fa-solid fa-plus icon-embed-btn"></i>

			<?=gettext("Add");?>

		</a>

		<a href="services_wol.php?wakeall=true" role="button" class="btn btn-primary">

			<i class="fa-solid fa-power-off icon-embed-btn"></i>

			<?=gettext("Wake All Devices")?>

		</a>

	</div>

<?php } ?>

	<div class="panel-body">

		<p class="text-danger" style="margin-left: 8px;margin-bottom:0px;"><?=gettext("Click the MAC address to wake up an individual device.")?></p>

		<div class="table-responsive">

			<table class="table table-striped table-hover table-rowdblclickedit">

				<thead>

					<tr>

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

						<th><?=gettext("MAC address")?></th>

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

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

					</tr>

				</thead>

				<tbody>

					<?php foreach ($a_wol as $i => $wolent): ?>

						<tr>

							<td>

								<?=convert_friendly_interface_to_friendly_descr($wolent['interface']);?>

							</td>

							<td>

								<a href="?mac=<?=$wolent['mac'];?>&amp;if=<?=$wolent['interface'];?>" usepost><?=strtolower($wolent['mac']);?></a>

							</td>

							<td>

								<?=htmlspecialchars($wolent['descr']);?>

							</td>

							<td>

								<a class="fa-solid fa-pencil"	title="<?=gettext('Edit Device')?>"	href="services_wol_edit.php?id=<?=$i?>"></a>

								<a class="fa-solid fa-trash-can"	title="<?=gettext('Delete Device')?>" href="services_wol.php?act=del&amp;id=<?=$i?>" usepost></a>

								<a class="fa-solid fa-power-off" title="<?=gettext('Wake Device')?>" href="?mac=<?=$wolent['mac'];?>&amp;if=<?=$wolent['interface'];?>" usepost></a>

							</td>

						</tr>

					<?php endforeach?>

				</tbody>

			</table>

		</div>

	</div>

	<div class="panel-footer">

		<a class="btn btn-success" href="services_wol_edit.php">

			<i class="fa-solid fa-plus icon-embed-btn"></i>

			<?=gettext("Add");?>

		</a>

		<button id="wakeall" class="btn btn-primary">

			<i class="fa-solid fa-power-off icon-embed-btn"></i>

			<?=gettext("Wake All Devices")?>

		</button>

	</div>

</div>

<script type="text/javascript">

//<![CDATA[

events.push(function() {

	$('#wakeall').click(function() {

		if (confirm("Are you sure you wish to Wake All Devices?")) {

			postSubmit({wakeall: 'true'}, 'services_wol.php');

		}

	});

});

//]]>

</script>

<?php

include("foot.inc");