235 lines
6.5 KiB
PHP
235 lines
6.5 KiB
PHP
<?php
|
|
/**
|
|
* REST API Reports Export Controller
|
|
*
|
|
* Handles requests to:
|
|
* - /reports/[report]/export
|
|
* - /reports/[report]/export/[id]/status
|
|
*
|
|
* @package WooCommerce Admin/API
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* Reports Export controller.
|
|
*
|
|
* @package WooCommerce Admin/API
|
|
* @extends WC_REST_Data_Controller
|
|
*/
|
|
class WC_Admin_REST_Reports_Export_Controller extends WC_Admin_REST_Reports_Controller {
|
|
/**
|
|
* Endpoint namespace.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $namespace = 'wc/v4';
|
|
|
|
/**
|
|
* Route base.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $rest_base = 'reports/(?P<type>[a-z]+)/export';
|
|
|
|
/**
|
|
* Register routes.
|
|
*/
|
|
public function register_routes() {
|
|
register_rest_route(
|
|
$this->namespace,
|
|
'/' . $this->rest_base,
|
|
array(
|
|
array(
|
|
'methods' => WP_REST_Server::EDITABLE,
|
|
'callback' => array( $this, 'export_items' ),
|
|
'permission_callback' => array( $this, 'export_permissions_check' ),
|
|
'args' => $this->get_export_collection_params(),
|
|
),
|
|
'schema' => array( $this, 'get_export_public_schema' ),
|
|
)
|
|
);
|
|
|
|
register_rest_route(
|
|
$this->namespace,
|
|
'/' . $this->rest_base . '/(?P<export_id>[a-z0-9]+)/status',
|
|
array(
|
|
array(
|
|
'methods' => WP_REST_Server::READABLE,
|
|
'callback' => array( $this, 'export_status' ),
|
|
'permission_callback' => array( $this, 'export_permissions_check' ),
|
|
),
|
|
'schema' => array( $this, 'get_export_status_public_schema' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Makes sure the current user has access to WRITE the settings APIs.
|
|
*
|
|
* @param WP_REST_Request $request Full data about the request.
|
|
* @return WP_Error|bool
|
|
*/
|
|
public function export_permissions_check( $request ) {
|
|
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
|
|
// @todo: better message?
|
|
return new WP_Error( 'woocommerce_rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'woocommerce-admin' ), array( 'status' => rest_authorization_required_code() ) );
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get the query params for collections.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_export_collection_params() {
|
|
$params = array();
|
|
$params['report_args'] = array(
|
|
'description' => __( 'Parameters to pass on to the exported report.', 'woocommerce-admin' ),
|
|
'type' => 'object',
|
|
'validate_callback' => 'rest_validate_request_arg', // @todo: use each controller's schema?
|
|
);
|
|
return $params;
|
|
}
|
|
|
|
/**
|
|
* Get the Report Export's schema, conforming to JSON Schema.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_export_public_schema() {
|
|
$schema = array(
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
|
'title' => 'report_export',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'status' => array(
|
|
'description' => __( 'Regeneration status.', 'woocommerce-admin' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'message' => array(
|
|
'description' => __( 'Regenerate data message.', 'woocommerce-admin' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
),
|
|
);
|
|
|
|
return $this->add_additional_fields_schema( $schema );
|
|
}
|
|
|
|
/**
|
|
* Get the Export status schema, conforming to JSON Schema.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_export_status_public_schema() {
|
|
$schema = array(
|
|
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
|
'title' => 'report_export_status',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'percent_complete' => array(
|
|
'description' => __( 'Percentage complete.', 'woocommerce-admin' ),
|
|
'type' => 'int',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
'download_url' => array(
|
|
'description' => __( 'Export download URL.', 'woocommerce-admin' ),
|
|
'type' => 'string',
|
|
'context' => array( 'view', 'edit' ),
|
|
'readonly' => true,
|
|
),
|
|
),
|
|
);
|
|
|
|
return $this->add_additional_fields_schema( $schema );
|
|
}
|
|
|
|
/**
|
|
* Export data based on user request params.
|
|
*
|
|
* @param WP_REST_Request $request Request data.
|
|
* @return WP_Error|WP_REST_Response
|
|
*/
|
|
public function export_items( $request ) {
|
|
$report_type = $request['type'];
|
|
$report_args = empty( $request['report_args'] ) ? array() : $request['report_args'];
|
|
$user_id = get_current_user_id();
|
|
$export_id = str_replace( '.', '', microtime( true ) );
|
|
|
|
WC_Admin_Report_Exporter::queue_report_export( $user_id, $export_id, $report_type, $report_args );
|
|
WC_Admin_Report_Exporter::update_export_percentage_complete( $report_type, $export_id, 0 );
|
|
|
|
// @todo: handle error case?
|
|
$result = array(
|
|
'status' => 'success',
|
|
'message' => __( 'Your report file is being generated.', 'woocommerce-admin' ),
|
|
);
|
|
|
|
// Wrap the data in a response object.
|
|
$response = rest_ensure_response( $result );
|
|
// Include a link to the export status endpoint.
|
|
$response->add_links(
|
|
array(
|
|
'status' => array(
|
|
'href' => rest_url( sprintf( '%s/reports/%s/export/%s/status', $this->namespace, $report_type, $export_id ) ),
|
|
),
|
|
)
|
|
);
|
|
|
|
$data = $this->prepare_response_for_collection( $response );
|
|
|
|
return rest_ensure_response( $data );
|
|
}
|
|
|
|
/**
|
|
* Export status based on user request params.
|
|
*
|
|
* @param WP_REST_Request $request Request data.
|
|
* @return WP_Error|WP_REST_Response
|
|
*/
|
|
public function export_status( $request ) {
|
|
$report_type = $request['type'];
|
|
$export_id = $request['export_id'];
|
|
$percentage = WC_Admin_Report_Exporter::get_export_percentage_complete( $report_type, $export_id );
|
|
|
|
if ( false === $percentage ) {
|
|
return new WP_Error(
|
|
'woocommerce_admin_reports_export_invalid_id',
|
|
__( 'Sorry, there is no export with that ID.', 'woocommerce-admin' ),
|
|
array( 'status' => 404 )
|
|
);
|
|
}
|
|
|
|
$result = array(
|
|
'percent_complete' => $percentage,
|
|
);
|
|
|
|
// @todo - add thing in the links below instead?
|
|
if ( 100 === $percentage ) {
|
|
$result['download_url'] = rest_url( sprintf( '%s/reports/%s/export/%s/download', $this->namespace, $report_type, $export_id ) );
|
|
}
|
|
|
|
// Wrap the data in a response object.
|
|
$response = rest_ensure_response( $result );
|
|
// Include a link to the export status endpoint.
|
|
$response->add_links(
|
|
array(
|
|
'self' => array(
|
|
'href' => rest_url( sprintf( '%s/reports/%s/export/%s/status', $this->namespace, $report_type, $export_id ) ),
|
|
),
|
|
)
|
|
);
|
|
|
|
$data = $this->prepare_response_for_collection( $response );
|
|
|
|
return rest_ensure_response( $data );
|
|
}
|
|
}
|