mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Apply fixes from StyleCI (#12120)

Browse Source
This commit is contained in:
Jellyfrog
2020-09-21 15:40:17 +02:00
committed by GitHub
parent 77c531527c
commit 82f43cb98d
1733 changed files with 18337 additions and 18540 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
includes/services.inc.php
View File

@@ -7,10 +7,10 @@ use LibreNMS\RRD\RrdDefinition;
function get_service_status($device = null)
{
$sql_query = "SELECT service_status, count(service_status) as count FROM services WHERE";
$sql_param = array();
$sql_param = [];
$add = 0;
if (!is_null($device)) {
if (! is_null($device)) {
// Add a device filter to the SQL query.
$sql_query .= " `device_id` = ?";
$sql_param[] = $device;
@@ -19,7 +19,7 @@ function get_service_status($device = null)
if ($add == 0) {
// No filters, remove " WHERE" -6
$sql_query = substr($sql_query, 0, strlen($sql_query)-6);
$sql_query = substr($sql_query, 0, strlen($sql_query) - 6);
}
$sql_query .= " GROUP BY service_status";
@@ -27,7 +27,7 @@ function get_service_status($device = null)
$result = dbFetchRows($sql_query, $sql_param);
// Set our defaults to 0
$service_count = array(0 => 0, 1 => 0, 2 => 0);
$service_count = [0 => 0, 1 => 0, 2 => 0];
// Rebuild the array in a more convenient method
foreach ($result as $v) {
$service_count[$v['service_status']] = $v['count'];
@@ -38,8 +38,7 @@ function get_service_status($device = null)
function add_service($device, $type, $desc, $ip = '', $param = "", $ignore = 0, $disabled = 0)
{
if (!is_array($device)) {
if (! is_array($device)) {
$device = device_by_id_cache($device);
}
@@ -47,24 +46,25 @@ function add_service($device, $type, $desc, $ip = '', $param = "", $ignore = 0,
$ip = Device::pollerTarget($device['hostname']);
}
$insert = array('device_id' => $device['device_id'], 'service_ip' => $ip, 'service_type' => $type, 'service_changed' => array('UNIX_TIMESTAMP(NOW())'), 'service_desc' => $desc, 'service_param' => $param, 'service_ignore' => $ignore, 'service_status' => 3, 'service_message' => 'Service not yet checked', 'service_ds' => '{}', 'service_disabled' => $disabled);
$insert = ['device_id' => $device['device_id'], 'service_ip' => $ip, 'service_type' => $type, 'service_changed' => ['UNIX_TIMESTAMP(NOW())'], 'service_desc' => $desc, 'service_param' => $param, 'service_ignore' => $ignore, 'service_status' => 3, 'service_message' => 'Service not yet checked', 'service_ds' => '{}', 'service_disabled' => $disabled];
return dbInsert($insert, 'services');
}
function service_get($device = null, $service = null)
{
$sql_query = "SELECT `service_id`,`device_id`,`service_ip`,`service_type`,`service_desc`,`service_param`,`service_ignore`,`service_status`,`service_changed`,`service_message`,`service_disabled`,`service_ds` FROM `services` WHERE";
$sql_param = array();
$sql_param = [];
$add = 0;
d_echo("SQL Query: ".$sql_query);
if (!is_null($service)) {
d_echo("SQL Query: " . $sql_query);
if (! is_null($service)) {
// Add a service filter to the SQL query.
$sql_query .= " `service_id` = ? AND";
$sql_param[] = $service;
$add++;
}
if (!is_null($device)) {
if (! is_null($device)) {
// Add a device filter to the SQL query.
$sql_query .= " `device_id` = ? AND";
$sql_param[] = $device;
@@ -73,41 +73,41 @@ function service_get($device = null, $service = null)
if ($add == 0) {
// No filters, remove " WHERE" -6
$sql_query = substr($sql_query, 0, strlen($sql_query)-6);
$sql_query = substr($sql_query, 0, strlen($sql_query) - 6);
} else {
// We have filters, remove " AND" -4
$sql_query = substr($sql_query, 0, strlen($sql_query)-4);
$sql_query = substr($sql_query, 0, strlen($sql_query) - 4);
}
d_echo("SQL Query: ".$sql_query);
d_echo("SQL Query: " . $sql_query);
// $service is not null, get only what we want.
$services = dbFetchRows($sql_query, $sql_param);
d_echo("Service Array: ".print_r($services, true)."\n");
d_echo("Service Array: " . print_r($services, true) . "\n");
return $services;
}
function edit_service($update = array(), $service = null)
function edit_service($update = [], $service = null)
{
if (!is_numeric($service)) {
if (! is_numeric($service)) {
return false;
}
return dbUpdate($update, 'services', '`service_id`=?', array($service));
return dbUpdate($update, 'services', '`service_id`=?', [$service]);
}
function delete_service($service = null)
{
if (!is_numeric($service)) {
if (! is_numeric($service)) {
return false;
}
return dbDelete('services', '`service_id` = ?', array($service));
return dbDelete('services', '`service_id` = ?', [$service]);
}
function discover_service($device, $service)
{
if (! dbFetchCell('SELECT COUNT(service_id) FROM `services` WHERE `service_type`= ? AND `device_id` = ?', array($service, $device['device_id']))) {
if (! dbFetchCell('SELECT COUNT(service_id) FROM `services` WHERE `service_type`= ? AND `device_id` = ?', [$service, $device['device_id']])) {
add_service($device, $service, "(Auto discovered) $service");
log_event('Autodiscovered service: type ' . mres($service), $device, 'service', 2);
echo '+';
@@ -117,7 +117,7 @@ function discover_service($device, $service)
function poll_service($service)
{
$update = array();
$update = [];
$old_status = $service['service_status'];
$check_cmd = "";
@@ -137,20 +137,20 @@ function poll_service($service)
// Some debugging
d_echo("\nNagios Service - $service_id\n");
// the check_service function runs $check_cmd through escapeshellcmd, so
list($new_status, $msg, $perf) = check_service($check_cmd);
[$new_status, $msg, $perf] = check_service($check_cmd);
d_echo("Response: $msg\n");
// If we have performance data we will store it.
if (count($perf) > 0) {
// Yes, We have perf data.
$rrd_name = array('services', $service_id);
$rrd_name = ['services', $service_id];
// Set the DS in the DB if it is blank.
$DS = array();
$DS = [];
foreach ($perf as $k => $v) {
$DS[$k] = $v['uom'];
}
d_echo("Service DS: "._json_encode($DS)."\n");
d_echo("Service DS: " . _json_encode($DS) . "\n");
if (($service['service_ds'] == "{}") || ($service['service_ds'] == "")) {
$update['service_ds'] = json_encode($DS);
}
@@ -158,7 +158,7 @@ function poll_service($service)
// rrd definition
$rrd_def = new RrdDefinition();
foreach ($perf as $k => $v) {
if (($v['uom'] == 'c') && !(preg_match('/[Uu]ptime/', $k))) {
if (($v['uom'] == 'c') && ! (preg_match('/[Uu]ptime/', $k))) {
// This is a counter, create the DS as such
$rrd_def->addDataset($k, 'COUNTER', 0);
} else {
@@ -168,14 +168,14 @@ function poll_service($service)
}
// Update data
$fields = array();
$fields = [];
foreach ($perf as $k => $v) {
$fields[$k] = $v['value'];
}
$tags = compact('service_id', 'rrd_name', 'rrd_def');
//TODO not sure if we have $device at this point, if we do replace faked $device
data_update(array('hostname' => $service['hostname']), 'services', $tags, $fields);
data_update(['hostname' => $service['hostname']], 'services', $tags, $fields);
}
if ($old_status != $new_status) {
@@ -185,7 +185,7 @@ function poll_service($service)
$update['service_message'] = $msg;
// TODO: Put the 3 lines below in a function getStatus(int) ?
$status_text = array(0 => 'OK', 1 => 'Warning', 3 => 'Unknown');
$status_text = [0 => 'OK', 1 => 'Warning', 3 => 'Unknown'];
$old_status_text = isset($status_text[$old_status]) ? $status_text[$old_status] : 'Critical';
$new_status_text = isset($status_text[$new_status]) ? $status_text[$new_status] : 'Critical';
@@ -215,12 +215,13 @@ function check_service($command)
// This array is used to test for valid UOM's to be used for graphing.
// Valid values from: https://nagios-plugins.org/doc/guidelines.html#AEN200
// Note: This array must be decend from 2 char to 1 char so that the search works correctly.
$valid_uom = array ('us', 'ms', 'KB', 'MB', 'GB', 'TB', 'c', 's', '%', 'B');
$valid_uom = ['us', 'ms', 'KB', 'MB', 'GB', 'TB', 'c', 's', '%', 'B'];
// Make our command safe.
$parts = preg_split('~(?:\'[^\']*\'|"[^"]*")(*SKIP)(*F)|\h+~', trim($command));
$safe_command = implode(' ', array_map(function ($part) {
$trimmed = preg_replace('/^(\'(.*)\'|"(.*)")$/', '$2$3', $part);
return escapeshellarg($trimmed);
}, $parts));
@@ -233,21 +234,21 @@ function check_service($command)
$response_string = implode("\n", $response_array);
// Split out the response and the performance data.
list($response, $perf) = explode("|", $response_string);
[$response, $perf] = explode("|", $response_string);
// Split each performance metric
$perf_arr = explode(' ', $perf);
// Create an array for our metrics.
$metrics = array();
$metrics = [];
// Loop through the perf string extracting our metric data
foreach ($perf_arr as $string) {
// Separate the DS and value: DS=value
list ($ds,$values) = explode('=', trim($string));
[$ds,$values] = explode('=', trim($string));
// Keep the first value, discard the others.
list($value,,,) = explode(';', trim($values));
[$value,,,] = explode(';', trim($values));
$value = trim($value);
// Set an empty uom
@@ -255,7 +256,7 @@ function check_service($command)
// is the UOM valid - https://nagios-plugins.org/doc/guidelines.html#AEN200
foreach ($valid_uom as $v) {
if ((strlen($value)-strlen($v)) === strpos($value, $v)) {
if ((strlen($value) - strlen($v)) === strpos($value, $v)) {
// Yes, store and strip it off the value
$uom = $v;
$value = substr($value, 0, -strlen($v));
@@ -278,9 +279,9 @@ function check_service($command)
d_echo($normalized_ds . " collides with an existing index\n");
$perf_unique = 0;
// Try to generate a unique name
for ($i = 0; $i<10; $i++) {
for ($i = 0; $i < 10; $i++) {
$tmp_ds_name = substr($normalized_ds, 0, 18) . $i;
if (!isset($metrics[$tmp_ds_name])) {
if (! isset($metrics[$tmp_ds_name])) {
d_echo($normalized_ds . " collides with an existing index\n");
$normalized_ds = $tmp_ds_name;
$perf_unique = 1;
@@ -289,10 +290,10 @@ function check_service($command)
}
if ($perf_unique == 0) {
// Try harder to generate a unique name
for ($i = 0; $i<10; $i++) {
for ($j = 0; $j<10; $j++) {
for ($i = 0; $i < 10; $i++) {
for ($j = 0; $j < 10; $j++) {
$tmp_ds_name = substr($normalized_ds, 0, 17) . $j . $i;
if (!isset($perf[$tmp_ds_name])) {
if (! isset($perf[$tmp_ds_name])) {
$normalized_ds = $tmp_ds_name;
$perf_unique = 1;
break 2;
@@ -304,18 +305,18 @@ function check_service($command)
d_echo("could not generate a unique ds-name for " . $ds . "\n");
}
}
$ds = $normalized_ds ;
$ds = $normalized_ds;
}
// We have a DS. Add an entry to the array.
d_echo("Perf Data - DS: ".$ds.", Value: ".$value.", UOM: ".$uom."\n");
$metrics[$ds] = array ('value'=>$value, 'uom'=>$uom);
d_echo("Perf Data - DS: " . $ds . ", Value: " . $value . ", UOM: " . $uom . "\n");
$metrics[$ds] = ['value'=>$value, 'uom'=>$uom];
} else {
// No DS. Don't add an entry to the array.
d_echo("Perf Data - None.\n");
}
}
return array ($status, $response, $metrics);
return [$status, $response, $metrics];
}
/**
@@ -325,11 +326,12 @@ function check_service($command)
*/
function list_available_services()
{
$services = array();
$services = [];
foreach (scandir(Config::get('nagios_plugins')) as $file) {
if (substr($file, 0, 6) === 'check_') {
$services[] = substr($file, 6);
}
}
return $services;
}