UniFi API browser 2.0.16

- updated PHP API client to 1.1.64 - several minor code changes based on Code Inspector feedback - added check in `index.php` to verify whether `$users` array exists and isn't empty, thanks to @scyto for submitting PR #85 - applied default payload for `stat_monthly_gateway()` to collect all available metrics
Art-of-WiFi · Jan 21, 2021 · c35123a · c35123a
1 parent c75e2c5
commit c35123a
Show file tree

Hide file tree

Showing 51 changed files with 369 additions and 346 deletions.
diff --git a/ajax/fetch_about_modal_metrics.php b/ajax/fetch_about_modal_metrics.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
  * This file is subject to the MIT license that is bundled
@@ -11,16 +11,16 @@
 /**
  * load the files containing shared functions and the collections
  */
-require_once('../common.php');
-require_once('../collections.php');
+require_once '../common.php';
+require_once '../collections.php';
 
 /**
  * load the configuration file if readable
  */
 if (is_file('../config/config.php') && is_readable('../config/config.php')) {
-    include('../config/config.php');
+    include '../config/config.php';
 } else {
-    die();
+    exit;
 }
 
 /**

diff --git a/ajax/fetch_collection.php b/ajax/fetch_collection.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
  * This file is subject to the MIT license that is bundled
@@ -12,17 +12,17 @@
  * load required packages using the composer autoloader together with the files containing shared functions
  * and the collections
  */
-require_once('../common.php');
-require_once('../collections.php');
-require_once('../vendor/autoload.php');
+require_once '../common.php';
+require_once '../collections.php';
+require_once '../vendor/autoload.php';
 
 /**
  * load the configuration file if readable
  */
 if (is_file('../config/config.php') && is_readable('../config/config.php')) {
-    include('../config/config.php');
+    include '../config/config.php';
 } else {
-    die();
+    exit;
 }
 
 /**
@@ -118,7 +118,10 @@
                 break;
             case 'stat_daily_gateway':
                 $params = [null, null, $gateway_stats_attribs];
-        }
+
+                break;
+            case 'stat_monthly_gateway':
+                $params = [null, null, $gateway_stats_attribs];        }
     }
 
     if (!empty($method) && !empty($site_id)) {
@@ -212,4 +215,4 @@
 header('Content-Type: application/json; charset=utf-8');
 echo (json_encode($results));
 
-$_SESSION['memory_used'] = round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'M';
+$_SESSION['memory_used'] = round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'MB';
diff --git a/ajax/fetch_sites.php b/ajax/fetch_sites.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
  * This file is subject to the MIT license that is bundled
@@ -12,17 +12,17 @@
  * load required packages using the composer autoloader together with the files containing shared functions
  * and the collections
  */
-require_once('../common.php');
-require_once('../collections.php');
-require_once('../vendor/autoload.php');
+require_once '../common.php';
+require_once '../collections.php';
+require_once '../vendor/autoload.php';
 
 /**
  * load the configuration file if readable
  */
 if (is_file('../config/config.php') && is_readable('../config/config.php')) {
-    include('../config/config.php');
+    include '../config/config.php';
 } else {
-    die();
+    exit;
 }
 
 /**
@@ -141,4 +141,4 @@
 header('Content-Type: application/json; charset=utf-8');
 echo (json_encode($results));
 
-$_SESSION['memory_used'] = round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'M';
+$_SESSION['memory_used'] = round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'MB';
diff --git a/ajax/show_api_debug.php b/ajax/show_api_debug.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
  * This file is subject to the MIT license that is bundled
@@ -12,17 +12,17 @@
  * load required packages using the composer autoloader together with the files containing shared functions
  * and the collections
  */
-require_once('../common.php');
-require_once('../collections.php');
-require_once('../vendor/autoload.php');
+require_once '../common.php';
+require_once '../collections.php';
+require_once '../vendor/autoload.php';
 
 /**
  * load the configuration file if readable
  */
 if (is_file('../config/config.php') && is_readable('../config/config.php')) {
-    include('../config/config.php');
+    include '../config/config.php';
 } else {
-    die();
+    exit;
 }
 
 /**

diff --git a/ajax/update_controller.php b/ajax/update_controller.php
@@ -1,26 +1,24 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**
  * load required files containing shared functions and the collections
  */
-require_once('../common.php');
-require_once('../collections.php');
+require_once '../common.php';
+require_once '../collections.php';
 
 /**
  * load the configuration file if readable
  */
 if (is_file('../config/config.php') && is_readable('../config/config.php')) {
-    include('../config/config.php');
+    include '../config/config.php';
 } else {
-    die();
+    exit;
 }
 
 /**

diff --git a/ajax/update_theme.php b/ajax/update_theme.php
@@ -1,26 +1,24 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**
  * load required files containing shared functions and the collections
  */
-require_once('../common.php');
-require_once('../collections.php');
+require_once '../common.php';
+require_once '../collections.php';
 
 /**
  * load the configuration file if readable
  */
 if (is_file('../config/config.php') && is_readable('../config/config.php')) {
-    include('../config/config.php');
+    include '../config/config.php';
 } else {
-    die();
+    exit;
 }
 
 /**

diff --git a/collections.php b/collections.php
@@ -1,11 +1,9 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**

diff --git a/common.php b/common.php
@@ -1,28 +1,25 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
-define('TOOL_VERSION', '2.0.15');
+define('TOOL_VERSION', '2.0.16');
 
 /**
  * gather some basic information for the About modal
  */
 $curl_info      = curl_version();
 $unknown_string = 'unknown';
-
 /**
  * create the array to pass on to the twig templates
  */
 $about_modal_params = [
     'os_version'          => php_uname('s') . ' ' . php_uname('r'),
     'php_version'         => phpversion(),
-    'memory_limit'        => ini_get('memory_limit'),
-    'memory_used'         => round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'M',
+    'memory_limit'        => ini_get('memory_limit') . 'B',
+    'memory_used'         => round(memory_get_peak_usage(false) / 1024 / 1024, 2) . 'MB',
     'curl_version'        => $curl_info['version'],
     'openssl_version'     => $curl_info['ssl_version'],
     'api_client_version'  => getClientVersion(),

diff --git a/composer.lock b/composer.lock
diff --git a/config/config-template.php b/config/config-template.php
@@ -1,11 +1,9 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**

diff --git a/config/users-template.php b/config/users-template.php
@@ -1,11 +1,9 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**

diff --git a/index.php b/index.php
@@ -1,11 +1,9 @@
 <?php
 /**
- * Copyright (c) 2019, Art of WiFi
+ * Copyright (c) 2021, Art of WiFi
  * www.artofwifi.net
  *
- * This file is subject to the MIT license that is bundled
- * with this package in the file LICENSE.md
- *
+ * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md
  */
 
 /**
@@ -32,9 +30,9 @@
  * load required packages using the composer autoloader together with the files containing shared functions
  * and the collections
  */
-require_once('vendor/autoload.php');
-require_once('common.php');
-require_once('collections.php');
+require_once 'vendor/autoload.php';
+require_once 'common.php';
+require_once 'collections.php';
 
 /**
  * initialize the Twig loader early on in case we need to render the error page
@@ -47,7 +45,7 @@
  * - if not, stop and display an error message
  */
 if (is_file('config/config.php') && is_readable('config/config.php')) {
-    require_once('config/config.php');
+    require_once 'config/config.php';
 } else {
     /**
      * render the config error page
@@ -56,7 +54,7 @@
         'error_message' => 'The file <b>config/config.php</b> does not exist! Please create one based on the <b>config/config-template.php</b> file!<br>',
     ]);
 
-    exit();
+    exit;
 }
 
 /**
@@ -81,7 +79,7 @@
         'error_message' => 'The <b>PHP curl</b> module is not installed! Please correct this before proceeding!<br>',
     ]);
 
-    exit();
+    exit;
 }
 
 /**
@@ -96,15 +94,20 @@
         'error_message' => 'The current PHP version (' . PHP_VERSION . ') does not meet the minimum required version which is 5.6.0. Please upgrade before proceeding!<br>',
     ]);
 
-    exit();
+    exit;
 }
 
 /**
  * load the file containing user accounts, if readable
  */
 if (is_file('config/users.php') && is_readable('config/users.php')) {
-    require_once('config/users.php');
-    $user_authentication = true;
+    require_once 'config/users.php';
+    if (isset($users) && is_array($users) && count($users) > 0) {
+        $user_authentication = true;
+    } else {
+        $user_authentication = false;
+        error_log('The $users array in the config/users.php file does not exist or is empty, proceeding without user authentication.');
+    }
 } else {
     $user_authentication = false;
     error_log('The file config/users.php does not exist, proceeding without user authentication.');