<?php

[0] Fix | Delete

namespace WPForms\Emails;

[1] Fix | Delete

[2] Fix | Delete

/**

[3] Fix | Delete

* Fetching and formatting Info Blocks for Email Summaries class.

[4] Fix | Delete

*

[5] Fix | Delete

* @since 1.5.4

[6] Fix | Delete

*/

[7] Fix | Delete

class InfoBlocks {

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Source of info blocks content.

[11] Fix | Delete

*

[12] Fix | Delete

* @since 1.5.4

[13] Fix | Delete

*/

[14] Fix | Delete

const SOURCE_URL = 'https://wpformsapi.com/feeds/v1/email-summaries/%s';

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Get info blocks info from the cache file or remote.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.6.4

[20] Fix | Delete

*

[21] Fix | Delete

* @return array

[22] Fix | Delete

*/

[23] Fix | Delete

public function get_all() {

[24] Fix | Delete

[25] Fix | Delete

$cache_file = $this->get_cache_file_path();

[26] Fix | Delete

[27] Fix | Delete

if ( empty( $cache_file ) || ! is_readable( $cache_file ) ) {

[28] Fix | Delete

return $this->fetch_all();

[29] Fix | Delete

}

[30] Fix | Delete

[31] Fix | Delete

// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents

[32] Fix | Delete

$contents = file_get_contents( $cache_file );

[33] Fix | Delete

$contents = json_decode( $contents, true );

[34] Fix | Delete

[35] Fix | Delete

return $this->verify_fetched( $contents );

[36] Fix | Delete

}

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Fetch info blocks info from remote.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.5.4

[42] Fix | Delete

*

[43] Fix | Delete

* @return array

[44] Fix | Delete

*/

[45] Fix | Delete

public function fetch_all() {

[46] Fix | Delete

[47] Fix | Delete

$info = [];

[48] Fix | Delete

[49] Fix | Delete

$res = wp_remote_get(

[50] Fix | Delete

$this->get_remote_source(),

[51] Fix | Delete

[

[52] Fix | Delete

'timeout' => 10,

[53] Fix | Delete

'user-agent' => wpforms_get_default_user_agent(),

[54] Fix | Delete

]

[55] Fix | Delete

);

[56] Fix | Delete

[57] Fix | Delete

if ( is_wp_error( $res ) ) {

[58] Fix | Delete

return $info;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

$body = wp_remote_retrieve_body( $res );

[62] Fix | Delete

[63] Fix | Delete

if ( empty( $body ) ) {

[64] Fix | Delete

return $info;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

$body = json_decode( $body, true );

[68] Fix | Delete

[69] Fix | Delete

return $this->verify_fetched( $body );

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Verify fetched blocks data.

[74] Fix | Delete

*

[75] Fix | Delete

* @since 1.5.4

[76] Fix | Delete

*

[77] Fix | Delete

* @param array $fetched Fetched blocks data.

[78] Fix | Delete

*

[79] Fix | Delete

* @return array

[80] Fix | Delete

*/

[81] Fix | Delete

protected function verify_fetched( $fetched ) {

[82] Fix | Delete

[83] Fix | Delete

$info = [];

[84] Fix | Delete

[85] Fix | Delete

if ( ! \is_array( $fetched ) ) {

[86] Fix | Delete

return $info;

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

foreach ( $fetched as $item ) {

[90] Fix | Delete

[91] Fix | Delete

if ( empty( $item['id'] ) ) {

[92] Fix | Delete

continue;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$id = \absint( $item['id'] );

[96] Fix | Delete

[97] Fix | Delete

if ( empty( $id ) ) {

[98] Fix | Delete

continue;

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

$info[ $id ] = $item;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

return $info;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Get info blocks relevant to customer's licence.

[109] Fix | Delete

*

[110] Fix | Delete

* @since 1.5.4

[111] Fix | Delete

*

[112] Fix | Delete

* @return array

[113] Fix | Delete

*/

[114] Fix | Delete

protected function get_by_license() {

[115] Fix | Delete

[116] Fix | Delete

$data = $this->get_all();

[117] Fix | Delete

$filtered = [];

[118] Fix | Delete

[119] Fix | Delete

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

[120] Fix | Delete

return $filtered;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

// When there is no license, we assume it's a Lite version.

[124] Fix | Delete

// This is needed to show blocks for Lite users, as they don't have a license type.

[125] Fix | Delete

$license_type = wpforms_setting( 'type', 'lite', 'wpforms_license' );

[126] Fix | Delete

[127] Fix | Delete

foreach ( $data as $key => $item ) {

[128] Fix | Delete

[129] Fix | Delete

if ( ! isset( $item['type'] ) || ! \is_array( $item['type'] ) ) {

[130] Fix | Delete

continue;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

if ( ! \in_array( $license_type, $item['type'], true ) ) {

[134] Fix | Delete

continue;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

$filtered[ $key ] = $item;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

return $filtered;

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* Get the first block with a valid id.

[145] Fix | Delete

* Needed to ignore blocks with invalid/missing ids.

[146] Fix | Delete

*

[147] Fix | Delete

* @since 1.5.4

[148] Fix | Delete

*

[149] Fix | Delete

* @param array $data Blocks array.

[150] Fix | Delete

*

[151] Fix | Delete

* @return array

[152] Fix | Delete

*/

[153] Fix | Delete

protected function get_first_with_id( $data ) {

[154] Fix | Delete

[155] Fix | Delete

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

[156] Fix | Delete

return [];

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

foreach ( $data as $item ) {

[160] Fix | Delete

$item_id = \absint( $item['id'] );

[161] Fix | Delete

if ( ! empty( $item_id ) ) {

[162] Fix | Delete

return $item;

[163] Fix | Delete

}

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

return [];

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Get next info block that wasn't sent yet.

[171] Fix | Delete

*

[172] Fix | Delete

* @since 1.5.4

[173] Fix | Delete

*

[174] Fix | Delete

* @return array

[175] Fix | Delete

*/

[176] Fix | Delete

public function get_next() {

[177] Fix | Delete

[178] Fix | Delete

$data = $this->get_by_license();

[179] Fix | Delete

$block = [];

[180] Fix | Delete

[181] Fix | Delete

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

[182] Fix | Delete

return $block;

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

$blocks_sent = \get_option( 'wpforms_emails_infoblocks_sent' );

[186] Fix | Delete

[187] Fix | Delete

if ( empty( $blocks_sent ) || ! \is_array( $blocks_sent ) ) {

[188] Fix | Delete

$block = $this->get_first_with_id( $data );

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

if ( empty( $block ) ) {

[192] Fix | Delete

$data = \array_diff_key( $data, \array_flip( $blocks_sent ) );

[193] Fix | Delete

$block = $this->get_first_with_id( $data );

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

return $block;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Register a block as sent.

[201] Fix | Delete

*

[202] Fix | Delete

* @since 1.5.4

[203] Fix | Delete

*

[204] Fix | Delete

* @param array $info_block Info block.

[205] Fix | Delete

*/

[206] Fix | Delete

public function register_sent( $info_block ) {

[207] Fix | Delete

[208] Fix | Delete

$block_id = isset( $info_block['id'] ) ? absint( $info_block['id'] ) : false;

[209] Fix | Delete

[210] Fix | Delete

if ( empty( $block_id ) ) {

[211] Fix | Delete

return;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

$option_name = 'wpforms_email_summaries_info_blocks_sent';

[215] Fix | Delete

$blocks = get_option( $option_name );

[216] Fix | Delete

[217] Fix | Delete

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

[218] Fix | Delete

update_option( $option_name, [ $block_id ] );

[219] Fix | Delete

[220] Fix | Delete

return;

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

if ( in_array( $block_id, $blocks, true ) ) {

[224] Fix | Delete

return;

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

$blocks[] = $block_id;

[228] Fix | Delete

[229] Fix | Delete

update_option( $option_name, $blocks );

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Get a path of the blocks cache file.

[234] Fix | Delete

*

[235] Fix | Delete

* @since 1.6.4

[236] Fix | Delete

*

[237] Fix | Delete

* @return string

[238] Fix | Delete

*/

[239] Fix | Delete

public function get_cache_file_path() {

[240] Fix | Delete

[241] Fix | Delete

$upload_dir = wpforms_upload_dir();

[242] Fix | Delete

[243] Fix | Delete

if ( ! isset( $upload_dir['path'] ) ) {

[244] Fix | Delete

return '';

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

$cache_dir = trailingslashit( $upload_dir['path'] ) . 'cache';

[248] Fix | Delete

[249] Fix | Delete

return wp_normalize_path( trailingslashit( $cache_dir ) . 'email-summaries.json' );

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Fetch and cache blocks in a file.

[254] Fix | Delete

*

[255] Fix | Delete

* @since 1.6.4

[256] Fix | Delete

*/

[257] Fix | Delete

public function cache_all() {

[258] Fix | Delete

[259] Fix | Delete

$file_path = $this->get_cache_file_path();

[260] Fix | Delete

[261] Fix | Delete

if ( empty( $file_path ) ) {

[262] Fix | Delete

return;

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

$dir = dirname( $file_path );

[266] Fix | Delete

[267] Fix | Delete

if ( ! wp_mkdir_p( $dir ) ) {

[268] Fix | Delete

return;

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

wpforms_create_index_html_file( $dir );

[272] Fix | Delete

wpforms_create_upload_dir_htaccess_file();

[273] Fix | Delete

[274] Fix | Delete

$info_blocks = $this->fetch_all();

[275] Fix | Delete

[276] Fix | Delete

// phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_operations_file_put_contents

[277] Fix | Delete

file_put_contents( $file_path, wp_json_encode( $info_blocks ) );

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Retrieve the source URL.

[282] Fix | Delete

*

[283] Fix | Delete

* @since 1.9.5

[284] Fix | Delete

*

[285] Fix | Delete

* @return string

[286] Fix | Delete

*/

[287] Fix | Delete

protected function get_remote_source(): string {

[288] Fix | Delete

[289] Fix | Delete

$license_type = wpforms()->is_pro() ? wpforms_get_license_type() : 'lite';

[290] Fix | Delete

[291] Fix | Delete

return sprintf( self::SOURCE_URL, $license_type );

[292] Fix | Delete

}

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete