Edit File by line
/home/zeestwma/richards.../wp-conte.../plugins/wpforms-.../src/Integrat.../LiteConn...
File: Integration.php
<?php
[0] Fix | Delete
[1] Fix | Delete
namespace WPForms\Integrations\LiteConnect;
[2] Fix | Delete
[3] Fix | Delete
use WPForms\Admin\Notice;
[4] Fix | Delete
use WPForms\Helpers\Transient;
[5] Fix | Delete
use WPForms\Tasks\Tasks;
[6] Fix | Delete
[7] Fix | Delete
/**
[8] Fix | Delete
* Class Integration.
[9] Fix | Delete
*
[10] Fix | Delete
* Base integration between Lite Connect API and WPForms.
[11] Fix | Delete
*
[12] Fix | Delete
* @since 1.7.4
[13] Fix | Delete
*/
[14] Fix | Delete
class Integration extends API {
[15] Fix | Delete
[16] Fix | Delete
/**
[17] Fix | Delete
* Authentication data.
[18] Fix | Delete
*
[19] Fix | Delete
* @since 1.7.4
[20] Fix | Delete
*
[21] Fix | Delete
* @var array
[22] Fix | Delete
*/
[23] Fix | Delete
protected $auth = [];
[24] Fix | Delete
[25] Fix | Delete
/**
[26] Fix | Delete
* Option name to store the total count of Lite Connect entries.
[27] Fix | Delete
*
[28] Fix | Delete
* @since 1.7.4
[29] Fix | Delete
*
[30] Fix | Delete
* @var string
[31] Fix | Delete
*/
[32] Fix | Delete
const LITE_CONNECT_ENTRIES_COUNT_OPTION = 'wpforms_lite_connect_entries_count';
[33] Fix | Delete
[34] Fix | Delete
/**
[35] Fix | Delete
* Post meta name to store the total count of Lite Connect form entries.
[36] Fix | Delete
*
[37] Fix | Delete
* @since 1.7.9
[38] Fix | Delete
*
[39] Fix | Delete
* @var string
[40] Fix | Delete
*/
[41] Fix | Delete
const LITE_CONNECT_FORM_ENTRIES_COUNT_META = 'wpforms_lite_connect_form_entries_count';
[42] Fix | Delete
[43] Fix | Delete
/**
[44] Fix | Delete
* Integration constructor.
[45] Fix | Delete
*
[46] Fix | Delete
* @since 1.7.4
[47] Fix | Delete
*/
[48] Fix | Delete
public function __construct() {
[49] Fix | Delete
[50] Fix | Delete
static $updated;
[51] Fix | Delete
[52] Fix | Delete
parent::__construct();
[53] Fix | Delete
[54] Fix | Delete
$this->hooks();
[55] Fix | Delete
[56] Fix | Delete
// Update the site key and access token.
[57] Fix | Delete
if (
[58] Fix | Delete
! $updated &&
[59] Fix | Delete
( is_admin() && ! wp_doing_ajax() ) &&
[60] Fix | Delete
( ( wpforms()->is_pro() && self::get_enabled_since() ) || LiteConnect::is_enabled() )
[61] Fix | Delete
) {
[62] Fix | Delete
$this->maybe_update_access_token();
[63] Fix | Delete
$this->update_keys();
[64] Fix | Delete
$updated = true;
[65] Fix | Delete
}
[66] Fix | Delete
}
[67] Fix | Delete
[68] Fix | Delete
/**
[69] Fix | Delete
* Hooks.
[70] Fix | Delete
*
[71] Fix | Delete
* @since 1.7.5
[72] Fix | Delete
*/
[73] Fix | Delete
private function hooks() {
[74] Fix | Delete
[75] Fix | Delete
add_action( 'admin_init', [ $this, 'max_attempts_notice' ], 10 );
[76] Fix | Delete
}
[77] Fix | Delete
[78] Fix | Delete
/**
[79] Fix | Delete
* Update the site key and access token if they do not exist.
[80] Fix | Delete
*
[81] Fix | Delete
* @since 1.7.4
[82] Fix | Delete
*/
[83] Fix | Delete
public function update_keys() {
[84] Fix | Delete
[85] Fix | Delete
if ( isset( $this->auth['site_key'], $this->auth['access_token'] ) ) {
[86] Fix | Delete
return;
[87] Fix | Delete
}
[88] Fix | Delete
[89] Fix | Delete
$site_key = $this->get_site_key();
[90] Fix | Delete
[91] Fix | Delete
$this->auth = [
[92] Fix | Delete
'site_key' => $site_key,
[93] Fix | Delete
'access_token' => $this->get_access_token( $site_key ),
[94] Fix | Delete
];
[95] Fix | Delete
}
[96] Fix | Delete
[97] Fix | Delete
/**
[98] Fix | Delete
* Get the site key.
[99] Fix | Delete
*
[100] Fix | Delete
* @since 1.7.4
[101] Fix | Delete
*
[102] Fix | Delete
* @return string|false|array The site key, or false on error.
[103] Fix | Delete
*/
[104] Fix | Delete
protected function get_site_key() {
[105] Fix | Delete
[106] Fix | Delete
// At first, try to get the site key from the wp-config.php file.
[107] Fix | Delete
$debug_site_key = $this->get_debug_setting( 'key' );
[108] Fix | Delete
[109] Fix | Delete
if ( $debug_site_key !== false ) {
[110] Fix | Delete
return $debug_site_key;
[111] Fix | Delete
}
[112] Fix | Delete
[113] Fix | Delete
// If site key already exists, then we won't need to regenerate it.
[114] Fix | Delete
$curr_key = wpforms_setting( 'site', false, self::get_option_name() );
[115] Fix | Delete
[116] Fix | Delete
if ( ! empty( $curr_key['key'] ) ) {
[117] Fix | Delete
return $curr_key['key'];
[118] Fix | Delete
}
[119] Fix | Delete
[120] Fix | Delete
// Generate the site key.
[121] Fix | Delete
return $this->generate_site_key();
[122] Fix | Delete
}
[123] Fix | Delete
[124] Fix | Delete
/**
[125] Fix | Delete
* Get the access token.
[126] Fix | Delete
*
[127] Fix | Delete
* @since 1.7.4
[128] Fix | Delete
*
[129] Fix | Delete
* @param string|array $site_key The site key.
[130] Fix | Delete
* @param bool $force True to force generate a new access token.
[131] Fix | Delete
*
[132] Fix | Delete
* @return string|false|void The access token, or false on error.
[133] Fix | Delete
*/
[134] Fix | Delete
protected function get_access_token( $site_key, $force = false ) {
[135] Fix | Delete
[136] Fix | Delete
if ( ! $site_key ) {
[137] Fix | Delete
return false;
[138] Fix | Delete
}
[139] Fix | Delete
[140] Fix | Delete
$curr_token = wpforms_setting( 'access_token', false, self::get_option_name() );
[141] Fix | Delete
[142] Fix | Delete
// It won't regenerate the access token if $force is false, and the current token is not expired.
[143] Fix | Delete
if ( $force === false && isset( $curr_token['expires_at'] ) && (int) $curr_token['expires_at'] - time() > 0 ) {
[144] Fix | Delete
return $curr_token['access_token'];
[145] Fix | Delete
}
[146] Fix | Delete
[147] Fix | Delete
// Generate the access token.
[148] Fix | Delete
$response = $this->generate_access_token( $site_key );
[149] Fix | Delete
[150] Fix | Delete
if ( $response ) {
[151] Fix | Delete
$response = json_decode( $response, true );
[152] Fix | Delete
[153] Fix | Delete
if ( isset( $response['access_token'] ) ) {
[154] Fix | Delete
$settings = get_option( self::get_option_name(), [] );
[155] Fix | Delete
$settings['access_token'] = $response;
[156] Fix | Delete
[157] Fix | Delete
update_option( self::get_option_name(), $settings );
[158] Fix | Delete
[159] Fix | Delete
// Create task to refresh access token in 6 days.
[160] Fix | Delete
$this->refresh_access_token_task();
[161] Fix | Delete
[162] Fix | Delete
return $response['access_token'];
[163] Fix | Delete
}
[164] Fix | Delete
[165] Fix | Delete
wpforms_log(
[166] Fix | Delete
'Lite Connect: unable to generate access token',
[167] Fix | Delete
[
[168] Fix | Delete
'response' => $response,
[169] Fix | Delete
'request' => [
[170] Fix | Delete
'domain' => $this->domain,
[171] Fix | Delete
'site_id' => $this->site_id,
[172] Fix | Delete
'wp_version' => get_bloginfo( 'version' ),
[173] Fix | Delete
],
[174] Fix | Delete
],
[175] Fix | Delete
[ 'type' => [ 'error' ] ]
[176] Fix | Delete
);
[177] Fix | Delete
}
[178] Fix | Delete
[179] Fix | Delete
return false;
[180] Fix | Delete
}
[181] Fix | Delete
[182] Fix | Delete
/**
[183] Fix | Delete
* Create a task to refresh the access token.
[184] Fix | Delete
*
[185] Fix | Delete
* @since 1.7.4
[186] Fix | Delete
*/
[187] Fix | Delete
private function refresh_access_token_task() {
[188] Fix | Delete
[189] Fix | Delete
$tasks = wpforms()->obj( 'tasks' );
[190] Fix | Delete
[191] Fix | Delete
if ( $tasks instanceof Tasks && ! $tasks->is_scheduled( RefreshAccessTokenTask::LITE_CONNECT_TASK ) ) {
[192] Fix | Delete
( new RefreshAccessTokenTask() )->create();
[193] Fix | Delete
}
[194] Fix | Delete
}
[195] Fix | Delete
[196] Fix | Delete
/**
[197] Fix | Delete
* Get the name for the Lite Connect's option.
[198] Fix | Delete
*
[199] Fix | Delete
* @since 1.7.4
[200] Fix | Delete
*
[201] Fix | Delete
* @return string
[202] Fix | Delete
*/
[203] Fix | Delete
public static function get_option_name() {
[204] Fix | Delete
[205] Fix | Delete
if ( self::is_staging() ) {
[206] Fix | Delete
return API::STAGING_LITE_CONNECT_OPTION;
[207] Fix | Delete
}
[208] Fix | Delete
[209] Fix | Delete
return API::LITE_CONNECT_OPTION;
[210] Fix | Delete
}
[211] Fix | Delete
[212] Fix | Delete
/**
[213] Fix | Delete
* Get the Lite Connect entries count.
[214] Fix | Delete
*
[215] Fix | Delete
* @since 1.7.4
[216] Fix | Delete
*
[217] Fix | Delete
* @return int The entries count.
[218] Fix | Delete
*/
[219] Fix | Delete
public static function get_entries_count() {
[220] Fix | Delete
[221] Fix | Delete
return (int) get_option( self::LITE_CONNECT_ENTRIES_COUNT_OPTION, 0 );
[222] Fix | Delete
}
[223] Fix | Delete
[224] Fix | Delete
/**
[225] Fix | Delete
* Get the Lite Connect form entries count.
[226] Fix | Delete
*
[227] Fix | Delete
* @since 1.7.9
[228] Fix | Delete
*
[229] Fix | Delete
* @param int $form_id The form ID.
[230] Fix | Delete
*
[231] Fix | Delete
* @return int The form entries count.
[232] Fix | Delete
*/
[233] Fix | Delete
public static function get_form_entries_count( $form_id ) {
[234] Fix | Delete
[235] Fix | Delete
return (int) get_post_meta( $form_id, self::LITE_CONNECT_FORM_ENTRIES_COUNT_META, true );
[236] Fix | Delete
}
[237] Fix | Delete
[238] Fix | Delete
/**
[239] Fix | Delete
* Get the Lite Connect new entries count (since previous import).
[240] Fix | Delete
*
[241] Fix | Delete
* @since 1.7.4
[242] Fix | Delete
*
[243] Fix | Delete
* @return int The new entries count.
[244] Fix | Delete
*/
[245] Fix | Delete
public static function get_new_entries_count() {
[246] Fix | Delete
[247] Fix | Delete
// Get current total entries count.
[248] Fix | Delete
$count = self::get_entries_count();
[249] Fix | Delete
[250] Fix | Delete
// Reduces the entries that were already imported previously from the count.
[251] Fix | Delete
$import = wpforms_setting( 'import', false, self::get_option_name() );
[252] Fix | Delete
$prev_count = 0;
[253] Fix | Delete
[254] Fix | Delete
if ( isset( $import['previous_import_count'] ) ) {
[255] Fix | Delete
$prev_count = (int) $import['previous_import_count'];
[256] Fix | Delete
}
[257] Fix | Delete
[258] Fix | Delete
if ( isset( $import['previous_failed_count'] ) ) {
[259] Fix | Delete
$prev_count += (int) $import['previous_failed_count'];
[260] Fix | Delete
}
[261] Fix | Delete
[262] Fix | Delete
return $count < $prev_count ? 0 : $count - $prev_count;
[263] Fix | Delete
}
[264] Fix | Delete
[265] Fix | Delete
/**
[266] Fix | Delete
* Maybe restart the import flag (for when the user re-upgrades to pro).
[267] Fix | Delete
*
[268] Fix | Delete
* @since 1.7.4
[269] Fix | Delete
*/
[270] Fix | Delete
public static function maybe_restart_import_flag() {
[271] Fix | Delete
[272] Fix | Delete
$settings = get_option( self::get_option_name(), [] );
[273] Fix | Delete
[274] Fix | Delete
if ( empty( $settings ) ) {
[275] Fix | Delete
return;
[276] Fix | Delete
}
[277] Fix | Delete
[278] Fix | Delete
$status = isset( $settings['import']['status'] ) ? $settings['import']['status'] : false;
[279] Fix | Delete
[280] Fix | Delete
if ( $status === 'done' ) {
[281] Fix | Delete
$previous_imported_entries = Transient::get( 'lite_connect_imported_entries' );
[282] Fix | Delete
$settings['import']['previous_import_count'] = is_array( $previous_imported_entries ) ? count( $previous_imported_entries ) : 0;
[283] Fix | Delete
[284] Fix | Delete
$previous_failed_entries = Transient::get( 'lite_connect_failed_entries' );
[285] Fix | Delete
$settings['import']['previous_failed_count'] = is_array( $previous_failed_entries ) ? count( $previous_failed_entries ) : 0;
[286] Fix | Delete
}
[287] Fix | Delete
[288] Fix | Delete
self::maybe_set_entries_count();
[289] Fix | Delete
[290] Fix | Delete
// Reset import status to be able to restart import process.
[291] Fix | Delete
unset(
[292] Fix | Delete
$settings['import']['status'],
[293] Fix | Delete
$settings['import']['user_notified']
[294] Fix | Delete
);
[295] Fix | Delete
[296] Fix | Delete
update_option( self::get_option_name(), $settings );
[297] Fix | Delete
[298] Fix | Delete
if ( Transient::get( 'lite_connect_error' ) !== false ) {
[299] Fix | Delete
Transient::delete( 'lite_connect_error' );
[300] Fix | Delete
}
[301] Fix | Delete
}
[302] Fix | Delete
[303] Fix | Delete
/**
[304] Fix | Delete
* Get the Lite Connect enabled since timestamp.
[305] Fix | Delete
*
[306] Fix | Delete
* @since 1.7.4
[307] Fix | Delete
*
[308] Fix | Delete
* @return bool|int
[309] Fix | Delete
*/
[310] Fix | Delete
public static function get_enabled_since() {
[311] Fix | Delete
[312] Fix | Delete
return wpforms_setting( LiteConnect::SETTINGS_SLUG . '-since' );
[313] Fix | Delete
}
[314] Fix | Delete
[315] Fix | Delete
/**
[316] Fix | Delete
* Get the Email of the user who enabled Lite Connect.
[317] Fix | Delete
*
[318] Fix | Delete
* @since 1.7.4
[319] Fix | Delete
*
[320] Fix | Delete
* @return bool|string
[321] Fix | Delete
*/
[322] Fix | Delete
public static function get_enabled_email() {
[323] Fix | Delete
[324] Fix | Delete
return wpforms_setting( LiteConnect::SETTINGS_SLUG . '-email' );
[325] Fix | Delete
}
[326] Fix | Delete
[327] Fix | Delete
/**
[328] Fix | Delete
* Normalize Lite Connect entries counter when their value is wrong.
[329] Fix | Delete
*
[330] Fix | Delete
* @since 1.7.4
[331] Fix | Delete
*/
[332] Fix | Delete
public static function maybe_set_entries_count() {
[333] Fix | Delete
[334] Fix | Delete
$settings = get_option( self::get_option_name(), [] );
[335] Fix | Delete
[336] Fix | Delete
if ( empty( $settings ) ) {
[337] Fix | Delete
return;
[338] Fix | Delete
}
[339] Fix | Delete
[340] Fix | Delete
$previous_import_count = isset( $settings['import']['previous_import_count'] ) ? (int) $settings['import']['previous_import_count'] : 0;
[341] Fix | Delete
$previous_failed_count = isset( $settings['import']['previous_failed_count'] ) ? (int) $settings['import']['previous_failed_count'] : 0;
[342] Fix | Delete
$previous_import_count += $previous_failed_count;
[343] Fix | Delete
[344] Fix | Delete
// When the entries counter was manually deleted from options OR it was modified by another process,
[345] Fix | Delete
// we are setting the counter to the value of the previous imported entries.
[346] Fix | Delete
// In this way, the next form submission will increase counter properly, and user will see value of the backed up entries.
[347] Fix | Delete
// Obviously, this solution is not perfect, but we don't have another source of the total entries count.
[348] Fix | Delete
if ( $previous_import_count > self::get_entries_count() ) {
[349] Fix | Delete
update_option( self::LITE_CONNECT_ENTRIES_COUNT_OPTION, $previous_import_count );
[350] Fix | Delete
}
[351] Fix | Delete
}
[352] Fix | Delete
[353] Fix | Delete
/**
[354] Fix | Delete
* Show the Lite Connect notice about the max attempts to generate the API key.
[355] Fix | Delete
*
[356] Fix | Delete
* @since 1.7.5
[357] Fix | Delete
*/
[358] Fix | Delete
public function max_attempts_notice() {
[359] Fix | Delete
[360] Fix | Delete
$attempts_count = get_option( self::GENERATE_KEY_ATTEMPT_COUNTER_OPTION, 0 );
[361] Fix | Delete
[362] Fix | Delete
$notice_text = sprintf(
[363] Fix | Delete
wp_kses( /* translators: %s - WPForms documentation link. */
[364] Fix | Delete
__( 'Your form entries can’t be backed up because WPForms can’t connect to the backup server. If you’d like to back up your entries, find out how to <a href="%s" target="_blank" rel="noopener noreferrer">fix entry backup issues</a>.', 'wpforms-lite' ),
[365] Fix | Delete
[
[366] Fix | Delete
'a' => [
[367] Fix | Delete
'href' => [],
[368] Fix | Delete
'target' => [],
[369] Fix | Delete
'rel' => [],
[370] Fix | Delete
],
[371] Fix | Delete
]
[372] Fix | Delete
),
[373] Fix | Delete
wpforms_utm_link( 'https://wpforms.com/docs/how-to-use-lite-connect-for-wpforms/#backup-issues', 'Admin Notice' )
[374] Fix | Delete
);
[375] Fix | Delete
[376] Fix | Delete
if ( $attempts_count >= self::MAX_GENERATE_KEY_ATTEMPTS ) {
[377] Fix | Delete
Notice::warning(
[378] Fix | Delete
$notice_text,
[379] Fix | Delete
[
[380] Fix | Delete
'dismiss' => Notice::DISMISS_GLOBAL,
[381] Fix | Delete
'slug' => 'max_attempts',
[382] Fix | Delete
]
[383] Fix | Delete
);
[384] Fix | Delete
}
[385] Fix | Delete
}
[386] Fix | Delete
[387] Fix | Delete
/**
[388] Fix | Delete
* Maybe update access token.
[389] Fix | Delete
*
[390] Fix | Delete
* @since 1.7.6
[391] Fix | Delete
*/
[392] Fix | Delete
public function maybe_update_access_token() {
[393] Fix | Delete
[394] Fix | Delete
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
[395] Fix | Delete
$action = isset( $_GET['wpforms_lite_connect_action'] ) ? sanitize_key( $_GET['wpforms_lite_connect_action'] ) : '';
[396] Fix | Delete
[397] Fix | Delete
if (
[398] Fix | Delete
! isset( $_GET['_wpnonce'] ) ||
[399] Fix | Delete
$action !== 'update-access-token' ||
[400] Fix | Delete
! current_user_can( 'manage_options' ) ||
[401] Fix | Delete
! wp_verify_nonce( sanitize_key( $_GET['_wpnonce'] ), 'wpforms_lite_connect_action' )
[402] Fix | Delete
) {
[403] Fix | Delete
return;
[404] Fix | Delete
}
[405] Fix | Delete
[406] Fix | Delete
$this->get_access_token( $this->get_site_key(), true );
[407] Fix | Delete
}
[408] Fix | Delete
[409] Fix | Delete
/**
[410] Fix | Delete
* Determine if Lite Connect staging is used.
[411] Fix | Delete
*
[412] Fix | Delete
* @since 1.9.1
[413] Fix | Delete
*
[414] Fix | Delete
* @return bool
[415] Fix | Delete
*/
[416] Fix | Delete
private static function is_staging(): bool {
[417] Fix | Delete
[418] Fix | Delete
return defined( 'WPFORMS_LITE_CONNECT_STAGING' ) && WPFORMS_LITE_CONNECT_STAGING;
[419] Fix | Delete
}
[420] Fix | Delete
[421] Fix | Delete
/**
[422] Fix | Delete
* Get the site credentials.
[423] Fix | Delete
*
[424] Fix | Delete
* @since 1.9.1
[425] Fix | Delete
*
[426] Fix | Delete
* @return array
[427] Fix | Delete
*/
[428] Fix | Delete
public static function get_site_credentials(): array {
[429] Fix | Delete
[430] Fix | Delete
$settings = (array) get_option( self::get_option_name(), [] );
[431] Fix | Delete
[432] Fix | Delete
if ( ! empty( $settings['site']['id'] ) && ! empty( $settings['access_token']['access_token'] ) ) {
[433] Fix | Delete
return [
[434] Fix | Delete
'site_id' => $settings['site']['id'],
[435] Fix | Delete
'access_token' => $settings['access_token']['access_token'],
[436] Fix | Delete
];
[437] Fix | Delete
}
[438] Fix | Delete
[439] Fix | Delete
$instance = ( new self() );
[440] Fix | Delete
[441] Fix | Delete
// Try to get the site id from the wp-config.php file.
[442] Fix | Delete
$debug_site_id = $instance->get_debug_setting( 'id' );
[443] Fix | Delete
[444] Fix | Delete
if ( empty( $debug_site_id ) ) {
[445] Fix | Delete
return [];
[446] Fix | Delete
}
[447] Fix | Delete
[448] Fix | Delete
$access_token = $instance->get_access_token( $instance->get_site_key() );
[449] Fix | Delete
[450] Fix | Delete
if ( ! $access_token ) {
[451] Fix | Delete
return [];
[452] Fix | Delete
}
[453] Fix | Delete
[454] Fix | Delete
return [
[455] Fix | Delete
'site_id' => $debug_site_id,
[456] Fix | Delete
'access_token' => $access_token,
[457] Fix | Delete
'is_production' => ! self::is_staging(),
[458] Fix | Delete
];
[459] Fix | Delete
}
[460] Fix | Delete
}
[461] Fix | Delete
[462] Fix | Delete
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
Function