Add customoid type to graph widget (librenms#18452)

* Update Graph.php, CustomoidController.php, GraphController.php, and 3 more files

* Update Graph.php and GraphController.php

* lint

* lint

* Update CustomoidController.php

* Update GraphController.php

Author: slashdoom

app/Http/Controllers/Select/CustomoidController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Http\Controllers\Select;
+
+use App\Models\Customoid;
+
+class CustomoidController extends SelectController
+{
+    /**
+     * Defines the base query for this resource
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
+     */
+    protected function baseQuery($request)
+    {
+        return Customoid::hasAccess($request->user())
+            ->with(['device' => function ($query): void {
+                $query->select('device_id', 'hostname', 'sysName', 'display');
+            }])
+            ->select('customoid_id', 'customoid_descr', 'device_id');
+    }
+
+    /**
+     * @param  Customoid  $customoid
+     */
+    public function formatItem($customoid)
+    {
+        return [
+            'id' => $customoid->customoid_id,
+            'text' => $customoid->device->shortDisplayName() . ' (' . $customoid->customoid_descr . ')',
+        ];
+    }
+}

app/Http/Controllers/Select/GraphController.php

@@ -87,6 +87,16 @@ public function __invoke(Request $request)
             ];
         }
 
+        $customoid = $this->filterTypeGraphs(collect([
+            'customoid_customoid' => 'CustomOID Graph',
+        ]), 'customoid', $search);
+        if ($customoid->isNotEmpty()) {
+            $data[] = [
+                'text' => 'CustomOID',
+                'children' => $customoid->map(fn ($text, $id) => ['id' => $id, 'text' => $text])->values(),
+            ];
+        }
+
         return response()->json([
             'results' => $data,
             'pagination' => ['more' => false],

app/Http/Controllers/Widgets/GraphController.php

@@ -29,6 +29,7 @@
 use App\Facades\LibrenmsConfig;
 use App\Models\Application;
 use App\Models\Bill;
+use App\Models\Customoid;
 use App\Models\Device;
 use App\Models\MuninPlugin;
 use App\Models\Port;
@@ -53,6 +54,7 @@ class GraphController extends WidgetController
         'graph_application' => null,
         'graph_munin' => null,
         'graph_service' => null,
+        'graph_customoid' => null,
         'graph_ports' => [],
         'graph_custom' => [],
         'graph_manual' => null,
@@ -95,6 +97,10 @@ public function getTitle(): string
             if ($service = Service::find($settings['graph_service'])) {
                 return $service->device->displayName() . ' / ' . $service->service_type . ' (' . $service->service_desc . ')' . ' / ' . $settings['graph_type'];
             }
+        } elseif ($type == 'customoid') {
+            if ($customoid = Customoid::find($settings['graph_customoid'])) {
+                return $customoid->device?->displayName() . ' / ' . $type . ' / ' . $customoid->customoid_descr;
+            }
         }
 
         // fall back for types where we couldn't find the item
@@ -146,6 +152,11 @@ public function getSettingsView(Request $request): View
         }
         $data['service_text'] = isset($service) ? $service->device->displayName() . ' - ' . $service->service_type . ' (' . $service->service_desc . ')' : __('Service does not exist');
 
+        if ($primary == 'customoid' && $data['graph_customoid']) {
+            $customoid = Customoid::with('device')->find($data['graph_customoid']);
+        }
+        $data['customoid_text'] = isset($customoid) ? $customoid->device?->displayName() . ' - ' . $customoid->customoid_descr : __('Custom OID does not exist');
+
         $data['graph_ports'] = Port::whereIntegerInRaw('port_id', $data['graph_ports'])
             ->select('ports.device_id', 'port_id', 'ifAlias', 'ifName', 'ifDescr')
             ->with(['device' => function ($query): void {
@@ -189,6 +200,12 @@ public function getView(Request $request): string|View
                 $params[] = 'device=' . $service->device_id;
                 $params[] = 'id=' . $service->service_id;
             }
+        } elseif ($type == 'customoid') {
+            if ($customoid = Customoid::find($settings['graph_customoid'])) {
+                $params[] = 'device=' . $customoid->device_id;
+                $params[] = 'id=' . $customoid->customoid_id;
+                $settings['graph_type'] = 'customoid_' . $customoid->customoid_descr;
+            }
         } elseif ($type == 'aggregate') {
             $aggregate_type = $this->getGraphType(false);
             if ($aggregate_type == 'custom') {

app/Models/Customoid.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Models;
+
+class Customoid extends DeviceRelatedModel
+{
+    public $timestamps = false;
+    protected $primaryKey = 'customoid_id';
+}

resources/views/widgets/settings/graph.blade.php

@@ -78,6 +78,14 @@
         @endif
         </select>
     </div>
+    <div class="form-group graph_select_extra-{{ $id }}" id="graph_select_customoid-{{ $id }}" style="display: none;">
+        <label for="graph_customoid-{{ $id }}" class="control-label">{{ __('Customoid') }}</label>
+        <select class="form-control" id="graph_customoid-{{ $id }}" name="graph_customoid" data-placeholder="{{ __('Select a custom OID') }}">
+        @if($graph_customoid)
+            <option value="{{ $graph_customoid }}">{{ $customoid_text }}</option>
+        @endif
+        </select>
+    </div>
     <div class="form-group graph_select_extra-{{ $id }}" id="graph_select_bill-{{ $id }}" style="display: none;">
         <label for="graph_bill-{{ $id }}" class="control-label">{{ __('Bill') }}</label>
         <select class="form-control" id="graph_bill-{{ $id }}" name="graph_bill" data-placeholder="{{ __('Select a bill') }}">
@@ -121,6 +129,7 @@
         }, '{{ $graph_application ?: '' }}');
         init_select2('#graph_munin-{{ $id }}', 'munin', {limit: 100}, '{{ $graph_munin ?: '' }}');
         init_select2('#graph_service-{{ $id }}', 'service', {limit: 100}, '{{ $graph_service ?: '' }}');
+        init_select2('#graph_customoid-{{ $id }}', 'customoid', {limit: 100}, '{{ $graph_customoid ?: '' }}');
         init_select2('#graph_bill-{{ $id }}', 'bill', {limit: 100}, '{{ $graph_bill ?: '' }}');
         init_select2('#graph_custom-{{ $id }}', 'graph-aggregate', {}, false);
         init_select2('#graph_ports-{{ $id }}', 'port', {limit: 100}, {{ $graph_port_ids }});

routes/web.php

@@ -275,6 +275,7 @@
             Route::get('munin', Select\MuninPluginController::class)->name('ajax.select.munin');
             Route::get('role', Select\RoleController::class)->name('ajax.select.role');
             Route::get('service', Select\ServiceController::class)->name('ajax.select.service');
+            Route::get('customoid', Select\CustomoidController::class)->name('ajax.select.customoid');
             Route::get('template', Select\ServiceTemplateController::class)->name('ajax.select.template');
             Route::get('poller-group', Select\PollerGroupController::class)->name('ajax.select.poller-group');
             Route::get('port', Select\PortController::class)->name('ajax.select.port');