Files
cacti/script_server.php
T

359 lines
11 KiB
PHP

<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2017 The Cacti Group |
| |
| This program is free software; you can redistribute it and/or |
| modify it under the terms of the GNU General Public License |
| as published by the Free Software Foundation; either version 2 |
| of the License, or (at your option) any later version. |
| |
| This program is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| GNU General Public License for more details. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDTool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
/* do NOT run this script through a web browser */
if (!isset($_SERVER['argv'][0]) || isset($_SERVER['REQUEST_METHOD']) || isset($_SERVER['REMOTE_ADDR'])) {
die('<br><strong>This script is only meant to run at the command line.</strong>');
}
$no_http_headers = true;
declare(ticks = 1);
/* need to capture signals from users */
function sig_handler($signo) {
global $include_file, $function, $parameters;
switch ($signo) {
case SIGTERM:
case SIGINT:
case SIGABRT:
case SIGQUIT:
case SIGSEGV:
cacti_log("WARNING: Script Server terminated with signal '$signo' in file:'" . basename($include_file) . "', function:'$function', params:'$parameters'", FALSE, 'PHPSVR');
db_close();
exit;
break;
default:
cacti_log("WARNING: Script Server received signal '$signo' in file:'$include_file', function:'$function', params:'$parameters'", FALSE, 'PHPSVR');
break;
}
}
/* used for includes */
/* install signal handlers for UNIX only */
if (function_exists('pcntl_signal')) {
pcntl_signal(SIGTERM, 'sig_handler');
pcntl_signal(SIGINT, 'sig_handler');
pcntl_signal(SIGABRT, 'sig_handler');
pcntl_signal(SIGQUIT, 'sig_handler');
pcntl_signal(SIGSEGV, 'sig_handler');
}
error_reporting(0);
include_once(dirname(__FILE__) . '/include/global.php');
/* define STDOUT/STDIN file descriptors if not running under CLI */
if (php_sapi_name() != 'cli') {
define('STDIN', fopen('php://stdin', 'r'));
define('STDOUT', fopen('php://stdout', 'w'));
}
/* signal for realtime */
global $environ, $poller_id;
/* record the script start time */
$start = microtime(true);
/* some debugging */
$pid = getmypid();
$ctr = 0;
/* if multiple polling intervals are defined, compensate for them */
$polling_interval = read_config_option('poller_interval');
if (!empty($polling_interval)) {
$num_polling_items = db_fetch_cell_prepared('SELECT count(*) FROM poller_item WHERE rrd_next_step <= 0 AND poller_id = ?', array($config['poller_id']), 'count(*)');
define('MAX_POLLER_RUNTIME', $polling_interval);
} else {
$num_polling_items = db_fetch_cell_prepared('SELECT count(*) FROM poller_item WHERE poller_id = ?', array($config['poller_id']), 'count(*)');
define('MAX_POLLER_RUNTIME', 300);
}
/* Let PHP only run 1 second longer than the max runtime */
ini_set('max_execution_time', MAX_POLLER_RUNTIME + 1);
/* Record the calling environment */
if ($_SERVER['argc'] >= 2) {
if ($_SERVER['argv'][1] == 'spine')
$environ = 'spine';
else
if (($_SERVER['argv'][1] == 'cmd.php') || ($_SERVER['argv'][1] == 'cmd'))
$environ = 'cmd';
elseif ($_SERVER['argv'][1] == 'realtime')
$environ = 'realtime';
else
$environ = 'other';
if ($_SERVER['argc'] == 3)
$poller_id = $_SERVER['argv'][2];
else
$poller_id = 1;
} else {
$environ = 'cmd';
$poller_id = 1;
}
cacti_log('DEBUG: SERVER: ' . $environ, false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
if ($config['cacti_server_os'] == 'win32') {
cacti_log('DEBUG: GETCWD: ' . strtolower(strtr(getcwd(),"\\",'/')), false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
cacti_log('DEBUG: DIRNAM: ' . strtolower(strtr(dirname(__FILE__),"\\",'/')), false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
} else {
cacti_log('DEBUG: GETCWD: ' . strtr(getcwd(),"\\",'/'), false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
cacti_log('DEBUG: DIRNAM: ' . strtr(dirname(__FILE__),"\\",'/'), false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
}
cacti_log('DEBUG: FILENM: ' . __FILE__, false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
/* send status back to the server */
cacti_log('PHP Script Server has Started - Parent is ' . $environ, false, 'PHPSVR', POLLER_VERBOSITY_HIGH);
fputs(STDOUT, 'PHP Script Server has Started - Parent is ' . $environ . "\n");
fflush(STDOUT);
/* process waits for input and then calls functions as required */
while (1) {
$result = '';
$input_string = fgets(STDIN, 1024);
$function = '';
$parameters = '';
$parameter_array = array();
if ($input_string !== FALSE) {
$input_string = trim($input_string);
if (substr($input_string,0,4) == 'quit') {
fputs(STDOUT, 'PHP Script Server Shutdown request received, exiting\n');
fflush(STDOUT);
cacti_log('DEBUG: PHP Script Server Shutdown request received, exiting', false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
db_close();
exit(0);
}
if (strlen($input_string)) {
/* pull off the parameters */
$i = 0;
while ( true ) {
$pos = strpos($input_string, ' ');
if ($pos > 0) {
switch ($i) {
case 0:
/* cut off include file as first part of input string and keep rest for further parsing */
$include_file = trim(substr($input_string,0,$pos));
$input_string = trim(strchr($input_string, ' ')) . ' ';
break;
case 1:
/* cut off function as second part of input string and keep rest for further parsing */
$function = trim(substr($input_string,0,$pos));
$input_string = trim(strchr($input_string, ' ')) . ' ';
break;
case 2:
/* take the rest as parameter(s) to the function stripped off previously */
$parameters = trim($input_string);
break 2;
}
} else {
break;
}
$i++;
}
if (!parseArgs($parameters, $parameter_array)) {
cacti_log("WARNING: Script Server count not parse '$parameters' for $function", false, 'PHPSVR');
fputs(STDOUT, "U\n");
fflush(STDOUT);
continue;
}
cacti_log("DEBUG: PID[$pid] CTR[$ctr] INC: '". basename($include_file) . "' FUNC: '" .$function . "' PARMS: '" . $parameters . "'", false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
/* validate the existance of the function, and include if applicable */
if (!function_exists($function)) {
if (file_exists($include_file)) {
/* quirk in php on Windows, believe it or not.... */
/* path must be lower case */
if ($config['cacti_server_os'] == 'win32') {
$include_file = strtolower($include_file);
}
/* set this variable so the calling script can determine if it was called
* by the script server or stand-alone */
$called_by_script_server = true;
/* turn on output buffering to avoid problems with nasty scripts */
ob_start();
include_once($include_file);
ob_end_clean();
} else {
cacti_log('WARNING: PHP Script File to be included, does not exist', false, 'PHPSVR');
}
}
if (function_exists($function)) {
if ($parameters == '') {
$result = call_user_func($function);
} else {
$result = call_user_func_array($function, $parameter_array);
}
fputs(STDOUT, trim($result) . "\n");
fflush(STDOUT);
cacti_log("DEBUG: PID[$pid] CTR[$ctr] RESPONSE:'$result'", false, 'PHPSVR', POLLER_VERBOSITY_DEBUG);
$ctr++;
} else {
cacti_log("WARNING: Function does not exist INC: '". basename($include_file) . "' FUNC: '" .$function . "' PARMS: '" . $parameters . "'", false, 'PHPSVR');
fputs(STDOUT, "U\n");
fflush(STDOUT);
}
}
} else {
cacti_log('ERROR: Input Expected, Script Server Terminating', false, 'PHPSVR');
fputs(STDOUT, "ERROR: Input Expected, Script Server Terminating\n");
fflush(STDOUT);
exit (-1);
}
/* end the process if the runtime exceeds MAX_POLLER_RUNTIME */
if (($start + MAX_POLLER_RUNTIME) < time()) {
cacti_log('Maximum runtime of ' . MAX_POLLER_RUNTIME . ' seconds exceeded for the Script Server. Exiting.', true, 'PHPSVR');
exit (-1);
}
}
function parseArgs($string, &$str_list, $debug = false) {
$delimiters = array("'",'"');
$delimited = false;
$str_list = array();
if ($debug) echo "String: '" . $string . "'\n";
foreach($delimiters as $delimiter) {
if (strpos($string, $delimiter) !== false) {
$delimited = true;
break;
}
}
/* process the simple case */
if (!$delimited) {
$str_list = explode(' ', $string);
if ($debug) echo "Output: '" . implode(",", $str_list) . "'\n";
return true;
}
/* Break str down into an array of characters and process */
$char_array = str_split($string);
$escaping = false;
$indelim = false;
$parse_ok = true;
$curstr = '';
foreach($char_array as $char) {
switch ($char) {
case '\'':
case '"':
if (!$indelim) {
if (!$escaping) {
$indelim = true;
} else {
$curstr .= $char;
$escaping = false;
}
} elseif (!$escaping) {
$str_list[] = $curstr;
$curstr = '';
$indelim = false;
} elseif ($escaping) {
$curstr .= $char;
$escaping = false;
}
break;
case '\\':
if ($escaping) {
$curstr .= $char;
$escaping = false;
} else {
$escaping = true;
}
break;
case ' ':
if ($escaping) {
$parse_ok = false;
$msg = 'Parse error attempting to parse string';
} elseif ($indelim) {
$curstr .= $char;
} elseif (strlen($curstr)) {
$str_list[] = $curstr;
$curstr = '';
}
break;
case '`':
$parse_ok = false;
$msg = 'Backtic (`) characters not allowed';
break;
default:
if ($escaping) {
$parse_ok = false;
$msg = 'Parse error attempting to parse string';
} else {
$curstr .= $char;
}
break;
}
if (!$parse_ok) {
break;
}
}
/* Add the last str to the string array */
if ($indelim || $escaping) {
$parse_ok = false;
$msg = 'Parse error attempting to parse string';
}
if (!$parse_ok) {
echo 'ERROR: ' . $msg . " '" . $string . "'\n";
} elseif (strlen($curstr)) {
$str_list[] = $curstr;
}
if ($debug) echo "Output: '" . implode(",", $str_list) . "'\n";
return $parse_ok;
}