%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
namespace WPForms\Admin\Builder;
use WPForms\Helpers\CacheBase;
use WPForms\Helpers\File;
/**
* Form templates cache handler.
*
* @since 1.6.8
*/
class TemplatesCache extends CacheBase {
/**
* Templates list content cache files.
*
* @since 1.8.6
*
* @var array
*/
const CONTENT_CACHE_FILES = [
'admin-page' => 'templates-admin-page.html',
'builder' => 'templates-builder.html',
];
/**
* List of plugins that can use the templates cache.
*
* @since 1.8.7
*
* @var array
*/
const PLUGINS = [
'wpforms',
'wpforms-lite',
];
/**
* Determine if the class is allowed to load.
*
* @since 1.6.8
*
* @return bool
*/
protected function allow_load(): bool {
$has_permissions = wpforms_current_user_can( [ 'create_forms', 'edit_forms' ] );
$allowed_requests = wpforms_is_admin_ajax() ||
wpforms_is_admin_page( 'builder' ) ||
wpforms_is_admin_page( 'templates' ) ||
wpforms_is_admin_page( 'tools', 'action-scheduler' );
$allow = wp_doing_cron() || wpforms_doing_wp_cli() || ( $has_permissions && $allowed_requests );
/**
* Whether to load this class.
*
* @since 1.7.2
*
* @param bool $allow True or false.
*/
return (bool) apply_filters( 'wpforms_admin_builder_templatescache_allow_load', $allow ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Initialize the class.
*
* @since 1.8.7
*/
public function init() { // phpcs:ignore WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks
parent::init();
// Upgrade cached templates data after the plugin update.
add_action( 'upgrader_process_complete', [ $this, 'upgrade_templates' ] );
}
/**
* Upgrade cached templates data after the plugin update.
*
* @since 1.8.7
*
* @param object $upgrader WP_Upgrader instance.
*/
public function upgrade_templates( $upgrader ) {
if ( $this->allow_update_cache( $upgrader ) ) {
$this->update( true );
}
}
/**
* Determine if allowed to update the cache.
*
* @since 1.8.7
*
* @param object $upgrader WP_Upgrader instance.
*
* @return bool
*/
private function allow_update_cache( $upgrader ): bool {
$result = $upgrader->result ?? null;
// Check if plugin was updated.
if ( ! $result ) {
return false;
}
// Check if updated plugin is WPForms.
if ( ! in_array( $result['destination_name'], self::PLUGINS, true ) ) {
return false;
}
return true;
}
/**
* Provide settings.
*
* @since 1.6.8
*
* @return array Settings array.
*/
protected function setup() {
return [
// Remote source URL.
'remote_source' => 'https://wpforms.com/templates/api/get/',
// Cache file.
'cache_file' => 'templates.json',
/**
* Time-to-live of the templates cache files in seconds.
*
* This applies to `uploads/wpforms/cache/templates.json`
* and all *.json files in `uploads/wpforms/cache/templates/` directory.
*
* @since 1.6.8
*
* @param integer $cache_ttl Cache time-to-live, in seconds.
* Default value: WEEK_IN_SECONDS.
*/
'cache_ttl' => (int) apply_filters( 'wpforms_admin_builder_templates_cache_ttl', WEEK_IN_SECONDS ),
// Scheduled update action.
'update_action' => 'wpforms_admin_builder_templates_cache_update',
];
}
/**
* Prepare data to store in a local cache.
*
* @since 1.6.8
*
* @param array $data Raw data received by the remote request.
*
* @return array Prepared data for caching.
*/
protected function prepare_cache_data( $data ): array {
if (
empty( $data ) ||
! is_array( $data ) ||
empty( $data['status'] ) ||
$data['status'] !== 'success' ||
empty( $data['data'] )
) {
return [];
}
$cache_data = $data['data'];
// Strip the word "Template" from the end of each template name.
foreach ( $cache_data['templates'] as $slug => $template ) {
$cache_data['templates'][ $slug ]['name'] = preg_replace( '/\sTemplate$/', '', $template['name'] );
}
return $cache_data;
}
/**
* Update the cache.
*
* @since 1.8.6
*
* @param bool $force Whether to force update the cache.
*
* @return bool
*/
public function update( bool $force = false ): bool {
$result = parent::update( $force );
if ( ! $result ) {
return false;
}
$this->wipe_content_cache();
return $result;
}
/**
* Get cached templates content.
*
* @since 1.8.6
*
* @return string
*/
public function get_content_cache(): string {
// phpcs:ignore Universal.Operators.DisallowShortTernary.Found
return File::get_contents( $this->get_content_cache_file() ) ?: '';
}
/**
* Save templates content cache.
*
* @since 1.8.6
*
* @param string|mixed $content Templates content.
*
* @return bool
*/
public function save_content_cache( $content ): bool {
return File::put_contents( $this->get_content_cache_file(), (string) $content );
}
/**
* Wipe cached templates content.
*
* @since 1.8.6
*/
public function wipe_content_cache() {
$cache_dir = $this->get_cache_dir();
// Delete the template content cache files. They will be regenerated on the first visit.
foreach ( self::CONTENT_CACHE_FILES as $file ) {
$cache_file = $cache_dir . $file;
if ( is_file( $cache_file ) && is_readable( $cache_file ) ) {
// phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
unlink( $cache_file );
}
}
}
/**
* Get templates content cache file path.
*
* @since 1.8.6
*
* @return string
*/
private function get_content_cache_file(): string {
$context = wpforms_is_admin_page( 'templates' ) ? 'admin-page' : 'builder';
return File::get_cache_dir() . self::CONTENT_CACHE_FILES[ $context ];
}
}
Zerion Mini Shell 1.0