v1.1

- Fixed: Update email pattern in `cleanMessage()` method to handle local addresses without TLD and to allow using the caracter `@` in custom message. Close #4

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 kristuff
+Copyright (c) 2020-2022 kristuff
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -16,7 +16,8 @@ Features
 - Single IP report request **✓** 
 - Bulk report request (send `csv` file) **✓** 
 - Clear IP address request (remove your own reports) **✓**
-- Auto cleaning report comments from sensitive data (email, custom ip/domain names list)  **✓** 
+- Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓** 
+- Define timeout for cURL internal requests **✓**
 
 Requirements
 ------------    
@@ -32,7 +33,7 @@ Deploy with composer:
 ```json
 ...
 "require": {
-    "kristuff/abuseipdb": "^0.9.13-stable"
+    "kristuff/abuseipdb": "^1.1-stable"
 },
 ```
 
@@ -49,7 +50,7 @@ License
 
 The MIT License (MIT)
 
-Copyright (c) 2020-2021 Kristuff
+Copyright (c) 2020-2022 Kristuff
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

lib/ApiBase.php

@@ -1,12 +1,11 @@
 <?php declare(strict_types=1);
 
 /**
- *     _    _                    ___ ____  ____  ____
- *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
- *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
- *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
- * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
- *
+ *       _                 ___ ___ ___  ___
+ *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
+ * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
+ * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
+ * 
  * This file is part of Kristuff\AbuseIPDB.
  *
  * (c) Kristuff <kristuff@kristuff.fr>
@@ -14,8 +13,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @version    0.9.13
- * @copyright  2020-2021 Kristuff
+ * @version    1.1
+ * @copyright  2020-2022 Kristuff
  */
 
 namespace Kristuff\AbuseIPDB;

lib/ApiHandler.php

@@ -1,12 +1,11 @@
 <?php declare(strict_types=1);
 
 /**
- *     _    _                    ___ ____  ____  ____
- *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
- *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
- *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
- * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
- *
+ *       _                 ___ ___ ___  ___
+ *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
+ * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
+ * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
+ * 
  * This file is part of Kristuff\AbuseIPDB.
  *
  * (c) Kristuff <kristuff@kristuff.fr>
@@ -14,8 +13,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @version    0.9.13
- * @copyright  2020-2021 Kristuff
+ * @version    1.1
+ * @copyright  2020-2022 Kristuff
  */
 
 namespace Kristuff\AbuseIPDB;
@@ -35,7 +34,7 @@ class ApiHandler extends ApiBase
     /**
      * @var string
      */
-    const VERSION = 'v0.9.13'; 
+    const VERSION = 'v1.1'; 
 
     /**
      * The ips to remove from report messages
@@ -46,18 +45,46 @@ class ApiHandler extends ApiBase
      */
     protected $selfIps = []; 
 
+    /**
+     * The maximum number of milliseconds to allow cURL functions to execute. If libcurl is 
+     * built to use the standard system name resolver, that portion of the connect will still 
+     * use full-second resolution for timeouts with a minimum timeout allowed of one second. 
+     * 
+     * @access protected
+     * @var int  
+     */
+    protected $timeout = 0; 
+
     /**
      * Constructor
      * 
      * @access public
      * @param string  $apiKey     The AbuseIPDB api key
      * @param array   $myIps      The Ips/domain name you don't want to display in report messages
+     * @param int     $timeout    The maximum number of milliseconds to allow internal cURL functions 
+     *                            to execute. Default is 0, no timeout
      * 
      */
-    public function __construct(string $apiKey, array $myIps = [])
+    public function __construct(string $apiKey, array $myIps = [], int $timeout = 0)
     {
         $this->aipdbApiKey = $apiKey;
         $this->selfIps = $myIps;
+        $this->timeout = $timeout;
+    }
+
+    /**
+     * Sets the cURL timeout (apply then to any API request). Overwrites the value passed in 
+     * constructor, useful when performing multiple queries with same handler but different timeout.
+     * 
+     * @access public
+     * @param int     $timeout    The maximum number of milliseconds to allow internal cURL functions 
+     *                            to execute.
+     * 
+     * @return void
+     */
+    public function setTimeout(int $timeout): void
+    {
+        $this->timeout = $timeout;
     }
 
     /**
@@ -72,6 +99,7 @@ class ApiHandler extends ApiBase
         return array(
             'apiKey'  => $this->aipdbApiKey,
             'selfIps' => $this->selfIps,
+            'timeout' => $this->timeout, 
         );
     }
 
@@ -160,6 +188,7 @@ class ApiHandler extends ApiBase
      * @return ApiResponse
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
+     * @throws InvalidPermissionException
      */
     public function bulkReport(string $filePath): ApiResponse
     {
@@ -356,9 +385,10 @@ class ApiHandler extends ApiBase
      */
     protected function apiRequest(string $path, array $data, string $method = 'GET', string $csvFilePath = ''): ApiResponse
     {
-        // set api url
-        $url = $this->aipdbApiEndpoint . $path; 
-
+        $curlErrorNumber = -1;                   // will be used later to check curl execution
+        $curlErrorMessage = '';
+        $url = $this->aipdbApiEndpoint . $path;  // api url
+        
         // set the wanted format, JSON (required to prevent having full html page on error)
         // and the AbuseIPDB API Key as a header
         $headers = [
@@ -386,17 +416,35 @@ class ApiHandler extends ApiBase
             $url .= '?' . http_build_query($data);
         }
 
-        // set the url to call
+        // set url and options
         $this->setCurlOption($ch, CURLOPT_URL, $url);
         $this->setCurlOption($ch, CURLOPT_RETURNTRANSFER, 1); 
         $this->setCurlOption($ch, CURLOPT_HTTPHEADER, $headers);
-    
+        
+        /**
+         * set timeout  
+         * 
+         * @see https://curl.se/libcurl/c/CURLOPT_TIMEOUT_MS.html
+         * @see https://curl.se/libcurl/c/CURLOPT_CONNECTTIMEOUT_MS.html
+         *  If libcurl is built to use the standard system name resolver, that portion of the transfer 
+         *  will still use full-second resolution for timeouts with a minimum timeout allowed of one second. 
+         *  In unix-like systems, this might cause signals to be used unless CURLOPT_NOSIGNAL is set. 
+         */
+        $this->setCurlOption($ch, CURLOPT_NOSIGNAL, 1);
+        $this->setCurlOption($ch, CURLOPT_TIMEOUT_MS, $this->timeout);
+
         // execute curl call
         $result = curl_exec($ch);
-    
+        $curlErrorNumber = curl_errno($ch);
+        $curlErrorMessage = curl_error($ch);
+
         // close connection
         curl_close($ch);
-  
+
+        if ($curlErrorNumber !== 0){
+            throw new \RuntimeException($curlErrorMessage);
+        }
+
         return new ApiResponse($result !== false ? $result : '');
     }
 
@@ -421,8 +469,8 @@ class ApiHandler extends ApiBase
         }
 
         // If we're reporting spam, further munge any email addresses in the report
-        $emailPattern = "/[^@\s]*@[^@\s]*\.[^@\s]*/";
-        $message = preg_replace($emailPattern, "*", $message);
+        $emailPattern   = "/\b[A-Z0-9!#$%&'*`\/?^{|}~=+_.-]+@[A-Z0-9.-]+\b/i";
+        $message        = preg_replace($emailPattern, "*", $message);
         
         // Make sure message is less 1024 chars
         return substr($message, 0, 1024);

lib/ApiResponse.php

@@ -1,12 +1,11 @@
 <?php declare(strict_types=1);
 
 /**
- *     _    _                    ___ ____  ____  ____
- *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
- *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
- *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
- * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
- *
+ *       _                 ___ ___ ___  ___
+ *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
+ * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
+ * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
+ * 
  * This file is part of Kristuff\AbuseIPDB.
  *
  * (c) Kristuff <kristuff@kristuff.fr>
@@ -14,8 +13,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @version    0.9.13
- * @copyright  2020-2021 Kristuff
+ * @version    1.1
+ * @copyright  2020-2022 Kristuff
  */
 
 namespace Kristuff\AbuseIPDB;

lib/CurlTrait.php

@@ -1,12 +1,11 @@
 <?php declare(strict_types=1);
 
 /**
- *     _    _                    ___ ____  ____  ____
- *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
- *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
- *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
- * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
- *
+ *       _                 ___ ___ ___  ___
+ *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
+ * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
+ * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
+ * 
  * This file is part of Kristuff\AbuseIPDB.
  *
  * (c) Kristuff <kristuff@kristuff.fr>
@@ -14,8 +13,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @version    0.9.13
- * @copyright  2020-2021 Kristuff
+ * @version    1.1
+ * @copyright  2020-2022 Kristuff
  */
 
 namespace Kristuff\AbuseIPDB;

lib/InvalidPermissionException.php

@@ -1,12 +1,11 @@
 <?php declare(strict_types=1);
 
 /**
- *     _    _                    ___ ____  ____  ____
- *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
- *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
- *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
- * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
- *
+ *       _                 ___ ___ ___  ___
+ *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
+ * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
+ * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
+ * 
  * This file is part of Kristuff\AbuseIPDB.
  *
  * (c) Kristuff <kristuff@kristuff.fr>
@@ -14,8 +13,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @version    0.9.13
- * @copyright  2020-2021 Kristuff
+ * @version    1.1
+ * @copyright  2020-2022 Kristuff
  */
 
 namespace Kristuff\AbuseIPDB;

lib/QuietApiHandler.php

@@ -1,12 +1,11 @@
 <?php declare(strict_types=1);
 
 /**
- *     _    _                    ___ ____  ____  ____
- *    / \  | |__  _   _ ___  ___|_ _|  _ \|  _ \| __ )
- *   / _ \ | '_ \| | | / __|/ _ \| || |_) | | | |  _ \
- *  / ___ \| |_) | |_| \__ \  __/| ||  __/| |_| | |_) |
- * /_/   \_\_.__/ \__,_|___/\___|___|_|   |____/|____/
- *
+ *       _                 ___ ___ ___  ___
+ *  __ _| |__ _  _ ___ ___|_ _| _ \   \| _ )
+ * / _` | '_ \ || (_-</ -_)| ||  _/ |) | _ \
+ * \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
+ * 
  * This file is part of Kristuff\AbuseIPDB.
  *
  * (c) Kristuff <kristuff@kristuff.fr>
@@ -14,8 +13,8 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  *
- * @version    0.9.13
- * @copyright  2020-2021 Kristuff
+ * @version    1.1
+ * @copyright  2020-2022 Kristuff
  */
 
 namespace Kristuff\AbuseIPDB;