Sensors remove reliance on global variable (#16344)

* Sensors remove reliance on global variable * Apply fixes from StyleCI * Clear the instance instead of reset. Remove $valid['sensors'] from docs --------- Co-authored-by: Tony Murray <murrant@users.noreply.github.com>
2024-10-07 16:52:45 +00:00 · 2024-09-03 21:04:34 -05:00
parent 4efad1ae69
commit f15f8fa63a
381 changed files with 991 additions and 932 deletions
--- a/app/Observers/SensorObserver.php
+++ b/app/Observers/SensorObserver.php
@@ -0,0 +1,121 @@
+<?php
+
+namespace App\Observers;
+
+use App\Models\Eventlog;
+use App\Models\Sensor;
+use Illuminate\Foundation\Application;
+use LibreNMS\Enum\Severity;
+
+class SensorObserver
+{
+    private bool $runningInConsole;
+
+    public function __construct(Application $app)
+    {
+        $this->runningInConsole = $app->runningInConsole();
+    }
+
+    public function saving(Sensor $sensor): void
+    {
+        // fix inverted limits
+        if ($sensor->sensor_limit !== null && $sensor->sensor_limit_low !== null && $sensor->sensor_limit_low > $sensor->sensor_limit) {
+            // Fix high/low thresholds (i.e. on negative numbers)
+            [$sensor->sensor_limit, $sensor->sensor_limit_low] = [$sensor->sensor_limit_low, $sensor->sensor_limit];
+        }
+
+        if ($this->runningInConsole && ! $sensor->isDirty()) {
+            echo '.';
+        }
+    }
+
+    /**
+     * Handle the service "created" event.
+     *
+     * @param  Sensor  $sensor
+     * @return void
+     */
+    public function created(Sensor $sensor): void
+    {
+        $guess_limits = \LibreNMS\Config::get('sensors.guess_limits', true);
+        if ($guess_limits && $sensor->sensor_current !== null && $sensor->sensor_limit === null && $sensor->sensor_limit_low === null) {
+            $sensor->guessLimits();
+        }
+
+        EventLog::log('Sensor Added: ' . $sensor->sensor_class . ' ' . $sensor->sensor_type . ' ' . $sensor->sensor_index . ' ' . $sensor->sensor_descr, $sensor->device_id, 'sensor', Severity::Notice, $sensor->sensor_id);
+
+        if ($this->runningInConsole) {
+            echo '+';
+        }
+    }
+
+    /**
+     * Handle the Stp "updating" event.
+     *
+     * @param  \App\Models\Sensor  $sensor
+     * @return void
+     */
+    public function updating(Sensor $sensor)
+    {
+        // prevent update of limits
+        if ($sensor->sensor_custom !== 'Yes') {
+            if ($sensor->getOriginal('sensor_limit') !== null) {
+                $sensor->sensor_limit = $sensor->getOriginal('sensor_limit');
+            }
+            if ($sensor->getOriginal('sensor_limit_low') !== null) {
+                $sensor->sensor_limit_low = $sensor->getOriginal('sensor_limit_low');
+            }
+        }
+    }
+
+    public function updated(Sensor $sensor): void
+    {
+        // log limit changes
+        if ($sensor->sensor_custom == 'No') {
+            if ($sensor->isDirty('sensor_limit')) {
+                EventLog::log('Sensor High Limit Updated: ' . $sensor->sensor_class . ' ' . $sensor->sensor_type . ' ' . $sensor->sensor_index . ' ' . $sensor->sensor_descr . ' (' . $sensor->sensor_limit . ')', $sensor->device_id, 'sensor', Severity::Notice, $sensor->sensor_id);
+
+                if ($this->runningInConsole) {
+                    echo 'H';
+                }
+            }
+
+            if ($sensor->isDirty('sensor_limit_low')) {
+                EventLog::log('Sensor Low Limit Updated: ' . $sensor->sensor_class . ' ' . $sensor->sensor_type . ' ' . $sensor->sensor_index . ' ' . $sensor->sensor_descr . ' (' . $sensor->sensor_limit_low . ')', $sensor->device_id, 'sensor', Severity::Notice, $sensor->sensor_id);
+
+                if ($this->runningInConsole) {
+                    echo 'L';
+                }
+            }
+
+            if ($sensor->isDirty('sensor_limit_warn')) {
+                EventLog::log('Sensor Warn High Limit Updated: ' . $sensor->sensor_class . ' ' . $sensor->sensor_type . ' ' . $sensor->sensor_index . ' ' . $sensor->sensor_descr . ' (' . $sensor->sensor_limit_warn . ')', $sensor->device_id, 'sensor', Severity::Notice, $sensor->sensor_id);
+
+                if ($this->runningInConsole) {
+                    echo 'WH';
+                }
+            }
+
+            if ($sensor->isDirty('sensor_limit_low_warn')) {
+                EventLog::log('Sensor Warn Low Limit Updated: ' . $sensor->sensor_class . ' ' . $sensor->sensor_type . ' ' . $sensor->sensor_index . ' ' . $sensor->sensor_descr . ' (' . $sensor->sensor_limit_low_warn . ')', $sensor->device_id, 'sensor', Severity::Notice, $sensor->sensor_id);
+
+                if ($this->runningInConsole) {
+                    echo 'WL';
+                }
+            }
+        }
+
+        if ($this->runningInConsole) {
+            echo 'U';
+        }
+
+        EventLog::log('Sensor Updated: ' . $sensor->sensor_class . ' ' . $sensor->sensor_type . ' ' . $sensor->sensor_index . ' ' . $sensor->sensor_descr, $sensor->device_id, 'sensor', Severity::Notice, $sensor->sensor_id);
+    }
+
+    public function deleted(): void
+    {
+        if ($this->runningInConsole) {
+            echo '-';
+        }
+    }
+}