Edit File by line

<?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

* Available addons data.

[72] Fix | Delete

[73] Fix | Delete

* @since 1.6.6

[74] Fix | Delete

[75] Fix | Delete

* @var array

[76] Fix | Delete

[77] Fix | Delete

private $available_addons;

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Determine if the class is allowed to load.

[81] Fix | Delete

[82] Fix | Delete

* @since 1.6.6

[83] Fix | Delete

[84] Fix | Delete

* @return bool

[85] Fix | Delete

[86] Fix | Delete

public function allow_load() {

[87] Fix | Delete

[88] Fix | Delete

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

[89] Fix | Delete

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

[90] Fix | Delete

[91] Fix | Delete

return $has_permissions && $allowed_requests;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Initialize class.

[96] Fix | Delete

[97] Fix | Delete

* @since 1.6.6

[98] Fix | Delete

[99] Fix | Delete

public function init() {

[100] Fix | Delete

[101] Fix | Delete

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

[102] Fix | Delete

return;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

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

[106] Fix | Delete

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

[107] Fix | Delete

[108] Fix | Delete

$this->hooks();

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Hooks.

[113] Fix | Delete

[114] Fix | Delete

* @since 1.6.6

[115] Fix | Delete

[116] Fix | Delete

protected function hooks() {

[117] Fix | Delete

[118] Fix | Delete

add_action( 'admin_init', [ $this, 'get_available' ] );

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Fire before admin addons init.

[122] Fix | Delete

[123] Fix | Delete

* @since 1.6.7

[124] Fix | Delete

[125] Fix | Delete

do_action( 'wpforms_admin_addons_init' );

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

/**

[129] Fix | Delete

* Get all addons data as array.

[130] Fix | Delete

[131] Fix | Delete

* @since 1.6.6

[132] Fix | Delete

[133] Fix | Delete

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

[134] Fix | Delete

[135] Fix | Delete

* @return array

[136] Fix | Delete

[137] Fix | Delete

public function get_all( $force_cache_update = false ) {

[138] Fix | Delete

[139] Fix | Delete

if ( $force_cache_update ) {

[140] Fix | Delete

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

[141] Fix | Delete

[142] Fix | Delete

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

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

// WPForms 1.8.7 core includes Custom Captcha.

[146] Fix | Delete

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

[147] Fix | Delete

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

[148] Fix | Delete

[149] Fix | Delete

return $this->get_sorted_addons();

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Get sorted addons data.

[154] Fix | Delete

* Recommended addons will be displayed first,

[155] Fix | Delete

* then new addons, then featured addons,

[156] Fix | Delete

* and then all other addons.

[157] Fix | Delete

[158] Fix | Delete

* @since 1.8.9

[159] Fix | Delete

[160] Fix | Delete

* @return array

[161] Fix | Delete

[162] Fix | Delete

private function get_sorted_addons(): array {

[163] Fix | Delete

[164] Fix | Delete

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

[165] Fix | Delete

return [];

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

$recommended = array_filter(

[169] Fix | Delete

$this->addons,

[170] Fix | Delete

static function ( $addon ) {

[171] Fix | Delete

[172] Fix | Delete

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

[173] Fix | Delete

}

[174] Fix | Delete

);

[175] Fix | Delete

[176] Fix | Delete

$new = array_filter(

[177] Fix | Delete

$this->addons,

[178] Fix | Delete

static function ( $addon ) {

[179] Fix | Delete

[180] Fix | Delete

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

[181] Fix | Delete

}

[182] Fix | Delete

);

[183] Fix | Delete

[184] Fix | Delete

$featured = array_filter(

[185] Fix | Delete

$this->addons,

[186] Fix | Delete

static function ( $addon ) {

[187] Fix | Delete

[188] Fix | Delete

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

[189] Fix | Delete

}

[190] Fix | Delete

);

[191] Fix | Delete

[192] Fix | Delete

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

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* Get filtered addons data.

[197] Fix | Delete

[198] Fix | Delete

* Usage:

[199] Fix | Delete

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

[200] Fix | Delete

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

[201] Fix | Delete

[202] Fix | Delete

* @since 1.6.6

[203] Fix | Delete

[204] Fix | Delete

* @param array $addons Raw addons data.

[205] Fix | Delete

* @param array $args Arguments array.

[206] Fix | Delete

[207] Fix | Delete

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

[208] Fix | Delete

[209] Fix | Delete

private function get_filtered( $addons, $args ) {

[210] Fix | Delete

[211] Fix | Delete

if ( empty( $addons ) ) {

[212] Fix | Delete

return [];

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

$default_args = [

[216] Fix | Delete

'category' => '',

[217] Fix | Delete

'license' => '',

[218] Fix | Delete

];

[219] Fix | Delete

[220] Fix | Delete

$args = wp_parse_args( $args, $default_args );

[221] Fix | Delete

[222] Fix | Delete

$filtered_addons = [];

[223] Fix | Delete

[224] Fix | Delete

foreach ( $addons as $addon ) {

[225] Fix | Delete

foreach ( [ 'category', 'license' ] as $arg_key ) {

[226] Fix | Delete

if (

[227] Fix | Delete

! empty( $args[ $arg_key ] ) &&

[228] Fix | Delete

! empty( $addon[ $arg_key ] ) &&

[229] Fix | Delete

is_array( $addon[ $arg_key ] ) &&

[230] Fix | Delete

in_array( strtolower( $args[ $arg_key ] ), $addon[ $arg_key ], true )

[231] Fix | Delete

) {

[232] Fix | Delete

$filtered_addons[] = $addon;

[233] Fix | Delete

}

[234] Fix | Delete

}

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

return $filtered_addons;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Get available addons data by category.

[242] Fix | Delete

[243] Fix | Delete

* @since 1.6.6

[244] Fix | Delete

[245] Fix | Delete

* @param string $category Addon category.

[246] Fix | Delete

[247] Fix | Delete

* @return array.

[248] Fix | Delete

[249] Fix | Delete

public function get_by_category( $category ) {

[250] Fix | Delete

[251] Fix | Delete

return $this->get_filtered( $this->available_addons, [ 'category' => $category ] );

[252] Fix | Delete

}

[253] Fix | Delete

[254] Fix | Delete

/**

[255] Fix | Delete

* Get available addons data by license.

[256] Fix | Delete

[257] Fix | Delete

* @since 1.6.6

[258] Fix | Delete

[259] Fix | Delete

* @param string $license Addon license.

[260] Fix | Delete

[261] Fix | Delete

* @return array.

[262] Fix | Delete

* @noinspection PhpUnused

[263] Fix | Delete

[264] Fix | Delete

public function get_by_license( $license ) {

[265] Fix | Delete

[266] Fix | Delete

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

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

/**

[270] Fix | Delete

* Get available addons data by slugs.

[271] Fix | Delete

[272] Fix | Delete

* @since 1.6.8

[273] Fix | Delete

[274] Fix | Delete

* @param array $slugs Addon slugs.

[275] Fix | Delete

[276] Fix | Delete

* @return array

[277] Fix | Delete

[278] Fix | Delete

public function get_by_slugs( $slugs ) {

[279] Fix | Delete

[280] Fix | Delete

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

[281] Fix | Delete

return [];

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

$result_addons = [];

[285] Fix | Delete

[286] Fix | Delete

foreach ( $slugs as $slug ) {

[287] Fix | Delete

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

[288] Fix | Delete

[289] Fix | Delete

if ( ! empty( $addon ) ) {

[290] Fix | Delete

$result_addons[] = $addon;

[291] Fix | Delete

}

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

return $result_addons;

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

/**

[298] Fix | Delete

* Get available addon data by slug.

[299] Fix | Delete

[300] Fix | Delete

* @since 1.6.6

[301] Fix | Delete

[302] Fix | Delete

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

[303] Fix | Delete

[304] Fix | Delete

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

[305] Fix | Delete

[306] Fix | Delete

public function get_addon( $slug ) {

[307] Fix | Delete

[308] Fix | Delete

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

[309] Fix | Delete

[310] Fix | Delete

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

[311] Fix | Delete

[312] Fix | Delete

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

[313] Fix | Delete

if ( empty( $addon ) ) {

[314] Fix | Delete

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

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

return $addon;

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

/**

[321] Fix | Delete

* Check if addon is active.

[322] Fix | Delete

[323] Fix | Delete

* @since 1.8.9

[324] Fix | Delete

[325] Fix | Delete

* @param string $slug Addon slug.

[326] Fix | Delete

[327] Fix | Delete

* @return bool

[328] Fix | Delete

[329] Fix | Delete

public function is_active( string $slug ): bool {

[330] Fix | Delete

[331] Fix | Delete

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

[332] Fix | Delete

[333] Fix | Delete

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

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

/**

[337] Fix | Delete

* Get license level of the addon.

[338] Fix | Delete

[339] Fix | Delete

* @since 1.6.6

[340] Fix | Delete

[341] Fix | Delete

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

[342] Fix | Delete

[343] Fix | Delete

* @return string License level: pro | elite.

[344] Fix | Delete

[345] Fix | Delete

private function get_license_level( $addon ) {

[346] Fix | Delete

[347] Fix | Delete

if ( empty( $addon ) ) {

[348] Fix | Delete

return '';

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

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

[352] Fix | Delete

$license = '';

[353] Fix | Delete

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

[354] Fix | Delete

[355] Fix | Delete

foreach ( $levels as $level ) {

[356] Fix | Delete

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

[357] Fix | Delete

$license = $level;

[358] Fix | Delete

[359] Fix | Delete

break;

[360] Fix | Delete

}

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

if ( empty( $license ) ) {

[364] Fix | Delete

return '';

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

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

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

/**

[371] Fix | Delete

* Get addon license.

[372] Fix | Delete

[373] Fix | Delete

* @since 1.8.2

[374] Fix | Delete

[375] Fix | Delete

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

[376] Fix | Delete

[377] Fix | Delete

* @return array

[378] Fix | Delete

[379] Fix | Delete

private function get_addon_license( $addon ) {

[380] Fix | Delete

[381] Fix | Delete

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

[382] Fix | Delete

[383] Fix | Delete

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

[384] Fix | Delete

}

[385] Fix | Delete

[386] Fix | Delete

/**

[387] Fix | Delete

* Determine if user's license level has access.

[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 bool

[394] Fix | Delete

[395] Fix | Delete

protected function has_access( $addon ) {

[396] Fix | Delete

[397] Fix | Delete

return false;

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

/**

[401] Fix | Delete

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

[402] Fix | Delete

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

[403] Fix | Delete

[404] Fix | Delete

* @since 1.6.6

[405] Fix | Delete

[406] Fix | Delete

* @return array

[407] Fix | Delete

[408] Fix | Delete

public function get_available() {

[409] Fix | Delete

[410] Fix | Delete

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

[411] Fix | Delete

return [];

[412] Fix | Delete

}

[413] Fix | Delete

[414] Fix | Delete

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

[415] Fix | Delete

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

[416] Fix | Delete

$this->available_addons = array_filter(

[417] Fix | Delete

$this->available_addons,

[418] Fix | Delete

static function ( $addon ) {

[419] Fix | Delete

[420] Fix | Delete

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

[421] Fix | Delete

}

[422] Fix | Delete

);

[423] Fix | Delete

}

[424] Fix | Delete

[425] Fix | Delete

return $this->available_addons;

[426] Fix | Delete

}

[427] Fix | Delete

[428] Fix | Delete

/**

[429] Fix | Delete

* Prepare addon data.

[430] Fix | Delete

[431] Fix | Delete

* @since 1.6.6

[432] Fix | Delete

[433] Fix | Delete

* @param array $addon Addon data.

[434] Fix | Delete

[435] Fix | Delete

* @return array Extended addon data.

[436] Fix | Delete

[437] Fix | Delete

protected function prepare_addon_data( $addon ) {

[438] Fix | Delete

[439] Fix | Delete

if ( empty( $addon ) ) {

[440] Fix | Delete

return [];

[441] Fix | Delete

}

[442] Fix | Delete

[443] Fix | Delete

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

[444] Fix | Delete

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

[445] Fix | Delete

[446] Fix | Delete

// We need the cleared name of the addon, without the ' addon' suffix, for further use.

[447] Fix | Delete

$addon['name'] = preg_replace( '/ addon$/i', '', $addon['title'] );

[448] Fix | Delete

[449] Fix | Delete

$addon['modal_name'] = sprintf( /* translators: %s - addon name. */

[450] Fix | Delete

esc_html__( '%s addon', 'wpforms-lite' ),

[451] Fix | Delete

$addon['name']

[452] Fix | Delete

);

[453] Fix | Delete

$addon['clear_slug'] = str_replace( 'wpforms-', '', $addon['slug'] );

[454] Fix | Delete

$addon['utm_content'] = ucwords( str_replace( '-', ' ', $addon['clear_slug'] ) );

[455] Fix | Delete

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

[456] Fix | Delete

$addon['license_level'] = $this->get_license_level( $addon );

[457] Fix | Delete

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

[458] Fix | Delete

$addon['path'] = sprintf( '%1$s/%1$s.php', $addon['slug'] );

[459] Fix | Delete

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

[460] Fix | Delete

$addon['plugin_allow'] = $this->has_access( $addon );

[461] Fix | Delete

$addon['status'] = 'missing';

[462] Fix | Delete

$addon['action'] = 'upgrade';

[463] Fix | Delete

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

[464] Fix | Delete

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

[465] Fix | Delete

$addon['url'] = '';

[466] Fix | Delete

[467] Fix | Delete

static $nonce = '';

[468] Fix | Delete

$nonce = empty( $nonce ) ? wp_create_nonce( 'wpforms-admin' ) : $nonce;

[469] Fix | Delete

$addon['nonce'] = $nonce;

[470] Fix | Delete

[471] Fix | Delete

return $addon;

[472] Fix | Delete

}

[473] Fix | Delete

[474] Fix | Delete

/**

[475] Fix | Delete

* Get default data.

[476] Fix | Delete

[477] Fix | Delete

* @since 1.8.2

[478] Fix | Delete

[479] Fix | Delete

* @param array $addon Addon data.

[480] Fix | Delete

* @param string $key Key.

[481] Fix | Delete

* @param mixed $default Default data.

[482] Fix | Delete

[483] Fix | Delete

* @return array|string|mixed

[484] Fix | Delete

[485] Fix | Delete

private function default_data( $addon, $key, $default ) {

[486] Fix | Delete

[487] Fix | Delete

if ( is_string( $default ) ) {

[488] Fix | Delete

return ! empty( $addon[ $key ] ) ? $addon[ $key ] : $default;

[489] Fix | Delete

}

[490] Fix | Delete

[491] Fix | Delete

if ( is_array( $default ) ) {

[492] Fix | Delete

return ! empty( $addon[ $key ] ) ? (array) $addon[ $key ] : $default;

[493] Fix | Delete

}

[494] Fix | Delete

[495] Fix | Delete

return $addon[ $key ];

[496] Fix | Delete

}

[497] Fix | Delete

}

[498] Fix | Delete

[499] Fix | Delete