woocommerce/includes/class-wc-api.php

267 lines
6.3 KiB
PHP

<?php
/**
* WooCommerce API
*
* Handles WC-API endpoint requests
*
* @author WooThemes
* @category API
* @package WooCommerce/API
* @since 2.0
*/
if ( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly
class WC_API {
/** This is the major version for the REST API and takes
* first-order position in endpoint URLs
*/
const VERSION = 2;
/** @var WC_API_Server the REST API server */
public $server;
/** @var WC_API_Authentication REST API authentication class instance */
public $authentication;
/**
* Setup class
*
* @access public
* @since 2.0
* @return WC_API
*/
public function __construct() {
// add query vars
add_filter( 'query_vars', array( $this, 'add_query_vars'), 0 );
// register API endpoints
add_action( 'init', array( $this, 'add_endpoint'), 0 );
// handle REST API requests
add_action( 'parse_request', array( $this, 'handle_rest_api_requests'), 0 );
// handle wc-api endpoint requests
add_action( 'parse_request', array( $this, 'handle_api_requests' ), 0 );
}
/**
* add_query_vars function.
*
* @access public
* @since 2.0
* @param $vars
* @return string[]
*/
public function add_query_vars( $vars ) {
$vars[] = 'wc-api';
$vars[] = 'wc-api-version';
$vars[] = 'wc-api-route';
return $vars;
}
/**
* add_endpoint function.
*
* @access public
* @since 2.0
* @return void
*/
public function add_endpoint() {
// REST API
add_rewrite_rule( '^wc-api/v([1-2]{1})/?$', 'index.php?wc-api-version=$matches[1]&wc-api-route=/', 'top' );
add_rewrite_rule( '^wc-api/v([1-2]{1})(.*)?', 'index.php?wc-api-version=$matches[1]&wc-api-route=$matches[2]', 'top' );
// WC API for payment gateway IPNs, etc
add_rewrite_endpoint( 'wc-api', EP_ALL );
}
/**
* Handle REST API requests
*
* @since 2.2
*/
public function handle_rest_api_requests() {
global $wp;
if ( ! empty( $_GET['wc-api-version'] ) ) {
$wp->query_vars['wc-api-version'] = $_GET['wc-api-version'];
}
if ( ! empty( $_GET['wc-api-route'] ) ) {
$wp->query_vars['wc-api-route'] = $_GET['wc-api-route'];
}
// REST API request
if ( ! empty( $wp->query_vars['wc-api-version'] ) && ! empty( $wp->query_vars['wc-api-route'] ) ) {
define( 'WC_API_REQUEST', true );
define( 'WC_API_REQUEST_VERSION', absint( $wp->query_vars['wc-api-version'] ) );
// legacy v1 API request
if ( 1 === WC_API_REQUEST_VERSION ) {
$this->handle_v1_rest_api_request();
} else {
$this->includes();
$this->server = new WC_API_Server( $wp->query_vars['wc-api-route'] );
// load API resource classes
$this->register_resources( $this->server );
// Fire off the request
$this->server->serve_request();
}
exit;
}
}
/**
* Include required files for REST API request
*
* @since 2.1
*/
public function includes() {
// API server / response handlers
include_once( 'api/class-wc-api-exception.php' );
include_once( 'api/class-wc-api-server.php' );
include_once( 'api/interface-wc-api-handler.php' );
include_once( 'api/class-wc-api-json-handler.php' );
// authentication
include_once( 'api/class-wc-api-authentication.php' );
$this->authentication = new WC_API_Authentication();
include_once( 'api/class-wc-api-resource.php' );
include_once( 'api/class-wc-api-orders.php' );
include_once( 'api/class-wc-api-products.php' );
include_once( 'api/class-wc-api-coupons.php' );
include_once( 'api/class-wc-api-customers.php' );
include_once( 'api/class-wc-api-reports.php' );
include_once( 'api/class-wc-api-webhooks.php' );
// allow plugins to load other response handlers or resource classes
do_action( 'woocommerce_api_loaded' );
}
/**
* Register available API resources
*
* @since 2.1
* @param WC_API_Server $server the REST server
*/
public function register_resources( $server ) {
$api_classes = apply_filters( 'woocommerce_api_classes',
array(
'WC_API_Customers',
'WC_API_Orders',
'WC_API_Products',
'WC_API_Coupons',
'WC_API_Reports',
'WC_API_Webhooks',
)
);
foreach ( $api_classes as $api_class ) {
$this->$api_class = new $api_class( $server );
}
}
/**
* Handle legacy v1 REST API requests. Note this and the associated
* classes in the v1 folder should be removed when the API version is bumped
* to v3
*
* @since 2.2
*/
private function handle_v1_rest_api_request() {
// include legacy required files for v1 REST API request
include_once( 'api/v1/class-wc-api-server.php' );
include_once( 'api/v1/interface-wc-api-handler.php' );
include_once( 'api/v1/class-wc-api-json-handler.php' );
include_once( 'api/v1/class-wc-api-xml-handler.php' );
include_once( 'api/v1/class-wc-api-authentication.php' );
$this->authentication = new WC_API_Authentication();
include_once( 'api/v1/class-wc-api-resource.php' );
include_once( 'api/v1/class-wc-api-orders.php' );
include_once( 'api/v1/class-wc-api-products.php' );
include_once( 'api/v1/class-wc-api-coupons.php' );
include_once( 'api/v1/class-wc-api-customers.php' );
include_once( 'api/v1/class-wc-api-reports.php' );
// allow plugins to load other response handlers or resource classes
do_action( 'woocommerce_api_loaded' );
$this->server = new WC_API_Server( $GLOBALS['wp']->query_vars['wc-api-route'] );
// Register available resources for legacy v1 REST API request
$api_classes = apply_filters( 'woocommerce_api_classes',
array(
'WC_API_Customers',
'WC_API_Orders',
'WC_API_Products',
'WC_API_Coupons',
'WC_API_Reports',
)
);
foreach ( $api_classes as $api_class ) {
$this->$api_class = new $api_class( $this->server );
}
// Fire off the request
$this->server->serve_request();
}
/**
* API request - Trigger any API requests
*
* @access public
* @since 2.0
* @return void
*/
public function handle_api_requests() {
global $wp;
if ( ! empty( $_GET['wc-api'] ) ) {
$wp->query_vars['wc-api'] = $_GET['wc-api'];
}
// wc-api endpoint requests
if ( ! empty( $wp->query_vars['wc-api'] ) ) {
// Buffer, we won't want any output here
ob_start();
// Get API trigger
$api = strtolower( esc_attr( $wp->query_vars['wc-api'] ) );
// Load class if exists
if ( class_exists( $api ) )
$api_class = new $api();
// Trigger actions
do_action( 'woocommerce_api_' . $api );
// Done, clear buffer and exit
ob_end_clean();
die('1');
}
}
}