<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Elementor\Modules\Variables\Classes;

[2] Fix | Delete

[3] Fix | Delete

use Elementor\Modules\Variables\Storage\Exceptions\DuplicatedLabel;

[4] Fix | Delete

use Exception;

[5] Fix | Delete

use WP_Error;

[6] Fix | Delete

use WP_REST_Response;

[7] Fix | Delete

use WP_REST_Request;

[8] Fix | Delete

use WP_REST_Server;

[9] Fix | Delete

[10] Fix | Delete

use Elementor\Plugin;

[11] Fix | Delete

use Elementor\Modules\Variables\PropTypes\Color_Variable_Prop_Type;

[12] Fix | Delete

use Elementor\Modules\Variables\PropTypes\Font_Variable_Prop_Type;

[13] Fix | Delete

use Elementor\Modules\Variables\Storage\Repository as Variables_Repository;

[14] Fix | Delete

use Elementor\Modules\Variables\Storage\Exceptions\VariablesLimitReached;

[15] Fix | Delete

use Elementor\Modules\Variables\Storage\Exceptions\RecordNotFound;

[16] Fix | Delete

[17] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[18] Fix | Delete

exit; // Exit if accessed directly.

[19] Fix | Delete

}

[20] Fix | Delete

[21] Fix | Delete

class Rest_Api {

[22] Fix | Delete

const API_NAMESPACE = 'elementor/v1';

[23] Fix | Delete

const API_BASE = 'variables';

[24] Fix | Delete

[25] Fix | Delete

const HTTP_OK = 200;

[26] Fix | Delete

const HTTP_CREATED = 201;

[27] Fix | Delete

const HTTP_BAD_REQUEST = 400;

[28] Fix | Delete

const HTTP_NOT_FOUND = 404;

[29] Fix | Delete

const HTTP_SERVER_ERROR = 500;

[30] Fix | Delete

[31] Fix | Delete

const MAX_ID_LENGTH = 64;

[32] Fix | Delete

const MAX_LABEL_LENGTH = 50;

[33] Fix | Delete

const MAX_VALUE_LENGTH = 512;

[34] Fix | Delete

[35] Fix | Delete

private Variables_Repository $variables_repository;

[36] Fix | Delete

[37] Fix | Delete

public function __construct( Variables_Repository $variables_repository ) {

[38] Fix | Delete

$this->variables_repository = $variables_repository;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

public function enough_permissions_to_perform_ro_action() {

[42] Fix | Delete

return current_user_can( 'edit_posts' );

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

public function enough_permissions_to_perform_rw_action() {

[46] Fix | Delete

return current_user_can( 'manage_options' );

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

public function register_routes() {

[50] Fix | Delete

register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/list', [

[51] Fix | Delete

'methods' => WP_REST_Server::READABLE,

[52] Fix | Delete

'callback' => [ $this, 'get_variables' ],

[53] Fix | Delete

'permission_callback' => [ $this, 'enough_permissions_to_perform_ro_action' ],

[54] Fix | Delete

] );

[55] Fix | Delete

[56] Fix | Delete

register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/create', [

[57] Fix | Delete

'methods' => WP_REST_Server::CREATABLE,

[58] Fix | Delete

'callback' => [ $this, 'create_variable' ],

[59] Fix | Delete

'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],

[60] Fix | Delete

'args' => [

[61] Fix | Delete

'type' => [

[62] Fix | Delete

'required' => true,

[63] Fix | Delete

'type' => 'string',

[64] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_type' ],

[65] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[66] Fix | Delete

],

[67] Fix | Delete

'label' => [

[68] Fix | Delete

'required' => true,

[69] Fix | Delete

'type' => 'string',

[70] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_label' ],

[71] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[72] Fix | Delete

],

[73] Fix | Delete

'value' => [

[74] Fix | Delete

'required' => true,

[75] Fix | Delete

'type' => 'string',

[76] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_value' ],

[77] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[78] Fix | Delete

],

[79] Fix | Delete

],

[80] Fix | Delete

] );

[81] Fix | Delete

[82] Fix | Delete

register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/update', [

[83] Fix | Delete

'methods' => WP_REST_Server::EDITABLE,

[84] Fix | Delete

'callback' => [ $this, 'update_variable' ],

[85] Fix | Delete

'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],

[86] Fix | Delete

'args' => [

[87] Fix | Delete

'id' => [

[88] Fix | Delete

'required' => true,

[89] Fix | Delete

'type' => 'string',

[90] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_id' ],

[91] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[92] Fix | Delete

],

[93] Fix | Delete

'label' => [

[94] Fix | Delete

'required' => true,

[95] Fix | Delete

'type' => 'string',

[96] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_label' ],

[97] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[98] Fix | Delete

],

[99] Fix | Delete

'value' => [

[100] Fix | Delete

'required' => true,

[101] Fix | Delete

'type' => 'string',

[102] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_value' ],

[103] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[104] Fix | Delete

],

[105] Fix | Delete

],

[106] Fix | Delete

] );

[107] Fix | Delete

[108] Fix | Delete

register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/delete', [

[109] Fix | Delete

'methods' => WP_REST_Server::EDITABLE,

[110] Fix | Delete

'callback' => [ $this, 'delete_variable' ],

[111] Fix | Delete

'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],

[112] Fix | Delete

'args' => [

[113] Fix | Delete

'id' => [

[114] Fix | Delete

'required' => true,

[115] Fix | Delete

'type' => 'string',

[116] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_id' ],

[117] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[118] Fix | Delete

],

[119] Fix | Delete

],

[120] Fix | Delete

] );

[121] Fix | Delete

[122] Fix | Delete

register_rest_route( self::API_NAMESPACE, '/' . self::API_BASE . '/restore', [

[123] Fix | Delete

'methods' => WP_REST_Server::EDITABLE,

[124] Fix | Delete

'callback' => [ $this, 'restore_variable' ],

[125] Fix | Delete

'permission_callback' => [ $this, 'enough_permissions_to_perform_rw_action' ],

[126] Fix | Delete

'args' => [

[127] Fix | Delete

'id' => [

[128] Fix | Delete

'required' => true,

[129] Fix | Delete

'type' => 'string',

[130] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_id' ],

[131] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[132] Fix | Delete

],

[133] Fix | Delete

'label' => [

[134] Fix | Delete

'required' => false,

[135] Fix | Delete

'type' => 'string',

[136] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_label' ],

[137] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[138] Fix | Delete

],

[139] Fix | Delete

'value' => [

[140] Fix | Delete

'required' => false,

[141] Fix | Delete

'type' => 'string',

[142] Fix | Delete

'validate_callback' => [ $this, 'is_valid_variable_value' ],

[143] Fix | Delete

'sanitize_callback' => [ $this, 'trim_and_sanitize_text_field' ],

[144] Fix | Delete

],

[145] Fix | Delete

],

[146] Fix | Delete

] );

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

public function trim_and_sanitize_text_field( $value ) {

[150] Fix | Delete

return trim( sanitize_text_field( $value ) );

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

public function is_valid_variable_id( $id ) {

[154] Fix | Delete

$id = trim( $id );

[155] Fix | Delete

[156] Fix | Delete

if ( empty( $id ) ) {

[157] Fix | Delete

return new WP_Error(

[158] Fix | Delete

'invalid_variable_id_empty',

[159] Fix | Delete

__( 'ID cannot be empty', 'elementor' )

[160] Fix | Delete

);

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

if ( self::MAX_ID_LENGTH < strlen( $id ) ) {

[164] Fix | Delete

return new WP_Error( 'invalid_variable_id_length', sprintf(

[165] Fix | Delete

__( 'ID cannot exceed %d characters', 'elementor' ),

[166] Fix | Delete

self::MAX_ID_LENGTH

[167] Fix | Delete

) );

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return true;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

public function is_valid_variable_type( $type ) {

[174] Fix | Delete

return in_array( $type, [

[175] Fix | Delete

Color_Variable_Prop_Type::get_key(),

[176] Fix | Delete

Font_Variable_Prop_Type::get_key(),

[177] Fix | Delete

], true );

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

public function is_valid_variable_label( $label ) {

[181] Fix | Delete

$label = trim( $label );

[182] Fix | Delete

[183] Fix | Delete

if ( empty( $label ) ) {

[184] Fix | Delete

return new WP_Error(

[185] Fix | Delete

'invalid_variable_label_empty',

[186] Fix | Delete

__( 'Label cannot be empty', 'elementor' )

[187] Fix | Delete

);

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

if ( self::MAX_LABEL_LENGTH < strlen( $label ) ) {

[191] Fix | Delete

return new WP_Error( 'invalid_variable_label_length', sprintf(

[192] Fix | Delete

__( 'Label cannot exceed %d characters', 'elementor' ),

[193] Fix | Delete

self::MAX_LABEL_LENGTH

[194] Fix | Delete

) );

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

return true;

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

public function is_valid_variable_value( $value ) {

[201] Fix | Delete

$value = trim( $value );

[202] Fix | Delete

[203] Fix | Delete

if ( empty( $value ) ) {

[204] Fix | Delete

return new WP_Error(

[205] Fix | Delete

'invalid_variable_value_empty',

[206] Fix | Delete

__( 'Value cannot be empty', 'elementor' )

[207] Fix | Delete

);

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

if ( self::MAX_VALUE_LENGTH < strlen( $value ) ) {

[211] Fix | Delete

return new WP_Error( 'invalid_variable_value_length', sprintf(

[212] Fix | Delete

__( 'Value cannot exceed %d characters', 'elementor' ),

[213] Fix | Delete

self::MAX_VALUE_LENGTH

[214] Fix | Delete

) );

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

return true;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

public function create_variable( WP_REST_Request $request ) {

[221] Fix | Delete

try {

[222] Fix | Delete

return $this->create_new_variable( $request );

[223] Fix | Delete

} catch ( Exception $e ) {

[224] Fix | Delete

return $this->error_response( $e );

[225] Fix | Delete

}

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

protected function clear_cache() {

[229] Fix | Delete

Plugin::$instance->files_manager->clear_cache();

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

private function create_new_variable( WP_REST_Request $request ) {

[233] Fix | Delete

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

[234] Fix | Delete

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

[235] Fix | Delete

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

[236] Fix | Delete

[237] Fix | Delete

$result = $this->variables_repository->create( [

[238] Fix | Delete

'type' => $type,

[239] Fix | Delete

'label' => $label,

[240] Fix | Delete

'value' => $value,

[241] Fix | Delete

] );

[242] Fix | Delete

[243] Fix | Delete

$this->clear_cache();

[244] Fix | Delete

[245] Fix | Delete

return $this->success_response( [

[246] Fix | Delete

'variable' => $result['variable'],

[247] Fix | Delete

'watermark' => $result['watermark'],

[248] Fix | Delete

], self::HTTP_CREATED );

[249] Fix | Delete

}

[250] Fix | Delete

[251] Fix | Delete

public function update_variable( WP_REST_Request $request ) {

[252] Fix | Delete

try {

[253] Fix | Delete

return $this->update_existing_variable( $request );

[254] Fix | Delete

} catch ( Exception $e ) {

[255] Fix | Delete

return $this->error_response( $e );

[256] Fix | Delete

}

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

private function update_existing_variable( WP_REST_Request $request ) {

[260] Fix | Delete

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

[261] Fix | Delete

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

[262] Fix | Delete

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

[263] Fix | Delete

[264] Fix | Delete

$result = $this->variables_repository->update( $id, [

[265] Fix | Delete

'label' => $label,

[266] Fix | Delete

'value' => $value,

[267] Fix | Delete

] );

[268] Fix | Delete

[269] Fix | Delete

$this->clear_cache();

[270] Fix | Delete

[271] Fix | Delete

return $this->success_response( [

[272] Fix | Delete

'variable' => $result['variable'],

[273] Fix | Delete

'watermark' => $result['watermark'],

[274] Fix | Delete

] );

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

public function delete_variable( WP_REST_Request $request ) {

[278] Fix | Delete

try {

[279] Fix | Delete

return $this->delete_existing_variable( $request );

[280] Fix | Delete

} catch ( Exception $e ) {

[281] Fix | Delete

return $this->error_response( $e );

[282] Fix | Delete

}

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

private function delete_existing_variable( WP_REST_Request $request ) {

[286] Fix | Delete

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

[287] Fix | Delete

[288] Fix | Delete

$result = $this->variables_repository->delete( $id );

[289] Fix | Delete

[290] Fix | Delete

$this->clear_cache();

[291] Fix | Delete

[292] Fix | Delete

return $this->success_response( [

[293] Fix | Delete

'variable' => $result['variable'],

[294] Fix | Delete

'watermark' => $result['watermark'],

[295] Fix | Delete

] );

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

public function restore_variable( WP_REST_Request $request ) {

[299] Fix | Delete

try {

[300] Fix | Delete

return $this->restore_existing_variable( $request );

[301] Fix | Delete

} catch ( Exception $e ) {

[302] Fix | Delete

return $this->error_response( $e );

[303] Fix | Delete

}

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

private function restore_existing_variable( WP_REST_Request $request ) {

[307] Fix | Delete

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

[308] Fix | Delete

[309] Fix | Delete

$overrides = [];

[310] Fix | Delete

[311] Fix | Delete

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

[312] Fix | Delete

if ( $label ) {

[313] Fix | Delete

$overrides['label'] = $label;

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

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

[317] Fix | Delete

if ( $value ) {

[318] Fix | Delete

$overrides['value'] = $value;

[319] Fix | Delete

}

[320] Fix | Delete

[321] Fix | Delete

$result = $this->variables_repository->restore( $id, $overrides );

[322] Fix | Delete

[323] Fix | Delete

$this->clear_cache();

[324] Fix | Delete

[325] Fix | Delete

return $this->success_response( [

[326] Fix | Delete

'variable' => $result['variable'],

[327] Fix | Delete

'watermark' => $result['watermark'],

[328] Fix | Delete

] );

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

public function get_variables() {

[332] Fix | Delete

try {

[333] Fix | Delete

return $this->list_of_variables();

[334] Fix | Delete

} catch ( Exception $e ) {

[335] Fix | Delete

return $this->error_response( $e );

[336] Fix | Delete

}

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete

private function list_of_variables() {

[340] Fix | Delete

$db_record = $this->variables_repository->load();

[341] Fix | Delete

[342] Fix | Delete

return $this->success_response( [

[343] Fix | Delete

'variables' => $db_record['data'],

[344] Fix | Delete

'total' => count( $db_record['data'] ),

[345] Fix | Delete

'watermark' => $db_record['watermark'],

[346] Fix | Delete

] );

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

private function success_response( $payload, $status_code = null ) {

[350] Fix | Delete

return new WP_REST_Response( [

[351] Fix | Delete

'success' => true,

[352] Fix | Delete

'data' => $payload,

[353] Fix | Delete

], $status_code ?? self::HTTP_OK );

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

private function error_response( Exception $e ) {

[357] Fix | Delete

if ( $e instanceof VariablesLimitReached ) {

[358] Fix | Delete

return $this->prepare_error_response(

[359] Fix | Delete

self::HTTP_BAD_REQUEST,

[360] Fix | Delete

'invalid_variable_limit_reached',

[361] Fix | Delete

__( 'Reached the maximum number of variables', 'elementor' )

[362] Fix | Delete

);

[363] Fix | Delete

}

[364] Fix | Delete

[365] Fix | Delete

if ( $e instanceof DuplicatedLabel ) {

[366] Fix | Delete

return $this->prepare_error_response(

[367] Fix | Delete

self::HTTP_BAD_REQUEST,

[368] Fix | Delete

'duplicated_label',

[369] Fix | Delete

__( 'Variable label already exists', 'elementor' )

[370] Fix | Delete

);

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

if ( $e instanceof RecordNotFound ) {

[374] Fix | Delete

return $this->prepare_error_response(

[375] Fix | Delete

self::HTTP_NOT_FOUND,

[376] Fix | Delete

'variable_not_found',

[377] Fix | Delete

__( 'Variable not found', 'elementor' )

[378] Fix | Delete

);

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

return $this->prepare_error_response(

[382] Fix | Delete

self::HTTP_SERVER_ERROR,

[383] Fix | Delete

'unexpected_server_error',

[384] Fix | Delete

__( 'Unexpected server error', 'elementor' )

[385] Fix | Delete

);

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

private function prepare_error_response( $status_code, $error, $message ) {

[389] Fix | Delete

return new WP_REST_Response( [

[390] Fix | Delete

'code' => $error,

[391] Fix | Delete

'message' => $message,

[392] Fix | Delete

'data' => [

[393] Fix | Delete

'status' => $status_code,

[394] Fix | Delete

],

[395] Fix | Delete

], $status_code );

[396] Fix | Delete

}

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete