<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Data Download IP Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to /data/download-ips

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\API;

[7] Fix | Delete

[8] Fix | Delete

defined( 'ABSPATH' ) || exit;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Data Download IP controller.

[12] Fix | Delete

*

[13] Fix | Delete

* @internal

[14] Fix | Delete

* @extends WC_REST_Data_Controller

[15] Fix | Delete

*/

[16] Fix | Delete

class DataDownloadIPs extends \WC_REST_Data_Controller {

[17] Fix | Delete

/**

[18] Fix | Delete

* Endpoint namespace.

[19] Fix | Delete

*

[20] Fix | Delete

* @var string

[21] Fix | Delete

*/

[22] Fix | Delete

protected $namespace = 'wc-analytics';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Route base.

[26] Fix | Delete

*

[27] Fix | Delete

* @var string

[28] Fix | Delete

*/

[29] Fix | Delete

protected $rest_base = 'data/download-ips';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Register routes.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 3.5.0

[35] Fix | Delete

*/

[36] Fix | Delete

public function register_routes() {

[37] Fix | Delete

register_rest_route(

[38] Fix | Delete

$this->namespace,

[39] Fix | Delete

'/' . $this->rest_base,

[40] Fix | Delete

array(

[41] Fix | Delete

array(

[42] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[43] Fix | Delete

'callback' => array( $this, 'get_items' ),

[44] Fix | Delete

'permission_callback' => array( $this, 'get_items_permissions_check' ),

[45] Fix | Delete

),

[46] Fix | Delete

'schema' => array( $this, 'get_public_item_schema' ),

[47] Fix | Delete

)

[48] Fix | Delete

);

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Return the download IPs matching the passed parameters.

[53] Fix | Delete

*

[54] Fix | Delete

* @since 3.5.0

[55] Fix | Delete

* @param WP_REST_Request $request Request data.

[56] Fix | Delete

* @return WP_Error|WP_REST_Response

[57] Fix | Delete

*/

[58] Fix | Delete

public function get_items( $request ) {

[59] Fix | Delete

global $wpdb;

[60] Fix | Delete

[61] Fix | Delete

if ( isset( $request['match'] ) ) {

[62] Fix | Delete

$downloads = $wpdb->get_results(

[63] Fix | Delete

$wpdb->prepare(

[64] Fix | Delete

"SELECT DISTINCT( user_ip_address ) FROM {$wpdb->prefix}wc_download_log

[65] Fix | Delete

WHERE user_ip_address LIKE %s

[66] Fix | Delete

LIMIT 10",

[67] Fix | Delete

$request['match'] . '%'

[68] Fix | Delete

)

[69] Fix | Delete

);

[70] Fix | Delete

} else {

[71] Fix | Delete

return new \WP_Error( 'woocommerce_rest_data_download_ips_invalid_request', __( 'Invalid request. Please pass the match parameter.', 'woocommerce' ), array( 'status' => 400 ) );

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

$data = array();

[75] Fix | Delete

[76] Fix | Delete

if ( ! empty( $downloads ) ) {

[77] Fix | Delete

foreach ( $downloads as $download ) {

[78] Fix | Delete

$response = $this->prepare_item_for_response( $download, $request );

[79] Fix | Delete

$data[] = $this->prepare_response_for_collection( $response );

[80] Fix | Delete

}

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

return rest_ensure_response( $data );

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Prepare the data object for response.

[88] Fix | Delete

*

[89] Fix | Delete

* @since 3.5.0

[90] Fix | Delete

* @param object $item Data object.

[91] Fix | Delete

* @param WP_REST_Request $request Request object.

[92] Fix | Delete

* @return WP_REST_Response $response Response data.

[93] Fix | Delete

*/

[94] Fix | Delete

public function prepare_item_for_response( $item, $request ) {

[95] Fix | Delete

$data = $this->add_additional_fields_to_object( $item, $request );

[96] Fix | Delete

$data = $this->filter_response_by_context( $data, 'view' );

[97] Fix | Delete

$response = rest_ensure_response( $data );

[98] Fix | Delete

[99] Fix | Delete

$response->add_links( $this->prepare_links( $item ) );

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Filter the list returned from the API.

[103] Fix | Delete

*

[104] Fix | Delete

* @param WP_REST_Response $response The response object.

[105] Fix | Delete

* @param array $item The original item.

[106] Fix | Delete

* @param WP_REST_Request $request Request used to generate the response.

[107] Fix | Delete

*/

[108] Fix | Delete

return apply_filters( 'woocommerce_rest_prepare_data_download_ip', $response, $item, $request );

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Prepare links for the request.

[113] Fix | Delete

*

[114] Fix | Delete

* @param object $item Data object.

[115] Fix | Delete

* @return array Links for the given object.

[116] Fix | Delete

*/

[117] Fix | Delete

protected function prepare_links( $item ) {

[118] Fix | Delete

$links = array(

[119] Fix | Delete

'collection' => array(

[120] Fix | Delete

'href' => rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ),

[121] Fix | Delete

),

[122] Fix | Delete

);

[123] Fix | Delete

return $links;

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Get the query params for collections.

[128] Fix | Delete

*

[129] Fix | Delete

* @return array

[130] Fix | Delete

*/

[131] Fix | Delete

public function get_collection_params() {

[132] Fix | Delete

$params = array();

[133] Fix | Delete

$params['context'] = $this->get_context_param( array( 'default' => 'view' ) );

[134] Fix | Delete

$params['match'] = array(

[135] Fix | Delete

'description' => __( 'A partial IP address can be passed and matching results will be returned.', 'woocommerce' ),

[136] Fix | Delete

'type' => 'string',

[137] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[138] Fix | Delete

);

[139] Fix | Delete

return $params;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Get the schema, conforming to JSON Schema.

[145] Fix | Delete

*

[146] Fix | Delete

* @return array

[147] Fix | Delete

*/

[148] Fix | Delete

public function get_item_schema() {

[149] Fix | Delete

$schema = array(

[150] Fix | Delete

'$schema' => 'http://json-schema.org/draft-04/schema#',

[151] Fix | Delete

'title' => 'data_download_ips',

[152] Fix | Delete

'type' => 'object',

[153] Fix | Delete

'properties' => array(

[154] Fix | Delete

'user_ip_address' => array(

[155] Fix | Delete

'type' => 'string',

[156] Fix | Delete

'description' => __( 'IP address.', 'woocommerce' ),

[157] Fix | Delete

'context' => array( 'view' ),

[158] Fix | Delete

'readonly' => true,

[159] Fix | Delete

),

[160] Fix | Delete

),

[161] Fix | Delete

);

[162] Fix | Delete

[163] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[164] Fix | Delete

}

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete