merge from master

Author: Yoyasp

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,9 @@ DO NOT DELETE THE UNDERLYING TEXT
 
 #### Please note
 
-> Please read this information carefully. You can run `./lnms dev:check` to check your code before submitting.
+> Please read this information carefully. Pull requests may be closed without explanation 
+> due to influx of low quality LLM generated pull requests.
+> You can run `./lnms dev:check` to check your code before submitting.
 
 - [ ] Have you followed our [code guidelines?](https://docs.librenms.org/Developing/Code-Guidelines/)
 - [ ] If my Pull Request does some changes/fixes/enhancements in the WebUI, I have inserted a screenshot of it.

.github/workflows/announcements.yml

@@ -12,16 +12,19 @@ jobs:
 
     steps:
       - name: Send Notification to Discord
-        if: contains(github.event.issue.labels.*.name, 'Breaking-Change')
+        if: contains(github.event.pull_request.labels.*.name, 'Breaking-Change')
         env:
-          DISCORD_WEBHOOK_URL: "${{ secrets.DISCORD_WEBHOOK_URL_ANNOUNCEMENT }}"
+          DISCORD_WEBHOOK_URL: ${{ secrets.DISCORD_WEBHOOK_URL_ANNOUNCEMENT }}
+          PR_TITLE: ${{ github.event.pull_request.title }}
+          PR_MESSAGE: ${{ github.event.pull_request.body }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
         run: |
-          PR_TITLE="${{ github.event.pull_request.title }}"
-          PR_MESSAGE="${{ github.event.pull_request.body }}"
-          PR_URL="${{ github.event.pull_request.html_url }}"
-
+          PAYLOAD=$(jq -n \
+            --arg title "$PR_TITLE" \
+            --arg url "$PR_URL" \
+            --arg body "$PR_MESSAGE" \
+            '{content: ":rotating_light: A breaking change pull request has been merged! :rotating_light:\n\n**Title**: \($title)\n[View PR](\($url))\n\n\($body)"}')
+      
           curl -X POST -H "Content-Type: application/json" \
-          -d "{
-            \"content\": \":rotating_light: A breaking change pull request has been merged! :rotating_light: \n\n**Title**: $PR_TITLE\n[View PR]($PR_URL)\n\n$PR_MESSAGE\"
-          }" \
-          $DISCORD_WEBHOOK_URL
+            -d "$PAYLOAD" \
+            "$DISCORD_WEBHOOK_URL"

LibreNMS/Cache/PermissionsCache.php

@@ -30,25 +30,30 @@
 use App\Models\Device;
 use App\Models\Port;
 use App\Models\User;
+use Illuminate\Database\Query\Builder;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Auth;
 use Illuminate\Support\Facades\DB;
 
 class PermissionsCache
 {
-    private $devicePermissions;
-    private $portPermissions;
-    private $billPermissions;
-    private $deviceGroupMap;
+    /** @var array<int, Collection<object{user_id: int, device_id: int}>> */
+    private array $devicePermissions = [];
+
+    /** @var array<int, Collection<int>> */
+    private array $deviceGroupMap = [];
+
+    /** @var Collection<object{user_id: int, port_id: int}>|null */
+    private ?Collection $portPermissions = null;
+
+    /** @var Collection<object{user_id: int, bill_id: int}>|null */
+    private ?Collection $billPermissions = null;
 
     /**
      * Check if a device can be accessed by user (non-global read/admin)
      * If no user is given, use the logged in user
-     *
-     * @param  Device|int  $device
-     * @param  User|int  $user
-     * @return bool
      */
-    public function canAccessDevice($device, $user = null)
+    public function canAccessDevice(Device|int $device, User|int|null $user = null): bool
     {
         return $this->getDevicePermissions($user)
             ->contains('device_id', $this->getDeviceId($device));
@@ -57,12 +62,8 @@ public function canAccessDevice($device, $user = null)
     /**
      * Check if a access can be accessed by user (non-global read/admin)
      * If no user is given, use the logged in user
-     *
-     * @param  Port|int  $port
-     * @param  User|int  $user
-     * @return bool
      */
-    public function canAccessPort($port, $user = null)
+    public function canAccessPort(Port|int $port, User|int|null $user = null): bool
     {
         return $this->getPortPermissions()
             ->where('user_id', $this->getUserId($user))
@@ -73,41 +74,21 @@ public function canAccessPort($port, $user = null)
     /**
      * Check if a bill can be accessed by user (non-global read/admin)
      * If no user is given, use the logged in user
-     *
-     * @param  Bill|int  $bill
-     * @param  User|int  $user
-     * @return bool
      */
-    public function canAccessBill($bill, $user = null)
+    public function canAccessBill(Bill|int $bill, User|int|null $user = null): bool
     {
         return $this->getBillPermissions()
             ->where('user_id', $this->getUserId($user))
             ->where('bill_id', $this->getBillId($bill))
             ->isNotEmpty();
     }
 
-    /**
-     * Get the user_id of users that have been granted access to device
-     *
-     * @param  Device|int  $device
-     * @return \Illuminate\Support\Collection
-     */
-    /*
-        public function usersForDevice($device)
-        {
-            return $this->getDevicePermissions()
-                ->where('device_id', $this->getDeviceId($device))
-                ->pluck('user_id');
-        }
-    */
-
     /**
      * Get the user_id of users that have been granted access to port
      *
-     * @param  Port|int  $port
-     * @return \Illuminate\Support\Collection
+     * @return Collection<int>
      */
-    public function usersForPort($port)
+    public function usersForPort(Port|int $port): Collection
     {
         return $this->getPortPermissions()
             ->where('port_id', $this->getPortId($port))
@@ -117,10 +98,9 @@ public function usersForPort($port)
     /**
      * Get the user_id of users that have been granted access to bill
      *
-     * @param  Bill|int  $bill
-     * @return \Illuminate\Support\Collection
+     * @return Collection<int>
      */
-    public function usersForBill($bill)
+    public function usersForBill(Bill|int $bill): Collection
     {
         return $this->getBillPermissions()
             ->where('bill_id', $this->getBillId($bill))
@@ -130,10 +110,9 @@ public function usersForBill($bill)
     /**
      * Get a list of device_id of all devices the user can access
      *
-     * @param  User|int  $user
-     * @return \Illuminate\Support\Collection
+     * @return Collection<int>
      */
-    public function devicesForUser($user = null)
+    public function devicesForUser(User|int|null $user = null): Collection
     {
         return $this->getDevicePermissions($user)
             ->pluck('device_id');
@@ -142,10 +121,9 @@ public function devicesForUser($user = null)
     /**
      * Get a list of port_id of all ports the user can access directly
      *
-     * @param  User|int  $user
-     * @return \Illuminate\Support\Collection
+     * @return Collection<int>
      */
-    public function portsForUser($user = null)
+    public function portsForUser(User|int|null $user = null): Collection
     {
         return $this->getPortPermissions()
             ->where('user_id', $this->getUserId($user))
@@ -155,10 +133,9 @@ public function portsForUser($user = null)
     /**
      * Get a list of bill_id of all bills the user can access directly
      *
-     * @param  User|int  $user
-     * @return \Illuminate\Support\Collection
+     * @return Collection<int>
      */
-    public function billsForUser($user = null)
+    public function billsForUser(User|int|null $user = null): Collection
     {
         return $this->getBillPermissions()
             ->where('user_id', $this->getUserId($user))
@@ -168,10 +145,9 @@ public function billsForUser($user = null)
     /**
      * Get the ids of all device groups the user can access
      *
-     * @param  User|int  $user
-     * @return \Illuminate\Support\Collection
+     * @return Collection<int>
      */
-    public function deviceGroupsForUser($user = null)
+    public function deviceGroupsForUser(User|int|null $user = null): Collection
     {
         $user_id = $this->getUserId($user);
 
@@ -189,10 +165,9 @@ public function deviceGroupsForUser($user = null)
     /**
      * Get the cached data for device permissions.  Use helpers instead.
      *
-     * @param  User|int  $user
-     * @return \Illuminate\Support\Collection
+     * @return Collection<object{user_id: int, device_id: int}>
      */
-    public function getDevicePermissions($user = null)
+    public function getDevicePermissions(User|int|null $user = null): Collection
     {
         $user_id = $this->getUserId($user);
 
@@ -210,9 +185,9 @@ public function getDevicePermissions($user = null)
     /**
      * Get the cached data for port permissions.  Use helpers instead.
      *
-     * @return \Illuminate\Support\Collection
+     * @return Collection<object{user_id: int, port_id: int}>
      */
-    public function getPortPermissions()
+    public function getPortPermissions(): Collection
     {
         if (is_null($this->portPermissions)) {
             $this->portPermissions = DB::table('ports_perms')
@@ -226,9 +201,9 @@ public function getPortPermissions()
     /**
      * Get the cached data for bill permissions.  Use helpers instead.
      *
-     * @return \Illuminate\Support\Collection
+     * @return Collection<object{user_id: int, bill_id: int}>
      */
-    public function getBillPermissions()
+    public function getBillPermissions(): Collection
     {
         if (is_null($this->billPermissions)) {
             $this->billPermissions = DB::table('bill_perms')
@@ -238,52 +213,42 @@ public function getBillPermissions()
         return $this->billPermissions;
     }
 
-    /**
-     * @param  mixed  $user
-     * @return int|null
-     */
-    private function getUserId($user)
+    public function invalidateCache(): void
+    {
+        $this->devicePermissions = [];
+        $this->deviceGroupMap = [];
+        $this->portPermissions = null;
+        $this->billPermissions = null;
+    }
+
+    private function getUserId(User|int|null $user): ?int
     {
         return $user instanceof User ? $user->user_id : (is_numeric($user) ? (int) $user : Auth::id());
     }
 
-    /**
-     * @param  mixed  $device
-     * @return int
-     */
-    private function getDeviceId($device)
+    private function getDeviceId(Device|int|null $device): int
     {
         return $device instanceof Device ? $device->device_id : (is_numeric($device) ? (int) $device : 0);
     }
 
-    /**
-     * @param  mixed  $port
-     * @return int
-     */
-    private function getPortId($port)
+    private function getPortId(Port|int|null $port): int
     {
         return $port instanceof Port ? $port->port_id : (is_numeric($port) ? (int) $port : 0);
     }
 
-    /**
-     * @param  mixed  $bill
-     * @return int
-     */
-    private function getBillId($bill)
+    private function getBillId(Bill|int|null $bill): int
     {
         return $bill instanceof Bill ? $bill->bill_id : (is_numeric($bill) ? (int) $bill : 0);
     }
 
-    /**
-     * @return \Illuminate\Database\Query\Builder
-     */
-    public function getDeviceGroupPermissionsQuery()
+    private function getDeviceGroupPermissionsQuery(): Builder
     {
         return DB::table('devices_group_perms')
-        ->select('devices_group_perms.user_id', 'device_group_device.device_id')
-        ->join('device_group_device', 'device_group_device.device_group_id', '=', 'devices_group_perms.device_group_id')
-        ->when(! LibrenmsConfig::get('permission.device_group.allow_dynamic'), fn ($query) => $query
-            ->join('device_groups', 'device_groups.id', '=', 'devices_group_perms.device_group_id')
-            ->where('device_groups.type', 'static'));
+            ->select('devices_group_perms.user_id', 'device_group_device.device_id')
+            ->join('device_group_device', 'device_group_device.device_group_id', '=',
+                'devices_group_perms.device_group_id')
+            ->when(! LibrenmsConfig::get('permission.device_group.allow_dynamic'), fn ($query) => $query
+                ->join('device_groups', 'device_groups.id', '=', 'devices_group_perms.device_group_id')
+                ->where('device_groups.type', 'static'));
     }
 }