Object_Sync_Sf_Salesforce::http_request()

Complexity

Conditions	24
Paths	433

Size

Total Lines	168
Code Lines	95

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

<?php
	protected function http_request( $url, $data, $headers = array(), $method = 'GET', $options = array() ) {
		// Build the request, including path and headers. Internal use.

		/**
		 * Short-circuits the return value of an HTTP API call.
		 *
		 * This allows other plugins to communicate with the Salesforce API on behalf of
		 * Object Sync for Salesforce, for example by using the WordPress HTTP API.
		 *
		 * @since 2.2.7
		 *
		 * @param null|array $check   Whether to short-circuit the HTTP request. Default null.
		 * @param string     $url     Path to make request from.
		 * @param array      $data    The request body.
		 * @param array      $headers Request headers to send as name => value.
		 * @param string     $method  Method to initiate the call, such as GET or POST. Defaults to GET.
		 * @param array      $options This is the options array from the api_http_request method.
		 */
		$check = apply_filters( $this->option_prefix . 'http_request', null, $url, $data, $headers, $method, $options );

The function apply_filters was not found. Maybe you did not declare it correctly or list all dependencies?

		if ( null !== $check ) {
			return $check;
		}

		/*
		 * Note: curl is used because wp_remote_get, wp_remote_post, wp_remote_request don't work. Salesforce returns various errors.
		 * todo: There is a GitHub branch attempting with the goal of addressing this: https://github.com/MinnPost/object-sync-for-salesforce/issues/94
		*/

		$curl = curl_init();
		curl_setopt( $curl, CURLOPT_URL, $url );
		curl_setopt( $curl, CURLOPT_RETURNTRANSFER, true );
		curl_setopt( $curl, CURLOPT_FOLLOWLOCATION, true );
		if ( false !== $headers ) {

The condition false !== $headers is always true.

			curl_setopt( $curl, CURLOPT_HTTPHEADER, $headers );
		} else {
			curl_setopt( $curl, CURLOPT_HEADER, false );
		}

		if ( 'POST' === $method ) {
			curl_setopt( $curl, CURLOPT_POST, true );
			curl_setopt( $curl, CURLOPT_POSTFIELDS, $data );
		} elseif ( 'PATCH' === $method || 'DELETE' === $method ) {
			curl_setopt( $curl, CURLOPT_CUSTOMREQUEST, $method );
			curl_setopt( $curl, CURLOPT_POSTFIELDS, $data );
		}
		$json_response = curl_exec( $curl ); // this is possibly gzipped json data.
		$code          = curl_getinfo( $curl, CURLINFO_HTTP_CODE );

		if ( ( 'PATCH' === $method || 'DELETE' === $method ) && '' === $json_response && 204 === $code ) {
			// delete and patch requests return a 204 with an empty body upon success for whatever reason.
			$data = array(
				'success' => true,
				'body'    => '',
			);
			curl_close( $curl );

			$result = array(
				'code' => $code,
			);

			$return_format = isset( $options['return_format'] ) ? $options['return_format'] : 'array';

			switch ( $return_format ) {
				case 'array':
					$result['data'] = $data;
					break;
				case 'json':
					$result['json'] = wp_json_encode( $data );

The function wp_json_encode was not found. Maybe you did not declare it correctly or list all dependencies?

					break;
				case 'both':
					$result['json'] = wp_json_encode( $data );
					$result['data'] = $data;
					break;
			}

			return $result;
		}

		if ( ( ord( $json_response[0] ) == 0x1f ) && ( ord( $json_response[1] ) == 0x8b ) ) {
			// skip header and ungzip the data.
			$json_response = gzinflate( substr( $json_response, 10 ) );

It seems like $json_response can also be of type true; however, parameter $string of substr() does only seem to accept string, maybe add an additional type check?

		}
		$data = json_decode( $json_response, true ); // decode it into an array.

It seems like $json_response can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

		// don't use the exception if the status is a success one, or if it just needs a refresh token (salesforce uses 401 for this).
		if ( ! in_array( $code, $this->success_or_refresh_codes, true ) ) {
			$curl_error = curl_error( $curl );
			if ( '' !== $curl_error ) {
				// create log entry for failed curl.
				$status = 'error';
				$title  = sprintf(
					// translators: placeholders are: 1) the log status, 2) the HTTP status code returned by the Salesforce API request.
					esc_html__( '%1$s: %2$s: on Salesforce HTTP request', 'object-sync-for-salesforce' ),

The function esc_html__ was not found. Maybe you did not declare it correctly or list all dependencies?

					ucfirst( esc_attr( $status ) ),

The function esc_attr was not found. Maybe you did not declare it correctly or list all dependencies?

					absint( $code )

The function absint was not found. Maybe you did not declare it correctly or list all dependencies?

				);
				$this->logging->setup(
					$title,
					$curl_error,
					0,
					0,
					$status
				);
			} elseif ( isset( $data[0]['errorCode'] ) && '' !== $data[0]['errorCode'] ) { // salesforce uses this structure to return errors
				// create log entry for failed curl.
				$status = 'error';
				$title  = sprintf(
					// translators: placeholders are: 1) the log status, 2) the HTTP status code returned by the Salesforce API request.
					esc_html__( '%1$s: %2$s: on Salesforce HTTP request', 'object-sync-for-salesforce' ),
					ucfirst( esc_attr( $status ) ),
					absint( $code )
				);
				$body = sprintf(
					// translators: placeholders are: 1) the URL requested, 2) the message returned by the error, 3) the server code returned.
					'<p>' . esc_html__( 'URL: %1$s', 'object-sync-for-salesforce' ) . '</p><p>' . esc_html__( 'Message: %2$s', 'object-sync-for-salesforce' ) . '</p><p>' . esc_html__( 'Code: %3$s', 'object-sync-for-salesforce' ),
					esc_attr( $url ),
					esc_html( $data[0]['message'] ),

The function esc_html was not found. Maybe you did not declare it correctly or list all dependencies?

					absint( $code )
				);
				$this->logging->setup(
					$title,
					$body,
					0,
					0,
					$status
				);
			} else {
				// create log entry for failed curl.
				$status = 'error';
				$title  = sprintf(
					// translators: placeholders are: 1) the log status, 2) the HTTP status code returned by the Salesforce API request.
					esc_html__( '%1$s: %2$s: on Salesforce HTTP request', 'object-sync-for-salesforce' ),
					ucfirst( esc_attr( $status ) ),
					absint( $code )
				);
				$this->logging->setup(
					$title,
					print_r( $data, true ), // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
					0,
					0,
					$status
				);
			} // End if() statement.
		} // End if() statement.

		curl_close( $curl );

		$result = array(
			'code' => $code,
		);

		$return_format = isset( $options['return_format'] ) ? $options['return_format'] : 'array';

		switch ( $return_format ) {
			case 'array':
				$result['data'] = $data;
				break;
			case 'json':
				$result['json'] = $json_response;
				break;
			case 'both':
				$result['json'] = $json_response;
				$result['data'] = $data;
				break;
		}

		return $result;