Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* CTF_Notifications.

[2] Fix | Delete

[3] Fix | Delete

* @since 2.0

[4] Fix | Delete

[5] Fix | Delete

namespace TwitterFeed\Admin;

[6] Fix | Delete

[7] Fix | Delete

// Exit if accessed directly

[8] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[9] Fix | Delete

exit;

[10] Fix | Delete

}

[11] Fix | Delete

[12] Fix | Delete

class CTF_Notifications {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Source of notifications content.

[16] Fix | Delete

[17] Fix | Delete

* @var string

[18] Fix | Delete

[19] Fix | Delete

const SOURCE_URL = 'https://plugin.smashballoon.com/notifications.json';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* @var string

[23] Fix | Delete

[24] Fix | Delete

const OPTION_NAME = 'ctf_notifications';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* JSON data contains notices for all plugins. This is used

[28] Fix | Delete

* to select messages only meant for this plugin

[29] Fix | Delete

[30] Fix | Delete

* @var string

[31] Fix | Delete

[32] Fix | Delete

const PLUGIN = 'twitter';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Option value.

[36] Fix | Delete

[37] Fix | Delete

* @since 2.0

[38] Fix | Delete

[39] Fix | Delete

* @var bool|array

[40] Fix | Delete

[41] Fix | Delete

public $option = false;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Initialize class.

[45] Fix | Delete

[46] Fix | Delete

* @since 2.0

[47] Fix | Delete

[48] Fix | Delete

public function init() {

[49] Fix | Delete

$this->hooks();

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Use this function to get the option name to allow

[54] Fix | Delete

* inheritance for the New_User class

[55] Fix | Delete

[56] Fix | Delete

* @return string

[57] Fix | Delete

[58] Fix | Delete

public function option_name() {

[59] Fix | Delete

return self::OPTION_NAME;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Use this function to get the source URL to allow

[64] Fix | Delete

* inheritance for the New_User class

[65] Fix | Delete

[66] Fix | Delete

* @return string

[67] Fix | Delete

[68] Fix | Delete

public function source_url() {

[69] Fix | Delete

return self::SOURCE_URL;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Register hooks.

[74] Fix | Delete

[75] Fix | Delete

* @since 2.0

[76] Fix | Delete

[77] Fix | Delete

public function hooks() {

[78] Fix | Delete

add_action( 'admin_enqueue_scripts', array( $this, 'enqueues' ) );

[79] Fix | Delete

[80] Fix | Delete

add_action( 'ctf_admin_notices', array( $this, 'output' ) );

[81] Fix | Delete

[82] Fix | Delete

// on cron. Once a week?

[83] Fix | Delete

add_action( 'ctf_notification_update', array( $this, 'update' ) );

[84] Fix | Delete

[85] Fix | Delete

add_action( 'wp_ajax_ctf_dashboard_notification_dismiss', array( $this, 'dismiss' ) );

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Check if user has access and is enabled.

[91] Fix | Delete

[92] Fix | Delete

* @since 2.0

[93] Fix | Delete

[94] Fix | Delete

* @return bool

[95] Fix | Delete

[96] Fix | Delete

public function has_access() {

[97] Fix | Delete

$access = false;

[98] Fix | Delete

[99] Fix | Delete

if ( current_user_can( 'manage_twitter_feed_options' ) || current_user_can( 'manage_options' ) ) {

[100] Fix | Delete

$access = true;

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

return apply_filters( 'ctf_admin_notifications_has_access', $access );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Get option value.

[108] Fix | Delete

[109] Fix | Delete

* @since 2.0

[110] Fix | Delete

[111] Fix | Delete

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

[112] Fix | Delete

[113] Fix | Delete

* @return array

[114] Fix | Delete

[115] Fix | Delete

public function get_option( $cache = true ) {

[116] Fix | Delete

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

[117] Fix | Delete

return $this->option;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

$option = get_option( $this->option_name(), array() );

[121] Fix | Delete

[122] Fix | Delete

$this->option = array(

[123] Fix | Delete

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

[124] Fix | Delete

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

[125] Fix | Delete

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

[126] Fix | Delete

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

[127] Fix | Delete

);

[128] Fix | Delete

[129] Fix | Delete

return $this->option;

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Fetch notifications from feed.

[134] Fix | Delete

[135] Fix | Delete

* @since 2.0

[136] Fix | Delete

[137] Fix | Delete

* @return array

[138] Fix | Delete

[139] Fix | Delete

public function fetch_feed() {

[140] Fix | Delete

$res = wp_remote_get( $this->source_url() );

[141] Fix | Delete

[142] Fix | Delete

if ( is_wp_error( $res ) ) {

[143] Fix | Delete

return array();

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

$body = wp_remote_retrieve_body( $res );

[147] Fix | Delete

[148] Fix | Delete

if ( empty( $body ) ) {

[149] Fix | Delete

return array();

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

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

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* Verify notification data before it is saved.

[157] Fix | Delete

[158] Fix | Delete

* @since 2.0

[159] Fix | Delete

[160] Fix | Delete

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

[161] Fix | Delete

[162] Fix | Delete

* @return array

[163] Fix | Delete

[164] Fix | Delete

public function verify( $notifications ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh

[165] Fix | Delete

$data = array();

[166] Fix | Delete

[167] Fix | Delete

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

[168] Fix | Delete

return $data;

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

$option = $this->get_option();

[172] Fix | Delete

[173] Fix | Delete

foreach ( $notifications as $notification ) {

[174] Fix | Delete

// Ignore if not a targeted plugin

[175] Fix | Delete

if ( ! empty( $notification['plugin'] ) && is_array( $notification['plugin'] ) && ! in_array( self::PLUGIN, $notification['plugin'], true ) ) {

[176] Fix | Delete

continue;

[177] Fix | Delete

}

[178] Fix | Delete

[179] Fix | Delete

// Ignore if max wp version detected

[180] Fix | Delete

if ( ! empty( $notification['maxwpver'] ) && version_compare( get_bloginfo( 'version' ), $notification['maxwpver'], '>' ) ) {

[181] Fix | Delete

continue;

[182] Fix | Delete

}

[183] Fix | Delete

[184] Fix | Delete

// Ignore if max version has been reached

[185] Fix | Delete

if ( ! empty( $notification['maxver'] ) && version_compare( $notification['maxver'], CTF_VERSION ) < 0 ) {

[186] Fix | Delete

continue;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

// Ignore if min version has not been reached

[190] Fix | Delete

if ( ! empty( $notification['minver'] ) && version_compare( $notification['minver'], CTF_VERSION ) > 0 ) {

[191] Fix | Delete

continue;

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

// Ignore if a specific ctf_status is empty or false

[195] Fix | Delete

if ( ! empty( $notification['statuscheck'] ) ) {

[196] Fix | Delete

$status_key = sanitize_key( $notification['statuscheck'] );

[197] Fix | Delete

$ctf_statuses_option = get_option( 'ctf_statuses', array() );

[198] Fix | Delete

[199] Fix | Delete

if ( empty( $ctf_statuses_option[ $status_key ] ) ) {

[200] Fix | Delete

continue;

[201] Fix | Delete

}

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

// The message and license should never be empty, if they are, ignore.

[205] Fix | Delete

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

[206] Fix | Delete

continue;

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

// Ignore if license type does not match.

[210] Fix | Delete

$license = ctf_is_pro_version() ? 'pro' : 'free';

[211] Fix | Delete

[212] Fix | Delete

if ( ! in_array( $license, $notification['type'], true ) ) {

[213] Fix | Delete

continue;

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

// Ignore if expired.

[217] Fix | Delete

if ( ! empty( $notification['end'] ) && ctf_get_current_time() > strtotime( $notification['end'] ) ) {

[218] Fix | Delete

continue;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

// Ignore if notification has already been dismissed.

[222] Fix | Delete

if ( ! empty( $option['dismissed'] ) && in_array( $notification['id'], $option['dismissed'] ) ) { // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict

[223] Fix | Delete

continue;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

// Ignore message "9".

[227] Fix | Delete

if ( in_array( (int)$notification['id'], array( 9 ) ) ) { // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict

[228] Fix | Delete

continue;

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

// TODO: Ignore if notification existed before installing CTF.

[232] Fix | Delete

// Prevents bombarding the user with notifications after activation.

[233] Fix | Delete

$activated = false;

[234] Fix | Delete

if ( ! empty( $activated )

[235] Fix | Delete

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

[236] Fix | Delete

&& $activated > strtotime( $notification['start'] ) ) {

[237] Fix | Delete

continue;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

$data[] = $notification;

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

return $data;

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

/**

[247] Fix | Delete

* Verify saved notification data for active notifications.

[248] Fix | Delete

[249] Fix | Delete

* @since 2.0

[250] Fix | Delete

[251] Fix | Delete

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

[252] Fix | Delete

[253] Fix | Delete

* @return array

[254] Fix | Delete

[255] Fix | Delete

public function verify_active( $notifications ) {

[256] Fix | Delete

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

[257] Fix | Delete

return array();

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

// Remove notfications that are not active.

[261] Fix | Delete

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

[262] Fix | Delete

if ( ( ! empty( $notification['start'] ) && ctf_get_current_time() < strtotime( $notification['start'] ) )

[263] Fix | Delete

|| ( ! empty( $notification['end'] ) && ctf_get_current_time() > strtotime( $notification['end'] ) ) ) {

[264] Fix | Delete

unset( $notifications[ $key ] );

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

if ( empty( $notification['recent_install_override'] ) && $this->recently_installed() ) {

[268] Fix | Delete

unset( $notifications[ $key ] );

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

// Ignore if max version has been reached

[272] Fix | Delete

if ( ! empty( $notification['maxver'] ) && version_compare( $notification['maxver'], CTF_VERSION ) < 0 ) {

[273] Fix | Delete

unset( $notifications[ $key ] );

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

// Ignore if max wp version detected

[277] Fix | Delete

if ( ! empty( $notification['maxwpver'] ) && version_compare( get_bloginfo( 'version' ), $notification['maxwpver'], '>' ) ) {

[278] Fix | Delete

unset( $notifications[ $key ] );

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

// Ignore if min version has not been reached

[282] Fix | Delete

if ( ! empty( $notification['minver'] ) && version_compare( $notification['minver'], CTF_VERSION ) > 0 ) {

[283] Fix | Delete

unset( $notifications[ $key ] );

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

// Ignore if a specific ctf_status is empty or false

[287] Fix | Delete

if ( ! empty( $notification['statuscheck'] ) ) {

[288] Fix | Delete

$status_key = sanitize_key( $notification['statuscheck'] );

[289] Fix | Delete

$ctf_statuses_option = get_option( 'ctf_statuses', array() );

[290] Fix | Delete

[291] Fix | Delete

if ( empty( $ctf_statuses_option[ $status_key ] ) ) {

[292] Fix | Delete

unset( $notifications[ $key ] );

[293] Fix | Delete

}

[294] Fix | Delete

}

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

return $notifications;

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

/**

[301] Fix | Delete

* @return bool

[302] Fix | Delete

[303] Fix | Delete

* @since 1.4.5/1.4.2

[304] Fix | Delete

[305] Fix | Delete

public function recently_installed() {

[306] Fix | Delete

$ctf_statuses_option = get_option( 'ctf_statuses', array() );

[307] Fix | Delete

[308] Fix | Delete

if ( ! isset( $ctf_statuses_option['first_install'] ) ) {

[309] Fix | Delete

return false;

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

// Plugin was installed less than a week ago

[313] Fix | Delete

if ( (int) $ctf_statuses_option['first_install'] > time() - WEEK_IN_SECONDS ) {

[314] Fix | Delete

return true;

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

return false;

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

/**

[321] Fix | Delete

* Get notification data.

[322] Fix | Delete

[323] Fix | Delete

* @since 2.0

[324] Fix | Delete

[325] Fix | Delete

* @return array

[326] Fix | Delete

[327] Fix | Delete

public function get() {

[328] Fix | Delete

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

[329] Fix | Delete

return array();

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

$option = $this->get_option();

[333] Fix | Delete

[334] Fix | Delete

// Update notifications using async task.

[335] Fix | Delete

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

[336] Fix | Delete

$this->update();

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete

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

[340] Fix | Delete

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

[341] Fix | Delete

[342] Fix | Delete

// If there is a new user notification, add it to the beginning of the notification list

[343] Fix | Delete

$ctf_newuser = new CTF_New_User();

[344] Fix | Delete

$newuser_notifications = $ctf_newuser->get();

[345] Fix | Delete

[346] Fix | Delete

if ( ! empty( $newuser_notifications ) ) {

[347] Fix | Delete

$events = array_merge( $newuser_notifications, $events );

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

return array_merge( $events, $feed );

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Get notification count.

[355] Fix | Delete

[356] Fix | Delete

* @since 2.0

[357] Fix | Delete

[358] Fix | Delete

* @return int

[359] Fix | Delete

[360] Fix | Delete

public function get_count() {

[361] Fix | Delete

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

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* Add a manual notification event.

[366] Fix | Delete

[367] Fix | Delete

* @since 2.0

[368] Fix | Delete

[369] Fix | Delete

* @param array $notification Notification data.

[370] Fix | Delete

[371] Fix | Delete

public function add( $notification ) {

[372] Fix | Delete

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

[373] Fix | Delete

return;

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete

$option = $this->get_option();

[377] Fix | Delete

[378] Fix | Delete

if ( in_array( $notification['id'], $option['dismissed'] ) ) { // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict

[379] Fix | Delete

return;

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

foreach ( $option['events'] as $item ) {

[383] Fix | Delete

if ( $item['id'] === $notification['id'] ) {

[384] Fix | Delete

return;

[385] Fix | Delete

}

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

$notification = $this->verify( array( $notification ) );

[389] Fix | Delete

[390] Fix | Delete

update_option(

[391] Fix | Delete

'ctf_notifications',

[392] Fix | Delete

array(

[393] Fix | Delete

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

[394] Fix | Delete

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

[395] Fix | Delete

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

[396] Fix | Delete

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

[397] Fix | Delete

)

[398] Fix | Delete

);

[399] Fix | Delete

}

[400] Fix | Delete

[401] Fix | Delete

/**

[402] Fix | Delete

* Update notification data from feed.

[403] Fix | Delete

[404] Fix | Delete

* @since 2.0

[405] Fix | Delete

[406] Fix | Delete

public function update() {

[407] Fix | Delete

$feed = $this->fetch_feed();

[408] Fix | Delete

$option = $this->get_option();

[409] Fix | Delete

[410] Fix | Delete

update_option(

[411] Fix | Delete

'ctf_notifications',

[412] Fix | Delete

array(

[413] Fix | Delete

'update' => ctf_get_current_time(),

[414] Fix | Delete

'feed' => $feed,

[415] Fix | Delete

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

[416] Fix | Delete

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

[417] Fix | Delete

)

[418] Fix | Delete

);

[419] Fix | Delete

}

[420] Fix | Delete

[421] Fix | Delete

/**

[422] Fix | Delete

* Admin area Form Overview enqueues.

[423] Fix | Delete

[424] Fix | Delete

* @since 2.0

[425] Fix | Delete

[426] Fix | Delete

public function enqueues() {

[427] Fix | Delete

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

[428] Fix | Delete

return;

[429] Fix | Delete

}

[430] Fix | Delete

[431] Fix | Delete

$notifications = $this->get();

[432] Fix | Delete

[433] Fix | Delete

if ( empty( $notifications ) ) {

[434] Fix | Delete

return;

[435] Fix | Delete

}

[436] Fix | Delete

[437] Fix | Delete

$min = '';

[438] Fix | Delete

[439] Fix | Delete

wp_enqueue_style(

[440] Fix | Delete

'ctf-admin-notifications',

[441] Fix | Delete

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

[442] Fix | Delete

array(),

[443] Fix | Delete

CTF_VERSION

[444] Fix | Delete

);

[445] Fix | Delete

[446] Fix | Delete

wp_enqueue_script(

[447] Fix | Delete

'ctf-admin-notifications',

[448] Fix | Delete

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

[449] Fix | Delete

array( 'jquery' ),

[450] Fix | Delete

CTF_VERSION,

[451] Fix | Delete

true

[452] Fix | Delete

);

[453] Fix | Delete

}

[454] Fix | Delete

[455] Fix | Delete

/**

[456] Fix | Delete

* Fields from the remote source contain placeholders to allow

[457] Fix | Delete

* some messages to be used for multiple plugins.

[458] Fix | Delete

[459] Fix | Delete

* @param $content string

[460] Fix | Delete

* @param $notification array

[461] Fix | Delete

[462] Fix | Delete

* @return string

[463] Fix | Delete

[464] Fix | Delete

* @since 2.0

[465] Fix | Delete

[466] Fix | Delete

public function replace_merge_fields( $content, $notification ) {

[467] Fix | Delete

$merge_fields = array(

[468] Fix | Delete

'{plugin}' => 'Twitter Feed',

[469] Fix | Delete

'{amount}' => isset( $notification['amount'] ) ? $notification['amount'] : '',

[470] Fix | Delete

'{platform}' => 'Twitter',

[471] Fix | Delete

'{lowerplatform}' => 'twitter',

[472] Fix | Delete

'{review-url}' => 'https://wordpress.org/support/plugin/custom-twitter-feeds/reviews/',

[473] Fix | Delete

'{slug}' => 'custom-twitter-feeds',

[474] Fix | Delete

'{campaign}' => 'twitter-free'

[475] Fix | Delete

);

[476] Fix | Delete

[477] Fix | Delete

if ( ctf_is_pro_version() ) {

[478] Fix | Delete

$merge_fields['{campaign}'] = 'twitter-pro';

[479] Fix | Delete

$merge_fields['{plugin}'] = 'Twitter Feed Pro';

[480] Fix | Delete

}

[481] Fix | Delete

[482] Fix | Delete

foreach ( $merge_fields as $find => $replace ) {

[483] Fix | Delete

$content = str_replace( $find, $replace, $content );

[484] Fix | Delete

}

[485] Fix | Delete

[486] Fix | Delete

return $content;

[487] Fix | Delete

}

[488] Fix | Delete

[489] Fix | Delete

/**

[490] Fix | Delete

* Output notifications on Twitter Feed admin area.

[491] Fix | Delete

[492] Fix | Delete

* @since 2.0

[493] Fix | Delete

[494] Fix | Delete

public function output() {

[495] Fix | Delete

// if we are one single feed page then return

[496] Fix | Delete

if ( isset( $_GET['feed_id'] ) ) {

[497] Fix | Delete

return;

[498] Fix | Delete

}

[499] Fix | Delete