Merge pull request #187 from cloudinary/fix/cname-use-credentials

RC-2 fixes

Author: David Cramer

cloudinary-image-management-and-manipulation-in-the-cloud-cdn/cloudinary.php

@@ -3,7 +3,7 @@
  * Plugin Name: Cloudinary
  * Plugin URI: https://cloudinary.com/documentation/wordpress_integration
  * Description: With the Cloudinary plugin, you can upload and manage your media assets in the cloud, then deliver them to your users through a fast content delivery network, improving your website’s loading speed and overall user experience. Apply multiple transformations and take advantage of a full digital asset management solution without leaving WordPress.
- * Version: 2.2.0-rc2
+ * Version: 2.2.0-rc3
  * Author:  Cloudinary Ltd., XWP
  * Author URI: https://cloudinary.com/
  * License: GPLv2+

cloudinary-image-management-and-manipulation-in-the-cloud-cdn/css/cloudinary.css

@@ -90,6 +90,11 @@
 						font-size : 1.2em;
 						color     : #5F5F5F;
 
+						&.expanded {
+							padding-top   : 40px;
+							margin-bottom : 25px;
+						}
+
 						.dashicons {
 							color : #AC0000;
 						}
@@ -108,7 +113,8 @@
 						color     : #23282d;
 
 						&.expanded {
-							padding-top : 40px;
+							padding-top   : 40px;
+							margin-bottom : 25px;
 						}
 
 						.dashicons {
@@ -210,29 +216,25 @@
 }
 
 .settings-warning {
-	display: inline-block;
-	padding: 5px 7px;
-	background-color: #e9faff;
-	border: 1px solid #ccd0d4;
-	border-left: 4px solid #00a0d2;
-	box-shadow: 0 1px 1px rgba(0,0,0,.04);
+	display          : inline-block;
+	padding          : 5px 7px;
+	background-color : #e9faff;
+	border           : 1px solid #ccd0d4;
+	border-left      : 4px solid #00a0d2;
+	box-shadow       : 0 1px 1px rgba(0, 0, 0, .04);
 }
 
 .field-radio {
 	input[type=radio].cld-field {
-		margin: 0;
-		margin-right: 5px;
+		margin       : 0;
+		margin-right : 5px;
 	}
 
 	label {
-		margin-right: 10px;
+		margin-right : 10px;
 	}
 }
 
 .settings-tab-section h2 {
-	margin: 0;
+	margin : 0;
 }
-
-hr {
-	margin-top: 25px;
-}

cloudinary-image-management-and-manipulation-in-the-cloud-cdn/css/src/components/_settings.scss

@@ -68,6 +68,13 @@ class Connect implements Config, Setup, Notice {
 	 */
 	protected $notices = array();
 
+	/**
+	 * Account Disabled Flag.
+	 *
+	 * @var bool
+	 */
+	public $disabled = false;
+
 	/**
 	 * Holds the meta keys for connect meta to maintain consistency.
 	 */
@@ -79,7 +86,7 @@ class Connect implements Config, Setup, Notice {
 		'url'        => 'cloudinary_url',
 		'connect'    => 'cloudinary_connect',
 		'cache'      => 'cloudinary_settings_cache',
-		'cname'      => 'cloudinary_url_cname',
+		'status'     => 'cloudinary_status',
 	);
 
 	/**
@@ -95,6 +102,8 @@ class Connect implements Config, Setup, Notice {
 	public function __construct( Plugin $plugin ) {
 		$this->plugin = $plugin;
 		add_filter( 'pre_update_option_cloudinary_connect', array( $this, 'verify_connection' ) );
+		add_filter( 'cron_schedules', array( $this, 'get_status_schedule' ) );
+		add_action( 'cloudinary_status', array( $this, 'check_status' ) );
 	}
 
 	/**
@@ -144,7 +153,6 @@ public function media_library_script() {
 	public function verify_connection( $data ) {
 		if ( empty( $data['cloudinary_url'] ) ) {
 			delete_option( self::META_KEYS['signature'] );
-			delete_option( self::META_KEYS['cname'] );
 
 			add_settings_error(
 				'cloudinary_connect',
@@ -164,9 +172,6 @@ public function verify_connection( $data ) {
 			return $data;
 		}
 
-		// Always clear out CNAME when re-saving.
-		delete_option( self::META_KEYS['cname'] );
-
 		// Pattern match to ensure validity of the provided url
 		if ( ! preg_match( '~' . self::CLOUDINARY_VARIABLE_REGEX . '~', $data['cloudinary_url'] ) ) {
 			add_settings_error(
@@ -187,12 +192,6 @@ public function verify_connection( $data ) {
 			return $current;
 		}
 
-		// Check if the given URL has a cname and store it if present.
-		$cname = $this->extract_cname( wp_parse_url( $data['cloudinary_url'] ) );
-		if ( $cname && $this->validate_domain( $cname ) ) {
-			update_option( self::META_KEYS['cname'], $cname );
-		}
-
 		add_settings_error(
 			'cloudinary_connect',
 			'connection_success',
@@ -216,11 +215,6 @@ public function is_connected() {
 		if ( null === $signature ) {
 			return false;
 		}
-		
-		// Get the last test transient.
-		if ( get_transient( $signature ) ) {
-			return true;
-		}
 
 		$connect_data = get_option( self::META_KEYS['connect'], [] );
 		$current_url  = isset( $connect_data['cloudinary_url'] ) ? $connect_data['cloudinary_url'] : null;
@@ -233,22 +227,37 @@ public function is_connected() {
 			return false;
 		}
 
-		$api  = new Connect\Api( $this, $this->plugin->version );
-		$ping = $api->ping();
-
-		if ( is_wp_error( $ping ) || ( is_array( $ping ) && $ping['status'] !== 'ok' ) ) {
-			delete_option( self::META_KEYS['signature'] );
-
-			$this->notices[] = array(
-				'message'     => __( 'You have been disconnected due to an account error.', 'cloudinary' ),
-				'type'        => 'error',
-				'dismissible' => true,
-			);
+		$status = get_option( self::META_KEYS['status'], null );
+		if ( is_wp_error( $status ) ) {
+			// Error, we stop here.
+			if ( ! isset( $this->notices['__status'] ) ) {
+				$error   = $status->get_error_message();
+				$message = sprintf(
+				// translators: Placeholder refers the error from API.
+					__( 'Cloudinary Error: %s', 'cloudinary' ),
+					ucwords( $error )
+				);
+				if ( 'disabled account' === strtolower( $error ) ) {
+					// Flag general disabled.
+					$this->disabled = true;
+					$message        = sprintf(
+					// translators: Placeholders are <a> tags.
+						__( 'Cloudinary Account Disabled. %1$s Upgrade your plan %3$s or %2$s submit a support request %3$s for assistance.', 'cloudinary' ),
+						'<a href="https://cloudinary.com/console/upgrade_options" target="_blank">',
+						'<a href="https://support.cloudinary.com/hc/en-us/requests/new" target="_blank">',
+						'</a>'
+					);
+				}
+				$this->notices['__status'] = array(
+					'message'     => $message,
+					'type'        => 'error',
+					'dismissible' => true,
+				);
+			}
 
 			return false;
 		}
-		// Set a 30 second transient to prevent continued pinging.
-		set_transient( $signature, true, 30 );
+
 
 		return true;
 	}
@@ -296,26 +305,51 @@ function ( $a ) {
 		}
 
 		$this->config_from_url( $url );
-
-		$test        = new Connect\Api( $this, $this->plugin->version );
-		$test_result = $test->ping();
+		$test_result = $this->check_status();
 
 		if ( is_wp_error( $test_result ) ) {
-			$result['type']    = 'connection_error';
+			$error = $test_result->get_error_message();
+			if ( 'disabled account' !== strtolower( $error ) ) {
+				// Account Disabled, is still successful, so allow it, else we will never be able to change it.
+				$result['type'] = 'connection_error';
+			}
 			$result['message'] = ucwords( str_replace( '_', ' ', $test_result->get_error_message() ) );
 		} else {
-			$this->api = $test;
 			$this->usage_stats( true );
 		}
 
 		return $result;
 	}
 
+	/**
+	 * Check the status of Cloudinary.
+	 *
+	 * @return array|\WP_Error
+	 */
+	public function check_status() {
+		$status = $this->test_ping();
+		update_option( self::META_KEYS['status'], $status );
+
+		return $status;
+	}
+
+	/**
+	 * Do a ping test on the API.
+	 *
+	 * @return array|\WP_Error
+	 */
+	public function test_ping() {
+		$test      = new Connect\Api( $this, $this->plugin->version );
+		$this->api = $test;
+
+		return $test->ping();
+	}
+
 	/**
 	 * Extracts the CNAME from a parsed connection URL.
 	 *
 	 * @param array $parsed_url
-	 * 
+	 *
 	 * @return string|null
 	 */
 	protected function extract_cname( $parsed_url ) {
@@ -336,7 +370,7 @@ protected function extract_cname( $parsed_url ) {
 	 * Safely validate a domain.
 	 *
 	 * @param string $domain
-	 * 
+	 *
 	 * @return bool
 	 */
 	protected function validate_domain( $domain ) {
@@ -416,6 +450,12 @@ public function config_from_url( $url ) {
 				$this->set_credentials( $config_params );
 			}
 		}
+
+		// Specifically set CNAME
+		$cname = $this->extract_cname( $parts );
+		if ( ! empty( $cname ) ) {
+			$this->set_credentials( array( 'cname' => $cname ) );
+		}
 	}
 
 	/**
@@ -430,6 +470,33 @@ public function setup() {
 			$this->config_from_url( $config['cloudinary_url'] );
 			$this->api = new Connect\Api( $this, $this->plugin->version );
 			$this->usage_stats();
+			$this->setup_status_cron();
+		}
+	}
+
+	/**
+	 * Add our every minute schedule.
+	 *
+	 * @param array $schedules Array of schedules.
+	 *
+	 * @return array
+	 */
+	public function get_status_schedule( $schedules ) {
+		$schedules['every_minute'] = array(
+			'interval' => MINUTE_IN_SECONDS,
+			'display'  => __( 'Every Minute', 'cloudinary' ),
+		);
+
+		return $schedules;
+	}
+
+	/**
+	 * Setup Status cron.
+	 */
+	protected function setup_status_cron() {
+		if ( false === wp_get_schedule( 'cloudinary_status' ) ) {
+			$now = current_time( 'timestamp' );
+			wp_schedule_event( $now + ( MINUTE_IN_SECONDS ), 'every_minute', 'cloudinary_status' );
 		}
 	}
 

cloudinary-image-management-and-manipulation-in-the-cloud-cdn/php/class-connect.php

@@ -143,6 +143,10 @@ class Api {
 	public function __construct( $connect, $version ) {
 		$this->credentials = $connect->get_credentials();
 		$this->plugin_version = $version;
+		// Use CNAME.
+		if ( ! empty( $this->credentials['cname'] ) ) {
+			$this->asset_url = $this->credentials['cname'];
+		}
 	}
 
 	/**
@@ -163,10 +167,6 @@ public function url( $resource, $function = null, $endpoint = false ) {
 		} else {
 			$parts[] = $this->asset_url;
 		}
-		
-		if ( $cname = get_option( Connect::META_KEYS['cname'] ) ) {
-			$parts[0] = $cname;
-		}
 
 		if ( empty( $this->credentials['cname'] ) || $endpoint ) {
 			$parts[] = $this->credentials['cloud_name'];

cloudinary-image-management-and-manipulation-in-the-cloud-cdn/php/connect/class-api.php

@@ -176,9 +176,12 @@ public function sync( $attachment_id ) {
 				break;
 			case 'dual_low':
 				$transformations = $this->media->get_transformation_from_meta( $attachment_id );
-				// Add low quality transformations.
-				$transformations[] = array( 'quality' => 'auto:low' );
-				$url               = $this->media->cloudinary_url( $attachment_id, 'full', $transformations, null, false, true );
+				// Only low res image items.
+				if ( ! $this->media->is_preview_only( $attachment_id ) && wp_attachment_is_image( $attachment_id ) ) {
+					// Add low quality transformations.
+					$transformations[] = array( 'quality' => 'auto:low' );
+				}
+				$url = $this->media->cloudinary_url( $attachment_id, '', $transformations, null, false, true );
 				break;
 			case 'dual_full':
 				if ( ! empty( $previous_state ) && 'dual_full' !== $previous_state ) {