Select Git revision
check_requirements
appmonitor-checks.class.php 37.37 KiB
<?php
if(!defined('RESULT_OK')){
define("RESULT_OK", 0);
define("RESULT_UNKNOWN", 1);
define("RESULT_WARNING", 2);
define("RESULT_ERROR", 3);
}
/**
* ____________________________________________________________________________
*
* _____ _____ __ _____ _ _
* | | | | ___ ___ ___| |___ ___|_| |_ ___ ___
* |- -| | | | |__ | .'| . | . | | | | . | | | _| . | _|
* |_____|_|_|_|_____| |__,| _| _|_|_|_|___|_|_|_|_| |___|_|
* |_| |_|
* _ _ _
* ___| |_|___ ___| |_
* | _| | | -_| | _|
* |___|_|_|___|_|_|_|
*
* ____________________________________________________________________________
*
* APPMONITOR :: CLASS FOR CLIENT TEST FUNCTIONS<br>
* <br>
* THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE <br>
* LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR <br>
* OTHER PARTIES PROVIDE THE PROGRAM ?AS IS? WITHOUT WARRANTY OF ANY KIND, <br>
* EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED <br>
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE <br>
* ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. <br>
* SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY <br>
* SERVICING, REPAIR OR CORRECTION.<br>
* <br>
* --------------------------------------------------------------------------------<br>
* <br>
* --- HISTORY:<br>
* 2014-10-24 0.5 axel.hahn@iml.unibe.ch<br>
* 2015-04-08 0.9 axel.hahn@iml.unibe.ch added sochket test: checkPortTcp<br>
* 2018-06-29 0.24 axel.hahn@iml.unibe.ch add file and directory checks<br>
* 2018-07-17 0.42 axel.hahn@iml.unibe.ch add port on mysqli check<br>
* 2018-07-26 0.46 axel.hahn@iml.unibe.ch fix mysql connection check with empty port param<br>
* 2018-08-14 0.47 axel.hahn@iml.unibe.ch appmonitor client: use timeout of 5 sec for tcp socket connections<br>
* 2018-08-15 0.49 axel.hahn@iml.unibe.ch cert check: added flag to skip verification<br>
* 2018-08-23 0.50 axel.hahn@iml.unibe.ch replace mysqli connect with mysqli real connect (to use a timeout)<br>
* 2018-08-27 0.52 axel.hahn@iml.unibe.ch add pdo connect (starting with mysql)<br>
* 2018-11-05 0.58 axel.hahn@iml.unibe.ch additional flag in http check to show content<br>
* 2019-05-31 0.87 axel.hahn@iml.unibe.ch add timeout as param in connective checks (http, tcp, databases)<br>
* 2019-06-05 0.88 axel.hahn@iml.unibe.ch add plugins<br>
* --------------------------------------------------------------------------------<br>
* @version 0.91
* @author Axel Hahn
* @link TODO
* @license GPL
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL 3.0
* @package IML-Appmonitor
*/
class appmonitorcheck {
// ----------------------------------------------------------------------
// CONFIG
// ----------------------------------------------------------------------
/**
* config container
* @var array
*/
protected $_aConfig = array();
/** * data of all checks
* @var array
*/
protected $_aData = array();
/**
* flat array with units for sizes
* @var array
*/
protected $_units = array( 'B', 'KB', 'MB', 'GB', 'TB');
/**
* timeout in sec for tcp socket connections
* @var type
*/
protected $_iTimeoutTcp=5;
/**
* point to the plugin directory
* @var string
*/
protected $_sPluginDir=__DIR__.'/../plugins';
// ----------------------------------------------------------------------
// CONSTRUCTOR
// ----------------------------------------------------------------------
/**
* constructor (nothing)
*/
public function __construct() {
}
// ----------------------------------------------------------------------
// PRIVATE FUNCTIONS
// ----------------------------------------------------------------------
/**
* internal: create basic array values for metadata
* @return boolean
*/
protected function _createDefaultMetadata() {
$this->_aData = array(
"name" => $this->_aConfig["name"],
"description" => $this->_aConfig["description"],
"result" => RESULT_UNKNOWN,
"value" => false,
"type" => false,
"time" => false,
);
return true;
}
/**
* set a result value of a check
* @param type $iResult
* @return type
*/
protected function _setResult($iResult) {
return $this->_aData["result"] = (int) $iResult;
}
/**
* set a result value of a check
* @param type $iResult
* @return type
*/ protected function _setOutput($s) {
return $this->_aData["value"] = (string) $s;
}
/**
* put counter data to result set
* @param type $aParams
* @return boolean
*/
protected function _setCounter($aParams){
if(count($aParams)){
foreach(array('type', 'count', 'visual') as $sMyKey){
if(isset($aParams[$sMyKey])){
$this->_aData[$sMyKey]=$aParams[$sMyKey];
}
}
}
return true;
}
/**
* set result and output
* @param integer $iResult value; use a RESULT_XYZ constant
* @param string $s message text
* @param array $aCounter optional: counter with array keys type, count, visual
* @return boolean
*/
protected function _setReturn($iResult, $s, $aCounter=array()) {
$this->_setResult($iResult);
$this->_setOutput($s);
$this->_setCounter($aCounter);
return true;
}
/**
* check a given array if it contains wanted keys
* @param array $aConfig array to verify
* @param string $sKeyList key or keys as comma seprated list
* @return boolean
*/
protected function _checkArrayKeys($aConfig, $sKeyList) {
foreach (explode(",", $sKeyList) as $sKey) {
if (!array_key_exists($sKey, $aConfig)) {
header('HTTP/1.0 503 Service Unavailable');
die('ERROR in ' . __CLASS__ . "<br>array requires the keys [$sKeyList] - but key '$sKey' was not found in config array <pre>" . print_r($aConfig, true));
}
if (is_null($aConfig[$sKey])) {
header('HTTP/1.0 503 Service Unavailable');
die('ERROR in ' . __CLASS__ . "<br> key '$sKey' is empty in config array <pre>" . print_r($aConfig, true));
}
}
return true;
}
// ----------------------------------------------------------------------
// PUBLIC FUNCTIONS
// ----------------------------------------------------------------------
/**
* perform a check
* @param type $aConfig
* Array
* (
* [name] => Dummy
* [description] => Dummy Test
* [check] => array(
* [function] => [check function] // i.e. Simple
* [params] => [array] // optional; arguments for Check function
* // its keys depend on the function
* ) * )
*
* @return array
*/
public function makeCheck($aConfig) {
$this->_iStart = microtime(true);
$this->_checkArrayKeys($aConfig, "name,description,check");
$this->_checkArrayKeys($aConfig["check"], "function");
$this->_aConfig = $aConfig;
$this->_createDefaultMetadata();
$sCheck = "check" . preg_replace('/[^a-zA-Z0-9]/', '', $this->_aConfig["check"]["function"]);
$aParams = array_key_exists("params", $this->_aConfig["check"]) ? $this->_aConfig["check"]["params"] : array();
if (method_exists($this, $sCheck)) {
// load as internal function
call_user_func(array($this, $sCheck), $aParams);
} else {
// load as plugin
$sPluginFile=$this->_sPluginDir.'/'.$sCheck.'.php';
if (file_exists($sPluginFile)) {
require_once($sPluginFile);
$oPlogin = new $sCheck;
$aResponse=$oPlogin->run($aParams);
if(!is_array($aResponse)){
header('HTTP/1.0 503 Service Unavailable');
die(__CLASS__ . " plugin : $sCheck does not responses an array<pre>" . print_r($aResponse, true));
}
if(count($aResponse)<2){
header('HTTP/1.0 503 Service Unavailable');
die(__CLASS__ . " plugin : $sCheck does not responses the minimum of 2 array values<pre>" . print_r($aResponse, true));
}
if(!isset($aResponse[2])){
$aResponse[2]=array();
}
$this->_setReturn($aResponse[0], $aResponse[1], $aResponse[2]);
} else {
header('HTTP/1.0 503 Service Unavailable');
die(__CLASS__ . " check not found: $sCheck <pre>" . print_r($aConfig, true));
}
}
$this->_aData['time'] = number_format((microtime(true) - $this->_iStart) * 1000, 3) . 'ms';
// ... and send response
return $this->respond();
}
/**
* list all available check functions. This is a helper class you can call
* to get an overview over built in functions and plugins.
* You get a flat array with all function names.
* @return array
*/
public function listChecks() {
$aReturn = array();
// return internal protected fuctions named "check[whatever]"
$class = new ReflectionClass($this);
foreach ($class->getMethods(ReflectionMethod::IS_PROTECTED) as $oReflectionMethod) {
if (strpos($oReflectionMethod->name, "check") === 0) {
$aReturn[(string) $oReflectionMethod->name]=1;
}
}
// return checks from plugins subdir
foreach(glob($this->_sPluginDir.'/check*.php') as $sPluginFile){
$aReturn[str_replace('.php', '', basename($sPluginFile))] = 1;
}
ksort($aReturn);
return array_keys($aReturn); }
/**
* final call of class: send response (data array)
* @return type
*/
public function respond() {
return $this->_aData;
}
// ----------------------------------------------------------------------
// CHECK FUNCTIONS (protected)
// ----------------------------------------------------------------------
/**
* helper function: read certificate data
* called in checkCert()
* @param string $sUrl url to connect
* @param boolean $bVerifyCert flag: verify certificate; default: no check
* @return array
*/
protected function _certGetInfos($sUrl, $bVerifyCert) {
$iTimeout=10;
$aUrldata=parse_url($sUrl);
$sHost = isset($aUrldata['host']) ? $aUrldata['host'] : false;
$iPort = isset($aUrldata['port']) ? $aUrldata['port'] : ((isset($aUrldata['scheme']) && $aUrldata['scheme'] === 'https') ? 443 : false);
$aSsl=array('capture_peer_cert' => true);
if($bVerifyCert){
$aSsl['verify_peer']=false;
$aSsl['verify_peer_name']=false;
};
$get = stream_context_create(array('ssl' => $aSsl));
if(!$get){
return array('_error' => 'Error: Cannot create stream_context');
}
$errno=-1;
$errstr="stream_socket_client failed.";
$read = stream_socket_client("ssl://$sHost:$iPort", $errno, $errstr, $iTimeout, STREAM_CLIENT_CONNECT, $get);
if(!$read){
return array('_error' => "Error $errno: $errstr; cannot create stream_socket_client with given stream_context to ssl://$sHost:$iPort; you can try to set the flag [verify] to false to check expiration date only.");
}
$cert = stream_context_get_params($read);
if(!$cert){
return array('_error' => "Error: socket was connected to ssl://$sHost:$iPort - but I cannot read certificate infos with stream_context_get_params ");
}
$certinfo = openssl_x509_parse($cert['options']['ssl']['peer_certificate']);
return $certinfo;
}
/**
* check SSL certificate
* @param array $aParams
* array(
* "url" optional: url to connect check; default: own protocol + server
* "verify" optional: flag for verification of certificate or check for expiration only; default=true (=verification is on)
* "warning" optional: count of days to warn; default=30
* )
* @return boolean
*/
protected function checkCert($aParams) {
$sUrl = isset($aParams["url"])
? $aParams["url"]
: 'http'. ($_SERVER['HTTPS'] ? 's' : '') . '://' . $_SERVER['SERVER_NAME'] .':' . $_SERVER['SERVER_PORT']
;
$bVerify = isset($aParams["verify"]) ? !!$aParams["verify"] : true;
$iWarn = isset($aParams["warning"]) ? (int)($aParams["warning"]) : 30;
$sMessage="Checked url: $sUrl ... ";
$certinfo=$this->_certGetInfos($sUrl, $bVerify);
if(isset($certinfo['_error'])){
$this->_setReturn(RESULT_ERROR, $certinfo['_error'] . $sMessage);
return true;
}
$sDNS=isset($certinfo['extensions']['subjectAltName']) ? $certinfo['extensions']['subjectAltName'] : false;
$sHost=parse_url($sUrl,PHP_URL_HOST);
if(strstr($sDNS, 'DNS:'.$sHost)===false){
$this->_setReturn(RESULT_ERROR, 'Wrong certificate: '.$sHost.' is not listed as DNS alias in ['.$sDNS.'] ' . $sMessage);
return true;
}
$iDaysleft = round(($certinfo['validTo_time_t'] - date('U')) / 60 / 60 / 24);
$sMessage.= 'Issuer: '. $sIssuer=$certinfo['issuer']['O']
. '; valid from: '. date("Y-m-d H:i", $certinfo['validFrom_time_t'])
. ' to '.date("Y-m-d H:i", $certinfo['validTo_time_t']).' '
. ( $iDaysleft ? "($iDaysleft days left)" : "expired since ".(-$iDaysleft)." days.")
;
if ($iDaysleft<0) {
$this->_setReturn(RESULT_ERROR, 'Expired! ' . $sMessage);
return true;
}
if ($iDaysleft<=$iWarn) {
$this->_setReturn(RESULT_WARNING, 'Expires soon. ' . $sMessage);
return true;
}
// echo '<pre>';
$this->_setReturn(RESULT_OK, 'OK. '
.($bVerify ? 'Certificate is valid. ' : '(Verification is disabled; Check for expiration only.) ' )
. $sMessage);
return true;
}
/**
* get human readable space value
* @param type $size
* @return string
*/
protected function _getHrSize($size){
$power = $size > 0 ? floor(log($size, 1024)) : 0;
return number_format($size / pow(1024, $power), 2, '.', ',') . ' ' . $this->_units[$power];
}
/**
* get a space in a real value if an integer has added MB|GB|...
* @param type $sValue
* @return integer
*/
protected function _getSize($sValue){
if(is_int($sValue)){
return $sValue;
}
$power=0;
foreach($this->_units as $sUnit){
if (preg_match('/^[0-9\.\ ]*'.$sUnit.'/', $sValue)){
$i=preg_replace('/([0-9\.]*).*/', '$1', $sValue);
$iReal=$i*pow(1024, $power);
// die("FOUND: $sValue with unit ${sUnit} - 1024^$power * $i = $iReal");
return $iReal;
}
$power++;
}
header('HTTP/1.0 503 Service Unavailable');
die("ERROR in space value parameter - there is no size unit in [$sValue] - allowed size units are " . implode('|', $this->_units));
return false;
}
/**
* check free disk space on a given directory * @param array $aParams
* array(
* "directory" directory that must exist
* "warning" space for warning (optional)
* "critical" minimal space
* )
* @return boolean
*/
protected function checkDiskfree($aParams) {
$this->_checkArrayKeys($aParams, "directory", "critical");
$sDirectory = $aParams["directory"];
if(!is_dir($sDirectory)){
$this->_setReturn(RESULT_ERROR, 'directory [' . $sDirectory . '] does not exist. Maybe it is wrong or is not mounted.');
return true;
}
$iWarn = isset($aParams["warning"]) ? $this->_getSize($aParams["warning"]) : false;
$iCritical = $this->_getSize($aParams["critical"]);
$iSpaceLeft=disk_free_space($sDirectory);
$sMessage='[' . $sDirectory . '] has '.$this->_getHrSize($iSpaceLeft).' left.';
if($iWarn){
if($iWarn<=$iCritical){
header('HTTP/1.0 503 Service Unavailable');
die("ERROR in a Diskfree check - warning value must be larger than critical.<pre>" . print_r($aParams, true));
}
if ($iWarn<$iSpaceLeft){
$this->_setReturn(RESULT_OK, $sMessage.' Warning level is not reached yet (still '.$this->_getHrSize($iSpaceLeft-$iWarn).' over warning limit).');
return true;
}
if ($iWarn>$iSpaceLeft && $iCritical<$iSpaceLeft){
$this->_setReturn(RESULT_WARNING, $sMessage.' Warning level '.$this->_getHrSize($iWarn).' was reached (space is '.$this->_getHrSize($iWarn-$iSpaceLeft).' below warning limit; still '.$this->_getHrSize($iSpaceLeft-$iCritical).' over critical limit).');
return true;
}
}
// check space
if ($iCritical<$iSpaceLeft){
$this->_setReturn(RESULT_OK, $sMessage .' Minimum is not reached yet (still '.$this->_getHrSize($iSpaceLeft-$iCritical).' over critical limit).');
} else {
$this->_setReturn(RESULT_ERROR, $sMessage);
}
return true;
}
/**
* check a file
* @param array $aParams
* array(
* "filename" directory that must exist
* "exists" "filename" must exist/ must be absent
* "dir" filetype directory
* "file" filetype file
* "link" filetype symbolic link
* "executable" flag executable
* "readable" flag is readable
* "writable" flag is writable
* )
* @return boolean
*/
protected function checkFile($aParams) {
$aOK = array();
$aErrors = array();
$this->_checkArrayKeys($aParams, "filename");
$sFile = $aParams["filename"];
if (isset($aParams['exists'])) {
$sMyflag = 'exists=' . ($aParams['exists'] ? 'yes' : 'no');
if (file_exists($sFile) && $aParams['exists']) { $aOK[] = $sMyflag;
} else {
$aErrors[] = $sMyflag;
}
}
foreach (array('dir', 'executable', 'file', 'link', 'readable', 'writable') as $sFiletest) {
if (isset($aParams[$sFiletest])) {
$sTestCmd = 'return is_' . $sFiletest . '("' . $sFile . '");';
if (eval($sTestCmd) && $aParams[$sFiletest]) {
$aOK[] = $sFiletest . '=' . ($aParams[$sFiletest] ? 'yes' : 'no');
} else {
$aErrors[] = $sFiletest . '=' . ($aParams[$sFiletest] ? 'yes' : 'no');
}
}
}
$sMessage = (count($aOK) ? ' flags OK: ' . implode('|', $aOK) : '')
. ' ' . (count($aErrors) ? ' flags FAILED: ' . implode('|', $aErrors) : '')
;
if (count($aErrors)) {
$this->_setReturn(RESULT_ERROR, 'file test [' . $sFile . '] ' . $sMessage);
} else {
$this->_setReturn(RESULT_OK, 'file test [' . $sFile . '] ' . $sMessage);
}
return true;
}
/**
* compare function for 2 values
* @param any $verifyValue search value
* @param string $sCompare compare function; it is one of
* IS -
* GE - greater or equal
* GT - greater
* @param any $value existing value
* @return boolean
*/
protected function _compare($value, $sCompare, $verifyValue){
switch ($sCompare){
case "IS":
return $value===$verifyValue;
break;
case "GE":
return $value>=$verifyValue;
break;
case "GT":
return $value>$verifyValue;
break;
case "HAS":
return !!(strstr($value, $verifyValue)!==false);
break;
default:
die("FATAL ERROR: a compare function [$sCompare] is not implemented (yet).");
break;
}
return false;
}
/**
* make http request and test response body
* @param array $aParams
* array(
* url string url to fetch
* timeout integer optional timeout in sec; default: 5
* headeronly boolean optional flag to fetch http response herader only; default: false = returns header and body
* follow boolean optional flag to follow a location; default: false = do not follow
* status integer test for an expected http status code; if none is given then test fails on status 400 and greater
* headercontains string test for a string in the http response header; it returns OK if the text was found
* headernotcontains string test for a string in the http response header; it returns OK if the text was not found * headerregex string test for a regex in the http response header; it returns OK if the regex matches; example: "headerregex"=>"/lowercasematch/i"
* bodycontains string test for a string in the http response body; it returns OK if the text was found
* bodynotcontains string test for a string in the http response body; it returns OK if the text was not found
* bodyregex string test for a regex in the http response body; it returns OK if the regex matches; example: "headerregex"=>"/lowercasematch/i"
* )
*/
protected function checkHttpContent($aParams) {
$this->_checkArrayKeys($aParams, "url");
if (!function_exists("curl_init")) {
header('HTTP/1.0 503 Service Unavailable');
die("ERROR: PHP CURL module is not installed.");
}
$bShowContent = (isset($aParams["content"]) && $aParams["content"]) ? true : false;
$ch = curl_init($aParams["url"]);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_NOBODY, isset($aParams["headeronly"]) && $aParams["headeronly"]);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, isset($aParams["follow"]) && $aParams["follow"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_TIMEOUT, (isset($aParams["timeout"]) && (int)$aParams["timeout"]) ? (int)$aParams["timeout"] : $this->_iTimeoutTcp);
$res = curl_exec($ch);
if (!$res) {
$this->_setReturn(RESULT_ERROR, 'ERROR: failed to fetch ' . $aParams["url"] . '.');
return false;
}
$sOut='';
$bError=false;
$aInfos = curl_getinfo($ch);
/*
Array
(
[url] => https://www.iml.unibe.ch/
[content_type] => text/html; charset=utf-8
[http_code] => 200
[header_size] => 926
[request_size] => 55
[filetime] => -1
[ssl_verify_result] => 20
[redirect_count] => 0
[total_time] => 1.812
[namelookup_time] => 0
[connect_time] => 0
[pretransfer_time] => 0.015
[size_upload] => 0
[size_download] => 94654
[speed_download] => 52237
[speed_upload] => 0
[download_content_length] => -1
[upload_content_length] => -1
[starttransfer_time] => 1.812
[redirect_time] => 0
[redirect_url] =>
[primary_ip] => 130.92.30.80
[certinfo] => Array
(
)
[primary_port] => 443
[local_ip] => 10.1.30.49
[local_port] => 63597
)
*/
curl_close($ch);
$aTmp=explode("\r\n\r\n", $res, 2);
$sHttpHeader=$aTmp[0]; $sHttpBody=isset($aTmp[1]) ? $aTmp[1] : false;
// ---------- check functions
// --- http status code
$sOut.="Http status: ".$aInfos['http_code']." - ";
if(isset($aParams["status"])){
if($aInfos['http_code'] === $aParams["status"]){
$sOut.="compare OK<br>";
} else {
$sOut.="compare failed<br>";
$bError=true;
}
} else {
if($aInfos['http_code'] >= 400){
$sOut.="Error page detected<br>";
$bError=true;
} else {
$sOut.="request successful<br>";
}
}
// --- http header
if(isset($aParams["headercontains"]) && $aParams["headercontains"]){
$sOut.="Http header contains "".$aParams["headercontains"]."" - ";
if(!strstr($sHttpHeader, $aParams["headercontains"])===false){
$sOut.="compare OK<br>";
} else {
$sOut.="compare failed<br>";
$bError=true;
}
}
if(isset($aParams["headernotcontains"]) && $aParams["headernotcontains"]){
$sOut.="Http header does not contain "".$aParams["headernotcontains"]."" - ";
if(strstr($sHttpHeader, $aParams["headernotcontains"])===false){
$sOut.="compare OK<br>";
} else {
$sOut.="compare failed<br>";
$bError=true;
}
}
if(isset($aParams["headerregex"]) && $aParams["headerregex"]){
$sOut.="Http header regex test "".$aParams["headerregex"]."" - ";
try{
$bRegex=preg_match($aParams["headerregex"], $sHttpHeader);
if($bRegex){
$sOut.="compare OK<br>";
} else {
$sOut.="compare failed<br>";
$bError=true;
}
}
catch(Exception $e){
$sOut.="Wrong REGEX<br>" . print_r($e, 1).'<br>';
$bError=true;
}
}
// --- http body
if(isset($aParams["bodycontains"]) && $aParams["bodycontains"]){
$sOut.="Http body contains "".$aParams["bodycontains"]."" - ";
if(!strstr($sHttpBody, $aParams["bodycontains"])===false){
$sOut.="compare OK<br>";
} else {
$sOut.="compare failed<br>";
$bError=true;
}
}
if(isset($aParams["bodynotcontains"]) && $aParams["bodynotcontains"]){
$sOut.="Http body does not contain "".$aParams["bodynotcontains"]."" - ";
if(strstr($sHttpBody, $aParams["bodynotcontains"])===false){
$sOut.="compare OK<br>"; } else {
$sOut.="compare failed<br>";
$bError=true;
}
}
if(isset($aParams["bodyregex"]) && $aParams["bodyregex"]){
$sOut.="Http body regex test "".$aParams["bodyregex"]."" - ";
try{
$bRegex=preg_match($aParams["bodyregex"], $sHttpBody);
if($bRegex){
$sOut.="compare OK<br>";
} else {
$sOut.="compare failed<br>";
$bError=true;
}
}
catch(Exception $e){
$sOut.="Wrong REGEX<br>" . print_r($e, 1).'<br>';
$bError=true;
}
}
if (!$bError) {
$this->_setReturn(RESULT_OK,
'OK: http check "' . $aParams["url"] . '".<br>'.$sOut
);
} else {
$this->_setReturn(RESULT_ERROR,
'ERROR: http check "' . $aParams["url"] . '".<br>'.$sOut
);
}
/*
echo '<pre>';
echo $sOut."<hr>";
echo "<hr>HEADER: ".htmlentities($sHttpHeader)."<hr>";
print_r($aParams); print_r($aInfos);
// echo htmlentities($sHttpBody);
die();
*/
return true;
}
/**
* check mysql connection to a database using mysqli realconnect
* @param array $aParams
* array(
* server string database hostname / ip address
* user string db user
* password string password for db user
* db string schema / database name
* port integer optional: port
* timeout integer optional timeout in sec; default: 5
* )
*/
protected function checkMysqlConnect($aParams) {
$this->_checkArrayKeys($aParams, "server,user,password,db");
$mysqli=mysqli_init();
if(!$mysqli){
$this->_setReturn(RESULT_ERROR, 'ERROR: mysqli_init failed.');
return false;
}
if (!$mysqli->options(MYSQLI_OPT_CONNECT_TIMEOUT, (isset($aParams["timeout"]) && (int)$aParams["timeout"]) ? (int)$aParams["timeout"] : $this->_iTimeoutTcp)) {
$this->_setReturn(RESULT_ERROR, 'ERROR: setting mysqli_init failed.');
return false;
}
$db = (isset($aParams["port"]) && $aParams["port"])
? $mysqli->real_connect($aParams["server"], $aParams["user"], $aParams["password"], $aParams["db"], $aParams["port"])
: $mysqli->real_connect($aParams["server"], $aParams["user"], $aParams["password"], $aParams["db"]) ;
if ($db) {
$this->_setReturn(RESULT_OK, "OK: Mysql database " . $aParams["db"] . " was connected");
$mysqli->close();
return true;
} else {
$this->_setReturn(RESULT_ERROR, "ERROR: Mysql database " . $aParams["db"] . " was not connected. Error ".mysqli_connect_errno() .": ". mysqli_connect_error());
return false;
}
}
/**
* check connection to a database using pdo
* see http://php.net/manual/en/pdo.drivers.php
*
* @param array $aParams
* array(
* connect string connect string
* user string db user
* password string password for db user
* timeout integer optional timeout in sec; default: 5
* )
*/
protected function checkPdoConnect($aParams) {
$this->_checkArrayKeys($aParams, "connect,user,password");
try{
$db = new PDO(
$aParams['connect'],
$aParams['user'],
$aParams['password'],
array(
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
// timeout
// Not all drivers support this option; mysqli does
PDO::ATTR_TIMEOUT => (isset($aParams["timeout"]) && (int)$aParams["timeout"]) ? (int)$aParams["timeout"] : $this->_iTimeoutTcp,
// mssql
// PDO::SQLSRV_ATTR_QUERY_TIMEOUT => $this->_iTimeoutTcp,
)
);
$this->_setReturn(RESULT_OK, "OK: Database was connected with PDO " . $aParams['connect']);
$db=null;
return true;
} catch(PDOException $e) {
$this->_setReturn(RESULT_ERROR, "ERROR: Database was not connected " . $aParams['connect'] . " was not connected. Error ".$e->getMessage());
return false;
}
}
/**
* check if system is listening to a given port
* @param array $aParams
* array(
* port integer port
* host string optional hostname to connect; default: 127.0.0.1
* timeout integer optional timeout in sec; default: 5
* )
* @return boolean
*/
protected function checkPortTcp($aParams) {
$this->_checkArrayKeys($aParams, "port");
$sHost = array_key_exists('host', $aParams) ? $aParams['host'] : '127.0.0.1';
$iPort = (int) $aParams['port'];
// from http://php.net/manual/de/sockets.examples.php
$socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if ($socket === false) {
$this->_setReturn(RESULT_UNKNOWN, "ERROR: $sHost:$iPort was not checked. socket_create() failed: " . socket_strerror(socket_last_error())); return false;
}
// set socket timeout
socket_set_option(
$socket,
SOL_SOCKET, // socket level
SO_SNDTIMEO, // timeout option
array(
"sec"=>(isset($aParams["timeout"]) && (int)$aParams["timeout"]) ? (int)$aParams["timeout"] : $this->_iTimeoutTcp, // timeout in seconds
"usec"=>0
)
);
$result = socket_connect($socket, $sHost, $iPort);
if ($result === false) {
$this->_setReturn(RESULT_ERROR, "ERROR: $sHost:$iPort failed. " . socket_strerror(socket_last_error($socket)));
socket_close($socket);
return false;
} else {
$this->_setReturn(RESULT_OK, "OK: $sHost:$iPort was connected.");
socket_close($socket);
return true;
}
}
/**
* most simple check: set given values
* Use this function to add a counter
*
* @param array $aParams
* array keys:
* value string description text
* result integer RESULT_nn
*
* brainstorming for a future release
*
* "counter" optioal: array of counter values
* - label string a label
* - value float a number
* - type string one of simple | bar | line
*
*/
protected function checkSimple($aParams) {
$this->_checkArrayKeys($aParams, "result,value");
$this->_setReturn((int) $aParams["result"], $aParams["value"]);
foreach(array('type', 'count', 'visual') as $sMyKey){
if(isset($aParams[$sMyKey])){
$this->_aData[$sMyKey]=$aParams[$sMyKey];
}
}
return true;
}
/**
* check sqlite connection
* @param array $aParams
* array(
* db string full path of sqlite file
* timeout integer optional timeout in sec; default: 5
* )
* @return boolean
*/
protected function checkSqliteConnect($aParams) {
$this->_checkArrayKeys($aParams, "db");
if (!file_exists($aParams["db"])) {
$this->_setReturn(RESULT_ERROR, "ERROR: Sqlite database file " . $aParams["db"] . " does not exist.");
return false;
}
if(!isset($aParams['user'])){
$aParams['user']=''; }
if(!isset($aParams['password'])){
$aParams['password']='';
}
try {
// $db = new SQLite3($sqliteDB);
// $db = new PDO("sqlite:".$sqliteDB);
$o = new PDO("sqlite:" . $aParams["db"],
$aParams['user'],
$aParams['password'],
array(
PDO::ATTR_TIMEOUT => (isset($aParams["timeout"]) && (int)$aParams["timeout"]) ? (int)$aParams["timeout"] : $this->_iTimeoutTcp,
)
);
$this->_setReturn(RESULT_OK, "OK: Sqlite database " . $aParams["db"] . " was connected");
return true;
} catch (Exception $e) {
$this->_setReturn(RESULT_ERROR, "ERROR: Sqlite database " . $aParams["db"] . " was not connected. " . $e->getMessage());
return false;
}
}
}