CMS Project Sync
This commit is contained in:
+569
@@ -0,0 +1,569 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
use WPForms\Tasks\Tasks;
|
||||
|
||||
/**
|
||||
* Remote data cache handler.
|
||||
*
|
||||
* Usage example in `WPForms\Admin\Addons\AddonsCache` and `WPForms\Admin\Builder\TemplatesCache`.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*/
|
||||
abstract class CacheBase {
|
||||
|
||||
/**
|
||||
* Encrypt a cached file.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*/
|
||||
protected const ENCRYPT = false;
|
||||
|
||||
/**
|
||||
* Request lock time, min.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*/
|
||||
private const REQUEST_LOCK_TIME = 15;
|
||||
|
||||
/**
|
||||
* A class id or array of cache class ids to sync updates with.
|
||||
*
|
||||
* @since 1.8.9
|
||||
*/
|
||||
protected const SYNC_WITH = [];
|
||||
|
||||
/**
|
||||
* The current class is syncing updates now.
|
||||
*
|
||||
* @since 1.8.9
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
private $syncing_updates = false;
|
||||
|
||||
/**
|
||||
* Indicates whether the cache was updated during the current run.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $updated = false;
|
||||
|
||||
/**
|
||||
* Settings.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $settings;
|
||||
|
||||
/**
|
||||
* Cache key.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $cache_key;
|
||||
|
||||
/**
|
||||
* Cache dir.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $cache_dir;
|
||||
|
||||
/**
|
||||
* Cache file.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private $cache_file;
|
||||
|
||||
/**
|
||||
* Determine if the class is allowed to load.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
abstract protected function allow_load();
|
||||
|
||||
/**
|
||||
* Initialize.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*/
|
||||
public function init() {
|
||||
|
||||
// Init settings before allow_load() as settings are used in get().
|
||||
$this->update_settings();
|
||||
|
||||
$this->cache_key = $this->settings['cache_file'];
|
||||
$this->cache_dir = $this->get_cache_dir(); // See comment in the method.
|
||||
$this->cache_file = $this->cache_dir . $this->settings['cache_file'];
|
||||
|
||||
// Do not update caches on heartbeat events.
|
||||
// phpcs:ignore WordPress.Security.NonceVerification.Missing
|
||||
$action = isset( $_POST['action'] ) ? sanitize_text_field( wp_unslash( $_POST['action'] ) ) : '';
|
||||
|
||||
if ( $action === 'heartbeat' ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! $this->allow_load() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Quit if settings weren't provided.
|
||||
if (
|
||||
empty( $this->settings['remote_source'] ) ||
|
||||
empty( $this->settings['cache_file'] )
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$this->hooks();
|
||||
}
|
||||
|
||||
/**
|
||||
* Base hooks.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*/
|
||||
private function hooks(): void {
|
||||
|
||||
add_action( 'shutdown', [ $this, 'cache_dir_complete' ] );
|
||||
|
||||
if ( empty( $this->settings['update_action'] ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Schedule recurring updates.
|
||||
add_action( 'admin_init', [ $this, 'schedule_update_cache' ] );
|
||||
add_action( $this->settings['update_action'], [ $this, 'update' ] );
|
||||
|
||||
// Sync cache updates.
|
||||
add_action( 'wpforms_helpers_cache_base_sync_updates', [ $this, 'sync_updates' ] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Sync cache updates.
|
||||
*
|
||||
* If one update has been done, run the update for other caches.
|
||||
*
|
||||
* @since 1.8.9
|
||||
*
|
||||
* @noinspection PhpCastIsUnnecessaryInspection
|
||||
* @noinspection UnnecessaryCastingInspection
|
||||
*/
|
||||
public function sync_updates(): void {
|
||||
|
||||
// Prevent infinite loop.
|
||||
if ( $this->syncing_updates ) {
|
||||
foreach ( (array) static::SYNC_WITH as $classname ) {
|
||||
$cache = wpforms()->obj( $classname );
|
||||
|
||||
if ( ! $cache instanceof self ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$cache->update( true );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up settings.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*/
|
||||
private function update_settings(): void {
|
||||
|
||||
$default_settings = [
|
||||
|
||||
// Remote source URL.
|
||||
// For instance: 'https://wpformsapi.com/feeds/v1/addons/'.
|
||||
'remote_source' => '',
|
||||
|
||||
// Request timeout in seconds.
|
||||
'timeout' => 10,
|
||||
|
||||
// Cache file.
|
||||
// Just file name. For instance: 'addons.json'.
|
||||
'cache_file' => '',
|
||||
|
||||
// Cache time to live in seconds.
|
||||
'cache_ttl' => WEEK_IN_SECONDS,
|
||||
|
||||
// Scheduled update action.
|
||||
// For instance: 'wpforms_admin_addons_cache_update'.
|
||||
'update_action' => '',
|
||||
// Additional query args for the remote source URL.
|
||||
'query_args' => [],
|
||||
];
|
||||
|
||||
$this->settings = wp_parse_args( $this->setup(), $default_settings );
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide settings.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @return array Settings array.
|
||||
*/
|
||||
abstract protected function setup();
|
||||
|
||||
/**
|
||||
* Get a cache directory path.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_cache_dir() {
|
||||
|
||||
return File::get_cache_dir();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get data from cache or from API call.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get() {
|
||||
|
||||
$cache = $this->get_from_cache();
|
||||
|
||||
if ( ! empty( $cache ) && ! $this->is_expired_cache() ) {
|
||||
return $cache;
|
||||
}
|
||||
|
||||
$this->update();
|
||||
|
||||
return $this->get_from_cache();
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the cache is expired.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function is_expired_cache(): bool {
|
||||
|
||||
return $this->cache_time() + $this->settings['cache_ttl'] < time();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cache creation time.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
private function cache_time(): int {
|
||||
|
||||
return (int) Transient::get( $this->cache_key );
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the cache file exists.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function exists(): bool {
|
||||
|
||||
return is_file( $this->cache_file ) && is_readable( $this->cache_file );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cache from a cache file.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function get_from_cache(): array {
|
||||
|
||||
if ( ! $this->exists() ) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$content = File::get_contents( $this->cache_file );
|
||||
|
||||
// Do not decrypt non-encrypted legacy files, they will be encrypted on the scheduled update.
|
||||
if ( static::ENCRYPT && ! wpforms_is_json( $content ) ) {
|
||||
$content = Crypto::decrypt( $content );
|
||||
}
|
||||
|
||||
return (array) json_decode( $content, true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Update cache.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @param bool $force Force update.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function update( bool $force = false ): bool {
|
||||
|
||||
if (
|
||||
! $force &&
|
||||
time() < $this->cache_time() + self::REQUEST_LOCK_TIME * MINUTE_IN_SECONDS
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
Transient::set( $this->cache_key, time(), $this->settings['cache_ttl'] );
|
||||
|
||||
if ( ! wp_mkdir_p( $this->cache_dir ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$data = $this->perform_remote_request();
|
||||
$content = wp_json_encode( $data );
|
||||
|
||||
$this->maybe_update_transient( $data );
|
||||
|
||||
if ( static::ENCRYPT ) {
|
||||
$content = Crypto::encrypt( $content );
|
||||
}
|
||||
|
||||
if ( ! File::put_contents( $this->cache_file, $content ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( ! $this->syncing_updates ) {
|
||||
$this->syncing_updates = true;
|
||||
|
||||
/**
|
||||
* Action hook after the cache has been updated.
|
||||
*
|
||||
* @since 1.8.9
|
||||
*/
|
||||
do_action( 'wpforms_helpers_cache_base_sync_updates' );
|
||||
}
|
||||
|
||||
$this->updated = true;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get data from API.
|
||||
*
|
||||
* @since 1.8.2
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function perform_remote_request(): array {
|
||||
|
||||
$query_args = $this->settings['query_args'] ?? [];
|
||||
|
||||
$request_url = add_query_arg( $query_args, $this->settings['remote_source'] );
|
||||
$user_agent = wpforms_get_default_user_agent();
|
||||
$request = wp_remote_get(
|
||||
$request_url,
|
||||
[
|
||||
'timeout' => $this->settings['timeout'],
|
||||
'user-agent' => $user_agent,
|
||||
]
|
||||
);
|
||||
|
||||
$request_url_log = remove_query_arg( [ 'tgm-updater-key' ], $request_url );
|
||||
|
||||
// Log if the request failed.
|
||||
if ( is_wp_error( $request ) ) {
|
||||
$this->add_log(
|
||||
'Cached data: HTTP request error',
|
||||
[
|
||||
'class' => static::class,
|
||||
'request_url' => $request_url_log,
|
||||
'error' => $request->get_error_message(),
|
||||
'error_data' => $request->get_error_data(),
|
||||
],
|
||||
'error'
|
||||
);
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
$response_code = wp_remote_retrieve_response_code( $request );
|
||||
$raw_headers = wp_remote_retrieve_headers( $request );
|
||||
$response_headers = is_object( $raw_headers ) ? $raw_headers->getAll() : (array) $raw_headers;
|
||||
$response_body = wp_remote_retrieve_body( $request );
|
||||
$response_body_len = strlen( $response_body );
|
||||
$response_body_log = $response_body_len > 1024 ? "(First 1 kB):\n" . substr( trim( $response_body ), 0, 1024 ) . '...' : trim( $response_body );
|
||||
$response_body_log = esc_html( $response_body_log );
|
||||
|
||||
$log_data = [
|
||||
'class' => static::class,
|
||||
'request_url' => $request_url_log,
|
||||
'code' => $response_code,
|
||||
'headers' => $response_headers,
|
||||
'content_length' => $response_body_len,
|
||||
'body' => $response_body_log,
|
||||
];
|
||||
|
||||
// Log the response details in debug mode.
|
||||
if ( wpforms_debug() ) {
|
||||
$this->add_log( 'Cached data: Response details', $log_data );
|
||||
}
|
||||
|
||||
// Log the error if the response code is not 2xx or 3xx.
|
||||
if ( $response_code > 399 ) {
|
||||
$this->add_log( 'Cached data: HTTP request error', $log_data, 'error' );
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
$json = trim( $response_body );
|
||||
$data = json_decode( $json, true );
|
||||
|
||||
if ( empty( $data ) ) {
|
||||
$message = $data === null ? 'Invalid JSON' : 'Empty JSON';
|
||||
|
||||
$log_data = array_merge(
|
||||
$log_data,
|
||||
[
|
||||
'json_result' => $message,
|
||||
'cache_file' => $this->settings['cache_file'],
|
||||
'remote_source' => $this->settings['remote_source'],
|
||||
]
|
||||
);
|
||||
|
||||
$this->add_log( 'Cached data: ' . $message, $log_data, 'error' );
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
return $this->prepare_cache_data( $data );
|
||||
}
|
||||
|
||||
/**
|
||||
* Add log.
|
||||
*
|
||||
* @since 1.8.9
|
||||
*
|
||||
* @param string $title Log title.
|
||||
* @param array $data Log data.
|
||||
* @param string $type Log type.
|
||||
*/
|
||||
protected function add_log( string $title, array $data, string $type = 'log' ): void {
|
||||
|
||||
wpforms_log(
|
||||
$title,
|
||||
$data,
|
||||
[
|
||||
'type' => [ $type ],
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedule updates.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*/
|
||||
public function schedule_update_cache(): void {
|
||||
|
||||
// Just skip if not need to register a scheduled action.
|
||||
if ( empty( $this->settings['update_action'] ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$tasks = wpforms()->obj( 'tasks' );
|
||||
|
||||
if (
|
||||
! $tasks instanceof Tasks ||
|
||||
$tasks->is_scheduled( $this->settings['update_action'] ) !== false
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
$tasks->create( $this->settings['update_action'] )
|
||||
->recurring( time() + $this->settings['cache_ttl'], $this->settings['cache_ttl'] )
|
||||
->params()
|
||||
->register();
|
||||
}
|
||||
|
||||
/**
|
||||
* Complete the cache directory.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*/
|
||||
public function cache_dir_complete(): void {
|
||||
|
||||
if ( ! $this->updated ) {
|
||||
return;
|
||||
}
|
||||
|
||||
wpforms_create_upload_dir_htaccess_file();
|
||||
wpforms_create_cache_dir_htaccess_file();
|
||||
wpforms_create_index_html_file( $this->cache_dir );
|
||||
wpforms_create_index_php_file( $this->cache_dir );
|
||||
}
|
||||
|
||||
/**
|
||||
* Invalidate cache.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*/
|
||||
public function invalidate_cache(): void {
|
||||
|
||||
Transient::delete( $this->cache_key );
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare data to store in a local cache.
|
||||
*
|
||||
* @since 1.6.8
|
||||
*
|
||||
* @param array|mixed $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 ) ) {
|
||||
return [];
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Maybe update transient duration time.
|
||||
*
|
||||
* Allows updating transient duration time if it's less than expiration time.
|
||||
* To do this, overwrite this method in child classes.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param array $data Data received by the remote request.
|
||||
*
|
||||
* @return bool|array
|
||||
*/
|
||||
protected function maybe_update_transient( array $data ) {
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
+416
@@ -0,0 +1,416 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
use BadFunctionCallException;
|
||||
|
||||
/**
|
||||
* Chain monad, useful for chaining a certain array or string related functions.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @method Chain array_change_key_case()
|
||||
* @method Chain array_chunk()
|
||||
* @method Chain array_column()
|
||||
* @method Chain array_combine()
|
||||
* @method Chain array_count_values()
|
||||
* @method Chain array_diff_assoc()
|
||||
* @method Chain array_diff_key()
|
||||
* @method Chain array_diff_uassoc()
|
||||
* @method Chain array_diff_ukey()
|
||||
* @method Chain array_diff(array $var)
|
||||
* @method Chain array_fill_keys()
|
||||
* @method Chain array_fill()
|
||||
* @method Chain array_filter()
|
||||
* @method Chain array_flip()
|
||||
* @method Chain array_intersect_assoc()
|
||||
* @method Chain array_intersect_key()
|
||||
* @method Chain array_intersect_uassoc()
|
||||
* @method Chain array_intersect_ukey()
|
||||
* @method Chain array_intersect(array $var)
|
||||
* @method Chain array_key_first()
|
||||
* @method Chain array_key_last()
|
||||
* @method Chain array_keys()
|
||||
* @method Chain array_map()
|
||||
* @method Chain array_merge_recursive()
|
||||
* @method Chain array_merge(array $var)
|
||||
* @method Chain array_pad()
|
||||
* @method Chain array_pop()
|
||||
* @method Chain array_product()
|
||||
* @method Chain array_rand()
|
||||
* @method Chain array_reduce()
|
||||
* @method Chain array_replace_recursive()
|
||||
* @method Chain array_replace()
|
||||
* @method Chain array_reverse()
|
||||
* @method Chain array_shift()
|
||||
* @method Chain array_slice()
|
||||
* @method Chain array_splice()
|
||||
* @method Chain array_sum()
|
||||
* @method Chain array_udiff_assoc()
|
||||
* @method Chain array_udiff_uassoc()
|
||||
* @method Chain array_udiff()
|
||||
* @method Chain array_uintersect_assoc()
|
||||
* @method Chain array_uintersect_uassoc()
|
||||
* @method Chain array_uintersect()
|
||||
* @method Chain array_unique()
|
||||
* @method Chain array_values()
|
||||
* @method Chain count()
|
||||
* @method Chain current()
|
||||
* @method Chain end()
|
||||
* @method Chain key()
|
||||
* @method Chain next()
|
||||
* @method Chain prev()
|
||||
* @method Chain range()
|
||||
* @method Chain reset()
|
||||
* @method Chain ltrim()
|
||||
* @method Chain rtrim()
|
||||
* @method Chain md5()
|
||||
* @method Chain str_getcsv()
|
||||
* @method Chain str_ireplace()
|
||||
* @method Chain str_pad()
|
||||
* @method Chain str_repeat()
|
||||
* @method Chain str_rot13()
|
||||
* @method Chain str_shuffle()
|
||||
* @method Chain str_split()
|
||||
* @method Chain str_word_count()
|
||||
* @method Chain strcasecmp()
|
||||
* @method Chain strchr()
|
||||
* @method Chain strcmp()
|
||||
* @method Chain strcoll()
|
||||
* @method Chain strcspn()
|
||||
* @method Chain strip_tags()
|
||||
* @method Chain stripcslashes()
|
||||
* @method Chain stripos()
|
||||
* @method Chain stripslashes()
|
||||
* @method Chain stristr()
|
||||
* @method Chain strlen()
|
||||
* @method Chain strnatcasecmp()
|
||||
* @method Chain strnatcmp()
|
||||
* @method Chain strncasecmp()
|
||||
* @method Chain strncmp()
|
||||
* @method Chain strpbrk()
|
||||
* @method Chain strpos()
|
||||
* @method Chain strrchr()
|
||||
* @method Chain strrev()
|
||||
* @method Chain strripos()
|
||||
* @method Chain strrpos()
|
||||
* @method Chain strspn()
|
||||
* @method Chain strstr()
|
||||
* @method Chain strtok()
|
||||
* @method Chain strtolower()
|
||||
* @method Chain strtoupper()
|
||||
* @method Chain strtr()
|
||||
* @method Chain substr_compare()
|
||||
* @method Chain substr_count()
|
||||
* @method Chain substr_replace()
|
||||
* @method Chain substr()
|
||||
* @method Chain trim()
|
||||
* @method Chain ucfirst()
|
||||
* @method Chain ucwords()
|
||||
* @method Chain vfprintf()
|
||||
* @method Chain vprintf()
|
||||
* @method Chain vsprintf()
|
||||
* @method Chain wordwrap()
|
||||
*/
|
||||
class Chain {
|
||||
|
||||
/**
|
||||
* Current value.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @var mixed
|
||||
*/
|
||||
private $value;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param mixed $value Current value to start working with.
|
||||
*/
|
||||
public function __construct( $value ) {
|
||||
|
||||
$this->value = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Bind some function to value.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param mixed $fn Some function.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function bind( $fn ) {
|
||||
|
||||
$this->value = $fn( $this->value );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get value.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function value() {
|
||||
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Magic call.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param string $name Method name.
|
||||
* @param array $params Parameters.
|
||||
*
|
||||
* @throws BadFunctionCallException Invalid function is called.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function __call( $name, $params ) {
|
||||
|
||||
if ( in_array( $name, $this->allowed_methods(), true ) ) {
|
||||
|
||||
$params = $params === null ? [] : $params;
|
||||
|
||||
array_unshift( $params, $this->value );
|
||||
|
||||
$this->value = call_user_func_array( $name, array_values( $params ) );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
throw new BadFunctionCallException( esc_html( "Provided function { $name } is not allowed. See Chain::allowed_methods()." ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Join array elements with a string.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param string $glue Defaults to an empty string.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function implode( $glue = '' ) {
|
||||
|
||||
$this->value = implode( $glue, $this->value );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Split a string by a string.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param string $delimiter The boundary string.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function explode( $delimiter ) {
|
||||
|
||||
$this->value = explode( $delimiter, $this->value );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply the callback to the elements of the given arrays.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param callable $cb Callback.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function map( $cb ) {
|
||||
|
||||
$this->value = array_map( $cb, $this->value );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pop array.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function pop() {
|
||||
|
||||
$this->value = array_pop( $this->value );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run first or second callback based on a condition.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param callable $condition Condition function.
|
||||
* @param callable $true_result If condition will return true we run this function.
|
||||
* @param callable $false_result If condition will return false we run this function.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public function iif( $condition, $true_result, $false_result = null ) {
|
||||
|
||||
if ( ! is_callable( $false_result ) ) {
|
||||
$false_result = function() {
|
||||
return '';
|
||||
};
|
||||
}
|
||||
$this->value = array_map(
|
||||
function( $el ) use ( $condition, $true_result, $false_result ) {
|
||||
if ( call_user_func( $condition, $el ) ) {
|
||||
return call_user_func( $true_result, $el );
|
||||
}
|
||||
return call_user_func( $false_result, $el );
|
||||
},
|
||||
$this->value
|
||||
);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* All allowed methods to work with data.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function allowed_methods() {
|
||||
|
||||
return [
|
||||
'array_change_key_case',
|
||||
'array_chunk',
|
||||
'array_column',
|
||||
'array_combine',
|
||||
'array_count_values',
|
||||
'array_diff_assoc',
|
||||
'array_diff_key',
|
||||
'array_diff_uassoc',
|
||||
'array_diff_ukey',
|
||||
'array_diff',
|
||||
'array_fill_keys',
|
||||
'array_fill',
|
||||
'array_filter',
|
||||
'array_flip',
|
||||
'array_intersect_assoc',
|
||||
'array_intersect_key',
|
||||
'array_intersect_uassoc',
|
||||
'array_intersect_ukey',
|
||||
'array_intersect',
|
||||
'array_key_first',
|
||||
'array_key_last',
|
||||
'array_keys',
|
||||
'array_map',
|
||||
'array_merge_recursive',
|
||||
'array_merge',
|
||||
'array_pad',
|
||||
'array_pop',
|
||||
'array_product',
|
||||
'array_rand',
|
||||
'array_reduce',
|
||||
'array_replace_recursive',
|
||||
'array_replace',
|
||||
'array_reverse',
|
||||
'array_shift',
|
||||
'array_slice',
|
||||
'array_splice',
|
||||
'array_sum',
|
||||
'array_udiff_assoc',
|
||||
'array_udiff_uassoc',
|
||||
'array_udiff',
|
||||
'array_uintersect_assoc',
|
||||
'array_uintersect_uassoc',
|
||||
'array_uintersect',
|
||||
'array_unique',
|
||||
'array_values',
|
||||
'count',
|
||||
'current',
|
||||
'end',
|
||||
'key',
|
||||
'next',
|
||||
'prev',
|
||||
'range',
|
||||
'reset',
|
||||
'implode',
|
||||
'ltrim',
|
||||
'rtrim',
|
||||
'md5',
|
||||
'str_getcsv',
|
||||
'str_ireplace',
|
||||
'str_pad',
|
||||
'str_repeat',
|
||||
'str_rot13',
|
||||
'str_shuffle',
|
||||
'str_split',
|
||||
'str_word_count',
|
||||
'strcasecmp',
|
||||
'strchr',
|
||||
'strcmp',
|
||||
'strcoll',
|
||||
'strcspn',
|
||||
'strip_tags',
|
||||
'stripcslashes',
|
||||
'stripos',
|
||||
'stripslashes',
|
||||
'stristr',
|
||||
'strlen',
|
||||
'strnatcasecmp',
|
||||
'strnatcmp',
|
||||
'strncasecmp',
|
||||
'strncmp',
|
||||
'strpbrk',
|
||||
'strpos',
|
||||
'strrchr',
|
||||
'strrev',
|
||||
'strripos',
|
||||
'strrpos',
|
||||
'strspn',
|
||||
'strstr',
|
||||
'strtok',
|
||||
'strtolower',
|
||||
'strtoupper',
|
||||
'strtr',
|
||||
'substr_compare',
|
||||
'substr_count',
|
||||
'substr_replace',
|
||||
'substr',
|
||||
'trim',
|
||||
'ucfirst',
|
||||
'ucwords',
|
||||
'vfprintf',
|
||||
'vprintf',
|
||||
'vsprintf',
|
||||
'wordwrap',
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Create myself.
|
||||
*
|
||||
* @since 1.5.6
|
||||
*
|
||||
* @param mixed $value Current.
|
||||
*
|
||||
* @return Chain
|
||||
*/
|
||||
public static function of( $value = null ) {
|
||||
|
||||
return new self( $value );
|
||||
}
|
||||
}
|
||||
+130
@@ -0,0 +1,130 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
/**
|
||||
* Class for encryption functionality.
|
||||
*
|
||||
* @since 1.6.1.2
|
||||
*
|
||||
* @link https://www.php.net/manual/en/intro.sodium.php
|
||||
*/
|
||||
class Crypto {
|
||||
|
||||
/**
|
||||
* Get a secret key for encrypt/decrypt.
|
||||
*
|
||||
* @since 1.6.1.2
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_secret_key() {
|
||||
|
||||
$secret_key = get_option( 'wpforms_crypto_secret_key' );
|
||||
|
||||
// If we already have the secret, send it back.
|
||||
if ( false !== $secret_key ) {
|
||||
return base64_decode( $secret_key ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
|
||||
}
|
||||
|
||||
// We don't have a secret, so let's generate one.
|
||||
$secret_key = sodium_crypto_secretbox_keygen();
|
||||
add_option( 'wpforms_crypto_secret_key', base64_encode( $secret_key ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
|
||||
|
||||
return $secret_key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Encrypt a message.
|
||||
*
|
||||
* @since 1.6.1.2
|
||||
*
|
||||
* @param string $message Message to encrypt.
|
||||
* @param string $key Encryption key.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function encrypt( $message, $key = '' ) {
|
||||
|
||||
// Create a nonce for this operation. It will be stored and recovered in the message itself.
|
||||
$nonce = random_bytes(
|
||||
SODIUM_CRYPTO_SECRETBOX_NONCEBYTES
|
||||
);
|
||||
|
||||
if ( empty( $key ) ) {
|
||||
$key = self::get_secret_key();
|
||||
}
|
||||
|
||||
// Encrypt message and combine with nonce.
|
||||
$cipher = base64_encode( // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
|
||||
$nonce .
|
||||
sodium_crypto_secretbox(
|
||||
$message,
|
||||
$nonce,
|
||||
$key
|
||||
)
|
||||
);
|
||||
|
||||
try {
|
||||
sodium_memzero( $message );
|
||||
sodium_memzero( $key );
|
||||
} catch ( \Exception $e ) {
|
||||
return $cipher;
|
||||
}
|
||||
|
||||
return $cipher;
|
||||
}
|
||||
|
||||
/**
|
||||
* Decrypt a message.
|
||||
*
|
||||
* @since 1.6.1.2
|
||||
*
|
||||
* @param string $encrypted Encrypted message.
|
||||
* @param string $key Encryption key.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function decrypt( $encrypted, $key = '' ) {
|
||||
|
||||
// Unpack base64 message.
|
||||
$decoded = base64_decode( (string) $encrypted ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
|
||||
|
||||
if ( false === $decoded ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( mb_strlen( $decoded, '8bit' ) < ( SODIUM_CRYPTO_SECRETBOX_NONCEBYTES + SODIUM_CRYPTO_SECRETBOX_MACBYTES ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Pull nonce and ciphertext out of unpacked message.
|
||||
$nonce = mb_substr( $decoded, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, '8bit' );
|
||||
$ciphertext = mb_substr( $decoded, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES, null, '8bit' );
|
||||
|
||||
if ( empty( $key ) ) {
|
||||
$key = self::get_secret_key();
|
||||
}
|
||||
|
||||
// Decrypt it.
|
||||
$message = sodium_crypto_secretbox_open(
|
||||
$ciphertext,
|
||||
$nonce,
|
||||
$key
|
||||
);
|
||||
|
||||
// Check for decrpytion failures.
|
||||
if ( false === $message ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
sodium_memzero( $ciphertext );
|
||||
sodium_memzero( $key );
|
||||
} catch ( \Exception $e ) {
|
||||
return $message;
|
||||
}
|
||||
|
||||
return $message;
|
||||
}
|
||||
}
|
||||
+291
@@ -0,0 +1,291 @@
|
||||
<?php
|
||||
|
||||
// phpcs:ignore Generic.Commenting.DocComment.MissingShort
|
||||
/** @noinspection PhpIllegalPsrClassPathInspection */
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
// phpcs:ignore WPForms.PHP.UseStatement.UnusedUseStatement
|
||||
use WPForms_DB;
|
||||
use WPForms_Lite;
|
||||
use WPForms_Pro;
|
||||
|
||||
/**
|
||||
* DB helpers.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*/
|
||||
class DB {
|
||||
|
||||
/**
|
||||
* Existing tables transient name.
|
||||
*
|
||||
* @since 1.8.7
|
||||
* @since 1.9.0 Changed from 'wpforms_existing_tables' to 'existing_tables'
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
const EXISTING_TABLES_TRANSIENT_NAME = 'existing_tables';
|
||||
|
||||
/**
|
||||
* Existing tables transient expiration, sec.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @var int
|
||||
* @noinspection SummerTimeUnsafeTimeManipulationInspection
|
||||
*/
|
||||
const EXISTING_TABLES_TRANSIENT_EXPIRATION = WEEK_IN_SECONDS; // A week.
|
||||
|
||||
/**
|
||||
* Existing tables.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
private static $existing_tables = [];
|
||||
|
||||
/**
|
||||
* Get the list of existing tables and cache the result.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param string $table_name Table name. Can have SQL wildcard.
|
||||
*
|
||||
* @return array List of table names.
|
||||
*/
|
||||
public static function get_existing_tables( string $table_name ): array {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
/**
|
||||
* Filters existence of a table before a request to the database is executed.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param array $tables Existing tables with given table name.
|
||||
* @param string $table_name Table name.
|
||||
*/
|
||||
$tables = (array) apply_filters( 'wpforms_helpers_db_pre_get_existing_tables', [], $table_name );
|
||||
|
||||
if ( $tables ) {
|
||||
return $tables;
|
||||
}
|
||||
|
||||
$tables = self::get_existing_tables_cache( $table_name );
|
||||
|
||||
if ( $tables ) {
|
||||
return $tables;
|
||||
}
|
||||
|
||||
// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
$tables = $wpdb->get_results(
|
||||
$wpdb->prepare( 'SHOW TABLES LIKE %s', $table_name ),
|
||||
'ARRAY_N'
|
||||
);
|
||||
// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
|
||||
$tables = ! empty( $tables ) ? wp_list_pluck( $tables, 0 ) : [];
|
||||
|
||||
self::set_existing_tables_cache( $tables, $table_name );
|
||||
|
||||
return self::$existing_tables[ $table_name ] ?? [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of all existing custom tables starting with `wpforms_*` and cache the result.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @return array List of table names.
|
||||
*/
|
||||
public static function get_existing_custom_tables(): array {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
return self::get_existing_tables( "{$wpdb->prefix}wpforms_%" );
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the database table exists and cache the result.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param string $table_name Table name. Can have SQL wildcard.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function table_exists( string $table_name ): bool {
|
||||
|
||||
/**
|
||||
* Filters existence of a table before a request to the database is executed.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param integer $exists Table exists.
|
||||
* @param string $table_name Table name.
|
||||
*/
|
||||
if ( apply_filters( 'wpforms_helpers_db_pre_table_exists', false, $table_name ) ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
foreach ( self::get_existing_tables( $table_name ) as $existing_table ) {
|
||||
if ( self::wildcard_match( $table_name, $existing_table ) ) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of existing tables from cache.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param string $table_name Table name. Can have SQL wildcard.
|
||||
*
|
||||
* @return array List of table names.
|
||||
*/
|
||||
private static function get_existing_tables_cache( string $table_name ): array {
|
||||
|
||||
$tables = Transient::get( self::EXISTING_TABLES_TRANSIENT_NAME );
|
||||
self::$existing_tables = $tables ? $tables : [];
|
||||
|
||||
return self::$existing_tables[ $table_name ] ?? [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set existing tables cache.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param array $tables Existing tables with given table name.
|
||||
* @param string $table_name Table name.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private static function set_existing_tables_cache( array $tables, string $table_name ) {
|
||||
|
||||
if ( empty( $tables ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
self::$existing_tables[ $table_name ] = $tables;
|
||||
|
||||
/**
|
||||
* Filters existing tables transient expiration time.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param integer $expiration Expiration time.
|
||||
*/
|
||||
$expiration = apply_filters( 'wpforms_helpers_db_existing_tables_transient_expiration', self::EXISTING_TABLES_TRANSIENT_EXPIRATION );
|
||||
|
||||
Transient::set( self::EXISTING_TABLES_TRANSIENT_NAME, self::$existing_tables, $expiration );
|
||||
}
|
||||
|
||||
/**
|
||||
* Flush existing tables cache.
|
||||
*
|
||||
* @since 1.9.0
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public static function flush_existing_tables_cache() {
|
||||
|
||||
self::$existing_tables = [];
|
||||
|
||||
Transient::delete( self::EXISTING_TABLES_TRANSIENT_NAME );
|
||||
}
|
||||
|
||||
/**
|
||||
* Wildcard match.
|
||||
* Works as MySQL LIKE match.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param string $pattern Pattern.
|
||||
* @param string $subject String to search into.
|
||||
*
|
||||
* @return false|int
|
||||
*/
|
||||
private static function wildcard_match( string $pattern, string $subject ) {
|
||||
|
||||
$regex = str_replace(
|
||||
[ '%', '_' ], // MySQL wildcard chars.
|
||||
[ '.*', '.' ], // Regexp chars.
|
||||
preg_quote( $pattern, '/' )
|
||||
);
|
||||
|
||||
return preg_match( '/^' . $regex . '$/is', $subject );
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if all custom tables exist.
|
||||
*
|
||||
* @since 1.9.0
|
||||
*
|
||||
* @return bool True if all custom tables exist. False if any is missing.
|
||||
*/
|
||||
public static function custom_tables_exist(): bool {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
$existing_tables = self::get_existing_custom_tables();
|
||||
$custom_tables = wpforms()->is_pro() ? WPForms_Pro::CUSTOM_TABLES : WPForms_Lite::CUSTOM_TABLES;
|
||||
|
||||
foreach ( $custom_tables as $table_name => $handler_class ) {
|
||||
if ( ! in_array( $wpdb->prefix . $table_name, $existing_tables, true ) ) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create all custom DB tables.
|
||||
*
|
||||
* @since 1.9.0
|
||||
*
|
||||
* @param bool $flush_cache Clear existing custom tables cache.
|
||||
*
|
||||
* @noinspection PhpPossiblePolymorphicInvocationInspection
|
||||
*/
|
||||
public static function create_custom_tables( bool $flush_cache = false ) {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
if ( $flush_cache ) {
|
||||
self::flush_existing_tables_cache();
|
||||
}
|
||||
|
||||
$existing_tables = self::get_existing_custom_tables();
|
||||
$custom_tables = wpforms()->is_pro() ? WPForms_Pro::CUSTOM_TABLES : WPForms_Lite::CUSTOM_TABLES;
|
||||
$created = false;
|
||||
|
||||
foreach ( $custom_tables as $table_name => $handler_class ) {
|
||||
if ( in_array( $wpdb->prefix . $table_name, $existing_tables, true ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Child class of WPForms_DB.
|
||||
*
|
||||
* @var $handler WPForms_DB
|
||||
*/
|
||||
$handler = new $handler_class();
|
||||
|
||||
// Create a table.
|
||||
$handler->create_table();
|
||||
|
||||
$created = true;
|
||||
}
|
||||
|
||||
if ( $created ) {
|
||||
Transient::delete( self::EXISTING_TABLES_TRANSIENT_NAME );
|
||||
}
|
||||
}
|
||||
}
|
||||
+409
@@ -0,0 +1,409 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
use WP_Filesystem_Base; // phpcs:ignore WPForms.PHP.UseStatement.UnusedUseStatement
|
||||
|
||||
/**
|
||||
* Class File.
|
||||
*
|
||||
* @since 1.6.5
|
||||
*/
|
||||
class File {
|
||||
|
||||
/**
|
||||
* Remove UTF-8 BOM signature if it presents.
|
||||
*
|
||||
* @since 1.6.5
|
||||
*
|
||||
* @param string $str String to process.
|
||||
*
|
||||
* @return string
|
||||
* @noinspection SpellCheckingInspection
|
||||
*/
|
||||
public static function remove_utf8_bom( $str ): string {
|
||||
|
||||
if ( strpos( bin2hex( $str ), 'efbbbf' ) === 0 ) {
|
||||
$str = substr( $str, 3 );
|
||||
}
|
||||
|
||||
return $str;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current filesystem.
|
||||
*
|
||||
* @since 1.8.6
|
||||
*
|
||||
* @return WP_Filesystem_Base|null
|
||||
*/
|
||||
public static function get_filesystem(): ?WP_Filesystem_Base {
|
||||
|
||||
global $wp_filesystem;
|
||||
|
||||
static $is_filesystem_setup;
|
||||
|
||||
if ( $is_filesystem_setup ) {
|
||||
return $wp_filesystem;
|
||||
}
|
||||
|
||||
// We have to start the buffer to prevent output
|
||||
// when the file system is ssh/FTP but not configured.
|
||||
ob_start();
|
||||
|
||||
if ( ! function_exists( 'request_filesystem_credentials' ) ) {
|
||||
require_once ABSPATH . 'wp-admin/includes/file.php';
|
||||
}
|
||||
|
||||
// The current page URL.
|
||||
$url = home_url( esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ?? '' ) ) );
|
||||
|
||||
$credentials = request_filesystem_credentials( $url, '', false, false );
|
||||
|
||||
ob_end_clean();
|
||||
|
||||
if ( $credentials === false || ! WP_Filesystem( $credentials ) ) {
|
||||
wpforms_log(
|
||||
'WP_Filesystem Error',
|
||||
'File system isn\'t configured.',
|
||||
[ 'type' => [ 'error' ] ]
|
||||
);
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
$is_filesystem_setup = true;
|
||||
|
||||
return $wp_filesystem;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get file contents.
|
||||
*
|
||||
* @since 1.8.6
|
||||
*
|
||||
* @param string $file File path.
|
||||
*
|
||||
* @return string|false
|
||||
*/
|
||||
public static function get_contents( $file ) {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if (
|
||||
! $filesystem
|
||||
|| ! $filesystem->is_readable( $file )
|
||||
|| $filesystem->is_dir( $file )
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $filesystem->size( $file ) > 0 ? $filesystem->get_contents( $file ) : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Save file contents.
|
||||
*
|
||||
* @since 1.8.6
|
||||
*
|
||||
* @param string $file File path.
|
||||
* @param string $content File content.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function put_contents( $file, $content ): bool {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $filesystem->put_contents( $file, $content );
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine whether a file or directory exists.
|
||||
*
|
||||
* @since 1.9.1
|
||||
*
|
||||
* @param string $path Path to a file or directory.
|
||||
*
|
||||
* @return bool Whether $path exists or not.
|
||||
*/
|
||||
public static function exists( string $path ): bool {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $filesystem->exists( $path );
|
||||
}
|
||||
|
||||
/**
|
||||
* Copies a file.
|
||||
*
|
||||
* @since 1.9.1
|
||||
*
|
||||
* @param string $source Path to the source file.
|
||||
* @param string $destination Path to the destination file.
|
||||
* @param bool $overwrite Optional. Whether to overwrite the destination file if it exists.
|
||||
* Default false.
|
||||
*
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
public static function copy( string $source, string $destination, bool $overwrite = false ): bool {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $filesystem->copy( $source, $destination, $overwrite );
|
||||
}
|
||||
|
||||
/**
|
||||
* Move a file or files from source to destination.
|
||||
*
|
||||
* @since 1.8.8
|
||||
*
|
||||
* @param string $source Source file or glob pattern.
|
||||
* @param string $destination Destination file or directory.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function move( string $source, string $destination ): bool {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
foreach ( glob( $source ) as $filename ) {
|
||||
$move = $filesystem->move( $filename, $destination . basename( $filename ), true );
|
||||
|
||||
if ( ! $move ) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a file or directory.
|
||||
*
|
||||
* @since 1.8.8
|
||||
*
|
||||
* @param string $file Path to the file or directory.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function delete( string $file ): bool {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $filesystem->delete( $file, true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a directory.
|
||||
*
|
||||
* @since 1.8.8
|
||||
*
|
||||
* @param string $dir Path directory.
|
||||
*
|
||||
* @return bool True on success, false on failure. If the directory already exists, this method will return true.
|
||||
*/
|
||||
public static function mkdir( string $dir ): bool {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( $filesystem->is_dir( $dir ) ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $filesystem->mkdir( $dir );
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets details for files in a directory or a specific file.
|
||||
*
|
||||
* @since 1.8.8
|
||||
*
|
||||
* @param string $dir Path directory.
|
||||
*
|
||||
* @return array|bool
|
||||
*/
|
||||
public static function dirlist( string $dir ) {
|
||||
|
||||
$filesystem = self::get_filesystem();
|
||||
|
||||
if ( ! $filesystem || ! $filesystem->is_dir( $dir ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return $filesystem->dirlist( $dir, false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the upload directory path.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_upload_dir(): string {
|
||||
|
||||
static $upload_dir;
|
||||
|
||||
if ( $upload_dir ) {
|
||||
/**
|
||||
* Since wpforms_upload_dir() relies on hooks, and hooks can be added unpredictably,
|
||||
* we need to cache the result of this method.
|
||||
* Otherwise, it is a risk to save a cache file to one dir and try to get from another.
|
||||
*/
|
||||
return $upload_dir;
|
||||
}
|
||||
|
||||
$wpforms_upload_dir = wpforms_upload_dir();
|
||||
$wpforms_upload_path = ! empty( $wpforms_upload_dir['path'] )
|
||||
? $wpforms_upload_dir['path']
|
||||
: WP_CONTENT_DIR . '/uploads/wpforms';
|
||||
$upload_dir = trailingslashit( wp_normalize_path( $wpforms_upload_path ) );
|
||||
|
||||
return $upload_dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the upload directory URL.
|
||||
*
|
||||
* @since 1.9.7.3
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_upload_url(): string {
|
||||
|
||||
static $upload_url;
|
||||
|
||||
if ( $upload_url ) {
|
||||
/**
|
||||
* Since wpforms_upload_dir() relies on hooks, and hooks can be added unpredictably,
|
||||
* we need to cache the result of this method.
|
||||
* Otherwise, it is a risk to save a cache file to one dir and try to get from another.
|
||||
*/
|
||||
return $upload_url;
|
||||
}
|
||||
|
||||
$wpforms_upload_dir = wpforms_upload_dir();
|
||||
|
||||
return ! empty( $wpforms_upload_dir['url'] )
|
||||
? $wpforms_upload_dir['url']
|
||||
: WP_CONTENT_URL . '/uploads/wpforms';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the cache directory path.
|
||||
*
|
||||
* @since 1.8.6
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_cache_dir(): string {
|
||||
|
||||
static $cache_dir;
|
||||
|
||||
if ( $cache_dir ) {
|
||||
/**
|
||||
* Since wpforms_upload_dir() relies on hooks, and hooks can be added unpredictably,
|
||||
* we need to cache the result of this method.
|
||||
* Otherwise, it is a risk to save a cache file to one dir and try to get from another.
|
||||
*/
|
||||
return $cache_dir;
|
||||
}
|
||||
|
||||
$cache_dir = self::get_upload_dir() . 'cache/';
|
||||
|
||||
return $cache_dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether the file is already updated.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param string $filename Filename.
|
||||
* @param string $cache_key Cache key.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public static function is_file_updated( string $filename, string $cache_key = '' ): bool {
|
||||
|
||||
$filename = wp_normalize_path( $filename );
|
||||
$cache_key = $cache_key ? $cache_key : 'wpforms_' . $filename . '_file';
|
||||
|
||||
if ( ! is_file( $filename ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$cached_stat = Transient::get( $cache_key );
|
||||
$stat = array_intersect_key(
|
||||
stat( $filename ),
|
||||
[
|
||||
'size' => 0,
|
||||
'mtime' => 0,
|
||||
'ctime' => 0,
|
||||
]
|
||||
);
|
||||
|
||||
if ( $cached_stat === $stat ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.unlink_unlink
|
||||
@unlink( $filename );
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Save file updated stat.
|
||||
*
|
||||
* @since 1.8.7
|
||||
*
|
||||
* @param string $filename Filename.
|
||||
* @param string $cache_key Cache key.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public static function save_file_updated_stat( string $filename, string $cache_key = '' ): void {
|
||||
|
||||
$filename = wp_normalize_path( $filename );
|
||||
$cache_key = $cache_key ? $cache_key : 'wpforms_' . $filename . '_file';
|
||||
|
||||
clearstatcache( true, $filename );
|
||||
|
||||
$stat = array_intersect_key(
|
||||
stat( $filename ),
|
||||
[
|
||||
'size' => 0,
|
||||
'mtime' => 0,
|
||||
'ctime' => 0,
|
||||
]
|
||||
);
|
||||
|
||||
Transient::set( $cache_key, $stat );
|
||||
}
|
||||
}
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
/**
|
||||
* Form helpers.
|
||||
*
|
||||
* @since 1.9.4
|
||||
*/
|
||||
class Form {
|
||||
|
||||
/**
|
||||
* Get form pro-fields array.
|
||||
*
|
||||
* @since 1.9.4
|
||||
*
|
||||
* @param array|mixed $form_data Form data.
|
||||
*
|
||||
* @return array Pro fields array.
|
||||
*/
|
||||
public static function get_form_pro_fields( $form_data ): array {
|
||||
|
||||
$fields = $form_data['fields'] ?? [];
|
||||
$pro_fields = [];
|
||||
|
||||
foreach ( $fields as $field_data ) {
|
||||
|
||||
/**
|
||||
* Filter form pro fields array.
|
||||
*
|
||||
* @since 1.9.4
|
||||
*
|
||||
* @param array $pro_fields Pro-fields data.
|
||||
* @param array $field_data Field data.
|
||||
*/
|
||||
$pro_fields = apply_filters( 'wpforms_helpers_form_pro_fields', $pro_fields, $field_data );
|
||||
}
|
||||
|
||||
return $pro_fields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get form addons educational data.
|
||||
*
|
||||
* @since 1.9.4
|
||||
*
|
||||
* @param array|mixed $form_data Form data.
|
||||
*
|
||||
* @return array The form addons educational data.
|
||||
*/
|
||||
public static function get_form_addons_edu_data( $form_data ): array {
|
||||
|
||||
$fields = $form_data['fields'] ?? [];
|
||||
$addons_edu_data = [];
|
||||
|
||||
foreach ( $fields as $field_data ) {
|
||||
/**
|
||||
* Filter the form addons educational data.
|
||||
*
|
||||
* @since 1.9.4
|
||||
*
|
||||
* @param array $addons_edu_data The form addons educational data.
|
||||
* @param array $field_data Field data.
|
||||
*/
|
||||
$addons_edu_data = apply_filters( 'wpforms_helpers_form_addons_edu_data', $addons_edu_data, $field_data );
|
||||
}
|
||||
|
||||
return $addons_edu_data;
|
||||
}
|
||||
}
|
||||
+68
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
/**
|
||||
* Helper to handle folder path parsing and processing.
|
||||
*
|
||||
* @since 1.10.0
|
||||
*/
|
||||
class PathParser {
|
||||
|
||||
/**
|
||||
* Split the folder path by "/" while preserving smart tags intact.
|
||||
*
|
||||
* Smart tags like {entry_date format="d/m/Y"} contain "/" in attributes
|
||||
* which should not be treated as path separators.
|
||||
*
|
||||
* Examples:
|
||||
* - /uploads/wpforms/tmp
|
||||
* - /uploads/wpforms/{date format="d/m/Y"}
|
||||
* - /uploads/wpforms/{entry_date format="d-m-Y"}
|
||||
*
|
||||
* @since 1.10.0
|
||||
*
|
||||
* @param string $folder_path Folder path with forward slashes.
|
||||
*
|
||||
* @return array Array of folder path parts with smart tags preserved.
|
||||
*/
|
||||
public static function split_folder( string $folder_path ): array {
|
||||
|
||||
$parts = [];
|
||||
$current_part = '';
|
||||
$inside_braces = 0;
|
||||
$length = strlen( $folder_path );
|
||||
|
||||
for ( $i = 0; $i < $length; $i++ ) {
|
||||
$char = $folder_path[ $i ];
|
||||
|
||||
if ( $char === '{' ) {
|
||||
++$inside_braces;
|
||||
} elseif ( $char === '}' ) {
|
||||
--$inside_braces;
|
||||
}
|
||||
|
||||
if ( $char === '/' && $inside_braces === 0 ) {
|
||||
$trimmed = trim( $current_part );
|
||||
|
||||
if ( ! wpforms_is_empty_string( $trimmed ) ) {
|
||||
$parts[] = $trimmed;
|
||||
}
|
||||
|
||||
$current_part = '';
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$current_part .= $char;
|
||||
}
|
||||
|
||||
$trimmed = trim( $current_part );
|
||||
|
||||
if ( ! wpforms_is_empty_string( $trimmed ) ) {
|
||||
$parts[] = $trimmed;
|
||||
}
|
||||
|
||||
return $parts;
|
||||
}
|
||||
}
|
||||
+614
@@ -0,0 +1,614 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
use WP_Error;
|
||||
use WP_Upgrader;
|
||||
use WP_Filesystem_Base;
|
||||
|
||||
/** \WP_Upgrader class */
|
||||
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
|
||||
|
||||
/** \Plugin_Upgrader class */
|
||||
require_once ABSPATH . 'wp-admin/includes/class-plugin-upgrader.php';
|
||||
|
||||
/**
|
||||
* In WP 5.3 a PHP 5.6 splat operator (...$args) was added to \WP_Upgrader_Skin::feedback().
|
||||
* We need to remove all calls to *Skin::feedback() method, as we can't override it in own Skins
|
||||
* without breaking support for PHP 5.3-5.5.
|
||||
*
|
||||
* @internal Please do not use this class outside of core WPForms development. May be removed at any time.
|
||||
*
|
||||
* @since 1.5.6.1
|
||||
*/
|
||||
class PluginSilentUpgrader extends \Plugin_Upgrader {
|
||||
|
||||
/**
|
||||
* Run an upgrade/installation.
|
||||
*
|
||||
* Attempt to download the package (if it is not a local file), unpack it, and
|
||||
* install it in the destination folder.
|
||||
*
|
||||
* @since 1.5.6.1
|
||||
*
|
||||
* @param array $options {
|
||||
* Array or string of arguments for upgrading/installing a package.
|
||||
*
|
||||
* @type string $package The full path or URI of the package to install.
|
||||
* Default empty.
|
||||
* @type string $destination The full path to the destination folder.
|
||||
* Default empty.
|
||||
* @type bool $clear_destination Whether to delete any files already in the
|
||||
* destination folder. Default false.
|
||||
* @type bool $clear_working Whether to delete the files form the working
|
||||
* directory after copying to the destination.
|
||||
* Default false.
|
||||
* @type bool $abort_if_destination_exists Whether to abort the installation if the destination
|
||||
* folder already exists. When true, `$clear_destination`
|
||||
* should be false. Default true.
|
||||
* @type bool $is_multi Whether this run is one of multiple upgrade/installation
|
||||
* actions being performed in bulk. When true, the skin
|
||||
* WP_Upgrader::header() and WP_Upgrader::footer()
|
||||
* aren't called. Default false.
|
||||
* @type array $hook_extra Extra arguments to pass to the filter hooks called by
|
||||
* WP_Upgrader::run().
|
||||
* }
|
||||
* @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error,
|
||||
* or false if unable to connect to the filesystem.
|
||||
*/
|
||||
public function run( $options ) {
|
||||
|
||||
$defaults = [
|
||||
'package' => '', // Please always pass this.
|
||||
'destination' => '', // And this
|
||||
'clear_destination' => false,
|
||||
'abort_if_destination_exists' => true, // Abort if the Destination directory exists, Pass clear_destination as false please
|
||||
'clear_working' => true,
|
||||
'is_multi' => false,
|
||||
'hook_extra' => [], // Pass any extra $hook_extra args here, this will be passed to any hooked filters.
|
||||
];
|
||||
|
||||
$options = wp_parse_args( $options, $defaults );
|
||||
|
||||
/**
|
||||
* Filter the package options before running an update.
|
||||
*
|
||||
* See also {@see 'upgrader_process_complete'}.
|
||||
*
|
||||
* @since 4.3.0
|
||||
*
|
||||
* @param array $options {
|
||||
* Options used by the upgrader.
|
||||
*
|
||||
* @type string $package Package for update.
|
||||
* @type string $destination Update location.
|
||||
* @type bool $clear_destination Clear the destination resource.
|
||||
* @type bool $clear_working Clear the working resource.
|
||||
* @type bool $abort_if_destination_exists Abort if the Destination directory exists.
|
||||
* @type bool $is_multi Whether the upgrader is running multiple times.
|
||||
* @type array $hook_extra {
|
||||
* Extra hook arguments.
|
||||
*
|
||||
* @type string $action Type of action. Default 'update'.
|
||||
* @type string $type Type of update process. Accepts 'plugin', 'theme', or 'core'.
|
||||
* @type bool $bulk Whether the update process is a bulk update. Default true.
|
||||
* @type string $plugin Path to the plugin file relative to the plugins directory.
|
||||
* @type string $theme The stylesheet or template name of the theme.
|
||||
* @type string $language_update_type The language pack update type. Accepts 'plugin', 'theme',
|
||||
* or 'core'.
|
||||
* @type object $language_update The language pack update offer.
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
$options = apply_filters( 'upgrader_package_options', $options );
|
||||
|
||||
if ( ! $options['is_multi'] ) { // call $this->header separately if running multiple times
|
||||
$this->skin->header();
|
||||
}
|
||||
|
||||
// Connect to the Filesystem first.
|
||||
$res = $this->fs_connect( [ WP_CONTENT_DIR, $options['destination'] ] );
|
||||
// Mainly for non-connected filesystem.
|
||||
if ( ! $res ) {
|
||||
if ( ! $options['is_multi'] ) {
|
||||
$this->skin->footer();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->skin->before();
|
||||
|
||||
if ( is_wp_error( $res ) ) {
|
||||
$this->skin->error( $res );
|
||||
$this->skin->after();
|
||||
if ( ! $options['is_multi'] ) {
|
||||
$this->skin->footer();
|
||||
}
|
||||
return $res;
|
||||
}
|
||||
|
||||
/*
|
||||
* Download the package (Note, This just returns the filename
|
||||
* of the file if the package is a local file)
|
||||
*/
|
||||
$download = $this->download_package( $options['package'], true );
|
||||
|
||||
// Allow for signature soft-fail.
|
||||
// WARNING: This may be removed in the future.
|
||||
if ( is_wp_error( $download ) && $download->get_error_data( 'softfail-filename' ) ) {
|
||||
|
||||
// Don't output the 'no signature could be found' failure message for now.
|
||||
if ( (string) $download->get_error_code() !== 'signature_verification_no_signature' || WP_DEBUG ) {
|
||||
// Outout the failure error as a normal feedback, and not as an error:
|
||||
//$this->skin->feedback( $download->get_error_message() );
|
||||
|
||||
// Report this failure back to WordPress.org for debugging purposes.
|
||||
wp_version_check(
|
||||
[
|
||||
'signature_failure_code' => $download->get_error_code(),
|
||||
'signature_failure_data' => $download->get_error_data(),
|
||||
]
|
||||
);
|
||||
}
|
||||
|
||||
// Pretend this error didn't happen.
|
||||
$download = $download->get_error_data( 'softfail-filename' );
|
||||
}
|
||||
|
||||
if ( is_wp_error( $download ) ) {
|
||||
$this->skin->error( $download );
|
||||
$this->skin->after();
|
||||
if ( ! $options['is_multi'] ) {
|
||||
$this->skin->footer();
|
||||
}
|
||||
return $download;
|
||||
}
|
||||
|
||||
$delete_package = ( (string) $download !== (string) $options['package'] ); // Do not delete a "local" file.
|
||||
|
||||
// Unzips the file into a temporary directory.
|
||||
$working_dir = $this->unpack_package( $download, $delete_package );
|
||||
if ( is_wp_error( $working_dir ) ) {
|
||||
$this->skin->error( $working_dir );
|
||||
$this->skin->after();
|
||||
if ( ! $options['is_multi'] ) {
|
||||
$this->skin->footer();
|
||||
}
|
||||
return $working_dir;
|
||||
}
|
||||
|
||||
// With the given options, this installs it to the destination directory.
|
||||
$result = $this->install_package(
|
||||
[
|
||||
'source' => $working_dir,
|
||||
'destination' => $options['destination'],
|
||||
'clear_destination' => $options['clear_destination'],
|
||||
'abort_if_destination_exists' => $options['abort_if_destination_exists'],
|
||||
'clear_working' => $options['clear_working'],
|
||||
'hook_extra' => $options['hook_extra'],
|
||||
]
|
||||
);
|
||||
|
||||
$this->skin->set_result( $result );
|
||||
if ( is_wp_error( $result ) ) {
|
||||
$this->skin->error( $result );
|
||||
//$this->skin->feedback( 'process_failed' );
|
||||
} else {
|
||||
// Installation succeeded.
|
||||
//$this->skin->feedback( 'process_success' );
|
||||
}
|
||||
|
||||
$this->skin->after();
|
||||
|
||||
if ( ! $options['is_multi'] ) {
|
||||
|
||||
/**
|
||||
* Fire when the upgrader process is complete.
|
||||
*
|
||||
* See also {@see 'upgrader_package_options'}.
|
||||
*
|
||||
* @since 3.6.0
|
||||
* @since 3.7.0 Added to WP_Upgrader::run().
|
||||
* @since 4.6.0 `$translations` was added as a possible argument to `$hook_extra`.
|
||||
*
|
||||
* @param WP_Upgrader $this WP_Upgrader instance. In other contexts, $this, might be a
|
||||
* Theme_Upgrader, Plugin_Upgrader, Core_Upgrade, or
|
||||
* Language_Pack_Upgrader instance.
|
||||
* @param array $hook_extra {
|
||||
* Array of bulk item update data.
|
||||
*
|
||||
* @type string $action Type of action. Default 'update'.
|
||||
* @type string $type Type of update process. Accepts 'plugin', 'theme', 'translation', or 'core'.
|
||||
* @type bool $bulk Whether the update process is a bulk update. Default true.
|
||||
* @type array $plugins Array of the basename paths of the plugins' main files.
|
||||
* @type array $themes The theme slugs.
|
||||
* @type array $translations {
|
||||
* Array of translations update data.
|
||||
*
|
||||
* @type string $language The locale the translation is for.
|
||||
* @type string $type Type of translation. Accepts 'plugin', 'theme', or 'core'.
|
||||
* @type string $slug Text domain the translation is for. The slug of a theme/plugin or
|
||||
* 'default' for core translations.
|
||||
* @type string $version The version of a theme, plugin, or core.
|
||||
* }
|
||||
* }
|
||||
*/
|
||||
do_action( 'upgrader_process_complete', $this, $options['hook_extra'] );
|
||||
|
||||
$this->skin->footer();
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Toggle maintenance mode for the site.
|
||||
*
|
||||
* Create/delete the maintenance file to enable/disable maintenance mode.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @global WP_Filesystem_Base $wp_filesystem Subclass
|
||||
*
|
||||
* @param bool $enable True to enable maintenance mode, false to disable.
|
||||
*/
|
||||
public function maintenance_mode( $enable = false ) {
|
||||
global $wp_filesystem;
|
||||
$file = $wp_filesystem->abspath() . '.maintenance';
|
||||
if ( $enable ) {
|
||||
//$this->skin->feedback( 'maintenance_start' );
|
||||
// Create maintenance file to signal that we are upgrading
|
||||
$maintenance_string = '<?php $upgrading = ' . time() . '; ?>';
|
||||
$wp_filesystem->delete( $file );
|
||||
$wp_filesystem->put_contents( $file, $maintenance_string, FS_CHMOD_FILE );
|
||||
} elseif ( ! $enable && $wp_filesystem->exists( $file ) ) {
|
||||
//$this->skin->feedback( 'maintenance_end' );
|
||||
$wp_filesystem->delete( $file );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Download a package.
|
||||
*
|
||||
* @since 2.8.0
|
||||
* @since 5.5.0 Added the `$hook_extra` parameter.
|
||||
*
|
||||
* @param string $package The URI of the package. If this is the full path to an
|
||||
* existing local file, it will be returned untouched.
|
||||
* @param bool $check_signatures Whether to validate file signatures. Default false.
|
||||
* @param array $hook_extra Extra arguments to pass to the filter hooks. Default empty array.
|
||||
* @return string|WP_Error The full path to the downloaded package file, or a WP_Error object.
|
||||
*/
|
||||
public function download_package( $package, $check_signatures = false, $hook_extra = [] ) {
|
||||
|
||||
/**
|
||||
* Filters whether to return the package.
|
||||
*
|
||||
* @since 3.7.0
|
||||
* @since 5.5.0 Added the `$hook_extra` parameter.
|
||||
*
|
||||
* @param bool $reply Whether to bail without returning the package.
|
||||
* Default false.
|
||||
* @param string $package The package file name.
|
||||
* @param WP_Upgrader $this The WP_Upgrader instance.
|
||||
* @param array $hook_extra Extra arguments passed to hooked filters.
|
||||
*/
|
||||
$reply = apply_filters( 'upgrader_pre_download', false, $package, $this, $hook_extra );
|
||||
if ( false !== $reply ) {
|
||||
return $reply;
|
||||
}
|
||||
|
||||
if ( ! preg_match( '!^(http|https|ftp)://!i', $package ) && file_exists( $package ) ) { // Local file or remote?
|
||||
return $package; // Must be a local file.
|
||||
}
|
||||
|
||||
if ( empty( $package ) ) {
|
||||
return new WP_Error( 'no_package', $this->strings['no_package'] );
|
||||
}
|
||||
|
||||
//$this->skin->feedback( 'downloading_package', $package );
|
||||
|
||||
$download_file = download_url( $package, 300, $check_signatures );
|
||||
|
||||
if ( is_wp_error( $download_file ) && ! $download_file->get_error_data( 'softfail-filename' ) ) {
|
||||
return new WP_Error( 'download_failed', $this->strings['download_failed'], $download_file->get_error_message() );
|
||||
}
|
||||
|
||||
return $download_file;
|
||||
}
|
||||
|
||||
/**
|
||||
* Unpack a compressed package file.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
|
||||
*
|
||||
* @param string $package Full path to the package file.
|
||||
* @param bool $delete_package Optional. Whether to delete the package file after attempting
|
||||
* to unpack it. Default true.
|
||||
* @return string|WP_Error The path to the unpacked contents, or a WP_Error on failure.
|
||||
*/
|
||||
public function unpack_package( $package, $delete_package = true ) {
|
||||
global $wp_filesystem;
|
||||
|
||||
//$this->skin->feedback( 'unpack_package' );
|
||||
|
||||
$upgrade_folder = $wp_filesystem->wp_content_dir() . 'upgrade/';
|
||||
|
||||
//Clean up contents of upgrade directory beforehand.
|
||||
$upgrade_files = $wp_filesystem->dirlist( $upgrade_folder );
|
||||
if ( ! empty( $upgrade_files ) ) {
|
||||
foreach ( $upgrade_files as $file ) {
|
||||
$wp_filesystem->delete( $upgrade_folder . $file['name'], true );
|
||||
}
|
||||
}
|
||||
|
||||
// We need a working directory - Strip off any .tmp or .zip suffixes
|
||||
$working_dir = $upgrade_folder . basename( basename( $package, '.tmp' ), '.zip' );
|
||||
|
||||
// Clean up working directory
|
||||
if ( $wp_filesystem->is_dir( $working_dir ) ) {
|
||||
$wp_filesystem->delete( $working_dir, true );
|
||||
}
|
||||
|
||||
// Unzip package to working directory
|
||||
$result = unzip_file( $package, $working_dir );
|
||||
|
||||
// Once extracted, delete the package if required.
|
||||
if ( $delete_package ) {
|
||||
// phpcs:ignore WordPress.WP.AlternativeFunctions.unlink_unlink
|
||||
unlink( $package );
|
||||
}
|
||||
|
||||
if ( is_wp_error( $result ) ) {
|
||||
$wp_filesystem->delete( $working_dir, true );
|
||||
if ( $result->get_error_code() === 'incompatible_archive' ) {
|
||||
return new WP_Error( 'incompatible_archive', $this->strings['incompatible_archive'], $result->get_error_data() );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
return $working_dir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Install a package.
|
||||
*
|
||||
* Copies the contents of a package form a source directory, and installs them in
|
||||
* a destination directory. Optionally removes the source. It can also optionally
|
||||
* clear out the destination folder if it already exists.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
|
||||
* @global array $wp_theme_directories
|
||||
*
|
||||
* @param array|string $args {
|
||||
* Optional. Array or string of arguments for installing a package. Default empty array.
|
||||
*
|
||||
* @type string $source Required path to the package source. Default empty.
|
||||
* @type string $destination Required path to a folder to install the package in.
|
||||
* Default empty.
|
||||
* @type bool $clear_destination Whether to delete any files already in the destination
|
||||
* folder. Default false.
|
||||
* @type bool $clear_working Whether to delete the files form the working directory
|
||||
* after copying to the destination. Default false.
|
||||
* @type bool $abort_if_destination_exists Whether to abort the installation if
|
||||
* the destination folder already exists. Default true.
|
||||
* @type array $hook_extra Extra arguments to pass to the filter hooks called by
|
||||
* WP_Upgrader::install_package(). Default empty array.
|
||||
* }
|
||||
*
|
||||
* @return array|WP_Error The result (also stored in `WP_Upgrader::$result`), or a WP_Error on failure.
|
||||
*/
|
||||
public function install_package( $args = [] ) {
|
||||
|
||||
global $wp_filesystem, $wp_theme_directories;
|
||||
|
||||
$defaults = [
|
||||
'source' => '', // Please always pass this
|
||||
'destination' => '', // and this
|
||||
'clear_destination' => false,
|
||||
'clear_working' => false,
|
||||
'abort_if_destination_exists' => true,
|
||||
'hook_extra' => [],
|
||||
];
|
||||
|
||||
$args = wp_parse_args( $args, $defaults );
|
||||
|
||||
// These were previously extract()'d.
|
||||
$source = $args['source'];
|
||||
$destination = $args['destination'];
|
||||
$clear_destination = $args['clear_destination'];
|
||||
|
||||
wpforms_set_time_limit( 300 );
|
||||
|
||||
if ( empty( $source ) || empty( $destination ) ) {
|
||||
return new WP_Error( 'bad_request', $this->strings['bad_request'] );
|
||||
}
|
||||
//$this->skin->feedback( 'installing_package' );
|
||||
|
||||
/**
|
||||
* Filter the install response before the installation has started.
|
||||
*
|
||||
* Returning a truthy value, or one that could be evaluated as a WP_Error
|
||||
* will effectively short-circuit the installation, returning that value
|
||||
* instead.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @param bool|WP_Error $response Response.
|
||||
* @param array $hook_extra Extra arguments passed to hooked filters.
|
||||
*/
|
||||
$res = apply_filters( 'upgrader_pre_install', true, $args['hook_extra'] );
|
||||
|
||||
if ( is_wp_error( $res ) ) {
|
||||
return $res;
|
||||
}
|
||||
|
||||
// Retain the Original source and destinations.
|
||||
$remote_source = $args['source'];
|
||||
$local_destination = $destination;
|
||||
|
||||
$source_files = array_keys( $wp_filesystem->dirlist( $remote_source ) );
|
||||
$remote_destination = $wp_filesystem->find_folder( $local_destination );
|
||||
$count_source_files = count( $source_files );
|
||||
|
||||
// Locate which directory to copy to the new folder, This is based on the actual folder holding the files.
|
||||
if ( $count_source_files === 1 && $wp_filesystem->is_dir( trailingslashit( $args['source'] ) . $source_files[0] . '/' ) ) { // Only one folder? Then we want its contents.
|
||||
$source = trailingslashit( $args['source'] ) . trailingslashit( $source_files[0] );
|
||||
} elseif ( $count_source_files === 0 ) {
|
||||
return new WP_Error( 'incompatible_archive_empty', $this->strings['incompatible_archive'], $this->strings['no_files'] ); // There are no files?
|
||||
} else { // It's only a single file, the upgrader will use the folder name of this file as the destination folder. Folder name is based on zip filename.
|
||||
$source = trailingslashit( $args['source'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the source file location for the upgrade package.
|
||||
*
|
||||
* @since 2.8.0
|
||||
* @since 4.4.0 The $hook_extra parameter became available.
|
||||
*
|
||||
* @param string $source File source location.
|
||||
* @param string $remote_source Remote file source location.
|
||||
* @param WP_Upgrader $this WP_Upgrader instance.
|
||||
* @param array $hook_extra Extra arguments passed to hooked filters.
|
||||
*/
|
||||
$source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this, $args['hook_extra'] );
|
||||
|
||||
if ( is_wp_error( $source ) ) {
|
||||
return $source;
|
||||
}
|
||||
|
||||
// Has the source location changed? If so, we need a new source_files list.
|
||||
if ( $source !== $remote_source ) {
|
||||
$source_files = array_keys( $wp_filesystem->dirlist( $source ) );
|
||||
}
|
||||
|
||||
/*
|
||||
* Protection against deleting files in any important base directories.
|
||||
* Theme_Upgrader & Plugin_Upgrader also trigger this, as they pass the
|
||||
* destination directory (WP_PLUGIN_DIR / wp-content/themes) intending
|
||||
* to copy the directory into the directory, whilst they pass the source
|
||||
* as the actual files to copy.
|
||||
*/
|
||||
$protected_directories = [ ABSPATH, WP_CONTENT_DIR, WP_PLUGIN_DIR, WP_CONTENT_DIR . '/themes' ];
|
||||
|
||||
if ( is_array( $wp_theme_directories ) ) {
|
||||
$protected_directories = array_merge( $protected_directories, $wp_theme_directories );
|
||||
}
|
||||
|
||||
if ( in_array( $destination, $protected_directories ) ) {
|
||||
$remote_destination = trailingslashit( $remote_destination ) . trailingslashit( basename( $source ) );
|
||||
$destination = trailingslashit( $destination ) . trailingslashit( basename( $source ) );
|
||||
}
|
||||
|
||||
if ( $clear_destination ) {
|
||||
// We're going to clear the destination if there's something there.
|
||||
$removed = $this->clear_destination( $remote_destination );
|
||||
|
||||
/**
|
||||
* Filter whether the upgrader cleared the destination.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @param mixed $removed Whether the destination was cleared. true on success, WP_Error on failure.
|
||||
* @param string $local_destination The local package destination.
|
||||
* @param string $remote_destination The remote package destination.
|
||||
* @param array $hook_extra Extra arguments passed to hooked filters.
|
||||
*/
|
||||
$removed = apply_filters( 'upgrader_clear_destination', $removed, $local_destination, $remote_destination, $args['hook_extra'] );
|
||||
|
||||
if ( is_wp_error( $removed ) ) {
|
||||
return $removed;
|
||||
}
|
||||
} elseif ( $args['abort_if_destination_exists'] && $wp_filesystem->exists( $remote_destination ) ) {
|
||||
// If we're not clearing the destination folder and something exists there already, Bail.
|
||||
// But first check to see if there are actually any files in the folder.
|
||||
$_files = $wp_filesystem->dirlist( $remote_destination );
|
||||
|
||||
if ( ! empty( $_files ) ) {
|
||||
$wp_filesystem->delete( $remote_source, true ); // Clear out the source files.
|
||||
|
||||
return new WP_Error( 'folder_exists', $this->strings['folder_exists'], $remote_destination );
|
||||
}
|
||||
}
|
||||
|
||||
// Create destination if needed.
|
||||
if ( ! $wp_filesystem->exists( $remote_destination ) ) {
|
||||
if ( ! $wp_filesystem->mkdir( $remote_destination, FS_CHMOD_DIR ) ) {
|
||||
return new WP_Error( 'mkdir_failed_destination', $this->strings['mkdir_failed'], $remote_destination );
|
||||
}
|
||||
}
|
||||
|
||||
// Copy new version of item into place.
|
||||
$result = copy_dir( $source, $remote_destination );
|
||||
|
||||
if ( is_wp_error( $result ) ) {
|
||||
if ( $args['clear_working'] ) {
|
||||
$wp_filesystem->delete( $remote_source, true );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Clear the Working folder?
|
||||
if ( $args['clear_working'] ) {
|
||||
$wp_filesystem->delete( $remote_source, true );
|
||||
}
|
||||
|
||||
$destination_name = basename( str_replace( $local_destination, '', $destination ) );
|
||||
|
||||
if ( $destination_name === '.' ) {
|
||||
$destination_name = '';
|
||||
}
|
||||
|
||||
$this->result = compact( 'source', 'source_files', 'destination', 'destination_name', 'local_destination', 'remote_destination', 'clear_destination' );
|
||||
|
||||
/**
|
||||
* Filter the installation response after the installation has finished.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @param bool $response Installation response.
|
||||
* @param array $hook_extra Extra arguments passed to hooked filters.
|
||||
* @param array $result Installation result data.
|
||||
*/
|
||||
$res = apply_filters( 'upgrader_post_install', true, $args['hook_extra'], $this->result );
|
||||
|
||||
if ( is_wp_error( $res ) ) {
|
||||
$this->result = $res;
|
||||
|
||||
return $res;
|
||||
}
|
||||
|
||||
// Bombard the calling function will all the info which we've just used.
|
||||
return $this->result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Install a plugin package.
|
||||
*
|
||||
* @since 1.6.3
|
||||
*
|
||||
* @param string $package The full local path or URI of the package.
|
||||
* @param array $args Optional. Other arguments for installing a plugin package. Default empty array.
|
||||
*
|
||||
* @return bool|\WP_Error True if the installation was successful, false or a WP_Error otherwise.
|
||||
*/
|
||||
public function install( $package, $args = [] ) {
|
||||
|
||||
$result = parent::install( $package, $args );
|
||||
if ( true === $result ) {
|
||||
do_action( 'wpforms_plugin_installed', $package );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
}
|
||||
+225
@@ -0,0 +1,225 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
/**
|
||||
* Template related helper methods.
|
||||
*
|
||||
* @since 1.5.4
|
||||
*/
|
||||
class Templates {
|
||||
|
||||
/**
|
||||
* Return a list of paths to check for template locations
|
||||
*
|
||||
* @since 1.5.4
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public static function get_theme_template_paths() {
|
||||
|
||||
$template_dir = 'wpforms';
|
||||
|
||||
$file_paths = [
|
||||
1 => trailingslashit( get_stylesheet_directory() ) . $template_dir,
|
||||
10 => trailingslashit( get_template_directory() ) . $template_dir,
|
||||
200 => trailingslashit( WPFORMS_PLUGIN_DIR ) . 'templates',
|
||||
];
|
||||
|
||||
$file_paths = \apply_filters( 'wpforms_helpers_templates_get_theme_template_paths', $file_paths );
|
||||
|
||||
// Sort the file paths based on priority.
|
||||
\ksort( $file_paths, SORT_NUMERIC );
|
||||
|
||||
return \array_map( 'trailingslashit', $file_paths );
|
||||
}
|
||||
|
||||
/**
|
||||
* Locate a template and return the path for inclusion.
|
||||
*
|
||||
* @since 1.5.4
|
||||
*
|
||||
* @param string $template_name Template name.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function locate( $template_name ) {
|
||||
|
||||
// Trim off any slashes from the template name.
|
||||
$template_name = \ltrim( $template_name, '/' );
|
||||
|
||||
if ( empty( $template_name ) ) {
|
||||
return \apply_filters( 'wpforms_helpers_templates_locate', '', $template_name );
|
||||
}
|
||||
|
||||
$located = '';
|
||||
|
||||
// Try locating this template file by looping through the template paths.
|
||||
foreach ( self::get_theme_template_paths() as $template_path ) {
|
||||
if ( \file_exists( $template_path . $template_name ) ) {
|
||||
$located = $template_path . $template_name;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return \apply_filters( 'wpforms_helpers_templates_locate', $located, $template_name );
|
||||
}
|
||||
|
||||
/**
|
||||
* Include a template.
|
||||
* Use 'require' if $args are passed or 'load_template' if not.
|
||||
*
|
||||
* @since 1.5.4
|
||||
*
|
||||
* @param string $template_name Template name.
|
||||
* @param array $args Arguments.
|
||||
* @param bool $extract Extract arguments.
|
||||
*
|
||||
* @throws \RuntimeException If extract() tries to modify the scope.
|
||||
*/
|
||||
public static function include_html( $template_name, $args = [], $extract = false ) {
|
||||
|
||||
$template_name .= '.php';
|
||||
|
||||
// Allow 3rd party plugins to filter template file from their plugin.
|
||||
$located = \apply_filters( 'wpforms_helpers_templates_include_html_located', self::locate( $template_name ), $template_name, $args, $extract );
|
||||
$args = \apply_filters( 'wpforms_helpers_templates_include_html_args', $args, $template_name, $extract );
|
||||
|
||||
if ( empty( $located ) || ! \is_readable( $located ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Load template WP way if no arguments were passed.
|
||||
if ( empty( $args ) ) {
|
||||
\load_template( $located, false );
|
||||
return;
|
||||
}
|
||||
|
||||
$extract = \apply_filters( 'wpforms_helpers_templates_include_html_extract_args', $extract, $template_name, $args );
|
||||
|
||||
if ( $extract && \is_array( $args ) ) {
|
||||
|
||||
$created_vars_count = extract( $args, EXTR_SKIP ); // phpcs:ignore WordPress.PHP.DontExtract
|
||||
|
||||
// Protecting existing scope from modification.
|
||||
if ( count( $args ) !== $created_vars_count ) {
|
||||
throw new \RuntimeException( 'Extraction failed: variable names are clashing with the existing ones.' );
|
||||
}
|
||||
}
|
||||
|
||||
require $located;
|
||||
}
|
||||
|
||||
/**
|
||||
* Like self::include_html, but returns the HTML instead of including.
|
||||
*
|
||||
* @since 1.5.4
|
||||
*
|
||||
* @param string $template_name Template name.
|
||||
* @param array $args Arguments.
|
||||
* @param bool $extract Extract arguments.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function get_html( $template_name, $args = [], $extract = false ) {
|
||||
|
||||
\ob_start();
|
||||
self::include_html( $template_name, $args, $extract );
|
||||
return \ob_get_clean();
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate that a file path is safe and within the expected path(s).
|
||||
*
|
||||
* Author Scott Kingsley Clark, Pods Framework.
|
||||
* Refactored to reduce cyclomatic complexity.
|
||||
*
|
||||
* @since 1.7.5.5
|
||||
*
|
||||
* @link https://github.com/pods-framework/pods/commit/ea53471e58e638dec06957edc38f9fa86607652c
|
||||
*
|
||||
* @param string $path The file path.
|
||||
* @param null|array|string $paths_to_check The list of path types to check, defaults to just checking 'wpforms'.
|
||||
* Available: 'wpforms', 'plugins', 'theme',
|
||||
* or 'all' to check all supported paths.
|
||||
*
|
||||
* @return false|string False if the path was not allowed or did not exist, otherwise it returns the normalized path.
|
||||
*/
|
||||
public static function validate_safe_path( $path, $paths_to_check = null ) {
|
||||
|
||||
static $available_checks;
|
||||
|
||||
if ( ! $available_checks ) {
|
||||
$available_checks = [
|
||||
'wpforms' => realpath( WPFORMS_PLUGIN_DIR ),
|
||||
'plugins' => [
|
||||
realpath( WP_PLUGIN_DIR ),
|
||||
realpath( WPMU_PLUGIN_DIR ),
|
||||
],
|
||||
'theme' => [
|
||||
realpath( get_stylesheet_directory() ),
|
||||
realpath( get_template_directory() ),
|
||||
],
|
||||
];
|
||||
|
||||
$available_checks['plugins'] = array_unique( array_filter( $available_checks['plugins'] ) );
|
||||
$available_checks['theme'] = array_unique( array_filter( $available_checks['theme'] ) );
|
||||
$available_checks = array_filter( $available_checks );
|
||||
}
|
||||
|
||||
$paths_to_check = $paths_to_check === null ? [ 'wpforms' ] : $paths_to_check;
|
||||
$paths_to_check = $paths_to_check === 'all' ? array_keys( $available_checks ) : $paths_to_check;
|
||||
$paths_to_check = (array) $paths_to_check;
|
||||
|
||||
if ( empty( $paths_to_check ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$path = wp_normalize_path( trim( (string) $path ) );
|
||||
|
||||
$match_count = 1;
|
||||
|
||||
// Replace the ../ usage as many times as it may need to be replaced.
|
||||
while ( $match_count ) {
|
||||
$path = str_replace( '../', '', $path, $match_count );
|
||||
}
|
||||
|
||||
$path = realpath( $path );
|
||||
|
||||
foreach ( $paths_to_check as $check_type ) {
|
||||
if ( self::has_match( $path, $available_checks, $check_type ) ) {
|
||||
return $path;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Whether path matches.
|
||||
*
|
||||
* @since 1.7.5.5
|
||||
*
|
||||
* @param string|bool $path Path.
|
||||
* @param array $available_checks Available checks.
|
||||
* @param string $check_type Check type.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private static function has_match( $path, $available_checks, $check_type ) {
|
||||
|
||||
if ( ! $path || ! isset( $available_checks[ $check_type ] ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$check_type_paths = (array) $available_checks[ $check_type ];
|
||||
|
||||
foreach ( $check_type_paths as $path_to_check ) {
|
||||
if ( 0 === strpos( $path, $path_to_check ) && file_exists( $path ) ) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
+279
@@ -0,0 +1,279 @@
|
||||
<?php
|
||||
|
||||
namespace WPForms\Helpers;
|
||||
|
||||
/**
|
||||
* WPForms Transients implementation.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*/
|
||||
class Transient {
|
||||
|
||||
/**
|
||||
* Transient option name prefix.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
const OPTION_PREFIX = '_wpforms_transient_';
|
||||
|
||||
/**
|
||||
* Transient timeout option name prefix.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
const TIMEOUT_PREFIX = '_wpforms_transient_timeout_';
|
||||
|
||||
/**
|
||||
* Get the value of a transient.
|
||||
*
|
||||
* If the transient does not exist, does not have a value, or has expired,
|
||||
* then the return value will be false.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return mixed Value of transient.
|
||||
*/
|
||||
public static function get( $transient ) {
|
||||
|
||||
$transient_option = self::OPTION_PREFIX . $transient;
|
||||
$transient_timeout = self::TIMEOUT_PREFIX . $transient;
|
||||
|
||||
$alloptions = wp_load_alloptions();
|
||||
|
||||
// If option is not in alloptions, it is not autoloaded and thus has a timeout to check.
|
||||
if ( ! isset( $alloptions[ $transient_option ] ) ) {
|
||||
$is_expired = self::is_expired( $transient );
|
||||
}
|
||||
|
||||
// Return the data if it's not expired.
|
||||
if ( empty( $is_expired ) ) {
|
||||
return self::get_option( $transient );
|
||||
}
|
||||
|
||||
delete_option( $transient_option );
|
||||
delete_option( $transient_timeout );
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set/update the value of a transient.
|
||||
*
|
||||
* You do not need to serialize values. If the value needs to be serialized, then
|
||||
* it will be serialized before it is set.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped. Must be
|
||||
* 164 characters or fewer.
|
||||
* @param mixed $value Transient value. Must be serializable if non-scalar.
|
||||
* Expected to not be SQL-escaped.
|
||||
* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).
|
||||
*
|
||||
* @return bool False if value was not set and true if value was set.
|
||||
*/
|
||||
public static function set( $transient, $value, $expiration = 0 ) {
|
||||
|
||||
if ( false === self::get_option( $transient ) ) {
|
||||
return self::add( $transient, $value, $expiration );
|
||||
}
|
||||
|
||||
return self::update( $transient, $value, $expiration );
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new transient with a given value.
|
||||
*
|
||||
* Internal method, use Transient::set() instead.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped. Must be
|
||||
* 164 characters or fewer.
|
||||
* @param mixed $value Transient value. Must be serializable if non-scalar.
|
||||
* Expected to not be SQL-escaped.
|
||||
* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).
|
||||
*
|
||||
* @return bool False if value was not set and true if value was set.
|
||||
*/
|
||||
private static function add( $transient, $value, $expiration ) {
|
||||
|
||||
if ( $expiration ) {
|
||||
add_option( self::TIMEOUT_PREFIX . $transient, time() + $expiration, '', 'no' );
|
||||
}
|
||||
|
||||
// If there's an expiration, the option won't be autoloaded.
|
||||
return add_option( self::OPTION_PREFIX . $transient, $value, '', $expiration ? 'no' : 'yes' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the value of a transient.
|
||||
*
|
||||
* Internal method, use Transient::set() instead.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped. Must be
|
||||
* 164 characters or fewer.
|
||||
* @param mixed $value Transient value. Must be serializable if non-scalar.
|
||||
* Expected to not be SQL-escaped.
|
||||
* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).
|
||||
*
|
||||
* @return bool False if value was not set and true if value was set.
|
||||
*/
|
||||
private static function update( $transient, $value, $expiration ) {
|
||||
|
||||
$transient_option = self::OPTION_PREFIX . $transient;
|
||||
$transient_timeout = self::TIMEOUT_PREFIX . $transient;
|
||||
|
||||
if ( ! $expiration ) {
|
||||
return update_option( $transient_option, $value );
|
||||
}
|
||||
|
||||
$timeout = self::get_timeout( $transient );
|
||||
|
||||
if ( $timeout !== false ) {
|
||||
update_option( $transient_timeout, time() + $expiration );
|
||||
|
||||
return update_option( $transient_option, $value );
|
||||
}
|
||||
|
||||
// If expiration is requested, but the transient has no timeout option,
|
||||
// delete, then re-create transient rather than update.
|
||||
delete_option( $transient_option );
|
||||
add_option( $transient_timeout, time() + $expiration, '', 'no' );
|
||||
|
||||
return add_option( $transient_option, $value, '', 'no' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a transient.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return bool true if successful, false otherwise
|
||||
*/
|
||||
public static function delete( $transient ) {
|
||||
|
||||
$result = delete_option( self::OPTION_PREFIX . $transient );
|
||||
|
||||
if ( $result ) {
|
||||
delete_option( self::TIMEOUT_PREFIX . $transient );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete all WPForms transients.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @return int|false Number of rows affected/selected or false on error
|
||||
*/
|
||||
public static function delete_all() {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
return $wpdb->query(
|
||||
$wpdb->prepare(
|
||||
"DELETE FROM $wpdb->options
|
||||
WHERE option_name LIKE %s",
|
||||
$wpdb->esc_like( self::OPTION_PREFIX ) . '%'
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete all expired WPForms transients.
|
||||
*
|
||||
* The multi-table delete syntax is used to delete the transient record
|
||||
* from table 'a', and the corresponding transient_timeout record from table 'b'.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @return int|false Number of rows affected/selected or false on error
|
||||
*/
|
||||
public static function delete_all_expired() {
|
||||
|
||||
global $wpdb;
|
||||
|
||||
// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
|
||||
return $wpdb->query(
|
||||
$wpdb->prepare(
|
||||
"DELETE a, b FROM $wpdb->options a, $wpdb->options b
|
||||
WHERE a.option_name LIKE %s
|
||||
AND a.option_name NOT LIKE %s
|
||||
AND b.option_name = CONCAT( %s, SUBSTRING( a.option_name, %d ) )
|
||||
AND b.option_value < %d",
|
||||
$wpdb->esc_like( self::OPTION_PREFIX ) . '%',
|
||||
$wpdb->esc_like( self::TIMEOUT_PREFIX ) . '%',
|
||||
self::TIMEOUT_PREFIX,
|
||||
strlen( self::OPTION_PREFIX ) + 1,
|
||||
time()
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if transient is expired.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return bool true if expired, false otherwise
|
||||
*/
|
||||
public static function is_expired( $transient ) {
|
||||
|
||||
$timeout = self::get_timeout( $transient );
|
||||
|
||||
// If there's no timeout data found, the transient is considered to be valid.
|
||||
if ( $timeout === false ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( $timeout >= time() ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a transient option value.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return mixed Value set for the option.
|
||||
*/
|
||||
private static function get_option( $transient ) {
|
||||
|
||||
return get_option( self::OPTION_PREFIX . $transient );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a transient timeout option value.
|
||||
*
|
||||
* @since 1.6.3.1
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
*
|
||||
* @return mixed Value set for the option.
|
||||
*/
|
||||
private static function get_timeout( $transient ) {
|
||||
|
||||
return get_option( self::TIMEOUT_PREFIX . $transient );
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user