Improve IP support flow

Author: relliv

config/ultimate-support.php

@@ -9,6 +9,16 @@
          */
         'get_local_public_ip' => true,
 
+        /**
+         * Use cache for local client IP address
+         *
+         * Cache key: ultimate-support:ip:local_public_ip
+         * Cache time: 1 day
+         *
+         * Default: true
+         */
+        'use_cache_for_local_public_ip' => true,
+
         /**
          * Enable/Disable get IP address failure logging
          *

src/Exceptions/IpAddressNotFoundException.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaravelReady\UltimateSupport\Exceptions;
+
+use Exception;
+
+class IpAddressNotFoundException extends Exception
+{
+    public function __construct(Exception $exp)
+    {
+        $message = 'IP address not found.' . PHP_EOL . $exp->getMessage();
+
+        parent::__construct($message);
+    }
+}

src/Supports/IpSupport.php

@@ -3,9 +3,11 @@
 namespace LaravelReady\UltimateSupport\Supports;
 
 use Exception;
-use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Facades\Config;
+use LaravelReady\UltimateSupport\Exceptions\IpAddressNotFoundException;
 
 class IpSupport
 {
@@ -18,7 +20,7 @@ class IpSupport
      */
     public static function isLocalhost(): bool
     {
-        return in_array($_SERVER['REMOTE_ADDR'], ['127.0.0.1', '::1', '172.27.0.1']);
+        return in_array(request()->ip(), ['127.0.0.1', '::1', '172.27.0.1']);
     }
 
     /**
@@ -28,19 +30,34 @@ public static function isLocalhost(): bool
      */
     public static function getPublicIp(): null | string
     {
-        $ipAddress = null;
+        $isCacheable = Config::get('ultimate-support.ip.use_cache_for_local_public_ip', true);
+        $cacheKey = 'ultimate-support:ip:local_public_ip';
+
+        if ($isCacheable) {
+            if (Cache::has($cacheKey)) {
+                $ipAddress = Cache::get($cacheKey, null);
+
+                if ($ipAddress !== null) {
+                    return $ipAddress;
+                }
+            }
+        }
 
         $response = Http::withoutVerifying()->get('https://api.ipify.org/?format=json');
 
         if ($response->ok()) {
             $ipAddress = $response->json()['ip'] ?? null;
 
-            if (!empty($ipAddress)) {
+            if ($ipAddress && filter_var($ipAddress, FILTER_VALIDATE_IP)) {
+                if ($isCacheable) {
+                    Cache::put($cacheKey, $ipAddress, now()->addDay());
+                }
+
                 return $ipAddress;
             }
-        }
 
-        return $ipAddress;
+            return $ipAddress;
+        }
     }
 
     /**
@@ -52,35 +69,46 @@ public static function getPublicIp(): null | string
      *
      * @return string
      */
-    public static function getIp(bool $getLocalPublicIp = true): string
+    public static function getIpAddress(bool $getLocalPublicIp = false): null | array
     {
-        $baseIp = $_SERVER['REMOTE_ADDR'];
+        $baseIpAddress = request()->ip();
 
         try {
             // get localhost public ip
-            if (($getLocalPublicIp && Config::get('ultimate-support.ip.get_local_public_ip')) && self::isLocalhost()) {
-                return self::getPublicIp();
+            if (($getLocalPublicIp || Config::get('ultimate-support.ip.get_local_public_ip')) && self::isLocalhost()) {
+                return [
+                    'is_local' => true,
+                    'base_ip' => $baseIpAddress,
+                    'ip_address' => self::getPublicIp(),
+                ];
             }
 
+            $ipAddress = $baseIpAddress;
+
             // check other conditions, cloudflare etc
             if (isset($_SERVER['HTTP_CF_CONNECTING_IP']) && filter_var($_SERVER['HTTP_CF_CONNECTING_IP'], FILTER_VALIDATE_IP)) {
-                return $_SERVER['HTTP_CF_CONNECTING_IP'];
+                $ipAddress = $_SERVER['HTTP_CF_CONNECTING_IP'];
             } elseif (isset($_SERVER['HTTP_X_REAL_IP']) && filter_var($_SERVER['HTTP_X_REAL_IP'], FILTER_VALIDATE_IP)) {
-                return $_SERVER['HTTP_X_REAL_IP'];
+                $ipAddress = $_SERVER['HTTP_X_REAL_IP'];
             } elseif (isset($_SERVER['HTTP_CLIENT_IP']) && filter_var($_SERVER['HTTP_CLIENT_IP'], FILTER_VALIDATE_IP)) {
-                return $_SERVER['HTTP_CLIENT_IP'];
+                $ipAddress = $_SERVER['HTTP_CLIENT_IP'];
             } elseif (isset($_SERVER['HTTP_X_FORWARDED_FOR'])) {
-                return $_SERVER['HTTP_X_FORWARDED_FOR'];
+                $ipAddress = $_SERVER['HTTP_X_FORWARDED_FOR'];
             }
+
+            return [
+                'is_local' => true,
+                'base_ip' => $baseIpAddress,
+                'ip_address' => $ipAddress
+            ];
         } catch (Exception $exp) {
             if (Config::get('ultimate-support.ip.get_local_public_ip')) {
                 Log::alert('Ultimate Support: getIP error', ['error' => $exp]);
             }
 
-            // TODO: add custom exception
-            throw $exp;
+            throw new IpAddressNotFoundException($exp);
         }
 
-        return $baseIp;
+        return $baseIpAddress;
     }
 }