168 lines
4.2 KiB
PHP
168 lines
4.2 KiB
PHP
<?php
|
|
/**
|
|
* REST API Data Download IP Controller
|
|
*
|
|
* Handles requests to /data/download-ips
|
|
*
|
|
* @package WooCommerce Admin/API
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* Data Download IP controller.
|
|
*
|
|
* @package WooCommerce Admin/API
|
|
* @extends WC_REST_Data_Controller
|
|
*/
|
|
class WC_Admin_REST_Data_Download_Ips_Controller extends WC_REST_Data_Controller {
|
|
/**
|
|
* Endpoint namespace.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $namespace = 'wc/v4';
|
|
|
|
/**
|
|
* Route base.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $rest_base = 'data/download-ips';
|
|
|
|
/**
|
|
* Register routes.
|
|
*
|
|
* @since 3.5.0
|
|
*/
|
|
public function register_routes() {
|
|
register_rest_route(
|
|
$this->namespace,
|
|
'/' . $this->rest_base,
|
|
array(
|
|
array(
|
|
'methods' => WP_REST_Server::READABLE,
|
|
'callback' => array( $this, 'get_items' ),
|
|
'permission_callback' => array( $this, 'get_items_permissions_check' ),
|
|
),
|
|
'schema' => array( $this, 'get_public_item_schema' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Return the download IPs matching the passed parameters.
|
|
*
|
|
* @since 3.5.0
|
|
* @param WP_REST_Request $request Request data.
|
|
* @return WP_Error|WP_REST_Response
|
|
*/
|
|
public function get_items( $request ) {
|
|
global $wpdb;
|
|
|
|
if ( isset( $request['match'] ) ) {
|
|
$downloads = $wpdb->get_results(
|
|
$wpdb->prepare(
|
|
"SELECT DISTINCT( user_ip_address ) FROM {$wpdb->prefix}wc_download_log
|
|
WHERE user_ip_address LIKE %s
|
|
LIMIT 10",
|
|
$request['match'] . '%'
|
|
)
|
|
);
|
|
} else {
|
|
return new WP_Error( 'woocommerce_rest_data_download_ips_invalid_request', __( 'Invalid request. Please pass the match parameter.', 'woocommerce-admin' ), array( 'status' => 400 ) );
|
|
}
|
|
|
|
$data = array();
|
|
|
|
if ( ! empty( $downloads ) ) {
|
|
foreach ( $downloads as $download ) {
|
|
$response = $this->prepare_item_for_response( $download, $request );
|
|
$data[] = $this->prepare_response_for_collection( $response );
|
|
}
|
|
}
|
|
|
|
return rest_ensure_response( $data );
|
|
}
|
|
|
|
/**
|
|
* Prepare the data object for response.
|
|
*
|
|
* @since 3.5.0
|
|
* @param object $item Data object.
|
|
* @param WP_REST_Request $request Request object.
|
|
* @return WP_REST_Response $response Response data.
|
|
*/
|
|
public function prepare_item_for_response( $item, $request ) {
|
|
$data = $this->add_additional_fields_to_object( $item, $request );
|
|
$data = $this->filter_response_by_context( $data, 'view' );
|
|
$response = rest_ensure_response( $data );
|
|
|
|
$response->add_links( $this->prepare_links( $item ) );
|
|
|
|
/**
|
|
* Filter the ist returned from the API.
|
|
*
|
|
* @param WP_REST_Response $response The response object.
|
|
* @param array $item The original item.
|
|
* @param WP_REST_Request $request Request used to generate the response.
|
|
*/
|
|
return apply_filters( 'woocommerce_rest_prepare_data_download_ip', $response, $item, $request );
|
|
}
|
|
|
|
/**
|
|
* Prepare links for the request.
|
|
*
|
|
* @param object $item Data object.
|
|
* @return array Links for the given object.
|
|
*/
|
|
protected function prepare_links( $item ) {
|
|
$links = array(
|
|
'collection' => array(
|
|
'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),
|
|
),
|
|
);
|
|
return $links;
|
|
}
|
|
|
|
/**
|
|
* Get the query params for collections.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_collection_params() {
|
|
$params = array();
|
|
$params['context'] = $this->get_context_param( array( 'default' => 'view' ) );
|
|
$params['match'] = array(
|
|
'description' => __( 'A partial IP address can be passed and matching results will be returned.', 'woocommerce-admin' ),
|
|
'type' => 'string',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
return $params;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get the schema, conforming to JSON Schema.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_item_schema() {
|
|
$schema = array(
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
|
'title' => 'data_download_ips',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'user_ip_address' => array(
|
|
'type' => 'string',
|
|
'description' => __( 'IP address.', 'woocommerce-admin' ),
|
|
'context' => array( 'view' ),
|
|
'readonly' => true,
|
|
),
|
|
),
|
|
);
|
|
|
|
return $this->add_additional_fields_schema( $schema );
|
|
}
|
|
}
|