WC_Auth::_format_api_key_data() - Code Metrics - Inspection of "Api keys refactoring" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#11616)

unknown
created 2016-08-03 15:16 UTC
WC_Auth::_format_api_key_data() A

↳ Parent: WC_Auth
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
cc	2
eloc	5
c	1
b	0
f	1
nc	2
nop	1
dl	0
loc	8
rs	9.4285
<?php
/**
 * WooCommerce Auth
 *
 * Handles wc-auth endpoint requests.
 *
 * @author   WooThemes
 * @category API
 * @package  WooCommerce/API
 * @since    2.4.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( 'WC_Auth' ) ) :

class WC_Auth {

	/**
	 * Version.
	 *
	 * @var int
	 */
	const VERSION = 1;

	/**
	 * Setup class.
	 *
	 * @since 2.4.0
	 */
	public function __construct() {
		// Add query vars
		add_filter( 'query_vars', array( $this, 'add_query_vars' ), 0 );

		// Register auth endpoint
		add_action( 'init', array( __CLASS__, 'add_endpoint' ), 0 );

		// Handle auth requests
		add_action( 'parse_request', array( $this, 'handle_auth_requests' ), 0 );
	}

	/**
	 * Add query vars.
	 *
	 * @since  2.4.0
	 *
	 * @param  array $vars
	 *
	 * @return string[]
	 */
	public function add_query_vars( $vars ) {
		$vars[] = 'wc-auth-version';
		$vars[] = 'wc-auth-route';
		return $vars;
	}

	/**
	 * Add auth endpoint.
	 *
	 * @since 2.4.0
	 */
	public static function add_endpoint() {
		add_rewrite_rule( '^wc-auth/v([1]{1})/(.*)?', 'index.php?wc-auth-version=$matches[1]&wc-auth-route=$matches[2]', 'top' );
	}

	/**
	 * Get scope name.
	 *
	 * @since 2.4.0
	 *
	 * @param  string $scope
	 *
	 * @return string
	 */
	protected function get_i18n_scope( $scope ) {
		$permissions = array(
			'read'       => __( 'Read', 'woocommerce' ),
			'write'      => __( 'Write', 'woocommerce' ),
			'read_write' => __( 'Read/Write', 'woocommerce' ),
		);

		return $permissions[ $scope ];
	}

	/**
	 * Return a list of permissions a scope allows.
	 *
	 * @since  2.4.0
	 *
	 * @param  string $scope
	 *
	 * @return array
	 */
	protected function get_permissions_in_scope( $scope ) {
		$permissions = array();
		switch ( $scope )  {
			case 'read' :

				$permissions[] = __( 'View coupons', 'woocommerce' );
				$permissions[] = __( 'View customers', 'woocommerce' );
				$permissions[] = __( 'View orders and sales reports', 'woocommerce' );
				$permissions[] = __( 'View products', 'woocommerce' );
			break;
			case 'write' :

				$permissions[] = __( 'Create webhooks', 'woocommerce' );
				$permissions[] = __( 'Create coupons', 'woocommerce' );
				$permissions[] = __( 'Create customers', 'woocommerce' );
				$permissions[] = __( 'Create orders', 'woocommerce' );
				$permissions[] = __( 'Create products', 'woocommerce' );
			break;
			case 'read_write' :

				$permissions[] = __( 'Create webhooks', 'woocommerce' );
				$permissions[] = __( 'View and manage coupons', 'woocommerce' );
				$permissions[] = __( 'View and manage customers', 'woocommerce' );
				$permissions[] = __( 'View and manage orders and sales reports', 'woocommerce' );
				$permissions[] = __( 'View and manage products', 'woocommerce' );
			break;
		}
		return apply_filters( 'woocommerce_api_permissions_in_scope', $permissions, $scope );
	}

	/**
	 * Build auth urls.
	 *
	 * @since  2.4.0
	 *
	 * @param  array $data
	 * @param  string $endpoint
	 *
	 * @return string
	 */
	protected function build_url( $data, $endpoint ) {
		$url = wc_get_endpoint_url( 'wc-auth/v' . self::VERSION, $endpoint, home_url( '/' ) );

		return add_query_arg( array(
			'app_name'            => wc_clean( $data['app_name'] ),
			'user_id'             => wc_clean( $data['user_id'] ),
			'return_url'          => urlencode( $this->get_formatted_url( $data['return_url'] ) ),
			'callback_url'        => urlencode( $this->get_formatted_url( $data['callback_url'] ) ),
			'scope'               => wc_clean( $data['scope'] ),
		), $url );
	}

	/**
	 * Decode and format a URL.
	 * @param  string $url
	 * @return array
	 */
	protected function get_formatted_url( $url ) {
		$url = urldecode( $url );

		if ( ! strstr( $url, '://' ) ) {
			$url = 'https://' . $url;
		}

		return $url;
	}

	/**
	 * Make validation.
	 *
	 * @since  2.4.0
	 */
	protected function make_validation() {
		$params = array(
			'app_name',
			'user_id',
			'return_url',
			'callback_url',
			'scope'
		);

		foreach ( $params as $param ) {
			if ( empty( $_REQUEST[ $param ] ) ) {
				throw new Exception( sprintf( __( 'Missing parameter %s', 'woocommerce' ), $param ) );
			}
		}

		if ( ! in_array( $_REQUEST['scope'], array( 'read', 'write', 'read_write' ) ) ) {
			throw new Exception( sprintf( __( 'Invalid scope %s', 'woocommerce' ), wc_clean( $_REQUEST['scope'] ) ) );
		}

		foreach ( array( 'return_url', 'callback_url' ) as $param ) {
			$param = $this->get_formatted_url( $_REQUEST[ $param ] );

			if ( false === filter_var( $param, FILTER_VALIDATE_URL ) ) {
				throw new Exception( sprintf( __( 'The %s is not a valid URL', 'woocommerce' ), $param ) );
			}
		}

		$callback_url = $this->get_formatted_url( $_REQUEST['callback_url'] );

		if ( 0 !== stripos( $callback_url, 'https://' ) ) {
			throw new Exception( __( 'The callback_url need to be over SSL', 'woocommerce' ) );
		}
	}

	/**
	 * Create keys.
	 *
	 * @since  2.4.0
	 *
	 * @param  string $app_name
	 * @param  string $app_user_id
	 * @param  string $scope
	 *
	 * @return array
	 */
	protected function create_keys( $app_name, $app_user_id, $scope ) {
		$description = sprintf( __( '%s - API %s (created on %s at %s).', 'woocommerce' ), wc_clean( $app_name ), $this->get_i18n_scope( $scope ), date_i18n( wc_date_format() ), date_i18n( wc_time_format() ) );
		$user        = wp_get_current_user();

		// Created API keys.
		$result = WC_Auth::create_api_key( array(
			'description' => $description,
			'user_id' => $user->ID,
			'scope' => $scope
		) );

		// @TODO: Apparently $app_user_id was not used previously (before 2.6.2) but for return array
		// @TODO: It could be deprecated and user only current user or actually use $app_user_id instead

		$result['user_id'] = $app_user_id;
		return $result;
	}

	/**
	 * Post consumer data.
	 *
	 * @since  2.4.0
	 *
	 * @param  array  $consumer_data
	 * @param  string $url
	 *
	 * @return bool
	 * @throws Exception
	 */
	protected function post_consumer_data( $consumer_data, $url ) {
		$params = array(
			'body'      => json_encode( $consumer_data ),
			'timeout'   => 60,
			'headers'   => array(
				'Content-Type' => 'application/json;charset=' . get_bloginfo( 'charset' ),
			)
		);

		$response = wp_safe_remote_post( esc_url_raw( $url ), $params );

		if ( is_wp_error( $response ) ) {
			throw new Exception( $response->get_error_message() );
		} else if ( 200 != $response['response']['code'] ) {
			throw new Exception( __( 'An error occurred in the request and at the time were unable to send the consumer data', 'woocommerce' ) );
		}

		return true;
	}

	/**
	 * Handle auth requests.
	 *
	 * @since 2.4.0
	 */
	public function handle_auth_requests() {
		global $wp;

		if ( ! empty( $_GET['wc-auth-version'] ) ) {
			$wp->query_vars['wc-auth-version'] = $_GET['wc-auth-version'];
		}

		if ( ! empty( $_GET['wc-auth-route'] ) ) {
			$wp->query_vars['wc-auth-route'] = $_GET['wc-auth-route'];
		}

		// wc-auth endpoint requests
		if ( ! empty( $wp->query_vars['wc-auth-version'] ) && ! empty( $wp->query_vars['wc-auth-route'] ) ) {
			$this->auth_endpoint( $wp->query_vars['wc-auth-route'] );
		}
	}

	/**
	 * Auth endpoint.
	 *
	 * @since 2.4.0
	 *
	 * @param string $route
	 */
	protected function auth_endpoint( $route ) {
		ob_start();

		$consumer_data = array();

		try {
			if ( 'yes' !== get_option( 'woocommerce_api_enabled' ) ) {
				throw new Exception( __( 'API disabled!', 'woocommerce' ) );
			}

			$route = strtolower( wc_clean( $route ) );
			$this->make_validation();

			// Login endpoint
			if ( 'login' == $route && ! is_user_logged_in() ) {
				wc_get_template( 'auth/form-login.php', array(
					'app_name'     => $_REQUEST['app_name'],
					'return_url'   => add_query_arg( array( 'success' => 0, 'user_id' => wc_clean( $_REQUEST['user_id'] ) ), $this->get_formatted_url( $_REQUEST['return_url'] ) ),
					'redirect_url' => $this->build_url( $_REQUEST, 'authorize' ),
				) );

				exit;

			// Redirect with user is logged in
			} else if ( 'login' == $route && is_user_logged_in() ) {
				wp_redirect( esc_url_raw( $this->build_url( $_REQUEST, 'authorize' ) ) );
				exit;

			// Redirect with user is not logged in and trying to access the authorize endpoint
			} else if ( 'authorize' == $route && ! is_user_logged_in() ) {
				wp_redirect( esc_url_raw( $this->build_url( $_REQUEST, 'login' ) ) );
				exit;

			// Authorize endpoint
			} else if ( 'authorize' == $route && current_user_can( 'manage_woocommerce' ) ) {
				wc_get_template( 'auth/form-grant-access.php', array(
					'app_name'    => $_REQUEST['app_name'],
					'return_url'  => add_query_arg( array( 'success' => 0, 'user_id' => wc_clean( $_REQUEST['user_id'] ) ), $this->get_formatted_url( $_REQUEST['return_url'] ) ),
					'scope'       => $this->get_i18n_scope( wc_clean( $_REQUEST['scope'] ) ),
					'permissions' => $this->get_permissions_in_scope( wc_clean( $_REQUEST['scope'] ) ),
					'granted_url' => wp_nonce_url( $this->build_url( $_REQUEST, 'access_granted' ), 'wc_auth_grant_access', 'wc_auth_nonce' ),
					'logout_url'  => wp_logout_url( $this->build_url( $_REQUEST, 'login' ) ),
					'user'        => wp_get_current_user()
				) );
				exit;

			// Granted access endpoint
			} else if ( 'access_granted' == $route && current_user_can( 'manage_woocommerce' ) ) {
				if ( ! isset( $_GET['wc_auth_nonce'] ) || ! wp_verify_nonce( $_GET['wc_auth_nonce'], 'wc_auth_grant_access' ) ) {
					throw new Exception( __( 'Invalid nonce verification', 'woocommerce' ) );
				}

				$consumer_data = $this->create_keys( $_REQUEST['app_name'], $_REQUEST['user_id'], $_REQUEST['scope'] );
				$response      = $this->post_consumer_data( $consumer_data, $this->get_formatted_url( $_REQUEST['callback_url'] ) );
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

				if ( $response ) {
					wp_redirect( esc_url_raw( add_query_arg( array( 'success' => 1, 'user_id' => wc_clean( $_REQUEST['user_id'] ) ), $this->get_formatted_url( $_REQUEST['return_url'] ) ) ) );
					exit;
				}
			} else {
				throw new Exception( __( 'You do not have permissions to access this page!', 'woocommerce' ) );
			}
		} catch ( Exception $e ) {
			$this->maybe_delete_key( $consumer_data );
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

			wp_die( sprintf( __( 'Error: %s', 'woocommerce' ), $e->getMessage() ), __( 'Access Denied', 'woocommerce' ), array( 'response' => 401 ) );
		}
	}

	/**
	 * Maybe delete key.
	 *
	 * @since 2.4.0
	 *
	 * @param array $key
	 */
	private function maybe_delete_key( $key ) {
		if ( isset( $key['key_id'] ) ) {
			WC_Auth::delete_api_key( $key['key_id'] );
		}
	}

	/**
	 * Generate a new pair of API Key/Secret
	 *
	 * @param array $args {
	 *     An array of arguments.
	 *
	 *     @type string    $description        Application description
	 *     @type int       $user_id            The user ID that the pair will be assigned to
	 *     @type string    $scope           Scope of the API Keys ('read', 'write' or 'read_write')
	 * }
	 *
	 * @return array|bool Return an array with the API Keys data. False in case of error.
	 */
	public static function create_api_key( $args = array() ) {
		global $wpdb;

		$defaults = array(
			'description' => '',
			'user_id' => 0,
			'scope' => 'read'
		);

		$args = wp_parse_args( $args, $defaults );

		// Sanitize description
		$description = wc_clean( $args['description'] );

		// If the user is not passed, let's use the current user
		$user_id = absint( $args['user_id'] );
		if ( ! $user_id ) {
			$user_id = get_current_user_id();
		}

		$user = get_userdata( $user_id );

		if ( ! $user ) {
			return false;
		}

		// Sanitize scope
		$scope = sanitize_text_field( $args['scope'] );
		$permissions     = ( in_array( $scope, array( 'read', 'write', 'read_write' ) ) ) ? $scope : 'read';

		// Created API keys.
		$consumer_key    = 'ck_' . wc_rand_hash();
		$consumer_secret = 'cs_' . wc_rand_hash();

		$wpdb->insert(
			$wpdb->prefix . 'woocommerce_api_keys',
			array(
				'user_id'         => $user->ID,
				'description'     => $description,
				'permissions'     => $permissions,
				'consumer_key'    => wc_api_hash( $consumer_key ),
				'consumer_secret' => $consumer_secret,
				'truncated_key'   => substr( $consumer_key, -7 )
			),
			array(
				'%d',
				'%s',
				'%s',
				'%s',
				'%s',
				'%s'
			)
		);

		return array(
			'key_id'          => $wpdb->insert_id,
			'user_id'         => $user_id,
			'consumer_key'    => $consumer_key,
			'consumer_secret' => $consumer_secret,
			'key_permissions' => $permissions
		);
	}

	/**
	 * Update a single API Key pair data
	 *
	 * @param int $key_id Key ID
	 * @param array $args {
	 *      List of arguments to be updated. Must include at least one of these:
	 *      @type int       $user_id            New User ID
	 *      @type string    $description        New Application description
	 *      @type string    $scope              New Scope of the API Keys ('read', 'write' or 'read_write')
	 *      @type string    $last_access        New last access date in MySQL format
	 *      @type array     $last_access        New nonces list
	 * }
	 *
	 * @return bool
	 */
	public static function update_api_key( $key_id, $args = array() ) {
		global $wpdb;

		$api_key_data = self::get_api_key_data( $key_id );
		if ( ! $api_key_data ) {
			return false;
		}

		$update = array();
		$update_format = array();

		if ( isset( $args['user_id'] ) ) {
			$user = get_userdata( $args['user_id'] );
			if ( ! $user ) {
				return false;
			}

			$update['user_id'] = $args['user_id'];
			$update_format[] = '%d';
		}

		if ( isset( $args['scope'] ) ) {
			$scope = sanitize_text_field( $args['scope'] );
			$permissions     = ( in_array( $scope, array( 'read', 'write', 'read_write' ) ) ) ? $scope : 'read';

			$update['permissions'] = $permissions;
			$update_format[] = '%s';
		}

		if ( isset( $args['description'] ) ) {
			$update['description'] = sanitize_text_field( $args['description'] );
			$update_format[] = '%s';
		}

		if ( isset( $args['last_access'] ) ) {
			$update['last_access'] = $args['last_access'];
			$update_format[] = '%s';
		}

		if ( isset( $args['nonces'] ) ) {
			$update['nonces'] = maybe_serialize( $args['nonces'] );
			$update_format[] = '%s';
		}

		if ( empty( $update ) ) {
			return false;
		}

		 $wpdb->update(
			$wpdb->prefix . 'woocommerce_api_keys',
			$update,
			array( 'key_id' => $key_id ),
			$update_format,
			array( '%d' )
		);

		self::clear_api_key_cache( $key_id );

		return true;
	}

	public static function update_last_access( $key_id ) {
		return self::update_api_key( $key_id, array( 'last_access' => current_time( 'mysql' ) ) );
	}

	/**
	 * Get a list of API Key data rows
	 *
	 * @param array $args
	 *
	 * @return array
	 */
	public static function get_api_keys( $args = array() ) {
		global $wpdb;

		$defaults = array(
			'per_page' => 10,
			'page' => 1,
			's' => '',
			'count' => false
		);

		$args = wp_parse_args( $args, $defaults );

		$where = array( "1 = 1" );

		$args['s'] = wc_clean( $args['s'] );
		if ( $args['s'] ) {
			$where[] = $wpdb->prepare( "description LIKE %s", '%' . $wpdb->esc_like( $args['s'] ) . '%' );
		}

		$where = "WHERE " . implode( " AND ", $where );

		if ( $args['per_page'] < 0 ) {
			$limit = '';
		}
		else {
			if ( 1 < $args['page'] ) {
				$offset = $args['per_page'] * ( $args['page'] - 1 );
			} else {
				$offset = 0;
			}

			$limit = $wpdb->prepare( "LIMIT %d OFFSET %d", $args['per_page'], $offset );
		}


		if ( $args['count'] ) {
			$sql = "SELECT COUNT(key_id) FROM {$wpdb->prefix}woocommerce_api_keys $where";

			$cache_key = md5( $sql );
			$cached = wp_cache_get( 'wc_api_key_counts' );
			if ( false === $cached || ! is_array( $cached ) ) {
				$cached = array();
			}

			$count = isset( $cached[ $cache_key ] ) ? $cached[ $cache_key ] : false;
			if ( false === $count ) {
				$count = $wpdb->get_var( $sql );
				$cached[ $cache_key ] = $count;
				wp_cache_set( 'wc_api_key_counts', $cached );
			}

			return $count;

		}
		else {
			$sql = "SELECT * FROM {$wpdb->prefix}woocommerce_api_keys $where ORDER BY key_id DESC $limit";

			$cache_key = md5( $sql );
			$cached = wp_cache_get( 'wc_get_api_keys' );
			if ( false === $cached || ! is_array( $cached ) ) {
				$cached = array();
			}

			$results = isset( $cached[ $cache_key ] ) ? $cached[ $cache_key ] : false;
			if ( false === $results ) {
				$results = $wpdb->get_results( $sql );

				if ( ! $results ) {
					$results = array();
				}

				$cached[ $cache_key ] = $results;
				wp_cache_set( 'wc_get_api_keys', $cached );
			}

			$list = array();
			foreach ( $results as $row ) {
				wp_cache_add( $row->key_id, $row, 'wc_api_keys' );
				wp_cache_add( $row->consumer_key, $row, 'wc_api_keys_consumer' );
				$list[] = self::_format_api_key_data( $row );
			}

			return $list;
		}

	}

	public static function get_api_keys_count( $args = array() ) {
		$args['count'] = true;
		return self::get_api_keys( $args );
	}

	/**
	 * Get a single API Key pair data
	 *
	 * @param int $key_id Key ID
	 *
	 * @return bool|object
	 */
	public static function get_api_key_data( $key_id ) {
		global $wpdb;

		$data = wp_cache_get( $key_id, 'wc_api_keys' );
		if ( false === $data ) {
			$table = $wpdb->prefix . 'woocommerce_api_keys';

			$data = $wpdb->get_row(
				$wpdb->prepare(
					"SELECT * FROM $table 
				WHERE key_id = %d
				LIMIT 1",
					$key_id
				)
			);

			wp_cache_add( $key_id, $data, 'wc_api_keys' );
		}

		return self::_format_api_key_data( $data );
	}

	/**
	 * Return the Api Key data for the given consumer_key.
	 *
	 * @param string $consumer_key
	 * @return array
	 */
	public static function get_api_key_data_by_consumer_key( $consumer_key ) {
		global $wpdb;

		$consumer_key = wc_api_hash( sanitize_text_field( $consumer_key ) );

		$data = wp_cache_get( $consumer_key, 'wc_api_keys_consumer' );
		if ( false === $data ) {
			$data         = $wpdb->get_row(
				$wpdb->prepare( "
				SELECT *
				FROM {$wpdb->prefix}woocommerce_api_keys
				WHERE consumer_key = %s ",
					$consumer_key
				)
			);

			wp_cache_add( $consumer_key, $data, 'wc_api_keys_consumer' );
		}


		return self::_format_api_key_data( $data );
	}

	/**
	 * Format an API Key Data row object
	 *
	 * @param object $data
	 * @return bool|object
	 */
	private static function _format_api_key_data( $data ) {
		if ( ! $data ) {
			return false;
		}

		$data->nonces = maybe_unserialize( $data->nonces );
		return $data;
	}

	/**
	 * Delete an API Key pair data
	 *
	 * @param int $key_id Key ID
	 *
	 * @return bool
	 */
	public static function delete_api_key( $key_id ) {
		global $wpdb;
	    $result = $wpdb->delete(
			$wpdb->prefix . 'woocommerce_api_keys',
			array( 'key_id' => $key_id ),
			array( '%d' )
		);

		self::clear_api_key_cache( $key_id );

		return $result;
	}

	public static function clear_api_key_cache( $key_id ) {
		$data = self::get_api_key_data( $key_id );
		if ( ! $data ) {
			return;
		}

		wp_cache_delete( $key_id, 'wc_api_keys' );
		wp_cache_delete( $data->consumer_key, 'wc_api_keys_consumer' );
		wp_cache_delete( 'wc_get_api_keys' );
		wp_cache_delete( 'wc_api_key_counts' );
	}
}

endif;

return new WC_Auth();

woothemes / woocommerce

Pull Request — master (#11616)

WC_Auth::_format_api_key_data() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
