<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Addons;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Addons data handler.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.6.6

[7] Fix | Delete

*/

[8] Fix | Delete

class Addons {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Basic license.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.8.2

[14] Fix | Delete

*/

[15] Fix | Delete

const BASIC = 'basic';

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Plus license.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 1.8.2

[21] Fix | Delete

*/

[22] Fix | Delete

const PLUS = 'plus';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Pro license.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.8.2

[28] Fix | Delete

*/

[29] Fix | Delete

const PRO = 'pro';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Elite license.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.8.2

[35] Fix | Delete

*/

[36] Fix | Delete

const ELITE = 'elite';

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Agency license.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.8.2

[42] Fix | Delete

*/

[43] Fix | Delete

const AGENCY = 'agency';

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Ultimate license.

[47] Fix | Delete

*

[48] Fix | Delete

* @since 1.8.2

[49] Fix | Delete

*/

[50] Fix | Delete

const ULTIMATE = 'ultimate';

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Addons cache object.

[54] Fix | Delete

*

[55] Fix | Delete

* @since 1.6.6

[56] Fix | Delete

*

[57] Fix | Delete

* @var AddonsCache

[58] Fix | Delete

*/

[59] Fix | Delete

private $cache;

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* All Addons data.

[63] Fix | Delete

*

[64] Fix | Delete

* @since 1.6.6

[65] Fix | Delete

*

[66] Fix | Delete

* @var array

[67] Fix | Delete

*/

[68] Fix | Delete

private $addons;

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* WPForms addons text domains.

[72] Fix | Delete

*

[73] Fix | Delete

* @since 1.9.2

[74] Fix | Delete

*

[75] Fix | Delete

* @var array

[76] Fix | Delete

*/

[77] Fix | Delete

private $addons_text_domains = [];

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* WPForms addons titles.

[81] Fix | Delete

*

[82] Fix | Delete

* @since 1.9.2

[83] Fix | Delete

*

[84] Fix | Delete

* @var array

[85] Fix | Delete

*/

[86] Fix | Delete

private $addons_titles = [];

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Determine if the class is allowed to load.

[90] Fix | Delete

*

[91] Fix | Delete

* @since 1.6.6

[92] Fix | Delete

*

[93] Fix | Delete

* @return bool

[94] Fix | Delete

*/

[95] Fix | Delete

public function allow_load() {

[96] Fix | Delete

[97] Fix | Delete

global $pagenow;

[98] Fix | Delete

[99] Fix | Delete

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

[100] Fix | Delete

$allowed_pages = in_array( $pagenow ?? '', [ 'plugins.php', 'update-core.php', 'plugin-install.php' ], true );

[101] Fix | Delete

$allowed_ajax = $pagenow === 'admin-ajax.php' && isset( $_POST['action'] ) && $_POST['action'] === 'update-plugin'; // phpcs:ignore WordPress.Security.NonceVerification.Missing

[102] Fix | Delete

[103] Fix | Delete

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

[104] Fix | Delete

[105] Fix | Delete

return $has_permissions && $allowed_requests;

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Initialize class.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.6.6

[112] Fix | Delete

*/

[113] Fix | Delete

public function init() {

[114] Fix | Delete

[115] Fix | Delete

if ( ! $this->allow_load() ) {

[116] Fix | Delete

return;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

$this->cache = wpforms()->obj( 'addons_cache' );

[120] Fix | Delete

[121] Fix | Delete

global $pagenow;

[122] Fix | Delete

[123] Fix | Delete

// Force update addons cache if we are on the update-core.php page.

[124] Fix | Delete

// This is necessary to update addons data while checking for all available updates.

[125] Fix | Delete

if ( $pagenow === 'update-core.php' ) {

[126] Fix | Delete

$this->cache->update( true );

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

$this->addons = $this->cache->get();

[130] Fix | Delete

[131] Fix | Delete

$this->populate_addons_data();

[132] Fix | Delete

$this->hooks();

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Hooks.

[137] Fix | Delete

*

[138] Fix | Delete

* @since 1.6.6

[139] Fix | Delete

*/

[140] Fix | Delete

protected function hooks() {

[141] Fix | Delete

[142] Fix | Delete

global $pagenow;

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Fire before admin addons init.

[146] Fix | Delete

*

[147] Fix | Delete

* @since 1.6.7

[148] Fix | Delete

*/

[149] Fix | Delete

do_action( 'wpforms_admin_addons_init' );

[150] Fix | Delete

[151] Fix | Delete

// Filter Gettext only on Plugin list and Updates pages.

[152] Fix | Delete

if ( $pagenow === 'update-core.php' || $pagenow === 'plugins.php' ) {

[153] Fix | Delete

add_action( 'gettext', [ $this, 'filter_gettext' ], 10, 3 );

[154] Fix | Delete

}

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Get all addons data as array.

[159] Fix | Delete

*

[160] Fix | Delete

* @since 1.6.6

[161] Fix | Delete

*

[162] Fix | Delete

* @param bool $force_cache_update Determine if we need to update cache. Default is `false`.

[163] Fix | Delete

*

[164] Fix | Delete

* @return array

[165] Fix | Delete

*/

[166] Fix | Delete

public function get_all( bool $force_cache_update = false ) {

[167] Fix | Delete

[168] Fix | Delete

if ( ! $this->allow_load() ) {

[169] Fix | Delete

return [];

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

if ( $force_cache_update ) {

[173] Fix | Delete

$this->cache->update( true );

[174] Fix | Delete

[175] Fix | Delete

$this->addons = $this->cache->get();

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

// WPForms 1.8.7 core includes Custom Captcha.

[179] Fix | Delete

// The Custom Captcha addon will only work on WPForms 1.8.6 and earlier versions.

[180] Fix | Delete

unset( $this->addons['wpforms-captcha'] );

[181] Fix | Delete

[182] Fix | Delete

return $this->get_sorted_addons();

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

/**

[186] Fix | Delete

* Get sorted addons data.

[187] Fix | Delete

* Recommended addons will be displayed first,

[188] Fix | Delete

* then new addons, then featured addons,

[189] Fix | Delete

* and then all other addons.

[190] Fix | Delete

*

[191] Fix | Delete

* @since 1.8.9

[192] Fix | Delete

*

[193] Fix | Delete

* @return array

[194] Fix | Delete

*/

[195] Fix | Delete

private function get_sorted_addons(): array {

[196] Fix | Delete

[197] Fix | Delete

if ( empty( $this->addons ) ) {

[198] Fix | Delete

return [];

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

$recommended = array_filter(

[202] Fix | Delete

$this->addons,

[203] Fix | Delete

static function ( $addon ) {

[204] Fix | Delete

[205] Fix | Delete

return ! empty( $addon['recommended'] );

[206] Fix | Delete

}

[207] Fix | Delete

);

[208] Fix | Delete

[209] Fix | Delete

$new = array_filter(

[210] Fix | Delete

$this->addons,

[211] Fix | Delete

static function ( $addon ) {

[212] Fix | Delete

[213] Fix | Delete

return ! empty( $addon['new'] );

[214] Fix | Delete

}

[215] Fix | Delete

);

[216] Fix | Delete

[217] Fix | Delete

$featured = array_filter(

[218] Fix | Delete

$this->addons,

[219] Fix | Delete

static function ( $addon ) {

[220] Fix | Delete

[221] Fix | Delete

return ! empty( $addon['featured'] );

[222] Fix | Delete

}

[223] Fix | Delete

);

[224] Fix | Delete

[225] Fix | Delete

return array_merge( $recommended, $new, $featured, $this->addons );

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Get filtered addons data.

[230] Fix | Delete

*

[231] Fix | Delete

* Usage:

[232] Fix | Delete

* ->get_filtered( $this->addons, [ 'category' => 'payments' ] ) - addons for the payments panel.

[233] Fix | Delete

* ->get_filtered( $this->addons, [ 'license' => 'elite' ] ) - addons available for 'elite' license.

[234] Fix | Delete

*

[235] Fix | Delete

* @since 1.6.6

[236] Fix | Delete

*

[237] Fix | Delete

* @param array $addons Raw addons data.

[238] Fix | Delete

* @param array $args Arguments array.

[239] Fix | Delete

*

[240] Fix | Delete

* @return array Addons data filtered according to given arguments.

[241] Fix | Delete

*/

[242] Fix | Delete

private function get_filtered( array $addons, array $args ): array {

[243] Fix | Delete

[244] Fix | Delete

$args = wp_parse_args(

[245] Fix | Delete

$args,

[246] Fix | Delete

[

[247] Fix | Delete

'category' => '',

[248] Fix | Delete

'license' => '',

[249] Fix | Delete

]

[250] Fix | Delete

);

[251] Fix | Delete

[252] Fix | Delete

$args = array_map( 'strtolower', $args );

[253] Fix | Delete

[254] Fix | Delete

$filtered_addons = [];

[255] Fix | Delete

[256] Fix | Delete

foreach ( $addons as $addon ) {

[257] Fix | Delete

foreach ( $args as $arg_key => $arg_value ) {

[258] Fix | Delete

$addon_value = wpforms_array_get_by_path( $addon, $arg_key, '' );

[259] Fix | Delete

[260] Fix | Delete

if (

[261] Fix | Delete

is_array( $addon_value ) &&

[262] Fix | Delete

// We cannot use preg_quote here, as $arg_value could contain regex like 'crm|email-marketing|integration'.

[263] Fix | Delete

preg_grep( '/^' . $arg_value . '$/', $addon_value )

[264] Fix | Delete

) {

[265] Fix | Delete

$filtered_addons[] = $addon;

[266] Fix | Delete

}

[267] Fix | Delete

}

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

return $filtered_addons;

[271] Fix | Delete

}

[272] Fix | Delete

[273] Fix | Delete

/**

[274] Fix | Delete

* Get available addons data by category.

[275] Fix | Delete

*

[276] Fix | Delete

* @since 1.6.6

[277] Fix | Delete

*

[278] Fix | Delete

* @param string $category Addon category.

[279] Fix | Delete

*

[280] Fix | Delete

* @return array.

[281] Fix | Delete

*/

[282] Fix | Delete

public function get_by_category( string $category ) {

[283] Fix | Delete

[284] Fix | Delete

return $this->get_by_path( 'category', $category );

[285] Fix | Delete

}

[286] Fix | Delete

[287] Fix | Delete

/**

[288] Fix | Delete

* Get available addons data by path.

[289] Fix | Delete

*

[290] Fix | Delete

* @since 1.9.8.6

[291] Fix | Delete

*

[292] Fix | Delete

* @param string $path Path in addons multidimensional array.

[293] Fix | Delete

* May be 'category' or 'form_builder.category' or 'settings_integrations.category', etc.

[294] Fix | Delete

* @param string $value Addons multidimensional array value we are looking for in the path.

[295] Fix | Delete

*

[296] Fix | Delete

* @return array

[297] Fix | Delete

*/

[298] Fix | Delete

public function get_by_path( string $path, $value ): array {

[299] Fix | Delete

[300] Fix | Delete

return $this->get_filtered( $this->get_available(), [ $path => $value ] );

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

/**

[304] Fix | Delete

* Get available addons data by license.

[305] Fix | Delete

*

[306] Fix | Delete

* @since 1.6.6

[307] Fix | Delete

*

[308] Fix | Delete

* @param string $license Addon license.

[309] Fix | Delete

*

[310] Fix | Delete

* @return array.

[311] Fix | Delete

* @noinspection PhpUnused

[312] Fix | Delete

*/

[313] Fix | Delete

public function get_by_license( string $license ) {

[314] Fix | Delete

[315] Fix | Delete

return $this->get_filtered( $this->get_available(), [ 'license' => $license ] );

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

/**

[319] Fix | Delete

* Get available addons data by slugs.

[320] Fix | Delete

*

[321] Fix | Delete

* @since 1.6.8

[322] Fix | Delete

*

[323] Fix | Delete

* @param array|mixed $slugs Addon slugs.

[324] Fix | Delete

*

[325] Fix | Delete

* @return array

[326] Fix | Delete

*/

[327] Fix | Delete

public function get_by_slugs( $slugs ) {

[328] Fix | Delete

[329] Fix | Delete

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

[330] Fix | Delete

return [];

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

$result_addons = [];

[334] Fix | Delete

[335] Fix | Delete

foreach ( $slugs as $slug ) {

[336] Fix | Delete

$addon = $this->get_addon( $slug );

[337] Fix | Delete

[338] Fix | Delete

if ( ! empty( $addon ) ) {

[339] Fix | Delete

$result_addons[] = $addon;

[340] Fix | Delete

}

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

return $result_addons;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

/**

[347] Fix | Delete

* Get available addon data by slug.

[348] Fix | Delete

*

[349] Fix | Delete

* @since 1.6.6

[350] Fix | Delete

*

[351] Fix | Delete

* @param string|bool $slug Addon slug can be both "wpforms-drip" and "drip".

[352] Fix | Delete

*

[353] Fix | Delete

* @return array Single addon data. Empty array if addon is not found.

[354] Fix | Delete

*/

[355] Fix | Delete

public function get_addon( $slug ) {

[356] Fix | Delete

[357] Fix | Delete

$slug = (string) $slug;

[358] Fix | Delete

$slug = 'wpforms-' . str_replace( 'wpforms-', '', sanitize_key( $slug ) );

[359] Fix | Delete

[360] Fix | Delete

$addon = $this->get_available()[ $slug ] ?? [];

[361] Fix | Delete

[362] Fix | Delete

// In case if addon is "not available" let's try to get and prepare addon data from all addons.

[363] Fix | Delete

if ( empty( $addon ) ) {

[364] Fix | Delete

$addon = ! empty( $this->addons[ $slug ] ) ? $this->prepare_addon_data( $this->addons[ $slug ] ) : [];

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

return $addon;

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

/**

[371] Fix | Delete

* Check if addon is active.

[372] Fix | Delete

*

[373] Fix | Delete

* @since 1.8.9

[374] Fix | Delete

*

[375] Fix | Delete

* @param string $slug Addon slug.

[376] Fix | Delete

*

[377] Fix | Delete

* @return bool

[378] Fix | Delete

*/

[379] Fix | Delete

public function is_active( string $slug ): bool {

[380] Fix | Delete

[381] Fix | Delete

$addon = $this->get_addon( $slug );

[382] Fix | Delete

[383] Fix | Delete

return isset( $addon['status'] ) && $addon['status'] === 'active';

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete

/**

[387] Fix | Delete

* Get license level of the addon.

[388] Fix | Delete

*

[389] Fix | Delete

* @since 1.6.6

[390] Fix | Delete

*

[391] Fix | Delete

* @param array|string $addon Addon data array OR addon slug.

[392] Fix | Delete

*

[393] Fix | Delete

* @return string License level: pro | elite.

[394] Fix | Delete

*/

[395] Fix | Delete

private function get_license_level( $addon ) {

[396] Fix | Delete

[397] Fix | Delete

if ( empty( $addon ) ) {

[398] Fix | Delete

return '';

[399] Fix | Delete

}

[400] Fix | Delete

[401] Fix | Delete

$levels = [ self::BASIC, self::PLUS, self::PRO, self::ELITE, self::AGENCY, self::ULTIMATE ];

[402] Fix | Delete

$license = '';

[403] Fix | Delete

$addon_license = $this->get_addon_license( $addon );

[404] Fix | Delete

[405] Fix | Delete

foreach ( $levels as $level ) {

[406] Fix | Delete

if ( in_array( $level, $addon_license, true ) ) {

[407] Fix | Delete

$license = $level;

[408] Fix | Delete

[409] Fix | Delete

break;

[410] Fix | Delete

}

[411] Fix | Delete

}

[412] Fix | Delete

[413] Fix | Delete

if ( empty( $license ) ) {

[414] Fix | Delete

return '';

[415] Fix | Delete

}

[416] Fix | Delete

[417] Fix | Delete

return in_array( $license, [ self::BASIC, self::PLUS, self::PRO ], true ) ? self::PRO : self::ELITE;

[418] Fix | Delete

}

[419] Fix | Delete

[420] Fix | Delete

/**

[421] Fix | Delete

* Get addon license.

[422] Fix | Delete

*

[423] Fix | Delete

* @since 1.8.2

[424] Fix | Delete

*

[425] Fix | Delete

* @param array|string $addon Addon data array OR addon slug.

[426] Fix | Delete

*

[427] Fix | Delete

* @return array

[428] Fix | Delete

*/

[429] Fix | Delete

private function get_addon_license( $addon ) {

[430] Fix | Delete

[431] Fix | Delete

$addon = is_string( $addon ) ? $this->get_addon( $addon ) : $addon;

[432] Fix | Delete

[433] Fix | Delete

return $this->default_data( $addon, 'license', [] );

[434] Fix | Delete

}

[435] Fix | Delete

[436] Fix | Delete

/**

[437] Fix | Delete

* Determine if a user's license level has access.

[438] Fix | Delete

*

[439] Fix | Delete

* @since 1.6.6

[440] Fix | Delete

*

[441] Fix | Delete

* @param array|string $addon Addon data array OR addon slug.

[442] Fix | Delete

*

[443] Fix | Delete

* @return bool

[444] Fix | Delete

*/

[445] Fix | Delete

protected function has_access( $addon ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found

[446] Fix | Delete

[447] Fix | Delete

return false;

[448] Fix | Delete

}

[449] Fix | Delete

[450] Fix | Delete

/**

[451] Fix | Delete

* Return array of addons available to display. All data is prepared and normalized.

[452] Fix | Delete

* "Available to display" means that addon needs to be displayed as an education item (addon is not installed or not activated).

[453] Fix | Delete

*

[454] Fix | Delete

* @since 1.6.6

[455] Fix | Delete

*

[456] Fix | Delete

* @return array

[457] Fix | Delete

*/

[458] Fix | Delete

public function get_available() {

[459] Fix | Delete

[460] Fix | Delete

static $available_addons = [];

[461] Fix | Delete

[462] Fix | Delete

if ( $available_addons ) {

[463] Fix | Delete

return $available_addons;

[464] Fix | Delete

}

[465] Fix | Delete

[466] Fix | Delete

if ( empty( $this->addons ) || ! is_array( $this->addons ) ) {

[467] Fix | Delete

return [];

[468] Fix | Delete

}

[469] Fix | Delete

[470] Fix | Delete

$available_addons = array_map( [ $this, 'prepare_addon_data' ], $this->addons );

[471] Fix | Delete

$available_addons = array_filter(

[472] Fix | Delete

$available_addons,

[473] Fix | Delete

static function ( $addon ) {

[474] Fix | Delete

[475] Fix | Delete

return isset( $addon['status'], $addon['plugin_allow'] ) && ( $addon['status'] !== 'active' || ! $addon['plugin_allow'] );

[476] Fix | Delete

}

[477] Fix | Delete

);

[478] Fix | Delete

[479] Fix | Delete

return $available_addons;

[480] Fix | Delete

}

[481] Fix | Delete

[482] Fix | Delete

/**

[483] Fix | Delete

* Prepare addon data.

[484] Fix | Delete

*

[485] Fix | Delete

* @since 1.6.6

[486] Fix | Delete

*

[487] Fix | Delete

* @param array|mixed $addon Addon data.

[488] Fix | Delete

*

[489] Fix | Delete

* @return array Extended addon data.

[490] Fix | Delete

*/

[491] Fix | Delete

protected function prepare_addon_data( $addon ) {

[492] Fix | Delete

[493] Fix | Delete

if ( empty( $addon ) ) {

[494] Fix | Delete

return [];

[495] Fix | Delete

}

[496] Fix | Delete

[497] Fix | Delete

$addon['title'] = $this->default_data( $addon, 'title', '' );

[498] Fix | Delete

$addon['slug'] = $this->default_data( $addon, 'slug', '' );

[499] Fix | Delete