mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Fix errors for some devices loading components (#11527)
* Test WIP * WIP * port getComponents to Eloquent * port more * simpler creation * change to explicit arrays * add missed file * restore commented code * fix inserting null value for component prefs * Fix some bugs in setCompenentPrefs Can't create tests without fixing bugs first :D * another test * another test * Modernize setComponentPrefs * Test for event log entries * Fix delete event * fix invalid values for component toggles * status log too * Use Setters to work around bad data, $casts doesn't do what we want.
This commit is contained in:
Tony Murray
GitHub
@@ -25,6 +25,11 @@
|
||||
|
||||
namespace LibreNMS;
|
||||
|
||||
use App\Models\ComponentPref;
|
||||
use App\Models\ComponentStatusLog;
|
||||
use Illuminate\Support\Arr;
|
||||
use Log;
|
||||
|
||||
class Component
|
||||
{
|
||||
/*
|
||||
@@ -32,45 +37,32 @@ class Component
|
||||
* so that they can be modified but they can not be set as user attributes. We
|
||||
* also set their default values.
|
||||
*/
|
||||
private $reserved = array(
|
||||
'type' => '',
|
||||
'label' => '',
|
||||
'status' => 0,
|
||||
'ignore' => 0,
|
||||
'disabled' => 0,
|
||||
'error' => '',
|
||||
);
|
||||
private $reserved = [
|
||||
'type' => '',
|
||||
'label' => '',
|
||||
'status' => 0,
|
||||
'ignore' => 0,
|
||||
'disabled' => 0,
|
||||
'error' => '',
|
||||
];
|
||||
|
||||
public function getComponentCount($device_id = null)
|
||||
{
|
||||
if (is_null($device_id)) {
|
||||
// SELECT type, count(*) as count FROM component GROUP BY type
|
||||
$SQL = "SELECT `type` as `name`, count(*) as count FROM `component` GROUP BY `type`";
|
||||
$rows = dbFetchRows($SQL, array());
|
||||
} else {
|
||||
$SQL = "SELECT `type` as `name`, count(*) as count FROM `component` WHERE `device_id` = ? GROUP BY `type`";
|
||||
$rows = dbFetchRows($SQL, array($device_id));
|
||||
}
|
||||
$counts = \App\Models\Component::query()->when($device_id, function ($query, $device_id) {
|
||||
$query->where('device_id', $device_id);
|
||||
})->selectRaw('type, count(*) as count')->groupBy('type')->pluck('count', 'type');
|
||||
|
||||
if (isset($rows)) {
|
||||
// We found some, lets re-process to make more accessible
|
||||
$result = array();
|
||||
foreach ($rows as $value) {
|
||||
$result[$value['name']] = $value['count'];
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
// We didn't find any components
|
||||
return false;
|
||||
return $counts->isEmpty() ? false : $counts->all();
|
||||
}
|
||||
|
||||
public function getComponentType($TYPE = null)
|
||||
{
|
||||
if (is_null($TYPE)) {
|
||||
$SQL = "SELECT DISTINCT `type` as `name` FROM `component` ORDER BY `name`";
|
||||
$row = dbFetchRow($SQL, array());
|
||||
$row = dbFetchRow($SQL, []);
|
||||
} else {
|
||||
$SQL = "SELECT DISTINCT `type` as `name` FROM `component` WHERE `type` = ? ORDER BY `name`";
|
||||
$row = dbFetchRow($SQL, array($TYPE));
|
||||
$row = dbFetchRow($SQL, [$TYPE]);
|
||||
}
|
||||
|
||||
if (!isset($row)) {
|
||||
@@ -82,109 +74,56 @@ class Component
|
||||
}
|
||||
}
|
||||
|
||||
public function getComponents($device_id = null, $options = array())
|
||||
public function getComponents($device_id = null, $options = [])
|
||||
{
|
||||
// Define our results array, this will be set even if no rows are returned.
|
||||
$RESULT = array();
|
||||
$PARAM = array();
|
||||
|
||||
// Our base SQL Query, with no options.
|
||||
$SQL = "SELECT `C`.`id`,`C`.`device_id`,`C`.`type`,`C`.`label`,`C`.`status`,`C`.`disabled`,`C`.`ignore`,`C`.`error`,`CP`.`attribute`,`CP`.`value` FROM `component` as `C` LEFT JOIN `component_prefs` as `CP` on `C`.`id`=`CP`.`component` WHERE ";
|
||||
$query = \App\Models\Component::query()
|
||||
->with('prefs');
|
||||
|
||||
// Device_id is shorthand for filter C.device_id = $device_id.
|
||||
if (!is_null($device_id)) {
|
||||
$options['filter']['device_id'] = array('=', $device_id);
|
||||
$options['filter']['device_id'] = ['=', $device_id];
|
||||
}
|
||||
|
||||
// Type is shorthand for filter type = $type.
|
||||
if (isset($options['type'])) {
|
||||
$options['filter']['type'] = array('=', $options['type']);
|
||||
$options['filter']['type'] = ['=', $options['type']];
|
||||
}
|
||||
|
||||
$validFields = ['device_id', 'type', 'id', 'label', 'status', 'disabled', 'ignore', 'error'];
|
||||
|
||||
// filter field => array(operator,value)
|
||||
// Filters results based on the field, operator and value
|
||||
$COUNT = 0;
|
||||
if (isset($options['filter'])) {
|
||||
$COUNT++;
|
||||
$validFields = array('device_id','type','id','label','status','disabled','ignore','error');
|
||||
$SQL .= " ( ";
|
||||
foreach ($options['filter'] as $field => $array) {
|
||||
// Only add valid fields to the query
|
||||
if (in_array($field, $validFields)) {
|
||||
if ($array[0] == 'LIKE') {
|
||||
$SQL .= "`C`.`".$field."` LIKE ? AND ";
|
||||
$array[1] = "%".$array[1]."%";
|
||||
} else {
|
||||
// Equals operator is the default
|
||||
$SQL .= "`C`.`".$field."` = ? AND ";
|
||||
}
|
||||
array_push($PARAM, $array[1]);
|
||||
}
|
||||
}
|
||||
// Strip the last " AND " before closing the bracket.
|
||||
$SQL = substr($SQL, 0, -5)." )";
|
||||
}
|
||||
|
||||
if ($COUNT == 0) {
|
||||
// Strip the " WHERE " that we didn't use.
|
||||
$SQL = substr($SQL, 0, -7);
|
||||
foreach (array_intersect_key($options['filter'], array_flip($validFields)) as $field => $filter) {
|
||||
$op = $filter[0];
|
||||
$value = $op == 'LIKE' ? "%{$filter[1]}%" : $filter[1];
|
||||
$query->where($field, $op, $value);
|
||||
}
|
||||
|
||||
// sort column direction
|
||||
// Add SQL sorting to the results
|
||||
if (isset($options['sort'])) {
|
||||
$SQL .= " ORDER BY ".$options['sort'];
|
||||
}
|
||||
|
||||
// Get our component records using our built SQL.
|
||||
$COMPONENTS = dbFetchRows($SQL, $PARAM);
|
||||
|
||||
// if we have no components we need to return nothing
|
||||
if (count($COMPONENTS) == 0) {
|
||||
return $RESULT;
|
||||
}
|
||||
|
||||
// Add the AVP's to the array.
|
||||
foreach ($COMPONENTS as $COMPONENT) {
|
||||
if ($COMPONENT['attribute'] != "") {
|
||||
// if this component has attributes, set them in the array.
|
||||
$RESULT[$COMPONENT['device_id']][$COMPONENT['id']][$COMPONENT['attribute']] = $COMPONENT['value'];
|
||||
}
|
||||
}
|
||||
|
||||
// Populate our reserved fields into the Array, these cant be used as user attributes.
|
||||
foreach ($COMPONENTS as $COMPONENT) {
|
||||
$component_device_id = (int)$COMPONENT['device_id'];
|
||||
foreach ($this->reserved as $k => $v) {
|
||||
$RESULT[$component_device_id][$COMPONENT['id']][$k] = $COMPONENT[$k];
|
||||
}
|
||||
[$column, $direction] = explode(' ', $options['sort']);
|
||||
$query->orderBy($column, $direction);
|
||||
}
|
||||
|
||||
// limit array(start,count)
|
||||
if (isset($options['limit'])) {
|
||||
$TEMP = array();
|
||||
$COUNT = 0;
|
||||
// k = device_id, v = array of components for that device_id
|
||||
foreach ($RESULT as $k => $v) {
|
||||
// k1 = component id, v1 = component array
|
||||
foreach ($v as $k1 => $v1) {
|
||||
if (($COUNT >= $options['limit'][0]) && ($COUNT < $options['limit'][0]+$options['limit'][1])) {
|
||||
$TEMP[$k][$k1] = $v1;
|
||||
}
|
||||
// We are counting components.
|
||||
$COUNT++;
|
||||
}
|
||||
}
|
||||
$RESULT = $TEMP;
|
||||
$query->offset($options['limit'][0])->limit($options['limit'][1]);
|
||||
}
|
||||
|
||||
return $RESULT;
|
||||
// get and format results as expected by receivers
|
||||
return $query->get()->groupBy('device_id')->map(function ($group) {
|
||||
return $group->keyBy('id')->map(function ($component) {
|
||||
return $component->prefs->pluck('value', 'attribute')
|
||||
->merge($component->only(array_keys($this->reserved)));
|
||||
});
|
||||
})->toArray();
|
||||
}
|
||||
|
||||
public function getComponentStatus($device = null)
|
||||
{
|
||||
$sql_query = "SELECT status, count(status) as count FROM component WHERE";
|
||||
$sql_param = array();
|
||||
$sql_param = [];
|
||||
$add = 0;
|
||||
|
||||
if (!is_null($device)) {
|
||||
@@ -196,22 +135,22 @@ class Component
|
||||
|
||||
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 status";
|
||||
d_echo("SQL Query: ".$sql_query);
|
||||
d_echo("SQL Query: " . $sql_query);
|
||||
|
||||
// $service is not null, get only what we want.
|
||||
$result = dbFetchRows($sql_query, $sql_param);
|
||||
|
||||
// Set our defaults to 0
|
||||
$count = array(0 => 0, 1 => 0, 2 => 0);
|
||||
$count = [0 => 0, 1 => 0, 2 => 0];
|
||||
// Rebuild the array in a more convenient method
|
||||
foreach ($result as $v) {
|
||||
$count[$v['status']] = $v['count'];
|
||||
}
|
||||
|
||||
d_echo("Component Count by Status: ".print_r($count, true)."\n");
|
||||
d_echo("Component Count by Status: " . print_r($count, true) . "\n");
|
||||
return $count;
|
||||
}
|
||||
|
||||
@@ -219,16 +158,16 @@ class Component
|
||||
{
|
||||
if (($component_id == null) || ($start == null) || ($end == null)) {
|
||||
// Error...
|
||||
d_echo("Required arguments are missing. Component ID: ".$component_id.", Start: ".$start.", End: ".$end."\n");
|
||||
d_echo("Required arguments are missing. Component ID: " . $component_id . ", Start: " . $start . ", End: " . $end . "\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
// Create our return array.
|
||||
$return = array();
|
||||
$return = [];
|
||||
|
||||
// 1. find the previous value, this is the value when $start occurred.
|
||||
$sql_query = "SELECT status FROM `component_statuslog` WHERE `component_id` = ? AND `timestamp` < ? ORDER BY `id` desc LIMIT 1";
|
||||
$sql_param = array($component_id, $start);
|
||||
$sql_param = [$component_id, $start];
|
||||
$result = dbFetchRow($sql_query, $sql_param);
|
||||
if ($result == false) {
|
||||
$return['initial'] = false;
|
||||
@@ -238,136 +177,96 @@ class Component
|
||||
|
||||
// 2. Then we just need a list of all the entries for the time period.
|
||||
$sql_query = "SELECT status, `timestamp`, message FROM `component_statuslog` WHERE `component_id` = ? AND `timestamp` >= ? AND `timestamp` < ? ORDER BY `timestamp`";
|
||||
$sql_param = array($component_id, $start,$end);
|
||||
$sql_param = [$component_id, $start, $end];
|
||||
$return['data'] = dbFetchRows($sql_query, $sql_param);
|
||||
|
||||
d_echo("Status Log Data: ".print_r($return, true)."\n");
|
||||
d_echo("Status Log Data: " . print_r($return, true) . "\n");
|
||||
return $return;
|
||||
}
|
||||
|
||||
public function createComponent($device_id, $TYPE)
|
||||
public function createComponent($device_id, $type)
|
||||
{
|
||||
// Prepare our default values to be inserted.
|
||||
$DATA = $this->reserved;
|
||||
|
||||
// Add the device_id and type
|
||||
$DATA['device_id'] = $device_id;
|
||||
$DATA['type'] = $TYPE;
|
||||
|
||||
// Insert a new component into the database.
|
||||
$id = dbInsert($DATA, 'component');
|
||||
$component = \App\Models\Component::create(['device_id' => $device_id, 'type' => $type]);
|
||||
|
||||
// Add a default status log entry - we always start ok.
|
||||
$this->createStatusLogEntry($id, 0, 'Component Created');
|
||||
$this->createStatusLogEntry($component->id, 0, 'Component Created');
|
||||
|
||||
// Create a default component array based on what was inserted.
|
||||
$ARRAY = array();
|
||||
$ARRAY[$id] = $DATA;
|
||||
unset($ARRAY[$id]['device_id']); // This doesn't belong here.
|
||||
return $ARRAY;
|
||||
return [$component->id => $component->only(array_keys($this->reserved))];
|
||||
}
|
||||
|
||||
public function createStatusLogEntry($component_id, $status, $message)
|
||||
{
|
||||
// Add an entry to the statuslog table for a particular component.
|
||||
$DATA = array(
|
||||
'component_id' => $component_id,
|
||||
'status' => $status,
|
||||
'message' => $message,
|
||||
);
|
||||
try {
|
||||
return ComponentStatusLog::create(['component_id' => $component_id, 'status' => $status, 'message' => $message])->id;
|
||||
} catch (\Exception $e) {
|
||||
Log::debug("Failed to create component status log");
|
||||
}
|
||||
|
||||
return dbInsert($DATA, 'component_statuslog');
|
||||
return 0;
|
||||
}
|
||||
|
||||
public function deleteComponent($id)
|
||||
{
|
||||
// Delete a component from the database.
|
||||
return dbDelete('component', "`id` = ?", array($id));
|
||||
return \App\Models\Component::destroy($id);
|
||||
}
|
||||
|
||||
public function setComponentPrefs($device_id, $ARRAY)
|
||||
public function setComponentPrefs($device_id, $updated)
|
||||
{
|
||||
// Compare the arrays. Update/Insert where necessary.
|
||||
$updated = Arr::wrap($updated);
|
||||
\App\Models\Component::whereIn('id', array_keys($updated))
|
||||
->with('prefs')
|
||||
->get()
|
||||
->each(function (\App\Models\Component $component) use ($updated) {
|
||||
unset($updated[$component->id]['type']); // can't change type
|
||||
|
||||
$OLD = $this->getComponents($device_id);
|
||||
// Loop over each component.
|
||||
foreach ((array)$ARRAY as $COMPONENT => $AVP) {
|
||||
// Make sure the component already exists.
|
||||
if (!isset($OLD[$device_id][$COMPONENT])) {
|
||||
// Error. Component doesn't exist in the database.
|
||||
continue;
|
||||
}
|
||||
// update component attributes
|
||||
$component->fill($updated[$component->id]);
|
||||
if ($component->isDirty()) {
|
||||
// Log the update to the Eventlog.
|
||||
$message = "Component $component->id has been modified: ";
|
||||
$message .= collect($component->getDirty())->map(function ($value, $key) {
|
||||
return "$key => $value";
|
||||
})->implode(',');
|
||||
|
||||
// Ignore type, we cant change that.
|
||||
unset($AVP['type'], $OLD[$device_id][$COMPONENT]['type']);
|
||||
|
||||
// If the Status has changed we need to add a log entry
|
||||
if ($AVP['status'] != $OLD[$device_id][$COMPONENT]['status']) {
|
||||
d_echo("Status Changed - Old: ".$OLD[$device_id][$COMPONENT]['status'].", New: ".$AVP['status']."\n");
|
||||
$this->createStatusLogEntry($COMPONENT['id'], $AVP['status'], $AVP['error']);
|
||||
}
|
||||
|
||||
// Process our reserved components first.
|
||||
$UPDATE = array();
|
||||
foreach ($this->reserved as $k => $v) {
|
||||
// does the reserved field exist, if not skip.
|
||||
if (isset($AVP[$k])) {
|
||||
// Has the value changed?
|
||||
if ($AVP[$k] != $OLD[$device_id][$COMPONENT][$k]) {
|
||||
// The value has been modified, add it to our update array.
|
||||
$UPDATE[$k] = $AVP[$k];
|
||||
// If the Status has changed we need to add a log entry
|
||||
if ($component->isDirty('status')) {
|
||||
Log::debug("Status Changed - Old: " . $component->getOriginal('status') . ", New: $component->status\n");
|
||||
$this->createStatusLogEntry($component->id, $component->status, $component->error);
|
||||
}
|
||||
$component->save();
|
||||
|
||||
// Unset the reserved field. We don't want to insert it below.
|
||||
unset($AVP[$k], $OLD[$device_id][$COMPONENT][$k]);
|
||||
Log::event($message, $component->device_id, 'component', 3, $component->id);
|
||||
}
|
||||
}
|
||||
|
||||
// Has anything changed, do we need to update?
|
||||
if (count($UPDATE) > 0) {
|
||||
// We have data to update
|
||||
dbUpdate($UPDATE, 'component', '`id` = ?', array($COMPONENT));
|
||||
// update preferences
|
||||
$prefs = collect($updated[$component->id])->filter(function ($value, $attr) {
|
||||
return !array_key_exists($attr, $this->reserved);
|
||||
});
|
||||
|
||||
// Log the update to the Eventlog.
|
||||
$MSG = "Component ".$COMPONENT." has been modified: ";
|
||||
foreach ($UPDATE as $k => $v) {
|
||||
$MSG .= $k." => ".$v.",";
|
||||
$invalid = $component->prefs->keyBy('id');
|
||||
|
||||
foreach ($prefs as $attribute => $value) {
|
||||
$existing = $component->prefs->firstWhere('attribute', $attribute);
|
||||
if ($existing) {
|
||||
$invalid->forget($existing->id);
|
||||
$existing->fill(['value' => $value]);
|
||||
if ($existing->isDirty()) {
|
||||
Log::event("Component: $component->type($component->id). Attribute: $attribute, was modified from: " . $existing->getOriginal('value') . ", to: $value", $device_id, 'component', 3, $component_id);
|
||||
$existing->save();
|
||||
}
|
||||
} else {
|
||||
$component->prefs()->save(new ComponentPref(['attribute' => $attribute, 'value' => $value]));
|
||||
Log::event("Component: $component->type($component->id). Attribute: $attribute, was added with value: $value", $component->device_id, 'component', 3, $component->id);
|
||||
}
|
||||
}
|
||||
$MSG = substr($MSG, 0, -1);
|
||||
log_event($MSG, $device_id, 'component', 3, $COMPONENT);
|
||||
}
|
||||
|
||||
// Process our AVP Adds and Updates
|
||||
foreach ($AVP as $ATTR => $VALUE) {
|
||||
// We have our AVP, lets see if we need to do anything with it.
|
||||
|
||||
if (!isset($OLD[$device_id][$COMPONENT][$ATTR])) {
|
||||
// We have a newly added attribute, need to insert into the DB
|
||||
$DATA = array('component'=>$COMPONENT, 'attribute'=>$ATTR, 'value'=>$VALUE);
|
||||
dbInsert($DATA, 'component_prefs');
|
||||
|
||||
// Log the addition to the Eventlog.
|
||||
log_event("Component: " . $AVP[$COMPONENT]['type'] . "(" . $COMPONENT . "). Attribute: " . $ATTR . ", was added with value: " . $VALUE, $device_id, 'component', 3, $COMPONENT);
|
||||
} elseif ($OLD[$device_id][$COMPONENT][$ATTR] != $VALUE) {
|
||||
// Attribute exists but the value is different, need to update
|
||||
$DATA = array('value'=>$VALUE);
|
||||
dbUpdate($DATA, 'component_prefs', '`component` = ? AND `attribute` = ?', array($COMPONENT, $ATTR));
|
||||
|
||||
// Add the modification to the Eventlog.
|
||||
log_event("Component: " . $AVP[$COMPONENT]['type'] . "(" . $COMPONENT . "). Attribute: " . $ATTR . ", was modified from: " . $OLD[$device_id][$COMPONENT][$ATTR] . ", to: " . $VALUE, $device_id, 'component', 3, $COMPONENT);
|
||||
foreach ($invalid as $pref) {
|
||||
$pref->delete();
|
||||
Log::event("Component: $component->type($component->id). Attribute: $pref->attribute, was deleted.", $component->device_id, 'component', 4);
|
||||
}
|
||||
} // End Foreach AVP
|
||||
|
||||
// Process our Deletes.
|
||||
$DELETE = array_diff_key($OLD[$device_id][$COMPONENT], $AVP);
|
||||
foreach ($DELETE as $KEY => $VALUE) {
|
||||
// As the Attribute has been removed from the array, we should remove it from the database.
|
||||
dbDelete('component_prefs', "`component` = ? AND `attribute` = ?", array($COMPONENT,$KEY));
|
||||
|
||||
// Log the addition to the Eventlog.
|
||||
log_event("Component: " . $AVP[$COMPONENT]['type'] . "(" . $COMPONENT . "). Attribute: " . $KEY . ", was deleted.", 4, $COMPONENT);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user