<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Addons;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Helpers\CacheBase;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Addons cache handler.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.6.6

[9] Fix | Delete

*/

[10] Fix | Delete

class AddonsCache extends CacheBase {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Remote source URL.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.8.9

[16] Fix | Delete

*

[17] Fix | Delete

* @var string

[18] Fix | Delete

*/

[19] Fix | Delete

const REMOTE_SOURCE = 'https://wpformsapi.com/feeds/v1/addons/';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Determine if the class is allowed to load.

[23] Fix | Delete

*

[24] Fix | Delete

* @since 1.6.8

[25] Fix | Delete

*

[26] Fix | Delete

* @return bool

[27] Fix | Delete

*/

[28] Fix | Delete

protected function allow_load() {

[29] Fix | Delete

[30] Fix | Delete

if ( wp_doing_cron() || wpforms_doing_wp_cli() ) {

[31] Fix | Delete

return true;

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

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

[35] Fix | Delete

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

[36] Fix | Delete

[37] Fix | Delete

return $has_permissions && $allowed_requests;

[38] Fix | Delete

}

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Provide settings.

[42] Fix | Delete

*

[43] Fix | Delete

* @since 1.6.6

[44] Fix | Delete

*

[45] Fix | Delete

* @return array Settings array.

[46] Fix | Delete

*/

[47] Fix | Delete

protected function setup() {

[48] Fix | Delete

[49] Fix | Delete

return [

[50] Fix | Delete

[51] Fix | Delete

// Remote source URL.

[52] Fix | Delete

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

[53] Fix | Delete

[54] Fix | Delete

// Addons cache file name.

[55] Fix | Delete

'cache_file' => 'addons.json',

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Time-to-live of the addons cache file in seconds.

[59] Fix | Delete

*

[60] Fix | Delete

* This applies to `uploads/wpforms/cache/addons.json` file.

[61] Fix | Delete

*

[62] Fix | Delete

* @since 1.6.8

[63] Fix | Delete

*

[64] Fix | Delete

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

[65] Fix | Delete

* Default value: WEEK_IN_SECONDS.

[66] Fix | Delete

*/

[67] Fix | Delete

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

[68] Fix | Delete

[69] Fix | Delete

// Scheduled update action.

[70] Fix | Delete

'update_action' => 'wpforms_admin_addons_cache_update',

[71] Fix | Delete

];

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Get remote source URL.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 1.8.9

[78] Fix | Delete

*

[79] Fix | Delete

* @return string

[80] Fix | Delete

*/

[81] Fix | Delete

protected function get_remote_source(): string {

[82] Fix | Delete

[83] Fix | Delete

return defined( 'WPFORMS_ADDONS_REMOTE_SOURCE' ) ? WPFORMS_ADDONS_REMOTE_SOURCE : self::REMOTE_SOURCE;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

/**

[87] Fix | Delete

* Prepare addons data to store in a local cache -

[88] Fix | Delete

* generate addons icon image file name for further use.

[89] Fix | Delete

*

[90] Fix | Delete

* @since 1.6.6

[91] Fix | Delete

*

[92] Fix | Delete

* @param array $data Raw addons data.

[93] Fix | Delete

*

[94] Fix | Delete

* @return array Prepared data for caching (with icons).

[95] Fix | Delete

*/

[96] Fix | Delete

protected function prepare_cache_data( $data ): array {

[97] Fix | Delete

[98] Fix | Delete

if ( empty( $data ) || ! is_array( $data ) ) {

[99] Fix | Delete

return [];

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

$addons_cache = [];

[103] Fix | Delete

[104] Fix | Delete

foreach ( $data as $addon ) {

[105] Fix | Delete

[106] Fix | Delete

// Addon icon.

[107] Fix | Delete

$addon['icon'] = str_replace( 'wpforms-', 'addon-icon-', $addon['slug'] ) . '.png';

[108] Fix | Delete

[109] Fix | Delete

// Special case when plugin addon renamed, for instance:

[110] Fix | Delete

// Sendinblue to Brevo, or ConvertKit to Kit,

[111] Fix | Delete

// but we keep the old slug for compatibility.

[112] Fix | Delete

foreach (

[113] Fix | Delete

[

[114] Fix | Delete

'wpforms-sendinblue' => [

[115] Fix | Delete

'old' => 'sendinblue',

[116] Fix | Delete

'new' => 'brevo',

[117] Fix | Delete

],

[118] Fix | Delete

'wpforms-convertkit' => [

[119] Fix | Delete

'old' => 'convertkit',

[120] Fix | Delete

'new' => 'kit',

[121] Fix | Delete

],

[122] Fix | Delete

] as $slug => $renamed

[123] Fix | Delete

) {

[124] Fix | Delete

if ( $addon['slug'] === $slug ) {

[125] Fix | Delete

$addon['icon'] = str_replace( $renamed['old'], $renamed['new'], $addon['icon'] );

[126] Fix | Delete

}

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

// Use slug as a key for further usage.

[130] Fix | Delete

$addons_cache[ $addon['slug'] ] = $addon;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

return $addons_cache;

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete