Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

appmonitor client: finish with existcode instead of die() #142

Merged
merged 1 commit into from
Mar 4, 2025
Merged

appmonitor client: finish with existcode instead of die() #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 69 additions & 50 deletions public_html/client/classes/appmonitor-checks.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,27 @@
* --------------------------------------------------------------------------------<br>
* <br>
* --- HISTORY:<br>
* 2014-10-24 0.5 [email protected]<br>
* 2015-04-08 0.9 [email protected] added sochket test: checkPortTcp<br>
* 2018-06-29 0.24 [email protected] add file and directory checks<br>
* 2018-07-17 0.42 [email protected] add port on mysqli check<br>
* 2018-07-26 0.46 [email protected] fix mysql connection check with empty port param<br>
* 2018-08-14 0.47 [email protected] appmonitor client: use timeout of 5 sec for tcp socket connections<br>
* 2018-08-15 0.49 [email protected] cert check: added flag to skip verification<br>
* 2018-08-23 0.50 [email protected] replace mysqli connect with mysqli real connect (to use a timeout)<br>
* 2018-08-27 0.52 [email protected] add pdo connect (starting with mysql)<br>
* 2018-11-05 0.58 [email protected] additional flag in http check to show content<br>
* 2019-05-31 0.87 [email protected] add timeout as param in connective checks (http, tcp, databases)<br>
* 2019-06-05 0.88 [email protected] add plugins<br>
* 2021-10-28 0.93 [email protected] add plugins<br>
* 2021-12-14 0.93 [email protected] split plugins into single files; added key group in a check<br>
* 2023-06-02 0.125 [email protected] replace array_key_exists for better readability
* 2024-07-22 0.137 [email protected] php 8 only: use typed variables
* 2025-02-28 0.152 [email protected] listChecks: add loop over currently loaded classes
* 2025-03-03 0.153 [email protected] getSize() preg_replace did not work in compiled binary
* 2014-10-24 0.5 [email protected]<br>
* 2015-04-08 0.9 [email protected] added sochket test: checkPortTcp<br>
* 2018-06-29 0.24 [email protected] add file and directory checks<br>
* 2018-07-17 0.42 [email protected] add port on mysqli check<br>
* 2018-07-26 0.46 [email protected] fix mysql connection check with empty port param<br>
* 2018-08-14 0.47 [email protected] appmonitor client: use timeout of 5 sec for tcp socket connections<br>
* 2018-08-15 0.49 [email protected] cert check: added flag to skip verification<br>
* 2018-08-23 0.50 [email protected] replace mysqli connect with mysqli real connect (to use a timeout)<br>
* 2018-08-27 0.52 [email protected] add pdo connect (starting with mysql)<br>
* 2018-11-05 0.58 [email protected] additional flag in http check to show content<br>
* 2019-05-31 0.87 [email protected] add timeout as param in connective checks (http, tcp, databases)<br>
* 2019-06-05 0.88 [email protected] add plugins<br>
* 2021-10-28 0.93 [email protected] add plugins<br>
* 2021-12-14 0.93 [email protected] split plugins into single files; added key group in a check<br>
* 2023-06-02 0.125 [email protected] replace array_key_exists for better readability
* 2024-07-22 0.137 [email protected] php 8 only: use typed variables
* 2025-02-28 0.152 [email protected] listChecks: add loop over currently loaded classes
* 2025-03-03 0.153 [email protected] getSize() preg_replace did not work in compiled binary
* 2025-03-04 0.154 [email protected] finish with existcode instead of die()
* --------------------------------------------------------------------------------<br>
* @version 0.153
* @version 0.154
* @author Axel Hahn
* @link TODO
* @license GPL
Expand Down Expand Up @@ -120,6 +121,25 @@ public function __construct()
// PRIVATE FUNCTIONS
// ----------------------------------------------------------------------

/**
* Exit execution with error message and given exicode.
* @param int $iHttpcode http statuscode
* @param string $sMessage detailed message
* @param int $iExitcode exitcode
* @return never
*/
protected function _exit($iHttpcode, $sMessage, $iExitcode): never
{
$aStatus=[
503 => 'Service Unavailable',
];
header("HTTP/1.1 $iHttpcode $aStatus[$iHttpcode]");
echo "<h1>$iHttpcode $aStatus[$iHttpcode]</h1>
<h2>Details</h2>
$sMessage\n";
exit($iExitcode);
}

/**
* Internal: create basic array values for metadata
* @return boolean
Expand Down Expand Up @@ -204,19 +224,19 @@ protected function _checkArrayKeys($aConfig, $sKeyList)
{
foreach (explode(",", $sKeyList) as $sKey) {
if (!isset($aConfig[$sKey])) {
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>'
. '<h2>Details</h2>'
. __METHOD__ . " - array of check parameters requires the keys [$sKeyList] - but key <code>$sKey</code> was not found in config array."
. "<pre>" . print_r($aConfig, true) . '</pre>'
$this->_exit(
503,
__METHOD__ . " - array of check parameters requires the keys [$sKeyList] - but key <code>$sKey</code> was not found in config array."
. "<pre>" . print_r($aConfig, true) . '</pre>',
20
);
}
if (is_null($aConfig[$sKey])) {
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>'
. '<h2>Details</h2>'
. __METHOD__ . " - key <code>$sKey</code> is empty in config array"
. "<pre>" . print_r($aConfig, true) . '</pre>'
$this->_exit(
503,
__METHOD__ . " - key <code>$sKey</code> is empty in config array"
. "<pre>" . print_r($aConfig, true) . '</pre>',
21
);
}
}
Expand Down Expand Up @@ -266,33 +286,32 @@ public function makeCheck(array $aConfig): array
}

if (!class_exists($sCheckClass)) {
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>'
. '<h2>Details</h2>'
. __METHOD__ . " - check class not found: <code>$sCheckClass</code>"
. "<pre>" . print_r($aConfig, true) . '</pre>'
. "<h2>Known checks</h2>\n" . print_r($this->listChecks(), 1)
$this->_exit(
503,
__METHOD__ . " - check class not found: <code>$sCheckClass</code>"
. "<pre>" . print_r($aConfig, true) . '</pre>',
22
);
}

$oPlugin = new $sCheckClass;
$aResponse = $oPlugin->run($aParams);
if (!is_array($aResponse)) {
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>'
. '<h2>Details</h2>'
. __METHOD__ . " - plugin : $sCheck does not responses an array"
$this->_exit(
503,
__METHOD__ . " - plugin : $sCheck does not responses an array"
. "<pre>INPUT " . print_r($aConfig, true) . '</pre>'
. "<pre>RESPONSE " . print_r($aResponse, true) . '</pre>'
. "<pre>RESPONSE " . print_r($aResponse, true) . '</pre>',
23
);
}
if (count($aResponse) < 2) {
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>'
. '<h2>Details</h2>'
. __METHOD__ . " - plugin : $sCheck does not responses the minimum of 2 array values"
. "<pre>INPUT " . print_r($aConfig, true) . '</pre>'
. "<pre>RESPONSE " . print_r($aResponse, true) . '</pre>'
$this->_exit(
503,
__METHOD__ . " - plugin : $sCheck does not responses the minimum of 2 array values"
. "<pre>INPUT " . print_r($aConfig, true) . '</pre>'
. "<pre>RESPONSE " . print_r($aResponse, true) . '</pre>',
24
);
}
if (!isset($aResponse[2]) || !$aResponse[2]) {
Expand Down Expand Up @@ -427,10 +446,10 @@ protected function _getSize(string $sValue): int
}
$power++;
}
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>'
. '<h2>Details</h2>'
. __METHOD__ . " ERROR in space value parameter - there is no size unit in [$sValue] - allowed size units are " . implode('|', $this->_units)
$this->_exit(
503,
__METHOD__ . " ERROR in space value parameter - there is no size unit in [$sValue] - allowed size units are " . implode('|', $this->_units),
25
);
}

Expand Down
49 changes: 34 additions & 15 deletions public_html/client/classes/appmonitor-client.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@
* 2024-11-22 0.141 [email protected] Set client version to server version after updating http, mysqli and app checks
* 2025-01-02 0.149 [email protected] add getChecks method
* 2025-03-03 0.153 [email protected] fix client checks during development of a compiled binary
* 2025-03-04 0.154 [email protected] finish with existcode instead of die()
* --------------------------------------------------------------------------------<br>
* @version 0.153
* @version 0.154
* @author Axel Hahn
* @link TODO
* @license GPL
Expand All @@ -60,7 +61,7 @@ class appmonitor
* Name and Version number
* @var string
*/
protected string $_sVersion = 'php-client-v0.153';
protected string $_sVersion = 'php-client-v0.154';

/**
* config: default ttl for server before requesting the client check again
Expand Down Expand Up @@ -319,8 +320,11 @@ public function checkIp(array $aAllowedIps = []): bool
return true;
}
}
header('HTTP/1.0 403 Forbidden');
die('ERROR: Your ip address [' . $sIP . '] has no access.');
$this->_exit(
403,
'ERROR: Your ip address [' . $sIP . '] has no access.',
11
);
}

/**
Expand All @@ -340,8 +344,11 @@ public function checkToken(string $sVarname, string $sToken): bool
if (isset($_GET[$sVarname]) && $_GET[$sVarname] === $sToken) {
return true;
}
header('HTTP/1.0 403 Forbidden');
die('ERROR: A token is required.');
$this->_exit(
403,
'ERROR: A token is required.',
12
);
}

// ----------------------------------------------------------------------
Expand Down Expand Up @@ -382,9 +389,11 @@ protected function _checkData(): bool
}

if (count($aErrors)) {
$this->abort(
'<h2>Error: client check is not complete</h2><p>Found errors:</p><ol><li>' . implode('<li>', $aErrors) . '</ol><br><br>'
// .'Dump of your data so far:<pre>' . json_encode($this->getResults(), JSON_PRETTY_PRINT) . '</pre><hr>'
$this->_exit(
503,
'Client check is not complete<br>Found errors:<br>'
.'<ol><li>' . implode('<li>', $aErrors) . '</ol><br><br>',
10
);
}
return true;
Expand All @@ -395,14 +404,24 @@ protected function _checkData(): bool
// ----------------------------------------------------------------------

/**
* Stop processing the client checks and abort with an error
* @param string $sMessage text to show after a 503 headline
* @return void
* Exit execution with error message and given exicode.
* @param int $iHttpcode http statuscode
* @param string $sMessage detailed message
* @param int $iExitcode exitcode
* @return never
*/
public function abort(string $sMessage): void
protected function _exit($iHttpcode, $sMessage, $iExitcode): never
{
header('HTTP/1.0 503 Service Unavailable');
die('<h1>503 Service Unavailable</h1>' . $sMessage);

$aStatus=[
403 => 'Forbidden',
503 => 'Service Unavailable',
];
header("HTTP/1.1 $iHttpcode $aStatus[$iHttpcode]");
echo "<h1>$iHttpcode $aStatus[$iHttpcode]</h1>
<h2>Details</h2>
$sMessage\n";
exit($iExitcode);
}

/**
Expand Down