<?php
/**
* Copyright 2014-2016 AGH Strategies, LLC
* Released under the Affero GNU Public License version 3
* but with NO WARRANTY: neither the implied warranty of merchantability
* nor fitness for a particular purpose
*
* Place in /usr/lib/nagios/plugins
*
* Call with the commands:
* /usr/bin/php /usr/lib/nagios/plugins/check_civicrm.php $HOSTADDRESS$ $_HOSTHTTP$ $_HOSTCMS$ $_HOSTSITE_KEY$ $_HOSTAPI_KEY$ cron
* and
* /usr/bin/php /usr/lib/nagios/plugins/check_civicrm.php $HOSTADDRESS$ $_HOSTHTTP$ $_HOSTCMS$ $_HOSTSITE_KEY$ $_HOSTAPI_KEY$ version
*
* in the host definition, provide the following custom variables:
* _http [http|https]
* _cms [drupal|joomla|wordpress]
* _site_key {your site key from settings.php}
* _api_key {an api key set on the civicrm_contact row corresponding to an admin user}
*/
$prot = ($argv[2] == 'https') ? 'https' : 'http';
// Specify a user header for file_get_contents.
$userAgent = array('http' => array('user_agent' => 'CiviMonitor'));
$streamContext = stream_context_create($userAgent);
switch (strtolower($argv[3])) {
case 'joomla':
$path = 'administrator/components/com_civicrm/civicrm';
break;
case 'wordpress':
$path = 'wp-content/plugins/civicrm/civicrm';
break;
case 'drupal':
default:
$path = 'sites/all/modules/civicrm';
}
switch (strtolower($argv[6])) {
case 'version':
$result = file_get_contents("$prot://{$argv[1]}/$path/extern/rest.php?entity=domain&action=get&key={$argv[4]}&api_key={$argv[5]}&return=version&json=1",false,$streamContext);
$latest = file_get_contents('http://latest.civicrm.org/stable.php?format=json');
$a = json_decode($result, TRUE);
if ($a["is_error"] != 1 && is_array($a['values'])) {
foreach ($a["values"] as $id => $attrib) {
if (isset($attrib['version'])) {
$status = array(3, "Unknown version status ({$attrib['version']})");
$latest = json_decode($latest, TRUE);
ksort($latest, SORT_NUMERIC);
list($m, $mm) = explode('.', $attrib['version']);
if (isset($latest["{$m}.{$mm}"])) {
if (isset($latest["{$m}.{$mm}"]['status'])) {
if (version_compare("{$m}.{$mm}", '4.4') < 0) {
echo "Much newer version available (currently on {$attrib['version']})";
exit(2);
}
else {
if ($latest["{$m}.{$mm}"]['status'] == 'lts') {
$latest["{$m}.{$mm}"]['status'] = 'LTS';
}
$versionDisplay = $attrib['version'] . ' ' . $latest["{$m}.{$mm}"]['status'];
}
}
else {
$versionDisplay = "{$attrib['version']} (unknown major version status)";
}
foreach ($latest["{$m}.{$mm}"]['releases'] as $info) {
if (version_compare($attrib['version'], $info['version']) < 0) {
if (isset($info['security']) && $info['security']) {
$status = array(2, "Security upgrade needed (currently on $versionDisplay)");
break;
}
else {
$status = array(1, "Newer version available (currently on $versionDisplay)");
}
}
elseif (version_compare($attrib['version'], $info['version']) == 0) {
$status = array(0, "Version $versionDisplay up-to-date");
}
}
}
echo $status[1];
exit($status[0]);
}
}
}
echo 'Unknown error';
exit(3);
case 'cron':
$result = file_get_contents("$prot://{$argv[1]}/$path/extern/rest.php?entity=setting&action=get&key={$argv[4]}&api_key={$argv[5]}&return=lastCron&json=1",false,$streamContext);
$a = json_decode($result, TRUE);
if ($a["is_error"] != 1 && is_array($a['values'])) {
foreach ($a["values"] as $id => $attrib) {
if (empty($attrib['lastCron'])) {
echo 'Last cron date not found';
exit (3);
}
if ($attrib['lastCron'] > gmdate('U') - 3600) {
echo 'Last cron at ' . date('r', $attrib['lastCron']);
exit(0);
}
elseif ($attrib['lastCron'] > gmdate('U') - 86400) {
echo 'Last cron at ' . date('r', $attrib['lastCron']);
exit(1);
}
elseif ($attrib['lastCron'] <= gmdate('U') - 86400) {
echo 'Last cron at ' . date('r', $attrib['lastCron']);
exit(2);
}
}
}
echo 'Unknown error';
exit(3);
case 'extensions':
$result = file_get_contents("$prot://{$argv[1]}/$path/extern/rest.php?entity=monitor&action=getextensions&key={$argv[4]}&api_key={$argv[5]}&json=1",false,$streamContext);
$a = json_decode($result, TRUE);
if ($a["is_error"] != 1 && is_array($a['values'])) {
foreach ($a["values"] as $attrib) {
echo filter_var($attrib['message'], FILTER_SANITIZE_STRING);
$exit = intval($attrib['status']);
if ($exit > 3 || $exit < 0 || !is_numeric($attrib['status'])) {
$exit = 3;
echo ' Unknown exit status';
}
exit($exit);
}
}
echo 'Unknown error';
exit(3);
case 'paymentprocessors':
$result = file_get_contents("$prot://{$argv[1]}/$path/extern/rest.php?entity=monitor&action=getpaymentprocessors&key={$argv[4]}&api_key={$argv[5]}&json=1",false,$streamContext);
$a = json_decode($result, TRUE);
if ($a["is_error"] != 1 && is_array($a['values'])) {
$display = array();
foreach ($a["values"] as $id => $attrib) {
$echo = '';
if (!empty($attrib['title'])) {
$echo = $attrib['title'];
if (!empty($attrib['type'])) {
$echo .= " ({$attrib['type']})";
}
}
elseif (!empty($attrib['type'])) {
$echo = $attrib['type'];
}
if (strlen($echo)) {
$display[] = $echo;
}
}
if (count($display)) {
echo implode(', ', $display);
exit(0);
}
else {
echo 'No payment processors';
exit(1);
}
}
echo 'Unknown error';
exit(3);
case 'mailing':
$result = file_get_contents("$prot://{$argv[1]}/$path/extern/rest.php?entity=monitor&action=getmailingbackend&key={$argv[4]}&api_key={$argv[5]}&json=1",false,$streamContext);
$a = json_decode($result, TRUE);
if ($a["is_error"] != 1 && is_array($a['values'])) {
foreach ($a["values"] as $attrib) {
echo filter_var($attrib['message'], FILTER_SANITIZE_STRING);
$exit = intval($attrib['status']);
if ($exit > 3 || $exit < 0 || !is_numeric($attrib['status'])) {
$exit = 3;
echo ' Unknown exit status';
}
exit($exit);
}
}
echo 'Unknown error';
exit(3);
case 'system':
$request = array(
'entity' => 'system',
'action' => 'check',
'key' => $argv[4],
'api_key' => $argv[5],
'json' => 1,
);
$options = array(
'http' => array(
'header' => "Content-type: application/x-www-form-urlencoded\r\nUser-Agent: CiviMonitor\r\n",
'method' => 'POST',
'content' => http_build_query($request),
),
);
$context = stream_context_create($options);
$result = file_get_contents("$prot://{$argv[1]}/$path/extern/rest.php", FALSE, $context);
$a = json_decode($result, TRUE);
if ($a["is_error"] != 1 && is_array($a['values'])) {
$exit = 0;
$message = array();
foreach ($a["values"] as $attrib) {
// first check for missing info
$neededKeys = array(
'title' => TRUE,
'message' => TRUE,
'name' => TRUE,
);
if (array_intersect_key($neededKeys, $attrib) != $neededKeys) {
$message[] = 'Missing keys: ' . implode(', ', array_diff($neededKeys, array_intersect_key($neededKeys, $attrib))) . '.';
$exit = 3;
continue;
}
$message[] = filter_var($attrib['title'], FILTER_SANITIZE_STRING) . ': ' . filter_var($attrib['message'], FILTER_SANITIZE_STRING);
// temporarily setting this based upon message key
// future versions of CiviCRM are likely to send severity
switch ($attrib['name']) {
// warnings
case "checkMysqlTime":
$exit = ($exit > 1) ? $exit : 1;
break;
// critical
case "checkDebug":
case "checkOutboundMail":
case "checkLogFileIsNotAccessible":
case "checkUploadsAreNotAccessible":
case "checkDirectoriesAreNotBrowseable":
case "checkFilesAreNotPresent":
$exit = ($exit > 2) ? $exit : 2;
break;
// assuming all others are warning
default:
$exit = ($exit > 1) ? $exit : 1;
}
}
if ($exit == 0) {
array_unshift($message, 'OK');
}
echo implode(' / ', $message);
exit($exit);
}
echo 'Unknown error';
exit(3);
default:
echo 'No command given';
exit(3);
}