aboutsummaryrefslogtreecommitdiffstats
path: root/config/apcupsd/apcupsd.inc
diff options
context:
space:
mode:
Diffstat (limited to 'config/apcupsd/apcupsd.inc')
-rw-r--r--config/apcupsd/apcupsd.inc317
1 files changed, 152 insertions, 165 deletions
diff --git a/config/apcupsd/apcupsd.inc b/config/apcupsd/apcupsd.inc
index 0a99982d..2b166994 100644
--- a/config/apcupsd/apcupsd.inc
+++ b/config/apcupsd/apcupsd.inc
@@ -1,53 +1,48 @@
<?php
-/* $Id$ */
-/* ========================================================================== */
/*
- apcupsd.inc
- part of the apcupsd package for pfSense
- Copyright (C) 2013 Danilo G. Baio <dbaio@bsd.com.br>
-
- 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.
- */
-/* ========================================================================== */
+ apcupsd.inc
+ part of pfSense (https://www.pfSense.org/)
+ Copyright (C) 2013-2015 Danilo G. Baio <dbaio@bsd.com.br>
+ Copyright (C) 2015 ESF, LLC
+ 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("util.inc");
require_once("functions.inc");
require_once("pkg-utils.inc");
require_once("globals.inc");
-function php_install_apcupsd(){
- sync_package_apcupsd();
+function php_install_apcupsd() {
+ sync_package_apcupsd();
apccontrol_scripts_install();
}
-function php_deinstall_apcupsd(){
+function php_deinstall_apcupsd() {
global $config, $g;
conf_mount_rw();
- $pfs_version = substr(trim(file_get_contents("/etc/version")),0,3);
- if ($pfs_version > 2.0){
+ $pfs_version = substr(trim(file_get_contents("/etc/version")), 0, 3);
+ if ($pfs_version == "2.1" || $pfs_version == "2.2") {
define('APCUPSD_BASE', '/usr/pbi/apcupsd-' . php_uname("m"));
} else {
define('APCUPSD_BASE', '/usr/local');
@@ -59,176 +54,171 @@ function php_deinstall_apcupsd(){
unlink_if_exists("/var/log/apcupsd/apcupsd.log");
unlink_if_exists("/var/run/apcupsd/apcupsd.pid");
- if (is_dir("/var/log/apcupsd"))
- exec("/bin/rm -r /var/log/apcupsd/");
- if (is_dir("/var/run/apcupsd"))
- exec("/bin/rm -r /var/run/apcupsd/");
+ if (is_dir("/var/log/apcupsd")) {
+ exec("/bin/rm -rf /var/log/apcupsd/");
+ }
+ if (is_dir("/var/run/apcupsd")) {
+ exec("/bin/rm -rf /var/run/apcupsd/");
+ }
- conf_mount_ro();
+ conf_mount_ro();
}
-function validate_input_apcupsd($post,&$input_errors){
+function validate_input_apcupsd($post, &$input_errors) {
- if (isset($post['apcupsdenabled'])){
-
+ if (isset($post['apcupsdenabled'])) {
if ($post['polltime'] != '' && !is_numericint($post['polltime'])) {
- $input_errors[]='Poll Time is not numeric.';
+ $input_errors[] = 'Poll Time is not numeric.';
}
if ($post['onbatterydelay'] != '' && !is_numericint($post['onbatterydelay'])) {
- $input_errors[]='OnBattery Delay is not numeric.';
+ $input_errors[] = 'OnBattery Delay is not numeric.';
}
if ($post['batterylevel'] != '' && !is_numericint($post['batterylevel'])) {
- $input_errors[]='Battery Level is not numeric.';
+ $input_errors[] = 'Battery Level is not numeric.';
}
if ($post['minutes'] != '' && !is_numericint($post['minutes'])) {
- $input_errors[]='Minutes is not numeric.';
+ $input_errors[] = 'Minutes is not numeric.';
}
if ($post['timeout'] != '' && !is_numericint($post['timeout'])) {
- $input_errors[]='Timeout is not numeric.';
+ $input_errors[] = 'Timeout is not numeric.';
}
if ($post['annoy'] != '' && !is_numericint($post['annoy'])) {
- $input_errors[]='Annoy is not numeric.';
+ $input_errors[] = 'Annoy is not numeric.';
}
if ($post['annoydelay'] != '' && !is_numericint($post['annoydelay'])) {
- $input_errors[]='Annoy Delay is not numeric.';
+ $input_errors[] = 'Annoy Delay is not numeric.';
}
if ($post['killdelay'] != '' && !is_numericint($post['killdelay'])) {
- $input_errors[]='Kill Delay is not numeric.';
+ $input_errors[] = 'Kill Delay is not numeric.';
}
if ($post['nisip'] != '') {
- if (!is_ipaddr_configured($post['nisip']) && !preg_match("/(127.0.0.1|0.0.0.0)/",$post['nisip'])) {
- $input_errors[]='NIS Ip is not a configured IP address.';
+ if (!is_ipaddr_configured($post['nisip']) && !preg_match("/(127.0.0.1|0.0.0.0)/", $post['nisip'])) {
+ $input_errors[] = 'NIS Ip is not a configured IP address.';
}
}
if ($post['nisport'] != '') {
if (!preg_match("/^\d+$/", $post['nisport'])) {
- $input_errors[]='NIS Port is not numeric.';
- }
+ $input_errors[] = 'NIS Port is not numeric.';
+ }
}
if ($post['emailnotification'] == 'smtpbuiltin') {
-
if (empty($post['smtphost'])) {
- $input_errors[]='SMTP Host cannot be empty if SMTP builtin is enabled.';
+ $input_errors[] = 'SMTP Host cannot be empty if SMTP builtin is enabled.';
}
if (empty($post['smtpport'])) {
- $input_errors[]='SMTP Port cannot be empty if SMTP builtin is enabled.';
- }elseif(!is_port($post['smtpport'])){
- $input_errors[]='SMTP Port is not a valid port.';
+ $input_errors[] = 'SMTP Port cannot be empty if SMTP builtin is enabled.';
+ } elseif (!is_port($post['smtpport'])) {
+ $input_errors[]='SMTP Port is not a valid port.';
}
if (empty($post['smtpfrom'])) {
- $input_errors[]='From field cannot be empty if SMTP builtin is enabled.';
+ $input_errors[] = 'From field cannot be empty if SMTP builtin is enabled.';
}
if (empty($post['smtpto'])) {
- $input_errors[]='To field cannot be empty if SMTP builtin is enabled..';
+ $input_errors[] = 'To field cannot be empty if SMTP builtin is enabled.';
}
-
}
- } // apcupsdenabled
+ }
}
-function sync_package_apcupsd(){
+function sync_package_apcupsd() {
global $config, $g;
conf_mount_rw();
- // check pfsense version
- $pfs_version = substr(trim(file_get_contents("/etc/version")),0,3);
- if ($pfs_version > 2.0){
+ $pfs_version = substr(trim(file_get_contents("/etc/version")), 0, 3);
+ if ($pfs_version == "2.1" || $pfs_version == "2.2") {
define('APCUPSD_BASE', '/usr/pbi/apcupsd-' . php_uname("m"));
- }
- else {
+ } else {
define('APCUPSD_BASE', '/usr/local');
}
// check apcupsd settings
- if (is_array($config['installedpackages']['apcupsd'])){
+ if (is_array($config['installedpackages']['apcupsd'])) {
$apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
- if ($apcupsd_config['apcupsdenabled']=="on"){
- $upsname=$apcupsd_config['upsname'];
- $upscable=$apcupsd_config['upscable'];
- $upstype=$apcupsd_config['upstype'];
- $device=($apcupsd_config['device'] != ''? "DEVICE {$apcupsd_config['device']}" : "#DEVICE");
- $polltime=($apcupsd_config['polltime'] != ''? $apcupsd_config['polltime'] : "60");
- $onbatterydelay=($apcupsd_config['onbatterydelay'] != ''? $apcupsd_config['onbatterydelay'] : "6");
- $batterylevel=($apcupsd_config['batterylevel'] != ''? $apcupsd_config['batterylevel'] : "5");
- $minutes=($apcupsd_config['minutes'] != ''? $apcupsd_config['minutes'] : "3");
- $timeout=($apcupsd_config['timeout'] != ''? $apcupsd_config['timeout'] : "0");
- $annoy=($apcupsd_config['annoy'] != ''? $apcupsd_config['annoy'] : "300");
- $annoydelay=($apcupsd_config['annoydelay'] != ''? $apcupsd_config['annoydelay'] : "60");
- $killdelay=($apcupsd_config['killdelay'] != ''? $apcupsd_config['killdelay'] : "0");
- $netserver=$apcupsd_config['netserver'];
- $nisip=($apcupsd_config['nisip'] != ''? $apcupsd_config['nisip'] : "0.0.0.0");
- $nisport=($apcupsd_config['nisport'] != ''? $apcupsd_config['nisport'] : "3551");
- $upsclass=$apcupsd_config['upsclass'];
- $upsmode=$apcupsd_config['upsmode'];
- $lockfile=($apcupsd_config['lockfile'] != ''? $apcupsd_config['lockfile'] : "/var/tmp");
- $emailnotification=$apcupsd_config['emailnotification'];
-
+ if ($apcupsd_config['apcupsdenabled'] == "on") {
+ $upsname = $apcupsd_config['upsname'];
+ $upscable = $apcupsd_config['upscable'];
+ $upstype = $apcupsd_config['upstype'];
+ $device = ($apcupsd_config['device'] != '' ? "DEVICE {$apcupsd_config['device']}" : "#DEVICE");
+ $polltime = $apcupsd_config['polltime'] ?: "60";
+ $onbatterydelay = $apcupsd_config['onbatterydelay'] ?: "6";
+ $batterylevel= $apcupsd_config['batterylevel'] ?: "5";
+ $minutes = $apcupsd_config['minutes'] ?: "3";
+ $timeout = $apcupsd_config['timeout'] ?: "0";
+ $annoy = $apcupsd_config['annoy'] ?: "300";
+ $annoydelay = $apcupsd_config['annoydelay'] ?: "60";
+ $killdelay = $apcupsd_config['killdelay'] ?: "0";
+ $netserver = $apcupsd_config['netserver'];
+ $nisip= $apcupsd_config['nisip'] ?: "0.0.0.0";
+ $nisport = $apcupsd_config['nisport'] ?: "3551";
+ $upsclass = $apcupsd_config['upsclass'];
+ $upsmode = $apcupsd_config['upsmode'];
+ $lockfile= $apcupsd_config['lockfile'] ?: "/var/tmp";
+ $emailnotification = $apcupsd_config['emailnotification'];
+
include("/usr/local/pkg/apcupsd.conf.php");
file_put_contents(APCUPSD_BASE . "/etc/apcupsd/apcupsd.conf", $apcupsdconf, LOCK_EX);
}
}
- // RC FILE
+ // RC FILE
$apcupsd_rcfile="/usr/local/etc/rc.d/apcupsd.sh";
- if (is_array($apcupsd_config) && $apcupsd_config['apcupsdenabled']=="on"){
+ if (is_array($apcupsd_config) && $apcupsd_config['apcupsdenabled']=="on") {
+
$apcupsd_start = "echo \"Starting APC UPS Daemon...\"\n";
$apcupsd_start .= " if [ ! -d {$lockfile} ]; then \n";
$apcupsd_start .= " /bin/mkdir -p {$lockfile} \n";
$apcupsd_start .= " fi \n";
$apcupsd_start .= " /bin/rm -f {$lockfile}/*LCK* 2>/dev/null \n";
- if ($apcupsd_config['killonpowerfail']=="on"){
+ if ($apcupsd_config['killonpowerfail'] == "on") {
$apcupsd_start .= " " . APCUPSD_BASE . "/sbin/apcupsd --kill-on-powerfail";
- }else{
+ } else {
$apcupsd_start .= " " . APCUPSD_BASE . "/sbin/apcupsd";
}
-
- $apcupsd_stop = "echo \"Stopping APC UPS Daemon...\"\n";
+
+ $apcupsd_stop = "echo \"Stopping APC UPS Daemon...\"\n";
$apcupsd_stop .= " /usr/bin/killall apcupsd\n";
$apcupsd_stop .= " /bin/sleep 5";
-
+
/* write out rc.d start/stop file */
write_rcfile(array(
- "file" => "apcupsd.sh",
- "start" => "$apcupsd_start",
- "stop" => "$apcupsd_stop"
- )
+ "file" => "apcupsd.sh",
+ "start" => "$apcupsd_start",
+ "stop" => "$apcupsd_stop"
+ )
);
- mwexec("{$apcupsd_rcfile} restart");
- }else{
- if (file_exists($apcupsd_rcfile)){
- mwexec("{$apcupsd_rcfile} stop");
- unlink($apcupsd_rcfile);
- }
+
+ restart_service("apcupsd");
+
+ } else {
+ stop_service("apcupsd");
+ unlink_if_exists($apcupsd_rcfile);
}
apccontrol_scripts_install($emailnotification);
conf_mount_ro();
}
-function apccontrol_scripts_install($emailnotification){
+function apccontrol_scripts_install($emailnotification) {
global $config, $g;
- // check pfsense version
- $pfs_version = substr(trim(file_get_contents("/etc/version")),0,3);
- if ($pfs_version > 2.0){
+ if ($pfs_version == "2.1" || $pfs_version == "2.2") {
define('APCUPSD_BASE', '/usr/pbi/apcupsd-' . php_uname("m"));
- }
- else {
+ } else {
define('APCUPSD_BASE', '/usr/local');
}
@@ -239,21 +229,21 @@ function apccontrol_scripts_install($emailnotification){
$apcstatus['changeme'] = "\$HOSTNAME - Emergency! UPS batteries have failed. Change them NOW";
$apccontrol_scripts = array("offbattery","onbattery","commfailure","commok","changeme");
- foreach($apccontrol_scripts as $apccontrol_script) {
+ foreach ($apccontrol_scripts as $apccontrol_script) {
- if ($emailnotification == "smtpbuiltin"){
+ if ($emailnotification == "smtpbuiltin") {
- if (is_array($config['installedpackages']['apcupsd'])){
+ if (is_array($config['installedpackages']['apcupsd'])) {
$apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
- if ($apcupsd_config['apcupsdenabled']=="on"){
- $smtphost=($apcupsd_config['smtphost'] != ''? $apcupsd_config['smtphost'] : "0.0.0.0");
- $smtpport=($apcupsd_config['smtpport'] != ''? $apcupsd_config['smtpport'] : "25");
- $smtpfrom=$apcupsd_config['smtpfrom'];
- $smtpto=$apcupsd_config['smtpto'];
- $smtpcc=$apcupsd_config['smtpcc'];
- if(empty($smtpcc)){
+ if ($apcupsd_config['apcupsdenabled'] == "on") {
+ $smtphost = $apcupsd_config['smtphost'] ?: "0.0.0.0";
+ $smtpport = $apcupsd_config['smtpport'] ?: "25";
+ $smtpfrom = $apcupsd_config['smtpfrom'];
+ $smtpto = $apcupsd_config['smtpto'];
+ $smtpcc = $apcupsd_config['smtpcc'];
+ if (empty($smtpcc)) {
$smtpcc_cmd = "";
- }else{
+ } else {
$smtpcc_cmd = "-c {$smtpcc}";
}
}
@@ -261,7 +251,7 @@ function apccontrol_scripts_install($emailnotification){
$pfSense_hostname = gethostname();
- $apccontrol_script_file=<<<EOF
+ $apccontrol_script_file =<<<EOF
#!/bin/sh
HOSTNAME="{$pfSense_hostname}"
@@ -276,8 +266,9 @@ MSG="{$apcstatus["{$apccontrol_script}"]}"
exit 0
EOF;
- }else{
- $apccontrol_script_file=<<<EOF
+
+ } else {
+ $apccontrol_script_file =<<<EOF
#!/bin/sh
/usr/local/bin/php -f /usr/local/pkg/apcupsd_mail.php {$apccontrol_script} > /dev/null
@@ -292,45 +283,41 @@ EOF;
}
-function check_nis_running_apcupsd(){
- global $config, $g;
-
- if (is_array($config['installedpackages']['apcupsd'])){
- $apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
-
- if ($apcupsd_config['apcupsdenabled']=="on" && $apcupsd_config['netserver']=="on" )
- return(true);
- }
+function check_nis_running_apcupsd() {
+ global $config, $g;
- return(false);
+ if (is_array($config['installedpackages']['apcupsd'])) {
+ $apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
+ if ($apcupsd_config['apcupsdenabled'] == "on" && $apcupsd_config['netserver'] == "on" ) {
+ return(true);
+ }
+ } else {
+ return(false);
+ }
}
-
-function check_nis_ip_apcupsd(){
- global $config, $g;
-
- if (is_array($config['installedpackages']['apcupsd'])){
- $apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
-
- if ($apcupsd_config['apcupsdenabled']=="on" && $apcupsd_config['netserver']=="on" )
- return($apcupsd_config['nisip']);
- }
-
- return(false);
+function check_nis_ip_apcupsd() {
+ global $config, $g;
+ if (is_array($config['installedpackages']['apcupsd'])) {
+ $apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
+ if ($apcupsd_config['apcupsdenabled']=="on" && $apcupsd_config['netserver']=="on" ) {
+ return($apcupsd_config['nisip']);
+ }
+ } else {
+ return(false);
+ }
}
-function check_nis_port_apcupsd(){
- global $config, $g;
-
- if (is_array($config['installedpackages']['apcupsd'])){
- $apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
-
- if ($apcupsd_config['apcupsdenabled']=="on" && $apcupsd_config['netserver']=="on" )
- return($apcupsd_config['nisport']);
- }
-
- return(false);
+function check_nis_port_apcupsd() {
+ global $config, $g;
+ if (is_array($config['installedpackages']['apcupsd'])) {
+ $apcupsd_config = $config['installedpackages']['apcupsd']['config'][0];
+ if ($apcupsd_config['apcupsdenabled']=="on" && $apcupsd_config['netserver']=="on" ) {
+ return($apcupsd_config['nisport']);
+ }
+ } else {
+ return(false);
+ }
}
?>
-
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-05 06:09:35 +0000