<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Code_Snippets;

[2] Fix | Delete

[3] Fix | Delete

use DateTimeImmutable;

[4] Fix | Delete

use Exception;

[5] Fix | Delete

use WP_Filesystem_Direct;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Class for loading data from the codesnippets.pro website.

[9] Fix | Delete

*

[10] Fix | Delete

* @package Code_Snippets

[11] Fix | Delete

*/

[12] Fix | Delete

class Welcome_API {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* URL for the welcome page data.

[16] Fix | Delete

*

[17] Fix | Delete

* @var string

[18] Fix | Delete

*/

[19] Fix | Delete

protected const WELCOME_JSON_URL = 'https://codesnippets.pro/wp-content/uploads/cs_welcome/cs_welcome.json';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Limit of number of items to display when loading lists of items.

[23] Fix | Delete

*

[24] Fix | Delete

* @var int

[25] Fix | Delete

*/

[26] Fix | Delete

protected const ITEM_LIMIT = 4;

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Limit of number of items of historic versions to display in the changelog.

[30] Fix | Delete

*

[31] Fix | Delete

* @var int

[32] Fix | Delete

*/

[33] Fix | Delete

protected const MAX_CHANGELOG_ENTRIES = 4;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Key used for caching welcome page data.

[37] Fix | Delete

*

[38] Fix | Delete

* @var string

[39] Fix | Delete

*/

[40] Fix | Delete

protected const CACHE_KEY = 'code_snippets_welcome_data';

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Data fetched from the remote API.

[44] Fix | Delete

*

[45] Fix | Delete

* @var array{

[46] Fix | Delete

* banner: ?array,

[47] Fix | Delete

* hero-item: ?array,

[48] Fix | Delete

* features: ?array,

[49] Fix | Delete

* partners: ?array,

[50] Fix | Delete

* changelog: ?array

[51] Fix | Delete

* }

[52] Fix | Delete

*/

[53] Fix | Delete

private array $welcome_data;

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Populate the $welcome_data variable when the class is loaded.

[57] Fix | Delete

*

[58] Fix | Delete

* @return void

[59] Fix | Delete

*/

[60] Fix | Delete

public function __construct() {

[61] Fix | Delete

$stored_data = get_transient( self::CACHE_KEY );

[62] Fix | Delete

[63] Fix | Delete

if ( is_array( $stored_data ) ) {

[64] Fix | Delete

$this->welcome_data = $stored_data;

[65] Fix | Delete

} else {

[66] Fix | Delete

$this->welcome_data = [];

[67] Fix | Delete

$this->fetch_remote_welcome_data();

[68] Fix | Delete

$this->build_changelog_data();

[69] Fix | Delete

set_transient( self::CACHE_KEY, $this->welcome_data, DAY_IN_SECONDS * 2 );

[70] Fix | Delete

}

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Purge the welcome data cache.

[75] Fix | Delete

*

[76] Fix | Delete

* @return void

[77] Fix | Delete

*/

[78] Fix | Delete

public static function clear_cache() {

[79] Fix | Delete

delete_transient( self::CACHE_KEY );

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Safely retrieve an array from an object, ensuring it exists and is valid, returning a default value if not.

[84] Fix | Delete

*

[85] Fix | Delete

* @param array<string, mixed> $items Associative array containing array to extract.

[86] Fix | Delete

* @param string $key Array key.

[87] Fix | Delete

*

[88] Fix | Delete

* @return array Extracted array, or empty array if array is missing.

[89] Fix | Delete

*/

[90] Fix | Delete

private static function safe_get_array( array $items, string $key ): array {

[91] Fix | Delete

return isset( $items[ $key ] ) && is_array( $items[ $key ] ) ? $items[ $key ] : [];

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Parse DateTime value from a string without triggering an error.

[96] Fix | Delete

*

[97] Fix | Delete

* @param string $datetime String representation of DateTime value.

[98] Fix | Delete

*

[99] Fix | Delete

* @return DateTimeImmutable|null

[100] Fix | Delete

*/

[101] Fix | Delete

private static function safe_parse_datetime( string $datetime ): ?DateTimeImmutable {

[102] Fix | Delete

try {

[103] Fix | Delete

return new DateTimeImmutable( $datetime );

[104] Fix | Delete

} catch ( Exception $e ) {

[105] Fix | Delete

return null;

[106] Fix | Delete

}

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Parse remote hero item data.

[111] Fix | Delete

*

[112] Fix | Delete

* @param array $remote Remote hero item data.

[113] Fix | Delete

*

[114] Fix | Delete

* @return array

[115] Fix | Delete

*/

[116] Fix | Delete

private function parse_hero_item( array $remote ): array {

[117] Fix | Delete

return [

[118] Fix | Delete

'name' => $remote[0]['name'] ?? '',

[119] Fix | Delete

'follow_url' => $remote[0]['follow_url'] ?? '',

[120] Fix | Delete

'image_url' => $remote[0]['image_url'] ?? '',

[121] Fix | Delete

];

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Parse remote banner data.

[126] Fix | Delete

*

[127] Fix | Delete

* @param array $remote Remote hero item data.

[128] Fix | Delete

*

[129] Fix | Delete

* @return array

[130] Fix | Delete

*/

[131] Fix | Delete

private function parse_banner( array $remote ): array {

[132] Fix | Delete

return [

[133] Fix | Delete

'key' => sanitize_key( $remote['key'] ) ?? '',

[134] Fix | Delete

'start_datetime' => self::safe_parse_datetime( $remote['start_datetime'] ),

[135] Fix | Delete

'end_datetime' => self::safe_parse_datetime( $remote['end_datetime'] ),

[136] Fix | Delete

'text_free' => $remote['text_free'] ?? '',

[137] Fix | Delete

'action_url_free' => $remote['action_url_free'] ?? '',

[138] Fix | Delete

'action_label_free' => $remote['action_label_free'] ?? '',

[139] Fix | Delete

'text_pro' => $remote['text_pro'] ?? '',

[140] Fix | Delete

'action_url_pro' => $remote['action_url_pro'] ?? '',

[141] Fix | Delete

'action_label_pro' => $remote['action_label_pro'] ?? '',

[142] Fix | Delete

];

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Parse a list of features from a remote dataset.

[147] Fix | Delete

*

[148] Fix | Delete

* @param array $remote Remote data.

[149] Fix | Delete

*

[150] Fix | Delete

* @return array[] Parsed feature data.

[151] Fix | Delete

*/

[152] Fix | Delete

private function parse_features( array $remote ): array {

[153] Fix | Delete

$limit = max( self::ITEM_LIMIT, count( $remote ) );

[154] Fix | Delete

$features = [];

[155] Fix | Delete

[156] Fix | Delete

for ( $i = 0; $i < $limit; $i++ ) {

[157] Fix | Delete

$feature = $remote[ $i ];

[158] Fix | Delete

[159] Fix | Delete

$features[] = [

[160] Fix | Delete

'title' => $feature['title'] ?? '',

[161] Fix | Delete

'follow_url' => $feature['follow_url'] ?? '',

[162] Fix | Delete

'image_url' => $feature['image_url'] ?? '',

[163] Fix | Delete

'category' => $feature['category'] ?? '',

[164] Fix | Delete

'description' => $feature['description'] ?? '',

[165] Fix | Delete

];

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

return $features;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* Parse a list of partners from a remote dataset.

[173] Fix | Delete

*

[174] Fix | Delete

* @param array $remote Remote data.

[175] Fix | Delete

*

[176] Fix | Delete

* @return array[] Parsed partner data.

[177] Fix | Delete

*/

[178] Fix | Delete

private function parse_partners( array $remote ): array {

[179] Fix | Delete

$limit = max( self::ITEM_LIMIT, count( $remote ) );

[180] Fix | Delete

$partners = [];

[181] Fix | Delete

[182] Fix | Delete

for ( $i = 0; $i < $limit; $i++ ) {

[183] Fix | Delete

$partner = $remote[ $i ];

[184] Fix | Delete

[185] Fix | Delete

$partners[] = [

[186] Fix | Delete

'title' => $partner['title'] ?? '',

[187] Fix | Delete

'follow_url' => $partner['follow_url'] ?? '',

[188] Fix | Delete

'image_url' => $partner['image_url'] ?? '',

[189] Fix | Delete

];

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

return $partners;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* Fetch remote welcome data from the remote server and add it to the stored data.

[197] Fix | Delete

*

[198] Fix | Delete

* @return void

[199] Fix | Delete

*/

[200] Fix | Delete

protected function fetch_remote_welcome_data() {

[201] Fix | Delete

$remote_welcome_data = wp_remote_get( self::WELCOME_JSON_URL );

[202] Fix | Delete

[203] Fix | Delete

if ( is_wp_error( $remote_welcome_data ) ) {

[204] Fix | Delete

return;

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

$remote_welcome_data = json_decode( wp_remote_retrieve_body( $remote_welcome_data ), true );

[208] Fix | Delete

[209] Fix | Delete

if ( ! is_array( $remote_welcome_data ) ) {

[210] Fix | Delete

return;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

$this->welcome_data['banner'] = $this->parse_banner( self::safe_get_array( $remote_welcome_data, 'banner' ) );

[214] Fix | Delete

$this->welcome_data['hero-item'] = $this->parse_hero_item( self::safe_get_array( $remote_welcome_data, 'hero-item' ) );

[215] Fix | Delete

$this->welcome_data['features'] = $this->parse_features( self::safe_get_array( $remote_welcome_data, 'features' ) );

[216] Fix | Delete

$this->welcome_data['partners'] = $this->parse_partners( self::safe_get_array( $remote_welcome_data, 'partners' ) );

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

* Build the full list of latest changes for caching.

[221] Fix | Delete

*

[222] Fix | Delete

* @return void

[223] Fix | Delete

*/

[224] Fix | Delete

protected function build_changelog_data() {

[225] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';

[226] Fix | Delete

require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-direct.php';

[227] Fix | Delete

$filesystem = new WP_Filesystem_Direct( null );

[228] Fix | Delete

[229] Fix | Delete

$changelog_filename = 'CHANGELOG.md';

[230] Fix | Delete

$changelog = [];

[231] Fix | Delete

[232] Fix | Delete

$changelog_dir = plugin_dir_path( PLUGIN_FILE );

[233] Fix | Delete

[234] Fix | Delete

while ( plugin_dir_path( $changelog_dir ) !== $changelog_dir && ! $filesystem->exists( $changelog_dir . $changelog_filename ) ) {

[235] Fix | Delete

$changelog_dir = plugin_dir_path( $changelog_dir );

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

if ( ! $filesystem->exists( $changelog_dir . $changelog_filename ) ) {

[239] Fix | Delete

return;

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

$changelog_contents = $filesystem->get_contents( $changelog_dir . $changelog_filename );

[243] Fix | Delete

$changelog_releases = explode( "\n## ", $changelog_contents );

[244] Fix | Delete

[245] Fix | Delete

foreach ( array_slice( $changelog_releases, 1, self::MAX_CHANGELOG_ENTRIES ) as $changelog_release ) {

[246] Fix | Delete

$sections = explode( "\n### ", $changelog_release );

[247] Fix | Delete

[248] Fix | Delete

if ( count( $sections ) < 2 ) {

[249] Fix | Delete

continue;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

$header_parts = explode( '(', $sections[0], 2 );

[253] Fix | Delete

$version = trim( trim( $header_parts[0] ), '[]' );

[254] Fix | Delete

[255] Fix | Delete

$changelog[ $version ] = [];

[256] Fix | Delete

[257] Fix | Delete

foreach ( array_slice( $sections, 1 ) as $section_contents ) {

[258] Fix | Delete

$lines = array_filter( array_map( 'trim', explode( "\n", $section_contents ) ) );

[259] Fix | Delete

$section_type = $lines[0];

[260] Fix | Delete

[261] Fix | Delete

foreach ( array_slice( $lines, 1 ) as $line ) {

[262] Fix | Delete

$entry = trim( str_replace( '(PRO)', '', str_replace( '*', '', $line ) ) );

[263] Fix | Delete

$core_or_pro = false === strpos( $line, '(PRO)' ) ? 'core' : 'pro';

[264] Fix | Delete

[265] Fix | Delete

if ( ! isset( $changelog[ $version ][ $section_type ] ) ) {

[266] Fix | Delete

$changelog[ $version ][ $section_type ] = [

[267] Fix | Delete

$core_or_pro => [ $entry ],

[268] Fix | Delete

];

[269] Fix | Delete

} elseif ( ! isset( $changelog[ $version ][ $section_type ][ $core_or_pro ] ) ) {

[270] Fix | Delete

$changelog[ $version ][ $section_type ][ $core_or_pro ] = [ $entry ];

[271] Fix | Delete

} else {

[272] Fix | Delete

$changelog[ $version ][ $section_type ][ $core_or_pro ][] = $entry;

[273] Fix | Delete

}

[274] Fix | Delete

}

[275] Fix | Delete

}

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

$this->welcome_data['changelog'] = $changelog;

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

/**

[282] Fix | Delete

* Retrieve banner information.

[283] Fix | Delete

*

[284] Fix | Delete

* @return array{

[285] Fix | Delete

* key: string,

[286] Fix | Delete

* start_datetime: ?DateTimeImmutable,

[287] Fix | Delete

* end_datetime: ?DateTimeImmutable,

[288] Fix | Delete

* text_free: string,

[289] Fix | Delete

* action_url_free: string,

[290] Fix | Delete

* action_label_free: string,

[291] Fix | Delete

* text_pro: string,

[292] Fix | Delete

* action_url_pro: string,

[293] Fix | Delete

* action_label_pro: string tet

[294] Fix | Delete

* }

[295] Fix | Delete

*/

[296] Fix | Delete

public function get_banner(): array {

[297] Fix | Delete

return $this->welcome_data['banner'] ?? [];

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

/**

[301] Fix | Delete

* Retrieve hero information.

[302] Fix | Delete

*

[303] Fix | Delete

* @return array{

[304] Fix | Delete

* name: string,

[305] Fix | Delete

* follow_url: string,

[306] Fix | Delete

* image_url: string

[307] Fix | Delete

* }

[308] Fix | Delete

*/

[309] Fix | Delete

public function get_hero_item(): array {

[310] Fix | Delete

return $this->welcome_data['hero-item'] ?? [];

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

/**

[314] Fix | Delete

* Retrieve the list of features retrieved from the remote API.

[315] Fix | Delete

*

[316] Fix | Delete

* @return array{

[317] Fix | Delete

* title: string,

[318] Fix | Delete

* follow_url: string,

[319] Fix | Delete

* image_url: string,

[320] Fix | Delete

* category: string,

[321] Fix | Delete

* description: string

[322] Fix | Delete

* }[] Feature details.

[323] Fix | Delete

*/

[324] Fix | Delete

public function get_features(): array {

[325] Fix | Delete

return $this->welcome_data['features'] ?? [];

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

/**

[329] Fix | Delete

* Retrieve the list of partners retrieved from the remote API.

[330] Fix | Delete

*

[331] Fix | Delete

* @return array{

[332] Fix | Delete

* title: string,

[333] Fix | Delete

* follow_url: string,

[334] Fix | Delete

* image_url: string

[335] Fix | Delete

* }[] Partner details.

[336] Fix | Delete

*/

[337] Fix | Delete

public function get_partners(): array {

[338] Fix | Delete

return $this->welcome_data['partners'] ?? [];

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

/**

[342] Fix | Delete

* Retrieve a list of latest changes for display.

[343] Fix | Delete

*

[344] Fix | Delete

* @return array<string, array{

[345] Fix | Delete

* 'Added': ?array<'core' | 'pro', string>,

[346] Fix | Delete

* 'Fixed': ?array<'core' | 'pro', string>,

[347] Fix | Delete

* 'Improved': ?array<'core' | 'pro', string>,

[348] Fix | Delete

* 'Other': ?array<'core' | 'pro', string>

[349] Fix | Delete

* }>

[350] Fix | Delete

*/

[351] Fix | Delete

public function get_changelog(): array {

[352] Fix | Delete

return $this->welcome_data['changelog'] ?? [];

[353] Fix | Delete

}

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete