<?php

[0] Fix | Delete

declare( strict_types=1 );

[1] Fix | Delete

[2] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin\Emails;

[3] Fix | Delete

[4] Fix | Delete

use Automattic\WooCommerce\Internal\RestApiControllerBase;

[5] Fix | Delete

use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCTransactionalEmails;

[6] Fix | Delete

use Automattic\WooCommerce\Internal\EmailEditor\WCTransactionalEmails\WCTransactionalEmailPostsGenerator;

[7] Fix | Delete

use WP_Error;

[8] Fix | Delete

use WP_REST_Request;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Controller for the REST endpoint for the new email listing page.

[12] Fix | Delete

*/

[13] Fix | Delete

class EmailListingRestController extends RestApiControllerBase {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Email listing nonce.

[17] Fix | Delete

*

[18] Fix | Delete

* @var string

[19] Fix | Delete

*/

[20] Fix | Delete

const NONCE_KEY = 'email-listing-nonce';

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* The root namespace for the JSON REST API endpoints.

[24] Fix | Delete

*

[25] Fix | Delete

* @var string

[26] Fix | Delete

*/

[27] Fix | Delete

protected string $route_namespace = 'wc-admin-email';

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Route base.

[31] Fix | Delete

*

[32] Fix | Delete

* @var string

[33] Fix | Delete

*/

[34] Fix | Delete

protected string $rest_base = 'settings/email/listing';

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Email template generator instance.

[38] Fix | Delete

*

[39] Fix | Delete

* @var WCTransactionalEmailPostsGenerator

[40] Fix | Delete

*/

[41] Fix | Delete

private $email_template_generator;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Get the WooCommerce REST API namespace for the class.

[45] Fix | Delete

*

[46] Fix | Delete

* @return string

[47] Fix | Delete

*/

[48] Fix | Delete

protected function get_rest_api_namespace(): string {

[49] Fix | Delete

return 'wc-admin-email-listing';

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* The constructor.

[54] Fix | Delete

*/

[55] Fix | Delete

public function __construct() {

[56] Fix | Delete

$this->email_template_generator = new WCTransactionalEmailPostsGenerator();

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Perform the initialization.

[61] Fix | Delete

*/

[62] Fix | Delete

public function initialize_template_generator() {

[63] Fix | Delete

$this->email_template_generator->init_default_transactional_emails();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Register the REST API endpoints handled by this controller.

[68] Fix | Delete

*/

[69] Fix | Delete

public function register_routes() {

[70] Fix | Delete

$this->initialize_template_generator();

[71] Fix | Delete

[72] Fix | Delete

register_rest_route(

[73] Fix | Delete

$this->route_namespace,

[74] Fix | Delete

'/' . $this->rest_base . '/recreate-email-post',

[75] Fix | Delete

array(

[76] Fix | Delete

array(

[77] Fix | Delete

'methods' => \WP_REST_Server::CREATABLE,

[78] Fix | Delete

'callback' => fn( $request ) => $this->recreate_email_post( $request ),

[79] Fix | Delete

'permission_callback' => fn( $request ) => $this->check_permissions( $request ),

[80] Fix | Delete

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

[81] Fix | Delete

'schema' => $this->get_schema_with_message(),

[82] Fix | Delete

),

[83] Fix | Delete

)

[84] Fix | Delete

);

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Get the accepted arguments for the POST recreate-email-post request.

[89] Fix | Delete

*

[90] Fix | Delete

* @return array[]

[91] Fix | Delete

*/

[92] Fix | Delete

private function get_args_for_recreate_email_post() {

[93] Fix | Delete

return array(

[94] Fix | Delete

'email_id' => array(

[95] Fix | Delete

'description' => __( 'The email ID to recreate the post for.', 'woocommerce' ),

[96] Fix | Delete

'type' => 'string',

[97] Fix | Delete

'required' => true,

[98] Fix | Delete

'validate_callback' => fn( $email_id ) => $this->validate_email_id( $email_id ),

[99] Fix | Delete

'sanitize_callback' => 'sanitize_text_field',

[100] Fix | Delete

),

[101] Fix | Delete

);

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Get the schema for the POST recreate-email-post and save-transient requests.

[106] Fix | Delete

*

[107] Fix | Delete

* @return array[]

[108] Fix | Delete

*/

[109] Fix | Delete

private function get_schema_with_message() {

[110] Fix | Delete

return array(

[111] Fix | Delete

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

[112] Fix | Delete

'title' => 'email-listing-with-message',

[113] Fix | Delete

'type' => 'object',

[114] Fix | Delete

'properties' => array(

[115] Fix | Delete

'message' => array(

[116] Fix | Delete

'description' => __( 'A message indicating that the action completed successfully.', 'woocommerce' ),

[117] Fix | Delete

'type' => 'string',

[118] Fix | Delete

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

[119] Fix | Delete

'readonly' => true,

[120] Fix | Delete

),

[121] Fix | Delete

'post_id' => array(

[122] Fix | Delete

'description' => __( 'The post ID of the generated email post.', 'woocommerce' ),

[123] Fix | Delete

'type' => 'string',

[124] Fix | Delete

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

[125] Fix | Delete

'readonly' => true,

[126] Fix | Delete

),

[127] Fix | Delete

),

[128] Fix | Delete

);

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Validate the email ID.

[133] Fix | Delete

*

[134] Fix | Delete

* @param string $email_id The email ID to validate.

[135] Fix | Delete

* @return bool|WP_Error True if the email ID is valid, otherwise a WP_Error object.

[136] Fix | Delete

*/

[137] Fix | Delete

private function validate_email_id( string $email_id ) {

[138] Fix | Delete

if ( ! in_array( $email_id, WCTransactionalEmails::get_transactional_emails(), true ) ) {

[139] Fix | Delete

return new \WP_Error(

[140] Fix | Delete

'woocommerce_rest_not_allowed_email_id',

[141] Fix | Delete

sprintf( 'The provided email ID "%s" is not allowed.', $email_id ),

[142] Fix | Delete

array( 'status' => 400 ),

[143] Fix | Delete

);

[144] Fix | Delete

}

[145] Fix | Delete

return true;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Permission check for REST API endpoint.

[150] Fix | Delete

*

[151] Fix | Delete

* @param WP_REST_Request $request The request for which the permission is checked.

[152] Fix | Delete

* @return bool|WP_Error True if the current user has the capability, otherwise a WP_Error object.

[153] Fix | Delete

*/

[154] Fix | Delete

private function check_permissions( WP_REST_Request $request ) {

[155] Fix | Delete

$nonce = $request->get_param( 'nonce' );

[156] Fix | Delete

if ( ! wp_verify_nonce( $nonce, self::NONCE_KEY ) ) {

[157] Fix | Delete

return new WP_Error(

[158] Fix | Delete

'invalid_nonce',

[159] Fix | Delete

__( 'Invalid nonce.', 'woocommerce' ),

[160] Fix | Delete

array( 'status' => 403 ),

[161] Fix | Delete

);

[162] Fix | Delete

}

[163] Fix | Delete

return $this->check_permission( $request, 'manage_woocommerce' );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Handle the POST /settings/email/listing/recreate-email-post.

[168] Fix | Delete

*

[169] Fix | Delete

* @param WP_REST_Request $request The received request.

[170] Fix | Delete

* @return array|WP_Error Request response or an error.

[171] Fix | Delete

*/

[172] Fix | Delete

public function recreate_email_post( WP_REST_Request $request ) {

[173] Fix | Delete

$email_id = $request->get_param( 'email_id' );

[174] Fix | Delete

[175] Fix | Delete

$generated_post_id = '';

[176] Fix | Delete

[177] Fix | Delete

try {

[178] Fix | Delete

$generated_post_id = $this->email_template_generator->generate_email_template_if_not_exists( $email_id );

[179] Fix | Delete

} catch ( \Exception $e ) {

[180] Fix | Delete

return new WP_Error(

[181] Fix | Delete

'woocommerce_rest_email_post_generation_failed',

[182] Fix | Delete

// translators: %s: Error message.

[183] Fix | Delete

sprintf( __( 'Error generating email post. Error: %s.', 'woocommerce' ), $e->getMessage() ),

[184] Fix | Delete

array( 'status' => 500 )

[185] Fix | Delete

);

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

if ( $generated_post_id ) {

[189] Fix | Delete

return array(

[190] Fix | Delete

// translators: %s: WooCommerce transactional email ID.

[191] Fix | Delete

'message' => sprintf( __( 'Email post generated for %s.', 'woocommerce' ), $email_id ),

[192] Fix | Delete

'post_id' => (string) $generated_post_id,

[193] Fix | Delete

);

[194] Fix | Delete

}

[195] Fix | Delete

return new WP_Error(

[196] Fix | Delete

'woocommerce_rest_email_post_generation_error',

[197] Fix | Delete

__( 'Error unable to generate email post.', 'woocommerce' ),

[198] Fix | Delete

array( 'status' => 500 )

[199] Fix | Delete

);

[200] Fix | Delete

}

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete