feat: Show API key usage information (#13)

Author: michaelwittig

plugin/README.txt

@@ -2,8 +2,8 @@
 Contributors: andreaswittig,michaelwittig
 Tags: malware,virus,antivirus,malware scanner,security
 Requires at least: 6.0
-Tested up to: 6.8
-Stable tag: 1.5
+Tested up to: 6.9
+Stable tag: 1.7
 License: GPLv2
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
@@ -37,7 +37,11 @@ Go to [attachmentAV for WordPress Setup Guide](https://attachmentav.com/help/set
 
 = Which file types are supported? =
 
-attachmentAV scans all file types. The maximum file size is 10 MB.
+attachmentAV scans all file types.
+
+= What's the maximum supported file size? =
+
+The maximum file size is 10 MB.
 
 = Which upload methods are covered? =
 
@@ -57,11 +61,18 @@ attachmentAV scans all files uploaded via:
 
 == Changelog ==
 
-= 1.5.2 =
+= 1.7.0 =
+* Show API key usage information
+* Support Wordpress 6.9
+
+= 1.6.0 =
 * Minor improvements
 
+= 1.5.2 =
+* Bug fixes
+
 = 1.5.1 =
-* Small fixes
+* Bug fixes
 
 = 1.5.0 =
 * Support for plugin Drag and Drop Multiple File Upload for Contact Form 7 added
@@ -73,16 +84,16 @@ attachmentAV scans all files uploaded via:
 * Support Wordpress 6.8
 
 = 1.2.1 =
-* Minor fixes
+* Bug fixes
 
 = 1.2.0 =
 * Support for plugin Formidable Forms added
 
 = 1.1.2 =
-* Small fixes
+* Bug fixes
 
 = 1.1.1 =
-* Small fixes
+* Bug fixes
 
 = 1.1.0 =
 * Support for plugin WPForms added
@@ -92,16 +103,16 @@ attachmentAV scans all files uploaded via:
 * Adding scan results to metadata
 
 = 1.0.4 =
-* Small fixes
+* Bug fixes
 
 = 1.0.3 =
-* Small fixes
+* Bug fixes
 
 = 1.0.2 =
-* Small fixes
+* Bug fixes
 
 = 1.0.1 =
-* Small fixes
+* Bug fixes
 
 = 1.0 =
 * Initial Release

plugin/admin/class-attachmentav-admin.php

@@ -82,6 +82,7 @@ public function create_admin_page() {
 			<form method="post" action="options.php">
 			<?php
 				// This prints out all hidden setting fields
+				settings_errors( 'attachmentav' );
 				settings_fields( 'attachmentav' );
 				do_settings_sections( 'attachmentav' );
 				submit_button();
@@ -98,7 +99,7 @@ public function page_init() {
 		register_setting(
 			'attachmentav', // Option group
 			'attachmentav_api_key', // Option name
-			array( $this, 'sanitize_text' ) // Sanitize
+			array( $this, 'sanitize_api_key' ) // Sanitize
 		);
 
 		register_setting(
@@ -203,15 +204,36 @@ public function page_init() {
 		);
 	}
 
-	/**
-	 * Sanitize each setting field as needed
-	 *
-	 * @param array $input Contains all settings fields as array keys
-	 */
 	public function sanitize_text( $input ) {
 		return sanitize_text_field($input);
 	}
 
+	public function sanitize_api_key( $input ) {
+		$api_key = sanitize_text_field($input);
+		$response = wp_remote_get('https://eu.developer.attachmentav.com/v1/test', array(
+			'timeout' => 30,
+			'headers' => array(
+				'x-api-key' => $api_key,
+				'x-wordpress-site-url' => get_site_url(),
+			),
+		));
+		if (is_wp_error($response)) {
+			$error_messages = implode(',', $response->get_error_messages());
+			add_settings_error('attachmentav_api_key', 'attachmentav_api_key', "Failure ({$error_messages}", 'error');
+			return get_option( 'attachmentav_api_key' );
+		} else {
+			if ($response['response']['code'] == 204) {
+				return $api_key;
+			} else if ($response['response']['code'] == 401) {
+				add_settings_error('attachmentav_api_key', 'attachmentav_api_key', 'License key is invalid', 'error');
+				return get_option( 'attachmentav_api_key' );
+			} else {
+				add_settings_error('attachmentav_api_key', 'attachmentav_api_key', "Unknown error ({$response['response']['code']}", 'error');
+				return get_option( 'attachmentav_api_key' );
+			}
+		}
+	}
+
 	public function print_subscription_section()
 	{
 		print '<a target="_blank" href="https://attachmentav.com/subscribe/wordpress/">Subscribe to attachmentAV</a> and enter the API key below.';
@@ -233,10 +255,31 @@ public function print_plugins_section()
 	}
 
 	public function print_api_key() {
-			printf(
-				'<input type="text" name="attachmentav_api_key" value="%s" />', esc_attr(get_option('attachmentav_api_key'))
-			);
-		
+		printf(
+			'<input type="text" name="attachmentav_api_key" value="%s" />', esc_attr(get_option('attachmentav_api_key'))
+		);
+		$response = wp_remote_get('https://eu.developer.attachmentav.com/v1/usage', array(
+			'timeout' => 30,
+			'headers' => array(
+				'x-api-key' => get_option('attachmentav_api_key'),
+				'x-wordpress-site-url' => get_site_url(),
+			),
+		));
+		if (is_wp_error($response)) {
+			$error_messages = implode(',', $response->get_error_messages());
+			printf("Failed to get usage ({$error_messages}). Please try again later or contact hello@attachmentav.com for help.");
+		} else {
+			if ($response['response']['code'] == 200) {
+				$body = json_decode($response['body'], true);
+				$usage = $body['quota']['limit']-$body['credits'];
+				$period = strtolower($body['quota']['period']);
+				printf("You used {$usage} of your {$body['quota']['limit']} scans this {$period}.");
+			} else if ($response['response']['code'] == 401) {
+				printf("Could not get usage as license key is missing or invalid. Add a valid license key.");
+			} else {
+				printf("Failed to get usage due to unknown error ({$response['response']['code']}). Please try again later or contact hello@attachmentav.com for help.");
+			}
+		}
 	}
 
 	public function print_block_unscannable() {

plugin/attachmentav.php

@@ -16,7 +16,7 @@
  * Plugin Name:       attachmentAV
  * Plugin URI:        https://attachmentav.com/solution/malware-protection-for-wordpress/
  * Description:       Protect your blog from malware. Scan attachments for viruses, worms, and trojans by sending them to the attachmentAV API powered by Sophos. To get started, please go to your <a href="/wp-admin/admin.php?page=attachmentav">attachmentAV Settings page</a> to set up your API key.
- * Version:           1.5.1
+ * Version:           1.7.0
  * Author:            widdix GmbH
  * License:           GPL-2.0+
  * License URI:       http://www.gnu.org/licenses/gpl-2.0.txt
@@ -34,7 +34,7 @@
  * Start at version 1.0.0 and use SemVer - https://semver.org
  * Rename this for your plugin and update it as you release new versions.
  */
-define( 'ATTACHMENTAV_VERSION', '1.5.1' );
+define( 'ATTACHMENTAV_VERSION', '1.7.0' );
 
 /**
  * The code that runs during plugin activation.