<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Notifications;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Notifications.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.7.5

[7] Fix | Delete

*/

[8] Fix | Delete

class Notifications {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Source of notifications content.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.7.5

[14] Fix | Delete

*

[15] Fix | Delete

* @var string

[16] Fix | Delete

*/

[17] Fix | Delete

const SOURCE_URL = 'https://wpformsapi.com/feeds/v1/notifications';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Array of license types, that are considered being Elite level.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.7.5

[23] Fix | Delete

*

[24] Fix | Delete

* @var array

[25] Fix | Delete

*/

[26] Fix | Delete

const LICENSES_ELITE = [ 'agency', 'ultimate', 'elite' ];

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Option value.

[30] Fix | Delete

*

[31] Fix | Delete

* @since 1.7.5

[32] Fix | Delete

*

[33] Fix | Delete

* @var bool|array

[34] Fix | Delete

*/

[35] Fix | Delete

public $option = false;

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Current license type.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 1.7.5

[41] Fix | Delete

*

[42] Fix | Delete

* @var string

[43] Fix | Delete

*/

[44] Fix | Delete

private $license_type;

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Initialize class.

[48] Fix | Delete

*

[49] Fix | Delete

* @since 1.7.5

[50] Fix | Delete

*/

[51] Fix | Delete

public function init() {

[52] Fix | Delete

[53] Fix | Delete

$this->hooks();

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Register hooks.

[58] Fix | Delete

*

[59] Fix | Delete

* @since 1.7.5

[60] Fix | Delete

*/

[61] Fix | Delete

public function hooks() {

[62] Fix | Delete

[63] Fix | Delete

add_action( 'wpforms_admin_notifications_update', [ $this, 'update' ] );

[64] Fix | Delete

[65] Fix | Delete

if ( ! wpforms_is_admin_ajax() && ! is_admin() ) {

[66] Fix | Delete

return;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

add_action( 'wpforms_overview_enqueue', [ $this, 'enqueues' ] );

[70] Fix | Delete

[71] Fix | Delete

add_action( 'wpforms_admin_overview_before_table', [ $this, 'output' ] );

[72] Fix | Delete

[73] Fix | Delete

add_action( 'deactivate_plugin', [ $this, 'delete' ], 10, 2 );

[74] Fix | Delete

[75] Fix | Delete

add_action( 'wp_ajax_wpforms_notification_dismiss', [ $this, 'dismiss' ] );

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Check if user has access and is enabled.

[80] Fix | Delete

*

[81] Fix | Delete

* @since 1.7.5

[82] Fix | Delete

* @since 1.8.2 Added AS task support.

[83] Fix | Delete

*

[84] Fix | Delete

* @return bool

[85] Fix | Delete

*/

[86] Fix | Delete

public function has_access() {

[87] Fix | Delete

[88] Fix | Delete

$has_access = ! wpforms_setting( 'hide-announcements', false );

[89] Fix | Delete

[90] Fix | Delete

if ( ! wp_doing_cron() && ! wpforms_doing_wp_cli() ) {

[91] Fix | Delete

$has_access = $has_access && wpforms_current_user_can( 'view_forms' );

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

/**

[95] Fix | Delete

* Allow modifying state if a user has access.

[96] Fix | Delete

*

[97] Fix | Delete

* @since 1.6.0

[98] Fix | Delete

*

[99] Fix | Delete

* @param bool $access True if user has access.

[100] Fix | Delete

*/

[101] Fix | Delete

return (bool) apply_filters( 'wpforms_admin_notifications_has_access', $has_access );

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Get option value.

[106] Fix | Delete

*

[107] Fix | Delete

* @since 1.7.5

[108] Fix | Delete

*

[109] Fix | Delete

* @param bool $cache Reference property cache if available.

[110] Fix | Delete

*

[111] Fix | Delete

* @return array

[112] Fix | Delete

*/

[113] Fix | Delete

public function get_option( $cache = true ) {

[114] Fix | Delete

[115] Fix | Delete

if ( $this->option && $cache ) {

[116] Fix | Delete

return $this->option;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

$option = (array) get_option( 'wpforms_notifications', [] );

[120] Fix | Delete

[121] Fix | Delete

$this->option = [

[122] Fix | Delete

'update' => ! empty( $option['update'] ) ? (int) $option['update'] : 0,

[123] Fix | Delete

'feed' => ! empty( $option['feed'] ) ? (array) $option['feed'] : [],

[124] Fix | Delete

'events' => ! empty( $option['events'] ) ? (array) $option['events'] : [],

[125] Fix | Delete

'dismissed' => ! empty( $option['dismissed'] ) ? (array) $option['dismissed'] : [],

[126] Fix | Delete

];

[127] Fix | Delete

[128] Fix | Delete

return $this->option;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Fetch notifications from feed.

[133] Fix | Delete

*

[134] Fix | Delete

* @since 1.7.5

[135] Fix | Delete

*

[136] Fix | Delete

* @return array

[137] Fix | Delete

*/

[138] Fix | Delete

public function fetch_feed() {

[139] Fix | Delete

[140] Fix | Delete

$response = wp_remote_get(

[141] Fix | Delete

self::SOURCE_URL,

[142] Fix | Delete

[

[143] Fix | Delete

'timeout' => 10,

[144] Fix | Delete

'user-agent' => wpforms_get_default_user_agent(),

[145] Fix | Delete

]

[146] Fix | Delete

);

[147] Fix | Delete

[148] Fix | Delete

if ( is_wp_error( $response ) ) {

[149] Fix | Delete

return [];

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

$body = wp_remote_retrieve_body( $response );

[153] Fix | Delete

[154] Fix | Delete

if ( empty( $body ) ) {

[155] Fix | Delete

return [];

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

return $this->verify( json_decode( $body, true ) );

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Verify notification data before it is saved.

[163] Fix | Delete

*

[164] Fix | Delete

* @since 1.7.5

[165] Fix | Delete

*

[166] Fix | Delete

* @param array $notifications Array of notifications items to verify.

[167] Fix | Delete

*

[168] Fix | Delete

* @return array

[169] Fix | Delete

*/

[170] Fix | Delete

public function verify( $notifications ) {

[171] Fix | Delete

[172] Fix | Delete

$data = [];

[173] Fix | Delete

[174] Fix | Delete

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

[175] Fix | Delete

return $data;

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

foreach ( $notifications as $notification ) {

[179] Fix | Delete

[180] Fix | Delete

// Ignore if one of the conditional checks is true:

[181] Fix | Delete

//

[182] Fix | Delete

// 1. notification message is empty.

[183] Fix | Delete

// 2. license type does not match.

[184] Fix | Delete

// 3. notification is expired.

[185] Fix | Delete

// 4. notification has already been dismissed.

[186] Fix | Delete

// 5. notification existed before installing WPForms.

[187] Fix | Delete

// (Prevents bombarding the user with notifications after activation).

[188] Fix | Delete

if (

[189] Fix | Delete

empty( $notification['content'] ) ||

[190] Fix | Delete

! $this->is_license_type_match( $notification ) ||

[191] Fix | Delete

$this->is_expired( $notification ) ||

[192] Fix | Delete

$this->is_dismissed( $notification ) ||

[193] Fix | Delete

$this->is_existed( $notification )

[194] Fix | Delete

) {

[195] Fix | Delete

continue;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

$data[] = $notification;

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

return $data;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Verify saved notification data for active notifications.

[206] Fix | Delete

*

[207] Fix | Delete

* @since 1.7.5

[208] Fix | Delete

*

[209] Fix | Delete

* @param array $notifications Array of notifications items to verify.

[210] Fix | Delete

*

[211] Fix | Delete

* @return array

[212] Fix | Delete

*/

[213] Fix | Delete

public function verify_active( $notifications ) {

[214] Fix | Delete

[215] Fix | Delete

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

[216] Fix | Delete

return [];

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

$current_timestamp = time();

[220] Fix | Delete

[221] Fix | Delete

// Remove notifications that are not active.

[222] Fix | Delete

foreach ( $notifications as $key => $notification ) {

[223] Fix | Delete

if (

[224] Fix | Delete

( ! empty( $notification['start'] ) && $current_timestamp < strtotime( $notification['start'] ) ) ||

[225] Fix | Delete

( ! empty( $notification['end'] ) && $current_timestamp > strtotime( $notification['end'] ) )

[226] Fix | Delete

) {

[227] Fix | Delete

unset( $notifications[ $key ] );

[228] Fix | Delete

}

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

return $notifications;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

/**

[235] Fix | Delete

* Get notification data.

[236] Fix | Delete

*

[237] Fix | Delete

* @since 1.7.5

[238] Fix | Delete

*

[239] Fix | Delete

* @return array

[240] Fix | Delete

*/

[241] Fix | Delete

public function get() {

[242] Fix | Delete

[243] Fix | Delete

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

[244] Fix | Delete

return [];

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

$option = $this->get_option();

[248] Fix | Delete

[249] Fix | Delete

// Update notifications using async task.

[250] Fix | Delete

if ( empty( $option['update'] ) || time() > $option['update'] + DAY_IN_SECONDS ) {

[251] Fix | Delete

[252] Fix | Delete

$tasks = wpforms()->obj( 'tasks' );

[253] Fix | Delete

[254] Fix | Delete

if ( ! $tasks->is_scheduled( 'wpforms_admin_notifications_update' ) !== false ) {

[255] Fix | Delete

$tasks

[256] Fix | Delete

->create( 'wpforms_admin_notifications_update' )

[257] Fix | Delete

->async()

[258] Fix | Delete

->params()

[259] Fix | Delete

->register();

[260] Fix | Delete

}

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

$feed = ! empty( $option['feed'] ) ? $this->verify_active( $option['feed'] ) : [];

[264] Fix | Delete

$events = ! empty( $option['events'] ) ? $this->verify_active( $option['events'] ) : [];

[265] Fix | Delete

[266] Fix | Delete

return array_merge( $feed, $events );

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

/**

[270] Fix | Delete

* Get notification count.

[271] Fix | Delete

*

[272] Fix | Delete

* @since 1.7.5

[273] Fix | Delete

*

[274] Fix | Delete

* @return int

[275] Fix | Delete

*/

[276] Fix | Delete

public function get_count() {

[277] Fix | Delete

[278] Fix | Delete

return count( $this->get() );

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

/**

[282] Fix | Delete

* Add a new Event Driven notification.

[283] Fix | Delete

*

[284] Fix | Delete

* @since 1.7.5

[285] Fix | Delete

*

[286] Fix | Delete

* @param array $notification Notification data.

[287] Fix | Delete

*/

[288] Fix | Delete

public function add( $notification ) {

[289] Fix | Delete

[290] Fix | Delete

if ( ! $this->is_valid( $notification ) ) {

[291] Fix | Delete

return;

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

$option = $this->get_option();

[295] Fix | Delete

[296] Fix | Delete

// Notification ID already exists.

[297] Fix | Delete

if ( ! empty( $option['events'][ $notification['id'] ] ) ) {

[298] Fix | Delete

return;

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

update_option(

[302] Fix | Delete

'wpforms_notifications',

[303] Fix | Delete

[

[304] Fix | Delete

'update' => $option['update'],

[305] Fix | Delete

'feed' => $option['feed'],

[306] Fix | Delete

'events' => array_merge( $notification, $option['events'] ),

[307] Fix | Delete

'dismissed' => $option['dismissed'],

[308] Fix | Delete

]

[309] Fix | Delete

);

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

/**

[313] Fix | Delete

* Determine if notification data is valid.

[314] Fix | Delete

*

[315] Fix | Delete

* @since 1.7.5

[316] Fix | Delete

*

[317] Fix | Delete

* @param array $notification Notification data.

[318] Fix | Delete

*

[319] Fix | Delete

* @return bool

[320] Fix | Delete

*/

[321] Fix | Delete

public function is_valid( $notification ) {

[322] Fix | Delete

[323] Fix | Delete

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

[324] Fix | Delete

return false;

[325] Fix | Delete

}

[326] Fix | Delete

[327] Fix | Delete

return ! empty( $this->verify( [ $notification ] ) );

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

/**

[331] Fix | Delete

* Determine if notification has already been dismissed.

[332] Fix | Delete

*

[333] Fix | Delete

* @since 1.7.5

[334] Fix | Delete

*

[335] Fix | Delete

* @param array $notification Notification data.

[336] Fix | Delete

*

[337] Fix | Delete

* @return bool

[338] Fix | Delete

*/

[339] Fix | Delete

private function is_dismissed( $notification ) {

[340] Fix | Delete

[341] Fix | Delete

$option = $this->get_option();

[342] Fix | Delete

[343] Fix | Delete

// phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict

[344] Fix | Delete

return ! empty( $option['dismissed'] ) && in_array( $notification['id'], $option['dismissed'] );

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

/**

[348] Fix | Delete

* Determine if license type is match.

[349] Fix | Delete

*

[350] Fix | Delete

* @since 1.7.5

[351] Fix | Delete

*

[352] Fix | Delete

* @param array $notification Notification data.

[353] Fix | Delete

*

[354] Fix | Delete

* @return bool

[355] Fix | Delete

*/

[356] Fix | Delete

private function is_license_type_match( $notification ) {

[357] Fix | Delete

[358] Fix | Delete

// A specific license type is not required.

[359] Fix | Delete

if ( empty( $notification['type'] ) ) {

[360] Fix | Delete

return true;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

return in_array( $this->get_license_type(), (array) $notification['type'], true );

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

/**

[367] Fix | Delete

* Determine if notification is expired.

[368] Fix | Delete

*

[369] Fix | Delete

* @since 1.7.5

[370] Fix | Delete

*

[371] Fix | Delete

* @param array $notification Notification data.

[372] Fix | Delete

*

[373] Fix | Delete

* @return bool

[374] Fix | Delete

*/

[375] Fix | Delete

private function is_expired( $notification ) {

[376] Fix | Delete

[377] Fix | Delete

return ! empty( $notification['end'] ) && time() > strtotime( $notification['end'] );

[378] Fix | Delete

}

[379] Fix | Delete

[380] Fix | Delete

/**

[381] Fix | Delete

* Determine if notification existed before installing WPForms.

[382] Fix | Delete

*

[383] Fix | Delete

* @since 1.7.5

[384] Fix | Delete

*

[385] Fix | Delete

* @param array $notification Notification data.

[386] Fix | Delete

*

[387] Fix | Delete

* @return bool

[388] Fix | Delete

*/

[389] Fix | Delete

private function is_existed( $notification ) {

[390] Fix | Delete

[391] Fix | Delete

$activated = wpforms_get_activated_timestamp();

[392] Fix | Delete

[393] Fix | Delete

return ! empty( $activated ) &&

[394] Fix | Delete

! empty( $notification['start'] ) &&

[395] Fix | Delete

$activated > strtotime( $notification['start'] );

[396] Fix | Delete

}

[397] Fix | Delete

[398] Fix | Delete

/**

[399] Fix | Delete

* Update notification data from feed.

[400] Fix | Delete

*

[401] Fix | Delete

* @since 1.7.5

[402] Fix | Delete

* @since 1.7.8 Added `wp_cache_flush()` call when the option has been updated.

[403] Fix | Delete

* @since 1.8.2 Don't fire the update action when it disabled or was fired recently.

[404] Fix | Delete

*/

[405] Fix | Delete

public function update() {

[406] Fix | Delete

[407] Fix | Delete

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

[408] Fix | Delete

return;

[409] Fix | Delete

}

[410] Fix | Delete

[411] Fix | Delete

$option = $this->get_option();

[412] Fix | Delete

[413] Fix | Delete

// Double-check the last update time to prevent multiple requests.

[414] Fix | Delete

if ( ! empty( $option['update'] ) && time() < $option['update'] + DAY_IN_SECONDS ) {

[415] Fix | Delete

return;

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

$data = [

[419] Fix | Delete

'feed' => $this->fetch_feed(),

[420] Fix | Delete

'events' => $option['events'],

[421] Fix | Delete

'dismissed' => $option['dismissed'],

[422] Fix | Delete

];

[423] Fix | Delete

[424] Fix | Delete

// phpcs:disable WPForms.PHP.ValidateHooks.InvalidHookName

[425] Fix | Delete

/**

[426] Fix | Delete

* Allow changing notification data before it will be updated in database.

[427] Fix | Delete

*

[428] Fix | Delete

* @since 1.7.5

[429] Fix | Delete

*

[430] Fix | Delete

* @param array $data New notification data.

[431] Fix | Delete

*/

[432] Fix | Delete

$data = (array) apply_filters( 'wpforms_admin_notifications_update_data', $data );

[433] Fix | Delete

// phpcs:enable WPForms.PHP.ValidateHooks.InvalidHookName

[434] Fix | Delete

[435] Fix | Delete

$data['update'] = time();

[436] Fix | Delete

[437] Fix | Delete

update_option( 'wpforms_notifications', $data );

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete

/**

[441] Fix | Delete

* Remove notification data from database before a plugin is deactivated.

[442] Fix | Delete

*

[443] Fix | Delete

* @since 1.7.5

[444] Fix | Delete

*

[445] Fix | Delete

* @param string $plugin Path to the plugin file relative to the plugins directory.

[446] Fix | Delete

* @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network

[447] Fix | Delete

* or just the current site. Multisite only. Default false.

[448] Fix | Delete

*/

[449] Fix | Delete

public function delete( $plugin, $network_deactivating ) {

[450] Fix | Delete

[451] Fix | Delete

$wpforms_plugins = [

[452] Fix | Delete

'wpforms-lite/wpforms.php',

[453] Fix | Delete

'wpforms/wpforms.php',

[454] Fix | Delete

];

[455] Fix | Delete

[456] Fix | Delete

if ( ! in_array( $plugin, $wpforms_plugins, true ) ) {

[457] Fix | Delete

return;

[458] Fix | Delete

}

[459] Fix | Delete

[460] Fix | Delete

delete_option( 'wpforms_notifications' );

[461] Fix | Delete

}

[462] Fix | Delete

[463] Fix | Delete

/**

[464] Fix | Delete

* Enqueue assets on Form Overview admin page.

[465] Fix | Delete

*

[466] Fix | Delete

* @since 1.7.5

[467] Fix | Delete

*/

[468] Fix | Delete

public function enqueues() {

[469] Fix | Delete

[470] Fix | Delete

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

[471] Fix | Delete

return;

[472] Fix | Delete

}

[473] Fix | Delete

[474] Fix | Delete

$min = wpforms_get_min_suffix();

[475] Fix | Delete

[476] Fix | Delete

wp_enqueue_style(

[477] Fix | Delete

'wpforms-admin-notifications',

[478] Fix | Delete

WPFORMS_PLUGIN_URL . "assets/css/admin-notifications{$min}.css",

[479] Fix | Delete

[ 'wpforms-lity' ],

[480] Fix | Delete

WPFORMS_VERSION

[481] Fix | Delete

);

[482] Fix | Delete

[483] Fix | Delete

wp_enqueue_script(

[484] Fix | Delete

'wpforms-admin-notifications',

[485] Fix | Delete

WPFORMS_PLUGIN_URL . "assets/js/admin/admin-notifications{$min}.js",

[486] Fix | Delete

[ 'jquery', 'wpforms-lity' ],

[487] Fix | Delete

WPFORMS_VERSION,

[488] Fix | Delete

true

[489] Fix | Delete

);

[490] Fix | Delete

[491] Fix | Delete

// Lity.

[492] Fix | Delete

wp_enqueue_style(

[493] Fix | Delete

'wpforms-lity',

[494] Fix | Delete

WPFORMS_PLUGIN_URL . 'assets/lib/lity/lity.min.css',

[495] Fix | Delete

[],

[496] Fix | Delete

WPFORMS_VERSION

[497] Fix | Delete

);

[498] Fix | Delete

[499] Fix | Delete