Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\Admin\Notifications

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Class Yoast_Notifications.

[8] Fix | Delete

[9] Fix | Delete

class Yoast_Notifications {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Holds the admin page's ID.

[13] Fix | Delete

[14] Fix | Delete

* @var string

[15] Fix | Delete

[16] Fix | Delete

public const ADMIN_PAGE = 'wpseo_dashboard';

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Total notifications count.

[20] Fix | Delete

[21] Fix | Delete

* @var int

[22] Fix | Delete

[23] Fix | Delete

private static $notification_count = 0;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* All error notifications.

[27] Fix | Delete

[28] Fix | Delete

* @var array

[29] Fix | Delete

[30] Fix | Delete

private static $errors = [];

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Active errors.

[34] Fix | Delete

[35] Fix | Delete

* @var array

[36] Fix | Delete

[37] Fix | Delete

private static $active_errors = [];

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Dismissed errors.

[41] Fix | Delete

[42] Fix | Delete

* @var array

[43] Fix | Delete

[44] Fix | Delete

private static $dismissed_errors = [];

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* All warning notifications.

[48] Fix | Delete

[49] Fix | Delete

* @var array

[50] Fix | Delete

[51] Fix | Delete

private static $warnings = [];

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Active warnings.

[55] Fix | Delete

[56] Fix | Delete

* @var array

[57] Fix | Delete

[58] Fix | Delete

private static $active_warnings = [];

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Dismissed warnings.

[62] Fix | Delete

[63] Fix | Delete

* @var array

[64] Fix | Delete

[65] Fix | Delete

private static $dismissed_warnings = [];

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Yoast_Notifications constructor.

[69] Fix | Delete

[70] Fix | Delete

public function __construct() {

[71] Fix | Delete

[72] Fix | Delete

$this->add_hooks();

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Add hooks

[77] Fix | Delete

[78] Fix | Delete

* @return void

[79] Fix | Delete

[80] Fix | Delete

private function add_hooks() {

[81] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.

[82] Fix | Delete

if ( isset( $_GET['page'] ) && is_string( $_GET['page'] ) ) {

[83] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Reason: We are not processing form information.

[84] Fix | Delete

$page = sanitize_text_field( wp_unslash( $_GET['page'] ) );

[85] Fix | Delete

if ( $page === self::ADMIN_PAGE ) {

[86] Fix | Delete

add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_assets' ] );

[87] Fix | Delete

}

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

// Needed for adminbar and Notifications page.

[91] Fix | Delete

add_action( 'admin_init', [ self::class, 'collect_notifications' ], 99 );

[92] Fix | Delete

[93] Fix | Delete

// Add AJAX hooks.

[94] Fix | Delete

add_action( 'wp_ajax_yoast_dismiss_notification', [ $this, 'ajax_dismiss_notification' ] );

[95] Fix | Delete

add_action( 'wp_ajax_yoast_restore_notification', [ $this, 'ajax_restore_notification' ] );

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Enqueue assets.

[100] Fix | Delete

[101] Fix | Delete

* @return void

[102] Fix | Delete

[103] Fix | Delete

public function enqueue_assets() {

[104] Fix | Delete

$asset_manager = new WPSEO_Admin_Asset_Manager();

[105] Fix | Delete

[106] Fix | Delete

$asset_manager->enqueue_style( 'notifications' );

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Handle ajax request to dismiss a notification.

[111] Fix | Delete

[112] Fix | Delete

* @return void

[113] Fix | Delete

[114] Fix | Delete

public function ajax_dismiss_notification() {

[115] Fix | Delete

[116] Fix | Delete

$notification = $this->get_notification_from_ajax_request();

[117] Fix | Delete

if ( $notification ) {

[118] Fix | Delete

$notification_center = Yoast_Notification_Center::get();

[119] Fix | Delete

$notification_center->maybe_dismiss_notification( $notification );

[120] Fix | Delete

[121] Fix | Delete

$this->output_ajax_response( $notification->get_type() );

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

wp_die();

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

/**

[128] Fix | Delete

* Handle ajax request to restore a notification.

[129] Fix | Delete

[130] Fix | Delete

* @return void

[131] Fix | Delete

[132] Fix | Delete

public function ajax_restore_notification() {

[133] Fix | Delete

[134] Fix | Delete

$notification = $this->get_notification_from_ajax_request();

[135] Fix | Delete

if ( $notification ) {

[136] Fix | Delete

$notification_center = Yoast_Notification_Center::get();

[137] Fix | Delete

$notification_center->restore_notification( $notification );

[138] Fix | Delete

[139] Fix | Delete

$this->output_ajax_response( $notification->get_type() );

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

wp_die();

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Create AJAX response data.

[147] Fix | Delete

[148] Fix | Delete

* @param string $type Notification type.

[149] Fix | Delete

[150] Fix | Delete

* @return void

[151] Fix | Delete

[152] Fix | Delete

private function output_ajax_response( $type ) {

[153] Fix | Delete

[154] Fix | Delete

$html = $this->get_view_html( $type );

[155] Fix | Delete

// phpcs:disable WordPress.Security.EscapeOutput -- Reason: WPSEO_Utils::format_json_encode is safe.

[156] Fix | Delete

echo WPSEO_Utils::format_json_encode(

[157] Fix | Delete

[

[158] Fix | Delete

'html' => $html,

[159] Fix | Delete

'total' => self::get_active_notification_count(),

[160] Fix | Delete

]

[161] Fix | Delete

);

[162] Fix | Delete

// phpcs:enable -- Reason: WPSEO_Utils::format_json_encode is safe.

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Get the HTML to return in the AJAX request.

[167] Fix | Delete

[168] Fix | Delete

* @param string $type Notification type.

[169] Fix | Delete

[170] Fix | Delete

* @return bool|string

[171] Fix | Delete

[172] Fix | Delete

private function get_view_html( $type ) {

[173] Fix | Delete

[174] Fix | Delete

switch ( $type ) {

[175] Fix | Delete

case 'error':

[176] Fix | Delete

$view = 'errors';

[177] Fix | Delete

break;

[178] Fix | Delete

[179] Fix | Delete

case 'warning':

[180] Fix | Delete

default:

[181] Fix | Delete

$view = 'warnings';

[182] Fix | Delete

break;

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

// Re-collect notifications.

[186] Fix | Delete

self::collect_notifications();

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Stops PHPStorm from nagging about this variable being unused. The variable is used in the view.

[190] Fix | Delete

[191] Fix | Delete

* @noinspection PhpUnusedLocalVariableInspection

[192] Fix | Delete

[193] Fix | Delete

$notifications_data = self::get_template_variables();

[194] Fix | Delete

[195] Fix | Delete

ob_start();

[196] Fix | Delete

include WPSEO_PATH . 'admin/views/partial-notifications-' . $view . '.php';

[197] Fix | Delete

$html = ob_get_clean();

[198] Fix | Delete

[199] Fix | Delete

return $html;

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

/**

[203] Fix | Delete

* Extract the Yoast Notification from the AJAX request.

[204] Fix | Delete

[205] Fix | Delete

* This function does not handle nonce verification.

[206] Fix | Delete

[207] Fix | Delete

* @return Yoast_Notification|null A Yoast_Notification on success, null on failure.

[208] Fix | Delete

[209] Fix | Delete

private function get_notification_from_ajax_request() {

[210] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: This function does not handle nonce verification.

[211] Fix | Delete

if ( ! isset( $_POST['notification'] ) || ! is_string( $_POST['notification'] ) ) {

[212] Fix | Delete

return null;

[213] Fix | Delete

}

[214] Fix | Delete

// phpcs:ignore WordPress.Security.NonceVerification.Missing -- Reason: This function does not handle nonce verification.

[215] Fix | Delete

$notification_id = sanitize_text_field( wp_unslash( $_POST['notification'] ) );

[216] Fix | Delete

[217] Fix | Delete

if ( empty( $notification_id ) ) {

[218] Fix | Delete

return null;

[219] Fix | Delete

}

[220] Fix | Delete

$notification_center = Yoast_Notification_Center::get();

[221] Fix | Delete

return $notification_center->get_notification_by_id( $notification_id );

[222] Fix | Delete

}

[223] Fix | Delete

[224] Fix | Delete

/**

[225] Fix | Delete

* Collect the notifications and group them together.

[226] Fix | Delete

[227] Fix | Delete

* @return void

[228] Fix | Delete

[229] Fix | Delete

public static function collect_notifications() {

[230] Fix | Delete

[231] Fix | Delete

$notification_center = Yoast_Notification_Center::get();

[232] Fix | Delete

[233] Fix | Delete

$notifications = $notification_center->get_sorted_notifications();

[234] Fix | Delete

self::$notification_count = count( $notifications );

[235] Fix | Delete

[236] Fix | Delete

self::$errors = array_filter( $notifications, [ self::class, 'filter_error_notifications' ] );

[237] Fix | Delete

self::$dismissed_errors = array_filter( self::$errors, [ self::class, 'filter_dismissed_notifications' ] );

[238] Fix | Delete

self::$active_errors = array_diff( self::$errors, self::$dismissed_errors );

[239] Fix | Delete

[240] Fix | Delete

self::$warnings = array_filter( $notifications, [ self::class, 'filter_warning_notifications' ] );

[241] Fix | Delete

self::$dismissed_warnings = array_filter( self::$warnings, [ self::class, 'filter_dismissed_notifications' ] );

[242] Fix | Delete

self::$active_warnings = array_diff( self::$warnings, self::$dismissed_warnings );

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

/**

[246] Fix | Delete

* Get the variables needed in the views.

[247] Fix | Delete

[248] Fix | Delete

* @return array

[249] Fix | Delete

[250] Fix | Delete

public static function get_template_variables() {

[251] Fix | Delete

[252] Fix | Delete

return [

[253] Fix | Delete

'metrics' => [

[254] Fix | Delete

'total' => self::$notification_count,

[255] Fix | Delete

'active' => self::get_active_notification_count(),

[256] Fix | Delete

'errors' => count( self::$errors ),

[257] Fix | Delete

'warnings' => count( self::$warnings ),

[258] Fix | Delete

[259] Fix | Delete

'errors' => [

[260] Fix | Delete

'dismissed' => self::$dismissed_errors,

[261] Fix | Delete

'active' => self::$active_errors,

[262] Fix | Delete

[263] Fix | Delete

'warnings' => [

[264] Fix | Delete

'dismissed' => self::$dismissed_warnings,

[265] Fix | Delete

'active' => self::$active_warnings,

[266] Fix | Delete

[267] Fix | Delete

];

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Get the number of active notifications.

[272] Fix | Delete

[273] Fix | Delete

* @return int

[274] Fix | Delete

[275] Fix | Delete

public static function get_active_notification_count() {

[276] Fix | Delete

[277] Fix | Delete

return ( count( self::$active_errors ) + count( self::$active_warnings ) );

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Filter out any non-errors.

[282] Fix | Delete

[283] Fix | Delete

* @param Yoast_Notification $notification Notification to test.

[284] Fix | Delete

[285] Fix | Delete

* @return bool

[286] Fix | Delete

[287] Fix | Delete

private static function filter_error_notifications( Yoast_Notification $notification ) {

[288] Fix | Delete

[289] Fix | Delete

return $notification->get_type() === 'error';

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Filter out any non-warnings.

[294] Fix | Delete

[295] Fix | Delete

* @param Yoast_Notification $notification Notification to test.

[296] Fix | Delete

[297] Fix | Delete

* @return bool

[298] Fix | Delete

[299] Fix | Delete

private static function filter_warning_notifications( Yoast_Notification $notification ) {

[300] Fix | Delete

[301] Fix | Delete

return $notification->get_type() !== 'error';

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* Filter out any dismissed notifications.

[306] Fix | Delete

[307] Fix | Delete

* @param Yoast_Notification $notification Notification to test.

[308] Fix | Delete

[309] Fix | Delete

* @return bool

[310] Fix | Delete

[311] Fix | Delete

private static function filter_dismissed_notifications( Yoast_Notification $notification ) {

[312] Fix | Delete

[313] Fix | Delete

return Yoast_Notification_Center::is_notification_dismissed( $notification );

[314] Fix | Delete

}

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

class_alias( Yoast_Notifications::class, 'Yoast_Alerts' );

[318] Fix | Delete

[319] Fix | Delete