<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Reports Export Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to:

[4] Fix | Delete

* - /reports/[report]/export

[5] Fix | Delete

* - /reports/[report]/export/[id]/status

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

namespace Automattic\WooCommerce\Admin\API\Reports\Export;

[9] Fix | Delete

[10] Fix | Delete

defined( 'ABSPATH' ) || exit;

[11] Fix | Delete

[12] Fix | Delete

use Automattic\WooCommerce\Admin\ReportExporter;

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Reports Export controller.

[16] Fix | Delete

*

[17] Fix | Delete

* @internal

[18] Fix | Delete

* @extends \Automattic\WooCommerce\Admin\API\Reports\Controller

[19] Fix | Delete

*/

[20] Fix | Delete

class Controller extends \Automattic\WooCommerce\Admin\API\Reports\Controller {

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Route base.

[24] Fix | Delete

*

[25] Fix | Delete

* @var string

[26] Fix | Delete

*/

[27] Fix | Delete

protected $rest_base = 'reports/(?P<type>[a-z]+)/export';

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Register routes.

[31] Fix | Delete

*/

[32] Fix | Delete

public function register_routes() {

[33] Fix | Delete

register_rest_route(

[34] Fix | Delete

$this->namespace,

[35] Fix | Delete

'/' . $this->rest_base,

[36] Fix | Delete

array(

[37] Fix | Delete

array(

[38] Fix | Delete

'methods' => \WP_REST_Server::EDITABLE,

[39] Fix | Delete

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

[40] Fix | Delete

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

[41] Fix | Delete

'args' => $this->get_export_collection_params(),

[42] Fix | Delete

),

[43] Fix | Delete

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

[44] Fix | Delete

)

[45] Fix | Delete

);

[46] Fix | Delete

[47] Fix | Delete

register_rest_route(

[48] Fix | Delete

$this->namespace,

[49] Fix | Delete

'/' . $this->rest_base . '/(?P<export_id>[a-z0-9]+)/status',

[50] Fix | Delete

array(

[51] Fix | Delete

array(

[52] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[53] Fix | Delete

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

[54] Fix | Delete

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

[55] Fix | Delete

),

[56] Fix | Delete

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

[57] Fix | Delete

)

[58] Fix | Delete

);

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Get the query params for collections.

[63] Fix | Delete

*

[64] Fix | Delete

* @return array

[65] Fix | Delete

*/

[66] Fix | Delete

protected function get_export_collection_params() {

[67] Fix | Delete

$params = array();

[68] Fix | Delete

$params['report_args'] = array(

[69] Fix | Delete

'description' => __( 'Parameters to pass on to the exported report.', 'woocommerce' ),

[70] Fix | Delete

'type' => 'object',

[71] Fix | Delete

'validate_callback' => 'rest_validate_request_arg', // @todo: use each controller's schema?

[72] Fix | Delete

);

[73] Fix | Delete

$params['email'] = array(

[74] Fix | Delete

'description' => __( 'When true, email a link to download the export to the requesting user.', 'woocommerce' ),

[75] Fix | Delete

'type' => 'boolean',

[76] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[77] Fix | Delete

);

[78] Fix | Delete

return $params;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Get the Report Export's schema, conforming to JSON Schema.

[83] Fix | Delete

*

[84] Fix | Delete

* @return array

[85] Fix | Delete

*/

[86] Fix | Delete

public function get_export_public_schema() {

[87] Fix | Delete

$schema = array(

[88] Fix | Delete

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

[89] Fix | Delete

'title' => 'report_export',

[90] Fix | Delete

'type' => 'object',

[91] Fix | Delete

'properties' => array(

[92] Fix | Delete

'status' => array(

[93] Fix | Delete

'description' => __( 'Export status.', 'woocommerce' ),

[94] Fix | Delete

'type' => 'string',

[95] Fix | Delete

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

[96] Fix | Delete

'readonly' => true,

[97] Fix | Delete

),

[98] Fix | Delete

'message' => array(

[99] Fix | Delete

'description' => __( 'Export status message.', 'woocommerce' ),

[100] Fix | Delete

'type' => 'string',

[101] Fix | Delete

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

[102] Fix | Delete

'readonly' => true,

[103] Fix | Delete

),

[104] Fix | Delete

'export_id' => array(

[105] Fix | Delete

'description' => __( 'Export ID.', 'woocommerce' ),

[106] Fix | Delete

'type' => 'string',

[107] Fix | Delete

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

[108] Fix | Delete

'readonly' => true,

[109] Fix | Delete

),

[110] Fix | Delete

),

[111] Fix | Delete

);

[112] Fix | Delete

[113] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Get the Export status schema, conforming to JSON Schema.

[118] Fix | Delete

*

[119] Fix | Delete

* @return array

[120] Fix | Delete

*/

[121] Fix | Delete

public function get_export_status_public_schema() {

[122] Fix | Delete

$schema = array(

[123] Fix | Delete

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

[124] Fix | Delete

'title' => 'report_export_status',

[125] Fix | Delete

'type' => 'object',

[126] Fix | Delete

'properties' => array(

[127] Fix | Delete

'percent_complete' => array(

[128] Fix | Delete

'description' => __( 'Percentage complete.', 'woocommerce' ),

[129] Fix | Delete

'type' => 'int',

[130] Fix | Delete

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

[131] Fix | Delete

'readonly' => true,

[132] Fix | Delete

),

[133] Fix | Delete

'download_url' => array(

[134] Fix | Delete

'description' => __( 'Export download URL.', 'woocommerce' ),

[135] Fix | Delete

'type' => 'string',

[136] Fix | Delete

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

[137] Fix | Delete

'readonly' => true,

[138] Fix | Delete

),

[139] Fix | Delete

),

[140] Fix | Delete

);

[141] Fix | Delete

[142] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Export data based on user request params.

[147] Fix | Delete

*

[148] Fix | Delete

* @param WP_REST_Request $request Request data.

[149] Fix | Delete

* @return WP_Error|WP_REST_Response

[150] Fix | Delete

*/

[151] Fix | Delete

public function export_items( $request ) {

[152] Fix | Delete

$report_type = $request['type'];

[153] Fix | Delete

$report_args = empty( $request['report_args'] ) ? array() : $request['report_args'];

[154] Fix | Delete

$send_email = isset( $request['email'] ) ? $request['email'] : false;

[155] Fix | Delete

[156] Fix | Delete

$default_export_id = str_replace( '.', '', microtime( true ) );

[157] Fix | Delete

$export_id = apply_filters( 'woocommerce_admin_export_id', $default_export_id );

[158] Fix | Delete

$export_id = (string) sanitize_file_name( $export_id );

[159] Fix | Delete

[160] Fix | Delete

$total_rows = ReportExporter::queue_report_export( $export_id, $report_type, $report_args, $send_email );

[161] Fix | Delete

[162] Fix | Delete

if ( 0 === $total_rows ) {

[163] Fix | Delete

return rest_ensure_response(

[164] Fix | Delete

array(

[165] Fix | Delete

'message' => __( 'There is no data to export for the given request.', 'woocommerce' ),

[166] Fix | Delete

)

[167] Fix | Delete

);

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

ReportExporter::update_export_percentage_complete( $report_type, $export_id, 0 );

[171] Fix | Delete

[172] Fix | Delete

$response = rest_ensure_response(

[173] Fix | Delete

array(

[174] Fix | Delete

'message' => __( 'Your report file is being generated.', 'woocommerce' ),

[175] Fix | Delete

'export_id' => $export_id,

[176] Fix | Delete

)

[177] Fix | Delete

);

[178] Fix | Delete

[179] Fix | Delete

// Include a link to the export status endpoint.

[180] Fix | Delete

$response->add_links(

[181] Fix | Delete

array(

[182] Fix | Delete

'status' => array(

[183] Fix | Delete

'href' => rest_url( sprintf( '%s/reports/%s/export/%s/status', $this->namespace, $report_type, $export_id ) ),

[184] Fix | Delete

),

[185] Fix | Delete

)

[186] Fix | Delete

);

[187] Fix | Delete

[188] Fix | Delete

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

[189] Fix | Delete

[190] Fix | Delete

return rest_ensure_response( $data );

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

/**

[194] Fix | Delete

* Export status based on user request params.

[195] Fix | Delete

*

[196] Fix | Delete

* @param WP_REST_Request $request Request data.

[197] Fix | Delete

* @return WP_Error|WP_REST_Response

[198] Fix | Delete

*/

[199] Fix | Delete

public function export_status( $request ) {

[200] Fix | Delete

$report_type = $request['type'];

[201] Fix | Delete

$export_id = $request['export_id'];

[202] Fix | Delete

$percentage = ReportExporter::get_export_percentage_complete( $report_type, $export_id );

[203] Fix | Delete

[204] Fix | Delete

if ( false === $percentage ) {

[205] Fix | Delete

return new \WP_Error(

[206] Fix | Delete

'woocommerce_admin_reports_export_invalid_id',

[207] Fix | Delete

__( 'Sorry, there is no export with that ID.', 'woocommerce' ),

[208] Fix | Delete

array( 'status' => 404 )

[209] Fix | Delete

);

[210] Fix | Delete

}

[211] Fix | Delete

[212] Fix | Delete

$result = array(

[213] Fix | Delete

'percent_complete' => $percentage,

[214] Fix | Delete

);

[215] Fix | Delete

[216] Fix | Delete

// @todo - add thing in the links below instead?

[217] Fix | Delete

if ( 100 === $percentage ) {

[218] Fix | Delete

$query_args = array(

[219] Fix | Delete

'action' => ReportExporter::DOWNLOAD_EXPORT_ACTION,

[220] Fix | Delete

'filename' => "wc-{$report_type}-report-export-{$export_id}",

[221] Fix | Delete

);

[222] Fix | Delete

[223] Fix | Delete

$result['download_url'] = add_query_arg( $query_args, admin_url() );

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

// Wrap the data in a response object.

[227] Fix | Delete

$response = rest_ensure_response( $result );

[228] Fix | Delete

// Include a link to the export status endpoint.

[229] Fix | Delete

$response->add_links(

[230] Fix | Delete

array(

[231] Fix | Delete

'self' => array(

[232] Fix | Delete

'href' => rest_url( sprintf( '%s/reports/%s/export/%s/status', $this->namespace, $report_type, $export_id ) ),

[233] Fix | Delete

),

[234] Fix | Delete

)

[235] Fix | Delete

);

[236] Fix | Delete

[237] Fix | Delete

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

[238] Fix | Delete

[239] Fix | Delete

return rest_ensure_response( $data );

[240] Fix | Delete

}

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete