Skip to content

fix: improve connection string error handling for common copy-paste mistakes #1128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dkohn1337 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: improve connection string error handling for common copy-paste mistakes #1128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 52 additions & 4 deletions php/class-connect.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,9 @@ class Connect extends Settings_Component implements Config, Setup, Notice {

/**
* Regex to match Cloudinary environment variable.
* Updated to support cloud names with underscores, hyphens, and numbers.
*/
const CLOUDINARY_VARIABLE_REGEX = '^(?:CLOUDINARY_URL=)?cloudinary://[0-9]+:[A-Za-z_\-0-9]+@[A-Za-z]+';
const CLOUDINARY_VARIABLE_REGEX = '^(?:CLOUDINARY_URL=)?cloudinary://[0-9]+:[A-Za-z0-9_\-]+@[A-Za-z0-9_\-]+';

/**
* Initiate the plugin resources.
Expand Down Expand Up @@ -272,14 +273,25 @@ public function verify_connection( $data ) {
return $data;
}

$data['cloudinary_url'] = str_replace( 'CLOUDINARY_URL=', '', $data['cloudinary_url'] );
$data['cloudinary_url'] = $this->normalize_cloudinary_url( $data['cloudinary_url'] );
$current = $this->plugin->settings->find_setting( 'connect' )->get_value();

// Same URL, return original data.
if ( $current['cloudinary_url'] === $data['cloudinary_url'] ) {
return $data;
}

// Check for angle brackets early with helpful message.
if ( preg_match( '/[<>]/', $data['cloudinary_url'] ) ) {
$admin->add_admin_notice(
'angle_brackets',
__( 'Your connection string contains angle brackets (< or >). Replace the placeholder values like <your_api_key> with your actual credentials.', 'cloudinary' ),
'error'
);

return $current;
}

// Pattern match to ensure validity of the provided url.
if ( ! preg_match( '~' . self::CLOUDINARY_VARIABLE_REGEX . '~', $data['cloudinary_url'] ) ) {
$admin->add_admin_notice(
Expand Down Expand Up @@ -376,6 +388,27 @@ public function is_connected() {
return true;
}

/**
* Normalize a Cloudinary URL by trimming whitespace, quotes, and removing the CLOUDINARY_URL= prefix.
*
* @param string $url The URL to normalize.
*
* @return string The normalized URL.
*/
protected function normalize_cloudinary_url( $url ) {
if ( ! is_string( $url ) ) {
return $url;
}
// Trim whitespace.
$url = trim( $url );
// Trim surrounding quotes (single or double).
$url = trim( $url, " \t\n\r\0\x0B\"'" );
// Remove CLOUDINARY_URL= prefix if present.
$url = preg_replace( '/^CLOUDINARY_URL=/', '', $url );

return $url;
}

/**
* Test the connection url.
*
Expand All @@ -384,6 +417,21 @@ public function is_connected() {
* @return array
*/
public function test_connection( $url ) {
// Normalize the URL first.
$url = $this->normalize_cloudinary_url( $url );

// Check for angle brackets - common copy-paste error from Cloudinary dashboard.
if ( is_string( $url ) && preg_match( '/[<>]/', $url ) ) {
return array(
'type' => 'invalid_url',
'message' => __(
'Your connection string contains angle brackets (< or >). Replace the placeholder values like <your_api_key> with your actual credentials. The format should be: cloudinary://API_KEY:API_SECRET@CLOUD_NAME',
'cloudinary'
),
'url' => $url,
);
}

$result = array(
'type' => 'connection_success',
'message' => null,
Expand Down Expand Up @@ -903,7 +951,7 @@ public function upgrade_connection( $old_version ) {
}

// Test upgraded details.
$data['cloudinary_url'] = str_replace( 'CLOUDINARY_URL=', '', $data['cloudinary_url'] );
$data['cloudinary_url'] = $this->normalize_cloudinary_url( $data['cloudinary_url'] );
$test = $this->test_connection( $data['cloudinary_url'] );

if ( 'connection_success' === $test['type'] ) {
Expand Down Expand Up @@ -942,7 +990,7 @@ public function maybe_connection_string_constant( $value, $setting ) {
static $url = null;

if ( empty( $url ) ) {
$url = str_replace( 'CLOUDINARY_URL=', '', CLOUDINARY_CONNECTION_STRING );
$url = $this->normalize_cloudinary_url( CLOUDINARY_CONNECTION_STRING );
}

if ( 'cloudinary_url' === $setting ) {
Expand Down