From 82861c0f2e2bccf9c9d938f1dd3813a82a32d064 Mon Sep 17 00:00:00 2001 From: malle-pietje Date: Wed, 27 Oct 2021 15:35:33 +0200 Subject: [PATCH] UniFi API browser 2.0.20 - updated links in the About modal now that dereferer.org is no longer available - updated PHP API client to 1.1.73 --- .gitignore | 5 +- ajax/fetch_collection.php | 5 +- common.php | 4 +- composer.lock | 12 +- templates/components/about_modal.html.twig | 8 +- vendor/art-of-wifi/unifi-api-client/README.md | 5 +- .../examples/test_connection.php | 27 ++--- .../unifi-api-client/src/Client.php | 103 +++++++++++------- vendor/composer/InstalledVersions.php | 10 +- vendor/composer/installed.json | 14 +-- vendor/composer/installed.php | 10 +- 11 files changed, 114 insertions(+), 89 deletions(-) diff --git a/.gitignore b/.gitignore index 44ed971..638fd02 100755 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# Ignore personal config file +# Ignore personal config files config/config.php config/users.php @@ -11,4 +11,5 @@ desktop.ini .Spotlight-V100 .Trashes ehthumbs.db -Thumbs.db \ No newline at end of file +Thumbs.db +/.idea diff --git a/ajax/fetch_collection.php b/ajax/fetch_collection.php index 8560251..753400e 100755 --- a/ajax/fetch_collection.php +++ b/ajax/fetch_collection.php @@ -74,7 +74,7 @@ 'data' => [] ]; -$output_method = 'json'; +$output_method = 'json'; if (!empty($_SESSION['controller'])) { $method = ''; @@ -118,7 +118,8 @@ $params = [null, null, $gateway_stats_attribs]; break; case 'stat_monthly_gateway': - $params = [null, null, $gateway_stats_attribs]; } + $params = [null, null, $gateway_stats_attribs]; + } } if (!empty($method) && !empty($site_id)) { diff --git a/common.php b/common.php index 07a5893..e93a04a 100755 --- a/common.php +++ b/common.php @@ -5,7 +5,7 @@ * * This file is subject to the MIT license that is bundled with this package in the file LICENSE.md */ -define('TOOL_VERSION', '2.0.19'); +define('TOOL_VERSION', '2.0.20'); /** * gather some basic information for the About modal @@ -48,4 +48,4 @@ function getClientVersion() } } return 'unknown'; -} \ No newline at end of file +} diff --git a/composer.lock b/composer.lock index 3cfdbfb..a68315b 100755 --- a/composer.lock +++ b/composer.lock @@ -8,16 +8,16 @@ "packages": [ { "name": "art-of-wifi/unifi-api-client", - "version": "v1.1.72", + "version": "v1.1.73", "source": { "type": "git", "url": "https://github.com/Art-of-WiFi/UniFi-API-client.git", - "reference": "9cca43557c7f6454eb044d5c04a676630825872a" + "reference": "310abc43b52518853b671e3fa46423c007ccac79" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Art-of-WiFi/UniFi-API-client/zipball/9cca43557c7f6454eb044d5c04a676630825872a", - "reference": "9cca43557c7f6454eb044d5c04a676630825872a", + "url": "https://api.github.com/repos/Art-of-WiFi/UniFi-API-client/zipball/310abc43b52518853b671e3fa46423c007ccac79", + "reference": "310abc43b52518853b671e3fa46423c007ccac79", "shasum": "" }, "require": { @@ -54,9 +54,9 @@ ], "support": { "issues": "https://github.com/Art-of-WiFi/UniFi-API-client/issues", - "source": "https://github.com/Art-of-WiFi/UniFi-API-client/tree/v.1.1.72" + "source": "https://github.com/Art-of-WiFi/UniFi-API-client/tree/v1.1.73" }, - "time": "2021-10-19T08:39:17+00:00" + "time": "2021-10-23T09:14:25+00:00" }, { "name": "kint-php/kint", diff --git a/templates/components/about_modal.html.twig b/templates/components/about_modal.html.twig index b2bd8ea..5ac12d0 100755 --- a/templates/components/about_modal.html.twig +++ b/templates/components/about_modal.html.twig @@ -11,23 +11,23 @@
- A tool for browsing the data collections that are exposed through Ubiquiti's UniFi Controller API, created by Art of WiFi. + A tool for browsing the data collections that are exposed through Ubiquiti's UniFi Controller API, created by Art of WiFi.

- UniFi API browser on Github + UniFi API browser on Github
- UniFi API browser on Ubiquiti Community forum + UniFi API browser on Ubiquiti Community forum
- UniFi API client on Github + UniFi API client on Github
diff --git a/vendor/art-of-wifi/unifi-api-client/README.md b/vendor/art-of-wifi/unifi-api-client/README.md index ff62269..5b0cbf3 100755 --- a/vendor/art-of-wifi/unifi-api-client/README.md +++ b/vendor/art-of-wifi/unifi-api-client/README.md @@ -107,7 +107,7 @@ require_once 'vendor/autoload.php'; * initialize the UniFi API connection class, log in to the controller and request the alarms collection * (this example assumes you have already assigned the correct values to the variables used) */ -$unifi_connection = new UniFi_API\Client($controller_user, $controller_password $controller_url, $site_id, $controller_version, true); +$unifi_connection = new UniFi_API\Client($controller_user, $controller_password, $controller_url, $site_id, $controller_version, true); $login = $unifi_connection->login(); $results = $unifi_connection->list_alarms(); // returns a PHP array containing alarm objects ``` @@ -133,7 +133,7 @@ own PHP code. The class currently supports the following functions/methods to GET/POST/PUT/DELETE data through the UniFi Controller API. Please refer to the comments in the source code for -more details on the functions/methods and their respective parameters. +more details on each of the functions/methods and their respective parameters. - login() - logout() @@ -170,6 +170,7 @@ more details on the functions/methods and their respective parameters. - disable_ap() - edit_apgroup() (supported with controller versions 6.0.X and higher) - edit_client_fixedip() +- edit_client_name() - edit_firewallgroup() - edit_usergroup() - extend_guest_validity() diff --git a/vendor/art-of-wifi/unifi-api-client/examples/test_connection.php b/vendor/art-of-wifi/unifi-api-client/examples/test_connection.php index bd3d379..c1b9be4 100755 --- a/vendor/art-of-wifi/unifi-api-client/examples/test_connection.php +++ b/vendor/art-of-wifi/unifi-api-client/examples/test_connection.php @@ -29,24 +29,25 @@ if (is_resource($ch) || is_object($ch)) { /** * If we have a resource or object (for PHP > 8.0), we proceed and set the required cURL options - */ - curl_setopt($ch, CURLOPT_URL, $controllerurl); - curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); - curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); - curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); - - /** - * This cURL option can have a value of 0-6 + * + * NOTES: + * The cURL option CURLOPT_SSLVERSION can have a value of 0-6 * see this URL for more details: * http://php.net/manual/en/function.curl-setopt.php * 0 is the default value and is used by the PHP API client class */ - curl_setopt($ch, CURLOPT_SSLVERSION, 0); + $curl_options = [ + CURLOPT_PROTOCOLS => CURLPROTO_HTTPS, + CURLOPT_URL => $controllerurl, + CURLOPT_CUSTOMREQUEST => 'GET', + CURLOPT_SSL_VERIFYPEER => false, + CURLOPT_SSL_VERIFYHOST => false, + CURLOPT_VERBOSE => true, + CURLOPT_SSLVERSION => 0, + CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, + ]; - /** - * Be more verbose - */ - curl_setopt($ch, CURLOPT_VERBOSE, true); + curl_setopt_array($ch, $curl_options); /** * $results contains the output as returned by the cURL request, diff --git a/vendor/art-of-wifi/unifi-api-client/src/Client.php b/vendor/art-of-wifi/unifi-api-client/src/Client.php index 32f3df0..fd6ef55 100755 --- a/vendor/art-of-wifi/unifi-api-client/src/Client.php +++ b/vendor/art-of-wifi/unifi-api-client/src/Client.php @@ -24,9 +24,9 @@ class Client * private and protected properties * * NOTE: - * do not modify the values here, instead user the constructor or the getter and setter functions/methods + * do not modify the values here, instead use the constructor or the getter and setter functions/methods */ - const CLASS_VERSION = '1.1.72'; + const CLASS_VERSION = '1.1.73'; protected $baseurl = 'https://127.0.0.1:8443'; protected $user = ''; protected $password = ''; @@ -60,7 +60,7 @@ class Client * @param string $version optional, the version number of the controller * @param bool $ssl_verify optional, whether to validate the controller's SSL certificate or not, a value of true * is recommended for production environments to prevent potential MitM attacks, default - * value (false) disables validation of the controller certificate + * value (false) disables validation of the controller's SSL certificate */ public function __construct($user, $password, $baseurl = '', $site = '', $version = '', $ssl_verify = false) { @@ -85,7 +85,7 @@ public function __construct($user, $password, $baseurl = '', $site = '', $versio $this->version = trim($version); } - if ((boolean)$ssl_verify === true) { + if ((bool) $ssl_verify === true) { $this->curl_ssl_verify_peer = true; $this->curl_ssl_verify_host = 2; } @@ -1057,23 +1057,23 @@ public function stat_client($client_mac) /** * Assign client device to another group * - * @param string $user_id id of the user device to be modified - * @param string $group_id id of the user group to assign user to + * @param string $client_id _id value of the client device to be modified + * @param string $group_id _id value of the user group to assign client device to * @return bool returns true upon success */ - public function set_usergroup($user_id, $group_id) + public function set_usergroup($client_id, $group_id) { $payload = ['usergroup_id' => $group_id]; - return $this->fetch_results_boolean('/api/s/' . $this->site . '/upd/user/' . trim($user_id), $payload); + return $this->fetch_results_boolean('/api/s/' . $this->site . '/upd/user/' . trim($client_id), $payload); } /** - * Update client fixedip (using REST) + * Update client device fixed IP address (using REST) * - * @param string $client_id _id value for the client - * @param bool $use_fixedip determines whether use_fixedip is true or false + * @param string $client_id _id value for the client device + * @param bool $use_fixedip determines whether to enable the fixed IP address or not * @param string $network_id optional, _id value for the network where the ip belongs to - * @param string $fixed_ip optional, IP address, value of client's fixed_ip field + * @param string $fixed_ip optional, IP address, value of client device's fixed_ip field * @return array|false returns an array containing a single object with attributes of the updated client on success */ public function edit_client_fixedip($client_id, $use_fixedip, $network_id = null, $fixed_ip = null) @@ -1101,6 +1101,28 @@ public function edit_client_fixedip($client_id, $use_fixedip, $network_id = null return $this->fetch_results('/api/s/' . $this->site . '/rest/user/' . trim($client_id), $payload); } + /** + * Update client device name (using REST) + * + * @param string $client_id _id value for the client device + * @param string $name name of the client + * @return array|false returns an array containing a single object with attributes of the updated client on success + */ + public function edit_client_name($client_id, $name) + { + if (empty($name)) { + return false; + } + + $this->curl_method = 'PUT'; + $payload = [ + '_id' => $client_id, + 'name' => $name, + ]; + + return $this->fetch_results('/api/s/' . $this->site . '/rest/user/' . trim($client_id), $payload); + } + /** * Fetch user groups * @@ -1740,7 +1762,7 @@ public function revoke_admin($admin_id) } /** - * Fetch wlan_groups + * Fetch WLAN groups * * @return array containing known wlan_groups */ @@ -1803,7 +1825,7 @@ public function list_device_name_mappings() /** * Fetch self * - * @return array containing information about the logged in user + * @return array containing information about the logged-in user */ public function list_self() { @@ -1973,7 +1995,7 @@ public function list_dpi_stats_filtered($type = 'by_cat', array $cat_filter = nu $payload = ['type' => $type]; - if (is_array($cat_filter) && $type == 'by_app') { + if (is_array($cat_filter) && $type === 'by_app') { $payload['cats'] = $cat_filter; } @@ -2528,7 +2550,7 @@ public function list_wlanconf($wlan_id = null) } /** - * Create a wlan + * Create a WLAN * * @param string $name SSID * @param string $x_passphrase new pre-shared key, minimal length is 8 characters, maximum length is 63, @@ -2541,8 +2563,9 @@ public function list_wlanconf($wlan_id = null) * @param string $security optional, security type (open, wep, wpapsk, wpaeap) * @param string $wpa_mode optional, wpa mode (wpa, wpa2, ..) * @param string $wpa_enc optional, encryption (auto, ccmp) - * @param boolean $vlan_enabled optional, enable/disable vlan for this wlan - * @param int $vlan optional, vlan id + * @param boolean $vlan_enabled optional, enable/disable VLAN for this wlan (is ignored as of 1.1.73) + * @param string $vlan_id optional, "_id" value of the VLAN to assign to this WLAN, can be found using + * list_networkconf() * @param boolean $uapsd_enabled optional, enable/disable Unscheduled Automatic Power Save Delivery * @param boolean $schedule_enabled optional, enable/disable wlan schedule * @param array $schedule optional, schedule rules @@ -2561,35 +2584,34 @@ public function create_wlan( $security = 'open', $wpa_mode = 'wpa2', $wpa_enc = 'ccmp', - $vlan_enabled = false, - $vlan = null, + $vlan_enabled = null, + $vlan_id = null, $uapsd_enabled = false, $schedule_enabled = false, $schedule = [], $ap_group_ids = null ) { $payload = [ - 'name' => $name, - 'usergroup_id' => $usergroup_id, - 'wlangroup_id' => $wlangroup_id, + 'name' => trim($name), + 'usergroup_id' => trim($usergroup_id), + 'wlangroup_id' => trim($wlangroup_id), 'enabled' => $enabled, 'hide_ssid' => $hide_ssid, 'is_guest' => $is_guest, - 'security' => $security, - 'wpa_mode' => $wpa_mode, - 'wpa_enc' => $wpa_enc, - 'vlan_enabled' => $vlan_enabled, + 'security' => trim($security), + 'wpa_mode' => trim($wpa_mode), + 'wpa_enc' => trim($wpa_enc), 'uapsd_enabled' => $uapsd_enabled, 'schedule_enabled' => $schedule_enabled, 'schedule' => $schedule, ]; - if (!empty($vlan) && $vlan_enabled) { - $payload['vlan'] = $vlan; + if (!empty($vlan_id)) { + $payload['networkconf_id'] = $vlan_id; } if (!empty($x_passphrase) && $security !== 'open') { - $payload['x_passphrase'] = $x_passphrase; + $payload['x_passphrase'] = trim($x_passphrase); } if (!empty($ap_group_ids) && is_array($ap_group_ids)) { @@ -2604,9 +2626,8 @@ public function create_wlan( * * @param string $wlan_id the "_id" value for the WLAN which can be found with the list_wlanconf() function * @param object|array $payload stdClass object or associative array containing the configuration to apply to the - * wlan, must be a - * (partial) object/array structured in the same manner as is returned by - * list_wlanconf() for the wlan. + * wlan, must be a (partial) object/array structured in the same manner as is returned + * by list_wlanconf() for the wlan. * @return bool true on success */ public function set_wlansettings_base($wlan_id, $payload) @@ -2690,7 +2711,7 @@ public function set_wlan_mac_filter($wlan_id, $mac_filter_policy, $mac_filter_en $macs = array_map('strtolower', $macs); $payload = [ - 'mac_filter_enabled' => (bool)$mac_filter_enabled, + 'mac_filter_enabled' => (bool) $mac_filter_enabled, 'mac_filter_policy' => $mac_filter_policy, 'mac_filter_list' => $macs, ]; @@ -3003,15 +3024,15 @@ public function create_radius_account($name, $x_password, $tunnel_type = null, $ ]; if (!is_null($tunnel_type)) { - $payload['tunnel_type'] = (int)$tunnel_type; + $payload['tunnel_type'] = (int) $tunnel_type; } if (!is_null($tunnel_medium_type)) { - $payload['tunnel_medium_type'] = (int)$tunnel_medium_type; + $payload['tunnel_medium_type'] = (int) $tunnel_medium_type; } if (!is_null($vlan)) { - $payload['vlan'] = (int)$vlan; + $payload['vlan'] = (int) $vlan; } return $this->fetch_results('/api/s/' . $this->site . '/rest/account', $payload); @@ -3927,7 +3948,7 @@ protected function exec_curl($path, $payload = null) } /** - * fetch the HTTP response code + * get the HTTP response code */ $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); @@ -3935,12 +3956,12 @@ protected function exec_curl($path, $payload = null) * an HTTP response code 401 (Unauthorized) indicates the Cookie/Token has expired in which case * re-login is required */ - if ($http_code == 401) { + if ($http_code === 401) { if ($this->debug) { error_log(__FUNCTION__ . ': needed to reconnect to UniFi controller'); } - if ($this->exec_retries == 0) { + if ($this->exec_retries === 0) { /** * explicitly clear the expired Cookie/Token, update other properties and log out before logging in again */ @@ -4006,7 +4027,7 @@ protected function exec_curl($path, $payload = null) /** * Create and return a new cURL handle * - * @return object|bool|resource cURL handle (object or resource) upon success, false upon failure + * @return object|resource|bool cURL handle (object or resource) upon success, false upon failure */ protected function get_curl_handle() { diff --git a/vendor/composer/InstalledVersions.php b/vendor/composer/InstalledVersions.php index 3abb462..5238ab8 100644 --- a/vendor/composer/InstalledVersions.php +++ b/vendor/composer/InstalledVersions.php @@ -32,7 +32,7 @@ class InstalledVersions 'aliases' => array ( ), - 'reference' => '2f1522139be5bc7c8bb6aae19d911501dfef1a84', + 'reference' => '5bf616d02d5f2466e42d2b795de0cd30547eab3c', 'name' => '__root__', ), 'versions' => @@ -44,16 +44,16 @@ class InstalledVersions 'aliases' => array ( ), - 'reference' => '2f1522139be5bc7c8bb6aae19d911501dfef1a84', + 'reference' => '5bf616d02d5f2466e42d2b795de0cd30547eab3c', ), 'art-of-wifi/unifi-api-client' => array ( - 'pretty_version' => 'v1.1.72', - 'version' => '1.1.72.0', + 'pretty_version' => 'v1.1.73', + 'version' => '1.1.73.0', 'aliases' => array ( ), - 'reference' => '9cca43557c7f6454eb044d5c04a676630825872a', + 'reference' => '310abc43b52518853b671e3fa46423c007ccac79', ), 'kint-php/kint' => array ( diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json index 5360750..c3282bf 100755 --- a/vendor/composer/installed.json +++ b/vendor/composer/installed.json @@ -2,17 +2,17 @@ "packages": [ { "name": "art-of-wifi/unifi-api-client", - "version": "v1.1.72", - "version_normalized": "1.1.72.0", + "version": "v1.1.73", + "version_normalized": "1.1.73.0", "source": { "type": "git", "url": "https://github.com/Art-of-WiFi/UniFi-API-client.git", - "reference": "9cca43557c7f6454eb044d5c04a676630825872a" + "reference": "310abc43b52518853b671e3fa46423c007ccac79" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Art-of-WiFi/UniFi-API-client/zipball/9cca43557c7f6454eb044d5c04a676630825872a", - "reference": "9cca43557c7f6454eb044d5c04a676630825872a", + "url": "https://api.github.com/repos/Art-of-WiFi/UniFi-API-client/zipball/310abc43b52518853b671e3fa46423c007ccac79", + "reference": "310abc43b52518853b671e3fa46423c007ccac79", "shasum": "" }, "require": { @@ -20,7 +20,7 @@ "ext-json": "*", "php": ">=5.5.0" }, - "time": "2021-10-19T08:39:17+00:00", + "time": "2021-10-23T09:14:25+00:00", "type": "library", "installation-source": "dist", "autoload": { @@ -51,7 +51,7 @@ ], "support": { "issues": "https://github.com/Art-of-WiFi/UniFi-API-client/issues", - "source": "https://github.com/Art-of-WiFi/UniFi-API-client/tree/v.1.1.72" + "source": "https://github.com/Art-of-WiFi/UniFi-API-client/tree/v1.1.73" }, "install-path": "../art-of-wifi/unifi-api-client" }, diff --git a/vendor/composer/installed.php b/vendor/composer/installed.php index 19eec0a..8f87c13 100644 --- a/vendor/composer/installed.php +++ b/vendor/composer/installed.php @@ -6,7 +6,7 @@ 'aliases' => array ( ), - 'reference' => '2f1522139be5bc7c8bb6aae19d911501dfef1a84', + 'reference' => '5bf616d02d5f2466e42d2b795de0cd30547eab3c', 'name' => '__root__', ), 'versions' => @@ -18,16 +18,16 @@ 'aliases' => array ( ), - 'reference' => '2f1522139be5bc7c8bb6aae19d911501dfef1a84', + 'reference' => '5bf616d02d5f2466e42d2b795de0cd30547eab3c', ), 'art-of-wifi/unifi-api-client' => array ( - 'pretty_version' => 'v1.1.72', - 'version' => '1.1.72.0', + 'pretty_version' => 'v1.1.73', + 'version' => '1.1.73.0', 'aliases' => array ( ), - 'reference' => '9cca43557c7f6454eb044d5c04a676630825872a', + 'reference' => '310abc43b52518853b671e3fa46423c007ccac79', ), 'kint-php/kint' => array (