<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Builder;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Helpers\CacheBase;

[4] Fix | Delete

use WPForms\Tasks\Actions\AsyncRequestTask;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Single template cache handler.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.6.8

[10] Fix | Delete

*/

[11] Fix | Delete

class TemplateSingleCache extends CacheBase {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Template Id (hash).

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.6.8

[17] Fix | Delete

*

[18] Fix | Delete

* @var string

[19] Fix | Delete

*/

[20] Fix | Delete

private $id;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* License data (`key` and `type`).

[24] Fix | Delete

*

[25] Fix | Delete

* @since 1.6.8

[26] Fix | Delete

*

[27] Fix | Delete

* @var array

[28] Fix | Delete

*/

[29] Fix | Delete

private $license;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Determine if the class is allowed to load.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.6.8

[35] Fix | Delete

*

[36] Fix | Delete

* @return bool

[37] Fix | Delete

*/

[38] Fix | Delete

protected function allow_load() {

[39] Fix | Delete

[40] Fix | Delete

$has_permissions = wpforms_current_user_can( [ 'create_forms', 'edit_forms' ] );

[41] Fix | Delete

$allowed_requests = wpforms_is_admin_ajax() || wpforms_is_admin_page( 'builder' ) || wpforms_is_admin_page( 'templates' );

[42] Fix | Delete

$allow = wp_doing_cron() || wpforms_doing_wp_cli() || ( $has_permissions && $allowed_requests );

[43] Fix | Delete

[44] Fix | Delete

// phpcs:disable WPForms.PHP.ValidateHooks.InvalidHookName

[45] Fix | Delete

/**

[46] Fix | Delete

* Whether to allow to load this class.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.7.2

[49] Fix | Delete

*

[50] Fix | Delete

* @param bool $allow True or false.

[51] Fix | Delete

*/

[52] Fix | Delete

return (bool) apply_filters( 'wpforms_admin_builder_templatesinglecache_allow_load', $allow );

[53] Fix | Delete

// phpcs:enable WPForms.PHP.ValidateHooks.InvalidHookName

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Re-initialize object with the particular template.

[58] Fix | Delete

*

[59] Fix | Delete

* @since 1.6.8

[60] Fix | Delete

*

[61] Fix | Delete

* @param string $template_id Template ID (hash).

[62] Fix | Delete

* @param array $license License data.

[63] Fix | Delete

*

[64] Fix | Delete

* @return TemplateSingleCache

[65] Fix | Delete

*/

[66] Fix | Delete

public function instance( $template_id, $license ) {

[67] Fix | Delete

[68] Fix | Delete

$this->id = $template_id;

[69] Fix | Delete

$this->license = $license;

[70] Fix | Delete

[71] Fix | Delete

$this->init();

[72] Fix | Delete

[73] Fix | Delete

return $this;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Provide settings.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 1.6.8

[80] Fix | Delete

*

[81] Fix | Delete

* @return array Settings array.

[82] Fix | Delete

*/

[83] Fix | Delete

protected function setup() {

[84] Fix | Delete

[85] Fix | Delete

return [

[86] Fix | Delete

[87] Fix | Delete

// Remote source URL.

[88] Fix | Delete

'remote_source' => $this->remote_source(),

[89] Fix | Delete

[90] Fix | Delete

// Cache file.

[91] Fix | Delete

'cache_file' => $this->get_cache_file_name(),

[92] Fix | Delete

[93] Fix | Delete

// This filter is documented in wpforms/src/Admin/Builder/TemplatesCache.php.

[94] Fix | Delete

// phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName, WPForms.Comments.PHPDocHooks.RequiredHookDocumentation

[95] Fix | Delete

'cache_ttl' => (int) apply_filters( 'wpforms_admin_builder_templates_cache_ttl', WEEK_IN_SECONDS ),

[96] Fix | Delete

];

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Generate single template remote URL.

[101] Fix | Delete

*

[102] Fix | Delete

* @since 1.6.8

[103] Fix | Delete

*

[104] Fix | Delete

* @param bool $cache True if the cache arg should be appended to the URL.

[105] Fix | Delete

*

[106] Fix | Delete

* @return string

[107] Fix | Delete

*/

[108] Fix | Delete

private function remote_source( $cache = false ) {

[109] Fix | Delete

[110] Fix | Delete

if ( ! isset( $this->license['key'] ) ) {

[111] Fix | Delete

return '';

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

$args = [

[115] Fix | Delete

'license' => $this->license['key'],

[116] Fix | Delete

'site' => site_url(),

[117] Fix | Delete

];

[118] Fix | Delete

[119] Fix | Delete

if ( $cache ) {

[120] Fix | Delete

$args['cache'] = 1;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

return add_query_arg(

[124] Fix | Delete

$args,

[125] Fix | Delete

'https://wpforms.com/templates/api/get/' . $this->id

[126] Fix | Delete

);

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Get cached data.

[131] Fix | Delete

*

[132] Fix | Delete

* @since 1.8.2

[133] Fix | Delete

*

[134] Fix | Delete

* @return array Cached data.

[135] Fix | Delete

*/

[136] Fix | Delete

public function get() {

[137] Fix | Delete

[138] Fix | Delete

$data = parent::get();

[139] Fix | Delete

[140] Fix | Delete

if ( ! $this->updated ) {

[141] Fix | Delete

$this->update_usage_tracking();

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

return $data;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Sends a request to update the form template usage tracking database.

[149] Fix | Delete

*

[150] Fix | Delete

* @since 1.7.5

[151] Fix | Delete

*/

[152] Fix | Delete

private function update_usage_tracking() {

[153] Fix | Delete

[154] Fix | Delete

$tasks = wpforms()->obj( 'tasks' );

[155] Fix | Delete

[156] Fix | Delete

if ( ! $tasks ) {

[157] Fix | Delete

return;

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

$url = $this->remote_source( true );

[161] Fix | Delete

$args = [ 'blocking' => false ];

[162] Fix | Delete

[163] Fix | Delete

$tasks->create( AsyncRequestTask::ACTION )->async()->params( $url, $args )->register();

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Get cache directory path.

[168] Fix | Delete

*

[169] Fix | Delete

* @since 1.6.8

[170] Fix | Delete

*/

[171] Fix | Delete

protected function get_cache_dir() {

[172] Fix | Delete

[173] Fix | Delete

return parent::get_cache_dir() . 'templates/';

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Generate single template cache file name.

[178] Fix | Delete

*

[179] Fix | Delete

* @since 1.6.8

[180] Fix | Delete

*

[181] Fix | Delete

* @return string.

[182] Fix | Delete

*/

[183] Fix | Delete

private function get_cache_file_name() {

[184] Fix | Delete

[185] Fix | Delete

return sanitize_key( $this->id ) . '.json';

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Prepare data to store in a local cache.

[190] Fix | Delete

*

[191] Fix | Delete

* @since 1.6.8

[192] Fix | Delete

*

[193] Fix | Delete

* @param array $data Raw data received by the remote request.

[194] Fix | Delete

*

[195] Fix | Delete

* @return array Prepared data for caching.

[196] Fix | Delete

*/

[197] Fix | Delete

protected function prepare_cache_data( $data ): array {

[198] Fix | Delete

[199] Fix | Delete

if (

[200] Fix | Delete

empty( $data ) ||

[201] Fix | Delete

! is_array( $data ) ||

[202] Fix | Delete

empty( $data['status'] ) ||

[203] Fix | Delete

$data['status'] !== 'success' ||

[204] Fix | Delete

empty( $data['data'] )

[205] Fix | Delete

) {

[206] Fix | Delete

return [];

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

$cache_data = $data['data'];

[210] Fix | Delete

$cache_data['data'] = empty( $cache_data['data'] ) ? [] : $cache_data['data'];

[211] Fix | Delete

$cache_data['data']['settings'] = empty( $cache_data['data']['settings'] ) ? [] : $cache_data['data']['settings'];

[212] Fix | Delete

$cache_data['data']['settings']['ajax_submit'] = '1';

[213] Fix | Delete

[214] Fix | Delete

// Strip the word "Template" from the end of the template name and form title setting.

[215] Fix | Delete

$cache_data['name'] = preg_replace( '/\sTemplate$/', '', $cache_data['name'] );

[216] Fix | Delete

$cache_data['data']['settings']['form_title'] = $cache_data['name'];

[217] Fix | Delete

[218] Fix | Delete

// Unset `From Name` field of the notification settings.

[219] Fix | Delete

// By default, the builder will use the `blogname` option value.

[220] Fix | Delete

unset( $cache_data['data']['settings']['notifications'][1]['sender_name'] );

[221] Fix | Delete

[222] Fix | Delete

return $cache_data;

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Wipe cache of an empty templates.

[227] Fix | Delete

*

[228] Fix | Delete

* @since 1.7.5

[229] Fix | Delete

*/

[230] Fix | Delete

public function wipe_empty_templates_cache() {

[231] Fix | Delete

[232] Fix | Delete

$cache_dir = $this->get_cache_dir();

[233] Fix | Delete

$files = glob( $cache_dir . '*.json' );

[234] Fix | Delete

[235] Fix | Delete

foreach ( $files as $filename ) {

[236] Fix | Delete

// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents

[237] Fix | Delete

$content = file_get_contents( $filename );

[238] Fix | Delete

[239] Fix | Delete

if ( empty( $content ) || trim( $content ) === '[]' ) {

[240] Fix | Delete

// phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink

[241] Fix | Delete

unlink( $filename );

[242] Fix | Delete

}

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete