Merge pull request #455 from 10up/fix/415

Ensure we don't send unnecessary API requests to NLU

includes/Classifai/Providers/Azure/ComputerVision.php

@@ -112,20 +112,6 @@ public function get_alt_text_settings() {
 		return $enabled_fields;
 	}
 
-	/**
-	 * Can the functionality be initialized?
-	 *
-	 * @return bool
-	 */
-	public function can_register() {
-		$options = get_option( $this->get_option_name() );
-		if ( empty( $options ) || ( isset( $options['authenticated'] ) && false === $options['authenticated'] ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
 	/**
 	 * Register the functionality.
 	 */

includes/Classifai/Providers/Azure/Personalizer.php

@@ -70,20 +70,6 @@ private function get_default_settings() {
 		];
 	}
 
-	/**
-	 * Can the functionality be initialized?
-	 *
-	 * @return bool
-	 */
-	public function can_register() {
-		$options = get_option( $this->get_option_name() );
-		if ( empty( $options ) || ( isset( $options['authenticated'] ) && false === $options['authenticated'] ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
 	/**
 	 * Register the functionality.
 	 */

includes/Classifai/Providers/OpenAI/ChatGPT.php

@@ -60,21 +60,6 @@ public function __construct( $service ) {
 		);
 	}
 
-	/**
-	 * Can the functionality be initialized?
-	 *
-	 * @return bool
-	 */
-	public function can_register() {
-		$settings = $this->get_settings();
-
-		if ( empty( $settings ) || ( isset( $settings['authenticated'] ) && false === $settings['authenticated'] ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
 	/**
 	 * Register what we need for the plugin.
 	 *

includes/Classifai/Providers/OpenAI/DallE.php

@@ -44,21 +44,6 @@ public function __construct( $service ) {
 		);
 	}
 
-	/**
-	 * Can the functionality be initialized?
-	 *
-	 * @return bool
-	 */
-	public function can_register() {
-		$settings = $this->get_settings();
-
-		if ( empty( $settings ) || ( isset( $settings['authenticated'] ) && false === $settings['authenticated'] ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
 	/**
 	 * Register what we need for the provider.
 	 *

includes/Classifai/Providers/Provider.php

@@ -110,7 +110,9 @@ public function get_onboarding_options() {
 	/**
 	 * Can the Provider be initalized?
 	 */
-	abstract public function can_register();
+	public function can_register() {
+		return $this->is_configured();
+	}
 
 	/**
 	 * Register the functionality for the Provider.

includes/Classifai/Providers/Watson/NLU.php

@@ -9,6 +9,7 @@
 use Classifai\Admin\PreviewClassifierData;
 use Classifai\Providers\Provider;
 use Classifai\Taxonomy\TaxonomyFactory;
+use WP_Error;
 
 use function Classifai\get_asset_info;
 use function Classifai\get_post_types_for_language_settings;
@@ -116,19 +117,6 @@ public function reset_settings() {
 		update_option( $this->get_option_name(), $settings );
 	}
 
-	/**
-	 * Can the functionality be initialized?
-	 *
-	 * @return bool
-	 */
-	public function can_register() {
-		if ( $this->nlu_authentication_check_failed( $this->get_settings() ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
 	/**
 	 * Register what we need for the plugin.
 	 */
@@ -600,17 +588,17 @@ public function get_supported_taxonomies() {
 	 *
 	 * @param array $settings The list of settings to be saved
 	 *
-	 * @return bool
+	 * @return bool|WP_Error
 	 */
-	protected function nlu_authentication_check_failed( $settings ) {
+	protected function nlu_authentication_check( $settings ) {
 
 		// Check that we have credentials before hitting the API.
 		if ( ! isset( $settings['credentials'] )
 			|| empty( $settings['credentials']['watson_username'] )
 			|| empty( $settings['credentials']['watson_password'] )
 			|| empty( $settings['credentials']['watson_url'] )
 		) {
-			return true;
+			return new WP_Error( 'auth', esc_html__( 'Please enter your credentials.', 'classifai' ) );
 		}
 
 		$request           = new \Classifai\Watson\APIRequest();
@@ -634,15 +622,13 @@ protected function nlu_authentication_check_failed( $settings ) {
 		];
 		$response          = $request->post( $url, $options );
 
-		$is_error = is_wp_error( $response );
-		if ( ! $is_error ) {
+		if ( ! is_wp_error( $response ) ) {
 			update_option( 'classifai_configured', true );
+			return true;
 		} else {
 			delete_option( 'classifai_configured' );
+			return $response;
 		}
-
-		return $is_error;
-
 	}
 
 
@@ -654,14 +640,19 @@ protected function nlu_authentication_check_failed( $settings ) {
 	 * @return array The sanitized settings to be saved.
 	 */
 	public function sanitize_settings( $settings ) {
-		$new_settings = $this->get_settings();
-		if ( $this->nlu_authentication_check_failed( $settings ) ) {
+		$new_settings  = $this->get_settings();
+		$authenticated = $this->nlu_authentication_check( $settings );
+
+		if ( is_wp_error( $authenticated ) ) {
+			$new_settings['authenticated'] = false;
 			add_settings_error(
 				'credentials',
 				'classifai-auth',
-				esc_html__( 'IBM Watson NLU Authentication Failed. Please check credentials.', 'classifai' ),
+				$authenticated->get_error_message(),
 				'error'
 			);
+		} else {
+			$new_settings['authenticated'] = true;
 		}
 
 		if ( isset( $settings['credentials']['watson_url'] ) ) {
@@ -903,9 +894,20 @@ public function add_process_content_meta_to_rest_api() {
 	/**
 	 * Returns whether the provider is configured or not.
 	 *
+	 * For backwards compat, we've maintained the use of the
+	 * `classifai_configured` option. We default to looking for
+	 * the `authenticated` setting though.
+	 *
 	 * @return bool
 	 */
 	public function is_configured() {
-		return get_option( 'classifai_configured', false );
+		$is_configured = parent::is_configured();
+
+		if ( ! $is_configured ) {
+			$is_configured = (bool) get_option( 'classifai_configured', false );
+		}
+
+		return $is_configured;
 	}
+
 }