Cleanups (#12642)

Should only be cosmetic

LibreNMS/Alert/Transport/Boxcar.php

@@ -68,6 +68,9 @@ class Boxcar extends Transport
                     $data['notification[sound]'] = $api['sound_warning'];
                 }
                 break;
+            default:
+                $severity = 'Unknown';
+                break;
         }
         switch ($obj['state']) {
             case AlertState::RECOVERED:
@@ -82,6 +85,10 @@ class Boxcar extends Transport
             case AlertState::ACKNOWLEDGED:
                 $title_text = 'Acknowledged';
                 break;
+            default:
+                $title_text = $severity;
+                break;
+
         }
         $data['notification[title]'] = $title_text . ' - ' . $obj['hostname'] . ' - ' . $obj['name'];
         $message_text = 'Timestamp: ' . $obj['timestamp'];

LibreNMS/Alert/Transport/Clickatell.php

@@ -46,7 +46,9 @@ class Clickatell extends Transport
         $ret = curl_exec($curl);
         $code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         if ($code > 200) {
-            return var_dump($ret);
+            var_dump($ret);
+
+            return;
         }
 
         return true;

LibreNMS/Alert/Transport/Elasticsearch.php

@@ -82,6 +82,9 @@ class Elasticsearch extends Transport
             case AlertState::BETTER:
                 $state = 'better';
                 break;
+            default:
+                $state = 'unknown';
+                break;
         }
 
         $data = [

LibreNMS/Alert/Transport/Osticket.php

@@ -31,6 +31,7 @@ class Osticket extends Transport
     {
         $url = $opts['url'];
         $token = $opts['token'];
+        $email = '';
 
         foreach (parse_email(Config::get('email_from')) as $from => $from_name) {
             $email = $from_name . ' <' . $from . '>';

LibreNMS/Alert/Transport/Playsms.php

@@ -53,7 +53,9 @@ class Playsms extends Transport
         $ret = curl_exec($curl);
         $code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
         if ($code > 202) {
-            return var_dump($ret);
+            var_dump($ret);
+
+            return;
         }
 
         return true;

LibreNMS/DB/Schema.php

@@ -144,6 +144,7 @@ class Schema
     public function getAllRelationshipPaths($base = 'devices')
     {
         $update_cache = true;
+        $cache = [];
         $cache_file = Config::get('install_dir') . "/cache/{$base}_relationships.cache";
         $db_version = Version::get()->database();
 

LibreNMS/Data/Store/Rrd.php

@@ -357,6 +357,7 @@ class Rrd extends BaseDatastore
     {
         global $vdebug;
         $stat = Measurement::start($this->coalesceStatisticType($command));
+        $output = null;
 
         try {
             $cmd = self::buildCommand($command, $filename, $options);

LibreNMS/OS/Allied.php

@@ -100,9 +100,9 @@ class Allied extends OS implements OSDiscovery
             $hardware = $e;
         }
 
-        $device->version = str_replace(['"', ','], '', $version);
-        $device->features = str_replace('"', '', $features);
-        $device->hardware = str_replace('"', '', $hardware);
-        $device->serial = $serial;
+        $device->version = str_replace(['"', ','], '', $version ?? null);
+        $device->features = str_replace('"', '', $features ?? null);
+        $device->hardware = str_replace('"', '', $hardware ?? null);
+        $device->serial = $serial ?? null;
     }
 }

LibreNMS/Snmptrap/Handlers/OspfIfStateChange.php

@@ -79,6 +79,9 @@ class OspfIfStateChange implements SnmptrapHandler
             case 'loopback':
                 $severity = 4;
                 break;
+            default:
+                $severity = 0;
+                break;
         }
 
         Log::event("OSPF interface $port->ifName is $ospfPort->ospfIfState", $device->device_id, 'trap', $severity);

LibreNMS/Util/Clean.php

@@ -84,7 +84,7 @@ class Clean
             $value = htmlentities($value);
         }
 
-        if (! isset($purifier)) {
+        if (! $purifier instanceof HTMLPurifier) {
             // initialize HTML Purifier here since this is the only user
             $p_config = HTMLPurifier_Config::createDefault();
             $p_config->set('Cache.SerializerPath', Config::get('temp_dir', '/tmp'));

app/ApiClients/RipeApi.php

@@ -67,12 +67,10 @@ class RipeApi extends BaseApi
     }
 
     /**
-     * @param $uri
-     * @param $options
      * @return array|mixed
      * @throws ApiException
      */
-    private function makeApiCall($uri, $options)
+    private function makeApiCall(string $uri, array $options)
     {
         try {
             $response = $this->getClient()->get($uri, $options);

app/Console/Commands/SetConfigCommand.php

@@ -85,10 +85,9 @@ class SetConfigCommand extends LnmsCommand
     /**
      * Convert the string input into the appropriate PHP native type
      *
-     * @param $value
      * @return mixed
      */
-    private function juggleType($value)
+    private function juggleType(string $value)
     {
         $json = json_decode($value, true);
 

app/Console/Commands/SmokepingGenerateCommand.php

@@ -124,6 +124,7 @@ class SmokepingGenerateCommand extends LnmsCommand
     public function buildTargetsConfiguration($devices)
     {
         // Take the devices array and build it into a hierarchical list
+        $smokelist = [];
         foreach ($devices as $device) {
             $smokelist[$device->type][$device->hostname] = ['transport' => $device->transport];
         }
@@ -222,7 +223,7 @@ class SmokepingGenerateCommand extends LnmsCommand
     /**
      * Determine if a list of targets is needed, and write one if so
      *
-     * @param array $devices A list of devices to create a a config block for
+     * @param array $smokelist A list of devices to create a a config block for
      *
      * @return array
      */

app/Console/Kernel.php

@@ -49,7 +49,9 @@ class Kernel extends ConsoleKernel
     {
         if (is_null($this->artisan)) {
             parent::getArtisan();
+            /** @phpstan-ignore-next-line */
             $this->artisan->setName(\LibreNMS\Config::get('project_name', 'LibreNMS'));
+            /** @phpstan-ignore-next-line */
             $this->artisan->setVersion(Version::get()->local());
         }
 

app/Http/Controllers/Auth/RegisterController.php

@@ -60,7 +60,7 @@ class RegisterController extends Controller
      * Create a new user instance after a valid registration.
      *
      * @param  array  $data
-     * @return \App\User
+     * @return User
      */
     protected function create(array $data)
     {

app/Http/Controllers/Auth/TwoFactorController.php

@@ -199,10 +199,9 @@ class TwoFactorController extends Controller
     }
 
     /**
-     * @param $user
      * @return mixed
      */
-    private function loadSettings($user)
+    private function loadSettings(User $user)
     {
         if (Session::has('twofactoradd')) {
             return Session::get('twofactoradd');

app/Http/Controllers/Form/CopyDashboardController.php

@@ -53,7 +53,7 @@ class CopyDashboardController extends Controller
             $success = $dashboard_copy->save();
         }
 
-        if ($success) {
+        if ($success && isset($dashboard_copy)) {
             $widgets = UserWidget::where(['dashboard_id' => $dashboard_id, 'user_id' => Auth::id()])->get();
 
             foreach ($widgets as $widget) {

app/Http/Controllers/LegacyController.php

@@ -58,6 +58,7 @@ class LegacyController extends Controller
         $html = ob_get_clean();
         ob_end_clean();
 
+        /** @phpstan-ignore-next-line */
         if (isset($pagetitle) && is_array($pagetitle)) {
             // if prefix is set, put it in front
             if (Config::get('page_title_prefix')) {

app/Http/Controllers/PaginatedAjaxController.php

@@ -126,7 +126,6 @@ abstract class PaginatedAjaxController extends Controller
     {
         if ($search) {
             $query->where(function ($query) use ($fields, $search) {
-                /** @var Builder $query */
                 foreach ($fields as $field) {
                     $query->orWhere($field, 'like', '%' . $search . '%');
                 }

app/Http/Controllers/Select/ApplicationController.php

@@ -54,6 +54,9 @@ class ApplicationController extends SelectController
         return $query;
     }
 
+    /**
+     * @param Application $app
+     */
     public function formatItem($app)
     {
         return [

app/Http/Controllers/ServiceTemplateController.php

@@ -211,9 +211,9 @@ class ServiceTemplateController extends Controller
             }, $updated)) > 0;
         }
 
-        if ($template->isDirty() || $devices_updated || $device_groups_updated) {
+        if ($template->isDirty() || $devices_updated || isset($device_groups_updated)) {
             try {
-                if ($template->save() || $devices_updated || $device_groups_updated) {
+                if ($template->save() || $devices_updated || isset($device_groups_updated)) {
                     Toastr::success(__('Service Template :name updated', ['name' => $template->name]));
                 } else {
                     Toastr::error(__('Failed to save'));

app/Http/Controllers/Table/DeviceController.php

@@ -255,10 +255,10 @@ class DeviceController extends TableController
     }
 
     /**
-     * @param $device
-     * @param $count
-     * @param $tab
-     * @param $icon
+     * @param int|Device $device
+     * @param mixed $count
+     * @param mixed $tab
+     * @param mixed $icon
      * @return string
      */
     private function formatMetric($device, $count, $tab, $icon)

app/Http/Controllers/Table/GraylogController.php

@@ -144,7 +144,7 @@ class GraylogController extends SimpleTableController
 
     /**
      * Cache device lookups so we don't lookup for every entry
-     * @param $source
+     * @param mixed $source
      * @return mixed
      */
     private function deviceFromSource($source)

app/Http/Controllers/Table/RoutesTablesController.php

@@ -164,6 +164,9 @@ class RoutesTablesController extends TableController
         return $query;
     }
 
+    /**
+     * @param Route $route_entry
+     */
     public function formatItem($route_entry)
     {
         $item = $route_entry->toArray();

app/Http/Controllers/Table/SyslogController.php

@@ -25,7 +25,6 @@
 namespace App\Http\Controllers\Table;
 
 use App\Models\Syslog;
-use Illuminate\Database\Eloquent\Builder;
 
 class SyslogController extends TableController
 {
@@ -68,7 +67,6 @@ class SyslogController extends TableController
      */
     public function baseQuery($request)
     {
-        /** @var Builder $query */
         return Syslog::hasAccess($request->user())
             ->with('device')
             ->when($request->device_group, function ($query) use ($request) {
@@ -109,7 +107,7 @@ class SyslogController extends TableController
 
     /**
      * @param int $syslog_priority
-     * @return string $syslog_priority_icon
+     * @return string|void
      */
     private function priorityLabel($syslog_priority)
     {

app/Http/Controllers/UserController.php

@@ -202,7 +202,7 @@ class UserController extends Controller
 
     /**
      * @param User $user
-     * @param $dashboard
+     * @param mixed $dashboard
      * @return bool
      */
     protected function updateDashboard(User $user, $dashboard)

app/Http/Controllers/Widgets/TopDevicesController.php

@@ -123,7 +123,7 @@ class TopDevicesController extends WidgetController
      * @param string $left_table
      * @return Builder
      */
-    private function withDeviceQuery($query, $left_table)
+    private function withDeviceQuery(Builder $query, $left_table)
     {
         $settings = $this->getSettings();
 
@@ -136,12 +136,12 @@ class TopDevicesController extends WidgetController
             ->groupBy("$left_table.device_id")
             ->where('devices.last_polled', '>', Carbon::now()->subMinutes($settings['time_interval']))
             ->when($settings['device_group'], function ($query) use ($settings) {
+                /** @var Builder<\App\Models\DeviceRelatedModel> $query */
                 $query->inDeviceGroup($settings['device_group']);
             });
     }
 
     /**
-     * @param Builder $query
      * @return Builder
      */
     private function deviceQuery()

app/Http/Controllers/Widgets/WidgetController.php

@@ -60,14 +60,11 @@ abstract class WidgetController extends Controller
     public function __invoke(Request $request)
     {
         $this->show_settings = (bool) $request->get('settings');
+        $settings = $this->getSettings();
 
         if ($this->show_settings) {
             $view = $this->getSettingsView($request);
-        }
-
-        $settings = $this->getSettings();
-
-        if (! $this->show_settings) {
+        } else {
             if (! empty($settings['device_group'])) {
                 $this->title .= ' (' . DeviceGroup::find($settings['device_group'])->name . ')';
             }

app/Jobs/PingCheck.php

@@ -223,9 +223,9 @@ class PingCheck implements ShouldQueue
      * If the device is on the current tier, record the data and remove it
      * $data should have keys: hostname, status, and conditionally rtt
      *
-     * @param $data
+     * @param array $data
      */
-    private function recordData($data)
+    private function recordData(array $data)
     {
         global $vdebug;
 
@@ -280,7 +280,7 @@ class PingCheck implements ShouldQueue
     /**
      * Done processing $hostname, remove it from our active data
      *
-     * @param $hostname
+     * @param string $hostname
      */
     private function complete($hostname)
     {
@@ -292,9 +292,9 @@ class PingCheck implements ShouldQueue
      * Defer this data processing until all parent devices are complete
      *
      *
-     * @param $data
+     * @param array $data
      */
-    private function defer($data)
+    private function defer(array $data)
     {
         $device = $this->devices->get($data['hostname']);
 

app/Models/AlertRule.php

@@ -34,7 +34,7 @@ class AlertRule extends BaseModel
     // ---- Query scopes ----
 
     /**
-     * @param Builder $query
+     * @param Builder<AlertRule> $query
      * @return Builder
      */
     public function scopeEnabled($query)
@@ -45,7 +45,7 @@ class AlertRule extends BaseModel
     /**
      * Scope for only alert rules that are currently in alarm
      *
-     * @param Builder $query
+     * @param Builder<AlertRule> $query
      * @return Builder
      */
     public function scopeIsActive($query)
@@ -59,7 +59,7 @@ class AlertRule extends BaseModel
      * Scope to filter rules for devices permitted to user
      * (do not use for admin and global read-only users)
      *
-     * @param $query
+     * @param Builder<AlertRule> $query
      * @param User $user
      * @return mixed
      */

app/Models/Device.php

@@ -328,10 +328,9 @@ class Device extends BaseModel
      * Update the location to the correct location and update GPS if needed
      *
      * @param  \App\Models\Location|string  $new_location  location data
-     * @param  string  $hostname
      * @param  bool  $doLookup try to lookup the GPS coordinates
      */
-    public function setLocation($new_location, $doLookup = false)
+    public function setLocation($new_location, bool $doLookup = false)
     {
         $new_location = $new_location instanceof Location ? $new_location : new Location(['location' => $new_location]);
         $new_location->location = $new_location->location ? Rewrite::location($new_location->location) : null;

app/Models/Notification.php

@@ -35,7 +35,7 @@ class Notification extends Model
      * @param bool $enabled
      * @return bool
      */
-    public function markRead($enabled = true)
+    public function markRead(bool $enabled = true): bool
     {
         return $this->setAttrib('read', $enabled);
     }
@@ -46,17 +46,17 @@ class Notification extends Model
      * @var bool
      * @return bool
      */
-    public function markSticky($enabled = true)
+    public function markSticky(bool $enabled = true): bool
     {
         return $this->setAttrib('sticky', $enabled);
     }
 
     /**
-     * @param $name
-     * @param $enabled
+     * @param string $name
+     * @param bool $enabled
      * @return bool
      */
-    private function setAttrib($name, $enabled)
+    private function setAttrib($name, bool $enabled): bool
     {
         if ($enabled === true) {
             $read = new NotificationAttrib;
@@ -74,7 +74,8 @@ class Notification extends Model
     // ---- Query Scopes ----
 
     /**
-     * @param Builder $query
+     * @param Builder<Notification> $query
+     * @param User $user
      * @return mixed
      */
     public function scopeIsUnread(Builder $query, User $user)
@@ -90,7 +91,7 @@ class Notification extends Model
     /**
      * Get all sticky notifications
      *
-     * @param Builder $query
+     * @param Builder<Notification> $query
      */
     public function scopeIsSticky(Builder $query)
     {
@@ -99,7 +100,7 @@ class Notification extends Model
     }
 
     /**
-     * @param Builder $query
+     * @param Builder<Notification> $query
      * @param User $user
      * @return mixed
      */
@@ -113,7 +114,7 @@ class Notification extends Model
     }
 
     /**
-     * @param Builder $query
+     * @param Builder<Notification> $query
      * @return $this
      */
     public function scopeLimit(Builder $query)
@@ -122,7 +123,7 @@ class Notification extends Model
     }
 
     /**
-     * @param Builder $query
+     * @param Builder<Notification> $query
      * @return Builder|static
      */
     public function scopeSource(Builder $query)

app/Policies/DeviceGroupPolicy.php

@@ -43,7 +43,7 @@ class DeviceGroupPolicy
     /**
      * Determine whether the user can view any device group.
      *
-     * @param  \App\User $user
+     * @param  \App\Models\User $user
      * @return mixed
      */
     public function viewAny(User $user)

app/Policies/PollerClusterPolicy.php

@@ -96,7 +96,6 @@ class PollerClusterPolicy
      * Determine whether the user can manage the poller cluster.
      *
      * @param  \App\Models\User  $user
-     * @param  \App\Models\PollerCluster  $pollerCluster
      * @return mixed
      */
     public function manage(User $user)

app/Policies/UserPolicy.php

@@ -12,7 +12,7 @@ class UserPolicy
     /**
      * Determine whether the user can manage users.
      *
-     * @param  \App\Models\User  $user
+     * @param  User  $user
      * @return bool
      */
     public function manage(User $user)
@@ -23,8 +23,8 @@ class UserPolicy
     /**
      * Determine whether the user can view the user.
      *
-     * @param  \App\Models\User  $user
-     * @param  \App\Models\User  $target
+     * @param  User  $user
+     * @param  User  $target
      * @return bool
      */
     public function view(User $user, User $target)
@@ -35,7 +35,7 @@ class UserPolicy
     /**
      * Determine whether the user can view any user.
      *
-     * @param  \App\User $user
+     * @param  User $user
      * @return mixed
      */
     public function viewAny(User $user)
@@ -46,7 +46,7 @@ class UserPolicy
     /**
      * Determine whether the user can create users.
      *
-     * @param  \App\Models\User  $user
+     * @param  User  $user
      * @return bool
      */
     public function create(User $user)
@@ -57,8 +57,8 @@ class UserPolicy
     /**
      * Determine whether the user can update the user.
      *
-     * @param  \App\Models\User  $user
-     * @param  \App\Models\User  $target
+     * @param  User  $user
+     * @param  User  $target
      * @return bool
      */
     public function update(User $user, User $target)
@@ -69,8 +69,8 @@ class UserPolicy
     /**
      * Determine whether the user can delete the user.
      *
-     * @param  \App\Models\User  $user
-     * @param  \App\Models\User  $target
+     * @param  User  $user
+     * @param  User  $target
      * @return bool
      */
     public function delete(User $user, User $target)

app/Providers/LegacyUserProvider.php

@@ -138,9 +138,8 @@ class LegacyUserProvider implements UserProvider
             }
             \Toastr::error($auth_message);
 
-            if (empty($username)) {
-                $username = Session::get('username', $credentials['username']);
-            }
+            $username = $username ?? Session::get('username', $credentials['username']);
+
             DB::table('authlog')->insert(['user' => $username, 'address' => Request::ip(), 'result' => $auth_message]);
         } finally {
             error_reporting(-1);

app/View/Components/Submenu.php

@@ -58,7 +58,7 @@ class Submenu extends Component
     /**
      * Determine if the given option is the current selected option.
      *
-     * @param  string  $option
+     * @param  string  $url
      * @return bool
      */
     public function isSelected($url)