Skip to content
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

Robust query string encoding #129

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

Robust query string encoding #129

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
40 changes: 15 additions & 25 deletions lib/class-wp-rest-oauth1.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,31 +711,21 @@ protected function check_oauth_signature( $consumer, $oauth_params, $token = nul
* @return string Signature string
*/
public function create_signature_string( $params ) {
return implode( '%26', $this->join_with_equals_sign( $params ) ); // join with ampersand
}

/**
* Creates an array of urlencoded strings out of each array key/value pairs
*
* @since 0.1.0
* @param array $params Array of parameters to convert.
* @param array $query_params Array to extend.
* @param string $key Optional Array key to append
* @return string Array of urlencoded strings
*/
public function join_with_equals_sign( $params, $query_params = array(), $key = '' ) {
foreach ( $params as $param_key => $param_value ) {
if ( is_array( $param_value ) ) {
$query_params = $this->join_with_equals_sign( $param_value, $query_params, $param_key );
} else {
if ( $key ) {
$param_key = $key . '[' . $param_key . ']'; // Handle multi-dimensional array
}
$string = $param_key . '=' . $param_value; // join with equals sign
$query_params[] = urlencode( $string );
}
}
return $query_params;
$query = http_build_query( $params );
// http_build_query will attach numeric indices for array values, eg
// filter[post__not_in][0]=1 instead of filter[post__not_in][]=1.
//
// Clients issue requests in the form filter[post__not_in][]=1 so
// we should compare against that. This regex will strip out
// the numeric indices.
//
// cf. http://php.net/manual/en/function.http-build-query.php
// cf. http://stackoverflow.com/a/11996686/751089
$replaced = preg_replace( '/%5B[0-9]+%5D/simU', '%5B%5D', $query );

// http_build_query has urlencoded the parameters, but our calling function
// expects a double-encoded return value
return urlencode( $replaced );
}

/**
Expand Down