<?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\Helpers\File;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Form templates cache handler.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.6.8

[10] Fix | Delete

*/

[11] Fix | Delete

class TemplatesCache extends CacheBase {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Templates list content cache files.

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.8.6

[17] Fix | Delete

*

[18] Fix | Delete

* @var array

[19] Fix | Delete

*/

[20] Fix | Delete

const CONTENT_CACHE_FILES = [

[21] Fix | Delete

'admin-page' => 'templates-admin-page.html',

[22] Fix | Delete

'builder' => 'templates-builder.html',

[23] Fix | Delete

];

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* List of plugins that can use the templates cache.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 1.8.7

[29] Fix | Delete

*

[30] Fix | Delete

* @var array

[31] Fix | Delete

*/

[32] Fix | Delete

const PLUGINS = [

[33] Fix | Delete

'wpforms',

[34] Fix | Delete

'wpforms-lite',

[35] Fix | Delete

];

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Determine if the class is allowed to load.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 1.6.8

[41] Fix | Delete

*

[42] Fix | Delete

* @return bool

[43] Fix | Delete

*/

[44] Fix | Delete

protected function allow_load(): bool {

[45] Fix | Delete

[46] Fix | Delete

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

[47] Fix | Delete

$allowed_requests = wpforms_is_admin_ajax() ||

[48] Fix | Delete

wpforms_is_admin_page( 'builder' ) ||

[49] Fix | Delete

wpforms_is_admin_page( 'templates' ) ||

[50] Fix | Delete

wpforms_is_admin_page( 'tools', 'action-scheduler' );

[51] Fix | Delete

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

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Whether to load this class.

[55] Fix | Delete

*

[56] Fix | Delete

* @since 1.7.2

[57] Fix | Delete

*

[58] Fix | Delete

* @param bool $allow True or false.

[59] Fix | Delete

*/

[60] Fix | Delete

return (bool) apply_filters( 'wpforms_admin_builder_templatescache_allow_load', $allow ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Initialize the class.

[65] Fix | Delete

*

[66] Fix | Delete

* @since 1.8.7

[67] Fix | Delete

*/

[68] Fix | Delete

public function init() { // phpcs:ignore WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks

[69] Fix | Delete

[70] Fix | Delete

parent::init();

[71] Fix | Delete

[72] Fix | Delete

// Upgrade cached templates data after the plugin update.

[73] Fix | Delete

add_action( 'upgrader_process_complete', [ $this, 'upgrade_templates' ] );

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Upgrade cached templates data after the plugin update.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 1.8.7

[80] Fix | Delete

*

[81] Fix | Delete

* @param object $upgrader WP_Upgrader instance.

[82] Fix | Delete

*/

[83] Fix | Delete

public function upgrade_templates( $upgrader ) {

[84] Fix | Delete

[85] Fix | Delete

if ( $this->allow_update_cache( $upgrader ) ) {

[86] Fix | Delete

$this->update( true );

[87] Fix | Delete

}

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Determine if allowed to update the cache.

[92] Fix | Delete

*

[93] Fix | Delete

* @since 1.8.7

[94] Fix | Delete

*

[95] Fix | Delete

* @param object $upgrader WP_Upgrader instance.

[96] Fix | Delete

*

[97] Fix | Delete

* @return bool

[98] Fix | Delete

*/

[99] Fix | Delete

private function allow_update_cache( $upgrader ): bool {

[100] Fix | Delete

[101] Fix | Delete

$result = $upgrader->result ?? null;

[102] Fix | Delete

[103] Fix | Delete

// Check if plugin was updated.

[104] Fix | Delete

if ( ! $result ) {

[105] Fix | Delete

return false;

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

// Check if updated plugin is WPForms.

[109] Fix | Delete

if ( ! in_array( $result['destination_name'], self::PLUGINS, true ) ) {

[110] Fix | Delete

return false;

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

return true;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Provide settings.

[118] Fix | Delete

*

[119] Fix | Delete

* @since 1.6.8

[120] Fix | Delete

*

[121] Fix | Delete

* @return array Settings array.

[122] Fix | Delete

*/

[123] Fix | Delete

protected function setup() {

[124] Fix | Delete

[125] Fix | Delete

return [

[126] Fix | Delete

[127] Fix | Delete

// Remote source URL.

[128] Fix | Delete

'remote_source' => 'https://wpforms.com/templates/api/get/',

[129] Fix | Delete

[130] Fix | Delete

// Cache file.

[131] Fix | Delete

'cache_file' => 'templates.json',

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* Time-to-live of the templates cache files in seconds.

[135] Fix | Delete

*

[136] Fix | Delete

* This applies to `uploads/wpforms/cache/templates.json`

[137] Fix | Delete

* and all *.json files in `uploads/wpforms/cache/templates/` directory.

[138] Fix | Delete

*

[139] Fix | Delete

* @since 1.6.8

[140] Fix | Delete

*

[141] Fix | Delete

* @param integer $cache_ttl Cache time-to-live, in seconds.

[142] Fix | Delete

* Default value: WEEK_IN_SECONDS.

[143] Fix | Delete

*/

[144] Fix | Delete

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

[145] Fix | Delete

[146] Fix | Delete

// Scheduled update action.

[147] Fix | Delete

'update_action' => 'wpforms_admin_builder_templates_cache_update',

[148] Fix | Delete

];

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Prepare data to store in a local cache.

[153] Fix | Delete

*

[154] Fix | Delete

* @since 1.6.8

[155] Fix | Delete

*

[156] Fix | Delete

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

[157] Fix | Delete

*

[158] Fix | Delete

* @return array Prepared data for caching.

[159] Fix | Delete

*/

[160] Fix | Delete

protected function prepare_cache_data( $data ): array {

[161] Fix | Delete

[162] Fix | Delete

if (

[163] Fix | Delete

empty( $data ) ||

[164] Fix | Delete

! is_array( $data ) ||

[165] Fix | Delete

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

[166] Fix | Delete

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

[167] Fix | Delete

empty( $data['data'] )

[168] Fix | Delete

) {

[169] Fix | Delete

return [];

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

$cache_data = $data['data'];

[173] Fix | Delete

[174] Fix | Delete

// Strip the word "Template" from the end of each template name.

[175] Fix | Delete

foreach ( $cache_data['templates'] as $slug => $template ) {

[176] Fix | Delete

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

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

return $cache_data;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Update the cache.

[184] Fix | Delete

*

[185] Fix | Delete

* @since 1.8.6

[186] Fix | Delete

*

[187] Fix | Delete

* @param bool $force Whether to force update the cache.

[188] Fix | Delete

*

[189] Fix | Delete

* @return bool

[190] Fix | Delete

*/

[191] Fix | Delete

public function update( bool $force = false ): bool {

[192] Fix | Delete

[193] Fix | Delete

$result = parent::update( $force );

[194] Fix | Delete

[195] Fix | Delete

if ( ! $result ) {

[196] Fix | Delete

return false;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

$this->wipe_content_cache();

[200] Fix | Delete

[201] Fix | Delete

return $result;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Get cached templates content.

[206] Fix | Delete

*

[207] Fix | Delete

* @since 1.8.6

[208] Fix | Delete

*

[209] Fix | Delete

* @return string

[210] Fix | Delete

*/

[211] Fix | Delete

public function get_content_cache(): string {

[212] Fix | Delete

[213] Fix | Delete

// phpcs:ignore Universal.Operators.DisallowShortTernary.Found

[214] Fix | Delete

return File::get_contents( $this->get_content_cache_file() ) ?: '';

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

/**

[218] Fix | Delete

* Save templates content cache.

[219] Fix | Delete

*

[220] Fix | Delete

* @since 1.8.6

[221] Fix | Delete

*

[222] Fix | Delete

* @param string|mixed $content Templates content.

[223] Fix | Delete

*

[224] Fix | Delete

* @return bool

[225] Fix | Delete

*/

[226] Fix | Delete

public function save_content_cache( $content ): bool {

[227] Fix | Delete

[228] Fix | Delete

return File::put_contents( $this->get_content_cache_file(), (string) $content );

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* Wipe cached templates content.

[233] Fix | Delete

*

[234] Fix | Delete

* @since 1.8.6

[235] Fix | Delete

*/

[236] Fix | Delete

public function wipe_content_cache() {

[237] Fix | Delete

[238] Fix | Delete

$cache_dir = $this->get_cache_dir();

[239] Fix | Delete

[240] Fix | Delete

// Delete the template content cache files. They will be regenerated on the first visit.

[241] Fix | Delete

foreach ( self::CONTENT_CACHE_FILES as $file ) {

[242] Fix | Delete

[243] Fix | Delete

$cache_file = $cache_dir . $file;

[244] Fix | Delete

[245] Fix | Delete

if ( is_file( $cache_file ) && is_readable( $cache_file ) ) {

[246] Fix | Delete

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

[247] Fix | Delete

unlink( $cache_file );

[248] Fix | Delete

}

[249] Fix | Delete

}

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Get templates content cache file path.

[254] Fix | Delete

*

[255] Fix | Delete

* @since 1.8.6

[256] Fix | Delete

*

[257] Fix | Delete

* @return string

[258] Fix | Delete

*/

[259] Fix | Delete

private function get_content_cache_file(): string {

[260] Fix | Delete

[261] Fix | Delete

$context = wpforms_is_admin_page( 'templates' ) ? 'admin-page' : 'builder';

[262] Fix | Delete

[263] Fix | Delete

return File::get_cache_dir() . self::CONTENT_CACHE_FILES[ $context ];

[264] Fix | Delete

}

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete